NCM.Interfaces
SolarWinds Information Service 2024.4 Schema Documentation
Interfaces data For valid Orion user with at least WebViewer NCM role. Read-only.
Inheritance
Access control
everyone
Properties
| Name | Type | Summary | Access Control |
|---|---|---|---|
| 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. | everyone |
| 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. | everyone |
| 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. | everyone |
| 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. | everyone |
| 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. | everyone |
| 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. | everyone |
| 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. | everyone |
| InterfaceSpeed | System.Double | 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. | everyone |
| 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. | everyone |
| 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). | everyone |
| 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. | everyone |
| 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. | everyone |
| 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. | everyone |
| PhysicalInterface | System.Char | This object has the value 'true(1)' if the interface sublayer has a physical connector and the value 'false(2)' otherwise. | everyone |
| 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. |
everyone |
| InterfaceID | System.Guid | Interface ID. Primary key. | everyone |
| NodeID | System.Guid | 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.) | everyone |
| LastDiscovery | System.DateTime | A SWIS-generated date and time marker for when NCM last discovered the device during inventory. | everyone |
| FirstDiscovery | System.DateTime | A SWIS-generated date and time marker for when NCM first discovered the device during inventory. | everyone |
| Missing | System.Boolean | Not used. | everyone |
| 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). | everyone |
| 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) |
everyone |
| VlanType | System.String | The type of this VLAN | everyone |
| InterfaceHighSpeed | System.Double | High speed interface. | everyone |
Source Relationships
| Name | Type | Notes |
|---|---|---|
| ArpTables | NCM.ArpTables | Defined by relationship NCM.InterfacesRefArpTables (System.Reference) |
| BridgePorts | NCM.BridgePorts | Defined by relationship NCM.InterfacesRefBridgePorts (System.Reference) |
| CiscoCdp | NCM.CiscoCdp | Defined by relationship NCM.InterfacesRefCiscoCdp (System.Reference) |
| RouteTable | NCM.RouteTable | Defined by relationship NCM.InterfacesRefRouteTable (System.Reference) |
| IpAddresses | NCM.IpAddresses | Defined by relationship NCM.InterfaceHostsIpAddresses (System.Hosting) |
| CATOSPorts | NCM.CATOSPorts | Defined by relationship NCM.InterfacesRefCATOSPorts (System.Reference) |
Target Relationships
| Name | Type | Notes |
|---|---|---|
| NodeProperties | NCM.NodeProperties | Defined by relationship NCM.NodePropertiesRefInterfaces (System.Reference) |
| Node | NCM.Nodes | Defined by relationship NCM.NodeHostsInterfaces (System.Hosting) |