Top
ServerView Resource Orchestrator Cloud Edition V3.1.1 Reference Guide (Command/XML)
ServerView

3.3 rcxadm disk

Name

[Windows Manager]
Installation_folder\SVROR\Manager\bin\rcxadm disk - disk resource operations

[Linux Manager]
/opt/FJSVrcvmr/bin/rcxadm disk - disk resource operations


Format

rcxadm disk register -file file.xml
rcxadm disk unregister -name name
rcxadm disk modify -name name {{[-label label] [-comment comment]} | -file file.xml}
rcxadm disk list [-verbose [-extend lock]]
rcxadm disk show -name name [-extend lock]
rcxadm disk move -name name -to pool [-nowait]

Description

rcxadm disk is the command used to perform operations on disk resources. The following disk resources are the resources to be allocated to the L-Server.

Disk resources provide virtual disks to L-Servers.


Subcommands

register

[KVM]
Creates a disk resource for a virtual L-Server and registers the disk resource in a storage pool.

In the following cases, an error will occur and the settings will not be modified.

  • The specified tenant does not exist

  • The specified physical resource pool does not exist

  • The specified file does not exist

  • Errors or inconsistencies exist in the xml file

  • The disk name is already registered in Resource Orchestrator

  • The IP addresses of VM hosts are not registered in Resource Orchestrator

  • The same device path is registered in Resource Orchestrator for the same VM host

Disk resources for virtual L-Servers can be registered in a storage pool, regardless of whether the Thin Provisioning attribute is applied to that storage pool. It is recommended to register disk resource in a storage pool which has the same attributes as the disk allocation method in order to standardize the operation so the disk allocation method can be specified when selecting storage pools such as VMware.

[Solaris Zones]
In a Solaris 10 global zone, this creates a disk resource for a virtual L-Server and registers the disk resource in a storage pool.

In the following cases, an error will occur and the settings will not be modified.

  • The specified tenant does not exist

  • The specified physical resource pool does not exist

  • The specified file does not exist

  • Errors or inconsistencies exist in the xml file

  • The specified mount point overlaps with other specified mount points

  • The specified mount point overlaps with the mount point registered in the specified global zone

Disk resources for virtual L-Servers can be registered in a storage pool, regardless of whether the Thin Provisioning attribute is applied to that storage pool. It is recommended to register disk resource in a storage pool which has the same attributes as the disk allocation method in order to standardize the operation so the disk allocation method can be specified when selecting storage pools such as VMware.

Note

Do not mount LUNs that are shared between multiple global zones or the LUNs for the zone path used by virtual L-Servers by selecting them from the other global zone. Data may be damaged when deploying the virtual L-Server using the disk for the corresponding LUN, due to conflicting LUN access.

Information

Overlapping mount points exist in the following case.

Example

When the mount point is /work/zones/ror-zone, the example of overlapping mount points is as follows.

/work/zones/ror-zone/zone1
/work/zones

An example of non-overlapping mount points is as follows.

/zones/ror-zone
/work/zones1/ror-zone

[OVM for SPARC]
Creates a disk resource for a virtual L-Server and registers the disk resource in a storage pool.
In the following cases, an error will occur and the settings will not be modified.

  • The specified tenant does not exist

  • The specified physical resource pool does not exist

  • The specified file does not exist

  • The virtual disk service information of disk resources shared between VM hosts is different

Disk resources for virtual L-Servers can be registered in a storage pool, regardless of whether the Thin Provisioning attribute is applied

to that storage pool. It is recommended to register disk resource in a storage pool which has the same attributes as the disk allocation method in order to standardize the operation so the disk allocation method can be specified when selecting storage pools such as VMware.

unregister

[KVM] [Solaris Zones] [OVM for SPARC]
Releases the registration of a disk resource for a virtual L-Server.

The registration in the storage pool cannot be canceled. When a disk resource has been registered in a storage pool, cancel registration of the disk resource from the storage pool using the rcxadm pool command, and then cancel registration of the disk resource using this subcommand.
In the following cases, an error will occur and the settings will not be modified.

  • The specified disk resource does not exist

  • The specified disk resource is not a raw device or a partition

  • The disk resource for deletion is registered in the storage pool

[Hyper-V]
Unregisters a disk resource of automatically created LUNs.

The registration in the storage pool cannot be canceled. When the disk resource has been registered in a storage pool, cancel registration of the disk resource using this subcommand after canceling registration of the disk resource from the storage pool using the rcxadm pool command. In the following cases, an error will occur and the operation will be aborted:

  • The specified disk resource is not an automatically created LUN that is being retained

  • The specified disk resource is used for an L-Server.

  • The disk resource for deletion is registered in the storage pool

modify -name name {[-label label] [-comment comment]}

Changes labels and comments of disk resources.

modify -name name -file file.xml

[KVM] [Solaris Zones] [OVM for SPARC]
Modifies the properties of a disk resource for a virtual L-Server.
The following operations can be performed:

  • Adding or deleting of a VM host that uses the disk resource (for Solaris Zones, the global zone)

  • Modifying of the device path

  • Modifying of the size

In the following cases, an error will occur and the settings will not be modified.

  • Pool elements are specified

  • The specified disk resource does not exist

  • The specified disk resource is not a device

  • As a VM host has been deleted, there is an L-Server that is using the disk resource for deletion

  • Errors or inconsistencies exist in the xml file

  • The IP addresses of VM hosts are not registered in Resource Orchestrator

  • The same device path is registered in Resource Orchestrator for the same VM host

The IP address of a VM host is only used to identify the VM host.
If the IP address is modified after the registration of raw device or partition information, specify the new IP address.
The IP address of the VM host cannot be modified with this command.
The disk resource name cannot be modified.
To move the disk resource between resource pools, use the rcxadm disk move command.

list

Displays a list of disk resource information.

The following detailed information is displayed:

Table 3.5 Disk Resource Information

Item Name

Description

NAME

Disk resource name

LABEL

Disk resource label

COMMENT (*1)

Disk resource comment

TOTAL

Total disk resource size

STATUS

Disk resource status

VSTORAGE NAME (*1)

Virtual storage resource name that is the source for disk resource creation

SHARED (*1)

Shared status of disks

One of the following is displayed:

  • Yes

    The status is displayed when the disk is used by multiple L-Servers.

  • No

    The status is displayed when the disk is not used by multiple L-Servers.

UNIT_NAME (*1)

Identifier of the physical storage unit resource where disk resources exist

VOLUME_ID (*1)

Volume identifier of the physical storage unit corresponding to disk resources

PRE_CREATED (*1)

One of the following is displayed:

  • Yes

    Displayed when the disk was created using storage management software beforehand.

  • No

    Displayed when the disk was created using Resource Orchestrator.

ATTRIBUTES (*1)

One of the following is displayed:

  • Thin

    Displayed when the thin provisioning attribute is applied.

  • Thick

    Displayed when the thick provisioning attribute is applied.

  • A hyphen ("-")

    Displayed for a disk resource using an iSCSI connection, or a disk resource for a virtual L-Server.

If -verbose -extend lock is specified for the option, in addition to the above information, the following information is displayed, separated by commas (","):

  • locked(DR) (*2)

    This is displayed when resources are locked during DR execution.

  • unlocked(DR) (*2)

    This is displayed when resources are not locked.

LAST_L-SERVER (*1)

The name of the L-Server that was last used is displayed if the disk resource is not connected to any L-Server.

If it is an L-Server located in the tenant or resource folder, the name of the tenant or resource folder is also displayed.

The information in this item is not changed even if the name of the L-Server is changed or the L-Server is deleted after reducing disks in the L-Server.

*1: This is displayed when specifying -verbose for the option.
*2: This is displayed when -verbose -extend lock is specified for the option.

show

Displays the detailed information for a disk resource.

The following detailed information is displayed:

Table 3.6 Detailed Information for Disk Resources

Item Name

Description

NAME

Disk resource name

LABEL

Disk resource label

COMMENT

Disk resource comment

TOTAL

Total disk resource size

STATUS

Disk resource status

VSTORAGE NAME

Virtual storage resource name that is the source for disk resource creation

SHARED

Shared status of disks

One of the following is displayed:

  • Yes

    The status is displayed when the disk is used by multiple L-Servers.

  • No

    The status is displayed when the disk is not used by multiple L-Servers.

POOL_NAME

Name of the storage pool where disk resources have been registered

UNIT_NAME

Identifier of the physical storage unit resource where disk resources exist

VOLUME_ID

Volume identifier of the physical storage unit corresponding to disk resources

L-SERVER[num]

Name of the L-Server to which disk resources are being connected (diskindex)

In diskindex, the index number corresponding to the disk element of the L-Server to which disk resources are being connected is set.

When the disk resource is being shared among multiple L-Servers, the index number of the L-Server is set in num. The number is "0" or larger.

LAST_L-SERVER

The name of the L-Server that was last used is displayed if the disk resource is not connected to any L-Server.

If it is an L-Server located in the tenant or resource folder, the name of the tenant or resource folder is also displayed.

The name of the L-Server that was last used is displayed if the disk resource is not connected to any L-Server.

The information in this item is not changed even if the name of the L-Server is changed or the L-Server is deleted after reducing disks in the L-Server.

PRE_CREATED

One of the following is displayed:

  • Yes

    Displayed when the disk was created using storage management software beforehand.

  • No

    Displayed when the disk was created using Resource Orchestrator.

ATTRIBUTES

One of the following is displayed:

  • Thin

    Displayed when the thin provisioning attribute is applied.

  • Thick

    Displayed when the thick provisioning attribute is applied.

  • A blank space (" ")

    Displayed for a disk resource using an iSCSI connection, or a disk resource for a virtual L-Server.

If -extend lock is specified for the option, in addition to the above information, the following information is displayed, separated by commas (","):

  • locked(DR) (*)

    This is displayed when resources are locked during DR execution.

  • unlocked(DR) (*)

    This is displayed when resources are not locked.

Alias

If an alias has been set for the ETERNUS LUN corresponding to the disk resource, the alias name is displayed.

This item is not displayed in the following cases.

  • If an alias has not been set for the ETERNUS LUN corresponding to the disk resource

  • If the disk resource is not an ETERNUS LUN

If the alias name of the ETERNUS LUN corresponding to the disk separated from the virtual storage has been changed using the ETERNUS WebGUI, the alias name in the disk details will be updated a certain time later.

iSCSI[num] [STORAGE IQN]

IQN name of the storage port used by disk resources with which iSCSI connection is made

The index number of the disk element is configured in num. The number is "1" or larger.

iSCSI[num] [STORAGE IPAddress]

IP address of the storage port used by disk resources with which iSCSI connection is made

The index number of the disk element is configured in num. The number is "1" or larger.

iSCSI[num] [SERVER IQN]

IQN name of the server used by disk resources with which iSCSI connection is made

The index number of the disk element is configured in num. The number is "1" or larger.

iSCSI[num] [SERVER IPAddress]

IP address of the server used by disk resources with which iSCSI connection is made

The index number of the disk element is configured in num. The number is "1" or larger.

iSCSI[num] [port]

iSCSI communication port number used by disk resources with which iSCSI connection is made

The index number of the disk element is configured in num. The number is "1" or larger.

iSCSI[num] [Authentication Method]

Authentication mode adapted to iSCSI communication used by disk resources with which iSCSI connection is made

One of the following is displayed:

  • NONE

    Displayed when not using authentication for iSCSI communications.

  • CHAP

    Displayed when using CHAP authentication.

  • MutualCHAP

    Displayed when using mutual authentication.

The index number of the disk element is configured in num. The number is "1" or larger.

FilePath

[Hyper-V]
The file path corresponding to the path on VM management software is displayed when a disk resource that is created (and saved) from virtual storage has no connection with any L-Servers.

VmHost[num][IPAddress]

The IP address of the VM host specified when creating a disk resource for the virtual L-Server is displayed.

The index number of the disk element is configured in num. The number is "0" or larger.

VmHost[num][Path]

The raw device, or the path or mount point of the partition specified when creating a disk resource for the virtual L-Server is displayed.

The index number of the disk element is configured in num. The number is "0" or larger.

* Note: The information is displayed when -extend lock is specified for the option.

move

Moves disk resources to the specified resource pool. Only disk resources created in advance can be moved.


Options

-file file.xml

[KVM] [Solaris Zones] [OVM for SPARC]
In file.xml, specify the XML file that defines the disk resource information for a virtual L-Server.
When the register subcommand is specified, the disk resource information that is unregistered will be written to the XML file.

In the XML file specified when modify is specified, describe the VM host information (the lower level of information under the VmHost element in the XML file) for all VM hosts sharing disk resources of the modification targets.
Since the XML file used when register is specified is not saved, if the existing VM host information is unclear, check the VM host information by executing the rcxadm disk show command.
The relationship between the information output using the rcxadm disk show command and the VM host information in the XML file is as below.

Information Output by the rcxadm disk show Command

VM Host Information in the XML File

Values of VmHost[num][IPAddress]

ip attribute value in the VmHost element

Values of Name

name attribute value in the Disk element

Values of VmHost[num][Path]

path attribute value in the Disk element

Values of Total Size (excluding "GB")

size attribute value in the Disk element

When specifying the modify subcommand, registered disk resource information that is already registered will be written to the XML file.
For details on the XML file definition, refer to "15.4.1 Disk Resources [KVM]" or "15.4.3 Disk Resources [Solaris Zones]" or "15.4.4 Disk Resources [OVM for SPARC]".
For details on the commands that help the creation of XML file definitions, refer to "5.24 rcxvmdisk" and "5.25 rcxvmdiskagt".

-pool pool

Specify the target resource pool name by level.
Resource_folder_name/Resource_pool_name

-disk disk

Specify the disk resource to delete.

Note

Registration of a raw device disk resource or a partition disk resource for a virtual L-Server cannot be released using the rcxadm pool unregister command.

To release the registration, use the rcxadm disk unregister command.

-verbose

Specify when displaying detailed information.

-name name

In name, specify the name of the target disk resource to perform an operation with.

-to pool

Specify the destination resource pool in pool.
For the resource pool allocated in the resource folder, specify the resource folder name using slashes ("/").

-nowait

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

-label label

In label, specify the new label.

-comment comment

In comment, specify the new comments.

-extend lock

Specify when displaying additional information.


Examples