setremoteconnection command

The setremoteconnection command adds or updates agentless connection-destination definitions in Ops Center Automator through a CSV file.

Function

The setremoteconnection command adds or updates agentless connection-destination definitions in Ops Center Automator. To add or update agentless connection-destination definitions, you define the information in a CSV file and then specify the file name as a command argument.

Syntax:

setremoteconnection {/file Input File  
[/user UserName | /user UserName /passwordfile PasswordFile]
 [/authmode local | external]| /help} 

Options

Storage destination

installation-folder\bin

Return codes

The following table lists the setremoteconnection command return codes and descriptions:

File format

The agentless connection-destination definition file that you specify for the /file option uses the same basic format that is used in the output generated by the listremoteconnections command.

The agentless connection-destination definition file differs depending on the environment as follows:

• In a Windows-based OS environment: Uses character encoding MS932 and line feed code CR+LF.
• In a Linux OS environment: Uses the character encoding that is specified for the user's LANG environment variable and uses the line feed code LF.

Behavior of the setremoteconnections command

The following lists includes details about the behavior of the setremoteconnections command when specifying an agentless connection-destination definition file for the /file option:

• The first line of the file is the header section output by the setremoteconnections command and is ignored unconditionally. The second and subsequent lines are treated as agentless connection-destination definitions.
• When you specify two or more agentless connection-destination definitions in the file, a single syntax error in either definition causes the command to end with an error, and no agentless connection-destination definitions are registered.
• The values of the data items output by the listremoteconnections command in CSV format are enclosed in double quotation marks ("). However, if the values are not enclosed by double quotation marks, they are not treated as errors. (This is because when you edit a CSV file in Excel, double quotation marks are removed).
• If the value of the first data item (ID) of an agentless connection-destination definition is a null character, the specified content is added as an agentless connection-destination definition.
• If a value is specified for the first data item (ID) of an agentless connection-destination definition, the agentless connection-destination definition corresponding to the specified ID is updated with the content specified in the line. If the agentless connection destination definition corresponding to the specified ID does not exist, the system generates an error.
• When two or more agentless connection-destination definitions are specified in a file and the addition or update portion of the definitions fails, the command results are as follows:

  - A return value (warning, not error) is used to report a definition that was not successfully registered.

  - Information is output as a standard error, which enables you to identify the definition that was not successfully registered.

  - The registration processing continues for all remaining definitions, even if an error occurs.

Usage example: Register or update the agentless connection-destination definitions in Ops Center Automator with the content of a specified file

setremoteconnection /file bbbbb /user xxxxx

Example: Successful registration of agentless connection-destination definition

KNAE03000-I The setremoteconnection command will now start.
KNAE03002-E The remote connection definition was registered (ID:12345, line number: 12345).

Example: Unsuccessful registration or update

KNAE03000-I The setremoteconnection command will now start.
KNAE03002-E The setremoteconnection command ended abnormally (12345).

Example: Error encountered in parameters

KNAE03000-I The setremoteconnection command will now start.
KNAE03333-E A required parameter was not found (parameter name: XXXXX, line number: 12345). Specify the required parameter, and then try again.
KNAE03334-E Unnecessary parameter has been specified (parameter name: XXXXX, line number: 12345). Delete the specified parameters, and then try again.
KNAE03002-E The setremoteconnection command ended abnormally (12345).