zone_dyn_host_logins

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

Overview

Name	zone_dyn_host_logins
Type	Resource
Id	ovh.domain.zone_dyn_host_logins

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
login	string	Login name
sub_domain	string	Login sub-domain (wire: subDomain)
zone	string	Login zone

list

DNS zone dynHost login

Name	Datatype	Description
login	string	Login name
sub_domain	string	Login sub-domain (wire: subDomain)
zone	string	Login zone

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	login, zone_name		Returns a DynHost login: its name and the subdomain it can update.
list	select	zone_name	login, sub_domain, x_pagination_mode	Returns the DynHost logins of the zone. Can be filtered by login and subdomain.
create	insert	zone_name, login_suffix, password, sub_domain		Creates a login named from the zone name and a suffix. The subdomain * allows all subdomains.
update	update	login, zone_name		Updates the subdomain a DynHost login is allowed to update.
delete	delete	login, zone_name		Deletes a DynHost login from the zone.
change_password	exec	login, zoneName, password		Sets a new password for a DynHost login.

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"}})
login	string	Login
zoneName	string	Zone name
zone_name	string	Zone name (wire: zoneName)
login	string	Filter the value of login property (ilike)
sub_domain	string	Filter the value of subDomain property (ilike) (wire: subDomain)
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

Returns a DynHost login: its name and the subdomain it can update.

SELECT
login,
sub_domain,
zone
FROM ovh.domain.zone_dyn_host_logins
WHERE login = '{{ login }}' -- required
AND zone_name = '{{ zone_name }}' -- required
;

list

Returns the DynHost logins of the zone. Can be filtered by login and subdomain.

SELECT
login,
sub_domain,
zone
FROM ovh.domain.zone_dyn_host_logins
WHERE zone_name = '{{ zone_name }}' -- required
AND login = '{{ login }}'
AND sub_domain = '{{ sub_domain }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Creates a login named from the zone name and a suffix. The subdomain * allows all subdomains.

INSERT INTO ovh.domain.zone_dyn_host_logins (
login_suffix,
password,
sub_domain,
zone_name
)
SELECT 
'{{ login_suffix }}' /* required */,
'{{ password }}' /* required */,
'{{ sub_domain }}' /* required */,
'{{ zone_name }}'
RETURNING
login,
sub_domain,
zone
;

Manifest

# Description fields are for documentation purposes
- name: zone_dyn_host_logins
props:
  - name: zone_name
    value: "{{ zone_name }}"
    description: Required parameter for the zone_dyn_host_logins resource.
  - name: login_suffix
    value: "{{ login_suffix }}"
    description: |
      Suffix that will be concatenated to the zoneName to create the login
  - name: password
    value: "{{ password }}"
    description: |
      Password of the login
  - name: sub_domain
    value: "{{ sub_domain }}"
    description: |
      Subdomain that the login will be allowed to update (use * to allow all)

UPDATE examples

update

Updates the subdomain a DynHost login is allowed to update.

UPDATE ovh.domain.zone_dyn_host_logins
SET 
sub_domain = '{{ sub_domain }}'
WHERE 
login = '{{ login }}' --required
AND zone_name = '{{ zone_name }}' --required;

DELETE examples

delete

Deletes a DynHost login from the zone.

DELETE FROM ovh.domain.zone_dyn_host_logins
WHERE login = '{{ login }}' --required
AND zone_name = '{{ zone_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_password

Sets a new password for a DynHost login.

EXEC ovh.domain.zone_dyn_host_logins.change_password 
@login='{{ login }}' --required, 
@zoneName='{{ zoneName }}' --required 
@@json=
'{
"password": "{{ password }}"
}'
;