domain_services

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

Overview

Name	domain_services
Type	Resource
Id	ovh.pack_xdsl.domain_services

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	pack_name		List the domain services of an xDSL pack. Returns the domain names ordered or transferred as a service of the pack.
create	insert	pack_name, action, domain, tld		Create a domain service in an xDSL pack. Orders, transfers or triggers the given action on a domain with its TLD, using the auth code for a transfer. Returns the task that performs it.

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"}})
pack_name	string	The internal name of your pack (wire: packName)

SELECT examples

list

List the domain services of an xDSL pack. Returns the domain names ordered or transferred as a service of the pack.

SELECT
value
FROM ovh.pack_xdsl.domain_services
WHERE pack_name = '{{ pack_name }}' -- required
;

INSERT examples

create

Create a domain service in an xDSL pack. Orders, transfers or triggers the given action on a domain with its TLD, using the auth code for a transfer. Returns the task that performs it.

INSERT INTO ovh.pack_xdsl.domain_services (
action,
auth_info,
domain,
tld,
pack_name
)
SELECT 
'{{ action }}' /* required */,
'{{ auth_info }}',
'{{ domain }}' /* required */,
'{{ tld }}' /* required */,
'{{ pack_name }}'
RETURNING
id,
function,
status,
update_date
;

Manifest

# Description fields are for documentation purposes
- name: domain_services
props:
  - name: pack_name
    value: "{{ pack_name }}"
    description: Required parameter for the domain_services resource.
  - name: action
    value: "{{ action }}"
    description: |
      Domain action
    valid_values: ['create', 'trade', 'transfer']
  - name: auth_info
    value: "{{ auth_info }}"
    description: |
      Needed for transfer from another registrar
  - name: domain
    value: "{{ domain }}"
    description: |
      Domain name
  - name: tld
    value: "{{ tld }}"
    description: |
      TLD of the domain