1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Doc formatting/tweaking.

This commit is contained in:
Michael DeHaan 2013-08-04 13:12:29 -04:00
parent 2ff5a615df
commit 2a0d67e6fc

View file

@ -20,7 +20,7 @@ module: dnsmadeeasy
version_added: "1.3" version_added: "1.3"
short_description: Interface with dnsmadeeasy.com (a DNS hosting service). short_description: Interface with dnsmadeeasy.com (a DNS hosting service).
description: description:
- Manage DNS records via the v2 REST API of the DNS Made Easy service. Records only; no manipulation of domains or monitor/account support yet. See: http://www.dnsmadeeasy.com/services/rest-api/ - "Manages DNS records via the v2 REST API of the DNS Made Easy service. It handles records only; there is no manipulation of domains or monitor/account support yet. See: U(http://www.dnsmadeeasy.com/services/rest-api/)"
options: options:
account_key: account_key:
description: description:
@ -42,8 +42,7 @@ options:
record_name: record_name:
description: description:
- Record name (to get/create/delete/update). - Record name to get/create/delete/update. If record_name is not specified; all records for the domain will be returned in "result" regardless of the state argument.
If record_name is not specified; all records for the domain will be returned as "result" regardless of state argument.
required: false required: false
default: null default: null
@ -56,28 +55,27 @@ options:
record_value: record_value:
description: description:
- Record value. HTTPRED: <redirection URL>, MX: <priority> <target name>, NS: <name server>, PTR: <target name>, SRV: <priority> <weight> <port> <target name>, TXT: <text value> - "Record value. HTTPRED: <redirection URL>, MX: <priority> <target name>, NS: <name server>, PTR: <target name>, SRV: <priority> <weight> <port> <target name>, TXT: <text value>"
If record_value is not specified; no changes will be made and the record will be returned as "result" (e.g. can be used to fetch a record's current id, type, and ttl) - "If record_value is not specified; no changes will be made and the record will be returned in 'result' (in other words, this module can be used to fetch a record's current id, type, and ttl)"
required: false required: false
default: null default: null
record_ttl: record_ttl:
description: description:
- Record "Time to live". Number of seconds a record remains cached in DNS servers. - record's "Time to live". Number of seconds the record remains cached in DNS servers.
required: false required: false
default: 1800 default: 1800
state: state:
description: description:
- If state is "present", record will be created. If state is "present" and if record exists and values have changed, it will be updated. - whether the record should exist or not
If state is absent, record will be removed.
required: true required: true
choices: [ 'present', 'absent' ] choices: [ 'present', 'absent' ]
default: null default: null
notes: notes:
- The DNS Made Easy service requires that machines interacting with it's API have the proper time + timezone set. Be sure you're within a few seconds of actual GMT by using NTP. - The DNS Made Easy service requires that machines interacting with the API have the proper time and timezone set. Be sure you are within a few seconds of actual time by using NTP.
- This module returns record(s) as "result" when state == 'present'. It can be be registered and used in your playbooks. - This module returns record(s) in the "result" element when 'state' is set to 'present'. This value can be be registered and used in your playbooks.
requirements: [ urllib, urllib2, hashlib, hmac ] requirements: [ urllib, urllib2, hashlib, hmac ]
author: Brice Burgess author: Brice Burgess