dedicated_horizons
Creates, updates, deletes, gets or lists a dedicated_horizons resource.
Overview​
| Name | dedicated_horizons |
| Type | Resource |
| Id | ovh.horizon_view.dedicated_horizons |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
private_cloud_name | string | Your Horizon Dedicated Cloud (wire: privateCloudName) |
master_zone | string | The location of your administration servers in our datacenter (Beauharnois, Roubaix, Strasbourg) (wire: masterZone) |
private_cloud_zone | string | The location of your datacenter (Beauharnois, Roubaix, Strasbourg) (wire: privateCloudZone) |
public_url | string | Url of your Dedicated Horizon (wire: publicUrl) |
state | string | Current state of your Dedicated Horizon (available, creating, delivered, disabled, error, reserved) |
storage_accelerator | boolean | View Storage Accelerator for Vcenter (wire: storageAccelerator) |
version | string | Version of your Dedicated Horizon |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Get this object properties | |
disable_storage_accelerator | exec | serviceName | Disable the View Storage Accelerator option on VCenter | |
enable_storage_accelerator | exec | serviceName | Enable the View Storage Accelerator option on VCenter |
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"}}) |
serviceName | string | Domain of the service |
service_name | string | Domain of the service (wire: serviceName) |
SELECT examples​
- get
Get this object properties
SELECT
private_cloud_name,
master_zone,
private_cloud_zone,
public_url,
state,
storage_accelerator,
version
FROM ovh.horizon_view.dedicated_horizons
WHERE service_name = '{{ service_name }}' -- required
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- disable_storage_accelerator
- enable_storage_accelerator
Disable the View Storage Accelerator option on VCenter
EXEC ovh.horizon_view.dedicated_horizons.disable_storage_accelerator
@serviceName='{{ serviceName }}' --required
;
Enable the View Storage Accelerator option on VCenter
EXEC ovh.horizon_view.dedicated_horizons.enable_storage_accelerator
@serviceName='{{ serviceName }}' --required
;