3.5 rcxadm folder

Name

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

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

Format

rcxadm folder create -file file.xml [-nowait]
rcxadm folder create -name name [-type type] [-label label] [-comment comment] [-nowait]
rcxadm folder list [-name name] [-type type] [-detail]
rcxadm folder show -name name [-type type]
rcxadm folder modify -name name [-type type] {[-new_name name] [-label label] [-comment comment]} [-nowait]
rcxadm folder move -name name [-type type] [-to folder] [-nowait]
rcxadm folder delete -name name [-type type] [-nowait]
rcxadm folder start -name name [-nowait]
rcxadm folder stop -name name
rcxadm folder restart -name name [-nowait]

Description

rcxadm folder is the command used to manage resource folders. Use resource folder management to group resources when the number of resources managed by Resource Orchestrator becomes large or when you want to manage resources in work units. Since the resource folders can be arranged in a hierarchy, you can perform detailed categorization for resources.

Resources can be grouped using the resource folder management functions. Grouping resources enables users to perform operation of multiple resources together and improve operability.
Resource folders can be used with user/role management to ensure folder level security.

Resource folders are categorized into the following two types, depending on the resources to register:

Orchestration
Registers L-Servers, network resources, disk resources, and resource pools.
Servers
Registers server tree blade chassis and rack mount servers.

Subcommands

create: Creates a new resource folder. Use the -file option to create the specified resource folder with resources included. If the resource folder specified in the XML file already exists, only the specified resources are created.

list

Displays the list of resource folders and the resources and subfolders included in the resource folders.

It is possible to display the list excluding the resources being registered, using the configuration in the definition file for "folder operations". By default, resources being registered are displayed. For details on the definition file for "folder operations", refer to the "Folder Operation Definition File" described later.

When specifying -name for the option
Displays the list of the resources and subfolders included in the specified resource folder.
When not specifying -name for the option
Displays the list for the top-level resource folders.

The following detailed information is displayed:

Table 3.11 Resource Folder Information
Item Name	Description
TYPE	Type of resource folder, resource pool, or each resource
NAME	Name of the resource folder, resource pool, or each resource
FOLDER_TYPE (*)	Type of the folder One of the following is displayed: For tenants "TENANT" is displayed. For L-Platforms "LPLATFORM" is displayed. Other folder types A hyphen ("-") is displayed.
LABEL	Label of the resource folder, resource pool, or each resource

* Note: When specifying -detail for the option, it is displayed.

show

Displays the detailed information of a resource folder.

The following detailed information is displayed:

Table 3.12 Detailed Information for Resource Folders
Item Name	Description
NAME	Resource folder name
LABEL	Resource folder label
COMMENT	Comment for the resource folder

modify

Modifies the following items of the specified resource folder:

Resource Folder Name
Label
Comment
Priority

move: Moves a resource folder to the specified resource folder. If the destination resource folder is not specified, the folder is moved to the home folder.

delete: Deletes a resource folder.

start: Starts an L-Server in a resource folder.

stop: Stops an L-Server in a resource folder.

restart: Restarts an L-Server in a resource folder.

Options

-file file.xml: In file.xml, specify the XML file that specifies the resource folder to create and the resources to include in the resource folder. For details on the XML file definition, refer to "15.7 Resource Folders".

-detail: Use this option to display the detailed information for a desired resource folder.

-nowait

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

This option also executes subsequent operations for L-Servers to which resources are not allocated without waiting for resource allocation.

-name name: In name, specify the resource folder name. For the hierarchized resource folder, specify the resource folder name using slashes ("/").
Example
To specify SecondFolder directly below TopFolder:
/TopFolder/SecondFolder

-type type

In type, specify a resource folder type for the resource folder. Specify one of the following for the resource folder type:

"server"
"lserver"

If omitted, "lserver" is set.

-label label: In label, specify the label for the resource folder.

-comment comment: In comment, specify any comments for the resource folder.

-new_name name: In name, specify a new name for the target resource folder to perform an operation with.

-to folder

Specify the destination resource folder in folder. For the hierarchized resource folder, specify the resource folder name using slashes ("/"). When omitted, the folder is moved to the home folder.

When executed by a user who has multiple access scopes specified, it cannot be omitted. Specify a resource folder.

Folder Operation Definition File

To exclude the resources being registered when displaying the list of folders or tenants, define the setting in the following file so that the resources being registered would not be displayed. By default, resources being registered are displayed.

Location of the Definition File

[Windows Manager]
Installation_folder\SVROR\Manager\etc\customize_data

[Linux Manager]
/etc/opt/FJSVrcvmr/customize_data

Definition File Name: folder.rcxprop

Definition File Format

In the definition file, specify each line in the following format:

Key = Value

Item to Specify in the Definition File

Table 3.13 List of Items Specified
Key	Description	Remarks (Possible Values, Examples)
list_registering	Includes the resources being registered in the folder list and the tenant list displayed using the command. (optional)	true (default) Displays the resources being registered. false Does not display the resources being registered.

Examples

To display the list of resource folders and the resources and subfolders included in the resource folders:

>rcxadm folder list <RETURN>
TYPE                NAME                            LABEL
----                ----                            -----
Folder              TenantA                         -
Folder              TenantB                         -
Pool                ImagePool                       -
Pool                ImgPool                         -
Pool                NetworkPool                     -
Pool                StoragePool                     -
Pool                VMHostPool                      -

To display a list of resource folders and the resources and subfolders included in those resource folders (with the -detail option):

>rcxadm folder list -detail <RETURN>
TYPE                NAME                            FOLDER_TYPE LABEL
----                ----                            ----------- -----
Folder              TenantA                         TENANT      -
Folder              TenantB                         TENANT      -
Pool                ImagePool                       -           -
Pool                NetworkPool                     -           -
Pool                StoragePool                     -           -
Pool                VMHostPool                      -           -

To display the list of the resources and subfolders included in the specified resource folder:

>rcxadm folder list -name TenantA <RETURN>
TYPE                NAME                            LABEL
----                ----                            -----
Folder              testA                           -
LServer             test4                           -

To display the detailed information for a resource folder:

>rcxadm folder show -name TenantA <RETURN>
name    : TenantA
label   :
comment :