hcxes
Creates, updates, deletes, gets or lists a hcxes resource.
Overview​
| Name | hcxes |
| Type | Resource |
| Id | ovh.dedicated_cloud.hcxes |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
build | string | Build of the VMware Hybrid Cloud Extension |
state | string | State of the option (disabled, disabling, enabled, enabling, error, migrating, unknown) |
version | string | Version of the VMware Hybrid Cloud Extension |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Get the HCX option | |
disable | exec | serviceName | Disable HCX |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
serviceName | string | Domain of the service |
service_name | string | Domain of the service (wire: serviceName) |
SELECT examples​
- get
Get the HCX option
SELECT
build,
state,
version
FROM ovh.dedicated_cloud.hcxes
WHERE service_name = '{{ service_name }}' -- required
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- disable
Disable HCX
EXEC ovh.dedicated_cloud.hcxes.disable
@serviceName='{{ serviceName }}' --required
;