Interface (NetXMS Client Library 1.2.13 API)

java.lang.Object
- org.netxms.client.objects.AbstractObject
- - org.netxms.client.objects.GenericObject
  - - org.netxms.client.objects.Interface

public class Interface
extends GenericObject

Network interface object

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADMIN_STATE_DOWN`
`static int`	`ADMIN_STATE_TESTING`
`static int`	`ADMIN_STATE_UNKNOWN`
`static int`	`ADMIN_STATE_UP`
`static int`	`BACKEND_STATE_FAIL`
`static int`	`BACKEND_STATE_IDLE`
`static int`	`BACKEND_STATE_IGNORE`
`static int`	`BACKEND_STATE_INITIALIZE`
`static int`	`BACKEND_STATE_REQUEST`
`static int`	`BACKEND_STATE_RESPONSE`
`static int`	`BACKEND_STATE_SUCCESS`
`static int`	`BACKEND_STATE_TIMEOUT`
`static int`	`BACKEND_STATE_UNKNOWN`
`static int`	`IF_CREATED_MANUALLY`
`static int`	`IF_EXCLUDE_FROM_TOPOLOGY`
`static int`	`IF_EXPECTED_STATE_MASK`
`static int`	`IF_LOOPBACK`
`static int`	`IF_PHYSICAL_PORT`
`static int`	`IF_SYNTHETIC_MASK`
`static int`	`OPER_STATE_DOWN`
`static int`	`OPER_STATE_TESTING`
`static int`	`OPER_STATE_UNKNOWN`
`static int`	`OPER_STATE_UP`
`static int`	`PAE_STATE_ABORTING`
`static int`	`PAE_STATE_AUTHENTICATED`
`static int`	`PAE_STATE_AUTHENTICATING`
`static int`	`PAE_STATE_CONNECTING`
`static int`	`PAE_STATE_DISCONNECTED`
`static int`	`PAE_STATE_FORCE_AUTH`
`static int`	`PAE_STATE_FORCE_UNAUTH`
`static int`	`PAE_STATE_HELD`
`static int`	`PAE_STATE_INITIALIZE`
`static int`	`PAE_STATE_RESTART`
`static int`	`PAE_STATE_UNKNOWN`

Fields inherited from class org.netxms.client.objects.AbstractObject
accessList, BUSINESSSERVICEROOT, CALCULATE_DEFAULT, CALCULATE_MOST_CRITICAL, CALCULATE_MULTIPLE_THRESHOLDS, CALCULATE_SINGLE_THRESHOLD, children, comments, customAttributes, DASHBOARDROOT, fixedPropagatedStatus, geolocation, guid, image, inheritAccessRights, isDeleted, NETWORK, NETWORKMAPROOT, OBJECT_ACCESSPOINT, OBJECT_AGENTPOLICY, OBJECT_AGENTPOLICY_CONFIG, OBJECT_BUSINESSSERVICE, OBJECT_BUSINESSSERVICEROOT, OBJECT_CLUSTER, OBJECT_CONDITION, OBJECT_CONTAINER, OBJECT_CUSTOM, OBJECT_DASHBOARD, OBJECT_DASHBOARDROOT, OBJECT_GENERIC, OBJECT_INTERFACE, OBJECT_MOBILEDEVICE, OBJECT_NETWORK, OBJECT_NETWORKMAP, OBJECT_NETWORKMAPGROUP, OBJECT_NETWORKMAPROOT, OBJECT_NETWORKSERVICE, OBJECT_NODE, OBJECT_NODELINK, OBJECT_POLICYGROUP, OBJECT_POLICYROOT, OBJECT_RACK, OBJECT_REPORT, OBJECT_REPORTGROUP, OBJECT_REPORTROOT, OBJECT_SERVICEROOT, OBJECT_SLMCHECK, OBJECT_SUBNET, OBJECT_TEMPLATE, OBJECT_TEMPLATEGROUP, OBJECT_TEMPLATEROOT, OBJECT_VPNCONNECTOR, OBJECT_ZONE, objectClass, objectId, objectName, parents, POLICYROOT, primaryIP, PROPAGATE_DEFAULT, PROPAGATE_FIXED, PROPAGATE_RELATIVE, PROPAGATE_TRANSLATED, PROPAGATE_UNCHANGED, REPORTROOT, SERVICEROOT, session, status, statusCalculationMethod, statusPropagationMethod, statusShift, statusSingleThreshold, statusThresholds, statusTransformation, submapId, TEMPLATEROOT, trustedNodes, ZONE0

Constructor Summary

Constructors
Constructor and Description

Interface(NXCPMessage msg, NXCSession session)

Constructors
Constructor and Description
`Interface(NXCPMessage msg, NXCSession session)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getAdminState()`
`java.lang.String`	`getAdminStateAsText()`
`java.lang.String`	`getDescription()`
`int`	`getDot1xBackendState()`
`java.lang.String`	`getDot1xBackendStateAsText()` Get 802.1x backend state as text
`int`	`getDot1xPaeState()`
`java.lang.String`	`getDot1xPaeStateAsText()` Get 802.1x PAE state as text
`int`	`getExpectedState()` Get interface expected state
`int`	`getFlags()`
`int`	`getIfIndex()`
`int`	`getIfType()`
`MacAddress`	`getMacAddress()`
`java.lang.String`	`getObjectClassName()`
`int`	`getOperState()`
`java.lang.String`	`getOperStateAsText()`
`AbstractNode`	`getParentNode()` Get parent node object.
`long`	`getPeerInterfaceId()`
`long`	`getPeerNodeId()`
`int`	`getPort()`
`int`	`getRequiredPollCount()`
`int`	`getSlot()`
`java.net.InetAddress`	`getSubnetMask()`
`long`	`getZoneId()`
`boolean`	`isExcludedFromTopology()`
`boolean`	`isLoopback()`
`boolean`	`isPhysicalPort()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - IF_SYNTHETIC_MASK
```
public static final int IF_SYNTHETIC_MASK
```
    See Also:
    Constant Field Values
  - IF_PHYSICAL_PORT
```
public static final int IF_PHYSICAL_PORT
```
    See Also:
    Constant Field Values
  - IF_EXCLUDE_FROM_TOPOLOGY
```
public static final int IF_EXCLUDE_FROM_TOPOLOGY
```
    See Also:
    Constant Field Values
  - IF_LOOPBACK
```
public static final int IF_LOOPBACK
```
    See Also:
    Constant Field Values
  - IF_CREATED_MANUALLY
```
public static final int IF_CREATED_MANUALLY
```
    See Also:
    Constant Field Values
  - IF_EXPECTED_STATE_MASK
```
public static final int IF_EXPECTED_STATE_MASK
```
    See Also:
    Constant Field Values
  - ADMIN_STATE_UNKNOWN
```
public static final int ADMIN_STATE_UNKNOWN
```
    See Also:
    Constant Field Values
  - ADMIN_STATE_UP
```
public static final int ADMIN_STATE_UP
```
    See Also:
    Constant Field Values
  - ADMIN_STATE_DOWN
```
public static final int ADMIN_STATE_DOWN
```
    See Also:
    Constant Field Values
  - ADMIN_STATE_TESTING
```
public static final int ADMIN_STATE_TESTING
```
    See Also:
    Constant Field Values
  - OPER_STATE_UNKNOWN
```
public static final int OPER_STATE_UNKNOWN
```
    See Also:
    Constant Field Values
  - OPER_STATE_UP
```
public static final int OPER_STATE_UP
```
    See Also:
    Constant Field Values
  - OPER_STATE_DOWN
```
public static final int OPER_STATE_DOWN
```
    See Also:
    Constant Field Values
  - OPER_STATE_TESTING
```
public static final int OPER_STATE_TESTING
```
    See Also:
    Constant Field Values
  - PAE_STATE_UNKNOWN
```
public static final int PAE_STATE_UNKNOWN
```
    See Also:
    Constant Field Values
  - PAE_STATE_INITIALIZE
```
public static final int PAE_STATE_INITIALIZE
```
    See Also:
    Constant Field Values
  - PAE_STATE_DISCONNECTED
```
public static final int PAE_STATE_DISCONNECTED
```
    See Also:
    Constant Field Values
  - PAE_STATE_CONNECTING
```
public static final int PAE_STATE_CONNECTING
```
    See Also:
    Constant Field Values
  - PAE_STATE_AUTHENTICATING
```
public static final int PAE_STATE_AUTHENTICATING
```
    See Also:
    Constant Field Values
  - PAE_STATE_AUTHENTICATED
```
public static final int PAE_STATE_AUTHENTICATED
```
    See Also:
    Constant Field Values
  - PAE_STATE_ABORTING
```
public static final int PAE_STATE_ABORTING
```
    See Also:
    Constant Field Values
  - PAE_STATE_HELD
```
public static final int PAE_STATE_HELD
```
    See Also:
    Constant Field Values
  - PAE_STATE_FORCE_AUTH
```
public static final int PAE_STATE_FORCE_AUTH
```
    See Also:
    Constant Field Values
  - PAE_STATE_FORCE_UNAUTH
```
public static final int PAE_STATE_FORCE_UNAUTH
```
    See Also:
    Constant Field Values
  - PAE_STATE_RESTART
```
public static final int PAE_STATE_RESTART
```
    See Also:
    Constant Field Values
  - BACKEND_STATE_UNKNOWN
```
public static final int BACKEND_STATE_UNKNOWN
```
    See Also:
    Constant Field Values
  - BACKEND_STATE_REQUEST
```
public static final int BACKEND_STATE_REQUEST
```
    See Also:
    Constant Field Values
  - BACKEND_STATE_RESPONSE
```
public static final int BACKEND_STATE_RESPONSE
```
    See Also:
    Constant Field Values
  - BACKEND_STATE_SUCCESS
```
public static final int BACKEND_STATE_SUCCESS
```
    See Also:
    Constant Field Values
  - BACKEND_STATE_FAIL
```
public static final int BACKEND_STATE_FAIL
```
    See Also:
    Constant Field Values
  - BACKEND_STATE_TIMEOUT
```
public static final int BACKEND_STATE_TIMEOUT
```
    See Also:
    Constant Field Values
  - BACKEND_STATE_IDLE
```
public static final int BACKEND_STATE_IDLE
```
    See Also:
    Constant Field Values
  - BACKEND_STATE_INITIALIZE
```
public static final int BACKEND_STATE_INITIALIZE
```
    See Also:
    Constant Field Values
  - BACKEND_STATE_IGNORE
```
public static final int BACKEND_STATE_IGNORE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - Interface
```
public Interface(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
  - getSubnetMask
```
public java.net.InetAddress getSubnetMask()
```
    Returns:
    Interface subnet mask
  - getIfIndex
```
public int getIfIndex()
```
    Returns:
    Interface index
  - getIfType
```
public int getIfType()
```
    Returns:
    Interface type
  - getMacAddress
```
public MacAddress getMacAddress()
```
    Returns:
    Interface MAC address
  - getRequiredPollCount
```
public int getRequiredPollCount()
```
    Returns:
    Number of polls required to change interface status
  - getObjectClassName
```
public java.lang.String getObjectClassName()
```
    Overrides:
    
    getObjectClassName in class AbstractObject
    
    Returns:
    Name of NetXMS object's class
  - getSlot
```
public int getSlot()
```
    Returns:
    the slot
  - getPort
```
public int getPort()
```
    Returns:
    the port
  - getPeerNodeId
```
public long getPeerNodeId()
```
    Returns:
    the peerNodeId
  - getPeerInterfaceId
```
public long getPeerInterfaceId()
```
    Returns:
    the peerInterfaceId
  - getZoneId
```
public long getZoneId()
```
    Returns:
    the zoneId
  - getDescription
```
public java.lang.String getDescription()
```
    Returns:
    the description
  - getFlags
```
public int getFlags()
```
    Returns:
    the flags
  - getDot1xPaeState
```
public int getDot1xPaeState()
```
    Returns:
    the dot1xPaeState
  - getDot1xPaeStateAsText
```
public java.lang.String getDot1xPaeStateAsText()
```
    Get 802.1x PAE state as text
    
    Returns:
  - getDot1xBackendState
```
public int getDot1xBackendState()
```
    Returns:
    the dot1xBackendState
  - getDot1xBackendStateAsText
```
public java.lang.String getDot1xBackendStateAsText()
```
    Get 802.1x backend state as text
    
    Returns:
  - getAdminState
```
public int getAdminState()
```
    Returns:
    the adminState
  - getAdminStateAsText
```
public java.lang.String getAdminStateAsText()
```
    Returns:
    the adminState
  - getOperState
```
public int getOperState()
```
    Returns:
    the operState
  - getOperStateAsText
```
public java.lang.String getOperStateAsText()
```
    Returns:
    the operState
  - getExpectedState
```
public int getExpectedState()
```
    Get interface expected state
    
    Returns:
  - isPhysicalPort
```
public boolean isPhysicalPort()
```
    Returns:
  - isLoopback
```
public boolean isLoopback()
```
    Returns:
  - isExcludedFromTopology
```
public boolean isExcludedFromTopology()
```
    Returns:

Class Interface

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

IF_SYNTHETIC_MASK

IF_PHYSICAL_PORT

IF_EXCLUDE_FROM_TOPOLOGY

IF_LOOPBACK

IF_CREATED_MANUALLY

IF_EXPECTED_STATE_MASK

ADMIN_STATE_UNKNOWN

ADMIN_STATE_UP

ADMIN_STATE_DOWN

ADMIN_STATE_TESTING

OPER_STATE_UNKNOWN

OPER_STATE_UP

OPER_STATE_DOWN

OPER_STATE_TESTING

PAE_STATE_UNKNOWN

PAE_STATE_INITIALIZE

PAE_STATE_DISCONNECTED

PAE_STATE_CONNECTING

PAE_STATE_AUTHENTICATING

PAE_STATE_AUTHENTICATED

PAE_STATE_ABORTING

PAE_STATE_HELD

PAE_STATE_FORCE_AUTH

PAE_STATE_FORCE_UNAUTH

PAE_STATE_RESTART

BACKEND_STATE_UNKNOWN

BACKEND_STATE_REQUEST

BACKEND_STATE_RESPONSE

BACKEND_STATE_SUCCESS

BACKEND_STATE_FAIL

BACKEND_STATE_TIMEOUT

BACKEND_STATE_IDLE

BACKEND_STATE_INITIALIZE

BACKEND_STATE_IGNORE

Constructor Detail

Interface

Method Detail

getParentNode

getSubnetMask

getIfIndex

getIfType

getMacAddress

getRequiredPollCount

getObjectClassName

getSlot

getPort

getPeerNodeId

getPeerInterfaceId

getZoneId

getDescription

getFlags

getDot1xPaeState

getDot1xPaeStateAsText

getDot1xBackendState

getDot1xBackendStateAsText

getAdminState

getAdminStateAsText

getOperState

getOperStateAsText

getExpectedState

isPhysicalPort

isLoopback

isExcludedFromTopology