Installation_folder\SVROR\Manager\bin\rcxadm tenant - Tenant operations
rcxadm tenant list [-name name] rcxadm tenant show -name name rcxadm tenant create -file file.xml [-nowait] rcxadm tenant modify -name name {[-new_name name] [-label label] [-mail mail_address] [-comment comment] [-global pool[,pool[,...]]]} [-nowait] rcxadm tenant delete -name name [-nowait] rcxadm tenant move -name name [-to folder] [-nowait]
rcxadm tenant is the command used to perform tenant management and operations.
When using Cloud Edition, refer to "3.14 rcxadm tenant" in the "Reference Guide (Command/XML) CE".
Displays a list of tenants.
| Item Name | Description |
|---|---|
| NAME | Tenant name |
| LABEL | Label for the tenant |
| 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 |
Displays the detailed information for a tenant.
The following information is displayed.
| Item Name | Description |
|---|---|
| NAME | Tenant name |
| LABEL | Label for the tenant |
| COMMENT | Comment for the tenant |
| GLOBAL POOL | Name of the global pool |
Creates a tenant.
Modifies one of the following. Specify at least one of the following items:
E-mail address
Deletes a tenant.
When an L-Server is created in a tenant, deleting the tenant will also delete the L-Server.
For details on deleting L-Servers, refer to "3.6 rcxadm lserver" in the "Reference Guide (Command/XML) CE".
User groups and users are also deleted if the roles assigned to them are only targeting the tenant for deletion. 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.
Moves a tenant 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.
In file.xml, specify the XML file that defines the information related to a tenant.
The XML definition for tenants is shown below.
|
<?xml version="1.0" encoding="utf-8"?> <Tenant name ="Tenant name" label="Label"> <Comment>Comment</Comment> <MailAddress>User's mail address</MailAddress> <UserGroup name="User group name" label="Label"> <Comment>Comment</Comment> <Role name="Role name"> <Scopes> <Scope>Tenant name</Scope> </Scopes> </Role> </UserGroup> <User name="User ID" label = "Label" > <Password>Password</Password> <Comment>Comment</Comment> <UserGroup>User Group Name</UserGroup> </User> <Pools> <Pool name="Resource pool name" type="Resource pool type" label="Label"> <Comment>Comment</Comment> <Priority>Priority</Priority> </Pool> </Pools> <GlobalPoolLinks> <GlobalPoolLink>Global pool name</GlobalPoolLink> ... </GlobalPoolLinks> </Tenant> |
| Element Name | Description | Remarks (Possible Values, Examples) |
|---|---|---|
|
Tenant name (Tenant name) |
Tenant Name |
Specify a character string beginning with an alphanumeric character and containing up to 32 alphanumeric characters, underscores ("_"), and hyphens ("-"). When creating it in a resource folder, specify the resource folder name using slashes ("/"). Creation in a tenant is not possible. |
|
Label (Tenant label) |
Label for the tenant (optional) |
Specify a string of up to 32 characters. |
|
Comment (Comment) |
Comment for the tenant (optional) |
Specify a character string of up to 256 alphanumeric characters or symbols. |
|
E-mail address (MailAddress) |
Email address of the tenant administrator | Specify a character string of up to 64 alphanumeric characters or symbols. |
|
User group name (UserGroup name) |
Name of the user group to create in the tenant |
Specify a user group name to create. If UserGroup is omitted, "supervisor" is set. For details on the elements inside the UserGroup tag, refer to "15.11 User Groups" in the "Reference Guide (Command/XML) CE". Create a user group when using directory service authentication. |
|
User ID (User name) |
Name of the user to create in the tenant |
Specify the user ID to create. If the User element is omitted, no user is created. The following elements can be specified for User elements.
Role names (Role name) and access scopes (Scope) cannot be specified. For details on reach of the elements, refer to "15.10 User" in the "Reference Guide (Command/XML) CE". When using directory service authentication, register the users registered in the directory service with the manager. A user and a manager are not converted, when no users are registered in the directory service. |
|
Resource pool name (Pool name) |
Name of the resource pool to create in the tenant |
Specify the name of the resource pool to create in the tenant. If the Pools element is omitted, no resource pool is created in the tenant. |
|
Resource Pool Type (Pool type) |
The type of the resource pool |
Specify the type of the resource pool to create in the tenant. The following types can be specified:
|
|
Label (Pool label) |
Label for the resource pool (optional) |
Specify a string of up to 32 characters. |
|
Comment (Comment) |
Comment for the resource pool (optional) |
Specify a character string of up to 256 alphanumeric characters or symbols. |
|
Priority (Priority) |
Resource pool priority (optional) |
Specify the priority for the resource pool as between 1 and 10. If omitted, "5" is set. For the priority order, "1" is the highest and "10" is the lowest. |
|
Name of the global pool (GlobalPoolLink) |
Name of the global pool |
Specify the resource pool name to be defined in a global pool of a tenant. If the GlobalPoolLinks element is omitted, no global pool is defined for the tenant. If specifying a resource pool in a resource folder, specify the resource folder name using slashes ("/"). |
Note
The email addresses specified in the create and modify subcommands cannot be referred to using the show command. Therefore, retain the XML file or the option setting information used when executing the command.
Example
<?xml version="1.0" encoding="utf-8"?>
<Tenant name ="TenantFolder" label="TenantFolder Label">
<Comment>TenantFolder Comment</Comment>
<MailAddress>TenantAdministratorUser MailAddress</MailAddress>
<UserGroup name="TenantUserGroup" label="TenantUserGroup Label">
<Comment>TenantUserGroup Comment</Comment>
<Role name="administrator">
<Scopes>
<Scope>TenantFolder</Scope>
</Scopes>
</Role>
</UserGroup>
<User name="TenantAdminUser" label="TenantAdministratorUser Label">
<Password>tenant123</Password>
<Comment>TenantAdministratorUser Comment</Comment>
<UserGroup>TenantUserGroup</UserGroup>
</User>
<Pools>
<Pool name="VMHostPool" type="vm" label="VMHostPool Label">
<Comment>VMHostPool Comment</Comment>
<Priority>5</Priority>
</Pool>
<Pool name="ServerPool" type="server" label="ServerPool Label">
<Comment>ServerPool Comment</Comment>
<Priority>5</Priority>
</Pool>
<Pool name="StoragePool" type="storage" label="StoragePool Label">
<Comment>StoragePool Comment</Comment>
<Priority>5</Priority>
</Pool>
<Pool name="NetworkPool" type="network" label="NetworkPool Label">
<Comment>NetworkPool Comment</Comment>
<Priority>5</Priority>
</Pool>
<Pool name="AddressPool" type="address" label="AddressPool label">
<Comment>AddressPool Comment</Comment>
<Priority>5</Priority>
</Pool>
<Pool name="ImagePool" type="image" label="ImagePool label">
<Comment>ImagePool Comment</Comment>
<Priority>5</Priority>
</Pool>
</Pools>
<GlobalPoolLinks>
<GlobalPoolLink>/VMHostPool</GlobalPoolLink>
<GlobalPoolLink>/ServerPool</GlobalPoolLink>
...
</GlobalPoolLinks>
</Tenant>
Use this option to return directly to the command prompt without waiting for the operation specified in the subcommand to complete its execution.
In name, specify the name of the target tenant to perform an operation with. If a tenant created in a resource folder is specified, specify the resource folder name using slashes ("/").
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.
In new_name, specify the changed tenant name.
In mail_address, specify the email address of the tenant administrator.
In label, specify the new label.
In comment, specify the comment for a tenant.
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 or a resource folder in a tenant.
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.
OS Administrator
Admin server
>rcxadm tenant list NAME LABEL ---- ----- /Tenant01 - /Tenant02 - >rcxadm tenant list -name Tenant01 TYPE NAME LABEL ---- ---- ----- Pool AddressPool02 - Pool ImagePool02 - Pool NetworkPool02 - Pool ServerPool02 - Pool StoragePool02 - Pool VMHostPool02 - LServer lserver02 l_server 2
>rcxadm tenant show -name TenantA
name : tenantA
label : tenant A
comment : comment_A
global pool : /VMHostPool
global pool : /NetworkPool
global pool : /AddressPool
This command returns the following values:
The command executed successfully.
An error has occurred.