nashas

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

Overview

Name	nashas
Type	Resource
Id	ovh.dedicated_nasha.nashas

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
custom_name	string	The name you give to the nas (wire: customName)
service_name	string	The storage service name (wire: serviceName)
can_create_partition	boolean	True, if partition creation is allowed on this nas HA (wire: canCreatePartition)
datacenter	string	area of nas
disk_type	string	the disk type of the nasHa (hdd, nvme, ssd) (wire: diskType)
iam	object	IAM resource metadata
ip	string (ipv4)	Access ip of nas (example: 192.0.2.0)
monitored	boolean	Send an email to customer if any issue is detected
zpool_capacity	integer	percentage of nas space used in % (wire: zpoolCapacity)
zpool_size	integer	the size of the nas (wire: zpoolSize)

list

Storage nas HA

Name	Datatype	Description
custom_name	string	The name you give to the nas (wire: customName)
service_name	string	The storage service name (wire: serviceName)
can_create_partition	boolean	True, if partition creation is allowed on this nas HA (wire: canCreatePartition)
datacenter	string	area of nas
disk_type	string	the disk type of the nasHa (hdd, nvme, ssd) (wire: diskType)
iam	object	IAM resource metadata
ip	string (ipv4)	Access ip of nas (example: 192.0.2.0)
monitored	boolean	Send an email to customer if any issue is detected
zpool_capacity	integer	percentage of nas space used in % (wire: zpoolCapacity)
zpool_size	integer	the size of the nas (wire: zpoolSize)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get this object properties
list	select		iam_tags, x_pagination_mode	List available services
update	update	service_name		Alter this object properties
change_contact	exec	serviceName		Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.
confirm_termination	exec	serviceName, token		Confirm service termination. Terminates the service with the token sent by email to the admin contact. A reason, a future use and a comment can be given.
terminate	exec	serviceName		Request service termination. Starts the termination of the service. The admin contact receives a token by email, to confirm with the confirmTermination call.

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	The internal name of your storage
service_name	string	The internal name of your storage (wire: serviceName)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
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
custom_name,
service_name,
can_create_partition,
datacenter,
disk_type,
iam,
ip,
monitored,
zpool_capacity,
zpool_size
FROM ovh.dedicated_nasha.nashas
WHERE service_name = '{{ service_name }}' -- required
;

list

List available services

SELECT
custom_name,
service_name,
can_create_partition,
datacenter,
disk_type,
iam,
ip,
monitored,
zpool_capacity,
zpool_size
FROM ovh.dedicated_nasha.nashas
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Alter this object properties

UPDATE ovh.dedicated_nasha.nashas
SET 
custom_name = '{{ custom_name }}',
monitored = {{ monitored }}
WHERE 
service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

change_contact

Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.

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

confirm_termination

Confirm service termination. Terminates the service with the token sent by email to the admin contact. A reason, a future use and a comment can be given.

EXEC ovh.dedicated_nasha.nashas.confirm_termination 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"commentary": "{{ commentary }}", 
"futureUse": "{{ futureUse }}", 
"reason": "{{ reason }}", 
"token": "{{ token }}"
}'
;

terminate

Request service termination. Starts the termination of the service. The admin contact receives a token by email, to confirm with the confirmTermination call.

EXEC ovh.dedicated_nasha.nashas.terminate 
@serviceName='{{ serviceName }}' --required
;