Top
ServerView Resource Orchestrator Cloud Edition V3.3.0 Automatic Quarantining FunctionUser's Guide
FUJITSU Software

A.6 Network Configuration Information XML File

The XML definition for network configuration information is shown below.

Table A.3 List of Items Specified in XML Definitions for Network Configuration Information (Excerpt)

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:

  • 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

Mandatory

No

Admin IP Address

(Netdevice ip)

Admin IP address for the network device

Specify an IPv4 address.

Mandatory

Optional

Mandatory

Mandatory

Yes

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

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.

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 the following.

  • L2-Switch

When omitted, the type obtained from the Network Device Model Definitions is specified.

Optional

Optional

Optional

Optional

Yes (*2)

Maintenance Mode

(Maintenance)

Maintenance mode settings

Specify the status of maintenance mode.

Specify either of the following options:

  • true

    Maintenance Mode

  • false

    Normal

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:

  • true

    Target of auto-configuration

  • false

    Not the target of auto-configuration

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

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 where the rulesets for 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 where the rulesets for network resources (network device-specific) are registered.

When omitted, the unit name obtained from the Network Device Model Definitions 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 where the rulesets for 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

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.

  • remote_login

    Specify when using Telnet or SSH login information.
    If login via Telnet is possible, use Telnet. If login via Telnet is not possible, use SSH.

  • telnet

    Specify when using Telnet login information.

  • ssh

    Specify when using SSH login information.

When omitted, "remote_login" is specified.

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:

  • user

    Specify when it is possible to connect to the target network device using an account with user privileges (the account specified for "Account (User)") and then switch to administrator privileges to modify definitions.

  • admin

    Specify only when it is possible to change the definition for the device to register using an account with administrator privileges (the account specified for "Account (User)").

When omitted, "user" is specified.

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:

  • true

    Checking is performed. (*4)

  • false

    Checking is not performed.

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).

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)).

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).

  • 23 or 22

    For "remote_login"
    The default value (23 or 22) for the protocol (Telnet or SSH) that was successful when checking the account information is specified.
    However, when not performing a check of the account information (when "false" is specified for the account check (LoginInfo check)), the default value for Telnet (23) is specified.

  • 21

    For "ftp"

  • 23

    For "telnet"

  • 22

    For "ssh"

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.
When "admin" is specified for Administrator authority (LoginInfo authority), specify an account with administrator privileges.
For the account, specify a character string containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-").

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:

  • 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.
When exporting the information, the password will be encrypted and "true" is set for this element to ensure security.
Specify "true" only when registering an external server using an encrypted password.

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, the following will be specified.

  • SNMP

Optional

Optional

Optional

Optional

Yes

Monitoring method

(Method)

Monitoring method

Specify the monitoring method for the network device.

Specify one of following items.

  • ping

    When using ping monitoring

  • SNMP

    When using SNMP monitoring

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.

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.

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)

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.

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:

  • F

    Represents full duplex.

  • H

    Represents half duplex.

  • -

    Represents unknown.

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)

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)

Link information destination

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

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:

  • add

    New registration

    When the information is the same as that of an already registered link, the link information will not be overwritten.

  • modify

    Modification

    After deleting all already registered link information, register the new link information.

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.

  • netdevice

    Represents a network device.

  • server

    Represents a server.

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.

  • When device type is "netdevice"

    Specify the port name of the network device.

    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".

  • When device type is "server"

    Specify the server NIC number.

    Specify the NIC number of a rack mount server or a tower server. The NIC number is defined in the preparations explained in "9.3.5 Pre-configuring Managed Servers" in the "Design 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

Optional (*12)

Optional (*12)

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>

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

VDX

Login prompt

Login:

Password prompt

Password:

Command prompt

Arbitrary_character_string#

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.
*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).
*19: Required when specifying port information (Ports).