Class Interface

    • Constructor Detail

      • Interface

        public Interface​(org.netxms.base.NXCPMessage msg,
                         NXCSession session)
        Parameters:
        msg -
    • Method Detail

      • getParentNode

        public AbstractNode getParentNode()
        Get parent node object.
        Returns:
        parent node object or null if it is not exist or inaccessible
      • getIfIndex

        public int getIfIndex()
        Returns:
        Interface index
      • getIfType

        public int getIfType()
        Returns:
        Interface type
      • getIfTypeName

        public String getIfTypeName()
        Get symbolic name for interface type
        Returns:
        symbolic name for interface type
      • getMacAddress

        public org.netxms.base.MacAddress getMacAddress()
        Get interface MAC address
        Returns:
        Interface MAC address
      • getRequiredPollCount

        public int getRequiredPollCount()
        Returns:
        Number of polls required to change interface status
      • 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
      • getChassis

        public int getChassis()
        Returns:
        the chassis
      • getPIC

        public int getPIC()
        Returns:
        the pic
      • getModule

        public int getModule()
        Returns:
        the slot
      • getPort

        public int getPort()
        Returns:
        the port
      • getPhysicalLocation

        public String getPhysicalLocation()
        Get string describing interface physical location in form chassis/module/pic/port
        Returns:
        string describing interface physical location in form chassis/module/pic/port or emoty string if interface is not physical port
      • getPeerNodeId

        public long getPeerNodeId()
        Returns:
        the peerNodeId
      • getPeerInterfaceId

        public long getPeerInterfaceId()
        Returns:
        the peerInterfaceId
      • 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
      • getDescription

        public String getDescription()
        Returns:
        the description
      • getFlags

        public int getFlags()
        Returns:
        the flags
      • getDot1xPaeState

        public int getDot1xPaeState()
        Get 802.1x PAE state
        Returns:
        802.1x PAE state
      • getDot1xPaeStateAsText

        public String getDot1xPaeStateAsText()
        Get 802.1x PAE state as text
        Returns:
        802.1x PAE state as text
      • getDot1xBackendState

        public int getDot1xBackendState()
        Get 802.1x backend state
        Returns:
        802.1x backend state
      • getDot1xBackendStateAsText

        public String getDot1xBackendStateAsText()
        Get 802.1x backend state as text
        Returns:
        802.1x backend state as text
      • getAdminState

        public int getAdminState()
        Get administrative state
        Returns:
        administrative state
      • getAdminStateAsText

        public String getAdminStateAsText()
        Get administrative state as text
        Returns:
        administrative state as text
      • getOperState

        public int getOperState()
        Get operational state
        Returns:
        operational state
      • getOperStateAsText

        public String getOperStateAsText()
        Get operational state as text
        Returns:
        operational state as text
      • getExpectedState

        public int getExpectedState()
        Get interface expected state
        Returns:
        interface expected state
      • isPhysicalPort

        public boolean isPhysicalPort()
        Check if this interface is a physical port
        Returns:
        true if this interface is a physical port
      • isLoopback

        public boolean isLoopback()
        Check if this interface is a loopback
        Returns:
        true if this interface is a loopback
      • isExcludedFromTopology

        public boolean isExcludedFromTopology()
        Check if this interface is excluded from network topology calculation
        Returns:
        true if this interface is excluded from network topology calculation
      • isIncludedInIcmpPoll

        public boolean isIncludedInIcmpPoll()
        Check if this interface is included in ICMP poll for owning node
        Returns:
        true if this interface is included in ICMP poll for owning node
      • getPeerDiscoveryProtocol

        public LinkLayerDiscoveryProtocol getPeerDiscoveryProtocol()
        Get peer discovery protocol
        Returns:
        peer discovery protocol
      • getMtu

        public int getMtu()
        Returns:
        the mtu
      • getSpeed

        public long getSpeed()
        Returns:
        the speed
      • getIfTableSuffix

        public SnmpObjectId getIfTableSuffix()
        Returns:
        the ifTableSuffix
      • getAlias

        public String getAlias()
        Returns:
        the alias
      • getIpAddressList

        public List<org.netxms.base.InetAddressEx> getIpAddressList()
        Returns:
        the ipAddressList
      • hasAddress

        public boolean hasAddress​(org.netxms.base.InetAddressEx addr)
        Check if given address present on interface
        Parameters:
        addr - IP address
        Returns:
        true if given address present on interface
      • hasAddress

        public boolean hasAddress​(InetAddress addr)
        Check if given address present on interface
        Parameters:
        addr - IP address
        Returns:
        true if given address present on interface
      • getFirstUnicastAddress

        public InetAddress getFirstUnicastAddress()
        Get first unicast address
        Returns:
        first unicast address
      • getFirstUnicastAddressEx

        public org.netxms.base.InetAddressEx getFirstUnicastAddressEx()
        Get first unicast address
        Returns:
        first unicast address
      • getIpAddressListAsString

        public String getIpAddressListAsString()
        Get IP address list as string
        Returns:
        IP address list as string
      • getIfTypeName

        public static String getIfTypeName​(int ifType)
        Get symbolic name for interface type
        Parameters:
        ifType - interface type
        Returns:
        symbolic name for interface type
      • getParentInterfaceId

        public long getParentInterfaceId()
        Get object ID of parent interface
        Returns:
        parent interface object ID or 0
      • getParentInterface

        public Interface getParentInterface()
        Get parent interface object
        Returns:
        parent interface object or null
      • getVlans

        public long[] getVlans()
        Returns:
        the vlans