Difference between revisions of "NXSL:Interface"

From NetXMS Wiki
Jump to navigation Jump to search
m (Added category)
m (Text replacement - "^" to "{{deprecated}}")
 
(8 intermediate revisions by 2 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
|-
| comments || string || Comments
|-
|-
| 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
|-
|-
| guid || string || Object's GUID
| expectedState || int32 || Interface expected state. Possible values are 0 (up), 1 (down), and 2 (ignore).
|-
|-
| id || uint32 || Object's identifier
| 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 40: Line 44:
|-
|-
| 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
|-
|-
| macAddr || string || MAC address
| macAddr || string || MAC address
|-
| mtu || int32 || Interface MTU (0 if unknown)
|-
|-
| name || string || Object name
| name || string || Object name
Line 57: Line 61:
| peerNode || object ([[NXSL:Node|Node]]) || Peer node object if known, otherwise '''null'''
| peerNode || object ([[NXSL:Node|Node]]) || Peer node object if known, otherwise '''null'''
|-
|-
| status || int32 || Object status
| 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 72: Line 84:
|-
|-
| 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]]
[[Category:NXSL Class Reference]]

Latest revision as of 18:13, 13 September 2022

This Wiki is deprecated and we are are currrently migrating remaining pages into product documentation (Admin Guide, NXSL Guide)

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
ipAddressList array (of InetAddress) List of IP addresses configured on interface
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

Methods

Name Parameters Return value Description
setExcludeFromTopology boolean none Set or clear "exclude from topology" flag on interface
setExpectedState string none Set interface expected state
Retrieved from "https://wiki.netxms.org/index.php?title=NXSL:Interface&oldid=1910"