access_points

Creates, updates, deletes, gets or lists an access_points resource.

Overview

Name	access_points
Type	Resource
Id	ovh.horizon_view.access_points

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
access_point_id	integer	Pool id (wire: accessPointId)
port_group_id	string	Port group id (wire: portGroupId)
dhcp_netmask	string (ipv4)	DHCP netmask in this port group (example: 192.0.2.0) (wire: dhcpNetmask)
dhcp_network	string (ipv4)	DHCP network in this port group (example: 192.0.2.0) (wire: dhcpNetwork)
external_url	string	External url of your access point (wire: externalUrl)
interco_next_hop	string (ipv4)	Next hop IP to reach virtual desktops network for public Access Point (example: 192.0.2.0) (wire: intercoNextHop)
interco_private_next_hop	string (ipv4)	Next hop IP to reach virtual desktops network for private Access Point (example: 192.0.2.0) (wire: intercoPrivateNextHop)
state	string	Network state (available, creating, delivered, disabled, error, reserved)
two_fa	boolean	Two factor authentication (wire: twoFA)
type	string	Pool type (hybridPool, privatePool, publicPool)

list

All informations about access point

Name	Datatype	Description
access_point_id	integer	Pool id (wire: accessPointId)
port_group_id	string	Port group id (wire: portGroupId)
dhcp_netmask	string (ipv4)	DHCP netmask in this port group (example: 192.0.2.0) (wire: dhcpNetmask)
dhcp_network	string (ipv4)	DHCP network in this port group (example: 192.0.2.0) (wire: dhcpNetwork)
external_url	string	External url of your access point (wire: externalUrl)
interco_next_hop	string (ipv4)	Next hop IP to reach virtual desktops network for public Access Point (example: 192.0.2.0) (wire: intercoNextHop)
interco_private_next_hop	string (ipv4)	Next hop IP to reach virtual desktops network for private Access Point (example: 192.0.2.0) (wire: intercoPrivateNextHop)
state	string	Network state (available, creating, delivered, disabled, error, reserved)
two_fa	boolean	Two factor authentication (wire: twoFA)
type	string	Pool type (hybridPool, privatePool, publicPool)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	access_point_id, service_name		Get this object properties
list	select	service_name	x_pagination_mode	Pool associated with this Datacenter
create	insert	service_name, pool_type		Add new access point to create a new network
delete	delete	access_point_id, service_name		Delete this access point
change_session_timeout	exec	accessPointId, serviceName, expiration		Manage your session Timeout on Unified Access Gateway
disable_two_fa	exec	accessPointId, serviceName		Disable two factor authentication on your pool
disable_windows_username_option	exec	accessPointId, serviceName		Disable windows Username option on Unified Access Gateway
enable_two_fa	exec	accessPointId, serviceName, radiusIp, secret		Enable two factor authentication on your pool
enable_windows_username_option	exec	accessPointId, serviceName		Enable windows Username option on Unified Access Gateway

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
accessPointId	integer	Pool id
access_point_id	integer	Pool id (wire: accessPointId)
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)
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
access_point_id,
port_group_id,
dhcp_netmask,
dhcp_network,
external_url,
interco_next_hop,
interco_private_next_hop,
state,
two_fa,
type
FROM ovh.horizon_view.access_points
WHERE access_point_id = '{{ access_point_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Pool associated with this Datacenter

SELECT
access_point_id,
port_group_id,
dhcp_netmask,
dhcp_network,
external_url,
interco_next_hop,
interco_private_next_hop,
state,
two_fa,
type
FROM ovh.horizon_view.access_points
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Add new access point to create a new network

INSERT INTO ovh.horizon_view.access_points (
pool_type,
private_block,
private_vlan,
vrouter_pool_public_ip,
service_name
)
SELECT 
'{{ pool_type }}' /* required */,
'{{ private_block }}',
{{ private_vlan }},
'{{ vrouter_pool_public_ip }}',
'{{ service_name }}'
RETURNING
name,
task_id,
description,
last_modification_date,
progress,
state
;

Manifest

# Description fields are for documentation purposes
- name: access_points
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the access_points resource.
  - name: pool_type
    value: "{{ pool_type }}"
    description: |
      The type of pool you want to deploy.
    valid_values: ['hybridPool', 'privatePool', 'publicPool']
  - name: private_block
    value: "{{ private_block }}"
    description: |
      You can customize your pool by choosing the private network (Ex : 10.0.0.0/16)
  - name: private_vlan
    value: {{ private_vlan }}
    description: |
      You can customize your pool by choosing its private Vlan ID. (smaller than 4095)
  - name: vrouter_pool_public_ip
    value: "{{ vrouter_pool_public_ip }}"
    description: |
      You need to use a public Ip if you want to deploy a public pool.

DELETE examples

delete

Delete this access point

DELETE FROM ovh.horizon_view.access_points
WHERE access_point_id = '{{ access_point_id }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_session_timeout

Manage your session Timeout on Unified Access Gateway

EXEC ovh.horizon_view.access_points.change_session_timeout 
@accessPointId='{{ accessPointId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"expiration": {{ expiration }}, 
"onSingleAP": "{{ onSingleAP }}"
}'
;

disable_two_fa

Disable two factor authentication on your pool

EXEC ovh.horizon_view.access_points.disable_two_fa 
@accessPointId='{{ accessPointId }}' --required, 
@serviceName='{{ serviceName }}' --required
;

disable_windows_username_option

Disable windows Username option on Unified Access Gateway

EXEC ovh.horizon_view.access_points.disable_windows_username_option 
@accessPointId='{{ accessPointId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"onSingleAP": "{{ onSingleAP }}"
}'
;

enable_two_fa

Enable two factor authentication on your pool

EXEC ovh.horizon_view.access_points.enable_two_fa 
@accessPointId='{{ accessPointId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"onSingleAP": "{{ onSingleAP }}", 
"radiusIp": "{{ radiusIp }}", 
"secret": "{{ secret }}"
}'
;

enable_windows_username_option

Enable windows Username option on Unified Access Gateway

EXEC ovh.horizon_view.access_points.enable_windows_username_option 
@accessPointId='{{ accessPointId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"onSingleAP": "{{ onSingleAP }}"
}'
;