About the XML import format
This topic contains information about the XML import format for TrueSight Network Automation.
XML import format
The import task maps the XML formatted file as shown in the following table.
Note
This format supports importing the auxiliary interface data.
Device field | XML tag | Required (Y/N) | Comments |
|---|---|---|---|
Name | name | Y | Required on all imports (new/update). Must be a unique name. Up to 100 characters in length. |
Hostname/IP Address 1 | address | Y | Required for new devices. |
Realm | realm | Y | Required for new devices if more than one realm is defined in the system. The value must be specified from one of the following:
|
External ID | externalId | N | A unique identifier for the device obtained from an external system; used to sync the TrueSight Network Automation database with BMC Atrium CMDB. |
Device Type | deviceType | Y | Required for new devices if the snmpOid field is not present. Can be either a GUID or a name. You can find the legal GUIDs and names in the Device Adapter Capabilities report attached to the Supported devices page. |
SNMP OID | snmpOid | N | Required for new devices if the deviceType field is not present. OID is used to look up the device type. If the device has both device type and snmpOid fields, and the two values are not consistent with each other as specified in the corresponding device adapter definition, the device is not imported. |
Category | category | Y | Required for new devices. The category can come from one of the following:
|
Security Context | securityContextType | N | If the device represents a security context within a multi-context device, then this value specifies what sort of context. Legal values are admin, system, userDefined, and none. |
Security Context Name | securityContextName | N | Name of the security context when securityContextType is userDefined. |
Device Agent 1 | agent | N | If not specified, the default agent is used. |
Device Agent NIC1 | agentNIC | N | If not specified, the default NIC is used. Note: If you specify the name of the default NIC in XML, device import fails. If you leave the field empty, default NIC is used. |
Access Mode 1 | accessMode | N | Default = auto Field options: auto, telnet, ssh2, http10, http11, https10 or https11 |
Port 1 | port | N | TCP port used for communcation with the device |
File Transfer Mode 1 | transferMode | N | Default = auto Field options: auto, tftp, ftp, scp, tunneled |
Device Security Profile 1 | deviceSecurityProfile | N | Default = auto Supply the name of the DSP to be used as device credentials. |
NAT Address 1 | enaNatAddress | N | For a description of the NAT Address, see Adding a device. |
Dynamic Field Label | dynamicField | N | In the example, Description and Location are dynamic fields. |
NEW IN 8.9.04.001Static Groups | groups | N | This field is applicable for only static groups, not auto groups. In the example, Device Location and Contract PO Number are static groups. |
Device Status Tab (Inventory) | inventory | N | The inventory text is displayed in the Device Details tab. |
Hostname/IP Address 2 | auxAddress | N | Required only if:
|
Access Mode 2 | auxAccessMode | N | Default = auto Field options: auto, telnet, ssh2, http10, http11, https10 or https11 |
Port 2 | auxPort | N | TCP port used for communcation with the device |
File Transfer Mode 2 | auxTransferMode | N | Default = auto Field options: auto, tftp, ftp, scp, tunneled |
Device Security Profile 2 | auxDeviceSecurityProfile | N | Default = auto Supply the name of the DSP to be used as device credentials. |
NAT Address 2 | auxNatAddress | N | For a description of the NAT Address, see Adding a device. |
Device Agent 2 | auxAgent | N | If not specified, the default agent is used. |
Device Agent NIC 2 | auxAgentNIC | N | If not specified, the default NIC is used. Note: If you specify the name of the default NIC in XML, device import fails. If you leave the field empty, default NIC is used. |
- These attributes are for the primary interface.
- These attributes are for the auxiliary interface.
XML formatting guidelines
Follow these guidelines while formatting an XML file:
- The XML file must begin and end with the
<import>and</import>tags. - Each device must begin and end with the
<device>and</device>tags. - Dynamic fields must begin and end with the
<dynamicFields>and</dynamicFields>tags. - Groups must begin and end with the
<groups>and</groups>tags.
Example XML formatted file
The XML tags must use the letter case shown in the previous table (for example, name, externalId).
<?xml version="1.0" encoding="UTF-8"?>
<import xmlns:xsi="http://www.w3.org/2001/XML.Schema=instance">
<device>
<name>cisco1760-01</name>
<address>cisco1760-01</address>
<realm>Speedy Print Services</realm>
<deviceType>BE2B2D21-1CAA-53C3-05C3-CBB0A5D151B8</deviceType>
<snmpOid>1.3.6.1.4.1.9.1.416</snmpOid>
<category>1</category>
<agent>Local</agent>
<agentNIC>default</agentNIC>
<accessMode>ssh2</accessMode>
<transferMode>scp</transferMode>
<dynamicFields>
<dynamicField name="Description">This is the description</dynamicField>
<dynamicField name="Location">ATL</dynamicField>
</dynamicFields>
<groups>
<group>Device Location</group>
<group>Contract PO Number</group>
</groups>
</device>
</import>
Device category IDs for CategoryMap
The following table lists the device category IDs for the CategoryMap.xml file.
Device category | ID |
|---|---|
Router | 1 |
Switch | 2 |
Layer 3 Switch | 3 |
Firewall | 4 |
Content Cache | 5 |
VPN Concentrator | 6 |
Load Balancer | 7 |
SAN Switch | 8 |
Wireless Device | 9 |
Application Accelerator | 10 |
Other | 98 |
Unknown | 99 |
Comments
Log in or register to comment.