Top
ServerView Resource Orchestrator Cloud Edition V3.1.2 Reference Guide (Command/XML)
FUJITSU Software

3.11 rcxadm server

Name

[Windows Manager]
Installation_folder\SVROR\Manager\bin\rcxadm server - Managed server operations

[Linux Manager]
/opt/FJSVrcvmr/bin/rcxadm server - Managed server operations


Format

rcxadm server start -name resource [-nowait]
rcxadm server stop -name resource [-force] [-nowait]
rcxadm server restart -name resource [-force] [-nowait]
rcxadm server switchover -name resource [-spare spare_server] [-nowait]
rcxadm server failback -name resource [-nowait]
rcxadm server takeover -name resource [-nowait]
rcxadm server list [{[-type {physical|vmguest [-server_role]|all [-server_role]}] | [-spare] | [-bootagt] | [-target_disk]} ]
rcxadm server migrate -name guest_name -to vmhost [-mode {live|cold}] [-nowait] rcxadm server migrate -home [-name vmhost] [-nowait]
rcxadm server set -name resource -attr vmm_mode={maintenance|active} rcxadm server set -name resource -attr {vmm_mode={maintenance|active}|vmware.maintenance={maintenance|active}} [VMware] rcxadm server set -name resource -attr vmm_mode={maintenance|active|maintenance_with_move} [Hyper-V] [Citrix Xen] rcxadm server set -name resource -attr bootagt={dos|winpe}
rcxadm server set -name resource -attr server_role={none|manager} rcxadm server set -name resource -mode {active|maintenance}
rcxadm server set -name resource -attr target_disk=disk_number
rcxadm server unset -name
resource -target_disk
rcxadm server show -name
resource -disk
rcxadm server collect -name
resource -disk [-nowait]

Information

rcxserver is an abbreviated form of the rcxadm server command. Both forms provide the same subcommands and options, and produce the same results.

Point

[VMware]
VM host's VM maintenance mode can set using one of the following methods.

  1. rcxadm server set -name resource -attr vmm_mode=maintenance|active

  2. rcxadm server set -name resource -attr vmware.maintenance=maintenance|active

Method b. is supported only for compatibility purposes with ServerView Resource Coordinator VE V2.1.0.

As future versions may not support this method, it is recommended to use method a. instead.


Description

rcxadm server is the command used to control server resources. This function provides the following functionality:

When stopping or restarting a VM host, any VM guests that are running will also be stopped.
Verify that stopping the affected VM guests will not cause any problems before stopping or restarting a VM host.

For details on the switchover, failback and takeover operations, refer to "Chapter 18 Server Switchover Settings" in the "User's Guide VE".
For details on VM guest migrations, refer to "15.1 Migration of VM Guests between Servers" in the "User's Guide VE".
For details on VM maintenance mode settings, refer to "15.2 VM Maintenance Mode of VM Hosts" in the "User's Guide VE".
About the VMguest's server role setting,please refer to "9.9 Server Role Modification" in the "User's Guide VE".


Subcommands

start

Starts the target server (physical server, physical OS, VM host, or VM guest).

stop

Stops the target server (physical server, physical OS, VM host, or VM guest).

restart

Restarts the target server (physical server, physical OS, VM host, or VM guest).

switchover

Switches over the target server (physical OS or VM host) with one of its spare servers.

failback

Switches back a server in switchover state (physical OS or VM host). The spare server that was switched over with is stopped, and the operating system will be restarted on the primary server.

takeover

Sets a post-switchover configuration as final, and allows the spare server to take over the role of the original primary server (physical OS or VM host). After takeover, both servers exchange their roles: the original spare server becomes the new primary server, while the original primary server becomes the new spare server.

list

Displays all registered servers (physical OS's, VM hosts, and VM guests).

The following properties are displayed for each server (when no options are specified).

Item Name

Description

PHYSICAL_SERVER

Physical server name

SERVER

Server name (physical OS or VM host)

ADMIN_IP

Admin LAN IP address

STATUS

Server status

Displays one of the following:

  • normal

  • warning

  • unknown

  • stop

  • error

  • fatal

For an explanation of possible server statuses, refer to "11.2 Resource Status" in the "Operation Guide CE".

MAINTENANCE

Current maintenance mode

  • If maintenance mode is set

    "ON" is displayed.

  • If maintenance mode is not set

    "OFF" is displayed.

For details on the maintenance mode, refer to "Appendix C Maintenance Mode" in the "User's Guide for Infrastructure Administrators (Resource Management) CE".

migrate

Migrates a VM guest to a VM host on a different physical server.

set

Sets or releases VM maintenance mode for a given VM host.
Change the boot agent used when manipulating images.
Set the VMguest's server role.

Configures the image operation target disk.

unset

Releases the configuration of the image operation target disk.

show

Displays the information of a disk on which image operations can be performed.

collect

Collects the information of a disk on which image operations can be performed.
Restarts the target server (physical server, physical OS, VM host, or VM guest) to acquire the disk information.


Options

The following option can be specified for subcommands other than the list subcommand:

-name resource

Specify the name of the target server in resource.


When specifying other than list, set, unset, or show, the following options can be specified.

-nowait (optional)

Use this option to return directly to the command prompt without waiting for the command to complete its execution.


The following option can be specified for the stop and restart subcommands:

-force (optional)

Use this option to forcibly stop or restart a server without shutting down its operating system.


The following option can be specified for the switchover subcommand:

-spare spare_server (optional)

This defines the spare server (physical server) to be switched over with. If omitted, an appropriate server will be automatically selected from the list of spare servers already assigned to the target server.


The following options can be specified for the list subcommand:

-type {physical|vmguest [-server_role]|all [-server_role]} (optional)

This defines the type of server (physical servers, VM guests, all servers) to be listed up.
The following properties are displayed for each server. The option column shows the relationship between displayed properties and the option given in -type ("always" in the table below designates properties that are always displayed, independently from the option given in -type).

Item Name

Description

Options

PHYSICAL_SERVER

Physical server name

always

SERVER

Server name (for a Physical OS, VM host, or VM guest)

always

TYPE

Server type

Displays one of the following:

  • native

    Physical OS

  • vm_host

    VM host

  • vm_guest

    VM guest

physical

all

VM_HOST

VM host name

For a VM guest, this shows the name of the VM host on which this VM guest operates.

vmguest

all

ADMIN_IP

Admin LAN IP address

always

STATUS

Server status

Displays one of the following:

  • normal

  • warning

  • unknown

  • stop

  • error

  • fatal

For an explanation of possible server statuses, refer to "11.2 Resource Status" in the "Operation Guide CE".

always

MAINTENANCE

Current maintenance mode

  • If maintenance mode is set

    "ON" is displayed.

  • If maintenance mode is not set

    "OFF" is displayed.

For details on the maintenance mode, refer to "Appendix C Maintenance Mode" in the "User's Guide for Infrastructure Administrators (Resource Management) CE".

physical

all

SERVER_ROLE

VMguest's server role

Either of the following contents will be displayed.

  • none

    Server role has not been setted.

  • manager

    "Manager" has been setted in server role.

  • -

    "-" will display when the resource is not vmguest.

vmguest -server_role

all -server_role


-spare (optional)

When using spare servers, this shows the spare server(s) (physical server) assigned to each server.
The following properties are displayed for each server.

Item Name

Description

SERVER

Server name (physical OS or VM host)

PRIMARY

Primary server

Name of the physical server that will be switched over with a spare server during a server switchover.

SPARE

Spare server

Name of the spare server (switchover destination) assigned to the primary server.
If multiple spare servers are assigned, the name of each spare server is displayed using commas (",") as a delimiters.

VLAN_SWITCH (*)

Network reconfiguration flag

This flag defines whether network settings will be reconfigured during a server switchover.

  • When network settings are reconfigured during server switchover

    "ON" is displayed.

  • When network settings are not reconfigured during server switchover

    "OFF" is displayed.

AUTO_SWITCH

Auto-Recovery flag

This flag defines whether Auto-Recovery is enabled.

  • When Auto-Recovery is enabled

    "ON" is displayed.

  • When Auto-Recovery is not enabled

    "OFF" is displayed.

ACTIVE

Active server

Displays the name of the currently active physical server.

SWITCHOVER_STATE

Switchover state

Displays the current switchover state. Displays one of the following:

  • normal

    Normal status (There are no switchover, failback, or takeover operations in progress).

  • switchover running

    A switchover operation is in progress.

  • switchover completed

    A switchover operation has been completed.

  • failback running

    A failback operation is in progress.

  • takeover running

    A takeover operation is in progress.

* Note: When a LAN switch blade is in IBP mode or Converged Fabric mode, the details of settings are displayed in this parameter.

-bootagt (optional)

Displays the information about the boot agent used when manipulating images.
The following properties are displayed for each server.

Item Name

Description

PHYSICAL_SERVER

Physical server name

BOOT_AGENT

Set boot agent

Displays one of the following:

  • DOS

  • Windows PE

- target_disk (optional)

Displays the information related to the image operation target disk.
The following properties are displayed for each server.

Item Name

Details

PHYSICAL_SERVER

Physical server name

DISK_NUMBER

Disk number of the configured image operation target disk

  • When the image operation target disk is already configured

    "An integer equal to or greater than 1" is displayed.

  • When the image operation target disk is not configured

    "-" is displayed.

  • When the image operation target disk is already configured, and its information cannot be confirmed in the latest disk information

    "(lost)" is displayed.

DISK_SIZE

Size of the image operation target disk

  • When the image operation target disk is already configured

    The size in megabytes is displayed.

  • When the image operation target disk is not configured

    "-" is displayed.

PARTITION_COUNT

Number of partitions that exist on the image operation target disk

  • When the image operation target disk is already configured

    The number of partitions is displayed.

  • When the image operation target disk is not configured

    "-" is displayed.

  • When disk information collection, image operations, or switchover using the backup and restore method is performed, the values of DISK_NUMBER may be modified based on the latest disk recognition order acquired by Resource Orchestrator.

  • When disks that are the targets of operations cannot be checked, image operations are determined to be invalid by the pre-operation check of Resource Orchestrator, and the image operations cannot be performed. Perform collection of the disk information and configuration of the image operation target disk again.

  • When using this option, if the physical server is a SPARC Enterprise, the information is not output in the list.


The following options can be specified for the migrate subcommand:

-name guest_name

Specify the name of the destination target VM guest in guest_name.

-to vmhost

Specify the name of the destination VM host in vmhost.

-mode {live|cold} (optional)

The type of migration method to perform is given for mode.
Depending on the power state of the VM guest to migrate, only one of those types may be available. When omitted, the appropriate type will be chosen depending on the state of the VM guest.
The following values can be specified.

live

Performs a live migration: migration of an active (powered-on) VM guest.

cold

Performs a cold migration: migration of an inactive (powered-off) VM guest.
The power status of the VM guest after migration will be the same as it was before migration.

[KVM]
The migration might fail when "- mode cold" is specified in the migration from the state of power supply ON.
Power supply ON after the migration is executed after power supply OFF, and it waits for a while.

-home

Specify when performing migration to the VM Home Position.

-name vmhost (optional)

Specify the name of the operation target VM host in vmhost.


The following options can be specified for the set subcommand:

-attr vmm_mode=maintenance
-attr vmware.maintenance =maintenance [VMware]

Sets or releases VM maintenance mode for the target VM host.

-attr vmm_mode=active
-attr vmware.maintenance =active [VMware]

Releases VM maintenance mode for the target VM host.

-attr vmm_mode=maintenance_with_move [Hyper-V] [Citrix Xen]

Sets VM maintenance mode for the target VM host. And migrates the VM guest.

-attr bootagt={dos|winpe}

Changes the boot agent used when manipulating images to DOS or Windows PE.

When the managed server has the following configuration, this option must be specified before manipulating images to change the boot agent settings.

  • SAN data environments using a built-in disk boot, and a physical WWN or VIOM, must be converted to DOS.

  • When using the Red Hat Enterprise Linux 6 ext4 file system and one of the following conditions applies, it needs to be changed to Windows PE.

    • SAN boot environment using HBA address rename

    • Rack mount or tower servers have been registered with "Disabled" selected for "Association with server management software (ServerView)"

  • In a SAN boot environment using HBA address rename and where the following model or OS is used, it needs to be changed to Windows PE.

    • PRIMERGY BX960 S1

    • XenServer6 or later

This option cannot be specified for the following models:

  • SPARC M10/SPARC Enterprise

  • PRIMEQUEST

-attr server_role={none|manager}

Set the VMguest's server role.
When ROR manager is running on the VMguest,set "manager" to guard the operations which will stop ROR manager.
In this way to prevent ROR manager from stopping by incorrect operations.

-attr target_disk=disk_number

Specify the disk number configured as the target disk of the image operation in disk_number.
An integer larger than 1 can be specified for the disk number.
Output the rcxadm server show -name resource -disk command to check the disk number which can be specified.
When using this option, it is only possible to specify the disk number of a physical server for which the disk information has been acquired in advance by execution of the rcxadm server collect -name resource -disk command.
When a backup of an admin server is restored, the actual disk configuration and the disk information may not match. Perform collection of the disk information and configuration of the image operation target disk again.

-name resource

For resource, specify a server name to place into or release from maintenance mode.

-mode active|maintenance

Specify whether the server is to be placed into or released from maintenance mode.

active

Release maintenance mode.

maintenance

Places into maintenance mode.


The following options can be specified for the unset subcommand:

-target_disk

Deletes the configuration of the image operation target disk for the specified server.


The following options can be specified for the show subcommand:

-disk

When the server is a physical server for which the disk information has already been acquired, the following information is displayed.

  • Number of disks (Number of Disk: 0 or larger)

  • Disk number (Equal to the number of disks, 1 or larger)

  • Disk name (Hardware display name)

  • Disk size unit: MByte

  • Number of partitions

  • Partition number (Equal to the number of partitions, 1 or larger)

  • Partition type

    (One of PRIMARY, EXTENDED, LOGICAL, ESP, MSR, DATA, LINUXSWAP, WINRE, or UNKNOWN)

  • File systems of partitions

    (One of FAT12, FAT16, NTFS, FAT32, LINUXSWAP, EXT2, EXT3, EXT4, DISKDUMP, REISERFS, VMFS, EXTENDED, or UNKNOWN)

  • Partition size

  • Usage area of partitions

When the disk information has not been acquired, no value is displayed.


The following options can be specified for the collect subcommand:

-disk

When a physical server is in the following configuration, it is necessary to acquire and configure the information of disks for which image operations are possible before starting image operations.

  • When using a SAN data disk environment with a built-in disk boot

This option can only be executed while the physical server is in maintenance mode, and stopped. Start the physical server to acquire the disk information from, and stop it after acquiring the disk information.

When performing update of a physical server for which the disk information has already been acquired, save the disk information acquired during the latest update.

This option cannot be specified for the following models:

  • SPARC Enterprise



Requirements

Permissions

One of the following permissions is required:

Location

Admin server


Examples

Exit Status

This command returns the following values:

0

The command executed successfully.

non-zero

An error has occurred.

Note

  • A VM guest can be configured to automatically start or stop whenever its VM host starts up or shuts down. This can be achieved by setting up the VM guest's startup and shutdown options in the server virtualization software used.
    For more information, please refer to the server virtualization software manual.

  • As a result of power operation being performed on a VM guest, an error may occur if the VM guest is moved to another VM host and processes executed.
    Refer to "D.3 Functional Differences between Products" in the "Design Guide VE" for details.

  • VM guests should be properly configured in order to use the "stop" or "restart" subcommands.
    Stopping or restarting a VM guest that was not properly configured will result in an error unless the -force option is specified.
    Refer to "D.2 Configuration Requirements" in the "Design Guide VE" for details.

  • For PRIMEQUEST servers, the warning message will not be displayed, even if there is a chance that the switchover will not be correctly performed using Reserved SB settings.

  • If ServerView Deployment Manager is used on the admin LAN, the switchover and failback subcommands cannot be used if the managed servers match any of the following conditions.
    For more details, please refer to "Appendix J Co-Existence with ServerView Deployment Manager" in the "Setup Guide CE".

    • Servers in local boot environments

    • Servers in SAN boot environments without VIOM profiles

  • The changes to the boot agent are valid while the physical server is registered. After reregistering the physical server, change the boot agent using the command if necessary.