horizon_views

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

Overview

Name	horizon_views
Type	Resource
Id	ovh.horizon_view.horizon_views

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Name of the datacenter
customer_interco_vlan_id	integer	Customer interco vlan allows you to communicate between your private infrastructure and your CDI infrastructure throw the vrack. (wire: customerIntercoVlanId)
datacenter_id	integer	Datacenter ids (wire: datacenterId)
service_name	string	Domain of your Horizon (wire: serviceName)
active_directory_ip	string (ipv4)	IP of the VDI Active Directory (example: 192.0.2.0) (wire: activeDirectoryIP)
admin_domain	string	Domain of the admin infrastructure (wire: adminDomain)
admin_network_next_hop	string	Next hop to contact the private admin network (wire: adminNetworkNextHop)
admin_private_network	string (ip-block)	Private network of the admin infrastructure (example: 192.0.2.0/24) (wire: adminPrivateNetwork)
customer_interco_ip	string (ipv4)	Customer interco IP allows you to communicate between your private infrastructure and your CDI infrastructure throw the vrack. (example: 192.0.2.0) (wire: customerIntercoIP)
customer_interco_mask	string (ipv4)	Customer interco netmask allows you to communicate between your private infrastructure and your CDI infrastructure throw the vrack. (example: 192.0.2.0) (wire: customerIntercoMask)
iam	object	IAM resource metadata

list

Cloud Desktop Infrastructure Datacenter

Name	Datatype	Description
name	string	Name of the datacenter
customer_interco_vlan_id	integer	Customer interco vlan allows you to communicate between your private infrastructure and your CDI infrastructure throw the vrack. (wire: customerIntercoVlanId)
datacenter_id	integer	Datacenter ids (wire: datacenterId)
service_name	string	Domain of your Horizon (wire: serviceName)
active_directory_ip	string (ipv4)	IP of the VDI Active Directory (example: 192.0.2.0) (wire: activeDirectoryIP)
admin_domain	string	Domain of the admin infrastructure (wire: adminDomain)
admin_network_next_hop	string	Next hop to contact the private admin network (wire: adminNetworkNextHop)
admin_private_network	string (ip-block)	Private network of the admin infrastructure (example: 192.0.2.0/24) (wire: adminPrivateNetwork)
customer_interco_ip	string (ipv4)	Customer interco IP allows you to communicate between your private infrastructure and your CDI infrastructure throw the vrack. (example: 192.0.2.0) (wire: customerIntercoIP)
customer_interco_mask	string (ipv4)	Customer interco netmask allows you to communicate between your private infrastructure and your CDI infrastructure throw the vrack. (example: 192.0.2.0) (wire: customerIntercoMask)
iam	object	IAM resource metadata

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
list	select		iam_tags, x_pagination_mode	Horizon View as a Service
confirm_termination	exec	serviceName, token		Confirm service termination. Terminates the service with the token sent by email to the admin contact. A reason, a future use and a comment can be given.
terminate	exec	serviceName		Request service termination. Starts the termination of the service. The admin contact receives a token by email, to confirm with the confirmTermination call.

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)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
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

Get this object properties

SELECT
name,
customer_interco_vlan_id,
datacenter_id,
service_name,
active_directory_ip,
admin_domain,
admin_network_next_hop,
admin_private_network,
customer_interco_ip,
customer_interco_mask,
iam
FROM ovh.horizon_view.horizon_views
WHERE service_name = '{{ service_name }}' -- required
;

list

Horizon View as a Service

SELECT
name,
customer_interco_vlan_id,
datacenter_id,
service_name,
active_directory_ip,
admin_domain,
admin_network_next_hop,
admin_private_network,
customer_interco_ip,
customer_interco_mask,
iam
FROM ovh.horizon_view.horizon_views
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

confirm_termination

Confirm service termination. Terminates the service with the token sent by email to the admin contact. A reason, a future use and a comment can be given.

EXEC ovh.horizon_view.horizon_views.confirm_termination 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"commentary": "{{ commentary }}", 
"futureUse": "{{ futureUse }}", 
"reason": "{{ reason }}", 
"token": "{{ token }}"
}'
;

terminate

Request service termination. Starts the termination of the service. The admin contact receives a token by email, to confirm with the confirmTermination call.

EXEC ovh.horizon_view.horizon_views.terminate 
@serviceName='{{ serviceName }}' --required
;