netapps

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

Overview

Name	netapps
Type	Resource
Id	ovh.storage.netapps

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Service ID
name	string	Service name
created_at	string (date-time)	Service creation date (wire: createdAt)
iam	object	IAM resource metadata
performance_level	string	Service performance level (premium) (wire: performanceLevel)
product	string	Product name
quota	integer	Service quota in GiB
region	string	Service region (ca-east-bhs, eu-west-gra, eu-west-lim, eu-west-rbx, eu-west-sbg, us-east-vin)
status	string	Service status (creating, deleted, deleting, reopening, running, suspended, suspending, updating)

list

A service

Name	Datatype	Description
id	string (uuid)	Service ID
name	string	Service name
created_at	string (date-time)	Service creation date (wire: createdAt)
iam	object	IAM resource metadata
performance_level	string	Service performance level (premium) (wire: performanceLevel)
product	string	Product name
quota	integer	Service quota in GiB
region	string	Service region (ca-east-bhs, eu-west-gra, eu-west-lim, eu-west-rbx, eu-west-sbg, us-east-vin)
status	string	Service status (creating, deleted, deleting, reopening, running, suspended, suspending, updating)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Returns the service, including its region, performance level, quota and status.
list	select		iam_tags	List Enterprise File Storage services
update	update	service_name, name		Updates the service name, the only property that can be changed. The change applies immediately, whatever the service status.
change_contact	exec	serviceName		Starts the change of the admin, tech or billing contact and returns the request IDs.
confirm_termination	exec	serviceName, token		Confirms the termination with the emailed token and records your reason.
terminate	exec	serviceName		Emails a termination token to the admin contact, to use with Confirm service termination.

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 (uuid)	Service name
service_name	string (uuid)	Service name (wire: serviceName)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)

SELECT examples

get

Returns the service, including its region, performance level, quota and status.

SELECT
id,
name,
created_at,
iam,
performance_level,
product,
quota,
region,
status
FROM ovh.storage.netapps
WHERE service_name = '{{ service_name }}' -- required
;

list

List Enterprise File Storage services

SELECT
id,
name,
created_at,
iam,
performance_level,
product,
quota,
region,
status
FROM ovh.storage.netapps
WHERE iam_tags = '{{ iam_tags }}'
;

UPDATE examples

update

Updates the service name, the only property that can be changed. The change applies immediately, whatever the service status.

UPDATE ovh.storage.netapps
SET 
name = '{{ name }}'
WHERE 
service_name = '{{ service_name }}' --required
AND name = '{{ name }}' --required
RETURNING
id,
name,
created_at,
performance_level,
product,
quota,
region,
status;

Lifecycle Methods

EXEC variables use wire (API) names.

change_contact

Starts the change of the admin, tech or billing contact and returns the request IDs.

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

confirm_termination

Confirms the termination with the emailed token and records your reason.

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

terminate

Emails a termination token to the admin contact, to use with Confirm service termination.

EXEC ovh.storage.netapps.terminate 
@serviceName='{{ serviceName }}' --required
;