vracks

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

Overview

Name	vracks
Type	Resource
Id	ovh.vrack.vracks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Name of the vRack
service_name	string	Service name of your vRack on OVHcloud (wire: serviceName)
description	string	Description of the vRack
iam	object	IAM resource metadata

list

vrack

Name	Datatype	Description
name	string	Name of the vRack
service_name	string	Service name of your vRack on OVHcloud (wire: serviceName)
description	string	Description of the vRack
iam	object	IAM resource metadata

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get a vRack. Returns the name and description of the vRack.
list	select		iam_tags, x_pagination_mode	List vRacks. Returns the service names of the vRacks of the account.
update	update	service_name		Update a vRack. Updates the name or description of the vRack.
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 vrack
service_name	string	The internal name of your vrack (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 a vRack. Returns the name and description of the vRack.

SELECT
name,
service_name,
description,
iam
FROM ovh.vrack.vracks
WHERE service_name = '{{ service_name }}' -- required
;

list

List vRacks. Returns the service names of the vRacks of the account.

SELECT
name,
service_name,
description,
iam
FROM ovh.vrack.vracks
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Update a vRack. Updates the name or description of the vRack.

UPDATE ovh.vrack.vracks
SET 
description = '{{ description }}',
name = '{{ name }}'
WHERE 
service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

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.vrack.vracks.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.vrack.vracks.terminate 
@serviceName='{{ serviceName }}' --required
;