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

Fix the docs for dig and nios.

The return docs for both of these didn't follow what the docs build
would understand.  Changed them so that they are properly formatted.
This commit is contained in:
Toshio Kuratomi 2020-05-20 10:43:22 -07:00
parent 820eea3d19
commit 651065bc03
2 changed files with 70 additions and 25 deletions

View file

@ -70,29 +70,73 @@ RETURN = """
description: description:
- list of composed strings or dictonaries with key and value - list of composed strings or dictonaries with key and value
If a dictionary, fields shows the keys returned depending on query type If a dictionary, fields shows the keys returned depending on query type
fields: contains:
ALL: owner, ttl, type ALL:
A: address description:
AAAA: address - owner, ttl, type
CNAME: target A:
DNAME: target description:
DLV: algorithm, digest_type, key_tag, digest - address
DNSKEY: flags, algorithm, protocol, key AAAA:
DS: algorithm, digest_type, key_tag, digest description:
HINFO: cpu, os - address
LOC: latitude, longitude, altitude, size, horizontal_precision, vertical_precision CNAME:
MX: preference, exchange description:
NAPTR: order, preference, flags, service, regexp, replacement - target
NS: target DNAME:
NSEC3PARAM: algorithm, flags, iterations, salt description:
PTR: target - target
RP: mbox, txt DLV:
SOA: mname, rname, serial, refresh, retry, expire, minimum description:
SPF: strings - algorithm, digest_type, key_tag, digest
SRV: priority, weight, port, target DNSKEY:
SSHFP: algorithm, fp_type, fingerprint description:
TLSA: usage, selector, mtype, cert - flags, algorithm, protocol, key
TXT: strings DS:
description:
- algorithm, digest_type, key_tag, digest
HINFO:
description:
- cpu, os
LOC:
description:
- latitude, longitude, altitude, size, horizontal_precision, vertical_precision
MX:
description:
- preference, exchange
NAPTR:
description:
- order, preference, flags, service, regexp, replacement
NS:
description:
- target
NSEC3PARAM:
description:
- algorithm, flags, iterations, salt
PTR:
description:
- target
RP:
description:
- mbox, txt
SOA:
description:
- mname, rname, serial, refresh, retry, expire, minimum
SPF:
description:
- strings
SRV:
description:
- priority, weight, port, target
SSHFP:
description:
- algorithm, fp_type, fingerprint
TLSA:
description:
- usage, selector, mtype, cert
TXT:
description:
- strings
""" """
from ansible.errors import AnsibleError from ansible.errors import AnsibleError

View file

@ -85,8 +85,9 @@ obj_type:
type: complex type: complex
contains: contains:
obj_field: obj_field:
- One or more obj_type fields as specified by return_fields argument or description:
the default set of fields as per the object type - One or more obj_type fields as specified by return_fields argument or
the default set of fields as per the object type
""" """
from ansible.plugins.lookup import LookupBase from ansible.plugins.lookup import LookupBase