nsxts
Creates, updates, deletes, gets or lists a nsxts resource.
Overview​
| Name | nsxts |
| Type | Resource |
| Id | ovh.dedicated_cloud.nsxts |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
datacenters_state | array | Installation status on all datacenters (wire: datacentersState) |
state | string | State of the NSX-T option (disabled, disabling, enabled, enabling, error, migrating, unknown) |
url | string | Url of the NSX-T interface |
version | string | Version of the NSX-T |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Get the NSX-T option. Returns the state, version and URL of the NSX-T option, and its installation state on each datacenter. |
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"}}) |
service_name | string | Domain of the service (wire: serviceName) |
SELECT examples​
- get
Get the NSX-T option. Returns the state, version and URL of the NSX-T option, and its installation state on each datacenter.
SELECT
datacenters_state,
state,
url,
version
FROM ovh.dedicated_cloud.nsxts
WHERE service_name = '{{ service_name }}' -- required
;