Difference between revisions of "NXSL:Node"

Jump to navigation Jump to search

NXSL:Node (view source)

Revision as of 18:13, 13 September 2022

1,316 bytes added ,  18:13, 13 September 2022
m
Text replacement - "^" to "{{deprecated}}"
m (Text replacement - "^" to "{{deprecated}}")
 
(18 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Represents NetXMS node object.
{{deprecated}}Represents NetXMS node object.


'''Class Name'''
'''Class Name'''
Line 7: Line 7:


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


{| class="wikitable"
{| class="wikitable"
Line 16: Line 18:
| bootTime || int64 || Node boot time or 0 if not known (in seconds since epoch)
| bootTime || int64 || Node boot time or 0 if not known (in seconds since epoch)
|-
|-
| comments || string || Object's comments
| bridgeBaseAddress || string || Bridge base address (will return "000000000000" if not known or node is not a bridge/switch)
|-
| components || object ([[NXSL:Component | Component]]) || The root physical component object of the node
|-
|-
| driver || string || Driver name
| driver || string || Driver name
Line 22: Line 26:
| [[NXSL:Node:flags | flags]] || uint32 || Node flags (bit mask)
| [[NXSL:Node:flags | flags]] || uint32 || Node flags (bit mask)
|-
|-
| guid || string || Object's GUID
| "is802_1x" or "isPAE" || boolean || TRUE if node supports 802.1x
|-
| id || uint32 || Object's identifier
|-
| ipAddr || string || Primary IP address
|-
| is802_1x || boolean || TRUE if node supports 802.1x
|-
|-
| isAgent || boolean || TRUE if NetXMS agent detected on node
| isAgent || boolean || TRUE if NetXMS agent detected on node
Line 38: Line 36:
| isLLDP || boolean || TRUE if node supports LLDP (Link Layer Discovery Protocol)
| isLLDP || boolean || TRUE if node supports LLDP (Link Layer Discovery Protocol)
|-
|-
| isLocalMgmt || boolean || TRUE if node is a local management server (NetXMS server)
| "isLocalMgmt" or "isLocalManagement" || boolean || TRUE if node is a local management server (NetXMS server)
|-
| isPAE || boolean || TRUE if node supports 802.1x
|-
|-
| isPrinter || boolean || TRUE if node is a printer
| isPrinter || boolean || TRUE if node is a printer
|-
|-
| isRouter || boolean || TRUE if node is a router (has IP forwarding enabled)
| isRouter || boolean || TRUE if node is a router (has IP forwarding enabled)
|-
| isSMCLP|| boolean || TRUE if SMCLP agent detected on node
|-
|-
| isSNMP || boolean || TRUE if SNMP agent detected on node
| isSNMP || boolean || TRUE if SNMP agent detected on node
Line 50: Line 48:
| isSONMP || boolean || TRUE if node supports SONMP/NDP (Synoptics/Nortel Discovery Protocol)
| isSONMP || boolean || TRUE if node supports SONMP/NDP (Synoptics/Nortel Discovery Protocol)
|-
|-
| name || string || Object name
| isSTP || boolean || TRUE if node supports STP (Spanning Tree Protocol)
|-
|-
| platformName || string || Platform name reported by NetXMS agent
| platformName || string || Platform name reported by NetXMS agent
Line 57: Line 55:
|-
|-
| snmpOID || string || SNMP object identifier (value of .1.3.6.1.2.1.1.2.0)
| snmpOID || string || SNMP object identifier (value of .1.3.6.1.2.1.1.2.0)
|-
| snmpSysContact || string || SNMP system contact (value of .1.3.6.1.2.1.1.4.0)
|-
| snmpSysLocation || string || SNMP system location (value of .1.3.6.1.2.1.1.6.0)
|-
|-
| snmpSysName || string || SNMP system name (value of .1.3.6.1.2.1.1.5.0)
| snmpSysName || string || SNMP system name (value of .1.3.6.1.2.1.1.5.0)
Line 62: Line 64:
| snmpVersion || int32 || Configured SNMP version (0 for SNMP version 1, 1 for SNMP version 2c, 2 for SNMP version 3)
| snmpVersion || int32 || Configured SNMP version (0 for SNMP version 1, 1 for SNMP version 2c, 2 for SNMP version 3)
|-
|-
| status || int32 || Object status
| sysDescription || string || System description (value of System.Uname for nodes with agents or .1.3.6.1.2.1.1.1.0 for SNMP nodes)
|-
| zone || object ([[NXSL:Zone|Zone]]) || Zone object ('''null''' if zoning is disabled)
|-
| zoneUIN || int32 || Zone UIN (0 if zoning is disabled)
|}
 
'''Methods'''
 
Inherits all methods of the [[NXSL:NetObj|NetObj class]].
 
{| class="wikitable"
|-
! Name !! Parameters !! Return value !! Description
|-
|-
| sysDescription || string || SNMP system description (value of .1.3.6.1.2.1.1.1.0)
| enableAgent || boolean || none ||Enable or disable usage of NetXMS agent for all polls
|-
|-
| zone || object || [[NXSL:Zone|Zone]] object ('''null''' if zoning is disabled)
| enableConfigurationPolling || boolean || none || Enable or disable configuration polling for a node
|-
|-
| zoneId || int32 || Zone ID (0 if zoning is disabled)
| enableIcmp || boolean || none || Enable or disable usage of ICMP pings for status polls
|-
| enableRoutingTablePolling || boolean || none || Enable or disable routing table polling (since 2.1.1)
|-
| enableSnmp || boolean || none || Enable or disable usage of SNMP for all polls
|-
| enableStatusPolling || boolean || none || Enable or disable status polling for a node
|-
| enableTopologyPolling || boolean || none || Enable or disable topology polling
|}
|}
Example (disable usage of NetXMS agent for all polls):
$node->enableAgent(false);


[[Category:NXSL Class Reference]]
[[Category:NXSL Class Reference]]
Retrieved from "https://wiki.netxms.org/wiki/Special:MobileDiff/1192...1926"

Navigation menu