7.2 rcxadm usergroup

Name

[Windows Manager]
Installation_folder\SVROR\Manager\bin\rcxadm usergroup - user group operations

[Linux Manager]
/opt/FJSVrcvmr/bin/rcxadm usergroup - user group operations

Format

rcxadm usergroup create -file file.xml
rcxadm usergroup create -name usergroup [-label label] [-comment comment] [-role scope=role[,...]]
rcxadm usergroup list [-format {text|xml}]
rcxadm usergroup show -name usergroup
rcxadm usergroup modify -name usergroup -file file.xml
rcxadm usergroup modify -name usergroup {[-new_name usergroup] [-label label] [-comment comment] [-role scope=role[,...]]}
rcxadm usergroup delete -name usergroup

Description

rcxadm usergroup is the command used to perform operations on multiple users and batch restriction of access scopes. By performing operations on and restricting the access scope for a user group, the settings are applied on all users registered in that user group. When different settings are specified for a user and its user group, the settings for the user are given priority.

Subcommands

create: Creates a user group.
For details on the definition of the XML file to be specified for the -file option, refer to "15.9 User Groups".

list

Displays a list of user group information in text format or XML format.

For the text format or XML format, the following information is displayed.

Table 7.5 User Group Information
Item Name	Description
NAME	User group name
LABEL	Label for the user group
ROLE	Scope and role of access of the user group Displayed as "access_scope=role", and when there are multiple roles, they are displayed separated by commas.

show

Displays the detailed information for the specified user in the text format.

The following detailed information is displayed:

Table 7.6 Detailed Information for User Groups
Item Name	Description
NAME	User group name
LABEL	Label for the user group
COMMENT	Comment for the user group
USER[num]	User IDs of belonging users A number starting from "0" is displayed for num, and when there are multiple roles, they are displayed separated by commas.
ROLE[num]	Scope and role of access of the user group A number starting from "0" is displayed for num, and when there are multiple roles, they are displayed separated by commas.

modify

Modifies the following items of the specified user group.

User Group Name
Label
Comment
Operations
Access Scope

User groups of the same name as the tenant cannot be modified.

For details on the definition of the XML file to be specified for the -file option, refer to "15.9 User Groups".

delete: Deletes the specified user group. You cannot delete a user group if it includes users.
User groups of the same name as the tenant cannot be deleted by this command. When the tenant is deleted, user groups of the same name as the tenant are deleted.

Options

-file file.xml

In file.xml, specify the XML file that defines the attributes of the user group to register or change.
For details on the XML file definition, refer to "15.9 User Groups".

It is not possible to perform batch registration or changes of multiple user groups using the output results of list -format xml.

-name usergroup: In usergroup, specify the user group name.

-label label: In label, specify the label for the user group.

-comment comment: In comment, specify the comments for the user group.

-role scope=role,...

In scope, specify the names of the resource folders, resource pools, or resources in the orchestration tree to include in the access scope.
Specify resources inside resource folders by entering a slash ("/") and the resource name after the resource folder name.
Specify resource folder names or resource names for the access scope. If you do not want to restrict the access scope, omit the access scope, or specify "all".

In role, specify the most appropriate role of the standard roles. Multiple access scopes and roles can be specified, separated by a comma (",").

administrator (Administrator)
operator (Operator)
monitor (Infrastructure Monitor, Monitor)
tenant_admin (Tenant Administrator)
tenant_operator (Tenant Operator)
tenant_monitor (Tenant Monitor)
tenant_user (Tenant User)
infra_admin (Infrastructure Administrator)
infra_operator (Infrastructure Operator)

-format text|xml

Specify the display format. You can specify text or xml format.

When -format is omitted, it is displayed in text format.

-new_name usergroup: In usergroup, specify the new user group name.

Examples

To create a user group:
>rcxadm usergroup create -name mygroup -role all=infra_admin <RETURN>
To modify an access scope and a role of a user group:
>rcxadm usergroup modify -name mygroup2 -role all=operator <RETURN>

To display a list of user group information in text format:

>rcxadm usergroup list <RETURN>
NAME                LABEL               ROLE
----                -----               ----
admin               -                   all=administrator
folder_group        -                   /folder001=administrator

To display the detailed information for the specified user group in text format:

>rcxadm usergroup show -name admin <RETURN>
Name      : admin
Label     :
Comment   :
User[0]   : admin_user
Role[0]   : all=administrator