NetworkDevice (ITNM Collector Framework v4.2 FP24 API)

java.lang.Object
- com.ibm.tivoli.nm.collectors.framework.store.Element
- - com.ibm.tivoli.nm.collectors.framework.store.NetworkDevice

All Implemented Interfaces:

Associatable

Direct Known Subclasses:

RANNetworkDevice
```
public class NetworkDevice
extends Element
```
Class representing a network device to be used as an in memory data store for the collector framework. This class holds collected network data for a given network device, which is commonly an entity like a network chassis.

Author:

Emlyn Whittick

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`addressSpace` A string representing the address space of the device
`protected java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>>`	`associatedAddresses` A map of all associated address data, hashed by the address' associated interface
`protected java.lang.String`	`baseName` The base name for the device
`protected java.util.Map<java.lang.String,java.lang.Integer>`	`configuredAddresses` A map for looking up a given network address.
`protected java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>>`	`connectivity` A map of all topology connections for this device.
`protected java.lang.String`	`deviceId` The unique identifier for this device
`protected java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`entityList` A map of eneity data for this device
`protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>`	`interfaces` A map of interface data for this device, indexed by interface ID.
`protected int`	`ipForwarding` An integer representing whether IP forwarding is enabled on the device.
`protected java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`layer2Vpns` A list of layer 2 virtual private networks for this device
`protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>`	`layer3Vpns` A map of layer 3 virtual private networks for this device, indexed by VPN name
`protected java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`lspList` A list of layer switch paths for this device
`protected java.lang.String`	`managedElementId` An optional custom ID field to be used when an ID is required in addition to the standard 'native' id
`protected java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`mplsInterfaces` A list of MPLS interfaces for this device
`protected int`	`protocol` An integer that represents the address protocol.
`protected java.lang.String`	`sysDescr` The system description (sysDescr attribute) for this device
`protected java.lang.String`	`sysName` The system name (sysName attribute) for this device
`protected java.lang.String`	`sysObjectId` The sysObjectId attribute for this device
`protected java.lang.String`	`uniqueAddress` The unique address for this device.

Fields inherited from class com.ibm.tivoli.nm.collectors.framework.store.Element
customData, extraInfo

Constructor Summary

Constructors
Constructor and Description
`NetworkDevice(java.lang.String deviceId, java.lang.String uniqueAddress)` Create a new network device with a given Device ID to store data from a collector
`NetworkDevice(java.lang.String deviceId, java.lang.String uniqueAddress, java.lang.String baseName, java.lang.String sysObjectId)` Constructor that takes all required attributes for a device

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAssociatedAddress(java.lang.String interfaceKey, java.util.Map<java.lang.String,java.lang.Object> addressData)` Add an associated address for a device.
`void`	`addConfiguredAddress(java.lang.String address, int ifOperStatus)` Add an address to a map to indicate that the given address is associated with this device, for the purposes of a quick lookup
`void`	`addConnection(java.lang.String topologyType, java.util.Map<java.lang.String,java.lang.Object> connectionData)` Add a connection within a given topology for this device.
`void`	`addInterface(java.lang.String interfaceKey, java.util.Map<java.lang.String,java.lang.Object> data)` Add interface data to the device.
`void`	`addL3Vpn(java.lang.String vpnName, java.util.Map<java.lang.String,java.lang.Object> data)` Add layer 3 VPN data to a device.
`void`	`addL3VpnInterface(java.lang.String vpnName, java.lang.String interfaceKey, java.util.Map<java.lang.String,java.lang.Object> interfaceData)` Add VPN interface data for a given layer 3 VPN.
`void`	`addL3VpnRouteTarget(java.lang.String vpnName, java.lang.String routeTarget, int routeTargetType)` Adds VPN route target data for a given VPN
`void`	`associate(Associatable a)` This method does not provide any functionality for a standard `NetworkDevice` as there are currently no automatic associations that can be inferred from two devices.
`java.lang.String`	`getAddressSpace()` Get the address space for this device
`java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>>`	`getAssociatedAddresses()` Returns a map of all associated addresses for the device by interface
`java.lang.String`	`getBaseName()` Get the base name for this device
`java.util.Map<java.lang.String,java.lang.Integer>`	`getConfiguredAddresses()` Returns a map of all addresses for the device for quick lookup of addresses - see `hasAddress(java.lang.String)`
`java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`getConnections(java.lang.String topologyType)` Get a list of all connections for a specified topology type
`java.lang.String`	`getDeviceId()` Get the ID of the device (see also `getId()`)
`java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`getEntityList()` Get a list of all entities for the device
`java.lang.String`	`getId()` Get the ID of the device (see also `getDeviceId()`)
`java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>`	`getInterfaces()` Get all the interfaces defined for this device
`int`	`getIpForwarding()` Get the ipForwarding value for this device
`java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`getLayer2Vpns()` Get a list of all layer 2 VPNs
`java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>`	`getLayer3Vpns()` Get a list of all layer 3 VPNs
`java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`getLspList()` Get a list of all LSPs
`java.lang.String`	`getManagedElementId()` Get the managed element ID for this device
`java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`getMplsInterfaces()` Get a list of all MPLS interfaces
`java.lang.String`	`getName()` Get the name of this device.
`int`	`getProtocol()` Get the protocol for this device.
`java.lang.String`	`getSysDescr()` Get the system description for this device
`java.lang.String`	`getSysName()` Get the system name for this device
`java.lang.String`	`getSysObjectId()` Get the system object ID for this device
`java.lang.String`	`getUniqueAddress()` Get the unique address for this device
`java.lang.String`	`getUniqueID()` Get the management IP of this device (this is an alias for `getUniqueAddress()`
`boolean`	`hasAddress(java.lang.String address)` Check whether a device has a given address configured for it
`boolean`	`isInSubnet(java.lang.String subnetAddress, java.lang.String subnetMask)` Checks whether the device is in a given subnet.
`boolean`	`merge(Element elementData)` Merge the data from a given network device object with this one
`void`	`resolveDeviceAddresses()` Builds the associated address list based on the existing interface data.
`void`	`setAddressSpace(java.lang.String addressSpace)` Set the address space for this deivce
`void`	`setBaseName(java.lang.String baseName)` Set the base name for this device
`void`	`setDeviceId(java.lang.String deviceId)` Set the Device ID
`void`	`setIpForwarding(int ipForwarding)` Set the ipForwarding attribute for this device
`void`	`setManagedElementId(java.lang.String managedElementId)` Set the managed element ID for this device
`void`	`setManagementIpAddress(java.lang.String managementIpAddress)` If a device has an IP, assign a management IP address
`void`	`setProtocol(int protocol)` Set the textual description of the protocol
`void`	`setSysDescr(java.lang.String sysDescr)` Set the sysDescr attribute for the device
`void`	`setSysName(java.lang.String sysName)` Set the sysName attribute for the device
`void`	`setSysObjectId(java.lang.String sysObjectId)` Set the sysObjectId attribute for the device
`void`	`setUniqueName(java.lang.String uniqueName)` For non-IP devices, a unique name must be provided instead of an IP address.
`java.lang.String`	`toDeviceInfoXMLString()` Generate an XML representation of the network device information
`java.lang.String`	`toInventoryXMLString()` Generate an XML representation of the network device inventory
`java.lang.String`	`toMPLSInterfaceXMLString()` Generate an XML representation of the MPLS interface data for the device
`java.lang.String`	`toXMLString()` Generate an XML representation of the network device

Methods inherited from class com.ibm.tivoli.nm.collectors.framework.store.Element
addCustomData, addExtraInfo, getCustomData, getExtraInfo

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

- Field Detail
  - addressSpace
```
protected java.lang.String addressSpace
```
    A string representing the address space of the device
  - associatedAddresses
```
protected java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>> associatedAddresses
```
    A map of all associated address data, hashed by the address' associated interface
  - baseName
```
protected java.lang.String baseName
```
    The base name for the device
  - configuredAddresses
```
protected java.util.Map<java.lang.String,java.lang.Integer> configuredAddresses
```
    A map for looking up a given network address. The key is the String representation of the address e.g. 192.168.0.1 and the value being the ifOperStatus attribute of the associated interface.
  - connectivity
```
protected java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>> connectivity
```
    A map of all topology connections for this device. For example, all layer 1 connections would be indexed under the key: Layer1.
  - deviceId
```
protected java.lang.String deviceId
```
    The unique identifier for this device
  - entityList
```
protected java.util.List<java.util.Map<java.lang.String,java.lang.Object>> entityList
```
    A map of eneity data for this device
  - interfaces
```
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> interfaces
```
    A map of interface data for this device, indexed by interface ID.
  - ipForwarding
```
protected int ipForwarding
```
    An integer representing whether IP forwarding is enabled on the device. -1 if not set or unknown
  - layer2Vpns
```
protected java.util.List<java.util.Map<java.lang.String,java.lang.Object>> layer2Vpns
```
    A list of layer 2 virtual private networks for this device
  - layer3Vpns
```
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> layer3Vpns
```
    A map of layer 3 virtual private networks for this device, indexed by VPN name
  - lspList
```
protected java.util.List<java.util.Map<java.lang.String,java.lang.Object>> lspList
```
    A list of layer switch paths for this device
  - managedElementId
```
protected java.lang.String managedElementId
```
    An optional custom ID field to be used when an ID is required in addition to the standard 'native' id
    
    See Also:
    
    deviceId
  - mplsInterfaces
```
protected java.util.List<java.util.Map<java.lang.String,java.lang.Object>> mplsInterfaces
```
    A list of MPLS interfaces for this device
  - protocol
```
protected int protocol
```
    An integer that represents the address protocol. A value of 4 represents a non-IP device. A value of -1 represents a not set or unknown value.
  - sysDescr
```
protected java.lang.String sysDescr
```
    The system description (sysDescr attribute) for this device
  - sysName
```
protected java.lang.String sysName
```
    The system name (sysName attribute) for this device
  - sysObjectId
```
protected java.lang.String sysObjectId
```
    The sysObjectId attribute for this device
  - uniqueAddress
```
protected java.lang.String uniqueAddress
```
    The unique address for this device. For IP devices, this will be the management IP address. For non-IP addresses, this will be a unique name used to identify the device (e.g. the baseName)
- Constructor Detail
  - NetworkDevice
```
public NetworkDevice(java.lang.String deviceId,
                     java.lang.String uniqueAddress)
```
    Create a new network device with a given Device ID to store data from a collector
    
    Parameters:
    
    deviceId - The ID of the device
    
    uniqueAddress - The management IP of the device or if there's no IP address, another unique name
  - NetworkDevice
```
public NetworkDevice(java.lang.String deviceId,
                     java.lang.String uniqueAddress,
                     java.lang.String baseName,
                     java.lang.String sysObjectId)
```
    Constructor that takes all required attributes for a device
    
    Parameters:
    
    deviceId - The ID of the device
    
    uniqueAddress - The management IP of the device or if there's no IP address, another unique name
    
    baseName - The name of the device
    
    sysObjectId - The system object ID of the device
- Method Detail
  - addAssociatedAddress
```
public void addAssociatedAddress(java.lang.String interfaceKey,
                                 java.util.Map<java.lang.String,java.lang.Object> addressData)
```
    Add an associated address for a device. For the format of the addressData, see CollectorValidationUtils.validateAddressData(Map)
    
    Parameters:
    
    interfaceKey - The interface to add the address to
    
    addressData - The address data: IfIndex, IfOperStatus, IpAddress
    
    See Also:
    
    CollectorValidationUtils.validateAddressData(Map)
  - addConfiguredAddress
```
public void addConfiguredAddress(java.lang.String address,
                                 int ifOperStatus)
```
    Add an address to a map to indicate that the given address is associated with this device, for the purposes of a quick lookup
    
    Parameters:
    
    address -
    
    ifOperStatus -
  - addConnection
```
public void addConnection(java.lang.String topologyType,
                          java.util.Map<java.lang.String,java.lang.Object> connectionData)
```
    Add a connection within a given topology for this device. For example, adding a microwave or layer 2 connection. For the format of the data, see CollectorValidationUtils.validateConnectionData(Map)
    
    Parameters:
    
    topologyType - The type of connection, for example Layer1, Layer2 or Microwave
    
    connectionData - Link data: SourceName SourceInterfaceId DestinationName DestinationInterfaceId
    
    See Also:
    
    CollectorValidationUtils.validateConnectionData(Map)
  - addInterface
```
public void addInterface(java.lang.String interfaceKey,
                         java.util.Map<java.lang.String,java.lang.Object> data)
```
    Add interface data to the device. For the format of the data, see CollectorValidationUtils.validateInterfaceData(Map)
    
    Parameters:
    
    interfaceKey - The key of the interface to add data to
    
    data - Interface data: Port Card IfIndex InterfaceId IfDescr IfName IfType IsConnected PhysAddress IpAddress Subnet SubnetMask NetMask
    
    See Also:
    
    CollectorValidationUtils.validateInterfaceData(Map)
  - addL3Vpn
```
public void addL3Vpn(java.lang.String vpnName,
                     java.util.Map<java.lang.String,java.lang.Object> data)
```
    Add layer 3 VPN data to a device. For the format of the data, see CollectorValidationUtils.validateL3VPNData(Map)
    
    Parameters:
    
    vpnName - The name of the VPN
    
    data - The VPN data: VPNName VRFName RD Status Description ImportRTs (see addL3VpnRouteTarget(java.lang.String, java.lang.String, int)) ExportRTs (see addL3VpnRouteTarget(java.lang.String, java.lang.String, int)) Interfaces (see addL3VpnInterface(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.Object>))
    
    See Also:
    
    CollectorValidationUtils.validateL3VPNData(Map)
  - addL3VpnInterface
```
public void addL3VpnInterface(java.lang.String vpnName,
                              java.lang.String interfaceKey,
                              java.util.Map<java.lang.String,java.lang.Object> interfaceData)
                       throws CollectorException
```
    Add VPN interface data for a given layer 3 VPN. For the format of the interfaceData, see CollectorValidationUtils.validateL3VPNInterfaceData(Map)
    
    Parameters:
    
    vpnName - The name of the CPN
    
    interfaceKey - The key of the interface
    
    interfaceData - The interface data: IfIndex InterfaceId CEAddress Protocol
    
    Throws:
    
    CollectorException - if the L3 VPN for which the data is being added, cannot be found in the data store
    
    See Also:
    
    CollectorValidationUtils.validateL3VPNInterfaceData(Map)
  - addL3VpnRouteTarget
```
public void addL3VpnRouteTarget(java.lang.String vpnName,
                                java.lang.String routeTarget,
                                int routeTargetType)
                         throws CollectorException
```
    Adds VPN route target data for a given VPN
    
    Parameters:
    
    vpnName - The name of the VPN
    
    routeTarget - The route target
    
    routeTargetType - The route target type (import/export/both)
    
    Throws:
    
    CollectorException - if the L3 VPN for which the data is being added, cannot be found in the data store
    
    See Also:
    
    CollectorValidationUtils.validateL3VPNRTData(String, int)
  - associate
```
public void associate(Associatable a)
```
    This method does not provide any functionality for a standard NetworkDevice as there are currently no automatic associations that can be inferred from two devices.
    
    Parameters:
    
    a - The object to associate with this object.
  - getAddressSpace
```
public java.lang.String getAddressSpace()
```
    Get the address space for this device
    
    Returns:
    
    The address space for this device
  - getAssociatedAddresses
```
public java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>> getAssociatedAddresses()
```
    Returns a map of all associated addresses for the device by interface
    
    Returns:
    
    a map of all associated addresses for the device by interface
  - getBaseName
```
public java.lang.String getBaseName()
```
    Get the base name for this device
    
    Returns:
    
    The base name for this device
  - getConfiguredAddresses
```
public java.util.Map<java.lang.String,java.lang.Integer> getConfiguredAddresses()
```
    Returns a map of all addresses for the device for quick lookup of addresses - see hasAddress(java.lang.String)
    
    Returns:
    
    a map of address -> IfOperStatus
  - getConnections
```
public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getConnections(java.lang.String topologyType)
```
    Get a list of all connections for a specified topology type
    
    Parameters:
    
    topologyType - The type of topology connections to get (e.g. Layer1, Layer2)
    
    Returns:
    
    a list of all connections for a specified topology type
  - getDeviceId
```
public java.lang.String getDeviceId()
```
    Get the ID of the device (see also getId())
    
    Returns:
    
    The ID of the device
  - getEntityList
```
public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getEntityList()
```
    Get a list of all entities for the device
    
    Returns:
    
    A list of all the entities for the device
  - getId
```
public java.lang.String getId()
```
    Get the ID of the device (see also getDeviceId())
    
    Specified by:
    
    getId in class Element
    
    Returns:
    
    The ID of the device
  - getInterfaces
```
public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> getInterfaces()
```
    Get all the interfaces defined for this device
    
    Returns:
    
    A map of all interfaces with the interface ID being the key
  - getIpForwarding
```
public int getIpForwarding()
```
    Get the ipForwarding value for this device
    
    Returns:
    
    The integer value that represents whether or not IP forwarding is enabled
  - getLayer2Vpns
```
public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getLayer2Vpns()
```
    Get a list of all layer 2 VPNs
    
    Returns:
    
    a list of all layer 2 VPNs
  - getLayer3Vpns
```
public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> getLayer3Vpns()
```
    Get a list of all layer 3 VPNs
    
    Returns:
    
    a list of all layer 3 VPNs
  - getLspList
```
public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getLspList()
```
    Get a list of all LSPs
    
    Returns:
    
    a list of all LSPs
  - getManagedElementId
```
public java.lang.String getManagedElementId()
```
    Get the managed element ID for this device
    
    Returns:
    
    the managed element ID for this device
    
    See Also:
    
    managedElementId
  - getMplsInterfaces
```
public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getMplsInterfaces()
```
    Get a list of all MPLS interfaces
    
    Returns:
    
    a list of all MPLS interfaces
  - getName
```
public java.lang.String getName()
```
    Get the name of this device. By default, has the same behaviour as getBaseName(), but if can be overriden if required.
    
    Specified by:
    
    getName in class Element
    
    Returns:
    
    The name of this element
  - getProtocol
```
public int getProtocol()
```
    Get the protocol for this device. A value of 4 represents a non-IP device.
    
    Returns:
    
    The integer representing the protocol for this device.
  - getSysDescr
```
public java.lang.String getSysDescr()
```
    Get the system description for this device
    
    Returns:
    
    The sysDescr attribute for this device
  - getSysName
```
public java.lang.String getSysName()
```
    Get the system name for this device
    
    Returns:
    
    The sysName attribute for this device
  - getSysObjectId
```
public java.lang.String getSysObjectId()
```
    Get the system object ID for this device
    
    Returns:
    
    The sysObjectId attribute for this device
  - getUniqueAddress
```
public java.lang.String getUniqueAddress()
```
    Get the unique address for this device
    
    Returns:
    
    The unique address that represents either the management IP address (for IP devices) or the unique name (for non-IP devices) of this device
  - getUniqueID
```
public java.lang.String getUniqueID()
```
    Get the management IP of this device (this is an alias for getUniqueAddress()
    
    Returns:
    
    The management IP of this device
  - hasAddress
```
public boolean hasAddress(java.lang.String address)
```
    Check whether a device has a given address configured for it
    
    Parameters:
    
    address - The address
    
    Returns:
    
    Whether or not that address is associated with the devices
  - isInSubnet
```
public boolean isInSubnet(java.lang.String subnetAddress,
                          java.lang.String subnetMask)
```
    Checks whether the device is in a given subnet.
    
    Parameters:
    
    subnetAddress - The address of the subnet
    
    subnetMask - The subnet mask
    
    Returns:
    
    true if any of the device's addresses fall within the subnet
  - merge
```
public boolean merge(Element elementData)
```
    Merge the data from a given network device object with this one
    
    Specified by:
    
    merge in class Element
    
    Parameters:
    
    elementData - The additional data to add/merge
    
    Returns:
    
    Whether or not the data was merged. If false, this indicates that the data could not be merged, e.g. because the deviceId differed
  - resolveDeviceAddresses
```
public void resolveDeviceAddresses()
```
    Builds the associated address list based on the existing interface data.
  - setAddressSpace
```
public void setAddressSpace(java.lang.String addressSpace)
```
    Set the address space for this deivce
    
    Parameters:
    
    addressSpace - The address space for this device
  - setBaseName
```
public void setBaseName(java.lang.String baseName)
```
    Set the base name for this device
    
    Parameters:
    
    baseName - The base name for this device
  - setDeviceId
```
public void setDeviceId(java.lang.String deviceId)
```
    Set the Device ID
    
    Parameters:
    
    deviceId - The ID of the device to set
  - setIpForwarding
```
public void setIpForwarding(int ipForwarding)
```
    Set the ipForwarding attribute for this device
    
    Parameters:
    
    ipForwarding - The integer value for ipForwarding
  - setManagedElementId
```
public void setManagedElementId(java.lang.String managedElementId)
```
    Set the managed element ID for this device
    
    Parameters:
    
    managedElementId - the managed elementId to set for this device
    
    See Also:
    
    managedElementId
  - setManagementIpAddress
```
public void setManagementIpAddress(java.lang.String managementIpAddress)
```
    If a device has an IP, assign a management IP address
    
    Parameters:
    
    managementIpAddress - The main management IP address to be used to identify the device
  - setProtocol
```
public void setProtocol(int protocol)
```
    Set the textual description of the protocol
    
    Parameters:
    
    protocol - The protocol value
  - setSysDescr
```
public void setSysDescr(java.lang.String sysDescr)
```
    Set the sysDescr attribute for the device
    
    Parameters:
    
    sysDescr - The system description for this device
  - setSysName
```
public void setSysName(java.lang.String sysName)
```
    Set the sysName attribute for the device
    
    Parameters:
    
    sysName - The system name for this device
  - setSysObjectId
```
public void setSysObjectId(java.lang.String sysObjectId)
```
    Set the sysObjectId attribute for the device
    
    Parameters:
    
    sysObjectId - The system object ID for this device
  - setUniqueName
```
public void setUniqueName(java.lang.String uniqueName)
```
    For non-IP devices, a unique name must be provided instead of an IP address. Also sets the protocol field to 4 to indicate a non IP address.
    
    Parameters:
    
    uniqueName - A unique name to identify the device
  - toDeviceInfoXMLString
```
public java.lang.String toDeviceInfoXMLString()
```
    Generate an XML representation of the network device information
    Returns:
    An XML representation of the network device information with its id and description e.g
    <deviceInfo> <sysObjectId>1.3.6.1.4.1.0.1.94</sysObjectId> <descr>Vendor Device Description (sysDescr)</descr> <name>10.1.254.1</name> </deviceInfo>
  - toInventoryXMLString
```
public java.lang.String toInventoryXMLString()
```
    Generate an XML representation of the network device inventory
    Returns:
    An XML String listing interfaces for the device, e.g.
    <deviceInventory> <deviceId>10.1.254.1</deviceId> <interfaceList> <interface> <ifPhysAddress>00:99:00:E5:C4:06</ifPhysAddress> <ifDescr>FastEthernet0/1.10</ifDescr> <ifOperStatus>1</ifOperStatus> <ifIndex>19</ifIndex> <interfaceId>MyUniqueInterfaceIdFor19</interfaceId> <ifType>135</ifType> <ipAddress></ipAddress> <ifName>Fa0/1.10</ifName> </interface> .. other interfaces .. </interfaceList> </deviceInventory>
  - toMPLSInterfaceXMLString
```
public java.lang.String toMPLSInterfaceXMLString()
```
    Generate an XML representation of the MPLS interface data for the device
    Returns:
    An XML String listing all the MPLS interfaces for the given device e.g.
    <mplsInterfaceData> <deviceId>10.1.1.1</deviceId> <interfaceList> <interface> <ifIndex>1</ifIndex> </interface> </interfaceList> </mplsInterfaceData>
  - toXMLString
```
public java.lang.String toXMLString()
```
    Generate an XML representation of the network device
    Specified by:
    
    toXMLString in class Element
    
    Returns:
    An XML representation of the network device e.g.
    <device> <id>10.1.230.3</id> <ip>10.1.230.3</ip> <addressSpace></addressSpace> <medId>optionalCustomId</meId> </device>

Class NetworkDevice

Field Summary

Fields inherited from class com.ibm.tivoli.nm.collectors.framework.store.Element

Constructor Summary

Method Summary

Methods inherited from class com.ibm.tivoli.nm.collectors.framework.store.Element

Methods inherited from class java.lang.Object

Field Detail

addressSpace

associatedAddresses

baseName

configuredAddresses

connectivity

deviceId

entityList

interfaces

ipForwarding

layer2Vpns

layer3Vpns

lspList

managedElementId

mplsInterfaces

protocol

sysDescr

sysName

sysObjectId

uniqueAddress

Constructor Detail

NetworkDevice

NetworkDevice

Method Detail

addAssociatedAddress

addConfiguredAddress

addConnection

addInterface

addL3Vpn

addL3VpnInterface

addL3VpnRouteTarget

associate

getAddressSpace

getAssociatedAddresses

getBaseName

getConfiguredAddresses

getConnections

getDeviceId

getEntityList

getId

getInterfaces

getIpForwarding

getLayer2Vpns

getLayer3Vpns

getLspList

getManagedElementId

getMplsInterfaces

getName

getProtocol

getSysDescr

getSysName

getSysObjectId

getUniqueAddress

getUniqueID

hasAddress

isInSubnet

merge

resolveDeviceAddresses

setAddressSpace

setBaseName

setDeviceId

setIpForwarding

setManagedElementId

setManagementIpAddress

setProtocol

setSysDescr

setSysName

setSysObjectId

setUniqueName

toDeviceInfoXMLString

toInventoryXMLString

toMPLSInterfaceXMLString

toXMLString