glue_records

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

Overview

Name	glue_records
Type	Resource
Id	ovh.domain.glue_records

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
host	string	Host of the glue record
ips	array	IP address

list

Glue record

Name	Datatype	Description
host	string	Host of the glue record
ips	array	IP address

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	host, service_name		Get this glue record
list	select	service_name	host, x_pagination_mode	List of glue records
create	insert	service_name, host, ips		Create a glue record
delete	delete	host, service_name		Delete the glue record
update	exec	host, serviceName, ips		Update the glue record

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"}})
host	string	Host
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)
host	string	Filter the value of host property
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 glue record

SELECT
host,
ips
FROM ovh.domain.glue_records
WHERE host = '{{ host }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List of glue records

SELECT
host,
ips
FROM ovh.domain.glue_records
WHERE service_name = '{{ service_name }}' -- required
AND host = '{{ host }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a glue record

INSERT INTO ovh.domain.glue_records (
host,
ips,
service_name
)
SELECT 
'{{ host }}' /* required */,
'{{ ips }}' /* 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: glue_records
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the glue_records resource.
  - name: host
    value: "{{ host }}"
    description: |
      Host of the glue record
  - name: ips
    value:
      - "{{ ips }}"
    description: |
      IP addresses of the glue record

DELETE examples

delete

Delete the glue record

DELETE FROM ovh.domain.glue_records
WHERE host = '{{ host }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

update

Update the glue record

EXEC ovh.domain.glue_records.update 
@host='{{ host }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"ips": "{{ ips }}"
}'
;