3.14 rcxadm tenant

Name

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

[Linux Manager]
/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,...] 
[-cut_off_date cut_off_date] [-accounting_mail accounting_mail_address] [-attr attr[,attr[...]]]} [-nowait]
rcxadm tenant lockrsc -name name
rcxadm tenant unlockrsc -name name

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.

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 "3.5 rcxadm folder".

The following detailed information is displayed:

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

When specifying -name for the option

Table 3.57 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 3.58 Detailed Information for Tenants
Item Name	Description
NAME	Tenant name
LABEL	Tenant label
COMMENT	Comment for a tenant
GLOBAL POOL	Global pool name

modify

Modifies one of the following. Specify at least one of the following items:

Tenant Display Name
E-mail Address
Definition of the Global Pool
Cut off Date
Accounting Mail Address
Tenant Configuration Information

lockrsc

Some operations are not possible for the following resources used by an L-Platform within a tenant.

Network Resources
Address Set Resources
Disk Resources
Virtual Storage Resources

For details on the operations that are restricted, refer to "2.2 Switchover Levels" in the "DR Option Instruction".

unlockrsc: Cancels the settings restricting operations configured for specific resources using the lockrsc option.

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

-cut_off_date cut_off_date: Specify the cut off date in cut_off_date.

-accounting_mail accounting_mail_address: Specify the destination e-mail address for the accounting information in accounting_mail_address.

-attr attr

Specify the tenant configuration information in attr using the following format: When specifying multiple pieces of information, separate them using commas.

name=value[,name=value,...]

For details on the names and values that can be specified, refer to "Table 15.19 Items of Tenant Configuration Information" in "15.10 Tenants".

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 A
comment     : comment_A
global pool : /VMHostPool
global pool : /NetworkPool
global pool : /AddressPool