1.3.6 rcxadm netdevice

Name

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

[Linux]
/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

Description

rcxadm netdevice is the command used to operate network devices.

Subcommands

create: Creates a network device.
Note
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 1.13 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 One of the following is displayed: For normal status "normal" is displayed. For error status "error" 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 1.14 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
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 unknown status "unknown" 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 One of the following is displayed: When maintenance mode is set "ON" is displayed. When maintenance mode is not set "OFF" is displayed.
AutoConfiguration	Selection target status during auto-configuration The status of 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. After the registration, the content ("true" or "false") specified for "auto-configuration for the network device (the AutoConfiguration element)" is displayed. If auto configuration for a network device for which "true" has been set when registering the network device fails, the network device will be excluded from the auto-configuration target and the display will change to "false".
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".
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[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" 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 or not is monitored 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)

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: Release maintenance mode.

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

-name name: In name, specify the name of a network device.

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

Examples

To display a list of network device information:

>rcxadm netdevice list <RETURN>
NAME                           IPADDRESS        NETDEVICE_TYPES        STATUS   MAINTENANCE
----                           ---------        --------               ------   -----------
cat4503.network.com            192.168.5.17     L2-Switch              normal   OFF
Firewall1                      192.168.5.1      Firewall               normal   OFF
Firewall2                      192.168.5.2      Firewall               normal   OFF

To display the detailed information for a network device:

>rcxadm netdevice show -name Firewall1 <RETURN>
Name: Firewall1
SystemName: Firewall1
IPAddress: 192.168.5.1
ProductName: IPCOMEXSC
ModelName: IPCOM EX2000 SC
VendorName: Fujitsu
Firmware: E20L10
Location: NUMAZU_B1
Status: normal
NetdeviceTypes: Firewall
Maintenance: OFF
AutoConfiguration: true
Redundancy: 1
Redundancy[GroupDevice]: Firewall1,Firewall2
Port[0]: LAN0.0
Port[0][Link]: up
Port[0][PhysicalState]: 1000M / F
Vlan[0]: 1
Vlan[0][UntaggedPort]: LAN0.1,LAN0.2
Vlan[0][TaggedPort]: LAN0.3
Link[0][NeighborResourceName]: Firewall2
Link[0][NeighborPort]: LAN0.0
AllocatedResources[Firewall]: fw1
AllocatedResources[Network]: network1,network2
LoginInfo[0][User]: admin
LoginInfo[0][IPAddress]: 192.168.5.1
LoginInfo[0][Port]: 8080
LoginInfo[0][Protocol]: remote_login
LoginInfo[0][Authority]: administrator
LoginInfo[0][Tenant]: TenantA
LoginInfo[0][AuthType]: local password
LoginInfo[0][LoginCheck]: Successful
Ruleset[0]: Rule1
Ruleset[0][info]: Firewall rule
SnmpCommunityName: public
FaultMonitoringMethod: SNMP
FaultMonitoringInterval(s): 300
FaultMonitoringRetry: 3
FaultMonitoringTimeout(s): 10