The listremoteconnections command outputs a listing of the agentless connection-destination definitions registered through Ops Center Automator to a CSV formatted file.
Functions
The listremoteconnections command performs the following functions:
- output a list of agentless connection-destination definitions that include names of connection destinations and credential information.
- The CSV file that you have output can be used as an input file for the setremoteconnection command as-is.
Syntax:
listremoteconnections {/file OutputFile [/user UserName | /user UserName /passwordfile PasswordFile] [/authmode local | external] | /help}
Permission
- Ops Center Automator users must have Admin permissions.
- Only users who have OS administrator permissions (members of the Administrators group) are allowed to run the listremoteconnections command.
-
If a user who does not have the necessary permissions runs the command, the following message appears, asking for the promotion of the user's permissions:
KNAE03226-E The user does not have permission to execute the command.
Options
| Option | Description |
|---|---|
| /file |
Specifies the path of the file to which the list is output; if the specified file already exists, an error is generated. . |
| /user |
Specifies the name of the user executing the command. The user name can consist of any single-byte alphanumeric characters including ( ! # $ % & ' ( ) * + - . = @ \ ^ _ |) from 1 - 256 characters. The user name is case-sensitive. |
| /passwordfile |
Specifies a password file (with absolute or relative path) that includes the encrypted user credentials for the selected user. |
| /authmode local | external | Specify the authentication type, either local or external. Specify local to authenticate locally with Automator. Specify external to authenticate with Common Services. If this option is not specified, Ops Center Automator operates in the authentication mode specified by the command.auth.mode of command_user.properties. |
Storage Destination
installation-folder\bin
Return codes
The following table lists the listremoteconnections command return codes and descriptions.
| Return code | Description |
|---|---|
| 0 | The command succeeded. |
| 1 | The argument is not valid. |
| 2 | The command stopped. |
| 3 | The service status is not valid. |
| 4 | An exclusion error has occurred. |
| 5 | Communication failed. |
| 6 | Authentication failed. |
| 7 | A path is specified is not valid. |
| 8 | A file with the specified name already exists. |
| 9 | Path not found. |
| 10 | Path cannot be accessed. |
| 13 | Failed to output the specified file. |
| 14 | User does not have permission to run the command. |
| 17 | The interactive input value is not valid. |
| 220 | Failed to acquire a list of agentless connection-destination definitions. |
| 255 | The command stopped because of an error not in this table. |
Data Format
Agentless connection destinations are output in CSV format with one host in one line and with the following data items in the order in which they are shown in the following table.
| Property | Header Section (first line) | Data Section (second and subsequent lines) |
|---|---|---|
| Definition ID | Id | Agentless connection-destination definition ID |
| Connection destination type | Method | Connection destination can be specified as follows:
|
| Connection destination | IP Address/Host Name | IP address or host name of the connection-destination host. |
| Service resource group | Service Group | Service group name allocated to the agentless connection-destination definition. |
| Authentication information | Authentication | Can be either of the following:
|
| Protocol | Protocol | Can be any of the following:
|
| SSH authentication method | SSH authentication method |
When the protocol is not SSH, null character ("") When the protocol is SSH, any one of the following:
|
| User ID | User ID | User ID of the user who logs on to the connection-destination host. |
| Password | Password | Fixed to "*******" |
| Super user's password | Super user's password | Fixed to "*******" |
| Status | Connection Status | Connection Successful, Error, Unknown, or -. |
| Last connection time | Connected Time | The last connection time. |
Usage example: To output a list of registered agentless connection-destination definitions to a file
listremoteconnections /file bbbbb /user xxxxx
Example: Output message for successful list
KNAE03000-I The listremoteconnections command will now start. KNAE03001-I The listremoteconnections command ended normally.
Example: Output message for unsuccessful list
KNAE03000-I The listremoteconnections command will now start. KNAE03002-E The listremoteconnections command ended abnormally (12345).
Example: Typical output file
"Id","Method","IP Address/Host Name","Service Group","Authentication ","Protocol","SSH Authentication Method","User ID","Password","Super User's Password" "1","IPv4","10.197.158.107","All Service Groups","Enable","Windows","","Administrator@DOM1","********","" "10","HostName","vmc006","All Service Groups","Enable","SSH","Password Authentication","ao","********","********" "100","IPv6","fd00::6172:839:2e15:f6f3:da7e"," All Service Groups ","Enable","Telnet","","","","" "1000","HostName","vmc007"," All Service Groups ","Disable","","","","",""