vrack_services

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

Overview

Name	vrack_services
Type	Resource
Id	ovh.vrack.vrack_services

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
vrack	string	vrack name
vrack_services	string	vrackServices service name (wire: vrackServices)

list

vrackServices in vrack

Name	Datatype	Description
vrack	string	vrack name
vrack_services	string	vrackServices service name (wire: vrackServices)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name, vrack_services		Get a vRack Services. Returns the attached vRack Services and its vRack.
list	select	service_name	x_pagination_mode	List vRack Services. Returns the vRack Services attached to the vRack.
create	insert	service_name, vrack_services		Attach a vRack Services. Attaches a vRack Services to the vRack. Its subnets and Service Endpoints are then configured with the vRack Services API. Returns the task that performs it.
delete	delete	service_name, vrack_services		Detach a vRack Services. Detaches the vRack Services from the vRack. Returns the task that performs 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"}})
service_name	string	The internal name of your vrack (wire: serviceName)
vrack_services	string	vrackServices service name (wire: vrackServices)
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 Services. Returns the attached vRack Services and its vRack.

SELECT
vrack,
vrack_services
FROM ovh.vrack.vrack_services
WHERE service_name = '{{ service_name }}' -- required
AND vrack_services = '{{ vrack_services }}' -- required
;

list

List vRack Services. Returns the vRack Services attached to the vRack.

SELECT
vrack,
vrack_services
FROM ovh.vrack.vrack_services
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Attach a vRack Services. Attaches a vRack Services to the vRack. Its subnets and Service Endpoints are then configured with the vRack Services API. Returns the task that performs it.

INSERT INTO ovh.vrack.vrack_services (
vrack_services,
service_name
)
SELECT 
'{{ vrack_services }}' /* required */,
'{{ service_name }}'
RETURNING
id,
order_id,
service_name,
function,
last_update,
status,
target_domain,
todo_date
;

Manifest

# Description fields are for documentation purposes
- name: vrack_services
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the vrack_services resource.
  - name: vrack_services
    value: "{{ vrack_services }}"
    description: |
      vrackServices service name

DELETE examples

delete

Detach a vRack Services. Detaches the vRack Services from the vRack. Returns the task that performs it.

DELETE FROM ovh.vrack.vrack_services
WHERE service_name = '{{ service_name }}' --required
AND vrack_services = '{{ vrack_services }}' --required
;