rcxadm image is an existing ROR VE command.
For details, refer to "4.1 rcxadm image" of the "Command Reference VE".
This section explains the additional functions.
Name
[Windows]
Installation_folder\Manager\bin\rcxadm image - image operations
[Linux]
/opt/FJSVrcvmr/bin/rcxadm image - image operations
Format
rcxadm image create -server resource -name image [-comment comment] [-to pool] [-storage vstorage] [-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] rcxadm image list -type snapshot [-server resource] [-detail] rcxadm image move -name image -to pool [-nowait]
Description
The additional functions of rcxadm image are indicated below.
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.
rcxadm image create -server resource -name image [-comment comment] [-to pool] [-storage vstorage] [-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]
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
Cloning images with the same name can be stored up to the maximum of the versions.
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 "1.7.2 rcxadm imagemgr".
Subcommands
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 cloning images |
VERSION | Version of cloning images |
CREATIONDATE | Date and time of cloning image collection |
COMMENT | Comments for cloning images |
For snapshots
Item Name | Description |
---|---|
SERVERNAME | Name of the server (physical server/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 cloning images |
VERSION | Version of cloning images |
CREATIONDATE | Date and time of cloning image collection |
TYPE | VM type of a cloning image [VMware] [Hyper-V] [Xen] [KVM] [Oracle VM] |
COMMENT | Comments for cloning images |
For snapshots
Item Name | Description |
---|---|
SERVERNAME | Name of the server (physical server/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] [Oracle VM] |
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.
Item Name | Description |
---|---|
NAME | Name of cloning images |
VERSION | Version of cloning images |
CREATIONDATE | Date and time of cloning image collection |
DISKS (*1) | The disk sizes of the cloning image are displayed, with the system disk size first, then data disk size.
|
COMMENT | Comments for cloning images |
*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 "Chapter 15 Disaster Recovery" in the "Operation Guide CE".
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.
Images registered in the orchestration tree are moved between resource pools.
Options
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.
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.
In comment, enter a comment that identifies the snapshot.
Enter up to 128 alphanumeric characters or symbols.
However, use of percent signs ("%"), back slashes ("\"), and double quotes (") is not allowed in comment.
Note
If blank spaces are included in comment, enclose the comment character string using double quotes ( " ).
Specify when executing a snapshot, regardless of the status of the L-Server.
In image, enter a name to identify the collected cloning 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.
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) |
Oracle VM |
|
Make sure the name image specified when creating an image does not conflict with the name of the cloning image for the physical server. For details on the cloning image of the physical server, refer to "Chapter 7 Cloning [Windows/Linux]" in the "User's Guide VE".
[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 ("_").
Examples
To display a list of cloning images:
>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 the list of snapshots:
>rcxadm image list -type snapshot <RETURN>
SERVERNAME VERSION BACKUPDATE 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 BACKUPDATE TYPE COMMENT
---------- ------- ------------ ---- -------
/test/TEST 1 2011/04/20-06:45:14 VMware - |