Documentation forNetwork Configuration Manager
Managing network configurations is a key capability of SolarWinds Observability Self-Hosted (formerly Hybrid Cloud Observability) and is available in the Advanced edition. Network Configuration Manager (NCM) is also available in a standalone module.

SWIS entities used in config change templates

The following sections document the SolarWinds Information Service (SWIS) entities and properties that you can use in NCM config change templates.

NCM.ArpTables

Property Name

Datatype

Description

InterfaceIndex

System.Int32

The interface on which this entry's equivalence is effective. The interface identified by a particular value of this index is the same interface as identified by the same value of RFC 1573's ifIndex.

InterfaceID

System.String

A unique GUID ID from ncm.Interfaces table.

MAC

System.String

The media dependent 'physical' address.

IPAddress

System.String

The IP address corresponding to the media dependent physical address.

IPSort

System.Double

A list of IP addresses sorted with octet markers (dots) omitted.

Source

System.String

The type of IP address associated with an ARP operation and media dependent address.

Possible Values:

  • Other (1)
  • Invalid (2)
  • Dynamic (3)
  • Static (4)

Setting this object to the value invalid (2) has the effect of invalidating the corresponding entry in the ipNetToMediaTable. That is, it effectively disassociates the interface identified with said entry from the mapping identified with said entry. It is an implementation specific matter as to whether the agent removes an Invalidated entry from the table. Accordingly, management stations must be prepared to receive tabular information from agents that corresponds to entries not currently in use. Proper interpretation of such entries requires examination of the relevant ipNetToMediaType object.

RDNSLookup

System.String

Result of DNS lookup on IPAddress.

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of interfaces for which ARP data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.ARPTables entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsArpTables (System.Hosting)

NCM.BridgePorts

Property Name

Datatype

Description

InterfaceIndex

System.Int32

The value of the instance of the ifIndex object, defined in MIB-II, for the interface corresponding to this port.

Port

System.Int32

The port number of the port for which this entry contains bridge management information.

SpanningTreeEnabled

System.String

The enabled/disabled status of the port.

Possible Values:

  • Enabled (1)
  • Disabled (2)

SpanningTreeState

System.String

The port's current state as defined by application of the Spanning Tree Protocol. This state controls what action a port takes on reception of a frame. If the bridge has detected a port that is malfunctioning, it places that port into the broken(6) state. For ports that are disabled (see dot1dStpPortEnable), this object has a value of disabled(1).

VlanType

System.String

The type of VLAN membership assigned to this port. A port with static VLAN membership is assigned to a single VLAN directly. A port with dynamic membership is assigned a single VLAN based on content of packets received on the port and through VQP queries to VMPS. A port with multiple VLAN membership may be assigned to one or more VLANs directly. A static or dynamic port membership is specified by the value of vmVlan. A multiVlan port membership is specified by the value of vmVlans.

Possible Values:

  • Static(1)
  • Dynamic(2)
  • MultiVlan(3)

VLANID

System.Int32

The VLAN id of the VLAN the port is assigned to when vmVlanType is set to static or dynamic. This object is not instantiated if not applicable.

The value may be 0 if the port is not assigned to a VLAN.

PortStatus

System.String

An indication of the current VLAN status of the port. A status of inactive(1) indicates that a dynamic port does not yet have a VLAN assigned, or a port is assigned to a VLAN that is currently not active. A status of active(2) indicates that the currently assigned VLAN is active. A status of shutdown(3) indicates that the port has been disabled as a result of VQP shutdown response.

Possible Values:

  • inactive(1)
  • active(2)
  • shutdown(3)

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of interfaces for which bridge port data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.BridgePorts entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsBridgePorts (System.Hosting)

NCM.CatalystCards

Property Name

Datatype

Description

CardIndex

System.Int32

A unique value for each module within the chassis.

CardType

System.Int32

The type of module.

CardName

System.String

A descriptive string used by the network administrator to name the module.

ModuleModel

System.String

The manufacturer's model number for the module.

CardSerial

System.String

The serial number of the module. This MIB object returns the module serial number for any module that uses either a numeric or an alphanumeric serial number.

HWVersion

System.String

The hardware version of the module.

FWVersion

System.String

The firmware version of the module.

SWVersion

System.String

The software version of the module.

Slot

System.Int32

This value is determined by the chassis slot number where the module is located. Valid entries are 1 to the value of chassisNumSlots.

Parent

System.Int32

The value of the instance of the entPhysicalIndex object, defined in ENTITY-MIB, for the entity physical index corresponding to this module.

OperStatus

System.String

The operational status of the module. If the status is not ok, the value of moduleTestResult gives more detailed information about the module's failure condition(s).

Possible Values:

  • other(1)
  • ok(2)
  • minorFault(3)
  • majorFault(4)

SlotsOnCard

System.Int32

The number of ports supported by the module.

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of interfaces for which card data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.CatalystCards entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsCatalystCards (System.Hosting)

NCM.CiscoCards

Property Name

Datatype

Description

CardIndex

System.Int32

Index into cardTable (not physical chassis slot number).

CardType

System.Int32

Functional type of this card (integer value).

CardName

System.String

Functional type of this card (parsed from type name value).

CardDescr

System.String

Text description of this card.

CardSerial

System.String

The serial number of this card, or zero if unavailable.

HWVersion

System.String

Hardware revision level of this card, or an empty string if unavailable.

SWVersion

System.String

Version of the firmware or microcode installed on this card, or an empty string if unavailable.

Slot

System.Int32

Number of slots on this card, or 0 if no slots or not applicable, or -1 if not determinable.

Parent

System.Int32

cardIndex of the parent card that directly contains this card, or 0 if contained by the chassis, or -1 if not  applicable or determinable.

OperStatus

System.String

The operational status of the card. cardOperStatus is up when a card is  recognized by the device and is enabled for operation. cardOperStatus is down if the card is not recognized by the device, or if it is not enabled for operation. cardOperStatus is standby if the card is enabled and acting as a standby slave.

Possible Values:

  • not-specified(1)
  • up (2)
  • down (3)
  • standby (4)
  • standbyMaster (5)
  • activeMaster (6)
  • outOfService (7)
  • masterBooting(8)
  • activeMasterBooting(9)
  • standbyMasterBooting(10)
  • slaveBooting(11)

SlotsOnCard

System.Int32

Number of slots on this card, or 0 if no slots or not applicable, or -1 if not  determinable.

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of interfaces for which card data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.CiscoCards entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsCiscoCards (System.Hosting)

NCM.CiscoCdp

Property Name

Datatype

Description

ifIndex

System.Int32

An indication of the type of address contained in the corresponding instance of cdpCacheAddress (parse just ifIndex from value). For example 1,2,3.

CDPIndex

System.String

An indication of the type of address contained in the corresponding instance of cdpCacheAddress (full value). For example 1.6, 2.108, 2.3.

RemoteDevice

System.String

The Device-ID string as reported in the most recent CDP message. A zero-length string indicates no Device-ID field (TLV) was reported in the most recent CDP message.

RemoteIPAddress

System.String

The (first) network-layer address of the device's SNMP-agent as reported in the most recent CDP message. For example, if the corresponding instance of cacheAddressType had the value 'ip(1)', then this object would be an IP address.

RemoteVersion

System.String

The Version string as reported in the most recent CDP message. A zero-length string indicates no Version field (TLV) was reported in the most recent CDP message.

RemotePort

System.String

The Port-ID string as reported in the most recent CDP message. This is typically the value of the ifName object (for example, 'Ethernet0'). A zero-length string indicates no Port-ID field (TLV) was reported in the most recent CDP message

RemoteCapability

System.String

The Device's Functional Capabilities as reported in the most recent CDP message. For latest set of specific values, see the latest version of the CDP specification. A zero-length string indicates no Capabilities field (TLV) was reported in the most recent CDP message.

RemotePlatform

System.String

The Device's Hardware Platform as reported in the most recent CDP message. A zero-length string indicates that no Platform field (TLV) was reported in the most recent CDP message.

RemoteDuplex

System.String

The remote device's interface's duplex mode, as reported in the most recent CDP message. The value unknown(1) indicates no duplex mode field (TLV) was reported in the most recent CDP message.

Possible Values:

  • unknown(1)
  • halfduplex(2)
  • fullduplex(3)

RemoteNativeVLAN

System.Int32

The remote device's interface's native VLAN, as reported in the most recent CDP message. The value 0 indicates no native VLAN field (TLV) was reported in the most recent CDP message.

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of remote devices for which remote device data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.CiscoCdp entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsCiscoCdp (System.Hosting)

NCM.CiscoChassis

Property Name

Datatype

Description

chassisType

System.Int32

Chassis type (integer value).

Possible Values:

  • unknown(1)
  • multibus(2)
  • agsplus(3)

chassisName

System.String

Chassis type (parsed string value).

Possible Values:

  • unknown(1)
  • multibus(2)
  • agsplus(3)

chassisVersion

System.String

Chassis hardware revision level, or an empty string if unavailable.

chassisID

System.String

Unique ID string. Defaults to chassis serial number if available, otherwise empty. Can also be set with 'snmp-server chassis-id'.

chassisSerialNumberString

System.String

The serial number of the chassis. This MIB object returns the chassis serial number for any chassis that uses either a numeric or an alphanumeric serial number.

romVersion

System.String

ROM monitor version.

RomSysVersion

System.String

ROM system software version or an empty string if unavailable.

processorRAM

System.Int32

Bytes of RAM available to CPU.

nvRAMSize

System.Int32

Bytes of nonvolatile configuration memory.

nvRAMUsed

System.Int32

Bytes of non-volatile configuration memory in use.

chassisSlots

System.Int32

Number of slots in this chassis, or -1 of neither applicable nor determinable.

romID

System.String

This variable contains a printable octet string that contains the System Bootstrap description and version identification.

whyReload

System.String

This variable contains a printable octet string that contains the reason why the system was last restarted.

freeMem

System.Int32

Return the amount of free memory in bytes.

This MIB object is obsolete as of IOS release 11.1. IOS release 11.1 introduced the CISCO-MEMORY-POOL-MIB, which better instruments all of the memory pools.

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of nodes for which data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.CiscoChassis entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsCiscoChassis (System.Hosting)

NCM.CiscoFlash

Property Name

Datatype

Description

FlashSize

System.Int32

Total size of the Flash device. For a removable device, the size is zero if the device has been removed.

Name

System.String

Flash device name. This name is used to refer to the device within the system. Flash operations get directed to a device based on this name. The system has a concept of a default device. This would be the primary or most used device in case of multiple devices. The system directs an operation to the default device whenever a device name is not specified. The device name is therefore mandatory except when the operation is being done on the default device, or the system supports only a single Flash device. The device name is always available for a removable device, even when the device has been removed.

FlashDescription

System.String

Description of a Flash device. The description is meant to explain what the Flash device and its purpose is. Current values are: System flash - for the primary Flash used to store full system images. Boot flash: for the secondary Flash used to store bootstrap images. The ciscoFlashDeviceDescr, CiscoFlashDeviceController (if applicable), and ciscoFlashPhyEntIndex objects are expected to collectively give all information about a Flash device. The device description is always available for a removable device, even when the device has been removed.

PartitionCount

System.Int32

Flash device partitions actually present. The number of partitions cannot exceed the minimum of ciscoFlashDeviceMaxPartitions and (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize). This is equal to at least 1, in the case where the partition spans the entire device (actually no partitioning). A partition contains one or more minimum partition units (where a minimum partition unit is defined by ciscoFlashDeviceMinPartitionSize).

MinPartitionSize

System.Int32

This object gives the minimum partition size supported for this device. For systems that execute code directly out of Flash, the minimum partition size needs to be the bank size. (Bank size is equal to the size of a chip multiplied by the width of the device. In most cases, the device width is 4 bytes, and so the bank size would be four times the size of a chip). This has to be so because all programming commands affect the operation of an entire chip (in our case, an entire bank because all operations are done on the entire width of the device) even though the actual command may be localized to a small portion of each chip. So when executing code out of Flash, one needs to be able to write and erase some portion of Flash without affecting the code execution. For systems that execute code out of DRAM or ROM, it is possible to partition Flash with a finer granularity (for example, at erase sector boundaries) if the system code supports such granularity.

This object lets a management entity know the minimum partition size as defined by the system. If the system does not support partitioning, the value is equal to the device size in ciscoFlashDeviceSize. The maximum number of partitions that could be configured is equal to the minimum of ciscoFlashDeviceMaxPartitions and (ciscoFlashDeviceSize / CiscoFlashDeviceMinPartitionSize).

Controller

System.String

Flash device controller. The h/w card that actually controls Flash read/write/erase. Relevant for the AGS+ systems where Flash may be controlled by the MC+, STR or the ENVM cards, cards that may not actually contain the Flash chips. For systems that have removable PCMCIA flash cards that are controlled by a PCMCIA controller chip, this object may contain a description of that controller chip. Where irrelevant (Flash is a direct memory mapped device accessed directly by the main processor), this object has an empty (NULL) string.

WriteProtectJumper

System.String

This object gives the state of a jumper (if present and can be determined) that controls the programming voltage called Vpp to the Flash device. Vpp is required for programming (erasing and writing) Flash. For certain older technology chips it is also required for identifying the chips (which in turn is required to identify which programming algorithms to use; different chips require different algorithms and commands). The purpose of the jumper, on systems where it is available, is to write protect a Flash device. On most of the newer remote access routers, this jumper is unavailable since users are not expected to visit remote sites just to install and remove the jumpers when upgrading software in the Flash device. The unknown(3) value is returned for such systems and can be interpreted to mean that a programming jumper is not present or not required on those systems. On systems where the programming jumper state can be read back through a hardware register, the installed (1) or notInstalled (2) value is returned. This object is expected to be used in conjunction with the ciscoFlashPartitionStatus object whenever that object has the readOnly(1) value. In such a case, this object indicates whether the programming jumper is a possible reason for the readOnly state.

Possible Values:

  • installed(1)
  • notInstalled(2)
  • unknown(3)

MaxPartitions

System.Int32

Max number of partitions supported by the system for this Flash device. The default is 1, which actually means that partitioning is not supported. Note that this value is defined by system limitations, not by the flash device itself (for example, the system may impose a limit of 2 partitions even though the device may be large enough to be partitioned into 4 based on the smallest partition unit supported). On systems that execute code out of Flash, partitioning is a way of creating multiple file systems in the Flash device so that writing into or erasing of one file system can be done while executing code residing in another file system. For systems executing code out of DRAM, partitioning gives a way of sub-dividing a large Flash device for easier management of files.

Initialized

System.DateTime

System time at which device was initialized. For fixed devices, this is the system time at boot up. For removable devices, it is the time at which the device was inserted, which may be boot up time or a later time (if device was inserted later). If a device (fixed or removable) was repartitioned, it is the time of repartitioning. The purpose of this object is to help a management station determine if a removable device has been changed. The application should retrieve this object prior to any operation and compare with the previously retrieved value. Note that this time is not real time but a running time maintained by the system. This running time starts from zero when the system boots up. For a removable device that has been removed, this value is zero.

Removable

System.String

Whether Flash device is removable. Generally, only PCMCIA Flash cards are treated as removable. Socketed Flash chips and Flash SIMM modules are not treated as removable. Simply put, only those Flash devices that can be inserted or removed without opening the hardware casing are considered removable. Further, removable Flash devices are expected to have the necessary hardware support: 1) on-line removal and insertion; 2) interrupt generation on removal or insertion.

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of Cisco devices for which data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.CiscoFlash entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsCiscoFlash (System.Hosting)

NCM.CiscoFlashFiles

Property Name

Datatype

Description

FlashFileName

System.String

Flash file name as specified by the user copying in the file. The name should not include the colon (:) character as it is a special separator character used to delineate the device name, partition name, and the file name.

FlashFileSize

System.Int32

Size of the file in bytes. Note that this size does not include the size of the filesystem file header. File size is always non-zero.

FlashCheckSum

System.String

File checksum stored in the file header. This checksum is computed and stored when the file is written into Flash. It serves to validate the data written into Flash. Whereas the system generates and stores the checksum internally in hexadecimal form, this object provides the checksum in a string form. The checksum is available for all valid and invalid checksum files.

FlashFileStatus

System.String

Status of a file. A file could be explicitly deleted if the file system supports such a user command facility. Alternately, an existing good file would be automatically deleted if another good file with the same name were copied in. Note that deleted files continue to occupy prime Flash real estate.

A file is marked as having an invalid checksum if any checksum mismatch was detected while writing or reading the file. Incomplete files (files truncated either because of lack of free space or a network download failure) are also written with a bad checksum and marked as invalid.

Possible Values:

  • deleted(1)
  • invalidChecksum(2)
  • valid(3)

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of Cisco devices for which data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.CiscoFlashFiles entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsCiscoFlashFiles (System.Hosting)

NCM.CiscoImageMIB

Property Name

Datatype

Description

Name

System.String

The string of this entry.

Value

System.String

The string of this entry.

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of Cisco devices for which data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.CiscoImageMIB entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsCiscoImageMIB (System.Hosting)

NCM.CiscoMemoryPools

Property Name

Datatype

Description

PoolName

System.String

A textual name assigned to the memory pool. This object is suitable for output to a human operator, and may also be used to distinguish among the various pool types, especially among dynamic pools.

PoolUsed

System.Int32

Indicates the number of bytes from the memory pool that are currently in use by applications on the managed device.

PoolFree

System.Int32

Indicates the number of bytes from the memory pool that are currently unused on the managed device. Note that the sum of ciscoMemoryPoolUsed and ciscoMemoryPoolFree is the total amount of memory in the pool.

PoolLargestFree

System.Int32

Indicates the largest number of contiguous bytes from the memory pool that are currently unused on the managed device.

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of Cisco devices for which data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.CiscoMemoryPools entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsCiscoMemoryPools (System.Hosting)

NCM.EntityLogical

Property Name

Datatype

Description

Name

System.String

A textual description of the logical entity. This object should contain a string that identifies the manufacturer's name for the logical entity , and should be set to a distinct value for each version of the logical entity.

TDomain

System.String

Indicates the kind of transport service by which the logical entity receives network management traffic. Possible values for this object are presently found in the Transport Mappings for SNMPv2 document (RFC 1906 [RFC1906]).

Type

System.String

An indication of the type of logical entity. This is typically the OBJECT-IDENTIFIER name of the node in the SMI's naming hierarchy that represents the major MIB module, or the majority of the MIB modules, supported by the logical entity. For example: a logical entity of a regular host/router > mib-2 a logical entity of a 802.1d bridge -> dot1dBridge a logical entity of a 802.3 repeater -> snmpDot3RptrMgmt If an appropriate node in the naming hierarchy of SMI cannot be identified , the value 'mib-2' should be used.

Community

System.String

An SNMPv1 or SNMPv2C community-string that can be used to access detailed management information for this logical entity. The agent should allow read access with this community string (to an appropriate subset of all managed objects) and may also return a community string based on the privileges of the request used to read this object. Note that an agent may return a community string with read-only privileges, even if this object is accessed with a read-write community string. However, the agent must take care not to return a community string that allows more privileges than the community string used to access this object.

TAddress

System.String

The transport service address by which the logical entity receives network management traffic, formatted according to the corresponding value of entLogicalTDomain. For snmpUDPDomain, a TAddress is 6 octets long, the initial 4 octets containing the IP-address in network-byte order and the last 2 containing the UDP port in network-byte order. Consult 'Transport Mappings for Version 2 of the Simple Network Management Protocol' (RFC 1906 [RFC1906]) for further information on snmpUDPDomain.

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of Cisco devices for which data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.EntityLogical entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsEntityLogical (System.Hosting)

NCM.EntityPhysical

Property Name

Datatype

Description

EntityName

System.String

The textual name of the physical entity. The value of this object should be the name of the component as assigned by the local device and should be suitable for use in commands entered at the device's 'console'. This might be a text name, such as 'console' or a simple component number (for example, port or module number) , such as '1' , depending on the physical component naming syntax of the device.

If there is no local name, or this object is otherwise not applicable, then this object contains a zero-length string.

The value of entPhysicalName for two physical entities is the same if the console interface does not distinguish between them (for example, slot-1 and the card in slot-1).

EntityDescription

System.String

A textual description of physical entity. This object should contain a string that identifies the manufacturer's name for the physical entity, and should be set to a distinct value for each version or model of the physical entity.

EntityType

System.String

An indication of the vendor-specific hardware type of the physical entity. Note that this is different from the definition of MIB-II's sysObjectID.

An agent should set this object to a enterprise-specific registration identifier value indicating the specific equipment type in detail. The associated instance of entPhysicalClass is used to indicate the general type of hardware device.

If no vendor-specific registration identifier exists for this physical entity, or the value is unknown by this agent then the value { 0 } is returned.

ContainedIn

System.String

The value of entPhysicalIndex for the physical entity that 'contains' this physical entity. A value of zero indicates this physical entity is not contained in any other physical entity. Note that the set of 'containment' relationships define a strict hierarchy; that is, recursion is not allowed.

In the event a physical entity is contained by more than one physical entity (for example, double-wide modules) , this object should identify the containing entity with the lowest value of entPhysicalIndex.

EntityClass

System.String

An indication of the general hardware type of the physical entity. An agent should set this object to the standard enumeration value that most accurately indicates the general class of the physical entity or the primary class if there is more than one. If no appropriate standard registration identifier exists for this physical entity, then the value 'other(1)' is returned. If the value is unknown by this agent, then the value 'unknown(2)' is returned.

Position

System.Int32

An indication of the relative position of this 'child' component among all its 'sibling' components. Sibling components are defined as entPhysicalEntries that share the same instance values of each of the entPhysicalContainedIn and entPhysicalClass objects.

HardwareRevision

System.String

The vendor-specific hardware revision string for the physical entity. The preferred value is the hardware revision identifier actually printed on the component itself (if present).

Note that if revision information is stored internally in a non-printable (for example, binary) format, then the agent must convert such information to a printable format, in an implementation-specific manner. If no specific hardware revision string is associated with the physical component, or this information is unknown to the agent, then this object contains a zero-length string.

FirmwareRevision

System.String

The vendor-specific firmware revision string for the physical entity.

Note that if revision information is stored internally in a non-printable (for example, binary) format , then the agent must convert such information to a printable format , in an implementation-specific manner. If no specific firmware programs are associated with the physical component, or this information is unknown to the agent, then this object contains a zero-length string.

SoftwareRevision

System.String

The vendor-specific software revision string for the physical entity.

Note that if revision information is stored internally in a non-printable (for example, binary) format, then the agent must convert such information to a printable format , in an implementation-specific manner. If no specific software programs are associated with the physical component, or this information is unknown to the agent, then this object contains a zero-length string.

Serial

System.String

The vendor-specific serial number string for the physical entity. The preferred value is the serial number string actually printed on the component itself (if present).

Manufacturer

System.String

The name of the manufacturer of this physical component. The preferred value is the manufacturer name string actually printed on the component itself (if present).

Model

System.String

The vendor-specific model name identifier string associated with this physical component. The preferred value is the customer-visible part number, which may be printed on the component itself. If the model name string associated with the physical component is unknown to the agent, then this object contains a zero-length string.

Alias

System.String

This object is an 'alias' name for the physical entity as specified by a network manager, and provides a non-volatile 'handle' for the physical entity.

AssetID

System.String

This object is a user-assigned asset tracking identifier for the physical entity as specified by a network manager, and provides non-volatile storage of this information.

FieldReplaceable

System.String

This object indicates whether or not this physical entity is considered a 'field replaceable unit' by the vendor. If this object contains the value 'true(1)' then this entPhysicalEntry identifies a field replaceable unit. For all entPhysicalEntries that represent components that are permanently contained within a field replaceable unit, the value 'false(2)' should be returned for this object.

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of Cisco devices for which data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.EntityPhysical entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsEntityPhysical (System.Hosting)

NCM.Interfaces

Property Name

Datatype

Description

InterfaceID

System.String

[Swis]

InterfaceIndex

System.Int32

A unique value, greater than zero, for each interface. SolarWinds recommends assigning values contiguously starting from 1. The value for each interface sub-layer must remain constant at least from one reinitialization of the entity's network management system to the next reinitialization.

InterfaceDescription

System.String

A textual string containing information about the interface. This string should include the name of the manufacturer, the product name, and the version of the interface hardware or software.

VLANID

System.Int32

The set of the device's member ports that belong to the VLAN. Each octet within the value of this object specifies a set of eight ports, with the first octet specifying ports 1 through 8, the second octet specifying ports 9 through 16, etc. Within each octet, the most significant bit represents the lowest numbered port, and the least significant bit represents the highest numbered port. Thus, each port of the VLAN is represented by a single bit within the value of this object. If that bit has a value of '1' then that port is included in the set of ports. The port is not included if its bit has a value of '0'. A port number is the value of dot1dBasePort for the port in the BRIDGE-MIB (RFC 1493).

PortStatus

System.String

An indication of the current VLAN status of the port. A status of inactive(1) indicates that a dynamic port does not yet have a VLAN assigned, or a port is assigned to a VLAN that is currently not active. A status of active(2) indicates that the currently assigned VLAN is active. A status of shutdown(3) indicates that the port has been disabled as a result of VQP shutdown response.

Possible Values:

  • inactive(1)
  • active(2)
  • shutdown(3)

VLANType

System.Int32

The type of this VLAN

InterfaceName

System.String

The textual name of the interface. The value of this object should be the name of the interface as assigned by the local device and should be suitable for use in commands entered at the device's 'console'. This might be a text name, such as 'le0' or a simple port number, such as '1' , depending on the interface naming syntax of the device. If several entries in the ifTable together represent a single interface as named by the device, then each entry has the same value of ifName. If there is no local name, or this object is otherwise not applicable, then this object contains a 0-length string.

InterfaceAlias

System.String

This object is an 'alias' name for the interface as specified by a network manager, and provides a non-volatile 'handle' for the interface.

InterfaceType

System.Int32

The type of interface. Additional values for ifType are assigned by the Internet Assigned Numbers Authority (IANA), through updating the syntax of the IANAifType textual convention.

InterfaceTypeName

System.String

The type of interface. Additional values for ifType are assigned by the Internet Assigned Numbers Authority (IANA), through updating the syntax of the IANAifType textual convention.

InterfaceTypeDescription

System.String

The type of interface. Additional values for ifType are assigned by the Internet Assigned Numbers Authority (IANA), through updating the syntax of the IANAifType textual convention.

InterfaceSpeed

System.Single

An estimate of the interface's current bandwidth in bits per second. For interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this object should contain the nominal bandwidth. If the bandwidth of the interface is greater than the maximum value reportable by this object then this object should report its maximum value (4, 294, 967, 295) and ifHighSpeed must be used to report the interface’s speed. For a sub-layer that has no concept of bandwidth, this object should be zero.

MACAddress

System.String

The interface's address at its protocol sublayer. The interface's media specific MIB must define the bit and byte ordering and format of the value contained by this object. For interfaces that do not have such an address (for example, a serial line), this object should contain an octet string of zero length.

AdminStatus

System.String

The desired state of the interface. The testing(3) state indicates that no operational packets can be passed. When a managed system initializes, all interfaces start with ifAdminStatus in the down(2) state. As a result of either explicit management action or per configuration information retained by the managed system, ifAdminStatus is then changed to either the up (1) or testing (3) states (or remains in the down (2) state).

OperStatus

System.String

The current operational state of the interface. The testing (3) state indicates that no operational packets can be passed. If ifAdminStatus is down (2) then ifOperStatus should be down (2). If ifAdminStatus is changed to up (1) then ifOperStatus should change to up (1) if the interface is ready to transmit and receive network traffic; it should change to dormant(5) if the interface is waiting for external actions (such as a serial line waiting for an incoming connection); it should remain in the down (2) state if and only if there is a fault that prevents it from going to the up (1) state.

InterfaceMTU

System.Int32

The size of the largest packet that can be sent or received on the interface, specified in octets. For interfaces that are used for transmitting network datagrams, this is the size of the largest network datagram that can be sent on the interface.

LastChange

System.DateTime

The value of sysUpTime at the time the interface entered its current operational state. If the current state was entered prior to the last re-initialization of the local network management subsystem, then this object contains a zero value.

PhysicalInterface

System.Char

This object has the value 'true(1)' if the interface sublayer has a physical connector and the value 'false(2)' otherwise.

Promiscuous

System.Char

This object has a value of false(2) if this interface only accepts packets/frames that are addressed to this station. This object has a value of true(1) when the station accepts all packets/frames transmitted on the media. The value true(1) is only legal on certain types of media. If legal, setting this object to a value of true(1) may require the interface to be reset before becoming effective.

The value of ifPromiscuousMode does not affect the reception of broadcast and multicast packets/frames by the interface.

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of Cisco devices for which data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.Interfaces entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsInterfaces (System.Hosting)

IpAddresses

NCM.IpAddresses

NCM.InterfaceHostsIpAddresses (System.Hosting)

NCM.IpAddresses

Property Name

Datatype

Description

InterfaceIndex

System.Int32

The index value that uniquely identifies the interface to which this entry is applicable. The interface identified by a particular value of this index is the same interface as  identified by the same value of RFC 1573's ifIndex.

IPAddress

System.String

The IP address to which this entry's addressing information pertains.

IPAddrIPSort

System.Double

Store IP address in double representation.

SubnetMask

System.String

The subnet mask associated with the IP address of this entry. The value of the mask is an IP address with all the network bits set to 1 and all the hosts bits set to 0.

InterfaceID

System.String

InterfaceId from interfaces table.

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of Cisco devices for which data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.IpAddresses entity relationships

Type

Entity

Joined Data Entity

Interfaces

NCM.Interfaces

NCM.InterfaceHostsIpAddresses (System.Hosting)

NCM.MacForwarding

Property Name

Datatype

Description

Port

System.Int32

Either the value '0', or the port number of the port on which a frame having a source address equal to the value of the corresponding instance of dot1dTpFdbAddress has been seen. A value of '0' indicates that the port number has not been learned but that the bridge does have some forwarding/filtering information about this address (for example, in the dot1dStaticTable). Implementers are encouraged to assign the port value to this object whenever it is learned even for addresses for which the corresponding value of dot1dTpFdbStatus is not learned(3).

MAC

System.String

A unicast MAC address for which the bridge has forwarding and/or filtering information.

Source

System.String

The status of this entry. The meanings of the values are: other(1) : none of the following. This would include the case where some other MIB object (not the corresponding instance of dot1dTpFdbPort, nor an entry in the dot1dStaticTable) is being used to determine if and how frames addressed to the value of  the corresponding instance of dot1dTpFdbAddress are being forwarded.

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of Cisco devices for which data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.MacForwarding entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsMacForwarding (System.Hosting)

NCM.Nodes

Property Name

Datatype

Description

AgentIP

System.String

IP address of the device entered manually by the user.

Status

System.Byte

NCM-only specific status of the device:

  • Unknown = 0 (not polled yet)
  • Up = 1 (based on ICMP pool)
  • Down = 2 (based on ICMP pool)
  • Warning = 3 (based on ICMP pool)
  • MonitoringDisabled = 10 (NCM node monitoring is disabled by user)
  • UnManaged = 9 (device is unmanaged in NCM)

Community

System.String

SNMP community string entered by the user.

ReverseDNS

System.String

DNS name of the device.

SysName

System.String

An administratively-assigned name for this managed node. By convention, this is the node's fully-qualified domain name.

SysDescr

System.String

A textual description of the entity. This value should include the full name and version identification of the system's hardware type, software operating-system, and networking software. It is mandatory that this contains only printable ASCII characters.

SysContact

System.String

The textual identification of the contact person for this managed node, together with information on how to contact this person.

SysLocation

System.String

The physical location of this node (for example, 'telephone closet, 3rd floor').

SystemOID

System.String

The vendor's authoritative identification of the network management subsystem contained in the entity. This value is allocated within the SMI enterprises subtree (1.3.6.1.4.1) and provides an easy and unambiguous means for determining 'what kind of box' is being managed. For example, if vendor 'Flintstones , Inc.' was assigned the subtree 1.3.6.1.4.1.4242 , it could assign the identifier 1.3.6.1.4.1.4242.1.1 to its 'Fred Router'.

Vendor

System.String

Vendor of device- determined based on SystemOID.

VendorIcon

System.String

Vendor icon of device- determined based on SystemOID.

MachineType

System.String

Machine Type - determined based on SystemOID.

LastBoot

System.DateTime

The time (in hundredths of a second) since the network management portion of the system was last re-initialized.

OSImage

System.String

Determined based on SysDescr.

OSVersion

System.String

Determined based on SysDescr.

SNMPLevel

System.Byte

SNMP version selected by the user (1,2 or 3).

SNMPContext

System.String

SNMPv3 credentials entered by the user.

SNMPUsername

System.String

SNMPv3 credentials entered by the user.

SNMPAuthType

System.String

SNMPv3 credentials entered by the user.

SNMPAuthPass

System.String

SNMPv3 credentials entered by the user.

SNMPEncryptType

System.String

SNMPv3 credentials entered by the user.

SNMPEncryptPass

System.String

SNMPv3 credentials entered by the user.

SNMPStatus

System.String

The status of SNMP connection to the device (OK, No SNMP support, SNMP error description if any).

NodeID

System.String

A SWIS-generated unique identifier of a network node in the current inventory. (Instances of this property recur in this table according to the number of devices for which data is reported.)

LastDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

A SWIS-generated date and time marker for when NCM first discovered the device during inventory.

NCM.Nodes entity relationships

Type

Entity

Joined Data Entity

Interfaces

NCM.Interfaces

NCM.NodeHostsInterfaces (System.Hosting)

MacForwarding

NCM.MacForwarding

NCM.NodeHostsMacForwarding (System.Hosting)

VLANs

NCM.VLANs

NCM.NodeHostsVLANs (System.Hosting)

BridgePorts

NCM.BridgePorts

NCM.NodeHostsBridgePorts (System.Hosting)

ArpTables

NCM.ArpTables

NCM.NodeHostsArpTables (System.Hosting)

CiscoCards

NCM.CiscoCards

NCM.NodeHostsCiscoCards (System.Hosting)

CiscoCdp

NCM.CiscoCdp

NCM.NodeHostsCiscoCdp (System.Hosting)

CiscoChassis

NCM.CiscoChassis

NCM.NodeHostsCiscoChassis (System.Hosting)

CiscoFlash

NCM.CiscoFlash

NCM.NodeHostsCiscoFlash (System.Hosting)

CiscoFlashFiles

NCM.CiscoFlashFiles

NCM.NodeHostsCiscoFlashFiles (System.Hosting)

CiscoImageMIB

NCM.CiscoImageMIB

NCM.NodeHostsCiscoImageMIB (System.Hosting)

CiscoMemoryPools

NCM.CiscoMemoryPools

NCM.NodeHostsCiscoMemoryPools (System.Hosting)

EntityLogical

NCM.EntityLogical

NCM.NodeHostsEntityLogical (System.Hosting)

EntityPhysical

NCM.EntityPhysical

NCM.NodeHostsEntityPhysical (System.Hosting)

PortsTcp

NCM.PortsTcp

NCM.NodeHostsPortsTcp (System.Hosting)

PortsUdp

NCM.PortsUdp

NCM.NodeHostsPortsUdp (System.Hosting)

RouteTable

NCM.RouteTable

NCM.NodeHostsRouteTable (System.Hosting)

NCM.Nodes with a custom property

 

NCM.PortsTcp

Property Name

Datatype

Description

NodeID

System.String

The unique identifier of a network node subject to configuration actions.

LastDiscovery

System.DateTime

Date and time NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

Date and time NCM first discovered the device during inventory.

TCPLocalAddress

System.String

The local IP address for this TCP connection. In the case of a connection in the listen state that is willing to accept connections for any IP interface associated with the node, the value 0.0.0.0 is used.

TCPLocalPort

System.Int32

The local port number for this TCP connection.

TCPLocalPortName

System.String

Port description based on TCPLocalPort value.

TCPRemoteAddress

System.String

The remote IP address for this TCP connection.

TCPRemotePort

System.Int32

The remote port number for this TCP connection.

TCPState

System.String

The state of this TCP connection.

The only value that may be set by a management station is deleteTCB(12). Accordingly, it is appropriate for an agent to return a 'badValue' response if a management station attempts to set this object to any other value.

If a management station sets this object to the value deleteTCB(12) , then this has the effect of deleting the TCB (as defined in RFC 793) of the corresponding connection on the managed node, resulting in immediate termination of the connection.

As an implementation-specific option, a RST segment may be sent from the managed node to the other TCP endpoint (note however that RST segments are not sent reliably).

TCPRemotePortName

System.String

Port description based on TCPRemotePort value.

NCM.PortsTcp entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsPortsTcp (System.Hosting)

NCM.PortsUdp

Property Name

Datatype

Description

NodeID

System.String

The unique identifier of a network node subject to configuration actions.

LastDiscovery

System.DateTime

Date and time NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

Date and time NCM first discovered the device during inventory.

UDPAddress

System.String

The local IP address for this UDP listener. In the case of a UDP listener that is willing to accept datagrams for any IP interface associated with the node, the value 0.0.0.0 is used.

UDPPort

System.Int32

The local port number for this UDP listener.

UDPPortName

System.String

Port description based on UDPPort value (like 161- SNMP).

NCM.PortsUdp entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsPortsUdp (System.Hosting)

NCM.RouteTable

Property Name

Datatype

Description

NodeID

System.String

The unique identifier of a network node subject to configuration actions.

LastDiscovery

System.DateTime

Date and time NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

Date and time NCM first discovered the device during inventory.

InterfaceIndex

System.Int32

The index value that uniquely identifies the local interface through which the next hop of this route should be reached. The interface identified by a particular value of this index is the same interface as identified by the same value of ifIndex.

InterfaceID

System.String

Indicate the mask to be logical-ANDed with the destination address before being compared to the value in the ipRouteDest field. For those systems that do not support arbitrary subnet masks , an agent constructs the value of the ipRouteMask by determining whether the value of the correspondent ipRouteDest field belong to a class-A , B , or C network , and then using one of:

  • mask network
  • 255.0.0.0 class-A
  • 255.255.0.0 class-B
  • 255.255.255.0 class-C

If the value of the ipRouteDest is 0.0.0.0 (a default route), then the mask value is also 0.0.0.0. Note that all IP routing subsystems implicitly use this mechanism.

Destination

System.String

The type of route. Note that the values direct(3) and indirect(4) refer to the notion of direct and indirect routing in the IP architecture. Setting this object to the value invalid(2) has the effect of invalidating the corresponding entry in the ipRouteTable object. That is, it effectively disassociates the destination identified with said entry from the route identified with said entry. It is an implementation-specific matter as to whether the agent removes an invalidated entry from the table.

Accordingly, management stations must be prepared to receive tabular information from agents that corresponds to entries not currently in use. Proper interpretation of such entries requires examination of the relevant ipRouteType object.

Possible Values:

  • other(1)
  • invalid(2)
  • direct(3)
  • indirect(4)

Mask

System.String

The routing mechanism through which this route was learned. Inclusion of values for gateway routing protocols is not intended to imply that hosts should support those protocols.

Possible Values:

  • other(1)
  • local(2)
  • netmgmt(3)
  • icmp(4)
  • egp(5)
  • ggp(6)
  • hello(7)
  • rip(8)
  • is-is(9)
  • es-is(10)
  • ciscoIgrp(11)
  • bbnSpfIgp(12)
  • ospf(13)
  • bgp(14)

NextHop

System.String

The number of seconds since this route was last updated or otherwise determined to be correct. Note that no semantics of 'too old' can be implied except through knowledge of the routing protocol by which the route was learned.

RouteType

System.String

The IP address of the next hop of this route. (In the case of a route bound to an interface that is realized via a broadcast media, the value of this field is the agent's IP address on that interface.)

RouteProtocol

System.String

The primary routing metric for this route. The semantics of this metric are determined by the routing-protocol specified in the route's ipRouteProto value. If this metric is not used, its value should be set to -1.

RouteAge

System.Int32

An alternate routing metric for this route. The semantics of this metric are determined by the routing-protocol specified in the route's ipRouteProto value. If this metric is not used, its value should be set to -1.

NextHopAS

System.Int32

An alternate routing metric for this route. The semantics of this metric are determined by the routing-protocol specified in the route's ipRouteProto value. If this metric is not used, its value should be set to -1.

Metric1

System.Int32

An alternate routing metric for this route. The semantics of this metric are determined by the routing-protocol specified in the route's ipRouteProto value. If this metric is not used, its value should be set to -1.

Metric2

System.Int32

An alternate routing metric for this route. The semantics of this metric are determined by the routing-protocol specified in the route's ipRouteProto value. If this metric is not used, its value should be set to -1.

Metric3

System.Int32

The index value that uniquely identifies the local interface through which the next hop of this route should be reached. The interface identified by a particular value of this index is the same interface as identified by the same value of ifIndex.

Metric4

System.Int32

Indicate the mask to be logical-ANDed with the destination address before being compared to the value in the ipRouteDest field. For those systems that do not support arbitrary subnet masks, an agent constructs the value of the ipRouteMask by determining whether the value of the correspondent ipRouteDest field belong to a class-A, B, or C network, and then using one of:

  • mask network
  • 255.0.0.0 class-A
  • 255.255.0.0 class-B
  • 255.255.255.0 class-C

If the value of the ipRouteDest is 0.0.0.0 (a default route) , then the mask value is also 0.0.0.0. Note that all IP routing subsystems implicitly use this mechanism.

Metric5

System.Int32

The type of route. Note that the values direct(3) and indirect(4) refer to the notion of direct and indirect routing in the IP architecture.

Setting this object to the value invalid(2) has the effect of invalidating the corresponding entry in the ipRouteTable object. That is, it effectively disassociates the destination identified with said entry from the route identified with said entry. It is an implementation-specific matter as to whether the agent removes an invalidated entry from the table. Accordingly, management stations must be prepared to receive tabular information from agents that corresponds to entries not currently in use. Proper interpretation of such entries requires examination of the relevant ipRouteType object.

Possible Values:

  • other(1)
  • invalid(2)
  • direct(3)
  • indirect(4)

NCM.RouteTable entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsRouteTable (System.Hosting)

NCM.VLANs

Property Name

Datatype

Description

NodeID

System.String

The unique identifier of a network node subject to configuration actions.

LastDiscovery

System.DateTime

Date and time NCM last discovered the device during inventory.

FirstDiscovery

System.DateTime

Date and time NCM first discovered the device during inventory.

VLANID

System.Int32

The set of the device's member ports that belong to the VLAN. Each octet within the value of this object specifies a set of eight ports, with the first octet specifying ports 1 through 8, the second octet specifying ports 9 through 16, etc. Within each octet, the most significant bit represents the lowest numbered port, and the least significant bit represents the highest numbered port. Thus, each port of the VLAN is represented by a single bit within the value of this object. If that bit has a value of '1' then that port is included in the set of ports ; the port is not included if its bit has a value of '0'. A port number is the value of dot1dBasePort for the port in the BRIDGE-MIB (RFC 1493).

VLANName

System.String

The name of this VLAN. This name is used as the ELAN-name for an ATM LAN-Emulation segment of this VLAN.

VLANMTU

System.Int32

The MTU size on this VLAN, defined as the size of largest MAC-layer (information field portion of the) data frame that can be transmitted on the VLAN.

VLANType

System.Int32

The type of this VLAN

VLANState

System.Int32

The state of this VLAN.

Possible Values:

  • operational(1)
  • suspended(2)
  • mtuTooBigForDevice(3)
  • mtuTooBigForTrunk(4)

NCM.VLANs entity relationships

Type

Entity

Joined Data Entity

Node

NCM.Nodes

NCM.NodeHostsVLANs (System.Hosting)

Custom properties

You can reference a custom property in a config change template using the NCM.Nodes entity. An example can be found here.