1.3.13 rcxadm tenant

Name

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

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

Format

rcxadm tenant create -file file.xml [-nowait]
rcxadm tenant delete -name name [-nowait]
rcxadm tenant list [-name name]
rcxadm tenant show -name name
rcxadm tenant modify -name name {[-display_name display_name] [-mail mail_address] [-global pool,...]} [-nowait]

Description

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

Subcommands

create: Creates a tenant.
Create a user group with the same name as that of the tenant. The role of the user group is tenant_admin, and the access scope is the tenant to be created.
The location that a tenant can be created in is the root folder.

delete

Delete the specified tenant and any tenants with the same name as that of the user group.

In the following cases, a tenant cannot be deleted.

When creating an L-Platform under a tenant
When a user belongs to a user group with the same name as that of the tenant

User groups and users are also deleted if the roles assigned to them are only targeting the tenant for deletion.

list

Displays a list of tenants.

The following detailed information is displayed:

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

When specifying -name for the option

Table 1.49 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.

The following detailed information is displayed:

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

modify

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

Tenant display name
E-mail address
Definition of the Global Pool

Options

-file file.xml: In file.xml, specify the XML file that defines the information related to one or more tenants to be registered. When an error occurs during registration of multiple tenants, no tenant registrations have been completed. Remove the cause of error, and execute the operation again.
For details on the XML file definition, refer to "2.10 Tenants".

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

-display_name display_name: Specify a tenant display name for display_name.

-mail mail_address: Specify the e-mail address for the tenant administrator in mail_address.

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

Examples

When displaying a list of tenant 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 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