commercial_ranges
Creates, updates, deletes, gets or lists a commercial_ranges resource.
Overview​
| Name | commercial_ranges |
| Type | Resource |
| Id | ovh.dedicated_cloud.commercial_ranges |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
commercial_range_name | string | The name of this commercial range (wire: commercialRangeName) |
allowed_hypervisor_versions | array | The hypervisor versions compliant with this commercial Range (wire: allowedHypervisorVersions) |
allowed_network_roles | array | The list of NetworkRoles allowed for one user in this commercial range (wire: allowedNetworkRoles) |
dedicated_cloud_version | string | The name of the dedicated Cloud version associated to this commercial range (wire: dedicatedCloudVersion) |
range | string | The range of this Datacenter in this VMware on OVHcloud version |
Commercial ranges
| Name | Datatype | Description |
|---|---|---|
commercial_range_name | string | The name of this commercial range (wire: commercialRangeName) |
allowed_hypervisor_versions | array | The hypervisor versions compliant with this commercial Range (wire: allowedHypervisorVersions) |
allowed_network_roles | array | The list of NetworkRoles allowed for one user in this commercial range (wire: allowedNetworkRoles) |
dedicated_cloud_version | string | The name of the dedicated Cloud version associated to this commercial range (wire: dedicatedCloudVersion) |
range | string | The range of this Datacenter in this VMware on OVHcloud version |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | commercial_range_name | Get a commercial range. Returns the commercial range: allowed hypervisor versions, allowed network roles and related version. | |
list | select | x_pagination_mode | List commercial ranges |
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"}}) |
commercial_range_name | string | The name of this commercial range (wire: commercialRangeName) |
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 commercial range. Returns the commercial range: allowed hypervisor versions, allowed network roles and related version.
SELECT
commercial_range_name,
allowed_hypervisor_versions,
allowed_network_roles,
dedicated_cloud_version,
range
FROM ovh.dedicated_cloud.commercial_ranges
WHERE commercial_range_name = '{{ commercial_range_name }}' -- required
;
List commercial ranges
SELECT
commercial_range_name,
allowed_hypervisor_versions,
allowed_network_roles,
dedicated_cloud_version,
range
FROM ovh.dedicated_cloud.commercial_ranges
WHERE x_pagination_mode = '{{ x_pagination_mode }}'
;