Top
ServerView Resource Orchestrator Cloud Edition V3.1.1 Reference Guide (Command/XML)
ServerView
Part 1 Command Reference > Chapter 3 Resource Operations > 3.8 rcxadm netdevice
PreviousNext

3.8 rcxadm netdevice

Name

[Windows Manager]
Installation_folder\SVROR\Manager\bin\rcxadm netdevice - network device operations

[Linux Manager]
/opt/FJSVrcvmr/bin/rcxadm netdevice - network device operations


Format

rcxadm netdevice create -file file.xml [-nowait]
rcxadm netdevice delete -name name [-nowait]
rcxadm netdevice list
rcxadm netdevice modify -name name -file file.xml [-nowait]
rcxadm netdevice set -name name -attr {mode={active|maintenance}|auto_conf={true|false}} [-nowait]
rcxadm netdevice show -name name
rcxadm netdevice refresh -name name [-recreate] [-nowait]
rcxadm netdevice cfbackup -name name [-type type] [-comment comment] [-redundancy] [-nowait]
rcxadm netdevice cfmodify -name name [-type config] -number number -comment comment [-nowait]
rcxadm netdevice cfmodify -name name -type environment -comment comment [-nowait]
rcxadm netdevice cfrestore -name name [-type type] [-nowait]
rcxadm netdevice cflist -name name
rcxadm netdevice cfexport -name name [-type config] -number number [-dir dir]
rcxadm netdevice cfexport -name name -type environment [-dir dir]
rcxadm netdevice cfclearerr -name name
Description


rcxadm netdevice is the command used to operate network devices.

Subcommands


create
Creates a network device.
Information
  • If two or more pieces of network device information are defined in the network configuration information definition file, the resource creation process is terminated and device registration fails.
    When registering two or more network devices for resources in one operation, use the rcxadm netconfig command.
  • When the network devices to register are NS appliances, and if there are not enough NS option licenses registered in the ROR manager for the number of NS appliances to register, the message 62596 is output, and registration fails.
    Register the necessary number of NS option licenses with the ROR manager, and register the devices again.
delete
Deletes a network device.
list
Displays a list of network devices.
The following detailed information is displayed:
Table 3.18 Network Device Information
Item Name
Description
NAME
Network device name
IPADDRESS
Admin IP address for the network device
NETDEVICE_TYPES
Network device type
When there is more than one, they are displayed separated by commas.
For virtual appliances, the type is displayed with "(virtual)" added.
STATUS
Network device operation status
One of the following is displayed:
  • For normal status
    "normal" is displayed.
  • For error status
    "error" is displayed.
  • For warning status
    "Warning" is displayed.
  • For unknown status
    "unknown" is displayed.
MAINTENANCE
Maintenance mode setting status for the network device
One of the following is displayed:
  • When maintenance mode is set
    "ON" is displayed.
  • When maintenance mode is not set
    "OFF" is displayed.
modify
Modifies a network device.
set
For a network device, switch the maintenance mode setting or the auto-configuration target.
show
Displays the detailed information for a network device.
The following information is displayed:
Table 3.19 Detailed Information for Network Devices
Item Name
Description
Name
Network device name
SystemName
System name
IPAddress
Admin IP address
ProductName
Device name (product name)
ModelName
Model name
VendorName
Vendor name
Firmware
Firmware version
PresettingInfo
Details of pre-configuration of network devices
  • When creating an L-Platform including firewalls using the simple configuration mode, and performing pre-configuration as an available network device.
    "Simple" is displayed.
Location
The location of the device is displayed.
Status
Network device operation status
One of the following is displayed:
  • For normal status
    "normal" is displayed.
  • For error status
    "error" is displayed.
  • For warning status
    "Warning" is displayed.
  • For unknown status
    "unknown" is displayed.
StatusCause
If the operational status of the network device is one other than "normal"
One of the following is displayed:
  • When there is no response for ping
    "Ping unreachable" is displayed.
  • When there is no response for SNMP
    "SNMP unreachable" is displayed.
  • When automatic configuration failed
    "auto configuration failed" is displayed.
  • When an error is detected in a switch in the domain of the Ethernet Fabric
    "Domain status error" is displayed.
If the operational status is normal, "-" is displayed.
NetdeviceTypes
Network device type
When there is more than one, they are displayed separated by commas.
When the type is omitted, only the item name is displayed and the type is not displayed.
For virtual appliances, the type is displayed with "(virtual)" added.
Maintenance
Maintenance mode setting status for the network device
One of the following is displayed:
  • When maintenance mode is set
    "ON" is displayed.
  • When maintenance mode is not set
    "OFF" is displayed.
AutoConfiguration
Target status of automatic configuration
Displays whether the network device can be selected as the target of auto-configuration.
One of the following is displayed:
  • When the network device can be selected as a target of auto-configuration
    "true" is displayed.
  • When the network device cannot be selected as a target of auto-configuration
    "false" is displayed.
FabricId
Fabric ID
This is displayed only when the type of network device is "Fabric".
PortProfile
Use of the AMPP function during automatic configuration for an Ethernet fabric
One of the following is displayed:
  • When using the AMPP function
    "enable" is displayed.
  • When not using the AMPP function
    "disable" is displayed.
This is displayed only when the type of network device is "Fabric".
Redundancy
Group ID
Redundancy[GroupDevice]
Group device name
When there is more than one, they are displayed separated by commas.
Port[num]
Port name
In num, the index number of a port element is displayed. The number is an integer starting from "0".
Port[num][Link]
Port link status
One of the following is displayed:
  • For link-up status
    "up" is displayed.
  • For link-down status
    "down" is displayed.
  • For unknown status
    "unknown" is displayed.
In num, the index number of a port element is displayed. The number is an integer starting from "0".
Port[num][PhysicalState]
Port communication status
This is displayed in the format of line speed/communication mode. The unit of line speed is in Mbps.
For the communication mode, one of the following is displayed:
  • For full duplex line
    "F" is displayed.
  • For half duplex line
    "H" is displayed.
  • For unknown status
    A hyphen ("-") is displayed.
In num, the index number of a port element is displayed. The number is an integer starting from "0".
Port[num][Type]
Port type
For Ethernet fabric, one of the following is displayed:
  • For the port connected to a server
    "EP" is displayed.
  • For the port connected to another network device
    "CIR" is displayed.
In num, the index number of a port element is displayed. The number is an integer starting from "0".
This is displayed only when the type of network device is "Fabric".
Vlan[num]
VLAN ID
In num, the index number of a VLAN element is displayed. The number is an integer starting from "0".
Vlan[num][UntaggedPort]
Name of the port belonging to an Untagged port of VLAN ID
In num, the index number of a VLAN element is displayed. The number is an integer starting from "0".
When there is more than one, they are displayed separated by commas.
Vlan[num][TaggedPort]
Name of the port belonging to a Tagged port of VLAN ID
In num, the index number of a VLAN element is displayed. The number is an integer starting from "0".
When there is more than one, they are displayed separated by commas.
Link[num][NeighborResourceName]
Name of the resource linked to the port number [num]
In num, the index number of a port element is displayed. The number is an integer starting from "0".
Link[num][NeighborPort]
Name of the port of the resource linked to the port number [num]
In num, the index number of a port element is displayed. The number is an integer starting from "0".
AllocatedResources[Firewall]
Firewall name assigned by auto-configuration
When there is more than one, they are displayed separated by commas.
AllocatedResources[SLB]
Server load balancer name assigned by auto-configuration
When there is more than one, they are displayed separated by commas.
AllocatedResources[Network]
Network resource name assigned by auto-configuration
When there is more than one, they are displayed separated by commas.
LoginInfo[num][User]
User name of the account
In num, the index number of an account element is displayed. The number is an integer starting from "0".
LoginInfo[num][IPAddress]
Destination IP address of the account
In num, the index number of an account element is displayed. The number is an integer starting from "0".
LoginInfo[num][Port]
Destination port number of the account
In num, the index number of an account element is displayed. The number is an integer starting from "0".
LoginInfo[num][Protocol]
Protocol name used by the account
In num, the index number of an account element is displayed. The number is an integer starting from "0".
LoginInfo[num][Authority]
Account privileges
One of the following is displayed:
  • For administrator authority
    "administrator" is displayed.
  • For user authority
    "user" is displayed.
In num, the index number of an account element is displayed. The number is an integer starting from "0".
LoginInfo[num][Tenant]
Tenant name of the account
The tenant name is displayed only when the type is "Firewall" or "SLB" and the tenant name has been configured.
In other cases, the item name and tenant name are not displayed.
In num, the index number of an account element is displayed. The number is an integer starting from "0".
LoginInfo[num][AuthType]
Management method of account authentication information
One of the following is displayed:
  • When the information is managed within a network device
    "local password" is displayed.
  • When the information is managed within an external server
    "external server" is displayed.
In num, the index number of an account element is displayed. The number is an integer starting from "0".
LoginInfo[num][LoginCheck]
Check results of account availability
One of the following is displayed:
  • When the account can be used
    "Successful" is displayed.
  • When the account cannot be used
    "Failed" is displayed.
  • When the account has not been checked
    "Unchecked" is displayed.
In num, the index number of an account element is displayed. The number is an integer starting from "0".
Ruleset[num]
Ruleset name
In num, the index number of a ruleset element is displayed. The number is an integer starting from "0".
When the ruleset is omitted, the item name and ruleset name are not displayed.
Ruleset[num][Info]
Description of a ruleset
In num, the index number of a ruleset element is displayed. The number is an integer starting from "0".
When the ruleset is omitted, the item name and description of the ruleset are not displayed.
SnmpCommunityName
SNMP community name
FaultMonitoringMethod
Method of fault monitoring
One of the following is displayed:
  • When alive monitoring is performed using ping
    "ping" is displayed.
  • When the status is monitored using SNMP
    "SNMP" is displayed.
When there are multiple monitoring methods employed, they are displayed separated by commas.
FaultMonitoringInterval(s)
Fault monitoring interval (unit: seconds)
FaultMonitoringRetry
Fault monitoring retry count
FaultMonitoringTimeout(s)
Fault monitoring timeout (unit: seconds)
RestoreHistory[Env][RestoreFileDate]
Time when the network device environment file was backed up
If restoration has not been performed or the target file has been already deleted, "-" is displayed.
RestoreHistory[Env][RestoreExecDate]
Date when the network device environment file was backed up
If restoration has not been performed, "-" is displayed.
RestoreHistory[Config][GenerationNumber]
Generation number of the network device configuration file
If restoration has not been performed or the target file has been already deleted, "-" is displayed.
RestoreHistory[Config][RestoreFileDate]
Time when the restore network device configuration file to restore was backed up
If restoration has not been performed, "-" is displayed.
RestoreHistory[Config][RestoreExecDate]
Date when the network device configuration file was backed up
If restoration has not been performed, "-" is displayed.
VFAB[num][name]
VFAB name
This is displayed only when the type of network device is "Fabric".
In num, the VFAB index number is displayed. The number is an integer starting from "0".
VFAB[num][id]
VFAB ID
This is displayed only when the type of network device is "Fabric".
In num, the VFAB index number is displayed. The number is an integer starting from "0".
VFAB[num][mode]
VFAB operation mode
This is displayed only when the type of network device is "Fabric".
One of the following is displayed:
  • For host mode
    "host" is displayed.
  • For network mode
    "network" is displayed.
In num, the VFAB index number is displayed. The number is an integer starting from "0".
VFAB[num1][Tenant][num2]
Name of a tenant using VFAB
This is displayed only when the type of network device is "Fabric".
Default VFAB information is not displayed.
In num1, the VFAB index number is displayed. The number is an integer starting from "0".
In num2, the tenant index number is displayed. The number is an integer starting from "0".
refresh
Updates the configuration information of the network device.
cfbackup
Backs up network device files.
cfmodify
Modifies the comments displayed in COMMENT of the cflist command.
cfrestore
Restores network device files.
cflist
Displays the list of network device files which have already been backed up.
The following detailed information is displayed:
Table 3.20 Information of Device Configuration Files
Item Name
Description
NUMBER
Generation number of the network device configuration file
In the lines where backup failed, "-" is displayed (*).
In the bottom line, "env", which represents an environment file, is displayed.
BACKUPDATE
Date when the network device file was backed up
TRIGGER
Trigger for performing network device file backup
One of the following is displayed:
  • create
    When the network device was registered
  • command
    When the rcxadm netdevice cfbackup command was executed
  • auto
    When the network device was automatically configured
L-PLATFORM/NETWORK
The name of the L-Platform on which automatic configuration was performed
If the type is "L2-Switch", the name of the network resource is displayed.
This information is only displayed when TRIGGER is "auto".
TENANT
The name of the tenant of the L-Platform on which automatic configuration was performed
This information is only displayed when TRIGGER is "auto".
OPERATION
L-Platform operation
One of the following is displayed:
  • create
    Creating an L-Platform or a network resource
  • modify
    Modifying an L-Platform or a network resource
  • delete
    Deleting an L-Platform or a network resource
  • connect
    Creating an L-Server
  • disconnect
    Deleting an L-Server
  • recovery
    A recovery process
This information is only displayed when TRIGGER is "auto".
COMMENT
Specified comment
* Note: Error lines disappear at one of the following timings:
- When the next generation of the network device configuration file is deleted due to the maximum number of generations being exceeded
- When the rcxadm netdevice cfclearerr command is executed
cfexport
Exports network device files.
cfclearerr
Deletes the error history of backup operations of network device configuration files.

Options


-attr {mode={active|maintenance}|auto_conf={true|false}}
For a network device, switch the maintenance mode settings or the auto-configuration target.
-attr mode=active
Checks the status of the device. If the device is in the normal state, this option will change the operational status to "normal" and release maintenance mode.
If an error is detected during the status check of the device, failure to release maintenance mode is notified as the command execution result. In this case, it is necessary to take corrective action according to the message that is output, and perform release of maintenance mode again.
-attr mode=maintenance
Places into maintenance mode.
-attr auto_conf=true
Use this option to select the network device as a target of auto-configuration.
-attr auto_conf=false
Use this option not to select the network device as a target of auto-configuration.
-file file.xml
In file.xml, specify the XML file that defines the network resource for creation.
For details on the XML file definition, refer to "15.6.1 Creation".
-name name
In name, specify the name of a network device.
If an unregistered network device name is specified for name, an error will occur.
-nowait
Use this option to return directly to the command prompt without waiting for the operation of the network device specified in the subcommand to complete its execution.
-type type
In type, specify the file type.
config
Specify when network device configuration file operations are performed.
environment
Specify when network device environment file operations are performed.
When omitted, "config" is specified.
For the handling of the file names corresponding to each model, refer to "Table 10.9 Network Devices that are Supported by Device Configuration File Management" in "10.2.1 Mechanism of Backup and Restoration" in the "Operation Guide CE".
-redundancy
Specify when operating a network device of the same redundant configuration group as the one that the network device specified for name belongs to.
-number number
Specify the generation number when a network device configuration file is to be operated.
The generation number can be checked using the cflist subcommand.
-dir dir
Specify the directory to which the file specified for export will be output.
Network device configuration files are output in the following format.
Backup_date_and_time-Network_device_configuration_file_name
Example
20120921104043-running-config
If the file is an environment file, the file will be output using the filename of the target network device.
-comment comment
Specify the comment for the network device configuration file.
Specify a character string of up to 256 alphanumeric characters or symbols.
-recreate
Update the port information of the network device specified in name.
When the number of ports of the network device have increased or decreased due to deletion of L2 switches in the Ethernet fabric, modifying the Ethernet Fabric ID, the domain ID, the switch ID or the port type, it is necessary to specify this option to update the port information.

Examples


PreviousNext
Copyright 2010-2013 FUJITSU LIMITED