nodes

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

Overview

Name	nodes
Type	Resource
Id	ovh.cluster_hadoop.nodes

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
billing_profile_name	string	Name of the billing profile attached to the node (100-small, 200-cpu-1, 220-cpu-3, 300-disk-1, 310-disk-3, 900-vm-1) (wire: billingProfileName)
hostname	string	Hostname of the node
ip	string (ipv4)	IP of the Node (example: 192.0.2.0)
is_removable	boolean	Whether or not the Node is removable (wire: isRemovable)
software_profile	string	Profile of the Node (ApplicationServer, BasicNode, ClouderaManager, MasterServer, SecondaryServer) (wire: softwareProfile)
state	string	State of the Node (available, delivered, toDeploy, unavailable)

list

Physical or Virtual Node

Name	Datatype	Description
billing_profile_name	string	Name of the billing profile attached to the node (100-small, 200-cpu-1, 220-cpu-3, 300-disk-1, 310-disk-3, 900-vm-1) (wire: billingProfileName)
hostname	string	Hostname of the node
ip	string (ipv4)	IP of the Node (example: 192.0.2.0)
is_removable	boolean	Whether or not the Node is removable (wire: isRemovable)
software_profile	string	Profile of the Node (ApplicationServer, BasicNode, ClouderaManager, MasterServer, SecondaryServer) (wire: softwareProfile)
state	string	State of the Node (available, delivered, toDeploy, unavailable)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	hostname, service_name		Get this object properties
list	select	service_name	software_profile, x_pagination_mode	Nodes of the Cluster
delete	delete	hostname, service_name		Remove this Node from the Cluster
decommission	exec	hostname, serviceName		Decommission the node and all the services on it
recommission	exec	hostname, serviceName		Recommission the node and all the services on it

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"}})
hostname	string	Hostname of the node
serviceName	string	The internal name of your cluster
service_name	string	The internal name of your cluster (wire: serviceName)
software_profile	string	Filter the value of softwareProfile property (=) (wire: softwareProfile)
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 this object properties

SELECT
billing_profile_name,
hostname,
ip,
is_removable,
software_profile,
state
FROM ovh.cluster_hadoop.nodes
WHERE hostname = '{{ hostname }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Nodes of the Cluster

SELECT
billing_profile_name,
hostname,
ip,
is_removable,
software_profile,
state
FROM ovh.cluster_hadoop.nodes
WHERE service_name = '{{ service_name }}' -- required
AND software_profile = '{{ software_profile }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

DELETE examples

delete

Remove this Node from the Cluster

DELETE FROM ovh.cluster_hadoop.nodes
WHERE hostname = '{{ hostname }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

decommission

Decommission the node and all the services on it

EXEC ovh.cluster_hadoop.nodes.decommission 
@hostname='{{ hostname }}' --required, 
@serviceName='{{ serviceName }}' --required
;

recommission

Recommission the node and all the services on it

EXEC ovh.cluster_hadoop.nodes.recommission 
@hostname='{{ hostname }}' --required, 
@serviceName='{{ serviceName }}' --required
;