Description
This command registers, updates, deletes, moves, changes the password of, and lists user information managed by Systemwalker Software Configuration Manager.
It cannot be used during linkage to ServerView Resource Orchestrator.
Synopsis
[Windows]
swcfmg_account.exe -list [ -file <Output file path>] [-e<Character encoding>] [-sort tenant-id | tenant-name] } |
[Linux]
swcfmg_account |
Options
Registers user information in the directory service using the data entered in the specified user information file. The user information file is in CSV format (refer to "2.2.1 User Information File" for details). User information is stored in the directory service (refer to "Managing User Information" in the Installation Guide for details).
Updates user information using the data entered in the specified user information file.
The user information file is in CSV format (refer to "2.2.1 User Information File" for details).
Moves a user (changes the tenant to which the user belongs) using the data entered in the specified user information file.
The user information file is in CSV format (refer to "2.2.1 User Information File" for details).
Updates the user password using the data entered in the specified user information file.
The user information file is in CSV format (refer to "2.2.1 User Information File" for details).
Specify a user ID for deleting a registered user. The user will be deleted from the directory service. Multiple user IDs can be specified by delimiting them with ',' (comma). You can confirm a user ID by executing this command with the "-list" option specified and checking the user information that is output.
Outputs, in CSV format, the user information registered using this command.
If -file <output file> is omitted, the information is output to the standard output for this command.
If the specified file does not exist, a new file will be created. If the file exists, the existing file will be overwritten.
If the file cannot be output because of an error, either a new file will not be created or, if an existing file was to be overwritten, the existing file will be kept as it is, without being overwritten.
Refer to "2.2.1 User Information File" for information on the output file.
Specify the character encoding for the file.
The character encodings below can be specified (single-byte uppercase characters must be used):
UTF-8
If this option is omitted, the character encoding of the execution environment of this command will be used.
If this option is specified, user information is displayed in ascending "tenant-id" order. "tenant-name" is the former option. For new operations, use "tenant-id".
Return value
Return value | Meaning |
|---|---|
0 | The command has terminated normally. |
10 | A parameter error has occurred. |
20 | The specified I/O path is incorrect. |
30 | The specified character encoding is incorrect. |
50 | The file description is incorrect. |
70 | The specified user ID does not exist. |
80 | The user cannot be deleted because there is a server group owned by the user to be deleted. |
100 | Systemwalker Software Configuration Manager is not running. |
101 | A command that cannot be executed at the same time as this command is already running. |
102 | You do not have the privileges required to execute this command. |
103 | Connection to the directory service failed. |
104 | This command cannot be used during linkage to ServerView Resource Orchestrator. |
110 | A write error has occurred. |
200 | Setup has not been performed. |
255 | A system error has occurred. |
Command location
Admin server
[Windows]
<Systemwalker Software Configuration Manager installation directory>\SWCFMGM\bin |
[Linux]
/opt/FJSVcfmgm/bin |
Privilege required/execution environment
[Windows]
Administrator privileges are required. Execute as an administrator.
This command can be executed on the admin server.
[Linux]
System administrator (superuser) privileges are required.
This command can be executed on the admin server.
Notes
Registration, updating, deletion, moving, and modification of the password of this command cannot be executed at the same time. If a command is executed while another command is being executed, an exception error will occur.
This command cannot be used for users who have not been registered using this command or users who do not satisfy the requirements to use this product. Refer to "Managing User Information" in the Installation Guide for information on the requirements to use this product.
Execute this command while Systemwalker Software Configuration Manager is running.
This command cannot be used during linkage to ServerView Resource Orchestrator.
User information is registered in accordance with the user information file.
Do not specify "tenant-id" if creating a dual-role administrator or infrastructure administrator. Specify an existing "tenant-id" if creating a tenant administrator or tenant user.
Behavior is not guaranteed if the character encoding specified for this command does not match the character encoding specified for the user information file. These character encodings must match.
Each user ID must be unique. An error will occur during registration if a user entry with the same user ID already exists in the directory service. For information on the attribute where the user ID is stored, refer to "Managing User Information" in the Installation Guide.
When updating registered user information, it is recommended that you edit the listed file and use the edited file as the input file for update.
Role information can be updated only between the dual-role administrator and infrastructure administrator, or between a tenant administrator and tenant user.
This option cannot be used to change a tenant ID or password. To change a tenant ID, move the user using the "-move" option of this command. To change a password, use the "-chpasswd" option of this command.
When updating registered user information, it is recommended that you edit the listed file and use the edited file as the input file for update.
This option cannot be used to change information other than a tenant ID. To change a password, use the "-chpasswd" option of this command. To change other information, update user information using the "-update" option of this command.
When updating registered user information, it is recommended that you edit the listed file and use the edited file as the input file for update.
The "-chpasswd" option cannot be used to change information other than a password. To change a tenant ID, move the user using the "-move" option of this command. To change other information, update user information using the "-update" option of this command.
If you specify "****" in <password>, the password is not changed and no error occurs.
Use this command to delete user information that is no longer required for Systemwalker Software Configuration Manager.
Before deleting user information, confirm that there are no server groups belonging to the relevant user. If one exists, deletion is not possible.
If no user information is registered, only header information is output.
#user-id,password,tenant-id,role,email,first-name,middle-name,last-name,contract-name,phone |
"****" is output to the "password" column.
If a user information file is invalid, the registration, update, moving, or password change for the user information will be canceled. An error message similar to the following will be output to the standard output:
|
One of the following messages will be output in <Cause>:
Message | Meaning |
|---|---|
Number of elements. | Review the number of elements in the line indicated. |
The specified elements are invalid. () | The values of elements within "()" in the given line are invalid. Enter the correct values. For details on the acceptable values, refer to "2.2.1 User Information File". |
Mandatory elements are not specified. | Enter the mandatory elements in the given line. |
The same user is specified in another line. | The same user information is already defined in one of the preceding lines. |
The specified tenant does not exist. | The tenant corresponding to <tenant-id> in the given line does not exist. Specify the tenant ID of an existing tenant. |
The user has already been registered. | The user information in the given line is already registered. |
The specified user does not exist. | There is no user corresponding to user-id in the given line. Specify the ID of an existing user. |
Example
Registration
[Windows]
swcfmg_account.exe -add -file C:\work\accountinfo.csv |
[Linux]
swcfmg_account -add -file /tmp/accountinfo.csv |
Update
[Windows]
swcfmg_account.exe -update -file C:\work\accountinfo.csv |
[Linux]
swcfmg_account -update -file /tmp/accountinfo.csv |
Moving
[Windows]
swcfmg_account.exe -move -file C:\work\accountinfo.csv |
[Linux]
swcfmg_account -move -file /tmp/accountinfo.csv |
Password change
[Windows]
swcfmg_account.exe -chpasswd -file C:\work\accountinfo.csv |
[Linux]
swcfmg_account -chpasswd -file /tmp/accountinfo.csv |
Deletion
[Windows]
swcfmg_ account.exe -delete -id user001,user002,user003 |
[Linux]
swcfmg_account -delete -id user001,user002,user003 |
List
[Windows]
swcfmg_account.exe -list -file C:\work\accountinfo.csv |
[Linux]
swcfmg_account -list -file C:\work\accountinfo.csv |
Execution results/output format
List
Standard output
#user-id,password,tenant-id,role,email,first-name,middle-name,last-name,contract-name,phone user001,****,tenant1,administrator,user001@example.com,John,,Smith,Development Division,0123-5678 user002,****,tenant1,tenant_admin,user002@example.com,George,,Smith,Sales Division,5678-0123
File output
CFMGC30001 The user information management command has completed normally.
Note that the following header information is output as the first line of the CSV file that is output:
#user-id,password,tenant-id,role,email,first-name,middle-name,last-name,contract-name,phone
