esacli connectionSettings

Use the esacli connectionSettings command to set and display information about the connections to IBM®.

Synopsis

esacli connectionSettings [-d [script]]

esacli connectionSettings {–t direct}

esacli connectionSettings {–t proxy} {-h hostname} {-p port} [-u user] [-w password] 
[-r connection_number]

esacli connectionSettings [-k connection_number]

Description

The esacli connectionSettings command sets and displays information about the connections to IBM. This command configures connectivity to IBM either directly and through a proxy server. Electronic Service Agent™ can be configured with up to three connections. This command will indicate that it completed successfully with a message: This command completed successfully. When the display option is specified, the new settings will be displayed. This command will also display the current settings when run with only the display option or no option is specified.

Options

-d | --display

Specifies the setting values are to be displayed.

The optional script option generates this command containing all the current values, which can be used for updates. For example, to create an executable script file that you can use to specify connectionSettings values, follow these steps:

Display the current connectionSettings values by running the following command:
```
esacli connectionSettings -d
```
Tip: You can display the help for the connectionSettings command by running the following command: esacli help connectionSettings.
Save the output of the connectionSettings command to a file by running the following command:
```
esacli connectionSettings -d script > connections.script
```
Edit the connections.script file to specify the wanted values.
Change the connections.script file to an executable script file.
Run the connections.script file to set the connectionSettings values on this or other systems.

-t | --type direct or proxy

Specifies if the connection to IBM is made through a direct connection or through a proxy connection

-h | --hostname IP address or hostname

Specifies the host name or IP address of the proxy server

-p | --port integer between 1 and 65535

Specifies a proxy server port

-u | --userid user

Optional. Specifies a proxy user ID

-w | --password password

Optional. Specifies a proxy password. The command will prompt for the password if the option but not the value is provided.

-r | --replace integer 1-3

Replaces the existing connection by number. Connection numbers are viewed using the display option of this command to retrieve the Connection number field.

-k | --remove integer 1-3

Deletes an existing connection by number. Connection numbers are viewed using the display option of this command to retrieve the Connection number field.

Exit status

The following table contains the codes that are returned by this command.

0: The operation completed successfully.
1: IBM Electronic Service Agent instance is not running.
10: Unsupported option was specified. Option: {option}.
13: An invalid host name was specified for a subcommand host option.
14: A required option was not provided. Option: {option}.
18: An option was set more than once. Option: {option}.
19: An option value was not provided when required. Option: {option}.
31: An integer value was not provided when required. Option: {name} Value: {value}.
32: An integer value was not in the valid range. Option: {option value} Range: {min-max}.
42: Invalid value {value} specified for the {option} option.
47: Unable to update connection settings. Reason: {reason}

Examples

List connections

This example shows how to display the connections.

esacli connectionSettings -d
Connection List
	Connection Number: 1
	Type: Direct

	Connection Number: 2
	Type: Proxy
	Proxy IP address or host name: proxy.ibm.com
	Proxy Port: 5026
	Destination user name: user1
Password: *******

	Connection Number: 3
	Type: Proxy
	Proxy IP address or host name: proxy2.ibm.com
	Proxy Port: 5026
	Destination user name: user1

Add a direct connection to IBM
This example shows how to add a direct connection to IBM.
```
esacli connectionSettings –x true
```

Add a proxy connection to IBM

This example shows how to add a proxy connection to IBM.

esacli connectionSettings set –x false –h proxy.ibm.com –p 5026 –u user1 –w password

Replace first connection with a proxy connection to IBM
This example shows how to replace the first connection with a proxy connection to IBM.
```
esacli connectionSettings set –x false –h proxy.ibm.com –p 5026 –u user1 –w password –r 1
```
Remove the first connection to IBM
This example shows how to remove the first connection to IBM.
```
esacli connectionSettings–k 1
```