Description
Note
This is the former command for registering, updating, deleting, and listing server information.
For new operations, use the swcfmg_servergroup and swcfmg_server commands.
Registers, updates, and deletes the information of the managed server managed by Systemwalker Software Configuration Manager
Note that it does not register, update, or delete server information managed by ServerView Resource Orchestrator.
This command only registers, updates, and deletes the server information. It does not register, update, or delete the server instance.
When the "-import" option is specified, manually registered server information is registered or updated according to the input file.
When the "-export" option is specified, manually registered server information is output to the output file. However, server information managed by ServerView Resource Orchestrator and OpenStack is not output.
When the "-delete" option is specified, the specified manually registered server information is deleted.
When editing manually registered server information, it is recommended to edit the file that was exported using the "-export" option, specify the edited file for the input file of the "-import" option, and then perform the import.
The input file is in CSV format (refer to "2.2.11 Managed Server Information Configuration File" for information on the I/O files).
Only the following information can be updated:
<host-name> (host name)
<server-name> (server name)
<os-name> (OS name)
Delete the managed server information in the following cases:
When there is no longer any need to manage the managed server using Systemwalker Software Configuration Manager
To change the server group that the managed server belongs to (Delete it and then re-register it)
To change the tenant that the managed server belongs to (delete it, and then register it)
If this command is executed without specifying an option, manually registered server information is output to the standard output.
Format
Windows
swcfmg_define_serverinfo.exe [-import <path of the input file> [-e <character encoding of the input file>] [-t] | -export <path of the output file> [-e <character encoding of the output file>] | -delete <IP address>] |
Linux
swcfmg_define_serverinfo [-import <path of the input file> [-e <character encoding of the input file>] [-t] | -export <path of the output file> [-e <character encoding of the output file>] | -delete <IP address>] |
Options
Registers/updates managed server information using the specified input file
The input file is in CSV format (refer to "2.2.11 Managed Server Information Configuration File" for details).
Specifies the character encoding of the input 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.
Performs the connection test
If this option is omitted, the connection test will not be performed (refer to "1.2.11 swcfmg_connectiontest (Connection Test Command)" for details).
The servers that will be the target of the connection test include managed servers whose information has been registered and updated.
Outputs registered managed server information to the specified output file in CSV format.
If the specified file does not exist, a new file will be created. If the file exists, the existing file will be overwritten.
When a new file is specified and the output fails, the file will not be created. When an existing file is specified and the output fails, the existing file will not be overwritten.
Refer to "2.2.11 Managed Server Information Configuration File" for information on the output file.
Specifies the character encoding of the output 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.
Deletes the information of the specified manually registered server information that has been registered.
Return values
Return value | Meaning |
|---|---|
0 | Completed normally. |
10 | A parameter error has occurred. |
20 | The specified I/O path is incorrect. |
30 | The specified character encoding is incorrect. |
40 | The managed server information configuration file cannot be analyzed. |
60 | There is a new managed server to be registered. |
61 | There is no managed server to be updated. |
70 | The managed server information you are trying to delete was registered by a related product. The managed server information managed by a related product cannot be deleted. |
71 | The managed server information you are trying to delete does not exist. |
80 | The connection test failed. |
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 permission to execute this command. |
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
This command can only be executed by the system administrator (superuser).
This command can be executed on the admin server.
Notes
Solaris managed servers are not supported by this command. When managing Solaris managed servers, use the swcfmg_server (server information management command).
This command is used to manage server information. It cannot be used to manage tenants, tenant users, and server groups.
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 still running.
Execute this command while Systemwalker Software Configuration Manager is running.
The managed server information is registered according to the input file. New server information that is defined will be registered. Existing server information that is defined will be updated. This is determined by the key in <IP address> of the input file.
To update existing managed server information, it is recommended that you edit the file that was exported, and use this as the import input file.
If there is an error in the input file, registration of the policy definitions will be canceled. An error message, similar to the following, will be output to the trace log:
The information in line n is invalid. (Cause: <Cause>)
One of the following messages will be output for <Cause>:
Message | Meaning |
|---|---|
Number of elements. | Review the number of elements in the given line. |
The specified elements are invalid. (tenant-name, owner, ...) | The values of elements within "()" in the given line are invalid. Enter the correct values (refer to "2.2.11 Managed Server Information Configuration File" for details). |
Mandatory elements are not specified. | Enter the mandatory elements in the given line. |
The specified tenant does not exist. | The tenant, <tenant-name>, in the given line does not exist. Specify an existing tenant. For information on the values to set, refer to "Designing Configurations of Tenants, Users, Server Groups and Servers" in the Installation Guide. If this message is output when linking to ServerView Resource Orchestrator while the managed server information is being updated, it signifies that the tenant information may have been deleted. Use the ROR console to restore the original tenant information. |
The specified owner does not exist. | <owner> in the given line is not the <tenant-name> user specified in the same line. For information on the values to set, refer to "Designing Configurations of Tenants, Users, Server Groups and Servers" in the Installation Guide. If this message is output when linking to ServerView Resource Orchestrator while the managed server information is being updated, it signifies that the <tenant-name> user may have been deleted. Use the ROR console to restore the original tenant information. |
The tenant name cannot be changed. | <tenant-name> cannot be changed for the existing managed server. To change the tenant that the managed server belongs to, delete the managed server information, and then register it with another tenant For information on the values to set, refer to "Designing Configurations of Tenants, Users, Server Groups and Servers" in the Installation Guide. |
The L-Platform name cannot be changed. | <lplatform-name> cannot be changed for the existing managed server. To change the server group that the managed server belongs to, delete the managed server information first, then register it in another server group. For information on the values to set, refer to "Designing Configurations of Tenants, Users, Server Groups and Servers" in the Installation Guide. |
The OS type cannot be changed. | <os-type> cannot be changed for the existing managed server. To change the OS of the managed server, delete the managed server information For information on the values to set, refer to "Designing Configurations of Tenants, Users, Server Groups and Servers" in the Installation Guide. |
The OS architecture cannot be changed. | <os-architecture> cannot be changed for the existing managed server. To change the OS architecture of the managed server, delete the managed server information before doing so. For information on the values to set, refer to "Designing Configurations of Tenants, Users, Server Groups and Servers" in the Installation Guide. |
The owner of the L-Platform cannot be changed. | <owner> in the given line is not the owner of <lplatform-name> specified in the same line. Specify the owner of <lplatform-name>. To change the owner of the server group, create a new server group with the relevant <owner> defined as the owner and move the managed server information to that server group. To move the managed server information, delete it and redefine elsewhere. The server group for which the owner was changed can be created, provided there is no server group with the same name within the tenant at the time of registration of managed server information. If the server group already exists, the managed server will belong to the existing one. For information on the values to set, refer to "Designing Configurations of Tenants, Users, Server Groups and Servers" in the Installation Guide. |
The specified L-Platform is related to another owner. | Different <owner> information for the same <lplatform-name> is already defined in one of the preceding lines. Specify one <owner> for <lplatform-name> only. For information on the values to set, refer to "Designing Configurations of Tenants, Users, Server Groups and Servers" in the Installation Guide. |
The same IP address is specified in another line. | The server information with the same admin IP address is already defined in one of the preceding lines. The server information cannot be registered if the same admin IP address is used. |
The server has already been registered. | The server information in the given line is already registered by a related product. The server information with the same admin IP address that matches servers managed by a related product cannot be registered. |
The L-Platform has already been registered. | The <lplatform-name> in the given line is already registered by a related product. Server groups managed by a related product cannot be registered. |
If the server group name (<lplatform-name>) is omitted from the input file, Systemwalker Software Configuration Manager will automatically create a server group. The server group name automatically created by Systemwalker Software Configuration Manager can be checked in the standard output of this command, and from Servers >> Server group name in the console window. In the standard output, the following message is displayed:
The L-Platform <L-Platform name> was automatically generated. Server: <IP address> (<host name>)
Example:
The L-Platform (3K6SP2QTZ) was automatically generated. Server: 10.10.10.10 (server1)
The server group owner cannot be changed using this command. To change the server group owner of a particular managed server, create a new server group that will be owned by the corresponding user, and then assign the managed server to that server group. To transfer the managed server information to another server group, delete the managed server information. For information on how to determine server group settings, refer to "Designing Configurations of Tenants, Users, Server Groups and Servers" in the Installation Guide. Perform registration and deletion using this command.
The tenant that the server group belongs to cannot be changed using this command. To change the tenant that the server group belongs to, change the tenant and the server group for the managed server that the server group belongs to. To transfer the managed server to another tenant, delete the managed server information. For information on how to determine server group settings, refer to "Designing Configurations of Tenants, Users, Server Groups and Servers" in the Installation Guide. Perform registration and deletion using this command.
Even if the connection test fails, the registration and update of the managed server information completes. If the connection test fails, resolve the problem on the managed server for which the connection test has failed, and then update the managed server information using this command. If you do not need to update the server information, run the connection test only, and then check the status of the managed server.
This command only registers and updates the managed server information. After it is registered, the managed server configuration information is retrieved using discovery. Additionally, if there is a defect in the managed server environment, it will be detected through the connection test or discovery, or by installing the patch.
The behavior cannot be guaranteed if the character encoding specified in this command does not match the input file character encoding. These character encodings must match.
If the managed server information is not registered, only the header information will be output.
#tenant-name,lplatform-name,owner,ipaddress,host-name,server-name,os-type,os-architecture,os-name
The displayed server information instance does not necessarily exist. Discard or return the managed server, and then delete the information about managed servers that no longer need to be managed by Systemwalker Software Configuration Manager using the import.
The displayed information instance does not necessarily exist for the tenant information and the owner information. These instances may sometimes be deleted by ServerView Resource Orchestrator. If the tenant or owner was deleted by ServerView Resource Orchestrator, an error will occur when the output file that was exported using this command is imported. Take action against the error that occurs during import. Refer to "Notes on import" for information on errors that may occur during import.
If the managed server information is not registered, only the header information will be output.
#tenant-name,lplatform-name,owner,ipaddress,host-name,server-name,os-type,os-architecture,os-name
Delete the information about servers that no longer need to be managed by Systemwalker Software Configuration Manager using this command.
For example, patch management will no longer work for a server once the server is discarded or returned. If the managed server information for the server has been registered using this command, the information must also be deleted using this command.
If the operation continues without deleting the server information, the management console will also continue displaying the server information although patch management no longer works for the server.
If a server is rebuilt or redeployed with the same IP address and its managed server information is registered without deleting the earlier server information for which patch management no longer works, the earlier information before the rebuild or redeploy may be displayed. If the earlier information is displayed, update it to the latest information using discovery. If the earlier information is still displayed even though it was updated to the latest information, delete the managed server information, and then register it again. After registering the managed server information, update the configuration information to the latest information through the connection test and discovery.
If the managed server information cannot be deleted, an error message, similar to the following, will be output to the trace log:
Failed to delete the managed server information. (Cause: <Cause>)One of the following messages will be output for <Cause>:
Message | Meaning |
|---|---|
The Server could not be deleted. | The specified managed server information cannot be deleted. The specified managed server was registered by a related product. The managed server information managed by a related product cannot be deleted. |
The Server does not exist. | The specified managed server information does not exist. |
Examples
Import
Windows
swcfmg_define_serverinfo.exe -import C:\work\serverinfo.csv |
Linux
swcfmg_define_serverinfo -import /tmp/serverinfo.csv |
Import (to perform the connection test)
Windows
swcfmg_define_serverinfo.exe -import C:\work\serverinfo.csv -t |
Linux
swcfmg_define_serverinfo -import /tmp/serverinfo.csv -t |
Export
Windows
swcfmg_define_serverinfo.exe -export C:\work\serverinfo.csv |
Linux
swcfmg_define_serverinfo -export /tmp/ serverinfo.csv |
Information deletion
Windows
swcfmg_define_serverinfo.exe -delete 10.10.10.10 |
Linux
swcfmg_define_serverinfo -delete 10.10.10.10 |
Standard output
Windows
swcfmg_define_serverinfo.exe |
Linux
swcfmg_define_serverinfo |