dedicated_connects
Creates, updates, deletes, gets or lists a dedicated_connects resource.
Overview​
| Name | dedicated_connects |
| Type | Resource |
| Id | ovh.vrack.dedicated_connects |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
name | string | A name for your dedicatedConnect link |
vrack dedicated connect interface
| Name | Datatype | Description |
|---|---|---|
name | string | A name for your dedicatedConnect link |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | name, service_name | Get a link. Returns the name of the Dedicated Connect link. | |
list | select | service_name | x_pagination_mode | List links. Returns the names of the Dedicated Connect links attached to the vRack. |
update | update | name, service_name | Update a link. Updates the name of the Dedicated Connect link. |
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"}}) |
name | string | A name for your dedicatedConnect link |
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
- list
Get a link. Returns the name of the Dedicated Connect link.
SELECT
name
FROM ovh.vrack.dedicated_connects
WHERE name = '{{ name }}' -- required
AND service_name = '{{ service_name }}' -- required
;
List links. Returns the names of the Dedicated Connect links attached to the vRack.
SELECT
name
FROM ovh.vrack.dedicated_connects
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;
UPDATE examples​
- update
Update a link. Updates the name of the Dedicated Connect link.
UPDATE ovh.vrack.dedicated_connects
SET
name = '{{ name }}'
WHERE
name = '{{ name }}' --required
AND service_name = '{{ service_name }}' --required;