Package org.netxms.client.objects

Class Node

java.lang.Object

org.netxms.client.objects.AbstractObject

org.netxms.client.objects.GenericObject

org.netxms.client.objects.DataCollectionTarget

org.netxms.client.objects.AbstractNode

org.netxms.client.objects.Node

All Implemented Interfaces:

HardwareEntity, PollingTarget, ZoneMember

public class Node
extends AbstractNode

This class represents NetXMS NODE objects.

Field Summary

Fields inherited from class org.netxms.client.objects.AbstractNode

AGENT_AUTH_MD5, AGENT_AUTH_NONE, AGENT_AUTH_PLAINTEXT, AGENT_AUTH_SHA1, agentCacheMode, agentCertificateMappingData, agentCertificateMappingMethod, agentCertificateSubject, agentCompressionMode, agentId, agentPort, agentProxyId, agentSharedSecret, agentVersion, bootTime, bridgeBaseAddress, capabilities, chassisPlacement, cipDeviceType, cipDeviceTypeName, cipExtendedStatusText, cipState, cipStateText, cipStatus, cipStatusText, cipVendorCode, driverName, driverVersion, etherNetIpPort, etherNetIpProxyId, expectedCapabilities, hardwareId, hardwareProductCode, hardwareProductName, hardwareProductVersion, hardwareSerialNumber, hardwareVendor, hypervisorInformation, hypervisorType, icmpAverageResponseTime, icmpLastResponseTime, icmpMaxResponseTime, icmpMinResponseTime, icmpPacketLoss, icmpProxyId, icmpStatCollectionMode, icmpStatisticsCollected, icmpTargets, IFXTABLE_DEFAULT, IFXTABLE_DISABLED, IFXTABLE_ENABLED, ifXTablePolicy, lastAgentCommTime, lastConfigBackupJobStatus, lldpNodeId, modbusProxyId, modbusTcpPort, modbusUnitId, mqttProxyId, NC_DEVICE_VIEW, NC_EMULATED_ENTITY_MIB, NC_HAS_AGENT_IFXCOUNTERS, NC_HAS_ENTITY_MIB, NC_HAS_FILE_MANAGER, NC_HAS_IFXTABLE, NC_HAS_SERVICE_MANAGER, NC_HAS_USER_AGENT, NC_HAS_VLANS, NC_HAS_WINPDH, NC_IS_8021X, NC_IS_BRIDGE, NC_IS_CDP, NC_IS_ETHERNET_IP, NC_IS_LLDP, NC_IS_LOCAL_MGMT, NC_IS_LOCAL_VNC, NC_IS_MODBUS_TCP, NC_IS_NATIVE_AGENT, NC_IS_NDP, NC_IS_OSPF, NC_IS_PRINTER, NC_IS_PROFINET, NC_IS_ROUTER, NC_IS_SMCLP, NC_IS_SNMP, NC_IS_SSH, NC_IS_STP, NC_IS_VNC, NC_IS_VRRP, NC_IS_WIFI_AP, NC_IS_WIFI_CONTROLLER, NC_LLDP_V2_MIB, NC_REGISTERED_FOR_BACKUP, networkPathCheckResult, networkServiceCount, NF_AGENT_OVER_TUNNEL_ONLY, NF_DISABLE_8021X_STATUS_POLL, NF_DISABLE_DISCOVERY_POLL, NF_DISABLE_ETHERNET_IP, NF_DISABLE_ICMP, NF_DISABLE_MODBUS_TCP, NF_DISABLE_NXCP, NF_DISABLE_PERF_COUNT, NF_DISABLE_ROUTE_POLL, NF_DISABLE_SMCLP_PROPERTIES, NF_DISABLE_SNMP, NF_DISABLE_SSH, NF_DISABLE_TOPOLOGY_POLL, NF_DISABLE_VNC, NF_EXTERNAL_GATEWAY, NF_FORCE_ENCRYPTION, NF_PING_PRIMARY_IP, NF_SNMP_SETTINGS_LOCKED, nodeSubType, nodeType, NSF_AGENT_UNREACHABLE, NSF_CACHE_MODE_NOT_SUPPORTED, NSF_ETHERNET_IP_UNREACHABLE, NSF_ICMP_UNREACHABLE, NSF_MODBUS_UNREACHABLE, NSF_SNMP_TRAP_FLOOD, NSF_SNMP_UNREACHABLE, NSF_SSH_UNREACHABLE, ospfRouterId, physicalContainerId, platformName, pollerNodeId, portNumberingScheme, portRowCount, primaryIP, primaryMacAddress, primaryName, rackHeight, rackImageFront, rackImageRear, rackOrientation, rackPosition, radios, requredPollCount, snmpAuthMethod, snmpAuthName, snmpAuthPassword, snmpCodepage, snmpOID, snmpPort, snmpPrivMethod, snmpPrivPassword, snmpProxyId, snmpSysContact, snmpSysLocation, snmpSysName, snmpVersion, sshKeyId, sshLogin, sshPassword, sshPort, sshProxyId, stateFlags, syslogCodepage, systemDescription, vncPassword, vncPort, vncProxyId, vpnConnectorCount, vrrpVersion, zoneId

Fields inherited from class org.netxms.client.objects.DataCollectionTarget

DCF_DISABLE_CONF_POLL, DCF_DISABLE_DATA_COLLECT, DCF_DISABLE_STATUS_POLL, DCF_LOCATION_CHANGE_EVENT, DCSF_NETWORK_PATH_PROBLEM, DCSF_UNREACHABLE, geoAreas, geoLocationControlMode, numDataCollectionItems, overviewDciData, tooltipDciData, webServiceProxyId

Fields inherited from class org.netxms.client.objects.AbstractObject

accessList, alias, assetId, ASSETS, backupZoneProxyId, BUSINESSSERVICEROOT, CALCULATE_DEFAULT, CALCULATE_MOST_CRITICAL, CALCULATE_MULTIPLE_THRESHOLDS, CALCULATE_SINGLE_THRESHOLD, categoryId, children, comments, commentsSource, CONTEXT, creationTime, customAttributes, DASHBOARDROOT, dashboards, drillDownObjectId, fixedPropagatedStatus, flags, geolocation, guid, inheritAccessRights, inMaintenanceMode, isDeleted, maintenanceInitiatorId, mapImage, MARKDOWN_COMMENTS_INDICATOR, moduleData, nameOnMap, NETWORK, NETWORKMAPROOT, OBJECT_ACCESSPOINT, OBJECT_ASSET, OBJECT_ASSETGROUP, OBJECT_ASSETROOT, OBJECT_BUSINESSSERVICE, OBJECT_BUSINESSSERVICEPROTOTYPE, OBJECT_BUSINESSSERVICEROOT, OBJECT_CHASSIS, OBJECT_CIRCUIT, OBJECT_CLUSTER, OBJECT_COLLECTOR, OBJECT_CONDITION, OBJECT_CONTAINER, OBJECT_CUSTOM, OBJECT_DASHBOARD, OBJECT_DASHBOARDGROUP, OBJECT_DASHBOARDROOT, OBJECT_DASHBOARDTEMPLATE, OBJECT_GENERIC, OBJECT_INTERFACE, OBJECT_MOBILEDEVICE, OBJECT_NETWORK, OBJECT_NETWORKMAP, OBJECT_NETWORKMAPGROUP, OBJECT_NETWORKMAPROOT, OBJECT_NETWORKSERVICE, OBJECT_NODE, OBJECT_RACK, OBJECT_SENSOR, OBJECT_SERVICEROOT, OBJECT_SUBNET, OBJECT_TEMPLATE, OBJECT_TEMPLATEGROUP, OBJECT_TEMPLATEROOT, OBJECT_VPNCONNECTOR, OBJECT_WIRELESSDOMAIN, OBJECT_ZONE, objectClass, objectId, objectName, parents, partialObject, pollStates, postalAddress, primaryZoneProxyId, PROPAGATE_DEFAULT, PROPAGATE_FIXED, PROPAGATE_RELATIVE, PROPAGATE_TRANSLATED, PROPAGATE_UNCHANGED, responsibleUsers, SERVICEROOT, session, status, statusCalculationMethod, statusPropagationMethod, statusShift, statusSingleThreshold, statusThresholds, statusTransformation, TEMPLATEROOT, trustedObjects, UNKNOWN, urls, ZONE0

Constructor Summary

Constructors

Constructor	Description
Node(long id, NXCSession session)	Create new node object.
Node(NXCPMessage msg, NXCSession session)	Create from NXCP message.

Method Summary

Modifier and Type	Method	Description
boolean	canHaveAgent()	Identify if this object can have NetXMS agent.
boolean	canHaveInterfaces()	Identify if this object can have network interfaces.
boolean	canHavePollerNode()	Identify if this object can have poller node property.
boolean	canUseEtherNetIP()	Identify if this object can use EtherNet/IP for communications.
boolean	canUseModbus()	Identify if this object can use Modbus for communications.
String	getObjectClassName()	Get name of NetXMS object's class.
PollState[]	getPollStates()	Get poll states.
boolean	isAlarmsVisible()	If this method returns true object can have visible alarms.
boolean	isAllowedOnMap()	If this method returns true object is allowed to be on custom network map.

Methods inherited from class org.netxms.client.objects.AbstractNode

getAgentCacheMode, getAgentCertificateMappingData, getAgentCertificateMappingMethod, getAgentCertificateSubject, getAgentCompressionMode, getAgentId, getAgentPort, getAgentProxyId, getAgentSharedSecret, getAgentVersion, getBootTime, getBridgeBaseAddress, getCapabilities, getChassisPlacement, getCipDeviceType, getCipDeviceTypeName, getCipExtendedStatusText, getCipState, getCipStateText, getCipStatus, getCipStatusText, getCipVendorCode, getDriverName, getDriverVersion, getEtherNetIpPort, getEtherNetIpProxyId, getExpectedCapabilities, getFlags, getFrontRackImage, getHardwareId, getHardwareIdAsText, getHardwareProductCode, getHardwareProductName, getHardwareProductVersion, getHardwareSerialNumber, getHardwareVendor, getHypervisorInformation, getHypervisorType, getIcmpAverageResponseTime, getIcmpLastResponseTime, getIcmpMaxResponseTime, getIcmpMinResponseTime, getIcmpPacketLoss, getIcmpProxyId, getIcmpStatCollectionMode, getIcmpTargets, getIfXTablePolicy, getInterfaceByIndex, getLastAgentCommTime, getLastConfigBackupJobStatus, getLldpNodeId, getModbusProxyId, getModbusTcpPort, getModbusUnitId, getMqttProxyId, getNetworkPathCheckResult, getNodeSubType, getNodeType, getOSPFRouterId, getPhysicalContainerId, getPlatformName, getPollerNodeId, getPortNumberingScheme, getPortRowCount, getPrimaryIP, getPrimaryMAC, getPrimaryName, getRackHeight, getRackOrientation, getRackPosition, getRadios, getRearRackImage, getRequredPollCount, getSnmpAuthMethod, getSnmpAuthName, getSnmpAuthPassword, getSNMPCodepage, getSnmpOID, getSnmpPort, getSnmpPrivMethod, getSnmpPrivPassword, getSnmpProxyId, getSnmpSysContact, getSnmpSysLocation, getSnmpSysName, getSnmpVersion, getSshKeyId, getSshLogin, getSshPassword, getSshPort, getSshProxyId, getStateFlags, getStrings, getSyslogCodepage, getSystemDescription, getVncPassword, getVncPort, getVncProxyId, getVrrpVersion, getZoneId, getZoneName, hasAgent, hasDeviceViewData, hasFileManager, hasNetworkServices, hasServiceManager, hasSnmpAgent, hasVNC, hasVpnConnectors, is8021xSupported, isAgentIfXCountersSupported, isAgentReachable, isBridge, isEntityMibEmulated, isEntityMibSupported, isIcmpStatisticsCollected, isIfXTableSupported, isManagementServer, isOSPF, isPingOnPrimaryIPEnabled, isRegisteredForConfigBackup, isSnmpReachable, isSnmpSettingsLocked, isSpanningTreeSupported, isVirtual, isVrrpSupported, isWirelessAccessPoint, isWirelessController

Methods inherited from class org.netxms.client.objects.DataCollectionTarget

getGeoAreas, getGeoLocationControlMode, getNumDataCollectionItems, getOverviewDciData, getTooltipDciData, getWebServiceProxyId, isLocationChageEventGenerated

Methods inherited from class org.netxms.client.objects.AbstractObject

addString, areChildrenSynchronized, getAccessList, getAlias, getAllChildren, getAllChildren, getAllParents, getAllParents, getAssetId, getBackupZoneProxyId, getCategory, getCategoryId, getChildCount, getChildIdList, getChildren, getChildrenAsArray, getComments, getCommentsSource, getConfiguredNameOnMap, getCreationTime, getCustomAttribute, getCustomAttributes, getCustomAttributeValue, getCustomAttributeValueAsBoolean, getDashboardIdentifiers, getDashboards, getDrillDownObjectId, getEffectiveRights, getFixedPropagatedStatus, getGeolocation, getGuid, getIcon, getMaintenanceInitiatorId, getMapImage, getModuleData, getNameOnMap, getNameWithAlias, getNetworkMaps, getObjectClass, getObjectId, getObjectName, getObjectNameWithPath, getParentChain, getParentCount, getParentIdList, getParents, getParentsAsArray, getPostalAddress, getPrimaryZoneProxyId, getResponsibleUsers, getStatus, getStatusCalculationMethod, getStatusPropagationMethod, getStatusShift, getStatusSingleThreshold, getStatusThresholds, getStatusTransformation, getTrustedObjects, getUrls, hasAccessibleChildren, hasAccessibleParents, hasAccessibleViewParents, hasChildren, hasCustomAttribute, hasDashboard, hashCode, hasNetworkMap, hasParents, hasUrls, isChildOf, isChildOf, isDefaultImage, isDeleted, isDirectChildOf, isDirectParentOf, isInheritAccessRights, isInMaintenanceMode, isParentOf, isParentOf, isPartialObject, setSession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.netxms.client.objects.interfaces.HardwareEntity

getObjectId, getObjectName, getStatus

Methods inherited from interface org.netxms.client.objects.interfaces.PollingTarget

getObjectId, getObjectName

Constructor Details

Node

public Node(long id,
 NXCSession session)

Create new node object.

Parameters:

id - object ID

session - owning client session

Node

public Node(NXCPMessage msg,
 NXCSession session)

Create from NXCP message.

Parameters:

msg - NXCP message

session - owning client session

Method Details

getObjectClassName

public String getObjectClassName()

Description copied from class: AbstractObject

Get name of NetXMS object's class.

Overrides:

getObjectClassName in class AbstractObject

Returns:

Name of NetXMS object's class

See Also:

• AbstractObject.getObjectClassName()

isAllowedOnMap

public boolean isAllowedOnMap()

Description copied from class: AbstractObject

If this method returns true object is allowed to be on custom network map. Default implementation always returns false.

Overrides:

isAllowedOnMap in class AbstractObject

Returns:

true if object is allowed to be on custom network map

See Also:

• AbstractObject.isAllowedOnMap()

isAlarmsVisible

public boolean isAlarmsVisible()

Description copied from class: AbstractObject

If this method returns true object can have visible alarms. Default implementation always returns false.

Overrides:

isAlarmsVisible in class AbstractObject

Returns:

true if object can contain visible alarms

See Also:

• AbstractObject.isAlarmsVisible()

canHaveAgent

public boolean canHaveAgent()

Description copied from interface: PollingTarget

Identify if this object can have NetXMS agent.

Returns:

true if this object can have NetXMS agent

See Also:

• PollingTarget.canHaveAgent()

canHaveInterfaces

public boolean canHaveInterfaces()

Description copied from interface: PollingTarget

Identify if this object can have network interfaces.

Returns:

true if this object can have network interfaces

See Also:

• PollingTarget.canHaveInterfaces()

canHavePollerNode

public boolean canHavePollerNode()

Description copied from interface: PollingTarget

Identify if this object can have poller node property.

Returns:

true if this object can have poller node property

See Also:

• PollingTarget.canHavePollerNode()

canUseEtherNetIP

public boolean canUseEtherNetIP()

Description copied from interface: PollingTarget

Identify if this object can use EtherNet/IP for communications.

Returns:

true if this object can use EtherNet/IP for communications

See Also:

• PollingTarget.canUseEtherNetIP()

canUseModbus

public boolean canUseModbus()

Description copied from interface: PollingTarget

Identify if this object can use Modbus for communications.

Returns:

true if this object can use Modbus for communications

See Also:

• PollingTarget.canUseModbus()

getPollStates

public PollState[] getPollStates()

Description copied from interface: PollingTarget

Get poll states.

Returns:

array of poll states or null if object doesn't have any

See Also:

• PollingTarget.getPollStates()