Executed when: Configuring the proxy.

Configures the connection with the proxy server.

clusterctl proxy set --host <host> [--port <port>] [--protocol <protocol>] [--certificate <cert>] [--user <user>] [--password <pwd>]

See below for a description of each parameter.

For example:

$ sudo clusterctl proxy set --host myproxy --user bob --password demo
The proxy configuration has been set

To make configuration changes effective, run the clusterctl solution deploy command and redeploy all deployed solutions.

--host <host>

Configure the <host> proxy, where <host> is the IP or hostname of the proxy. 

Mandatory: Yes.

--port <port>

Configure <port> as the proxy port number. 

Mandatory: No. When omitted, this parameter defaults to 443.

--user <user>, --password <pwd>

Authenticate in the proxy with the <user> username and the <pwd>  password.

Mandatory: No. See the following table for the supported combinations of the --user and --password options.

--user

--password

Action

<user>

<pwd>        

Set <user> and <pwd> as proxy basic authentication credentials.

<user>


Prompt for the password of the <user> user.


<pwd>

Throw an error.



Assume that the proxy requires no authentication.

--protocol <protocol>, --certificate <cert>

Authenticate in the proxy with:

  • The <protocol> protocol, where <protocol> is either http or https.
  • The <cert> certificate, where <cert> is the path of a plaintext file in PEM format. The certificate should include a SAN matching the host.

Mandatory: No. See the following table for the supported combinations of the --protocol and the --certificate options.

--protocol

--certificate

Action

http           

<cert>

Throw an error.

http


Set an HTTP connection.

https

<cert>

Set an HTTPS connection with the <cert> certificate.

https


Set an HTTPS connection with the default certificate of the operating system.


<cert>

Set an HTTPS connection with the <cert> certificate.



Set an HTTPS connection with the default certificate of the operating system.