name_servers

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

Overview

Name	name_servers
Type	Resource
Id	ovh.domain.name_servers

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	ID of the name server
host	string	Host of the name server
ip	string (ipv4)	IP address of the name server (example: 192.0.2.0)
is_used	boolean	isUsed flag of the name server (wire: isUsed)
to_delete	boolean	toDelete flag of the name server (wire: toDelete)

list

Full name server configuration

Name	Datatype	Description
id	integer	ID of the name server
host	string	Host of the name server
ip	string (ipv4)	IP address of the name server (example: 192.0.2.0)
is_used	boolean	isUsed flag of the name server (wire: isUsed)
to_delete	boolean	toDelete flag of the name server (wire: toDelete)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Get this name server configuration
list	select	service_name	x_pagination_mode	List of current name servers
create	insert	service_name, name_server		Add new name server
delete	delete	id, service_name		Delete a name server

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"}})
id	integer	Id
service_name	string	Service name (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 name server configuration

SELECT
id,
host,
ip,
is_used,
to_delete
FROM ovh.domain.name_servers
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List of current name servers

SELECT
id,
host,
ip,
is_used,
to_delete
FROM ovh.domain.name_servers
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Add new name server

INSERT INTO ovh.domain.name_servers (
name_server,
service_name
)
SELECT 
'{{ name_server }}' /* required */,
'{{ service_name }}'
RETURNING
id,
can_accelerate,
can_cancel,
can_relaunch,
comment,
creation_date,
domain,
done_date,
function,
last_update,
status,
todo_date,
type
;

Manifest

# Description fields are for documentation purposes
- name: name_servers
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the name_servers resource.
  - name: name_server
    description: |
      Name servers to create
    value:
      - host: "{{ host }}"
        ip: "{{ ip }}"

DELETE examples

delete

Delete a name server

DELETE FROM ovh.domain.name_servers
WHERE id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required
;