2.6.1 Creation

The XML definition for network configuration information is shown below.

XML definitions for creation of individual network devices

<?xml version="1.0" encoding="utf-8"?>
<Netdevice ip="Admin IP Address" name="Device Name">
  <Location>Location</Location>
  <Types>
    <Type>Type</Type>
  </Types>
  <Maintenance>Maintenance Mode</Maintenance>
  <AutoConfiguration>Auto-Configuration for Network Device</AutoConfiguration>
  <DeviceInfo>
    <SysObjectId>sysObjectID</SysObjectId>
    <Vendor>Vendor Name</Vendor>
    <ProductName>Device Name</ProductName>
    <ModelName>Model Name</ModelName>
    <Firmware>Firmware</Firmware>
  </DeviceInfo>
  <Redundancy group_id="Group ID"></Redundancy>
  <MgmtInfos>
    <Snmps>
      <ReadCommunity>Community Name</ReadCommunity>
    </Snmps>
    <LoginInfos>
      <LoginInfo auth_type="Management Method for Authentication Information" authority="Administrator Authority" check="Account Confirmation">
        <IpAddress>Destination IP Address</IpAddress>
        <Port>Destination Port Number</Port>
        <Tenant>Tenant Name</Tenant>
        <User>Account</User>
        <Password>Password</Password>
        <PrivilegedPassword>Administrator Password</PrivilegedPassword>
        <PasswordEncryption>Password Encryption</PasswordEncryption>
      </LoginInfo>
    </LoginInfos>
    <Monitoring method="Monitoring Method">
      <Interval>Monitoring Interval</Interval>
      <RetryCount>Retry Count</RetryCount>
      <Timeout>Timeout</Timeout>
    </Monitoring>
    <MgmtURL>Web Management Window URL</MgmtURL>
  </MgmtInfos>
  <Ports>
    <Port name="Port Name">
      <Description>Port Overview</Description>
      <PhysicalState>Communication Status</PhysicalState>
      <Link ip="Management IP address for Link Destination Device" port="Port Name of Link Destination" kind="Type of Link Destination Device" />
    </Port>
  </Ports>
</Netdevice>

XML definitions for batch creation of multiple network devices

<?xml version="1.0" encoding="utf-8"?>
</NetConfig>
<Netdevices>
  <Mode>Registration Mode</Mode>
  <Netdevice ip="Admin IP Address" name="Device Name">
    <Location>Location</Location>
    <Types>
      <Type>Type</Type>
    </Types>
    <Maintenance>Maintenance Mode</Maintenance>
    <AutoConfiguration>Auto-Configuration for Network Device</AutoConfiguration>
    <DeviceInfo>
      <SysObjectId>sysObjectID</SysObjectId>
      <Vendor>Vendor Name</Vendor>
      <ProductName>Device Name</ProductName>
      <ModelName>Model Name</ModelName>
      <Firmware>Firmware</Firmware>
    </DeviceInfo>
    <Redundancy group_id="Group ID"></Redundancy>
    <MgmtInfos>
      <Snmps>
        <ReadCommunity>Community Name</ReadCommunity>
      </Snmps>
      <LoginInfos>
        <LoginInfo auth_type="Management Method for Authentication Information" authority="Administrator Authority" check="Account Confirmation">
          <IpAddress>Destination IP Address</IpAddress>
          <Port>Destination Port Number</Port>
          <Tenant>Tenant Name</Tenant>
          <User>Account</User>
          <Password>Password</Password>
          <PrivilegedPassword>Administrator Password</PrivilegedPassword>
          <PasswordEncryption>Password Encryption</PasswordEncryption>
        </LoginInfo>
      </LoginInfos>
      <Monitoring method="Monitoring Method">
        <Interval>Monitoring Interval</Interval>
        <RetryCount>Retry Count</RetryCount>
        <Timeout>Timeout</Timeout>
      </Monitoring>
      <MgmtURL>Web Management Window URL</MgmtURL>
    </MgmtInfos>
    <Ports>
      <Port name="Port Name">
        <Description>Port Overview</Description>
        <PhysicalState>Communication Status</PhysicalState>
        <Link ip="Management IP address for Link Destination Device" port="Port Name of Link Destination" kind="Type of Link Destination Device" />
      </Port>
    </Ports>
  </Netdevice>
</Netdevices>
<Links>
  <Link>
    <Devices>
      <Device ip="Admin IP Address of Device 1" kind="Type of Device 1">
        <Port>Connection Port Name of Device 1</Port>
      </Device>
      <Device ip="Admin IP Address of Device 2" kind="Type of Device 2">
        <Port>Connection Port Name of Device 2</Port>
      </Device>
    </Devices>
  </Link>
</Links>
</NetConfig>

Table 2.11 List of Items Specified in XML Definitions for Network Configuration Information
Element Name	Description	Remarks (Possible Values, Examples)	Specification			Output Using Export
Element Name	Description	Remarks (Possible Values, Examples)	Individual Registration	Individual Modification	Batch Registration	Output Using Export
Network configuration information (NetConfig)	A collection of network configuration information	-	Not possible	Not possible	Required	Yes
Network Device Information (Netdevices)	A collection of network device information	Specify one or more Netdevice elements. When registering two or more network devices for resources simultaneously, this element cannot be omitted.	Not possible	Not possible	Optional	Yes (*1)
Registration Mode (Mode)	Registration mode (optional)	Specify the registration mode of the network device. Specify one of following items. add New registration Network device information is not overwritten when the specified management IP address has already been used to register another resource. modify Modification Network device information is overwritten when the specified management IP address has already been used to register another resource. If left blank, "add" is specified.	Not possible	Not possible	Optional	-
Admin IP address (Netdevice ip)	Admin IP address for the network device	Specify an IPv4 address.	Required	Optional	Required	Yes
Device name (Netdevice name)	Name of the network device (optional)	Specify a character string containing up to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). If left blank, the value the of standard MIB sysName obtained using SNMP is specified.	Optional	Optional	Optional	Yes
Location (Location)	Location (optional)	Specify a character string containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-"). If left blank, the value of the standard MIB sysLocation obtained using SNMP is specified.	Optional	Optional	Optional	Yes (*2)
Type information (Types)	A collection of type information (optional)	Specify one or more Type elements.	Optional	Optional	Optional	Yes (*1)
Type (Type)	Network device type (optional)	Specify the type of the network device. Specify one of following items. L2-Switch Firewall Network devices with "Firewall" specified are set as the registration targets for network pools. If left blank, "-" is specified.	Optional	Optional	Optional	Yes (*2)
Maintenance Mode (Maintenance)	Maintenance mode settings (optional)	Specify the status of maintenance mode. Specify one of following items. true Maintenance mode false Normal If left blank, "false" is specified.	Optional	Optional	Optional	Yes
Auto-configuration for the network device (AutoConfiguration)	Auto-configuration for the network device (optional)	Specify the status of auto-configuration for the network device. Specify one of following items. true Target of auto-configuration false Not the target of auto-configuration If left blank, "true" is specified.	Optional	Optional	Optional	-
Device information (DeviceInfo)	Device information	Information that is automatically collected by network device model definition and SNMP.	-	-	-	Yes
SysObjectId (SysObjectId)	SysObjectId	AN OID in number and period format is specified. Specification is unnecessary as it is automatically collected by SNMP.	-	-	-	Yes
Vendor Name (Vendor)	Vendor name	A character string is specified. Specification is unnecessary as it is set based on network device model definition.	-	-	-	Yes
Device name (ProductName)	Device name (product name)	A character string is specified. Specification is unnecessary as it is set based on network device model definition.	-	-	-	Yes
Model Name (ModeName)	Model name	A character string is specified. Specification is unnecessary as it is set based on network device model definition.	-	-	-	Yes
Firmware (Firmware)	Firmware or IOS version	A character string is specified. Specification is unnecessary as it is automatically collected by SNMP.	-	-	-	Yes
Group ID (Redundancy group_id)	Group ID (optional)	Specify a character string beginning with an alphanumeric character and containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-"). For the network devices belonging to the same group ID, use the same vendor name and device name.	Optional	Optional	Optional	Yes (*2)
Management information (MgmtInfos)	A collection of management information	Specify one or more Snmps elements, LoginInfo elements, or other similar elements.	Required	Optional	Required	Yes
SNMP information (Snmps)	A collection of SNMP information	Specify the ReadCommunity element once.	Required	Optional	Required	Yes
Community name (ReadCommunity)	Community name	Specify a character string containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-").	Required	Optional	Required	Yes
Login information (LoginInfos)	A collection of login information (optional)	Specify one or more LoginInfo elements.	Optional	Optional	Optional	Yes (*1)
Management method for authentication information (LoginInfo auth_type)	Management method for authentication information (optional)	Specify the management method for the authentication information. When the information is managed within a network device, specify "local password". If omitted, it will be automatically specified.	Optional	Optional	Optional	Yes (*3)
Administrator authority (LoginInfo authority)	Presence or absence of administrator authority (optional)	Specify the type of authority for the account. When the account has user authority, specify "user" If omitted, it will be automatically specified.	Optional	Optional	Optional	Yes (*3)
Account confirmation (LoginInfo check)	Presence or lack of account information checks (optional)	Specify whether to check the account information when the registration or modification is performed. Specify one of following items. true Checking is performed. (*4) false Checking is not performed. If left blank, "false" is specified.	Optional	Optional	Optional	-
Destination IP address (IpAddress)	Destination IP address (optional)	Specify the IP address in IPv4 format. Specify the IP address when configuring a destination IP address other than an admin IP address for automatic configuration on the network device. When "true" is specified for account checks, specify the IP address of the network device that performs connection checks using the specified account and password. If left blank, the admin IP address is specified.	Optional	Optional	Optional	Yes (*3)
Destination port number (Port)	Port number of the protocol to connect the destination (optional)	Specify an integer between 1 and 65535. When "true" is specified for account checks, specify the port number of the network device that performs connection checks using the specified account and password. Connection checks are performed using the telnet protocol. If left blank, "23" is set.	Optional	Optional	Optional	Yes (*3)
Tenant name (Tenant)	Tenant name (optional)	Specify a character string beginning with an alphanumeric character and containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-"). Specify the name of a tenant displayed in the orchestration tree that the resource belongs to. Only specify when "Firewall" is specified for the type (Type). Can be omitted when registering in the global pool.	Optional	Optional	Optional	Yes (*3)
Account (User)	User account for connection	Specify a character string containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-").	Required	Optional	Required	Yes (*3)
Password (Password)	Password for connection	Specify a character string containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-").	Required	Optional	Required	Yes (*3)
Administrator password (PrivilegedPassword)	Administrator password (optional)	Specify a character string containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-").	Optional	Optional	Optional	Yes (*3)
Password encryption (PasswordEncryption)	Presence or absence of password encryption (optional)	Specify whether the password of the network device is encrypted. Specify one of following items. true Encrypted false Not encrypted If left blank, "false" is specified. Specify "false" for initial registration as the password is entered in plain text at that time. To ensure security, when exporting the information in XML format, the password will be encrypted and "true" is set for this element. Specify "true" only when registering a network device using an encrypted password.	Optional	Optional	Optional	Yes (*3)
Monitoring Information (Monitoring)	Monitoring information (optional)	Specify the element of monitoring information.	Optional	Optional	Optional	Yes
Monitoring method (Monitoring method)	Monitoring method (optional)	Specify the monitoring method for the network device. Specify one of following items. 0: Not monitored 1: SNMP monitoring 2: ping monitoring 3: ping and SNMP monitoring If left blank, "1" is set.	Optional	Optional	Optional	Yes
Monitoring interval (Interval) (*5)	Monitoring interval (seconds) (This cannot be omitted when modifying the monitoring method)	Specify an integer between 1 and 600. If left blank, "300" is set.	Optional	Optional	Optional	Yes
Retry count (RetryCount) (*5)	Retry count (This cannot be omitted when modifying the monitoring method)	Specify an integer between 1 and 10. If left blank, "3" is set.	Optional	Optional	Optional	Yes
Timeout (Timeout) (*5)	Timeout (seconds) (This cannot be omitted when modifying the monitoring method)	Specify an integer between 1 and 300. If left blank, "30" is set.	Optional	Optional	Optional	Yes
Web management Window URL (MgmtURL)	Web management window URL (optional)	Specify the URL. If left blank, "http://Admin IP address/" is specified. This specification is valid only when using network devices for which Web management functions are provided.	Optional	Optional	Optional	Yes
Port information (Ports)	A collection of port information	One or more Port elements are specified.	-	-	-	Yes (*1)
Port name (Port name)	Port name	The value of the standard MIB ifName obtained using SNMP is specified. Specification is unnecessary as it is automatically collected by SNMP.	-	-	-	Yes
Port overview (description)	Overview of the port	The value of the standard MIB ifDescr obtained using SNMP is specified. Specification is unnecessary as it is automatically collected by SNMP.	-	-	-	Yes
Communication Status (PhysicalState)	Communication status	The value of line speed and communication mode obtained using SNMP are specified. Specification format:Line_speed (MB)/Communication_mode For the communication mode, one of the following is specified: F Represents full duplex. H Represents half duplex. - Represents unknown. Specification is unnecessary as it is automatically collected by SNMP.	-	-	-	Yes
Management IP address for link destination device (Link ip)	Management IP address for link destination	An IP address in IPv4 format is specified.	-	-	-	Yes (*2)
Port Name of Link Destination (Link port)	The name of the link destination port of a physical interface	The port name which is set for the standard MIB ifName of the network device is specified.	-	-	-	Yes (*2)
Type of Link Destination Device (Link kind)	Type of link destination device	The destination device to be linked to is specified. One of the following is specified: netdevice Represents a network device. server Represents a server.	-	-	-	Yes (*2)
Link information (Links) (*6)	Link information destination (optional)	This element consists of one or more Link elements. Link information specified with the Links element is registered after all of the currently registered link information is deleted. When modifying only device information, do not specify the Links element to avoid modifying the current link information. In order to delete all current link information, specify the following elements for the Links element: <Links><Link></Link></Links>	Not possible	Not possible	Optional	Yes (*1)
Link (Link)	Link definition (This cannot be omitted when specifying link information)	Specify the Devices element once.	Not possible	Not possible	Optional	Yes (*1)
Device information (Devices)	Definition of device information (This cannot be omitted when specifying links)	Specify the Device element twice.	Not possible	Not possible	Optional	Yes (*1)
Admin IP address for the device (Device ip)	Admin IP address for the device	Specify the IP address in IPv4 format.	Not possible	Not possible	Required	Yes
Device type (Device kind)	Device type (optional)	Specify the type of the device. Specify one of following items. netdevice Represents a network device. server Represents a server. If left blank, "netdevice" is specified.	Not possible	Not possible	Optional	Yes
Connection port name of device (Port)	Connection port name of device	Specify a character string. When device type is "netdevice" Specify the port name which is set for the standard MIB ifName (*7) of the network device. When device type is "server" Specify the L-Server NIC number. For physical L-Servers, specify the value for the NIC number of a rack mount server or a tower server. The NIC number is defined in preparations explained in "4.2.3.5 Pre-configuring Managed Servers" of the "Setup Guide CE". Example If "1" is defined for the NIC number placed on the upper left of the back face of a rack mount server, specify "1".	Not possible	Not possible	Required	Yes

-: Specification is unnecessary when registering or modifying. The information for the element is supplied by automatic configuration. The information is notified when the network configuration information is exported.
Yes: The element is output when exporting the network configuration information.
No: The element is not output when exporting the network configuration information.
*1: The element is output only when the tags are defined under that element.
*2: The element is output only when a value is set for that element.
*3: The element is output only when login information is set. When login information is not set, the default value (the value used when omitted) for that element is output if available.
*4: Accounts will be confirmed only for network devices satisfying the following conditions:

Vendor Name	Model Name	Prompt Type	Prompt Character
Fujitsu	SR-X IPCOM EX	Login prompt	Login:
		Password prompt	Password:
		Command prompt	Arbitrary_character_string#
		Command prompt	Arbitrary_character_string>
Cisco	Catalyst ASA	Login prompt	Username:
		Password prompt	Password:
		Command prompt	Arbitrary_character_string#
		Command prompt	Arbitrary_character_string>

The command prompt treats the arbitrary character string and the "#" or ">" that follows it as a prompt character string.

*5: Only specify the values when there are special requirements.
*6: It is not necessary to register network link information between Cisco ASA and adjacent network devices.
*7: When the standard MIB ifName for the network device is unknown, it can be confirmed using the snmpwalk command.

>snmpwalk -v 1 -c [SNMP community name] [IP address] ifName <RETURN>

Example

When creating one network device:

<?xml version="1.0" encoding="utf-8"?>
<Netdevice ip="192.168.5.11" name="Firewall01">
  <Location>B1F</Location>
  <Types>
    <Type>Firewall</Type>
  </Types>
  <Maintenance>false</Maintenance>
  <AutoConfiguration>true</AutoConfiguration>
  <Redundancy group_id="1"></Redundancy>
  <MgmtInfos>
    <Snmps>
      <ReadCommunity>public</ReadCommunity>
    </Snmps>
    <LoginInfos>
      <LoginInfo auth_type="local password" authority="admin" check="true">
        <Tenant>TenantA</Tenant>
        <User>user</User>
        <Password>password</Password>
        <PrivilegedPassword>root_password</PrivilegedPassword>
        <PasswordEncryption>false</PasswordEncryption>
      </LoginInfo>
    </LoginInfos>
    <Monitoring method="3">
      <Interval>300</Interval>
      <RetryCount>5</RetryCount>
      <Timeout>60</Timeout>
    </Monitoring>
    <MgmtURL>https://192.168.5.11</MgmtURL>
  </MgmtInfos>
</Netdevice>

When creating multiple network devices in one operation:

<?xml version="1.0" encoding="utf-8"?>
</NetConfig>
<Netdevices>
  <Mode>add</Mode>
  <Netdevice ip="192.168.5.11" name="Switch1">
    <Location>B1F</Location>
    <Types>
      <Type>L2-Switch</Type>
    </Types>
    <Maintenance>false</Maintenance>
    <AutoConfiguration>true</AutoConfiguration>
    <Redundancy group_id="1"></Redundancy>
    <MgmtInfos>
      <Snmps>
        <ReadCommunity>public</ReadCommunity>
      </Snmps>
      <LoginInfos>
        <LoginInfo auth_type="local password" authority="admin" check="true">
          <User>user</User>
          <Password>password</Password>
          <PrivilegedPassword>root_password</PrivilegedPassword>
          <PasswordEncryption>false</PasswordEncryption>
        </LoginInfo>
      </LoginInfos>
      <Monitoring method="3">
        <Interval>300</Interval>
        <RetryCount>5</RetryCount>
        <Timeout>60</Timeout>
      </Monitoring>
      <MgmtURL>https://192.168.5.11</MgmtURL>
    </MgmtInfos>
  </Netdevice>
  <Netdevice ip="192.168.5.10" name="Firewall1">
    <Location>B1F</Location>
    <Types>
      <Type>Firewall</Type>
    </Types>
    <Maintenance>false</Maintenance>
    <AutoConfiguration>true</AutoConfiguration>
    <Redundancy group_id="2"></Redundancy>
    <MgmtInfos>
      <Snmps>
        <ReadCommunity>public</ReadCommunity>
      </Snmps>
      <LoginInfos>
        <LoginInfo auth_type="local password" authority="admin" check="true">
          <Tenant>TenantA</Tenant>
          <User>user</User>
          <Password>password</Password>
          <PrivilegedPassword>root_password</PrivilegedPassword>
          <PasswordEncryption>false</PasswordEncryption>
        </LoginInfo>
      </LoginInfos>
      <Monitoring method="3">
        <Interval>300</Interval>
        <RetryCount>5</RetryCount>
        <Timeout>60</Timeout>
      </Monitoring>
      <MgmtURL>https://192.168.5.10:82</MgmtURL>
    </MgmtInfos>
  </Netdevice>
</Netdevices>
<Links>
  <Link>
    <Devices>
      <Device ip="192.168.1.1" kind="netdevice">
        <Port>lan0.1</Port>
      </Device>
      <Device ip="192.168.1.2" kind="netdevice">
        <Port>Fa2/1</Port>
      </Device>
    </Devices>
  </Link>
  <Link>
    <Devices>
      <Device ip="192.168.1.3" kind="netdevice">
        <Port>Fa2/2</Port>
      </Device>
      <Device ip="192.168.1.4" kind="server">
        <Port>1</Port>
      </Device>
    </Devices>
  </Link>
</Links>
</NetConfig>