Difference between revisions of "NXSL:Node"

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


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


{| class="wikitable"
{| class="wikitable"
Line 17: Line 19:
|-
|-
| bridgeBaseAddress || string || Bridge base address (will return "000000000000" if not known or node is not a bridge/switch)
| bridgeBaseAddress || string || Bridge base address (will return "000000000000" if not known or node is not a bridge/switch)
|-
| comments || string || Object's comments
|-
|-
| driver || string || Driver name
| driver || string || Driver name
Line 24: Line 24:
| [[NXSL:Node:flags | flags]] || uint32 || Node flags (bit mask)
| [[NXSL:Node:flags | flags]] || uint32 || Node flags (bit mask)
|-
|-
| geolocation || object ([[NXSL:GeoLocation|GeoLocation]]) || Object's location
| "is802_1x" or "isPAE" || boolean || TRUE if node supports 802.1x
|-
| guid || string || Object's GUID
|-
| 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 42: Line 34:
| 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
|-
|-
| 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
|-
|-
| platformName || string || Platform name reported by NetXMS agent
| platformName || string || Platform name reported by NetXMS agent
Line 69: Line 59:
|-
|-
| 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)
| 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)
Line 80: Line 68:


'''Methods'''
'''Methods'''
[[NXSL:NetObj:clearGeoLocation|clearGeoLocation]]
[[NXSL:NetObj:setGeoLocation|setGeoLocation]]
{| class="wikitable"
{| class="wikitable"
|-
|-
! Name !! Description
! Name !! Parameters !! Return value !! Description
|-
| [[NXSL:NetObj:clearGeoLocation|clearGeoLocation]] || none || none || Clears GeoLocation data from the node
|-
| [[NXSL:NetObj:setGeoLocation|setGeoLocation]] || Object of [[NXSL:GeoLocation|GeoLocation]] class || none || Sets GeoLocation data for the node
|-
|-
| enableAgent(boolean) || Enable or disable usage of NetXMS agent for all polls
| enableAgent || boolean || none ||Enable or disable usage of NetXMS agent for all polls
|-
|-
| enableConfigurationPolling(boolean) || Enable or disable configuration polling for a node
| enableConfigurationPolling || boolean || none || Enable or disable configuration polling for a node
|-
|-
| enableIcmp(boolean) || Enable or disable usage of ICMP pings for status polls
| enableIcmp || boolean || none || Enable or disable usage of ICMP pings for status polls
|-
|-
| enableSnmp(boolean) || Enable or disable usage of SNMP for all polls
| enableSnmp || boolean || none || Enable or disable usage of SNMP for all polls
|-
|-
| enableStatusPolling(boolean) || Enable or disable status polling for a node
| enableStatusPolling || boolean || none || Enable or disable status polling for a node
|-
|-
| enableTopologyPolling(boolean) || Enable or disable topology polling
| enableTopologyPolling || boolean || none || Enable or disable topology polling
|}
|}


Revision as of 15:10, 25 January 2016

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)
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)
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)
zoneId int32 Zone ID (0 if zoning is disabled)

Methods

Name Parameters Return value Description
clearGeoLocation none none Clears GeoLocation data from the node
setGeoLocation Object of GeoLocation class none Sets GeoLocation data for the node
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
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);
Retrieved from "https://wiki.netxms.org/index.php?title=NXSL:Node&oldid=1475"