Skip to main content

dedicated_horizons

Creates, updates, deletes, gets or lists a dedicated_horizons resource.

Overview​

Namededicated_horizons
TypeResource
Idovh.horizon_view.dedicated_horizons

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
private_cloud_namestringYour Horizon Dedicated Cloud (wire: privateCloudName)
master_zonestringThe location of your administration servers in our datacenter (Beauharnois, Roubaix, Strasbourg) (wire: masterZone)
private_cloud_zonestringThe location of your datacenter (Beauharnois, Roubaix, Strasbourg) (wire: privateCloudZone)
public_urlstringUrl of your Dedicated Horizon (wire: publicUrl)
statestringCurrent state of your Dedicated Horizon (available, creating, delivered, disabled, error, reserved)
storage_acceleratorbooleanView Storage Accelerator for Vcenter (wire: storageAccelerator)
versionstringVersion of your Dedicated Horizon

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectservice_nameGet this object properties
disable_storage_acceleratorexecserviceNameDisable the View Storage Accelerator option on VCenter
enable_storage_acceleratorexecserviceNameEnable 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.

NameDatatypeDescription
api_hoststringThe 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"}})
serviceNamestringDomain of the service
service_namestringDomain of the service (wire: serviceName)

SELECT examples​

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 the View Storage Accelerator option on VCenter

EXEC ovh.horizon_view.dedicated_horizons.disable_storage_accelerator
@serviceName='{{ serviceName }}' --required
;