Orion.NPM.Interfaces
SolarWinds Information Service 2024.4 Schema Documentation
This entity presents information about Node interfaces
Inheritance
Access control
| Operations | Right |
|---|---|
| read | everyone |
| create,read,update,delete,invoke | manageNodes |
Properties
| Name | Type | Summary | Access Control |
|---|---|---|---|
| NodeID | System.Int32 | ID of parent node. | everyone |
| InterfaceID | System.Int32 | Interface ID. Primary key. | everyone |
| ObjectSubType | System.String | String representation of object sub type: None, SNMP, WMI, ICMP, Agent. | everyone |
| Name | System.String | String value that contains the name of the agent. | everyone |
| Index | System.Int32 | Number value that uniquely identifies the interface. | everyone |
| Icon | System.String | String value containing a file name of interface Icon. Example:6.gif. | everyone |
| Type | System.Int32 | Integer value indicating interface type, stored in system in table InterfaceTypes. | everyone |
| TypeName | System.String | String value indicating interface type name. Example:ethernetCsmacd. | everyone |
| TypeDescription | System.String | String value indicating interface type description. Example:Ethernet. | everyone |
| Speed | System.Double | Interface's current bandwidth in bits per second. | everyone |
| MTU | 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 | Timestamp when interface state changed last time. | everyone |
| PhysicalAddress | System.String | String value of physical (MAC) address of interface. | everyone |
| AdminStatus | System.Int16 | Integer value indicating 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 AdminStatus in the down(2) state. As a result of either explicit management action or per configuration information retained by the managed system, AdminStatus is then changed to either the up (1) or testing (3) states (or remains in the down (2) state). Possible Values: * Unknown = 0 * Up = 1 * Down = 2 * Testing = 3. |
everyone |
| OperStatus | System.Int16 | The current operational state of the interface. The testing (3) state indicates that no operational packets can be passed. If AdminStatus is down (2) then OperStatus should be down (2). If AdminStatus is changed to up (1) then OperStatus 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. Possible Values: * Up = 1 * Down = 2 * Testing = 3 * Unknown = 4 * Dormant = 5 * NotPresent = 6 * LowerLayerDown = 7 |
everyone |
| StatusIcon | System.String | String value containing a file name of interface status Icon. Example:Unknown.gif. | everyone |
| InBandwidth | System.Double | Interface's current IN bandwidth in bits per second that can be set manually. | everyone |
| OutBandwidth | System.Double | Interface's current Out bandwidth in bits per second that can be set manually. | everyone |
| Caption | System.String | The string value that contains interface caption. Example:Local Netflow Source. | everyone |
| FullName | System.String | The string value that contains interface full name. | everyone |
| Outbps | System.Single | Current Outbound traffic, bits per second. | everyone |
| Inbps | System.Single | Current Inbound traffic, bits per second. | everyone |
| Bps | System.Double | Current traffic, bits per second. | everyone |
| OutPercentUtil | System.Single | Outbound interface utilization in percents. | everyone |
| InPercentUtil | System.Single | Inbound interface utilization in percents. | everyone |
| PercentUtil | System.Double | Interface utilization in percents. | everyone |
| OutPps | System.Single | Current Outbound traffic, packets per second. | everyone |
| InPps | System.Single | Current Inbound traffic, packets per second. | everyone |
| InPktSize | System.Int16 | Inbound packet size in bytes. | everyone |
| OutPktSize | System.Int16 | Outbound packet size in bytes. | everyone |
| OutUcastPps | System.Single | Current outbound unicast traffic, packets per second. | everyone |
| OutMcastPps | System.Single | Current outbound multicast traffic, packets per second. | everyone |
| InUcastPps | System.Single | Current inbound unicast traffic, packets per second. | everyone |
| InMcastPps | System.Single | Current inbound multicast traffic, packets per second. | everyone |
| InDiscardsThisHour | System.Single | Count of discarded inbound packets for this hour. | everyone |
| InDiscardsToday | System.Single | Count of discarded inbound packets for today. | everyone |
| InErrorsThisHour | System.Single | Count of inbound packets with errors for this hour. | everyone |
| InErrorsToday | System.Single | Count of inbound packets with errors for today. | everyone |
| OutDiscardsThisHour | System.Single | Count of discarded outbound packets for this hour. | everyone |
| OutDiscardsToday | System.Single | Count of discarded outbound packets for today. | everyone |
| OutErrorsThisHour | System.Single | Count of outbound packets with errors for this hour. | everyone |
| OutErrorsToday | System.Single | Count of outbound packets with errors for today. | everyone |
| CRCAlignErrorsThisHour | System.Single | Count of CRCAlignErrors (Cyclic Redundancy Check) on interface for this hour. | everyone |
| CRCAlignErrorsToday | System.Single | Count of CRCAlignError (Cyclic Redundancy Check) on interface for today. | everyone |
| LateCollisionsThisHour | System.Single | Count of LateCollisions on interface for this hour.. | everyone |
| LateCollisionsToday | System.Single | Count of LateCollisions on interface for today.. | everyone |
| MaxInBpsToday | System.Single | Max value of Inbound traffic for interface for today, bits per second.. | everyone |
| MaxInBpsTime | System.DateTime | Max value of Inbound traffic for interface, bits per second.. | everyone |
| MaxOutBpsToday | System.Single | Max value of Outbound traffic for today, bits per second. | everyone |
| MaxOutBpsTime | System.DateTime | Timestamp when maximum value of Outbound traffic was reached. | everyone |
| Counter64 | System.Char | Char value that indicates if interface supports 64-bit counters. Example:'Y','N'. | everyone |
| LastSync | System.DateTime | Timestamp when interface data was sync. | everyone |
| Alias | 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 |
| IfName | 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 |
| Severity | System.Int32 | Severity of Interface. When the Status property is changed on the Interface, Severity is also affected. If status is Down, Severity is 1000 (Down), when status is Unknows or Warning, Severity is 1 (Warning), everything else Severity is 0. |
everyone |
| CustomBandwidth | System.Boolean | Indicates if interface is configured to use custom bandwidth value. | everyone |
| CustomPollerLastStatisticsPoll | System.DateTime | Timestamp when interface statistics was polled last time by custom poller. | everyone |
| PollInterval | System.Int32 | Interval of polling interface in seconds. | everyone |
| NextPoll | System.DateTime | Timestamp when interface will be polled next time. | everyone |
| RediscoveryInterval | System.Int32 | Interval of rediscovery interface in minutes. | everyone |
| NextRediscovery | System.DateTime | Timestamp when interface will be rediscovered next time. | everyone |
| StatCollection | System.Int32 | Interval of collecting statistics for interface in minutes. | everyone |
| UnPluggable | System.Boolean | Indicates if interface is unpluggable. | everyone |
| InterfaceSpeed | System.Double | Interface's current bandwidth in bits per second. | everyone |
| InterfaceCaption | System.String | The string value that contains interface caption. | everyone |
| InterfaceType | System.Int32 | Integer value indicating interface type, stored in system in table InterfaceTypes. | everyone |
| InterfaceSubType | System.Int32 | Integer value indicating interface SUB type, stored in system in table InterfaceTypes. | everyone |
| MAC | System.String | MAC address of interface. | everyone |
| InterfaceName | System.String | Name of interface. | everyone |
| InterfaceIcon | System.String | String value containing a file name of interface Icon. Example:6.gif. | everyone |
| InterfaceTypeName | System.String | String value indicating interface type name. | everyone |
| AdminStatusLED | System.String | String value containing a file name of interface Admin status Icon. Example:'Up.gif'. | everyone |
| OperStatusLED | System.String | String value containing a file name of interface Oper status Icon. Example:'Up.gif'. | 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. Aligns with Alias field. |
everyone |
| InterfaceIndex | System.Int32 | Number value that uniquely identifies the interface. Aligns with Index field. | everyone |
| InterfaceLastChange | System.DateTime | Timestamp when interface state changed last time by Collector. | 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 |
| InterfaceTypeDescription | System.String | String value indicating interface type description. | everyone |
| OrionIdPrefix | System.String | Orion id prefix. Example:'I:'. | everyone |
| OrionIdColumn | System.String | Column name that contains Orion object ID InterfaceID. | everyone |
| DuplexMode | System.Int32 | Specifies if interface supports duplex mode. | everyone |
| SkippedPollingCycles | System.Int32 | Number of skipped polling cycles. | everyone |
| MinutesSinceLastSync | System.Int32 | Number of minutes since last sync. | everyone |
| Status | System.Int32 | Status of interface. Status is calculated from the AdminStatus and OperStatus properties. Possible Values: * Unknown = 0 * Up = 1 * Down = 2 * Warning = 3 * Shutdown = 4 * Unmanaged = 9 * Unplugged = 10 * Unreachable = 12. |
everyone |
| InterfaceResponding | System.Boolean | States if interface is responding. If status is Unknown, then 0 else 1. | everyone |
| Description | System.String | Description of interface. | everyone |
| DetailsUrl | System.String | Url of interface details page. | everyone |
| ObsoleteDataCurrentSettingValue | System.Int32 | Number of polling intervals before Interfaces data is considered obsolete. Default value is 3. | everyone |
| ObsoleteDataFeatureStatus | System.Int32 | Enables to turn the feature Obsolete Interface data on or off. Default value is 1 (on). | everyone |
| HasObsoleteData | System.Boolean | Indicator that states if interface data is obsolete: 1 if interfase data is obsolete, otherwise 0. | everyone |
| ModernIcon | System.String | Nova icon name for the entity. | everyone |
Source Relationships
| Name | Type | Notes |
|---|---|---|
| OutApplicationTcpConnections | Orion.APM.ApplicationTcpConnection | Defined by relationship Orion.APM.ApplicationTcpConnectionReferencesClientInterface (System.Reference) |
| InApplicationTcpConnections | Orion.APM.ApplicationTcpConnection | Defined by relationship Orion.APM.ApplicationTcpConnectionReferencesServerInterface (System.Reference) |
| ASAInterface | Orion.ASA.Interfaces | Defined by relationship Orion.InterfaceHostsASAInterface (System.Hosting) |
| CBQoSPolicies | Orion.Netflow.CBQoSPolicy | Defined by relationship Orion.Netflow.InterfaceReferencesCBQoSPolicy (System.Reference) |
| CBQoSSource | Orion.Netflow.CBQoSSource | Defined by relationship Orion.Netflow.InterfaceReferencesCBQoSSource (System.Reference) |
| CustomProperties | Orion.NPM.InterfacesCustomProperties | Defined by relationship Orion.NPM.InterfaceHostsCustomProperties (System.Hosting) |
| InErrorsDiscardsThreshold | Orion.NPM.InErrorsDiscardsThreshold | Defined by relationship Orion.NPM.InErrorsDiscardsThreshold (System.Hosting) |
| OutErrorsDiscardsThreshold | Orion.NPM.OutErrorsDiscardsThreshold | Defined by relationship Orion.NPM.OutErrorsDiscardsThreshold (System.Hosting) |
| InPercentUtilizationThreshold | Orion.NPM.InPercentUtilizationThreshold | Defined by relationship Orion.NPM.InPercentUtilizationThreshold (System.Hosting) |
| OutPercentUtilizationThreshold | Orion.NPM.OutPercentUtilizationThreshold | Defined by relationship Orion.NPM.OutPercentUtilizationThreshold (System.Hosting) |
| InterfaceDowntimeHistory | Orion.NPM.InterfaceNetObjectDowntime | Defined by relationship Orion.NPM.InterfaceHostsNetObjectDowntime (System.Hosting) |
| Errors | Orion.NPM.InterfaceErrors | Defined by relationship Orion.NPM.InterfacesHostsInterfaceErrors (System.Hosting) |
| Traffic | Orion.NPM.InterfaceTraffic | Defined by relationship Orion.NPM.InterfacesHostsInterfaceTraffic (System.Hosting) |
| WebUri | Orion.NPM.InterfaceWebUri | Defined by relationship Orion.NPM.InterfacesHostsWebUri (System.Hosting) |
| Availability | Orion.NPM.InterfaceAvailability | Defined by relationship Orion.NPM.InterfacesHostsInterfaceAvailability (System.Reference) |
| InterfacePortMaps | Orion.NodePortInterfaceMap | Defined by relationship Orion.NPM.InterfacesReferencesNodePortInterfaceMaps (System.Reference) |
| IPAddress | Orion.NodeIPAddresses | Defined by relationship Orion.NPM.InterfaceIPAddress (System.Reference) |
| ForecastCapacity | Orion.NPM.InterfacesForecastCapacity | Defined by relationship Orion.NPM.InterfacesHostsForecastCapacity (System.Hosting) |
| VoIPCallManager | Orion.IpSla.CCMMonitoring | Defined by relationship Orion.Ipsla.CCMMonitoringReferencesInterfaces (System.Reference) |
| VoIPInterface | Orion.IpSla.InfrastructureNodes | Defined by relationship Orion.Ipsla.InfrastructureNodesReferencesInterfaces (System.Reference) |
| MulticastInterface | Orion.NPM.MulticastRouting.Interfaces | Defined by relationship Orion.NPM.MulticastRouting.InterfaceHostsMulticastInterface (System.Hosting) |
| IngressFlows | Orion.Netflow.Flows | Defined by relationship Orion.Netflow.IngressInterfacesReferencesFlows (System.Reference) |
| EgressFlows | Orion.Netflow.Flows | Defined by relationship Orion.Netflow.EgressInterfacesReferencesFlows (System.Reference) |
| IngressFlowsByIP | Orion.Netflow.FlowsByIP | Defined by relationship Orion.Netflow.IngressInterfacesReferencesFlowsByIP (System.Reference) |
| EgressFlowsByIP | Orion.Netflow.FlowsByIP | Defined by relationship Orion.Netflow.EgressInterfacesReferencesFlowsByIP (System.Reference) |
| IngressFlowsByHostname | Orion.Netflow.FlowsByHostname | Defined by relationship Orion.Netflow.IngressInterfacesReferencesFlowsByHostname (System.Reference) |
| EgressFlowsByHostname | Orion.Netflow.FlowsByHostname | Defined by relationship Orion.Netflow.EgressInterfacesReferencesFlowsByHostname (System.Reference) |
| IngressFlowsByAS | Orion.Netflow.FlowsByAS | Defined by relationship Orion.Netflow.IngressInterfacesReferencesFlowsByAS (System.Reference) |
| EgressFlowsByAS | Orion.Netflow.FlowsByAS | Defined by relationship Orion.Netflow.EgressInterfacesReferencesFlowsByAS (System.Reference) |
| IngressFlowsByInterface | Orion.Netflow.FlowsByInterface | Defined by relationship Orion.Netflow.IngressInterfacesReferencesFlowsByInterface (System.Reference) |
| EgressFlowsByInterface | Orion.Netflow.FlowsByInterface | Defined by relationship Orion.Netflow.EgressInterfacesReferencesFlowsByInterface (System.Reference) |
| IngressFlowsByDomain | Orion.Netflow.FlowsByDomain | Defined by relationship Orion.Netflow.IngressInterfacesReferencesFlowsByDomain (System.Reference) |
| EgressFlowsByDomain | Orion.Netflow.FlowsByDomain | Defined by relationship Orion.Netflow.EgressInterfacesReferencesFlowsByDomain (System.Reference) |
| IngressFlowsByCountryCode | Orion.Netflow.FlowsByCountryCode | Defined by relationship Orion.Netflow.IngressInterfacesReferencesFlowsByCountryCode (System.Reference) |
| EgressFlowsByCountryCode | Orion.Netflow.FlowsByCountryCode | Defined by relationship Orion.Netflow.EgressInterfacesReferencesFlowsByCountryCode (System.Reference) |
| IngressFlowsByConversation | Orion.Netflow.FlowsByConversation | Defined by relationship Orion.Netflow.IngressInterfacesReferencesFlowsByConversation (System.Reference) |
| EgressFlowsByConversation | Orion.Netflow.FlowsByConversation | Defined by relationship Orion.Netflow.EgressInterfacesReferencesFlowsByConversation (System.Reference) |
| Flows | Orion.Netflow.FlowsByInterface | Defined by relationship Orion.Netflow.FlowsByInterfaceReferencesInterface (System.Reference) |
| NetFlowSource | Orion.Netflow.Source | Defined by relationship Orion.Netflow.InterfaceReferencesSource (System.Reference) |
| CustomPollerAssignmentOnInterface | Orion.NPM.CustomPollerAssignmentOnInterface | Defined by relationship Orion.NPM.InterfacesHostsCustomPollerAssignmentOnInterface (System.Hosting) |
| VRFInterfaces | Orion.Routing.VRFInterface | Defined by relationship Orion.NPM.InterfacesReferencesVRFInterfaces (System.Reference) |
Target Relationships
| Name | Type | Notes |
|---|---|---|
| EWEntity | Orion.NPM.EW.Entity | Defined by relationship Orion.EWEntityReferencesInterface (System.Reference) |
| FCPort | Orion.NPM.FCPorts | Defined by relationship Orion.NPM.PortsReferenceInterfaces (System.Reference) |
| Node | Orion.Nodes | Defined by relationship Orion.NodeHostsInterfaces (System.Hosting) |
| SwitchPortAsSource | Orion.NPM.OrionSwitchPortMapping | Defined by relationship Orion.SwitchPortMappingReferencesSourceInterface (System.Reference) |
| SwitchPortAsMapping | Orion.NPM.OrionSwitchPortMapping | Defined by relationship Orion.SwitchPortMappingReferencesMappedInterface (System.Reference) |
| VirtualPortChannel | Orion.Nexus.VirtualPortChannel | Defined by relationship Orion.VirtualPortChannelReferencesInterface (System.Reference) |
| VirtualPortChannelInterface | Orion.Nexus.VirtualPortChannelInterfaces | Defined by relationship Orion.VirtualPortChannelInterfaceReferencesInterface (System.Reference) |
Verbs
SetPowerLevel
Set interface power level.Id of Interface to update.Power level to set for interface.
Access control
| Operations | Right |
|---|---|
| invoke | manageNodes |
Unmanage
Unmanage interface for specified time.Id of net object (interface) to unmanage. Example:'I:1'.TimeStamp value to unmanage interface from.TimeStamp value to manage interface from.If is true that remanageTime will be unmanageTime + remanageTime.TimeOfDay.
Access control
| Operations | Right |
|---|---|
| invoke | allowUnmanage |
Remanage
Manage interface immediately.Id of net object (interface) to unmanage. Example:'I:1'.
Access control
| Operations | Right |
|---|---|
| invoke | allowUnmanage |
DiscoverInterfacesOnNode
Run lite discovery process for search interfaces on node and returns list of interfaces.Id of node to run discovery on.Discovery results that contains status and discovered interfaces. Full type: SolarWinds.Interfaces.Common.Models.Discovery.LiteDiscoveryResult.
Access control
everyone
AddInterfacesOnNode
Add provided interface to node.Id of node to add interfaces for.Array of interfaces to add. Full type: SolarWinds.Interfaces.Common.Models.Discovery.DiscoveredLiteInterfaceDiscovery results that contains status and discovered interfaces. Full type: SolarWinds.Interfaces.Common.Models.Discovery.LiteDiscoveryResult.
Access control
| Operations | Right |
|---|---|
| invoke | manageNodes |
CreateInterfacesPluginConfiguration
Create interface plugin configuration based on provided input data.Interfaces discovery plugin context. Full type: SolarWinds.Data.Providers.Interfaces.Verbs.InterfacesDiscoveryPluginContext.String with interface plugin configuration in XML format. Full type: SolarWinds.Data.Providers.Interfaces.Verbs.InterfacesDiscoveryPluginContext
Access control
everyone