Difference between revisions of "NXSL:Node"
Jump to navigation
Jump to search
Lukas Rypl (talk | contribs) m (Added category) |
m (Text replacement - "^" to "{{deprecated}}") |
||
(25 intermediate revisions by 6 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 14: | Line 16: | ||
| agentVersion || string || NetXMS agent's version | | agentVersion || string || NetXMS agent's version | ||
|- | |- | ||
| | | bootTime || int64 || Node boot time or 0 if not known (in seconds since epoch) | ||
|- | |- | ||
| | | 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 | ||
|- | |- | ||
| is802_1x || boolean || TRUE if node supports 802.1x | | [[NXSL:Node:flags | flags]] || uint32 || Node flags (bit mask) | ||
|- | |||
| "is802_1x" or "isPAE" || 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 32: | 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) | ||
|- | |- | ||
| 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 44: | 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) | ||
|- | |- | ||
| | | 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 | ||
|- | |||
| [[NXSL:Node:runtimeFlags | runtimeFlags]] || uint32 || Node runtime flags (bit mask) | |||
|- | |- | ||
| 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 54: | 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) | ||
|- | |- | ||
| | | 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 | |||
|- | |- | ||
| | | enableAgent || boolean || none ||Enable or disable usage of NetXMS agent for all polls | ||
|- | |||
| enableConfigurationPolling || boolean || none || Enable or disable configuration polling for a node | |||
|- | |||
| 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]] |
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 NetXMS node object.
Class Name
Node
Attributes
Inherits all attributes of the NetObj class.
Name | Type | Description |
---|---|---|
agentVersion | string | NetXMS agent's version |
bootTime | int64 | Node boot time or 0 if not known (in seconds since epoch) |
bridgeBaseAddress | string | Bridge base address (will return "000000000000" if not known or node is not a bridge/switch) |
components | object ( Component) | The root physical component object of the node |
driver | string | Driver name |
flags | uint32 | Node flags (bit mask) |
"is802_1x" or "isPAE" | boolean | TRUE if node supports 802.1x |
isAgent | boolean | TRUE if NetXMS agent detected on node |
isBridge | boolean | TRUE if node is a bridge |
isCDP | boolean | TRUE if node supports CDP (Cisco Discovery Protocol) |
isLLDP | boolean | TRUE if node supports LLDP (Link Layer Discovery Protocol) |
"isLocalMgmt" or "isLocalManagement" | boolean | TRUE if node is a local management server (NetXMS server) |
isPrinter | boolean | TRUE if node is a printer |
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 |
isSONMP | boolean | TRUE if node supports SONMP/NDP (Synoptics/Nortel Discovery Protocol) |
isSTP | boolean | TRUE if node supports STP (Spanning Tree Protocol) |
platformName | string | Platform name reported by NetXMS agent |
runtimeFlags | uint32 | Node runtime flags (bit mask) |
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) |
snmpVersion | int32 | Configured SNMP version (0 for SNMP version 1, 1 for SNMP version 2c, 2 for SNMP version 3) |
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 (Zone) | Zone object (null if zoning is disabled) |
zoneUIN | int32 | Zone UIN (0 if zoning is disabled) |
Methods
Inherits all methods of the NetObj class.
Name | Parameters | Return value | Description |
---|---|---|---|
enableAgent | boolean | none | Enable or disable usage of NetXMS agent for all polls |
enableConfigurationPolling | boolean | none | Enable or disable configuration polling for a node |
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);