Systemwalker Software Configuration Manager Reference Guide

1.2.4 swcfmg_lplatform (L-Platform Information Management Command)

Description

This command registers, updates, moves, changes the owner of, deletes, and lists L-Platform information managed by Systemwalker Software Configuration Manager.

It cannot register, update, move, change the owner of, or delete L-Platforms managed by ServerView Resource Orchestrator.

Synopsis

[Windows]

swcfmg_lplatform.exe
{ -add -file <L-Platform info file> [-e <char encoding>] |
-update -file <L-Platform info file> [-e <char encoding>] |
-move -file <L-Platform info file> [-e <char encoding>] |
-delete -id <L-Platform ID>,... |
-list [ -file <output file>] [-e<char encoding>] [-sort tenant-name] [-all] }

[Linux]

swcfmg_lplatform
{ -add -file <L-Platform info file> [-e <char encoding>] |
-update -file <L-Platform info file> [-e <char encoding>] |
-move -file <L-Platform info file> [-e <char encoding>] |
-delete -id <L-Platform ID>,... |
-list [ -file <output file>] [-e<char encoding>] [-sort tenant-name] [-all] }

Options

-add -file <L-Platform info file>

Registers L-Platform information using the data entered in the specified L-Platform information file.

The L-Platform information file is in CSV format (refer to "2.2.3 L-Platform Information File" for details).

-update -file <L-Platform info file>

Updates L-Platform information using the data entered in the specified L-Platform information file.

The L-Platform information file is in CSV format (refer to "2.2.3 L-Platform Information File" for details).

-move -file <L-Platform info file>

Moves or changes the owner of an L-Platform using the data entered in the specified L-Platform information file.

The L-Platform information file is in CSV format (refer to "2.2.3 L-Platform Information File" for details).

-delete -id <L-Platform ID>,...

Specify an L-Platform ID for deleting a registered L-Platform. Multiple L-Platform ID can be specified by delimiting them with ',' (comma).

• You can confirm an L-Platform ID by executing this command with the "-list" option specified and checking the L-Platform information that is output.

-list [-file <output file>]

Outputs, in CSV format, the L-Platform information registered using this command and L-Platform information created using swcfmg_define_serverinfo (Managed Server Information Definition 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.3 L-Platform Information File" for information on the output file.

-e <char encoding>

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.

-all

Outputs L-Platform information managed by ServerView Resource Orchestrator in addition to L-Platform information registered using this command and L-Platform information created using swcfmg_define_serverinfo (Managed Server Information Definition command).

-sort tenant-name

If this option is specified, L-Platform information is displayed in ascending "tenant-name" order.

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 L-Platform ID does not exist.
80	The L-Platform cannot be deleted because there is a server belonging to the L-Platform.
81	The L-Platform managed by ServerView Resource Orchestrator cannot be operated.
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. When using Windows Server 2008 or later, run this command 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

Common notes

• This command cannot be executed at the same time as other commands. An exclusive control error will occur if a command is executed while another command is executing.

• 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 L-Platforms managed by ServerView Resource Orchestrator.

Notes on registration

• L-Platform information is registered in accordance with the L-Platform information file.

• An error will occur if <L-Platform ID> is specified in the input file. For new registrations, do not specify <L-Platform ID>.

• Specify an L-Platform 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 L-Platform information file. These character encodings must match.

• As the owner, specify the user belonging to the tenant specified in tenant-name or a dual-role administrator. Do not specify the infrastructure administrator as the owner.

Notes on update

• When updating registered L-Platform information, it is recommended that you edit the listed file and use the edited file as the input file for update.

• Specify an L-Platform name that is unique within the tenant.

• The tenant name and owner are not changed even if specified. To change the tenant name and owner, specify the "-move" option of this command to move the L-Platform, or change the owner.

• L-Platforms managed by ServerView Resource Orchestrator cannot be updated.

Notes on moving, or changing the owner

• When updating registered L-Platform information, it is recommended that you edit the listed file and use the edited file as the input file for update.

• The L-Platform name is not changed even if specified. To change the L-Platform name, specify the "-update" option of this command to update the L-Platform.

• As the owner of the L-Platform, specify a user of the tenant to which the L-Platform belongs, or a dual-role administrator. If moving an L-Platform 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 an L-Platform. Do not specify the infrastructure administrator as the owner.

• The owner of L-Platforms managed by ServerView Resource Orchestrator cannot be moved or changed.

• An error will occur if an L-Platform with the same name already exists at the move destination. Use this command with the "-update" option to change the L-Platform name, and then move the L-Platform.

Notes on deletion

• Use this command to delete L-Platform information that is no longer required for Systemwalker Software Configuration Manager.

• Before deleting L-Platform information, confirm that there is no server belonging to the relevant L-Platform. If one exists, you cannot delete the L-Platform information.

• L-Platforms managed by ServerView Resource Orchestrator cannot be deleted.

Notes on list display

• If no L-Platform information is registered, only header information is output.

  #lplatform-id,lplatform-name,tenant-name,owner

• To include L-Platforms managed by ServerView Resource Orchestrator in the list display, specify the "-all" option.

• The "tenant name" column is not displayed for an L-Platform that does not belong to a tenant. Move the L-Platform, and change the tenant to which the L-Platform belongs, making sure to select an existing tenant.

Notes on update, moving, and owner change errors

• If an L-Platform information file is invalid, the update, moving, change of owner of, or deletion of the L-Platform 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 L-Platform is specified in another line.	The same L-Platform ID is already defined in one of the preceding lines.
  The same L-Platform name is specified in another line.	The same L-Platform name is already defined in one of the preceding lines.
  The L-Platform name already exists.	An L-Platform with the same name as <lplatform-name> in the given line exists in the same tenant.
  The specified L-Platform does not exist.	There is no L-Platform corresponding to <lplatform-id> in the given line. Specify the ID of an existing L-Platform.
  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.	There is no tenant corresponding to tenant-name in the given line. Specify the name of an existing tenant.
  The L-Platform cannot be operated.	The L-Platform information in the given line is for an L-Platform managed by ServerView Resource Orchestrator. This command cannot update, move, change the owner of, or delete this type of L-Platform information.

Example

• Registration

  [Windows]

  swcfmg_lplatform.exe -add -file C:\work\lplatforminfo.csv

  [Linux]

  swcfmg_lplatform -add -file /tmp/lplatforminfo.csv

• Update

  [Windows]

  swcfmg_lplatform.exe -update -file C:\work\lplatforminfo.csv

  [Linux]

  swcfmg_lplatform -update -file /tmp/lplatforminfo.csv

• Deletion

  [Windows]

  swcfmg_lplatform.exe -delete -id tenant_1-CFMG-UB5IFK3AT,tenant_2-CFMG-YFEFI9P7Q,tenant_2-CFMG-VGX13H9XL

  [Linux]

  swcfmg_lplatform -delete -id tenant_1-CFMG-UB5IFK3AT,tenant_2-CFMG-YFEFI9P7Q,tenant_2-CFMG-VGX13H9XL

• List

  [Windows]

  swcfmg_lplatform.exe -list -file C:\work\lplatforminfo.csv

  [Linux]

  swcfmg_lplatform -list -file /tmp/lplatforminfo.csv

Execution results/output format

• List

  Standard output

  #lplatform-id,lplatform-name,tenant-name,owner
  tenant_1-CFMG-UB5IFK3AT,system1,tenant_1,user001
  tenant_2-CFMG-YFEFI9P7Q,system2,tenant_2,user002

  File output

  CFMGC30101 The L-Platform 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.

  #lplatform-id,lplatform-name,tenant-name,owner