Create Sddc Proxy | VMware Cloud Director OpenAPI

Create Sddc Proxy

Creates an SDDC proxy.

Request

URI

POST

https://{api_host}/cloudapi/1.0.0/sddcProxies

COPY

Request Body

The new SDDC proxy model.

SddcProxy of type(s) application/json

Required

{
    "name": "SDDC Proxy Sample Name",
    "id": "string",
    "sddcId": "urn:vcloud:sddc:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "enabled": false,
    "tenantVisible": false,
    "targetHost": "sampleVc.vmware.com",
    "active": false,
    "token": "string",
    "defaultProxy": false,
    "parentProxyId": "urn:vcloud:sddcProxy:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "uiUrl": "https://sampleVc.vmware.com"
}

string As .*[\S].*

name

Required

name

string

Optional

string

sddcId

Required

URN of the parent SDDC. This is not editable once the proxy has been created.

boolean

enabled

Optional

True if the proxy is enabled. Proxy can only be enabled/disabled by privileged users. A disabled proxy cannot be activated and thus, cannot be used. When a proxy is disabled, all active sessions are terminated.

boolean

tenantVisible

Optional

Whether this proxy has been published to tenants.

string

targetHost

Required

IP address or FQDN of the host being proxied. Lower case formatting will be applied to the value of the property. This is not editable once the proxy has been created.

boolean

active

Optional

True if the proxy is currently active for the user session associated with the request made to get the proxy. An inactive proxy cannot be used.

string

token

Optional

The generated read-only token that should be used as the password when using this proxy. To generate a new token, activate the proxy. The token is tied to the user session that activated the proxy. If the proxy is inactive, this value will be null.

boolean

defaultProxy

Optional

True if this is the default proxy for the parent SDDC. A proxy being the default for the SDDC means that this proxy's UI will be launched when the SDDC tile is clicked in the H5 Tenant UI of VCD. If no default proxy is set, clicking the SDDC tile will be a no-op.

string

parentProxyId

Optional

The URN of the parent proxy. If a proxy has a parent, the proxy is activated along with its parent and shares the token with its parent. Each proxy may only have one parent. A parent proxy cannot have a parent of its own.

string As uri As uri

uiUrl

Optional

The URL of the proxied component's UI endpoint. This is the URL that the browser tab will be pointed to when the proxy is launched via the H5 UI of VCD.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

202

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure

Availability

Added in 32.0

Deprecated in 34.0

With alternative: see

proxies