esacli supportProxySettings

Edit online

Use the esacli supportProxySettings command to set and display information that configures the Service and Support Proxy.

Synopsis

esacli supportProxySettings [-d [script]]

esacli supportProxySettings {–e false}

esacli supportProxySettings [-d [script]] [–e true] [–i interface] {–p port} 
[–u user] [–w password]

Description

The esacli supportProxySettings command sets and displays information that configures the Service and Support Proxy. 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 supportProxySettings values, follow these steps:

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

-e | --enable true or false

Specifies whether the service and support proxy is enabled.

-i | --interface any | name of interface

Specifies a network interface to use. Use the esacli interfaces command to list the names of the network interfaces. If this option is not specified, the Service and Support proxy will be configured with any interface.

-p | --port integer between 1 and 65535

Specifies a proxy server port.

-u | --userid user

Specifies a proxy user ID. If used, Basic HTTP authentication is enabled.

-w | --password password

Specifies a proxy password. If used, Basic HTTP authentication is enabled. The command will prompt for the password if the option but not the value is provided.

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}.
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.
56: Interface {interface} not valid. Reason: {reason}.

Examples

Lists service and support proxy settings

esacli supportProxySettings –d
  Service and support proxy
     Interface:                                       Any 
     Server port:                                     5555
     Require HTTP basic authentication:               true
     User name:                                       user11
     Password:                                        *********

Sets service and support proxy settings using any interface

esacli supportProxySettings -e true -p 5026

esacli supportProxySettings -e true -p 5026 -u user1 -w password

Sets service and support proxy settings with an interface name

esacli supportProxySettings -e true -i "eth0" -p 5026  -u user1 -w password

Sets service and support proxy settings using a list of numbers
```
esacli supportProxySettings  -e true -i "1,2" -p 5026 -u user1 -w password
```
These numbers were determined by running the esacli interfaces command.