Description
This command registers, updates, deletes, and lists tenant information managed by Systemwalker Software Configuration Manager.
It cannot be used during linkage to ServerView Resource Orchestrator.
Synopsis
[Windows]
swcfmg_tenant.exe |
[Linux]
swcfmg_tenant |
Options
Registers tenant information using the data entered in the specified tenant information file.
The tenant information file is in CSV format (refer to "2.2.2 Tenant Information File" for details).
Updates tenant information using the data entered in the specified tenant information file.
The tenant information file is in CSV format (refer to "2.2.2 Tenant Information File" for details).
Specify a tenant ID for deleting a registered tenant. Multiple tenant IDs can be specified by delimiting them with ',' (comma).
You can confirm a tenant ID by executing this command with the "-list" option specified and checking the tenant information that is output. "-name" is the former option. For new operations, use "-id".
Outputs, in CSV format, the tenant 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.2 Tenant 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.
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 tenant ID does not exist. |
80 | The tenant cannot be deleted because there is a user or server group belonging to the tenant. |
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. |
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, and moving 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.
Execute this command while Systemwalker Software Configuration Manager is running.
This command cannot be used during linkage to ServerView Resource Orchestrator.
Tenant information is registered in accordance with the tenant information file.
Behavior is not guaranteed if the character encoding specified for this command does not match the character encoding specified for the software information file. These character encodings must match.
When updating registered tenant information, it is recommended that you edit the listed file and use the edited file as the input file for update.
Use this command to delete tenant information that is no longer required for Systemwalker Software Configuration Manager.
Before deleting tenant information, confirm that there is no user or server group belonging to the relevant tenant. If one exists, deletion is not possible.
If no tenant information is registered, only header information is output.
#tenant-id,display-name |
If a tenant information file is invalid, the registration, update, or deletion of the tenant information will be canceled. An error message similar to the following will be output to the trace log:
|
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 (refer to "2.2.2 Tenant Information File" for details). |
Mandatory elements are not specified. | Enter the mandatory elements in the given line. |
The same tenant is specified in another line. | The same tenant information is already defined in one of the preceding lines. |
The specified tenant does not exist. | There is no tenant information corresponding to <tenant-id> in the given line. Specify the tenant ID of an existing tenant. |
The tenant has already been registered. | The tenant information in the given line is already registered. |
Example
Registration
[Windows]
swcfmg_tenant.exe -add -file C:\work\tenantinfo.csv |
[Linux]
swcfmg_tenant -add -file /tmp/tenantinfo.csv |
Update
[Windows]
swcfmg_tenant.exe -update -file C:\work\tenantinfo.csv |
[Linux]
swcfmg_tenant -update -file /tmp/tenantinfo.csv |
Deletion
[Windows]
swcfmg_tenant.exe -delete -id tenant_1,tenant_2,tenant_3 |
[Linux]
swcfmg_tenant -delete -id tenant_1,tenant_2,tenant_3 |
List
[Windows]
swcfmg_tenant.exe -list -file C:\work\tenantinfo.csv |
[Linux]
swcfmg_tenant -list -file C:\work\tenantinfo.csv |
Execution results/output format
List
Standard output
#tenant-id,display-name tenant_1,tenant1 tenant_2,tenant2
File output
CFMGC30051 The tenant 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:
#tenant-id,display-name
