1.3.15 rcxadm tenant (for Basic mode)

Name

[Windows]
Installation_folder\Manager\bin\rcxadm tenant - Tenant operations

[Linux]
/opt/FJSVrcvmr/bin/rcxadm tenant - Tenant operations

Format

rcxadm tenant list [-name name]
rcxadm tenant show -name name
rcxadm tenant create -file file.xml [-nowait]
rcxadm tenant modify -name name {[-new_name new_name] [-label label] [-comment comment] [-global pool,...]} [-nowait]
rcxadm tenant delete -name name [-nowait]
rcxadm tenant move -name name [-to folder] [-nowait]

Description

rcxadm tenant is the command used to perform tenant management and operations.

Subcommands

list

Displays a list of tenant folders.

The following detailed information is displayed:

When not specifying -name for the option
Table 1.55 Tenant Information (when omitting the -name option)
Item Name
Description
NAME
Tenant folder name
LABEL
Tenant folder label

When specifying -name for the option

Table 1.56 Tenant Information (when specifying the -name option)
Item Name	Description
TYPE	Type of resource folder, resource pool, or each resource
NAME	Name of the resource folder, resource pool, or each resource
LABEL	Label of the resource folder, resource pool, or each resource

show

Displays the detailed information for a tenant folder.

The following detailed information is displayed:

Table 1.57 Detailed Information for Tenants
Item Name	Description
NAME	Tenant folder name
LABEL	Tenant folder label
COMMENT	Comment for a tenant folder
GLOBAL POOL	Global pool name

create: Creates a tenant.

modify

Modify one of the following: Specify at least one of the items below.

Tenant Name
Label
Comment Information
Definition of the Global Pool

delete

Deletes a tenant.
When an L-Server is created in a tenant folder, deleting the tenant will also delete the L-Server.
For details on how to delete an L-Server, refer to the advisory notes of "1.3.1 rcxadm lserver".

User groups and users are also deleted if the roles assigned to them are only targeting the deleted tenant folder. When user information is managed using a directory service, the user information will be deleted from the management information of Resource Orchestrator. The user information in the directory service is not deleted.

Note

When an L-Server is created in a tenant folder, deleting the tenant will also delete the L-Server.
For details on how to delete an L-Server, refer to the advisory notes of "1.3.1 rcxadm lserver".

move: Moves a tenant folder to the specified resource folder. If the destination resource folder is not specified, the folder is moved to the home folder.
It cannot be moved into a tenant folder.

Options

-file file.xml: In file.xml, specify the XML file that defines the information related to a tenant.
For details on the XML file definition, refer to "2.17 Tenants (for Basic mode)".

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

-name name: In name, specify the name of the target tenant to perform an operation with. If a tenant folder created in a resource folder is specified, specify the resource folder name using slashes ("/").

-global pool: In pool, specify the resource pool name to be defined in a global pool of a tenant. If specifying a resource pool in a resource folder, specify the resource folder name using slashes ("/"). When specifying multiple resource pools, separate them using commas.

-new_name new_name: In new_name, specify the changed tenant folder name.

-label label: In label, specify the new label.

-comment comment: In comment, specify the comment for a tenant folder.

-to folder: In folder, specify the destination resource folder. For the hierarchized resource folder, specify the resource folder name using slashes ("/"). It cannot be moved to a tenant folder or a resource folder in a tenant folder.
When omitted, the server 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.

Examples

When displaying a list of tenant folder information

>rcxadm tenant list <RETURN>
NAME                LABEL
----                -----
Tenant01            -    
Tenant02            -    

>rcxadm tenant list -name Tenant01<RETURN>
TYPE                NAME                            LABEL
----                ----                            -----
Pool                AddressPool02                   -
Pool                ImagePool02                     -
Pool                NetworkPool02                   -
Pool                ServerPool02                    -
Pool                StoragePool02                   -
Pool                VMHostPool02                    -
LServer             lserver02                       l_server 2

When displaying details of tenant folder information

>rcxadm tenant show -name TenantA <RETURN>
name        : tenantA
label       : tenant folder A
comment     : comment_A
global pool : /VMHostPool
global pool : /NetworkPool
global pool : /AddressPool