datacenter_clusters

Creates, updates, deletes, gets or lists a datacenter_clusters resource.

Overview

Name	datacenter_clusters
Type	Resource
Id	ovh.dedicated_cloud.datacenter_clusters

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Name of the cluster
cluster_id	integer	Id of the cluster (wire: clusterId)
vmware_cluster_id	string	The VMware MoRef of the cluster (wire: vmwareClusterId)
autoscale	object	AutoScale associated to this cluster
drs_mode	string	Drs mode of the cluster (fullyAutomated, manual, partiallyAutomated) (wire: drsMode)
drs_status	string	Drs status of the cluster (disabled, enabled, unknown) (wire: drsStatus)
evc_mode	string	Evc mode of the cluster (wire: evcMode)
ha_status	string	High availability status of the cluster (disabled, enabled, unknown) (wire: haStatus)

list

Cluster

Name	Datatype	Description
name	string	Name of the cluster
cluster_id	integer	Id of the cluster (wire: clusterId)
vmware_cluster_id	string	The VMware MoRef of the cluster (wire: vmwareClusterId)
autoscale	object	AutoScale associated to this cluster
drs_mode	string	Drs mode of the cluster (fullyAutomated, manual, partiallyAutomated) (wire: drsMode)
drs_status	string	Drs status of the cluster (disabled, enabled, unknown) (wire: drsStatus)
evc_mode	string	Evc mode of the cluster (wire: evcMode)
ha_status	string	High availability status of the cluster (disabled, enabled, unknown) (wire: haStatus)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cluster_id, datacenter_id, service_name		Get a cluster. Returns the cluster: name, VMware MoRef, DRS and HA status, EVC mode and autoscale settings.
list	select	datacenter_id, service_name	x_pagination_mode	List clusters
delete_nsxt	exec	clusterId, datacenterId, serviceName		Delete the cluster NSX-T configuration. Removes the NSX-T configuration from the cluster. Returns a task to track progress.
nsxt	exec	clusterId, datacenterId, serviceName		Configure NSX-T on a cluster
update_nsxt	exec	clusterId, datacenterId, serviceName		Reapply NSX-T on a cluster. Reapplies the NSX-T configuration of the cluster. 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"}})
clusterId	integer	Id of the cluster
cluster_id	integer	Id of the cluster (wire: clusterId)
datacenterId	integer	Id of the Datacenter
datacenter_id	integer	Id of the Datacenter (wire: datacenterId)
serviceName	string	Domain of the service
service_name	string	Domain of the service (wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a cluster. Returns the cluster: name, VMware MoRef, DRS and HA status, EVC mode and autoscale settings.

SELECT
name,
cluster_id,
vmware_cluster_id,
autoscale,
drs_mode,
drs_status,
evc_mode,
ha_status
FROM ovh.dedicated_cloud.datacenter_clusters
WHERE cluster_id = '{{ cluster_id }}' -- required
AND datacenter_id = '{{ datacenter_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List clusters

SELECT
name,
cluster_id,
vmware_cluster_id,
autoscale,
drs_mode,
drs_status,
evc_mode,
ha_status
FROM ovh.dedicated_cloud.datacenter_clusters
WHERE datacenter_id = '{{ datacenter_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

delete_nsxt

Delete the cluster NSX-T configuration. Removes the NSX-T configuration from the cluster. Returns a task to track progress.

EXEC ovh.dedicated_cloud.datacenter_clusters.delete_nsxt 
@clusterId='{{ clusterId }}' --required, 
@datacenterId='{{ datacenterId }}' --required, 
@serviceName='{{ serviceName }}' --required
;

nsxt

Configure NSX-T on a cluster

EXEC ovh.dedicated_cloud.datacenter_clusters.nsxt 
@clusterId='{{ clusterId }}' --required, 
@datacenterId='{{ datacenterId }}' --required, 
@serviceName='{{ serviceName }}' --required
;

update_nsxt

Reapply NSX-T on a cluster. Reapplies the NSX-T configuration of the cluster. Returns a task to track progress.

EXEC ovh.dedicated_cloud.datacenter_clusters.update_nsxt 
@clusterId='{{ clusterId }}' --required, 
@datacenterId='{{ datacenterId }}' --required, 
@serviceName='{{ serviceName }}' --required
;