clusters

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

Overview

Name	clusters
Type	Resource
Id	ovh.nutanix.clusters

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
service_name	string	Cluster name (wire: serviceName)
allowed_redundancy_factor	array	Available redundancy Factor (wire: allowedRedundancyFactor)
available_versions	array	Available versions to install (wire: availableVersions)
iam	object	IAM resource metadata
status	string	Current cluster's status (Active, Deploying, Error)
target_spec	object	Target Spec after deployment (wire: targetSpec)

list

Nutanix Cluster State

Name	Datatype	Description
service_name	string	Cluster name (wire: serviceName)
allowed_redundancy_factor	array	Available redundancy Factor (wire: allowedRedundancyFactor)
available_versions	array	Available versions to install (wire: availableVersions)
iam	object	IAM resource metadata
status	string	Current cluster's status (Active, Deploying, Error)
target_spec	object	Target Spec after deployment (wire: targetSpec)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get nutanix cluster info
list	select		iam_tags, x_pagination_mode	Get list of owned Nutanix Clusters
update	update	service_name	redeploycluster, scale_out	Update nutanix cluster info
change_contact	exec	serviceName		Launch a contact change procedure
confirm_termination	exec	serviceName, token		Confirm service termination
terminate	exec	serviceName		Ask for the termination of your service
update_vrack	exec	serviceName

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	Service name
service_name	string	Service name (wire: serviceName)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
redeploycluster	boolean	I am aware that I am going to make changes that will reinstall my cluster
scale_out	boolean	I am aware that I am going to make changes that will scale-out my cluster (wire: scaleOut)
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 nutanix cluster info

SELECT
service_name,
allowed_redundancy_factor,
available_versions,
iam,
status,
target_spec
FROM ovh.nutanix.clusters
WHERE service_name = '{{ service_name }}' -- required
;

list

Get list of owned Nutanix Clusters

SELECT
service_name,
allowed_redundancy_factor,
available_versions,
iam,
status,
target_spec
FROM ovh.nutanix.clusters
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Update nutanix cluster info

UPDATE ovh.nutanix.clusters
SET 
dataservice_ip = '{{ dataservice_ip }}',
erasure_coding = {{ erasure_coding }},
gateway_cidr = '{{ gateway_cidr }}',
infra_vlan_number = {{ infra_vlan_number }},
install_prism_central = {{ install_prism_central }},
nodes = '{{ nodes }}',
prism_central = '{{ prism_central }}',
prism_element_vip = '{{ prism_element_vip }}',
redundancy_factor = {{ redundancy_factor }},
version = '{{ version }}'
WHERE 
service_name = '{{ service_name }}' --required
AND redeploycluster = {{ redeploycluster}}
AND scale_out = {{ scale_out}}
RETURNING
service_name,
allowed_redundancy_factor,
available_versions,
status,
target_spec;

Lifecycle Methods

EXEC variables use wire (API) names.

change_contact

Launch a contact change procedure

EXEC ovh.nutanix.clusters.change_contact 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"contactAdmin": "{{ contactAdmin }}", 
"contactBilling": "{{ contactBilling }}", 
"contactTech": "{{ contactTech }}"
}'
;

confirm_termination

Confirm service termination

EXEC ovh.nutanix.clusters.confirm_termination 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"commentary": "{{ commentary }}", 
"commentaryFutureUse": "{{ commentaryFutureUse }}", 
"commentaryReason": "{{ commentaryReason }}", 
"futureUse": "{{ futureUse }}", 
"reason": "{{ reason }}", 
"token": "{{ token }}"
}'
;

terminate

Ask for the termination of your service

EXEC ovh.nutanix.clusters.terminate 
@serviceName='{{ serviceName }}' --required
;

update_vrack

successful operation

EXEC ovh.nutanix.clusters.update_vrack 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"vrackName": "{{ vrackName }}"
}'
;