vlans
Creates, updates, deletes, gets or lists a vlans resource.
Overview​
| Name | vlans |
| Type | Resource |
| Id | ovh.dedicated_cloud.vlans |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
name | string | |
vlan_id | integer | (wire: vlanId) |
routing_rate_limit | string | Speed in Mbps (wire: routingRateLimit) |
state | string | All states a Dedicated Cloud Vlan can be in (available, delivered, disabled, error, removing, reserved) |
type | string | This Dedicated Cloud vlan type (admin, free, paid) |
vlan_number | integer | (wire: vlanNumber) |
vLAN
| Name | Datatype | Description |
|---|---|---|
name | string | |
vlan_id | integer | (wire: vlanId) |
routing_rate_limit | string | Speed in Mbps (wire: routingRateLimit) |
state | string | All states a Dedicated Cloud Vlan can be in (available, delivered, disabled, error, removing, reserved) |
type | string | This Dedicated Cloud vlan type (admin, free, paid) |
vlan_number | integer | (wire: vlanNumber) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name, vlan_id | Get a VLAN | |
list | select | service_name | x_pagination_mode | List VLANs |
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 | Domain of the service (wire: serviceName) |
vlan_id | integer | (wire: vlanId) |
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 VLAN
SELECT
name,
vlan_id,
routing_rate_limit,
state,
type,
vlan_number
FROM ovh.dedicated_cloud.vlans
WHERE service_name = '{{ service_name }}' -- required
AND vlan_id = '{{ vlan_id }}' -- required
;
List VLANs
SELECT
name,
vlan_id,
routing_rate_limit,
state,
type,
vlan_number
FROM ovh.dedicated_cloud.vlans
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;