Architecting a vCloud Availability for vCloud Director Solution : Appendix F – Undocumented HybridSettings vCloud API
   
Appendix F – Undocumented HybridSettings vCloud API
HybridSettingsType
Element: HybridSettings
Type: HybridSettingsType
Namespace: http://www.vmware.com/vcloud/v1.5
Description: Public URL and certificate of the Cloud Proxy endpoint.
Since: 5.6
Internal: Yes
Schema: hybrid.xsd
Media type(s): application/vnd.vmware.vcloud.hybridSettings+xml
Extends: ResourceType
XML Representation:
<HybridSettings xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string"/>
<CloudProxyBaseUri> xs:string </CloudProxyBaseUri>
<CloudProxyBaseUriPublicCertChain> xs:string </CloudProxyBaseUriPublicCertChain>
<CloudProxyBaseUriOverride> xs:string </CloudProxyBaseUriOverride>
<CloudProxyBaseUriPublicCertChainOverride> xs:string </CloudProxyBaseUriPublicCertChainOverride>
<CloudProxyFromCloudTunnelHost> xs:string </CloudProxyFromCloudTunnelHost>
<CloudProxyFromCloudTunnelHostOverride> xs:string </CloudProxyFromCloudTunnelHostOverride>
</HybridSettings>
Attribute
Type
Required
Modifiable
Since
Description
href
anyURI
No
Always
5.6
The URI of the entity.
type
string
No
Always
5.6
The MIME of the entity.
 
Element
Type
Required
Modifiable
Since
Description
CloudProxyBaseUri
string
No
none
5.6
Effective base URI for Cloud Proxy (wss) endpoint. By default, this value is the same as the base URI for the API endpoint. This value can be overridden by specifying CloudProxyBaseUriOverride.
CloudProxyBaseUriOverride
string
No
always
5.6
Base URI for Cloud Proxy (wss) endpoint. Leave empty to use the default.
CloudProxyBaseUriPublicCertChain
string
No
none
5.6
Effective SSL public certificate chain for the effective base URI for cloud proxy (wss) endpoint. The certificate chain is PEM encoded X.509 certificates. By default, this value is the same as the public certificate chain for the API endpoint. This value can be overridden by specifying CloudProxyBaseUriPublicCertChainOverride. This value will be empty if URI is overridden but the certificate is not.
CloudProxyBaseUriPublicCertChainOverride
string
No
always
5.6
SSL public certificate chain for the base URI for cloud proxy (wss) endpoint. The certificate chain must be PEM encoded X.509 certificates. A Base URI override must be specified if this value is included in a request.
CloudProxyFromCloudTunnelHost
string
No
none
6
IP address or hostname of the effective host used for from-the-cloud tunnels.
CloudProxyFromCloudTunnelHostOverride
string
No
none
6
IP address or hostname of the host used for from-the-cloud tunnels. Leave empty to use default.
Link
LinkType
No
none
5.6
A reference to an entity or operation associated with this object.
VCloudExtension
VCloudExtensionType
No
always
5.6
An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
 
 
GET /admin/hybrid/settings
Operation: GET /admin/hybrid/settings
Internal: Yes
Input parameters
Consume media type(s): None
Input type: None
Output parameters
current settings
Produce media type(s): application/vnd.vmware.vcloud.hybridSettings+xml
Output type: HybridSettingsType
 
PUT /admin/hybrid/settings
Operation: PUT /admin/hybrid/settings
Description: Updates settings
Internal: Yes
Input parameters
New settings
Consume media type(s): application/vnd.vmware.vcloud.hybridSettings+xml
Input type: HybridSettingsType
Output parameters
updated settings
Produce media type(s): application/vnd.vmware.vcloud.hybridSettings+xml
Output type: HybridSettingsType