Top
ServerView Resource Orchestrator Cloud Edition V3.1.1 Reference Guide (Command/XML)
ServerView
Part 1 Command Reference > Chapter 4 Image Operations > 4.1 rcxadm image
PreviousNext

4.1 rcxadm image

Name

[Windows Manager]
Installation_folder\SVROR\Manager\bin\rcxadm image - Image operations

[Linux Manager]
/opt/FJSVrcvmr/bin/rcxadm image - Image operations


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.

  1. rcxadm image list -type backup [-server resource]

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

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 "6.4 Changing the Maximum Number of Cloning Image Versions (Physical Servers)" or "6.5 Changing the Maximum Number of Cloning Image Versions (Virtual Servers)" in the "User's Guide for Infrastructure Administrators (Resource Management) CE".

  • This command is not available if ServerView Deployment Manager is used on the admin LAN. For more details, please refer to "Appendix B Co-Existence with ServerView Deployment Manager" in the "Setup Guide VE".


Subcommands

backup

Backs up a system image from the specified server (physical OS or VM host) to the admin server.

restore

Restores a system image to the specified server (physical OS or VM host).

create

Collects a cloning image from the specified server (physical OS).

deploy

Deploys a cloning image to one or multiple servers (physical OS).

delete

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

list
System Image List

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

Cloning Image Display

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


Options

The following option can be specified for the backup, restore, create, or deploy subcommands:

-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 backup, restore or delete subcommand:

-server resource

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:

-name image

Specify the name of the target cloning image in image.

-version version (optional)

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:

-comment comment (optional)

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 ( " ).

-force (optional)

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:

-version version (optional)

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:

-server resource

Specify the name of the target server (physical OS) in resource.

-name image

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 ("_").

-comment comment (optional)

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:

-server resource[[:hostname],...]

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:

-version version

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:

-type {backup|cloning}

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.

-server resource

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

-name image

Specify the name of the cloning image to display in image.
If omitted, a list of all cloning images will be displayed.


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.


This section explains the additional functions of the Cloud Edition.

Name

[Windows Manager]
Installation_folder\SVROR\Manager\bin\rcxadm image - image operations

[Linux Manager]
/opt/FJSVrcvmr/bin/rcxadm image - image operations

Format

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

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

Subcommands

create

Collects a cloning image of the specified L-Server.

list

Displays the cloning images and snapshot images of the specified L-Server.

The following detailed information is displayed:

  • For Cloning Images

    Table 4.1 Cloning Image Information

    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

    Table 4.2 Snapshot Information

    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

    Table 4.3 Detailed Information of 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]
    VMware

    [Hyper-V]
    Hyper-V

    [Xen]
    Xen

    [KVM]
    KVM

    [OVM for x86 2.2]
    Oracle VM

    [OVM for x86 3.2]
    OVM-x86

    [Citrix Xen]
    Citrix-Xen

    COMMENT

    Comment describing the cloning image

  • For Snapshots

    Table 4.4 Detailed Information of 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]
    VMware

    [Hyper-V]
    Hyper-V

    [Xen]
    Xen

    [Citrix Xen]
    Citrix-Xen

    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 the -extend custom option is specified, in addition to the information displayed by the list subcommand, information on relation of customization of the image is displayed.

Table 4.5 Detailed Information of 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

DISKS (*)

The disk sizes of the cloning image are displayed, with the system disk size first, then data disk size.
Hyphens("-") are displayed for the following cloning images:

  • A physical L-Server image

  • Images with the VM type of Xen, KVM, or Oracle VM

CUSTOM

Specify enabling/disabling of customization using cloning image

  • When enabling customization

    true

  • When disabling customization

    false

Hyphen ("-") is displayed to the following cloning images

  • Cloning Image Whose VM Type is not Citrix-Xen

SYSTEMTYPE

System Type of guest OS corresponding to cloning image

Hyphen ("-") is displayed to the following cloning images.

  • Cloning Image Whose VM Type is not Citrix-Xen

  • When display item CUSTOM is false

COMMENT

Comment describing the cloning image

* Note: 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 18 Disaster Recovery" in the "Operation Guide CE".

delete

In addition to the ROR VE functions, an L-Server snapshot can be deleted with the delete subcommand.

restore

In addition to the ROR VE functions, an L-Server snapshot can be restored with the restore subcommand.

snapshot

Collects a snapshot of the specified L-Server.
Setting is only possible for virtual L-Servers.

move

Images registered in the orchestration tree are moved between resource pools.

Options

-server resource

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

-nowait

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

-to pool

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

-storage storagename

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.

-type cloning|snapshot

Specify the type of image. If you specify snapshot, a snapshot image is displayed.

-detail

Use this option to display the detailed information for a desired image.

-extend disksize|custom

Specify when displaying additional information.
If you specify disksize, the disk size of the cloning image is displayed.
If you specify custom, information on relation of customization of the image is displayed.

-comment comment

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 ( " ).

-online

Specify when executing a snapshot, regardless of the status of the L-Server.

-name image

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

-version version

In version, specify the version of the cloning image or snapshot.

-attr attr

When the cloning image is collected, specify the collection form to virtual server. When specifying multiple attributes, separate them using commas.

disk=all

Specify this option to collect cloning images including data disks for L-Servers.
This option can be specified when the target L-Server satisfies the following conditions:

  • The server type is virtual

  • The VM type is VMware or Hyper-V

custom={true|false}

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 the following conditions:

  • ROR Manager is Windows

  • The OS type is supported

  • The server type is virtual

  • The VM type is Citrix-Xen

systemtype={32bit|64bit}

When using the VM guest's customization, specify the system type of guest OS

  • When guest OS is 32 bit operating system

    Specify "32bit".

  • When guest OS is 64 bit operating system

    Specify "64bit".

When custom option is specified by "true", specify this option

When custom option is specified by "true", This option is not omissible.

Point

In the VM guest's customizing, Sysprep of Microsoft is used.

The response file used with Sysprep specifies "x86" or "amd64" for a parameter of cpuarch. Therefore, when the VM guest's customization is used, it is necessary to specify the parameter of cpuarch. In ROR, it is expressed as the system type of guest OS, and specify "32bit" or "64bit".

Note

  • When creating an image, a template is created in the server virtualization software with the following name:

    Table 4.6 Name in Server Virtualization Software

    Server Virtualization Software

    Name in Server Virtualization Software

    VMware
    Hyper-V
    OVM for x86 2.2
    OVM for x86 3.2

    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.

    Table 4.7 Settings for System Disks

    Server Virtualization Software

    System Disk

    VMware

    Disk with SCSI controller: 0, ID:0

    Hyper-V

    Device, Primary channel (0)

    OVM for x86 2.2

    • When the L-Server is an HVM (Hardware Virtualized Machine)

      hda

    • When the L-Server is a PVM (Para-Virtualized Machine)

      xvda

    OVM for x86 3.2

    Slot 0

  • Use the following methods to collect cloning images:

    • Collecting cloning images from physical servers with an OS installed

    • Collecting cloning images from physical L-Servers with an OS installed

    • Collecting cloning images from virtual L-Servers with an OS installed

    • Collecting cloning images from templates of server virtualization software

    • Registering the server management software (BMC BladeLogic Server Automation) package

    Ensure that each of cloning images collected using one of the above methods has a unique name in the same image pool.

    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 ("_").

Examples

PreviousNext
Copyright 2010-2013 FUJITSU LIMITED