InlineTelemetryProxy1

JSON Example

{
    "certificate_id": "string",
    "hostname": "string",
    "password": "string",
    "port": 0,
    "scheme": "string",
    "test_connection_url": "string",
    "username": "string"
}

string

certificate_id

Optional

Certificate ID with a valid certificate, procured from trust-management API. If the scheme property is set to HTTPS, certificate_id is verified if specified.

string As hostname-or-ip As hostname-or-ip

hostname

Required

Specify the fully qualified domain name, or ip address, of the proxy server.

string

password

Optional

Specify the password used to authenticate with the proxy server, if required. A GET call on /telemetry/config returns a non-meaningful password to maintain security. To change the password to a new value, issue a PUT call after updating this field. To remove the password, issue a PUT call after emptying this field. To retain a previously set password, issue a PUT call keeping the non-meaningful value obtained from the GET call.

integer As int32 As int32

port

Required

Specify the port of the proxy server.

string

scheme

Required

The scheme accepted by the proxy server. Specify one of HTTP and HTTPS.

Possible values are : HTTP, HTTPS,

string

test_connection_url

Optional

Constraints: default: https://www.vmware.com

Specify a url for connection testing when adding proxy config. https://www.vmware.com is used by default if not specified.

string

username

Optional

Specify the user name used to authenticate with the proxy server, if required.

Used By

TelemetryProxy