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" subnetmask="Admin LAN Subnet Mask" vlanid="Admin LAN VLAN ID" name="Device Name" portprofile="Use of the AMPP Function"> <Location>Location</Location> <Types> <Type>Type</Type> </Types> <FabricType>Fabric type</FabricType> <ApplianceType>Appliance type</ApplianceType> <Maintenance>Maintenance Mode</Maintenance> <AutoConfiguration>Auto-Configuration for Network Device</AutoConfiguration> <MaxDeployment>Number of deployable L-Platforms (total)</MaxDeployment> <ManagementHost>Management host IP address</ManagementHost> <Vfabs> <Mode>VFAB Registration Mode</Mode> <Vfab vfabid="VFAB ID" name="VFAB Name" mode="Operation Mode" vfabauto="Auto-Configuration of VFABs"> <Tenants> <Tenant>Tenant Name</Tenant> </Tenants> <Dot1adPorts> <Dot1adPort name="Sending and Receiving Port of the IEEE802.1ad Frame"></Dot1adPort> </Dot1adPorts> <CirPorts> <CirPort name="CIR port name or CIR Link Aggregation Port Identifier Information"></CirPort> </CirPorts> <EpPorts> <EpPort name="EP port name or EP Link Aggregation Port Identifier Information"></EpPort> </EpPorts> </Vfab> </Vfabs> <DeviceInfo> <SysObjectId>sysObjectID</SysObjectId> <Vendor>Vendor Name</Vendor> <ProductName>Device Name</ProductName> <ModelName>Model Name</ModelName> <Firmware>Firmware</Firmware> <PresettingInfo>Pre-configuration Information</PresettingInfo> </DeviceInfo> <Redundancy group_id="Group ID"></Redundancy> <MgmtInfos> <Snmps> <ReadCommunity>Community Name</ReadCommunity> </Snmps> <LoginInfos> <LoginInfo="Protocol" 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> <Methods> <Method>Monitoring method</Method> </Methods> <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" /> <Link ip="Management IP address for Link Destination Device" nic_index="Port Name of Link Destination (for display)" kind="server" /> <StagId>S-TAG ID</StagId> </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" subnetmask="Admin LAN Subnet Mask" vlanid="Admin LAN VLAN ID" name="Device Name" portprofile="Use of the AMPP Function"> <Location>Location</Location> <Types> <Type>Type</Type> </Types> <FabricType>Fabric type</FabricType> <ApplianceType>Appliance type</ApplianceType> <Maintenance>Maintenance Mode</Maintenance> <AutoConfiguration>Auto-Configuration for Network Device</AutoConfiguration> <MaxDeployment>Number of deployable L-Platforms (total)</MaxDeployment> <ManagementHost>Management host IP address</ManagementHost> <Vfabs> <Mode>VFAB Registration Mode</Mode> <Vfab vfabid="VFAB ID" name="VFAB Name" mode="Operation Mode" vfabauto="Auto-Configuration of VFABs"> <Tenants> <Tenant>Tenant Name</Tenant> </Tenants> <Dot1adPorts> <Dot1adPort name="Sending and Receiving Port of the IEEE802.1ad Frame"></Dot1adPort> </Dot1adPorts> <CirPorts> <CirPort name="CIR port name or CIR Link Aggregation Port Identifier Information"></CirPort> </CirPorts> <EpPorts> <EpPort name="EP port name or EP Link Aggregation Port Identifier Information"></EpPort> </EpPorts> </Vfab> </Vfabs> <DeviceInfo> <SysObjectId>sysObjectID</SysObjectId> <Vendor>Vendor Name</Vendor> <ProductName>Device Name</ProductName> <ModelName>Model Name</ModelName> <Firmware>Firmware</Firmware> <PresettingInfo>Pre-configuration Information</PresettingInfo> </DeviceInfo> <Redundancy group_id="Group ID"></Redundancy> <MgmtInfos> <Snmps> <ReadCommunity>Community Name</ReadCommunity> </Snmps> <LoginInfos> <LoginInfo="Protocol" 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> <Methods> <Method>Monitoring method</Method> </Methods> <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" /> <Link ip="Management IP address for Link Destination Device" nic_index="Port Name of Link Destination (for display)" kind="server" /> <StagId>S-TAG ID</StagId> </Port> </Ports> </Netdevice> </Netdevices> <Links> <Mode>Link Information Registration Mode</Mode> <Link> <Devices> <Device ip="Admin IP Address of Device 1" name="Resource Name of Device 1" kind="Type of Device 1"> <Port>Connection Port Name of Device 1</Port> <NicIndex>Connection Port Name of Device 1</NicIndex> </Device> <Device ip="Admin IP Address of Device 2" name="Resource Name of Device 2" kind="Type of Device 2"> <Port>Connection Port Name of Device 2</Port> <NicIndex>Connection Port Name of Device 2</NicIndex> </Device> </Devices> </Link> </Links> <FileServers> <Mode>External Server Registration Mode</Mode> <FileServer ip="IP Address"> <User>External Server Account</User> <Password>External Server Password</Password> <PasswordEncryption>Password Encryption of External Server</PasswordEncryption> </FileServer> </FileServers> </NetConfig> |
Element Name | Description | Remarks (Possible Values, Examples) | Specification | Output Using Export | |||
---|---|---|---|---|---|---|---|
Individual Registration | Individual Modification | Batch Registration | Batch Modification | ||||
Network configuration information (NetConfig) | A collection of network configuration information | - | Not possible | Not possible | Mandatory | Mandatory | 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 | Optional | Yes (*1) |
Registration mode (Mode) | Registration mode | Specify the registration mode of the network device. Specify either of the following options:
If left blank, "add" is specified. | Not possible | Not possible | Optional | Mandatory | No |
Admin IP Address (Netdevice ip) | Admin IP address for the network device | Specify an IPv4 address. | Mandatory | Optional | Mandatory | Mandatory | Yes |
Admin LAN subnet mask (Netdevice subnetmask) | Admin LAN subnet mask | Specify the subnet mask for the admin LAN in the IPv4 format. | Optional | Optional | Optional | Optional | Yes (*2) |
VLAN ID for admin LAN (Netdevice vlanid) | VLAN ID for admin LAN | Specify an integer between 1 and 4094. | Optional | Optional | Optional | Optional | Yes (*2) |
Device Name (Netdevice name) | Name of the network device | Specify a character string containing up to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). If left blank, the host name or IP address obtained from the network device is specified. If characters other than alphanumeric characters, underscores ("_"), hyphens ("-"), and periods (".") are used in the host name obtained from the network device, they will be replaced with underscores ("_"). However, when the obtained value is 33 characters or longer, only the first 32 characters will be specified. | Optional | Optional | Optional | Optional | Yes |
Use of the AMPP function (Netdevice portprofile) | Use of the AMPP function | Specify whether to use the AMPP function during automatic configuration for an Ethernet Fabric switch (Converged Fabric). Specify either of the following options:
If left blank, "enable" is specified. | Optional | Optional | Optional | Optional | Yes |
Location (Location) | Location | Specify a character string containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-"). If left blank, the location obtained from the network device is specified. For Ethernet Fabric, if left blank, the destination location of the representative virtual IP address of the fabric is specified. If characters other than alphanumeric characters, underscores ("_"), hyphens ("-"), and periods (".") are used in the location obtained from the network device, they will be replaced with underscores ("_"). However, when the obtained value is 33 characters or longer, only the first 32 characters will be specified. | Optional | Optional | Optional | Optional | Yes (*2) |
Type Information (Types) | A collection of type information | Specify one or more Type elements. | Optional | Optional | Optional | Optional | Yes (*1) |
Type (Type) | Network device type | Specify the type of the network device. Specify one of following items.
Network devices with "Firewall" or "SLB" specified are set as the registration targets for network pools. However, when "Fabric" or "ManagementHost" is specified, multiple entries of this element cannot be specified. | Optional | Optional | Optional | Optional | Yes (*2) |
Appliance type (ApplianceType) | Appliance type | Specify the type of the appliance. Specify either of the following options:
If left blank, "physical" is specified. | Optional | Not possible | Optional | Not possible | Yes (*2) |
Fabric type (FabricType) | Fabric type | Specify the fabric type. Specify either of the following options:
Specify when "Fabric" is specified for the Type (type). When omitted, "C-Fabric" is specified. | Optional | - | Optional | - | Yes |
Maintenance Mode (Maintenance) | Maintenance mode settings | Specify the status of maintenance mode. Specify either of the following options:
If left blank, "false" is specified. | Optional | - | Optional | - | Yes |
Auto-configuration for the network device (AutoConfiguration) | Auto-configuration for network devices | Specify whether the network device can be selected as a target of auto-configuration. Specify either of the following options:
For IPCOM VX, specify "false". If left blank, "true" is specified. When the operational status of the network device is "error", changing the value to "false" is not possible. | Optional | Optional | Optional | Optional | No |
The number of the L-Platforms which can be deployed (total) (MaxDeployment) | The number of the L-Platforms which can be deployed (total) | Specify the (total) number of L-Platforms that can be deployed. Specify one of following values.
If left blank, "5" is set. This can only be specified when "Simple" is specified for Pre-configuration details (PresettingInfo). | Optional | - | Optional | - | Yes |
Management host IP address (ManagementHost) | Management host IP address | When registering virtual appliances, specify an IPv4 address of the management host (the physical L-Server or physical server on which IPCOM VX). Specify the value only when registering a virtual appliance. | Optional | - | Optional | - | Yes |
VFAB information (Vfabs) | A collection of VFAB information | Specify one or more Vfab elements. Enabled when Type (Type) is "Fabric" and Fabric type is "C-Fabric". | Optional | Optional | Optional | Optional | Yes |
VFAB Registration Mode (Mode) | VFAB Registration Mode | Specify a VFAB registration mode. Specify one of following items.
When omitted, "replace" is specified. This is only valid when modifying a network device. | - | - | Optional | Optional | No |
VFAB (Vfab) | A single piece of VFAB information | None | Optional | Optional | Optional | Optional | Yes |
VFAB ID attributes (vfabid) | VFAB ID | Specify the VFAB ID configured for the Ethernet Fabric (Converged Fabric). Specify an integer between 1 - 3000, or "default". When specifying "default", the default VFAB is considered to have been specified. Specify this element not to overlap in a single Vfabs element. | Optional (*9) | Optional (*9) | Optional (*9) | Optional (*9) | Yes |
name attributes (name) | VFAB name | Specify a character string containing up to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). When using the default VFAB, only "defaultVFAB" can be specified. When omitted, "defaultVFAB" is specified for the default VFAB. For other cases, automatically generated values are specified. Specify this element not to overlap in a single Vfabs element. When the VFAB registration mode is "add" or "modify", ensure this element does not overlap, including registered VFAB name information. | Optional | Optional | Optional | Optional | Yes |
mode attribute (mode) | VFAB operation mode | Specify a VFAB operation mode. Specify either of the following options:
For VFAB to be connected with IPCOM VX, specify "network". When omitted, "network" is specified for the default VFAB. For other cases, "host" is specified. | Optional | Optional | Optional | Optional | Yes |
vfabauto attributes (vfabauto) | Auto-configuration of VFABs | Specify auto-configuration for VFABs specified in the vfabid attribute in the Vfab element. Specify either of the following options:
If left blank, "false" is specified. | Optional | Not possible | Optional | Not possible | Yes |
Tenant information (Tenants) | A collection of information of tenants using VFAB | Specify one or more Tenant elements. Specify this element for any VFAB other than the default VFAB. | Optional | Optional | Optional | Optional | Yes |
Tenant name (Tenant) | Name of a tenant using VFAB | 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. Specify this element not to overlap in a single Vfabs element. Tenants which are not specified in this element will use the default VFAB. | Optional | Optional | Optional | Optional | Yes |
Ports for sending and receiving of the IEEE802.1ad frame (Dot1adPorts) | Collection of ports for sending and receiving of the IEEE802.1ad frame used in VFABs | Specify one or more Dot1adPort elements. This element is valid when maintenance mode setting is "normal", and the vfabauto attribute is "true". | Optional | Optional | Optional | Optional | Yes |
Information of ports for sending and receiving of the IEEE802.1ad frame (Dot1adPort) | Information of ports for sending and receiving of the IEEE802.1ad frame used by a single VFAB | There is no information to specify. This element is valid when maintenance mode setting is "normal", and the vfabauto attribute is "true". | Optional | Optional | Optional | Optional | Yes |
name attributes (name) | The names of ports for sending and receiving of the IEEE802.1ad frame used by VFABs | Specify the port name (ifName) configured in Converged Fabric using a string of up to 64 characters. Alphanumeric characters and symbols (ASCII characters (0x20 to 0x7e) can be specified. However, the port name (ifName) of the member port of the link aggregation port cannot be specified. | Optional (*14) | Optional (*14) | Optional (*14) | Optional (*14) | Yes |
CIR ports (CirPorts) | Collection of CIR ports used for VFABs | Specify one or more CirPort elements. Specify this element in the following cases:
In other cases, this specification is not valid. | Optional (*15) | Optional (*15) | Optional (*15) | Optional (*15) | Yes |
CIR port information (CirPort) | Information of CIR ports used for a single VFAB | There is no information to specify. Specify this element in the following cases:
In other cases, this specification is not valid. | Optional (*15) | Optional (*15) | Optional (*15) | Optional (*15) | Yes |
name attributes (name) | CIR port names used for VFABs or link aggregation port identifier information | Specify a character string containing up to 64 alphanumeric characters and symbols (ASCII characters 0x20 to 0x7e).
| Optional (*15, *16) | Optional (*15, *16) | Optional (*15, *16) | Optional (*15, *16) | Yes |
EP Ports (EpPorts) | Collection of EP ports used for VFABs | One or more EpPort elements are specified. | - | - | - | - | Yes |
EP Port information (EpPort) | Information of EP ports used for a single VFAB | There is no information to specify. | - | - | - | - | Yes |
name attributes (name) | EP port names used for VFABs or link aggregation port identifier information | Specify a character string containing up to 64 alphanumeric characters and symbols (ASCII characters (0x20 to 0x7e)).
| - | - | - | - | Yes |
Device information (DeviceInfo) | Device information | Specify the information of the model of the network device. | Optional | - | Optional | - | Yes |
SysObjectId (SysObjectId) | SysObjectId | When monitoring using SNMP, SysObjectID collected automatically is specified as an OID in number and period format. | - | - | - | - | Yes |
Vendor Name (Vendor) | Vendor Name | Specify a character string beginning with an alphanumeric character and containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-"). Specify the same arbitrary name as used for the Vendor name of the folder (*7) where the rulesets for L-Platform templates and network resources (network device-specific) are registered. When omitted, the vendor name obtained from the Network Device Model Definitions is specified. | Optional | - | Optional | - | Yes |
Device name (ProductName) | Device name (product name) | Specify a character string beginning with an alphanumeric character and containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-"). Specify the same arbitrary name as used for the unit_name or model_name of the folder (*7) where the rulesets for L-Platform templates and network resources (network device-specific) are registered. When omitted, the unit name obtained from the Network Device Model Definitions is specified. For Converged_Fabric, "Converged_Fabric" is displayed. For VCS, when omitted, "VDX" is specified. | Optional | - | Optional | - | Yes |
Model Name (ModelName) | Model Name | Specify a character string beginning with an alphanumeric character and containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-"). Specify the same arbitrary name as used for the unit_name or model_name of the folder (*7) where the rulesets for L-Platform templates and network resources (network device-specific) are registered. When omitted, the model name obtained from the Network Device Model Definitions is specified. | Optional | - | Optional | - | Yes |
Firmware (Firmware) | Firmware or IOS version | A character string is specified. Specification is unnecessary as it is automatically collected from the network device. | - | - | - | - | Yes |
Pre-configuration details (PresettingInfo) | Pre-configuration details | Specify details of pre-configuration of network devices. | Optional | - | Optional | - | Yes |
Group ID (Redundancy group_id) | Group ID | 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 | Optional | Yes (*2) |
Management information (MgmtInfos) | A collection of management information | Specify one or more Snmps elements, LoginInfo elements, or other similar elements. | Mandatory | Optional | Mandatory | Optional | Yes |
SNMP Information (Snmps) | A collection of SNMP information | Specify the ReadCommunity element once. | Optional | Optional | Optional | Optional | Yes |
Community name (ReadCommunity) | Community name (This cannot be omitted when specifying SNMP information) | Specify a character string containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-"). | Optional (*10) | Optional | Optional (*10) | Optional | Yes |
Login Information (LoginInfos) | A collection of login information | Specify one or more LoginInfo elements. | Optional | Optional | Optional | Optional | Yes (*1) |
Protocol (LoginInfo protocol) | Protocol | Specify the protocol used when logging in using login information. Specify one of following items.
When omitted, "remote_login" is specified. Specify "ssh", when Type (Type) is "Fabric" and the Fabric type is "C-Fabric". | Optional | Optional | Optional | Optional | Yes |
Management method for authentication information (LoginInfo auth_type) | Management method for authentication information | 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 | Optional | Yes (*3) |
Administrator authority (LoginInfo authority) | Presence or absence of administrator authority | Specify the type of authority for the account. Specify either of the following options:
When omitted, "user" is specified. When "Fabric" is specified for the type (Type), specify "user". | Optional | Optional | Optional | Optional | Yes (*3) |
Account confirmation (LoginInfo check) | Presence or lack of account information checks | Specify whether to check the account information when the registration or modification is performed. Specify either of the following options:
If left blank, "false" is specified. | Optional | Optional | Optional | Optional | No |
Destination IP address (IpAddress) | Destination IP address | Specify the IP address in IPv4 format. Specify when performing checks of the auto-configuration settings for the network device and account information (when "true" is specified for the account check (LoginInfo check)) from an IP address other than the admin IP address (Netdevice ip). Specify the same IP address when there are multiple specifications of the same login information for the Tenant name (Tenant). When a different IP address is specified, or partially omitted, the auto-configuration settings for the network device and the account information of the connection IP address (IpAddress) in the login information with "user" specified in the administrator privileges (LoginInfo authority) are checked. If left blank, the admin IP address (Netdevice ip) is specified. | Optional | Optional | Optional | Optional | Yes (*3) |
Destination port number (Port) | Port number of the protocol to connect the destination | Specify an integer between 1 and 65535. Specify the port number of the network device to perform checking of auto-configuration settings and account information (when "true" is specified for the account check (Login Info check)). Specify the same port number when there are multiple specifications of the same login information for the Tenant name (Tenant). When a different port number is specified, or partially omitted, the auto-configuration settings for the network device and the account information of the port number in the login information with "user" specified in the administrator privileges (LoginInfo authority) are checked. If left blank, one of the following is specified based on the value specified for the protocol (LoginInfo protocol).
| Optional | Optional | Optional | Optional | Yes (*3) |
Tenant name (Tenant) | Tenant name | Specify a character string beginning with an alphanumeric character and containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-"). Can be omitted when registering in the global pool. Omit this item when the account (User) is used for management of network device files or when "Fabric" is specified for the type (Type). | Optional | Optional | Optional | Optional | Yes (*3) |
Account (User) | User account for connection | When "user" is specified for Administrator authority (LoginInfo authority), specify an account with user privileges. | Optional (*11) | Optional (*11) | Optional (*11) | Optional (*11) | Yes (*3) |
Password (Password) | Password for connection | Specify a character string of up to 64 alphanumeric characters and symbols (!$%()*+,-./:;=@[]^_`{|}~ and spaces). | Mandatory | Optional (*11) | Mandatory | Optional (*11) | Yes (*3) |
Administrator password (PrivilegedPassword) | Administrator password | Specify a character string of up to 64 alphanumeric characters and symbols (!$%()*+,-./:;=@[]^_`{|}~ and spaces). When "admin" is specified for Administrator authority (LoginInfo authority), the administrator password is regarded as invalid. | Optional | Optional | Optional | Optional | Yes (*3) |
Password encryption (PasswordEncryption) | Presence or absence of password encryption | Specify whether the password of the network device is encrypted. Specify either of the following options:
If left blank, "false" is specified. Specify "false" for initial registration as the password is entered in plain text at that time. | Optional | Optional | Optional | Optional | Yes (*3) |
Monitoring information (Monitoring) | Monitoring information | Specify the element of monitoring information. | Optional | Optional | Optional | Optional | Yes |
Monitoring method information (Methods) | Collection of monitoring method information | Specify the monitoring method by specifying one or more Method elements. When this element is omitted, one of the following will be specified.
| Optional | Optional | Optional | Optional | Yes |
Monitoring method (Method) | Monitoring method | Specify the monitoring method for the network device. Specify one of following items.
When omitted, "no monitoring" is specified for monitoring of the network device. When specifying multiple monitoring methods, specify multiple entries of this element. | Optional | 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 86400. If left blank, "300" is set. Specify "60" when "Simple" is specified for Pre-configuration details (PresettingInfo) and "Firewall" and "SLB" are specified for Type (Type). | Optional | 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 | 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 | Optional | Yes |
Web Management Window URL (MgmtURL) | Web management window URL | Specify the URL for the Web management window. This can be specified when the Web management functions of the corresponding network devices are provided. If left blank, "http://Admin IP address/" is specified. When "Fabric" is specified for the type (Type), the default value is not specified. | Optional | Optional | Optional | Optional | Yes |
Port information (Ports) | A collection of port information | One or more Port elements are specified. | Optional | Optional | Optional | Optional | Yes (*1) |
Port name (Port name) (*18) | Port name | Specify the port name configured in the network device using a string of up to 64 characters. Alphanumeric characters and symbols (ASCII characters (0x20 to 0x7e) can be specified. Specify this when specifying a StagId element or when both SNMP monitoring and NETCONF monitoring are disabled. If left blank, the value for the port name obtained from the network device is specified. For the procedure to confirm port names, refer to "9.4.8.1 When Creating Network Configuration Information (XML Definition)" in the "Design Guide CE". | Optional (*19) | Optional (*19) | Optional (*19) | Optional (*19) | Yes |
Overview of the port (description) | Overview of the port | The overview of the port (description) is specified. Specification is unnecessary as it is automatically collected from the network device. | - | - | - | - | Yes |
Communication status (PhysicalState) | Communication status | The value of line speed and the communication mode are specified. Specification format:Line_speed (bps)/Communication_mode For the communication mode, one of the following is specified:
Specification is unnecessary as it is automatically collected from the network device. | - | - | - | - | 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 name of the destination port to be linked to is specified. | - | - | - | - | Yes (*2) |
Port Name of Link Destination (for display) (Link nic_index) | The NIC index of the link destination port of a physical interface | When the Type of Link Destination Device is "server" and Connection Port Name of Device (NicIndex) is specified during link information registration, the index number of the NIC 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:
| - | - | - | - | Yes (*2) |
S-TAG ID (StagId) | S-TAG value | Specify the S-TAG ID specified in the virtual machine interface of IPCOM VX. Specify an integer between 1 and 4094. When omitted, the values obtained from the MIB (isfexVmInterfaceTable) specific to the IPCOM VX are configured. Specify the values only when using IPCOM VA. (*20) | Optional | Optional | Optional | Optional | Yes |
Link information (Links) (*6) | Link information destination | This element consists of one or more Link elements. <Links><Link></Link></Links> | Not possible | Not possible | Optional | Optional | Yes (*1) |
Link information registration mode (Mode) | Link information registration mode | Specify the registration mode of the link information. Specify either of the following options:
If left blank, "modify" is specified. | Not possible | Not possible | Optional | Optional | No |
Link (Link) | Link definition (This cannot be omitted when specifying link information) | Specify the Devices element once. | Not possible | Not possible | Optional | 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 | 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 | Optional (*12) | Optional (*12) | Yes |
Device name (Device name) | Device name (Specification is not necessary) | The network device name registered from the admin IP address for devices is specified. When using devices other than network devices, the device name that is the connection destination set by auto-configuration functions is supplemented. | - | - | - | - | Yes |
Device type (Device kind) | Device type | Specify the type of the device. Specify one of following items.
If left blank, "netdevice" is specified. | Not possible | Not possible | Optional | Optional | Yes |
Connection port name of device (Port) | Connection port name of device | Specify a character string.
| Not possible | Not possible | Optional (*12) | Optional (*12) | Yes |
Connection port name of device (for display (NicIndex) | Connection port name of device (for display | Specify an integer. When the device type is "server" and you want to display the link information on the [Resource Details] tab of the ROR console and NetworkViewer, specify the index of the physical NIC displayed in the resource details of the corresponding physical server. If an index that is not registered is specified, an error will occur. | Not possible | Not possible | Optional (*12) | Optional (*12) | Yes |
External server information (FileServers) | Definition of the external server | Specify the element for the external server. In order to delete registered external server information, specify the following elements for the FileServers element: <FileServers><FileServer></FileServer></FileServers> | Not possible | Not possible | Optional | Optional | Yes |
External server registration mode (Mode) | External server registration mode | Specify the registration mode of the external server. Specify either of the following options:
If left blank, "modify" is specified. | Not possible | Not possible | Optional | Optional | No |
External server IP address (FileServer ip) | External server IP address (This cannot be omitted when specifying external server information) | Specify the IP address of the external server in IPv4 format. | Not possible | Not possible | Optional (*13) | Optional | Yes |
External server account (User) | External server account (This cannot be omitted when specifying external server information) | Specify a character string containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-"). | Not possible | Not possible | Optional (*13) | Optional | Yes |
External server password (Password) | Account password for the external server (This cannot be omitted when specifying external server information) | Specify a character string containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-"). | Not possible | Not possible | Optional (*13) | Optional | Yes |
Password encryption of external server (PasswordEncryption) | Presence or absence of password encryption of the external server | Specify whether the password of the external server is encrypted. Specify either of the following options:
If left blank, "false" is specified. Specify "false" for initial registration as the password is entered in plain text at that time. | Not possible | Not possible | Optional | Optional | Yes |
-: Specification is unnecessary when registering or modifying. The information for the element is supplied by automatic configuration. The user is notified of the information 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 elements are defined under that element.
*2: The element is output only when values are specified 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: Account information for network device models satisfying all of the following conditions can be confirmed.
Vendor Name | Model Name | Prompt Type | Prompt Character |
---|---|---|---|
Fujitsu | SR-X | Login prompt | Login: |
Password prompt | Password: | ||
Command prompt | Arbitrary_character_string# | ||
Arbitrary_character_string> | |||
IPCOM EX | Login prompt | login: | |
Password prompt | Password: | ||
Command prompt | Arbitrary_character_string# | ||
Arbitrary_character_string> | |||
Cisco | Catalyst | Login prompt | Username: |
Password prompt | Password: | ||
Command prompt | Arbitrary_character_string# | ||
Arbitrary_character_string> | |||
Nexus | Login prompt | login: | |
Password prompt | Password: | ||
Command prompt | Arbitrary_character_string# | ||
Arbitrary_character_string> | |||
Brocade Extreme Networks | VDX | Login prompt | Login: |
Password prompt | Password: | ||
Command prompt | Arbitrary_character_string# | ||
Arbitrary_character_string> | |||
F5 Networks | BIG-IP | Login prompt | There are no particular restrictions. |
The command prompt treats the arbitrary character string and the "#" or ">" that follows it as a prompt character string.
The model name of the BIG-IP LTM series is treated as being "BIG-IP".
*: Fujitsu PRIMERGY Converged Fabric Switch Blade (10Gbps 18/8+2) or Fujitsu Converged Fabric Switch
*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: For details on the folder for registration of the rulesets for L-Platform templates and network resources (network device-specific), refer to "F.3 Creating a Folder for Registering Rulesets" in the "Design Guide CE".
*8: Required when Type (Type) is "Fabric" and Fabric type is "C-Fabric".
*9: Required when VFAB (Vfab) is specified.
*10: Required when specifying "SNMP" for the monitoring method (Method).
*11: Required when specifying the login information (LoginInfos).
*12: Required when specifying the device information (Devices). However, when the device type is "server", either one or both of the Connection Port Name of Device (Port) and the Connection Port Name of Device (for display) (NicIndex) must be specified.
*13: Required when specifying the external server information (FileServers).
*14: Required when specifying the information of ports for sending and receiving of the IEEE802.1ad frame (Dot1adPort) under VFAB (Vfab).
*15: Required when "host" is specified for the VFAB operation mode (mode attribute) under VFAB (Vfab).
*16: Required when specifying the CIR port information (CirPort) under VFAB (Vfab).
*17: Indicates linkaggregationDomain ID to which the Link Aggregation Port Belongs_Link Aggregation Group Number (Last Number of ifDescr).
*18: When specifying "Fabric" for type (Type) and "C-Fabric" for Fabric type, port information cannot be registered using this definition.
*19: Required when specifying port information (Ports).
*20: For the settings specific to the IPCOM VA series, refer to "9.4.8.1 When Creating Network Configuration Information (XML Definition)" in the "Design Guide CE".
*21: Output when Type (Type) is "Fabric" and Fabric type is "C-Fabric".
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 protocol="telnet" 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> <Methods> <Method>ping</Method> <Method>SNMP</Method> </Methods> <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 protocol="telnet" auth_type="local password" authority="admin" check="true"> <User>user</User> <Password>password</Password> <PrivilegedPassword>root_password</PrivilegedPassword> <PasswordEncryption>false</PasswordEncryption> </LoginInfo> </LoginInfos> <Monitoring> <Methods> <Method>ping</Method> <Method>SNMP</Method> </Methods> <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 protocol="telnet" 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> <Methods> <Method>ping</Method> <Method>SNMP</Method> </Methods> <Interval>300</Interval> <RetryCount>5</RetryCount> <Timeout>60</Timeout> </Monitoring> <MgmtURL>https://192.168.5.10:82</MgmtURL> </MgmtInfos> </Netdevice> <Netdevice ip="192.168.5.20" name="SLB1"> <Location>B1F</Location> <Types> <Type>SLB</Type> </Types> <Maintenance>false</Maintenance> <AutoConfiguration>true</AutoConfiguration> <Redundancy group_id="3"></Redundancy> <MgmtInfos> <Snmps> <ReadCommunity>public</ReadCommunity> </Snmps> <LoginInfos> <LoginInfo protocol="telnet" 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> <Methods> <Method>ping</Method> <Method>SNMP</Method> </Methods> <Interval>300</Interval> <RetryCount>5</RetryCount> <Timeout>60</Timeout> </Monitoring> <MgmtURL>https://192.168.5.20:82</MgmtURL> </MgmtInfos> </Netdevice> <Netdevice ip="192.168.5.30" name="IPCOMEXIN1"> <Location>B1F</Location> <Types> <Type>Firewall</Type> <Type>SLB</Type> </Types> <Maintenance>false</Maintenance> <AutoConfiguration>true</AutoConfiguration> <Redundancy group_id="4"></Redundancy> <MgmtInfos> <Snmps> <ReadCommunity>public</ReadCommunity> </Snmps> <LoginInfos> <LoginInfo protocol="telnet" 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> <Methods> <Method>ping</Method> <Method>SNMP</Method> </Methods> <Interval>300</Interval> <RetryCount>5</RetryCount> <Timeout>60</Timeout> </Monitoring> <MgmtURL>https://192.168.5.30: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> <FileServers> <Mode>add</Mode> <FileServer ip="192.168.5.20"> <User>user</User> <Password>password</Password> </FileServer> </FileServers> </NetConfig> |
When creating Ethernet Fabric (Converged Fabric), IPCOM VX, and IPCOM VA network devices:
<?xml version="1.0" encoding="utf-8"?> <NetConfig> <Netdevices> <Netdevice ip="172.16.3.3" name="cfab1" portprofile="enable"> <Types> <Type>Fabric</Type> </Types> <FabricType>C-Fabric</FabricType> <ApplianceType>physical</ApplianceType> <Maintenance>false</Maintenance> <AutoConfiguration>true</AutoConfiguration> <Vfabs> <Vfab vfabid="10" name="VFAB-1-1" mode="network"></Vfab> <Vfab vfabid="20" name="VFAB-1-2" mode="network"></Vfab> </Vfabs> <MgmtInfos> <Snmps> <ReadCommunity>public</ReadCommunity> </Snmps> <LoginInfos> <LoginInfo protocol="ssh" auth_type="local password" authority="user" check="true"> <User>user</User> <Password>password</Password> <PrivilegedPassword>root_password</PrivilegedPassword> <PasswordEncryption>false</PasswordEncryption> </LoginInfo> </LoginInfos> <Monitoring> <Methods> <Method>ping</Method> <Method>SNMP</Method> </Methods> <Interval>300</Interval> <RetryCount>3</RetryCount> <Timeout>30</Timeout> </Monitoring> </MgmtInfos> </Netdevice> <Netdevice ip="172.16.1.52" name="ipcomvx1"> <Types> <Type>ManagementHost</Type> </Types> <ApplianceType>physical</ApplianceType> <Maintenance>false</Maintenance> <AutoConfiguration>false</AutoConfiguration> <MgmtInfos> <Snmps> <ReadCommunity>public</ReadCommunity> </Snmps> <LoginInfos> <LoginInfo protocol="telnet" auth_type="local password" authority="user" check="true"> <User>user</User> <Password>password</Password> <PrivilegedPassword>root_password</PrivilegedPassword> <PasswordEncryption>false</PasswordEncryption> </LoginInfo> </LoginInfos> <Monitoring> <Methods> <Method>SNMP</Method> </Methods> <Interval>300</Interval> <RetryCount>3</RetryCount> <Timeout>30</Timeout> </Monitoring> <MgmtURL>http://172.16.1.52</MgmtURL> </MgmtInfos> </Netdevice> <Netdevice ip="172.16.1.53" name="ipcomva11"> <Types> <Type>Firewall</Type> </Types> <ApplianceType>virtual</ApplianceType> <Maintenance>false</Maintenance> <AutoConfiguration>true</AutoConfiguration> <ManagementHost>172.16.1.52</ManagementHost> <Redundancy group_id="va1"></Redundancy> <MgmtInfos> <Snmps> <ReadCommunity>public</ReadCommunity> </Snmps> <LoginInfos> <LoginInfo protocol="telnet" auth_type="local password" authority="user" check="true"> <User>user</User> <Password>password</Password> <PrivilegedPassword>root_password</PrivilegedPassword> <PasswordEncryption>false</PasswordEncryption> </LoginInfo> </LoginInfos> <Monitoring> <Methods> <Method>SNMP</Method> </Methods> <Interval>300</Interval> <RetryCount>3</RetryCount> <Timeout>30</Timeout> </Monitoring> <MgmtURL>http://172.16.1.53</MgmtURL> </MgmtInfos> <Ports> <Port name="LAN0.0"> <StagId>110</StagId> </Port> <Port name="LAN0.1"> <StagId>110</StagId> </Port> <Port name="LAN0.2"> <StagId>110</StagId> </Port> <Port name="LAN0.3"> <StagId>100</StagId> </Port> </Ports> </Netdevice> <Netdevice ip="172.16.1.54" name="ipcomva12"> <Types> <Type>Firewall</Type> </Types> <ApplianceType>virtual</ApplianceType> <Maintenance>false</Maintenance> <AutoConfiguration>true</AutoConfiguration> <ManagementHost>172.16.1.52</ManagementHost> <Redundancy group_id="va2"></Redundancy> <MgmtInfos> <Snmps> <ReadCommunity>public</ReadCommunity> </Snmps> <LoginInfos> <LoginInfo protocol="telnet" auth_type="local password" authority="user" check="true"> <User>user</User> <Password>password</Password> <PrivilegedPassword>root_password</PrivilegedPassword> <PasswordEncryption>false</PasswordEncryption> </LoginInfo> </LoginInfos> <Monitoring> <Methods> <Method>SNMP</Method> </Methods> <Interval>300</Interval> <RetryCount>3</RetryCount> <Timeout>30</Timeout> </Monitoring> <MgmtURL>http://172.16.1.54</MgmtURL> </MgmtInfos> <Ports> <Port name="LAN0.0"> <StagId>120</StagId> </Port> <Port name="LAN0.1"> <StagId>120</StagId> </Port> <Port name="LAN0.2"> <StagId>120</StagId> </Port> <Port name="LAN0.3"> <StagId>100</StagId> </Port> </Ports> </Netdevice> </Netdevices> <Links> <Link> <Devices> <Device ip="172.16.1.52" kind="netdevice" name="ipcomvx1"> <Port>LAN0.0</Port> </Device> <Device ip="172.16.3.3" kind="netdevice" name="cfab1"> <Port>3/1/0/11</Port> </Device> </Devices> </Link> <Link> <Devices> <Device ip="172.16.1.52" kind="netdevice" name="ipcomvx1"> <Port>LAN0.1</Port> </Device> <Device ip="172.16.3.3" kind="netdevice" name="cfab1"> <Port>3/1/0/12</Port> </Device> </Devices> </Link> <Link> <Devices> <Device ip="172.16.1.52" kind="netdevice" name="ipcomvx1"> <Port>LAN0.2</Port> </Device> <Device ip="172.16.3.3" kind="netdevice" name="cfab1"> <Port>3/1/0/13</Port> </Device> </Devices> </Link> <Link> <Devices> <Device ip="172.16.1.52" kind="netdevice" name="ipcomvx1"> <Port>LAN0.3</Port> </Device> <Device ip="172.16.3.3" kind="netdevice" name="cfab1"> <Port>3/1/0/14</Port> </Device> </Devices> </Link> <Link> <Devices> <Device ip="172.16.1.52" kind="netdevice" name="ipcomvx1"> <Port>LAN1.0</Port> </Device> <Device ip="172.16.3.3" kind="netdevice" name="cfab1"> <Port>3/1/0/15</Port> </Device> </Devices> </Link> <Link> <Devices> <Device ip="172.16.1.53" kind="virtual" name="ipcomva11"> <Port>LAN0.0</Port> </Device> <Device ip="172.16.1.52" kind="netdevice" name="ipcomvx1"> <Port>LAN0.0</Port> </Device> </Devices> </Link> <Link> <Devices> <Device ip="172.16.1.53" kind="virtual" name="ipcomva11"> <Port>LAN0.1</Port> </Device> <Device ip="172.16.1.52" kind="netdevice" name="ipcomvx1"> <Port>LAN0.1</Port> </Device> </Devices> </Link> <Link> <Devices> <Device ip="172.16.1.53" kind="virtual" name="ipcomva11"> <Port>LAN0.2</Port> </Device> <Device ip="172.16.1.52" kind="netdevice" name="ipcomvx1"> <Port>LAN0.2</Port> </Device> </Devices> </Link> <Link> <Devices> <Device ip="172.16.1.53" kind="virtual" name="ipcomva11"> <Port>LAN0.3</Port> </Device> <Device ip="172.16.1.52" kind="netdevice" name="ipcomvx1"> <Port>LAN0.3</Port> </Device> </Devices> </Link> <Link> <Devices> <Device ip="172.16.1.54" kind="virtual" name="ipcomva12"> <Port>LAN0.0</Port> </Device> <Device ip="172.16.1.52" kind="netdevice" name="ipcomvx1"> <Port>LAN0.0</Port> </Device> </Devices> </Link> <Link> <Devices> <Device ip="172.16.1.54" kind="virtual" name="ipcomva12"> <Port>LAN0.1</Port> </Device> <Device ip="172.16.1.52" kind="netdevice" name="ipcomvx1"> <Port>LAN0.1</Port> </Device> </Devices> </Link> <Link> <Devices> <Device ip="172.16.1.54" kind="virtual" name="ipcomva12"> <Port>LAN0.2</Port> </Device> <Device ip="172.16.1.52" kind="netdevice" name="ipcomvx1"> <Port>LAN0.2</Port> </Device> </Devices> </Link> <Link> <Devices> <Device ip="172.16.1.54" kind="virtual" name="ipcomva12"> <Port>LAN0.3</Port> </Device> <Device ip="172.16.1.52" kind="netdevice" name="ipcomvx1"> <Port>LAN0.3</Port> </Device> </Devices> </Link> </Links> </NetConfig> |
When creating a single VCS:
<?xml version="1.0" encoding="utf-8"?> <Netdevice ip="192.168.5.11" name="VCS"> <Location>B1F</Location> <Types> <Type>Fabric</Type> </Types> <FabricType>VCS</FabricType> <Maintenance>false</Maintenance> <MgmtInfos> <LoginInfos> <LoginInfo protocol="netconf" check="true"> <User>admin</User> <Password>password</Password> </LoginInfo> </LoginInfos> <Monitoring> <Methods> <Method>NETCONF</Method> </Methods> <Interval>300</Interval> <RetryCount>5</RetryCount> <Timeout>60</Timeout> </Monitoring> </MgmtInfos> </Netdevice> |