access_point_customer_networks

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

Overview

Name	access_point_customer_networks
Type	Resource
Id	ovh.horizon_view.access_point_customer_networks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Name of your network
customer_network_id	integer	Customer Network id (wire: customerNetworkId)
network	string	Customer network

list

You can reach from your virtual desktops, your customer network

Name	Datatype	Description
name	string	Name of your network
customer_network_id	integer	Customer Network id (wire: customerNetworkId)
network	string	Customer network

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	access_point_id, customer_network_id, service_name		Get this object properties
list	select	access_point_id, service_name	x_pagination_mode	You can reach from the Desktops your private network
create	insert	access_point_id, service_name, network		Add a new network
delete	delete	access_point_id, customer_network_id, service_name		Delete this Customer Network

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
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"}})
customer_network_id	integer	Customer Network id (wire: customerNetworkId)
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
name,
customer_network_id,
network
FROM ovh.horizon_view.access_point_customer_networks
WHERE access_point_id = '{{ access_point_id }}' -- required
AND customer_network_id = '{{ customer_network_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

You can reach from the Desktops your private network

SELECT
name,
customer_network_id,
network
FROM ovh.horizon_view.access_point_customer_networks
WHERE access_point_id = '{{ access_point_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Add a new network

INSERT INTO ovh.horizon_view.access_point_customer_networks (
network,
access_point_id,
service_name
)
SELECT 
'{{ network }}' /* required */,
'{{ access_point_id }}',
'{{ service_name }}'
RETURNING
name,
task_id,
description,
last_modification_date,
progress,
state
;

Manifest

# Description fields are for documentation purposes
- name: access_point_customer_networks
props:
  - name: access_point_id
    value: {{ access_point_id }}
    description: Required parameter for the access_point_customer_networks resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the access_point_customer_networks resource.
  - name: network
    value: "{{ network }}"
    description: |
      The private network you want to reach.

DELETE examples

delete

Delete this Customer Network

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