AutoPatrol, Bureaucrats, Administrators
481
edits
Difference between revisions of "NXSL:Interface"
m
Text replacement - "^" to "{{deprecated}}"
m (Text replacement - "^" to "{{deprecated}}") |
|||
| (12 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
Represents interface object. | {{deprecated}}Represents interface object. | ||
| Line 8: | Line 8: | ||
'''Attributes''' | '''Attributes''' | ||
Inherits all attributes of the [[NXSL:NetObj|NetObj class]]. | |||
{| class="wikitable" | {| class="wikitable" | ||
| Line 14: | Line 16: | ||
|- | |- | ||
| adminState || int32 || Administrative state | | adminState || int32 || Administrative state | ||
|- | |||
| alias || string || Interface alias (usually value of SNMP ifAlias) | |||
|- | |- | ||
| bridgePortNumber || uint32 || Bridge port number for this interface | | bridgePortNumber || uint32 || Bridge port number for this interface | ||
|- | |- | ||
| description || string || Interface description | | description || string || Interface description | ||
| Line 25: | Line 27: | ||
| dot1xBackendAuthState || int32 || 802.1x back-end 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 | | ifIndex || int32 || Interface index | ||
|- | |- | ||
| ifType || int32 || Interface type | | ifType || int32 || Interface type | ||
|- | |||
| ipAddressList || array (of [[NXSL:InetAddress|InetAddress]]) || List of IP addresses configured on interface | |||
|- | |- | ||
| isExcludedFromTopology || boolean || TRUE if this interface excluded from network topology | | isExcludedFromTopology || boolean || TRUE if this interface excluded from network topology | ||
| Line 39: | Line 45: | ||
| isPhysicalPort || boolean || TRUE if this interface object represents physical port | | 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 | | name || string || Object name | ||
|- | |||
| node || object ([[NXSL:Node|Node]]) || Parent node object | |||
|- | |- | ||
| operState || int32 || Operational state | | operState || int32 || Operational state | ||
|- | |- | ||
| | | peerInterface || object ([[NXSL:Interface|Interface]]) || Peer interface object if known, otherwise '''null''' | ||
|- | |||
| peerNode || object ([[NXSL:Node|Node]]) || Peer node object if known, otherwise '''null''' | |||
|- | |||
| port|| int32 || Port number | |||
|- | |||
| slot|| int32 || Slot number | |||
|- | |||
| speed || uint64 || Speed of the interface | |||
|- | |||
| zone || object ([[NXSL:Zone|Zone]]) || Zone object ('''null''' if zoning is disabled) | |||
|- | |||
| zoneId || int32 || Zone ID (0 if zoning is disabled) | |||
|} | |} | ||
| Line 63: | Line 85: | ||
| 3 || Testing | | 3 || Testing | ||
|} | |} | ||
'''Methods''' | |||
{| class="wikitable" | |||
|- | |||
! Name !! Parameters !! Return value !! Description | |||
|- | |||
| [[NXSL:Interface:setExcludeFromTopology|setExcludeFromTopology]] || boolean || none ||Set or clear "exclude from topology" flag on interface | |||
|- | |||
| [[NXSL:Interface:setExpectedState|setExpectedState]] || string || none || Set interface expected state | |||
|} | |||
[[Category:NXSL Class Reference]] | |||