NSX-T Data Center REST API
Proxy (schema)
Proxy Configuration
Type to define the Proxy configuration.
| Name | Description | Type | Notes |
|---|---|---|---|
| _create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
| _create_user | ID of the user who created this resource | string | Readonly |
| _last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _last_modified_user | ID of the user who last modified this resource | string | Readonly |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _protection | Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. |
string | Readonly |
| _revision | Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | Readonly |
| certificate_id | Valid certificate ID 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 | |
| description | Description of this resource | string | Maximum length: 1024 Sortable |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| enabled | Flag to indicate if proxy is enabled. Flag to indicate if proxy is enabled. When set to true, a scheme, host and port must be provided. |
boolean | Required |
| host | FQDN or IP address of the proxy server Specify the fully qualified domain name, or ip address, of the proxy server. |
string | Required Format: hostname-or-ip |
| id | Unique identifier of this resource | string | Sortable |
| password | Password Specify the password used to authenticate with the proxy server, if required. |
secure_string | |
| port | Configured port for proxy Specify the port of the proxy server. |
int | Required Minimum: 0 Maximum: 65535 |
| resource_type | Must be set to the value Proxy | string | |
| scheme | The scheme accepted by the proxy server The scheme accepted by the proxy server. Specify one of HTTP and HTTPS. |
string | Required Enum: HTTP, HTTPS |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| test_connection_url | Test connection url Specify a url for connection testing when adding proxy config. https://www.vmware.com is used by default if not specified. |
string | Default: "https://www.vmware.com" |
| username | User name Specify the user name used to authenticate with the proxy server, if required. |
string |