1.6.1 rcxadm user

Name

[Windows]
Installation_folder\Manager\bin\rcxadm user - user operations

[Linux]
/opt/FJSVrcvmr/bin/rcxadm user - user operations

Format

rcxadm user create -file file.xml
rcxadm user list [-format text|xml|ldif] [-outfile outfile]
rcxadm user show -name name [-format text|xml] [-outfile outfile]
rcxadm user modify -file file.xml
rcxadm user delete -name name

Description

rcxadm user is the command to perform the following operations:

Register a user
Modify a password
Modify authority level
Delete a user
Operate by user
Restrict the access scope

Subcommands

create

Creates a user.
Use the -file option to specify the XML file that defines the attributes of one or more users to register. For details on the XML file definition, refer to "2.8 User".

The user is registered in the directory service when changing to the setting that registers the user in the directory service with the directory service operation definition file.
The user of the directory service is registered at the following positions.

For OpenDS
cn=user ID,ou=users,Base DN
For Active Directory
cn=user ID,cn=users,BaseDN

The user is registered to the following group of the directory service.

cn=IflowUsers,ou=group,BaseDN

For details on the directory service operation definition file, refer to "6.6.1 Settings for Tenant Management and Account Management" in the "Operation Guide CE".

list

Displays a list of user information in the text format, XML format, or LDIF.
For the text format, the following information is displayed.

Table 1.69 User Information (the text format)
Item Name	Description
NAME	User ID
USERGROUP	Name of the user group the user belongs to
LABEL	Label for the user
ROLE	Scope and role of access of the user Displayed as "access_scope=role", and when there are multiple roles, they are displayed separated by commas.

For the XML format at the tenant management roles and the tenant user role, the following information is displayed.

Table 1.70 User Information (the XML format at the tenant management roles and the tenant user role)
Item Name	Description
User name	User ID
Comment	Comment for the user
Role name	Role of the user
Scope	Tenant to whom user belongs
MailAddress	User's email address
ContractName	Company name or department name
EmergencyMailAddress	User's emergency contact email address
TelephoneNumber	User's telephone number
FirstName	User's first name
LastName	User's first name
MiddleName	User's middle name

In the XML format for infrastructure administrative roles and multiple roles, the following information is displayed.

Table 1.71 User Information (the XML format for the infrastructure administrative roles and multiple roles)
Item Name	Description
User name	User ID
User label	Label for the user
Comment	Comment for the user
UserGroup	Name of the user group the user belongs to
Role name	Role of the user
Scope	Access scope for the specified role
MailAddress	User's email address

When LDIF is specified, user IDs are output.

show

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

The following detailed information is displayed:

Table 1.72 Detailed Information for Users
Item Name	Description
NAME	User ID
USERGROUP	Name of the user group the user belongs to
LABEL	Label for the user
COMMENT	Comment for the user
ROLE[num]	Scope and role of access of the user A number starting from "0" is displayed for num, and when there are multiple roles, they are displayed separated by commas.

For the XML format, same information as display information on the list subcommand is displayed.

modify: Modifies the information of the specified user.
Use the -file option to specify the XML file that defines the attributes of one or more users to change. For details on the XML file definition, refer to "2.8 User".

delete: Deletes the specified user.
The user is deleted from the directory service when changing to the setting that registers the user in the directory service with the directory service operation definition file.

Options

-file file.xml

In file.xml, specify the XML file that defines one or more user attributes to register or change.
For details on the XML file definition, refer to "2.8 User".

It is possible to perform batch registration or changes of multiple users using the output results of list -format xml.
When the error occurs by users' registration or changes, processing is interrupted. Remove the error factor and delete user information that has succeeded from the file in registration or the change.

-name name: In name, specify the user ID.

-format text|xml|ldif: Specify the display format. You can specify text, xml, or ldif format. ldif can be specified only for the list subcommand.
When -format is omitted, it is displayed in text format.

-outfile outfile: In outfile, specify the file that stores output information. Information is output by the UTF-8 form. Please set it when you change user information by using the output result of the XML form with multi byte character.
When the specified file exists, it becomes an error.

Examples

To create a user:
>rcxadm user create -file myusers.xml <RETURN>

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

>rcxadm user list <RETURN>
NAME                USERGROUP           LABEL               ROLE
----                ---------           -----               ----
aaa                 -                   -                   all=administrator
admin_user          administrator       -                   -
bbb                 -                   -                   /folder001=administrator
folder_user         folder_group        -                   -
manage              -                   -                   -

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

>rcxadm user show -name aaa <RETURN>
Name      : aaa
UserGroup :
Label     :
Comment   :
Role[0]   : all=administrator