ovh_cloud_connects

Creates, updates, deletes, gets or lists an ovh_cloud_connects resource.

Overview

Name	ovh_cloud_connects
Type	Resource
Id	ovh.vrack.ovh_cloud_connects

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
ovh_cloud_connect	string (uuid)	ovhCloudConnect service name (wire: ovhCloudConnect)
vrack	string	vrack name

list

ovhCloudConnect in vrack

Name	Datatype	Description
ovh_cloud_connect	string (uuid)	ovhCloudConnect service name (wire: ovhCloudConnect)
vrack	string	vrack name

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	ovh_cloud_connect, service_name		Get a service. Returns the attached OVHcloud Connect service and its vRack.
list	select	service_name	x_pagination_mode	List services. Returns the identifiers of the OVHcloud Connect services attached to the vRack.
create	insert	service_name, ovh_cloud_connect		Attach a service. Attaches an OVHcloud Connect service to the vRack. Returns the task that performs it.
delete	delete	ovh_cloud_connect, service_name		Detach a service. Detaches the OVHcloud Connect service 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"}})
ovh_cloud_connect	string (uuid)	ovhCloudConnect service name (wire: ovhCloudConnect)
service_name	string	The internal name of your vrack (wire: serviceName)
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 service. Returns the attached OVHcloud Connect service and its vRack.

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

list

List services. Returns the identifiers of the OVHcloud Connect services attached to the vRack.

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

INSERT examples

create

Attach a service. Attaches an OVHcloud Connect service to the vRack. Returns the task that performs it.

INSERT INTO ovh.vrack.ovh_cloud_connects (
ovh_cloud_connect,
service_name
)
SELECT 
'{{ ovh_cloud_connect }}' /* 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: ovh_cloud_connects
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the ovh_cloud_connects resource.
  - name: ovh_cloud_connect
    value: "{{ ovh_cloud_connect }}"
    description: |
      ovhCloudConnect service name

DELETE examples

delete

Detach a service. Detaches the OVHcloud Connect service from the vRack. Returns the task that performs it.

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