Top
ServerView Resource Orchestrator Cloud Edition V3.3.0 Automatic Quarantining FunctionUser's Guide
FUJITSU Software
Chapter 4 Reference > 4.5 rcxadm netdevice
PreviousNext

4.5 rcxadm netdevice

Name

[Windows Manager]
Installation_folder\SVROR\Manager\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 [-with_va]|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.

delete

Deletes a network device.

list

Displays a list of network devices.

The following detailed information is displayed:

Table 4.6 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.

STATUS

Network device operation status

Displays one of the following:

  • 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

Displays either of the following:

  • 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 4.7 Detailed Information for Network Devices (Excerpt)

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

Location

The location of the device is displayed.

Status

Network device operation status

Displays one of the following:

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

Displays one of the following:

  • When there is no response for ping

    "Ping unreachable" is displayed.

  • When there is no response for SNMP

    "SNMP unreachable" is displayed.

  • When there is no response for NETCONF

    "NETCONF unreachable" is displayed.

  • When automatic configuration failed

    "auto configuration failed" 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.

Maintenance

Maintenance mode setting status for the network device

Displays either of the following:

  • When maintenance mode is set

    "ON" is displayed.

  • When maintenance mode is not set

    "OFF" is displayed.

FabricId

Fabric ID

This is only displayed when the network device type is "Fabric" and the fabric type is "C-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

Displays one of the following:

  • 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 lines

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

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.
Some VLANs which have been configured with an AMPP function for VCS fabrics may not be displayed.

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

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

Displays either of the following:

  • 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

Displays either of the following:

  • 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

Displays one of the following:

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

SnmpCommunityName

SNMP community name

FaultMonitoringMethod

Method of fault monitoring

Displays one of the following:

  • When alive monitoring is performed using ping

    "ping" is displayed.

  • When the status is monitored using SNMP

    "SNMP" is displayed.

  • When the status is monitored using NETCONF

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

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 that have already been backed up.

The following detailed information is displayed:

Table 4.8 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

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

One of the following is displayed:

  • create

    Creating a network resource

  • modify

    Modifying a network resource

  • delete

    Deleting 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 [-with_va]|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 "A.6 Network Configuration Information XML File".

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


Examples

PreviousNext
Copyright 2017-2018 FUJITSU LIMITED