Difference between revisions of "NXSL:Interface"

From NetXMS Wiki
Jump to navigation Jump to search
(Specified attributes are inhereted from NetObj and fixed missing attributes)
Line 8: Line 8:


'''Attributes'''
'''Attributes'''
Inherits all attributes of the [[NXSL:NetObj|NetObj class]].


{| class="wikitable"
{| class="wikitable"
Line 18: Line 20:
|-
|-
| bridgePortNumber || uint32 || Bridge port number for this interface
| bridgePortNumber || uint32 || Bridge port number for this interface
|-
| comments || string || Comments
|-
|-
| description || string || Interface description
| description || string || Interface description
Line 30: Line 30:
|-
|-
| flags || uint32 || Interface flags (bit mask)
| flags || uint32 || Interface flags (bit mask)
|-
| guid || string || Object's GUID
|-
| id || uint32 || Object's identifier
|-
|-
| ifIndex || int32 || Interface index
| ifIndex || int32 || Interface index
Line 46: Line 42:
|-
|-
| isPhysicalPort || boolean  || TRUE if this interface object represents physical port
| isPhysicalPort || boolean  || TRUE if this interface object represents physical port
|-
| ipAddr || string || IP address
|-
|-
| ipNetMask || string || IP network mask
| ipNetMask || string || IP network mask
Line 69: Line 63:
| slot|| int32 || Slot number
| slot|| int32 || Slot number
|-
|-
| status || int32 || Object status
| speed || uint64 || Speed of the interface
|-
|-
| zone || object ([[NXSL:Zone|Zone]]) || Zone object ('''null''' if zoning is disabled)
| zone || object ([[NXSL:Zone|Zone]]) || Zone object ('''null''' if zoning is disabled)

Revision as of 14:52, 25 January 2016

Represents interface object.


Class Name

Interface


Attributes

Inherits all attributes of the NetObj class.

Name Type Description
adminState int32 Administrative state
alias string Interface alias (usually value of SNMP ifAlias)
bridgePortNumber uint32 Bridge port number for this interface
description string Interface description
dot1xPaeAuthState int32 802.1x PAE authentication state
dot1xBackendAuthState int32 802.1x back-end authentication state
expectedState int32 Interface expected state. Possible values are 0 (up), 1 (down), and 2 (ignore).
flags uint32 Interface flags (bit mask)
ifIndex int32 Interface index
ifType int32 Interface type
isExcludedFromTopology boolean TRUE if this interface excluded from network topology
isLoopback boolean TRUE if this interface is a loopback
isManuallyCreated boolean TRUE if this interface object was created manually by NetXMS administrator
isPhysicalPort boolean TRUE if this interface object represents physical port
ipNetMask string IP network mask
macAddr string MAC address
mtu int32 Interface MTU (0 if unknown)
name string Object name
node object (Node) Parent node object
operState int32 Operational state
peerInterface object (Interface) Peer interface object if known, otherwise null
peerNode object (Node) Peer node object if known, otherwise null
port int32 Port number
slot int32 Slot number
speed uint64 Speed of the interface
zone object (Zone) Zone object (null if zoning is disabled)
zoneId int32 Zone ID (0 if zoning is disabled)

Possible values for adminState and operState are following:

Value Meaning
0 Unknown
1 Up
2 Down
3 Testing