Name
[Windows Manager]
Installation_folder\SVROR\Manager\bin\rcxadm image - system or cloning image operations of servers
[Linux Manager]
/opt/FJSVrcvmr/bin/rcxadm image - system or cloning image operations of servers
Format
rcxadm image backup -server resource [-comment comment] [-nowait] [-force] rcxadm image restore -server resource [-version version] [-nowait] rcxadm image create -server resource -name image [-comment comment] [-nowait] rcxadm image deploy -server resource [:hostname][,resource[:hostname]]... -name image [-version version] [-nowait] rcxadm image delete -server resource -version version rcxadm image delete -name image -version version rcxadm image list -type {backup|cloning} {[-server resource]|[-name image]} rcxadm image list -server [resource]
Information
rcximage is an abbreviated form of the rcxadm image command. Both forms provide the same subcommands and options, and produce the same results.
Point
A list of system images can be obtained using one of the following two methods.
rcxadm image list -type backup [-server resource]
rcxadm image list -server [resource]
Method b. is only supported only for compatibility purposes with Systemwalker Resource Coordinator Virtual Server Edition V13.2.0 and V13.3.0. As future versions may not support this method, it is recommended to use method a. instead.
Description
rcxadm image is the command used to perform operations involving system images and cloning images.
Backup and restore operations are done by collecting a system image from a managed server (physical OS or VM host) and storing it on the admin server disk. This system image can later be restored to the same managed server.
Cloning is done by collecting a cloning image from a reference server, and storing it on the admin server disk. Cloning images can later be distributed to other servers (either individually or simultaneously to multiple servers). All image operations (backup, restore, and cloning) are performed remotely over the network.
Before using this command, refer to the overview and sections about each operation mentioned in the following manuals.
"Chapter 16 Backup and Restore" in the "User's Guide VE"
"Chapter 17 Cloning [Physical Servers]" in the "User's Guide VE"
If any one of the "backup", "restore", "create", or "deploy" subcommands is executed, the target server is automatically placed into maintenance mode until processing completes. Once complete, the server is set back to its original mode.
Note
The number of cloning image versions that can be kept for a given cloning image (identified by its name attribute) is limited.
Using the create subcommand to collect a new cloning image when the limit has already been reached will fail and display an error.
In such a case, use the delete subcommand to delete one of the existing versions before collecting a new version of the cloning image. Existing versions can be checked using the list subcommand.
By default, this limit is set to 3 versions per cloning image.
For details on changing the maximum number of cloning image versions, refer to "8.4 Changing the Maximum Number of Cloning Image Versions" in the "User's Guide VE".
This command is not available if ServerView Deployment Manager is used on the admin LAN. For more details, refer to "B.2 Co-Existence with ServerView Deployment Manager" in the "Setup Guide VE".
Subcommand
Backs up a system image from the specified server (physical OS or VM host) to the admin server.
Restores a system image to the specified server (physical OS or VM host).
Collects a cloning image from the specified server (physical OS).
Deploys a cloning image to one or multiple servers (physical OS).
System image deletion
Deletes a system image belonging to the specified server (physical OS or VM host).
Cloning image deletion
Deletes the specified cloning image.
Displays a list of system images for the specified server.
The following properties are displayed for each server.
Item Name | Description |
|---|---|
SERVERNAME | Name of the server (physical OS or VM host) from which the system image was backed up |
VERSION | Version number of the system image |
BACKUPDATE | Backup date and time of the system image |
COMMENT | Comment describing the system image |
Displays a list of cloning images for the specified server.
The following properties are displayed for each server.
Item Name | Description |
|---|---|
NAME | Name of the cloning image |
VERSION | Version of cloning images |
CREATIONDATE | Creation date and time of the cloning image |
COMMENT | Comment describing the cloning image |
Option
The following option can be specified for the backup, restore, create, or deploy subcommands:
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 backup, restore or delete subcommand:
Specify the name of the target server (physical OS or VM host) in resource.
The following options can be specified for the deploy or delete subcommand:
Specify the name of the target cloning image in image.
Specify the version of the target cloning image to distribute in version.
This option can be omitted when deploying the latest cloning image version.
The following option can be specified for the backup subcommand:
Specify a comment to help identify the system image.
Enter a string no longer than 128 alphanumeric characters (either single or double-byte characters).
Note that percent signs ("%"), backslashes ("\") and double quotes ( " ) cannot be used for comment.
Note
When using blank spaces in comment, enclose the whole character string, comment, in double quotes ( " ).
Forces execution of a server backup when the target server's status is one of the following:
normal
warning
unknown
error
fatal
The following option can be specified for the restore subcommand:
Specify the version number of the system image to restore in version.
If omitted, the latest version of the system image will be restored.
The following options can be specified for the create subcommand:
Specify the name of the target server (physical OS) in resource.
Specify a name to assign to the collected cloning image in image.
Enter a string that is no more than 32 characters long, where the first character is a letter and the remaining characters are alphanumeric characters or underscores ("_").
Specify a comment to help identify the cloning image.
Enter a string no longer than 128 alphanumeric characters (either single or double-byte characters).
Note that percent signs ("%"), backslashes ("\") and double quotes ( " ) cannot be used for comment.
Note
When using blank spaces in comment, enclose the whole character string, comment, in double quotes ( " ).
The following option can be specified for the deploy subcommand:
Specify the name of the server(s) (physical server) to deploy a cloning image to in resource.
Multiple server names can be specified using commas (",").
The name attributed to a server after deployment can be specified in hostname. This is done by adding a colon (":") and the hostname string behind each physical server's resource identifier string. If the hostname string is omitted, the post-deployment server name is set to the following.
When a physical OS has not been registered
Physical server (resource) name
When a physical OS has been registered
Physical OS name
Use the following syntax for the hostname.
[Windows]
A string of up to 63 characters, including alphanumeric characters, underscores ("_"), and hyphens ("-").
Hostnames made of only numbers are not allowed.
[Linux]
A string of up to 64 characters, including alphanumeric characters, hyphens ("-"), periods ("."), and underscores ("_").
Note
When using SUSE Linux Enterprise Server, server names including periods (".") cannot be configured for post-deployment server names of cloning images.
Information
As the physical OS name of a managed server refers to that server's hostname, it is recommended to use only characters specified in the RFC (Request For Comments) 952. Those characters are listed below.
Alphanumeric Characters
Hyphens ("-")
Periods (".") [Linux]
The following options can be specified for the delete subcommand:
Specify the version number of the system image or cloning image to delete in version.
The following options can be specified for the list subcommand:
Specify the type of image to list up.
If "backup" is specified
A list of system images is displayed.
If "cloning" is specified
A list of cloning images is displayed.
Specify the name of the server (physical OS or VM host) for which to display system images in resource. This option should not be specified if the "-type" option has been set to "cloning".
If the "-type" option is set
Omitting this option will output a list of system images for all managed servers.
If the "-type" option is not set
The same list of system images (for all servers) can be output by specifying only the -server option without specifying a resource (this command usage differs from that of Systemwalker Resource Coordinator Virtual Server Edition V13.2.0 and V13.3.0. Refer to "Point" at the top of this section for details).
Specify the name of the cloning image to display in image.
If omitted, a list of all cloning images will be displayed.
Requirements
One of the following permissions is required:
OS Administrator
Resource Orchestrator Privileged User
Admin server
Usage example
To create a system image backup
>rcxadm image backup -server blade07 -comment "Database Server-2" <RETURN> |
To restore a system image to a managed server
>rcxadm image restore -server blade07 -version 2 <RETURN> |
To delete a system image
>rcxadm image delete -server blade07 -version 2 <RETURN> |
To display a list of all system images
>rcxadm image list -type backup -server blade07 <RETURN>
SERVERNAME VERSION BACKUPDATE COMMENT
---------- ------- ---------- -------
blade07 2 2007/11/01-10:06:35 Database Server-1
blade07 3 2007/11/12-15:16:55 Database Server-2 |
To display a list of all system images
>rcxadm image list -type backup <RETURN>
SERVERNAME VERSION BACKUPDATE COMMENT
---------- ------- ---------- -------
blade01 2 2007/11/01-10:06:35 Application Server-1
blade01 3 2007/11/12-15:16:55 Application Server-2
blade05 2 2007/12/01-10:06:35 File Server-1
blade05 3 2007/12/12-15:16:55 File Server-2
blade07 2 2007/01/31-20:46:25 Database Server-1 |
To collect a cloning image
>rcxadm image create -server blade01 -name AppImage -comment "Windows" <RETURN> |
To deploy a cloning image
>rcxadm image deploy -server blade08:db02,blade09 -name AppImage -version 2 <RETURN> |
To delete a cloning image
>rcxadm image delete -name AppImage -version 2 <RETURN> |
To display a list of image versions for a given cloning image
>rcxadm image list -type cloning -name AppImage <RETURN>
NAME VERSION CREATIONDATE COMMENT
---- ------- ------------ -------
AppImage 1 2008/11/12-16:54:05 Windows
AppImage 2 2008/11/13-10:16:53 Windows+patch |
To display a list of all cloning images
>rcxadm image list -type cloning <RETURN>
NAME VERSION CREATIONDATE COMMENT
---- ------- ------------ -------
AppImage 1 2008/11/12-16:54:05 Windows
AppImage 2 2008/11/13-10:16:53 Windows+patch
DBImage 1 2008/11/13-13:21:38 Redhat
DBImage 2 2008/11/14-04:39:27 - |
Exit Status
This command returns the following values:
The command executed successfully.
An error has occurred.
