Name
[Windows Manager]
Installation_folder\SVROR\Manager\bin\rcxadm image - system or cloning image operations of servers and L-Servers
[Linux Manager]
/opt/FJSVrcvmr/bin/rcxadm image - system or cloning image operations of servers and L-Servers
Format
Operations for system images and cloning images of servers
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]
Operations for system images and cloning images of L-Servers
rcxadm image create -server resource -name image [-comment comment] [-to pool] [-storage storagename] [-attr attr[,attr[,...]]] [-nowait] rcxadm image snapshot -server resource [-comment comment] [-online] [-nowait] rcxadm image backup -server resource [-comment comment] [-nowait] [-force] rcxadm image delete -server resource -version version rcxadm image delete -name image -version version rcxadm image restore -server resource [-version version] [-nowait] rcxadm image list -type cloning [-name image] [-detail] [-extend disksize,custom,storage] rcxadm image list -type snapshot [-server resource][-comment comment] [-online] [-detail] rcxadm image move -name image -to pool [-nowait]
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 of servers and L-Servers.
Operations of system images of servers (physical OS or VM host)
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.
Operations of cloning images of servers (physical OS)
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 12 Cloning [Physical Servers]" in the "User's Guide for Infrastructure Administrators (Resource Management) CE"
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.
Operations for system images and cloning images of L-Servers
A resource pool where images are stored can be specified with the -to option when creating an image. The virtual storage location for an image can be specified with the -storage option. Collection methods for virtual servers can be specified by using the -attr option.
rcxadm image create -server resource -name image [-comment comment] [-to pool] [-storage storagename] [-attr attr[,attr[,...]]] [-nowait]
An L-Server snapshot can be created with the snapshot subcommand.
rcxadm image snapshot -server resource [-comment comment] [-online] [-nowait]
A system image of a physical L-Server can be backed up with the backup subcommand.
rcxadm image backup -server resource [-comment comment] [-nowait] [-force]
An L-Server snapshot and the system image of a physical L-Server can be deleted with the delete subcommand.
rcxadm image delete -server resource -version version
Cloning images can be deleted using the delete subcommand.
rcxadm image delete -name name -version version
An L-Server snapshot and the system image of a physical L-Server can be restored with the restore subcommand.
rcxadm image restore -server resource [-version version] [-nowait]
Cloning can be specified with the -type option when using the list command. Detailed information can also be output with the -detail option. Display information can be added with the -extend option.
rcxadm image list -type cloning [-name image] [-detail] [-extend {disksize,custom}]
Storage can be specified with the -extend option when using the list command. If storage is specified, the image location type and the image location of the cloning image are displayed.
rcxadm image list -type cloning [-name image] [-detail] [-extend storage]
A snapshot can be specified with the -type option when using the list command. Detailed information can also be output with the -detail option.
rcxadm image list -type snapshot [-server resource] [-detail]
Images registered in the orchestration tree can be moved between resource pools. The destination resource pool name can be specified with the -to option.
rcxadm image move -name image -to pool [-nowait]
Note
The number of cloning image versions that can be kept for a given cloning image (identified by its name attribute) is limited.
When collecting cloning images using the create subcommand will cause a number exceeding the maximum to be collected, an error will occur.
Check the version of the cloning image name to be collected using the list subcommand, delete any unnecessary cloning image versions using the delete subcommand, and then perform collection of cloning images.
The maximum number of versions of the cloning images is 3 by default.
For details on how to change the number of cloning images versions, refer to "5.9 rcxadm imagemgr".
Subcommand (Operations for system images and cloning images of servers)
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 |
Subcommand (Operations for system images and cloning images of L-Servers)
Collects a cloning image of the specified L-Server.
Displays the cloning images and snapshot images of the specified L-Server.
The following detailed information is displayed:
For Cloning Images
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 |
For Snapshots
Item Name | Description |
|---|---|
SERVERNAME | Name of the server (physical OS/VM host) used to back up snapshot images |
VERSION | Version of snapshot image |
BACKUPDATE | Date and time of snapshot image collection |
COMMENT | Comment for snapshot image |
When the -detail option is specified, in addition to the information displayed by the list subcommand, the TYPE of the image or snapshot is displayed.
For Cloning Images
Item Name | Description |
|---|---|
NAME | Name of the cloning image |
VERSION | Version of cloning images |
CREATIONDATE | Creation date and time of the cloning image |
TYPE | VM type of a cloning image [VMware] [Hyper-V] [Xen] [KVM] [OVM for x86 2.2] [OVM for x86 3.2] [Citrix Xen] |
COMMENT | Comment describing the cloning image |
For Snapshots
Item Name | Description |
|---|---|
SERVERNAME | Name of the server (physical OS/VM host) used to back up snapshot images |
VERSION | Version of snapshot image |
BACKUPDATE | Date and time of snapshot image collection |
TYPE | VM type of a snapshot [VMware] [Hyper-V] [Xen] [Citrix Xen] [KVM] |
COMMENT | Comment for snapshot image |
When the -extend disksize option is specified, in addition to the information displayed by the list subcommand, the disk size of the image is displayed.
When specifying the -extend custom option, the information related to customization of the target images is added to the details displayed in the list.
Item Name | Description |
|---|---|
NAME | Name of the cloning image |
VERSION | Version of cloning images |
CREATIONDATE | Creation date and time of the cloning image |
DISKS (*1) | The disk sizes of the cloning image are displayed, with the system disk size first, then data disk size.
|
CUSTOM | Specify enabling/disabling of customization using cloning image
Hyphens ("-") are displayed for the following cloning images:
|
SYSTEMTYPE | System type of the guest OS corresponding to the cloning image Hyphens ("-") are displayed for the following cloning images:
|
COMMENT | Comment describing the cloning image |
STORAGETYPE (*2) | Type of storage disk of a cloning image When the image type is one other than KVM, a hyphen ("-") is displayed. [KVM]
|
STORAGE (*2) | The disk resource used to store cloning images When the image type is one other than KVM, a hyphen ("-") is displayed. [KVM] One of the following is displayed:
|
*1: This is displayed when specifying the -extend disksize option. Disk size may not be displayed immediately after updating Resource Orchestrator from V3.0 or an earlier version or immediately after performing recovery operations using Disaster Recovery. Wait for a short while and then perform the operation again.
For details on Disaster Recovery, refer to the "DR Option Instruction".
*2: This is displayed when specifying the -extend storage option.
In addition to the ROR VE functions, an L-Server snapshot can be deleted with the delete subcommand.
In addition to the ROR VE functions, an L-Server snapshot can be restored with the restore subcommand.
Collects a snapshot of the specified L-Server.
Setting is only possible for virtual L-Servers.
[KVM]
A snapshot of the virtual L-Server created in the KVM NAS environment can be collected.
Images registered in the orchestration tree are moved between resource pools.
Option (Operations for system images and cloning images of servers)
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.
Option (Operations for system images and cloning images of L-Servers)
Specify the name of the target L-Server to operate in resource.
For the L-Server allocated in the resource folder, specify the resource folder name using slashes ("/").
Example
When specifying the L-Server directly under the TopFolder:
/TopFolder/L-Server_name |
Use this option to return directly to the command prompt without waiting for the operation specified in the subcommand to complete its execution.
For pool, specify the name of the resource pool for storing the cloning image or the name of the destination resource pool.
If omitted, it is assumed that the resource pool with the highest priority from the resource pools with update rights has been specified.
For the resource pool located in the resource folder, specify the resource folder name using slashes ("/").
Example
When specifying the resource pool directly under the TopFolder:
/TopFolder/Resource_pool_name |
For storagename, specify the name of the virtual storage, the library shared folder, or the disk resource for storing the collected cloning image.
If omitted, it is assumed that the storage resource containing the L-Server for collecting cloning images has been specified.
[Hyper-V]
It is assumed that the name of the regulated shared library folder on the SCVMM server is specified.
[Xen]
If omitted when using RHEL5-Xen, virtual storage is automatically selected from the same storage pool as the virtual storage used by the target L-Server to collect from.
[OVM for x86 3.2]
This option is ignored even if specified. Virtual cloning images are stored in the storage repository in which an L-Server is stored.
Specify the type of image. If you specify snapshot, a snapshot image is displayed.
Use this option to display the detailed information for a desired image.
Specify when displaying additional information.
If disksize is specified, the disk size of the cloning image is displayed.
If custom is specified, information on relation of customization of the cloning image is displayed.
If storage is specified, the image location type and the image location of the cloning image are displayed.
In comment, enter a comment that identifies the snapshot.
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.
[Citrix Xen]
Note that percent signs ("%"), backslashes ("\"), double quotes ( " ) and single quotes ( ' ) cannot be used for comment.
Note
When using blank spaces in comment, enclose the whole character string, comment, in double quotes ( " ).
Specify when executing a snapshot, regardless of the status of the L-Server.
[Citrix Xen] [KVM]
When using Citrix Xen and KVM in a NAS environment, this option cannot be used.
Specify a name to assign to the collected cloning image in image.
When the subcommand is list, delete, or move, specify the following:
When the cloning image is registered in the resource pool
Specify the path name including the resource folder name.
When the cloning image is not registered in a resource pool
Specify the cloning image name
In version, specify the version of the cloning image or snapshot.
When collecting a cloning image, specify collection from the virtual server. When specifying multiple attributes, separate them using commas.
Specify this option to collect cloning images including data disks for L-Servers.
This option can be specified when the target L-Server satisfies all of the following conditions:
The server type is virtual
The VM type is VMware or Hyper-V
Specify whether to use the VM guest's customization
When using the VM guest's customization
Specify "true".
When not using the VM guest's customization
Specify "false".
This option can be specified when the target L-Server satisfies all of the following conditions:
The ROR manager is Windows
The OS type is supported
The server type is virtual
The VM type is Citrix-Xen
When using the VM guest's customization, specify the system type of the guest OS.
When the guest OS is a 32 bit operating system
Specify "32bit"
When the guest OS is a 64 bit operating system
Specify "64bit".
Specify this option when "true" is specified for the custom option.
This option cannot be omitted when "true" is specified for the custom option.
Point
Microsoft's Sysprep is used in customization of VM guests.
The response file used with Sysprep specifies "x86" or "amd64" for the cpuarch parameter.
Therefore, when the VM guest's customization is used, it is necessary to specify the parameter of cpuarch.
In ROR, the system type of guest OS is specified as "32bit" or "64bit".
Note
When creating an image, a template is created in the server virtualization software with the following name:
Server Virtualization Software | Name in Server Virtualization Software |
|---|---|
VMware | Cloning_image_name[_index]@version_number |
When creating a template in the server virtualization software, do not use a name with the above format.
When creating a template from a VM guest in the server virtualization software, set the system disk of the VM guest as indicated below.
Server Virtualization Software | System Disk |
|---|---|
VMware | Disk with SCSI controller: 0, ID:0 |
Hyper-V | Device, Primary channel (0) |
Citrix Xen | userdevice:0 |
OVM for x86 2.2 |
|
OVM for x86 3.2 | Slot 0 |
Use the following methods to collect cloning images:
Collect cloning images from physical servers after an OS has been installed
Collect cloning images from physical L-Servers after an OS has been installed
Collect cloning images from virtual L-Servers after an OS has been installed
Collect cloning images from templates of server virtualization software
Register the server management software (BMC BladeLogic Server Automation) package
Ensure that each of the cloning images collected using any of the above methods has a unique name in the same image pool.
Information
For details on the image type, refer to "14.7 Image Resources" in the "User's Guide for Infrastructure Administrators (Resource Management) CE".
For details on the cloning image of the physical server, refer to "Chapter 12 Cloning [Physical Servers]" in the "User's Guide for Infrastructure Administrators (Resource Management) CE".
[VMware] [Hyper-V]
For a cloning image name, enter a character string beginning with an alphabetic character and containing up to 32 alphanumeric characters and underscores ("_").
[Xen] [KVM]
For a cloning image name, enter a character string beginning with an alphabetic character and containing up to 22 alphanumeric characters and underscores ("_").
Requirements
One of the following permissions is required:
OS Administrator
Resource Orchestrator Privileged User
Admin server
Usage example (Operations for system images and cloning images of servers)
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 - |
Usage example (Operations for system images and cloning images of L-Servers)
To display a cloning image:
>rcxadm image list -type cloning <RETURN>
NAME VERSION CREATIONDATE COMMENT
---- ------- ------------ -------
/ImagePool/test2k3R2 1 2011/04/19-21:30:37 - |
To display the detailed information of a cloning image:
>rcxadm image list -type cloning -detail <RETURN>
NAME VERSION CREATIONDATE TYPE COMMENT
---- ------- ------------ ---- -------
/ImagePool/test2k3R2 1 2011/04/19-21:30:37 VMware - |
To display additional information of a cloning image:
>rcxadm image list -type cloning -extend disksize <RETURN> NAME VERSION CREATIONDATE DISKS COMMENT ---- ------- ------------ ----- ------- /ImagePool/test2k3R2 1 2011/04/19-21:30:37 30.0GB,20.0GB,50.0GB - |
To display additional information of a cloning image (when using KVM NAS):
>rcxadm image list -type cloning -extend storage <RETURN>
NAME VERSION CREATIONDATE DISKS COMMENT STORETYPE STORAGE
---- ------- ------------ ----- ------- --------- -------
/Tenant/ImagePool/image1 1 2013/10/30-12:57 30.0GB - VirtualDisk /Tenant/StoragePool/VStorage/image1-0-image1 |
To display the list of snapshots:
>rcxadm image list -type snapshot <RETURN>
SERVERNAME VERSION CREATIONDATE COMMENT
---------- ------- ------------ -------
/test/TEST 1 2011/04/20-06:45:14 - |
To display the detailed information of a snapshot:
>rcxadm image list -type snapshot -detail <RETURN>
SERVERNAME VERSION CREATIONDATE TYPE COMMENT
---------- ------- ------------ ---- -------
/test/TEST 1 2011/04/20-06:45:14 VMware - |
Exit Status
This command returns the following values:
The command executed successfully.
An error has occurred.
