domain_trusts

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

Overview

Name	domain_trusts
Type	Resource
Id	ovh.horizon_view.domain_trusts

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
domain_trust_id	integer	Domain trust id (wire: domainTrustId)
active_directory_ip	string (ipv4)	IP of your Active Directory (example: 192.0.2.0) (wire: activeDirectoryIP)
dns_1	string (ipv4)	IP of your first DNS (example: 192.0.2.0) (wire: dns1)
dns_2	string (ipv4)	IP of your second DNS (example: 192.0.2.0) (wire: dns2)
domain	string	Name of your private domain

list

List all Active Directories linked to your CDI Active Directory

Name	Datatype	Description
domain_trust_id	integer	Domain trust id (wire: domainTrustId)
active_directory_ip	string (ipv4)	IP of your Active Directory (example: 192.0.2.0) (wire: activeDirectoryIP)
dns_1	string (ipv4)	IP of your first DNS (example: 192.0.2.0) (wire: dns1)
dns_2	string (ipv4)	IP of your second DNS (example: 192.0.2.0) (wire: dns2)
domain	string	Name of your private domain

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain_trust_id, service_name		Get this object properties
list	select	service_name	x_pagination_mode	List all Active Directories linked to your CDI Active Directory
create	insert	service_name, active_directory_ip, domain		Link your Active Directory to your CDI Active Directory
add_child_domain	exec	domainTrustId, serviceName, activeDirectoryIP, domain, passphrase, serviceAccountPassword		Add a child domain for this domain.
add_domain_controller	exec	domainTrustId, serviceName, domain, domainControllerIp		Add a Domain Controller for this domain.
add_domain_user_on_composer	exec	domainTrustId, serviceName, domain, password, username		Add a domain user to add your desktop in your Active Directory
create_trust	exec	domainTrustId, serviceName, passphrase, serviceAccountPassword		Change Horizon View user password

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"}})
domainTrustId	integer	Domain trust id
domain_trust_id	integer	Domain trust id (wire: domainTrustId)
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
domain_trust_id,
active_directory_ip,
dns_1,
dns_2,
domain
FROM ovh.horizon_view.domain_trusts
WHERE domain_trust_id = '{{ domain_trust_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List all Active Directories linked to your CDI Active Directory

SELECT
domain_trust_id,
active_directory_ip,
dns_1,
dns_2,
domain
FROM ovh.horizon_view.domain_trusts
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Link your Active Directory to your CDI Active Directory

INSERT INTO ovh.horizon_view.domain_trusts (
active_directory_ip,
dns_1,
dns_2,
domain,
service_name
)
SELECT 
'{{ active_directory_ip }}' /* required */,
'{{ dns_1 }}',
'{{ dns_2 }}',
'{{ domain }}' /* required */,
'{{ service_name }}'
RETURNING
name,
task_id,
description,
last_modification_date,
progress,
state
;

Manifest

# Description fields are for documentation purposes
- name: domain_trusts
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the domain_trusts resource.
  - name: active_directory_ip
    value: "{{ active_directory_ip }}"
    description: |
      IP of your Active Directory
  - name: dns_1
    value: "{{ dns_1 }}"
    description: |
      IP of your first DNS
  - name: dns_2
    value: "{{ dns_2 }}"
    description: |
      IP of your second DNS
  - name: domain
    value: "{{ domain }}"
    description: |
      Domain of your active directory (for example domain.local)

Lifecycle Methods

EXEC variables use wire (API) names.

add_child_domain

Add a child domain for this domain.

EXEC ovh.horizon_view.domain_trusts.add_child_domain 
@domainTrustId='{{ domainTrustId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"activeDirectoryIP": "{{ activeDirectoryIP }}", 
"domain": "{{ domain }}", 
"passphrase": "{{ passphrase }}", 
"serviceAccountPassword": "{{ serviceAccountPassword }}"
}'
;

add_domain_controller

Add a Domain Controller for this domain.

EXEC ovh.horizon_view.domain_trusts.add_domain_controller 
@domainTrustId='{{ domainTrustId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"domain": "{{ domain }}", 
"domainControllerIp": "{{ domainControllerIp }}"
}'
;

add_domain_user_on_composer

Add a domain user to add your desktop in your Active Directory

EXEC ovh.horizon_view.domain_trusts.add_domain_user_on_composer 
@domainTrustId='{{ domainTrustId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"domain": "{{ domain }}", 
"password": "{{ password }}", 
"username": "{{ username }}"
}'
;

create_trust

Change Horizon View user password

EXEC ovh.horizon_view.domain_trusts.create_trust 
@domainTrustId='{{ domainTrustId }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"passphrase": "{{ passphrase }}", 
"serviceAccountPassword": "{{ serviceAccountPassword }}"
}'
;