nodes

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

Overview

Name	nodes
Type	Resource
Id	ovh.nutanix.nodes

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
ahv_ip	string (ipv4)	Hypervisor IP (example: 192.0.2.0) (wire: ahvIp)
cvm_ip	string (ipv4)	Controler VM IP (example: 192.0.2.0) (wire: cvmIp)
possible_actions	array	Node possible actions (wire: possibleActions)
server	string	Name of the associated server
status	string	Node status (DEPLOYED, DEPLOYING, DEPLOY_CANCELLED, DEPLOY_FAILURE, UNDEPLOYED, UNDEPLOYING, UNDEPLOY_CANCELLED, UNDEPLOY_FAILURE, UNKNOWN)

list

Node details in a nutanix cluster

Name	Datatype	Description
ahv_ip	string (ipv4)	Hypervisor IP (example: 192.0.2.0) (wire: ahvIp)
cvm_ip	string (ipv4)	Controler VM IP (example: 192.0.2.0) (wire: cvmIp)
possible_actions	array	Node possible actions (wire: possibleActions)
server	string	Name of the associated server
status	string	Node status (DEPLOYED, DEPLOYING, DEPLOY_CANCELLED, DEPLOY_FAILURE, UNDEPLOYED, UNDEPLOYING, UNDEPLOY_CANCELLED, UNDEPLOY_FAILURE, UNKNOWN)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	server, service_name		Get a node details in a cluster
list	select	service_name		Get all nodes in a cluster
update	update	server, service_name, version		Reinstall a node in a cluster
deploy	exec	server, serviceName
terminate	exec	server, serviceName		Terminate a node

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"}})
server	string	Server
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)

SELECT examples

get

Get a node details in a cluster

SELECT
ahv_ip,
cvm_ip,
possible_actions,
server,
status
FROM ovh.nutanix.nodes
WHERE server = '{{ server }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Get all nodes in a cluster

SELECT
ahv_ip,
cvm_ip,
possible_actions,
server,
status
FROM ovh.nutanix.nodes
WHERE service_name = '{{ service_name }}' -- required
;

UPDATE examples

update

Reinstall a node in a cluster

UPDATE ovh.nutanix.nodes
SET 
version = '{{ version }}'
WHERE 
server = '{{ server }}' --required
AND service_name = '{{ service_name }}' --required
AND version = '{{ version }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

deploy

successful operation

EXEC ovh.nutanix.nodes.deploy 
@server='{{ server }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"ahvIp": "{{ ahvIp }}", 
"cvmIp": "{{ cvmIp }}", 
"version": "{{ version }}"
}'
;

terminate

Terminate a node

EXEC ovh.nutanix.nodes.terminate 
@server='{{ server }}' --required, 
@serviceName='{{ serviceName }}' --required
;