Class AbstractNode

    • Field Detail

      • NC_HAS_AGENT_IFXCOUNTERS

        public static final int NC_HAS_AGENT_IFXCOUNTERS
        See Also:
        Constant Field Values
      • NF_DISABLE_DISCOVERY_POLL

        public static final int NF_DISABLE_DISCOVERY_POLL
        See Also:
        Constant Field Values
      • NF_DISABLE_TOPOLOGY_POLL

        public static final int NF_DISABLE_TOPOLOGY_POLL
        See Also:
        Constant Field Values
      • NF_AGENT_OVER_TUNNEL_ONLY

        public static final int NF_AGENT_OVER_TUNNEL_ONLY
        See Also:
        Constant Field Values
      • NF_SNMP_SETTINGS_LOCKED

        public static final int NF_SNMP_SETTINGS_LOCKED
        See Also:
        Constant Field Values
      • primaryIP

        protected org.netxms.base.InetAddressEx primaryIP
      • primaryName

        protected String primaryName
      • flags

        protected int flags
      • stateFlags

        protected int stateFlags
      • capabilities

        protected int capabilities
      • nodeSubType

        protected String nodeSubType
      • hypervisorType

        protected String hypervisorType
      • hypervisorInformation

        protected String hypervisorInformation
      • hardwareProductName

        protected String hardwareProductName
      • hardwareProductCode

        protected String hardwareProductCode
      • hardwareProductVersion

        protected String hardwareProductVersion
      • hardwareSerialNumber

        protected String hardwareSerialNumber
      • hardwareVendor

        protected String hardwareVendor
      • requredPollCount

        protected int requredPollCount
      • pollerNodeId

        protected long pollerNodeId
      • agentProxyId

        protected long agentProxyId
      • snmpProxyId

        protected long snmpProxyId
      • etherNetIpProxyId

        protected long etherNetIpProxyId
      • icmpProxyId

        protected long icmpProxyId
      • agentPort

        protected int agentPort
      • agentAuthMethod

        protected int agentAuthMethod
      • agentId

        protected UUID agentId
      • agentSharedSecret

        protected String agentSharedSecret
      • agentVersion

        protected String agentVersion
      • platformName

        protected String platformName
      • snmpAuthName

        protected String snmpAuthName
      • snmpAuthPassword

        protected String snmpAuthPassword
      • snmpPrivPassword

        protected String snmpPrivPassword
      • snmpAuthMethod

        protected int snmpAuthMethod
      • snmpPrivMethod

        protected int snmpPrivMethod
      • snmpOID

        protected String snmpOID
      • snmpPort

        protected int snmpPort
      • snmpSysName

        protected String snmpSysName
      • snmpSysContact

        protected String snmpSysContact
      • snmpSysLocation

        protected String snmpSysLocation
      • systemDescription

        protected String systemDescription
      • lldpNodeId

        protected String lldpNodeId
      • vrrpVersion

        protected int vrrpVersion
      • driverName

        protected String driverName
      • driverVersion

        protected String driverVersion
      • zoneId

        protected long zoneId
      • bridgeBaseAddress

        protected org.netxms.base.MacAddress bridgeBaseAddress
      • ifXTablePolicy

        protected int ifXTablePolicy
      • bootTime

        protected Date bootTime
      • lastAgentCommTime

        protected Date lastAgentCommTime
      • physicalContainerId

        protected long physicalContainerId
      • rackImageFront

        protected UUID rackImageFront
      • rackImageRear

        protected UUID rackImageRear
      • rackPosition

        protected short rackPosition
      • rackHeight

        protected short rackHeight
      • sshLogin

        protected String sshLogin
      • sshPassword

        protected String sshPassword
      • sshProxyId

        protected long sshProxyId
      • portRowCount

        protected int portRowCount
      • portNumberingScheme

        protected int portNumberingScheme
      • icmpStatisticsCollected

        protected boolean icmpStatisticsCollected
      • icmpLastResponseTime

        protected int icmpLastResponseTime
      • icmpMinResponseTime

        protected int icmpMinResponseTime
      • icmpMaxResponseTime

        protected int icmpMaxResponseTime
      • icmpAverageResponseTime

        protected int icmpAverageResponseTime
      • icmpPacketLoss

        protected int icmpPacketLoss
      • etherNetIpPort

        protected int etherNetIpPort
      • cipDeviceType

        protected int cipDeviceType
      • cipDeviceTypeName

        protected String cipDeviceTypeName
      • cipStatus

        protected int cipStatus
      • cipStatusText

        protected String cipStatusText
      • cipExtendedStatusText

        protected String cipExtendedStatusText
      • cipState

        protected int cipState
      • cipStateText

        protected String cipStateText
    • Constructor Detail

      • AbstractNode

        public AbstractNode​(long id,
                            NXCSession session)
        Create new node object.
        Parameters:
        id -
        session -
      • AbstractNode

        public AbstractNode​(org.netxms.base.NXCPMessage msg,
                            NXCSession session)
        Create node object from NXCP message.
        Parameters:
        msg -
        session -
    • Method Detail

      • getCapabilities

        public int getCapabilities()
        Returns:
        Flags
      • getStateFlags

        public int getStateFlags()
        Returns:
        Runtime flags
      • getNodeType

        public NodeType getNodeType()
        Returns:
        the nodeType
      • getNodeSubType

        public String getNodeSubType()
        Returns:
        the nodeSubType
      • isVirtual

        public boolean isVirtual()
        Check if this node is a virtual node (either virtual machine or container)
        Returns:
        true if this node is a virtual node
      • getHypervisorType

        public String getHypervisorType()
        Get hypervisor type.
        Returns:
        hypervisor type string or empty string if unknown or not applicable
      • getHypervisorInformation

        public String getHypervisorInformation()
        Get additional hypervisor information (product, version, etc.).
        Returns:
        hypervisor information string or empty string if unknown or not applicable
      • getRequredPollCount

        public int getRequredPollCount()
        Returns:
        the requredPollCount
      • getAgentProxyId

        public long getAgentProxyId()
        Returns:
        the proxyNodeId
      • getSnmpProxyId

        public long getSnmpProxyId()
        Returns:
        the snmpProxyId
      • getEtherNetIpProxyId

        public long getEtherNetIpProxyId()
        Returns:
        the etherNetIpProxyId
      • getIcmpProxyId

        public long getIcmpProxyId()
        Returns:
        the icmpProxyId
      • getAgentPort

        public int getAgentPort()
        Returns:
        the agentPort
      • getAgentAuthMethod

        public int getAgentAuthMethod()
        Returns:
        the agentAuthMethod
      • getAgentSharedSecret

        public String getAgentSharedSecret()
        Returns:
        the agentSharedSecret
      • getAgentCompressionMode

        public AgentCompressionMode getAgentCompressionMode()
        Returns:
        the agentCompressionMode
      • getAgentVersion

        public String getAgentVersion()
        Returns:
        the agentVersion
      • getAgentId

        public UUID getAgentId()
        Returns:
        the agentId
      • getPlatformName

        public String getPlatformName()
        Returns:
        the platformName
      • getSnmpAuthName

        public String getSnmpAuthName()
        Get SNMP authentication name - community string for version 1 and 2c, or user name for version 3.
        Returns:
        SNMP authentication name
      • getSnmpOID

        public String getSnmpOID()
        Returns:
        the snmpOID
      • getSnmpVersion

        public SnmpVersion getSnmpVersion()
        Returns:
        the snmpVersion
      • getSystemDescription

        public String getSystemDescription()
        Returns:
        the systemDescription
      • getSnmpAuthPassword

        public String getSnmpAuthPassword()
        Get SNMP authentication password.
        Returns:
        SNMP authentication password
      • getSnmpPrivPassword

        public String getSnmpPrivPassword()
        Get SNMP privacy password.
        Returns:
        SNMP privacy password
      • getSnmpAuthMethod

        public int getSnmpAuthMethod()
        Get SNMP authentication method
        Returns:
        SNMP authentication method
      • getSnmpPrivMethod

        public int getSnmpPrivMethod()
        Get SNMP privacy (encryption) method
        Returns:
        SNMP privacy method
      • hasAgent

        public boolean hasAgent()
        Returns:
        true if node has NetXMS agent
      • hasSnmpAgent

        public boolean hasSnmpAgent()
        Returns:
        true if node has SNMP agent
      • isManagementServer

        public boolean isManagementServer()
        Returns:
        true if node is a management server
      • isVrrpSupported

        public boolean isVrrpSupported()
        Returns:
        true if node is VRRP capable
      • is8021xSupported

        public boolean is8021xSupported()
        Returns:
        true if node supports 802.1x
      • isSpanningTreeSupported

        public boolean isSpanningTreeSupported()
        Returns:
        true if node supports spanning tree MIB
      • isEntityMibSupported

        public boolean isEntityMibSupported()
        Returns:
        true if node supports ENTITY-MIB
      • isIfXTableSupported

        public boolean isIfXTableSupported()
        Returns:
        true if node supports ifXTable
      • isAgentIfXCountersSupported

        public boolean isAgentIfXCountersSupported()
        Returns:
        true if agent on node supports 64-bit interface counters
      • isBridge

        public boolean isBridge()
        Check for bridge capabilities flag
        Returns:
        true if node is has bridge capabilities
      • isWirelessController

        public boolean isWirelessController()
        Returns:
        true if node is a wireless network controller
      • getSnmpPort

        public int getSnmpPort()
        Returns:
        the snmpPort
      • getSnmpSysName

        public String getSnmpSysName()
        Get SNMP system name (value of sysName MIB entry)
        Returns:
        the snmpSysName
      • getSnmpSysContact

        public String getSnmpSysContact()
        Get SNMP system contact (value of sysContact MIB entry)
        Returns:
        SNMP system contact (value of sysContact MIB entry)
      • getSnmpSysLocation

        public String getSnmpSysLocation()
        Get SNMP system location (value of sysLocation MIB entry)
        Returns:
        SNMP system location (value of sysLocation MIB entry)
      • getLldpNodeId

        public String getLldpNodeId()
        Returns:
        the lldpNodeId
      • getVrrpVersion

        protected int getVrrpVersion()
        Returns:
        the vrrpVersion
      • getDriverName

        public String getDriverName()
        Returns:
        the driverName
      • getDriverVersion

        public String getDriverVersion()
        Returns:
        the driverVersion
      • getZoneId

        public long getZoneId()
        Description copied from interface: ZoneMember
        Get ID of the zone this object belongs to
        Specified by:
        getZoneId in interface ZoneMember
        Returns:
        zone ID
      • getZoneName

        public String getZoneName()
        Description copied from interface: ZoneMember
        Get name of the zone this object belongs to
        Specified by:
        getZoneName in interface ZoneMember
        Returns:
        zone name
      • getBridgeBaseAddress

        public org.netxms.base.MacAddress getBridgeBaseAddress()
        Returns:
        the bridgeBaseAddress
      • getIfXTablePolicy

        public int getIfXTablePolicy()
        Description copied from interface: PollingTarget
        Get ifXTable usage policy.
        Specified by:
        getIfXTablePolicy in interface PollingTarget
        Returns:
        the ifXTablePolicy
      • getPrimaryName

        public String getPrimaryName()
        Returns:
        the primaryName
      • getPrimaryMAC

        public org.netxms.base.MacAddress getPrimaryMAC()
        Get MAC address of interface with node's primary IP
        Returns:
        MAC address of interface with node's primary IP
      • getBootTime

        public Date getBootTime()
        Returns:
        the bootTime
      • getPrimaryIP

        public org.netxms.base.InetAddressEx getPrimaryIP()
        Get primary IP address
        Returns:
        primary IP address
      • getLastAgentCommTime

        public Date getLastAgentCommTime()
        Get last agent communications time
        Returns:
        last agent communications time
      • getSshLogin

        public String getSshLogin()
        Returns:
        the sshLogin
      • getSshPassword

        public String getSshPassword()
        Returns:
        the sshPassword
      • getSshProxyId

        public long getSshProxyId()
        Returns:
        the sshProxyId
      • getPortRowCount

        public int getPortRowCount()
        Get number of rows for physical ports
        Returns:
        number of rows for physical ports
      • getPortNumberingScheme

        public int getPortNumberingScheme()
        Get physical port numbering scheme
        Returns:
        physical port numbering scheme
      • getHardwareProductName

        public String getHardwareProductName()
        Returns:
        the hardwareProductName
      • getHardwareProductCode

        public String getHardwareProductCode()
        Returns:
        the hardwareProductCode
      • getHardwareProductVersion

        public String getHardwareProductVersion()
        Returns:
        the hardwareProductVersion
      • getHardwareSerialNumber

        public String getHardwareSerialNumber()
        Returns:
        the hardwareSerialNumber
      • getHardwareVendor

        public String getHardwareVendor()
        Returns:
        the hardwareVendor
      • getEtherNetIpPort

        public int getEtherNetIpPort()
        Returns:
        the etherNetIpPort
      • getCipDeviceType

        public int getCipDeviceType()
        Returns:
        the cipDeviceType
      • getCipDeviceTypeName

        public String getCipDeviceTypeName()
        Get symbolic name for node's CIP device type.
        Returns:
        symbolic name for node's CIP device type or null if not available
      • getCipStatus

        public int getCipStatus()
        Returns:
        the cipStatus
      • getCipStatusText

        public String getCipStatusText()
        Returns:
        the cipStatusText
      • getCipExtendedStatusText

        public String getCipExtendedStatusText()
        Returns:
        the cipExtendedStatusText
      • getCipState

        public int getCipState()
        Returns:
        the cipState
      • getCipStateText

        public String getCipStateText()
        Returns:
        the cipStateText
      • getIcmpStatCollectionMode

        public IcmpStatCollectionMode getIcmpStatCollectionMode()
        Returns:
        the icmpStatCollectionMode
      • getIcmpTargets

        public InetAddress[] getIcmpTargets()
        Returns:
        the icmpTargets
      • isIcmpStatisticsCollected

        public boolean isIcmpStatisticsCollected()
        Check if ICMP statistics is collected for this node.
        Returns:
        true if ICMP statistics is collected for this node
      • getIcmpLastResponseTime

        public int getIcmpLastResponseTime()
        Returns:
        the icmpLastResponseTime
      • getIcmpMinResponseTime

        public int getIcmpMinResponseTime()
        Returns:
        the icmpMinResponseTime
      • getIcmpMaxResponseTime

        public int getIcmpMaxResponseTime()
        Returns:
        the icmpMaxResponseTime
      • getIcmpAverageResponseTime

        public int getIcmpAverageResponseTime()
        Returns:
        the icmpAverageResponseTime
      • getIcmpPacketLoss

        public int getIcmpPacketLoss()
        Returns:
        the icmpPacketLoss
      • getInterfaceByIndex

        public Interface getInterfaceByIndex​(int ifIndex)
        Get node's interface by interface index
        Parameters:
        ifIndex - interface index
        Returns:
        corresponding interface object or null
      • isAgentReachable

        public boolean isAgentReachable()
        Check node state flags for "agent unreachable" flag.
        Returns:
        true if agent is reachable (flag is cleared)
      • isSnmpReachable

        public boolean isSnmpReachable()
        Check node state flags for "SNMP unreachable" flag.
        Returns:
        true if SNMP is reachable (flag is cleared)
      • isSnmpSettingsLocked

        public boolean isSnmpSettingsLocked()
        Check node flags for "SNMP settings locked" flag.
        Returns:
        true if SNMP settings are locked (flag is set)
      • isPingOnPrimaryIPEnabled

        public boolean isPingOnPrimaryIPEnabled()
        Check node flags for "Enable ICMP ping on primary IP" flag.
        Returns:
        true if flag is set