datacenter_nsxt_edge_resiliences
Creates, updates, deletes, gets or lists a datacenter_nsxt_edge_resiliences resource.
Overview​
| Name | datacenter_nsxt_edge_resiliences |
| Type | Resource |
| Id | ovh.dedicated_cloud.datacenter_nsxt_edge_resiliences |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
state | string | State of the option (disabled, disabling, enabled, enabling, error, migrating, unknown) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | datacenter_id, nsxt_edge_id, service_name | Get the edge node resilience test | |
disable | exec | datacenterId, nsxtEdgeId, serviceName | Stop the resilience test. Stops the resilience test on the edge node. Returns a task to track progress. | |
enable | exec | datacenterId, nsxtEdgeId, serviceName | Start a resilience test. Puts the edge node in maintenance mode for the given duration, then reconnects it: 10 minutes to 24 hours, 1 hour by default. Returns a task to track progress. |
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"}}) |
datacenterId | integer | Id of the Datacenter |
datacenter_id | integer | Id of the Datacenter (wire: datacenterId) |
nsxtEdgeId | integer | Id of the NSX-T Edge |
nsxt_edge_id | integer | Id of the NSX-T Edge (wire: nsxtEdgeId) |
serviceName | string | Domain of the service |
service_name | string | Domain of the service (wire: serviceName) |
SELECT examples​
- get
Get the edge node resilience test
SELECT
state
FROM ovh.dedicated_cloud.datacenter_nsxt_edge_resiliences
WHERE datacenter_id = '{{ datacenter_id }}' -- required
AND nsxt_edge_id = '{{ nsxt_edge_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- disable
- enable
Stop the resilience test. Stops the resilience test on the edge node. Returns a task to track progress.
EXEC ovh.dedicated_cloud.datacenter_nsxt_edge_resiliences.disable
@datacenterId='{{ datacenterId }}' --required,
@nsxtEdgeId='{{ nsxtEdgeId }}' --required,
@serviceName='{{ serviceName }}' --required
;
Start a resilience test. Puts the edge node in maintenance mode for the given duration, then reconnects it: 10 minutes to 24 hours, 1 hour by default. Returns a task to track progress.
EXEC ovh.dedicated_cloud.datacenter_nsxt_edge_resiliences.enable
@datacenterId='{{ datacenterId }}' --required,
@nsxtEdgeId='{{ nsxtEdgeId }}' --required,
@serviceName='{{ serviceName }}' --required
@@json=
'{
"duration": {{ duration }}
}'
;