Description
Note
The swcfmg_lplatform command is the former command for registration, updating, moving, owner modification, deletion, and listing of server group information. For new operations, use the swcfmg_servergroup command.
Registers, updates, moves, changes the owner of, deletes, and lists server group information managed by Systemwalker Software Configuration Manager.
It cannot register, update, move, change the owner of, or delete server groups managed by ServerView Resource Orchestrator or OpenStack.
Synopsis
[Windows]
swcfmg_servergroup.exe |
[Linux]
swcfmg_servergroup |
Options
Registers server group information using the data entered in the specified server group information file.
The server group information file is in CSV format. For details, refer to "2.2.3 Server Group Information File ".
Updates server group information using the data entered in the specified server group information file.
The server group information file is in CSV format. For details, refer to "2.2.3 Server Group Information File ".
Moves or changes the owner of a server group using the data entered in the specified server group information file.
The server group information file is in CSV format. For details, refer to "2.2.3 Server Group Information File ".
Specify a server group ID to delete a registered server group. Multiple server group IDs can be specified by delimiting them with ',' (comma).
You can confirm a server group ID by executing this command with the "-list" option specified and checking the server group information that is output.
Outputs the server group information registered using this command and the server group information created using swcfmg_define_serverinfo (Managed Server Information Definition command), in CSV format.
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.
For information on the output file, refer to "2.2.3 Server Group Information 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.
utputs the server group information in the format of "site server group information file". When this option is omitted, the server group information is output in the format of "server group information file".
This option outputs not only the server group information registered using this command and the server group information created using swcfmg_define_serverinfo (Managed Server Information Definition command), but also the server group information managed using ServerView Resource Orchestrator or OpenStack.
If this option is specified, server group 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 server group ID does not exist. |
80 | The server group cannot be deleted because there is a server belonging to the server group. |
81 | This operation cannot be performed for server groups managed by ServerView Resource Orchestrator or OpenStack. |
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, moving, and deletion 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 to register, update, move, change the owner of, or delete server groups of ServerView Resource Orchestrator or OpenStack.
Server group information is registered in accordance with the server group information file.
An error will occur if <Server group ID> is specified in the input file. For new registrations, do not specify <Server group ID>.
Specify a server group name that is unique within the tenant.
Behavior is not guaranteed if the character encoding specified for this command does not match the character encoding specified for the server group information file. These character encodings must match.
As the owner, specify the user belonging to the tenant specified in "tenant-id" or a dual-role administrator. Do not specify the infrastructure administrator as the owner.
When updating registered server group information, it is recommended that you edit the listed file and use the edited file as the input file for update.
Specify a server group name that is unique within the tenant.
The tenant ID and owner are not changed even if specified. To change the tenant ID and owner, specify the "-move" option of this command to move the server group, or change the owner.
Updating cannot be performed for server groups managed by ServerView Resource Orchestrator or OpenStack.
When updating registered server group information, it is recommended that you edit the listed file and use the edited file as the input file for update.
The server group name is not changed even if specified. To change the server group name, specify the "-update" option of this command to update the server group.
For the owner of the server group, specify a user of the tenant to which the server group belongs, or a dual-role administrator. If moving a server group and also changing its owner, specify a user of the destination tenant or a dual-role administrator as the owner.
The infrastructure administrator cannot own a server group. Do not specify the infrastructure administrator as the owner.
Moving and changing of the owner cannot be performed for server groups managed by ServerView Resource Orchestrator or OpenStack.
An error will occur if a server group with the same name already exists at the destination. Execute this command with the "-update" option to change the server group name first, and then move the server group.
Use this command to delete server group information that is no longer required for Systemwalker Software Configuration Manager.
Before deleting server group information, confirm that there is no server belonging to the relevant server group. If one exists, deletion is not possible.
Deletion cannot be performed for server groups managed by ServerView Resource Orchestrator or OpenStack.
If no server group information is registered, only header information is output.
#servergroup-id, servergroup-name,tenant-id,owner |
To include server groups managed by ServerView Resource Orchestrator or OpenStack in the list display, specify the "-all" option.
The "tenant ID" column is not displayed for a server group that does not belong to a tenant. Move the server group and change the tenant to which the server group belongs, making sure to select an existing tenant.
If the server group information file is invalid, updating, moving, changing of owner of, or deletion of the server group information will be canceled. An error message similar to the following will be output to the trace log:
CFMGC20005 The file description is incorrect. [Line number:<n>][Cause:<Cause>] |
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.5 Server Information File" for details). |
Mandatory elements are not specified. | Enter the mandatory elements in the given line. |
The same Server group is specified in another line. | The same server group ID is already defined in one of the preceding lines. |
The same Server group name is specified in another line. | A server group with the same name as <servergroup-name> in the given line exists in the same tenant. |
The specified Server group does not exist. | There is no server group corresponding to <servergroup-id> in the given line. Specify the ID of an existing server group. |
The specified user does not exist. | There is no user corresponding to owner in the given line. Specify the ID of an existing user. |
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 Server group cannot be operated. | The server group information in the given line is for a server group managed using ServerView Resource Orchestrator or OpenStack. This command cannot update, move, change the owner of, or delete this type of information. |
Example
Registration
[Windows]
swcfmg_servergroup.exe -add -file C:\work\servergroupinfo.csv |
[Linux]
swcfmg_servergroup -add -file /tmp/servergroupinfo.csv |
Update
[Windows]
swcfmg_servergroup.exe -update -file C:\work\servergroupinfo.csv |
[Linux]
swcfmg_servergroup -update -file /tmp/servergroupinfo.csv |
Deletion
[Windows]
swcfmg_servergroup.exe -delete -id UB5IFK3AT@Direct,YFEFI9P7Q@Direct |
[Linux]
swcfmg_servergroup -delete -id UB5IFK3AT@Direct,YFEFI9P7Q@Direct |
List
[Windows]
swcfmg_servergroup.exe -list -file C:\work\servergroupinfo.csv |
[Linux]
swcfmg_servergroup -list -file /tmp/servergroupinfo.csv |
Execution results/output format
List
Standard output
#servergroup-id,servergroup-name,tenant-id,owner UB5IFK3AT@Direct,system1,tenant_1,user001 YFEFI9P7Q@Direct,system2,tenant_2,user002
File output
CFMGC30101 The server group 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:
#servergroup-id,servergroup-name,tenant-id,owner
