1.6.7 listremoteconnections (outputting the list of connection destination definitions) : JP1 Version 11 JP1/Automatic Operation Command and API Reference

Description

This command outputs the CSV-formatted list of the connection destination definitions registered in JP1/AO.

Syntax

listremoteconnections
    /file output-file-path
    /user user-ID
     {/password password | /passwordfilepassword-file-path}

Arguments

/file

This option specifies the absolute or relative path to the file to which connection destination definition information is to be output. An error occurs if the specified file exists.

/user

This option specifies the user ID for JP1/AO.

The number of possible characters is in the range from 1 to 256 characters.

The possible characters are half-width alphanumeric characters, !, #, $, %, &, ', (, ), *, +, -, ., =, @, \, ^, _, and |.

This option is not case sensitive.

/password

This option specifies the password of the user indicated by the user option.

You must specify either this option or the passwordfile option. If both options are specified, or if neither is specified, then you will get an error.

The number of possible characters is in the range from 1 to 256 characters.

The possible characters are the same as those for the user option.

/passwordfile

This option specifies the absolute or relative path to the password file for the user specified in the user option. You can create a password file by using the encryptpassword command.

You must specify either this option or the password option. If both options are specified, or if neither is specified, then you will get an error.

Output format

The output items are output in CSV format in a single line per connection destination definition.

The values for each output item are enclosed in double quotation marks ("). Any double quotation mark (") contained in the value is escaped with another one added in front of the mark.

Table 1‒6: Output format of a connection destination definition information file
Output item	Description
Id	ID of the connection destination definition
Method	One of the following values is output as the connection destination type. IPv4 IPv6 HostName
IP Address/Host Name	IP address or host name of the host to connect to
Service Group	Service group that is assigned to the connection destination definition
Authentication	Whether authentication information has been set is output. Enable Authentication information has been set. Disable Authentication information has not been set.
Protocol	The authentication protocol used for communication with the host to connect to is output. Windows SSH Telnet
SSH Authentication Method^#1	The authentication method used for communication with the host to connect to is output. Password Authentication Password authentication Public Key Authentication Public key authentication Keyboard Interactive Authentication Keyboard interactive authentication
User ID	User ID for logging in to the host to connect to
Password^#2	Password for logging in to the host to connect to
Superuser's Password^#2	Password for the superuser of the host to connect to
Connection Status	The status when JP1/AO last connected to the host is output. Connection Successful Connection was successful. Error Connection failed. Unknown Not connected - Not applicable If the range of the hosts to connect to is specified, a hyphen (-) will be displayed.
Connected Time	The time at which JP1/AO last connected to the host is output.

#1: If Protocol is Windows or Telnet, an empty string is output.
#2: ******** is output regardless of whether the password is set.

Located in

In Windows:: JP1/AO-installation-folder\bin
In Linux:: /opt/jp1ao/bin

Execute permission

Execute the command as a user with both Administrator or root permissions for the OS and with the Admin role for JP1/AO. If a user without Administrator or root permissions executes the command, a message appears asking the user to elevate the permission level.

Return code

The following table lists the return codes from the command.

Return code	Description
0	The command succeeded.
1	The argument is invalid.
2	The command execution has been interrupted.
3	The service status is invalid.
4	One of the other commands is running.
5	Communication failed.
6	Authentication failed.
7	An invalid path is specified.
8	The file with the same name already exists in the output path.
9	The specified path does not exist.
10	The specified path is not accessible.
13	Outputting the file failed.
14	You do not have permission to execute the command.
220	Obtaining the list of connection destination definitions failed.
255	The command execution has been interrupted due to an error other than the above.

Example

The following example shows how to use the command to output, in Windows, connection destination definition information as the file C:\temp\list01.csv:

listremoteconnections /file C:\temp\list01.csv /user user01 /password pass01