mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 22:02:50 +00:00
Convert to reduced list of known types (#50010)
This commit is contained in:
Dag Wieers
committed by
Jordan Borean
Jordan Borean
parent
fcd1486b51
commit
05c6ff79f9
@@ -223,22 +223,22 @@ RETURN = r'''
|
||||
backup_file:
|
||||
description: name of backup file created after download
|
||||
returned: changed and if backup=yes
|
||||
type: string
|
||||
type: str
|
||||
sample: /path/to/file.txt.2015-02-12@22:09~
|
||||
checksum_dest:
|
||||
description: sha1 checksum of the file after copy
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: 6e642bb8dd5c2e027bf21dd923337cbb4214f827
|
||||
checksum_src:
|
||||
description: sha1 checksum of the file
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: 6e642bb8dd5c2e027bf21dd923337cbb4214f827
|
||||
dest:
|
||||
description: destination file/path
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: /path/to/file.txt
|
||||
elapsed:
|
||||
description: The number of seconds that elapsed while performing the download
|
||||
@@ -253,32 +253,32 @@ gid:
|
||||
group:
|
||||
description: group of the file
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: "httpd"
|
||||
md5sum:
|
||||
description: md5 checksum of the file after download
|
||||
returned: when supported
|
||||
type: string
|
||||
type: str
|
||||
sample: "2a5aeecc61dc98c4d780b14b330e3282"
|
||||
mode:
|
||||
description: permissions of the target
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: "0644"
|
||||
msg:
|
||||
description: the HTTP message from the request
|
||||
returned: always
|
||||
type: string
|
||||
type: str
|
||||
sample: OK (unknown bytes)
|
||||
owner:
|
||||
description: owner of the file
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: httpd
|
||||
secontext:
|
||||
description: the SELinux security context of the file
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: unconfined_u:object_r:user_tmp_t:s0
|
||||
size:
|
||||
description: size of the target
|
||||
@@ -288,12 +288,12 @@ size:
|
||||
src:
|
||||
description: source file used after download
|
||||
returned: always
|
||||
type: string
|
||||
type: str
|
||||
sample: /tmp/tmpAdFLdV
|
||||
state:
|
||||
description: state of the target
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: file
|
||||
status_code:
|
||||
description: the HTTP status code from the request
|
||||
@@ -308,7 +308,7 @@ uid:
|
||||
url:
|
||||
description: the actual URL used for the request
|
||||
returned: always
|
||||
type: string
|
||||
type: str
|
||||
sample: https://www.ansible.com/
|
||||
'''
|
||||
|
||||
|
||||
@@ -245,7 +245,7 @@ elapsed:
|
||||
msg:
|
||||
description: The HTTP message from the request
|
||||
returned: always
|
||||
type: string
|
||||
type: str
|
||||
sample: OK (unknown bytes)
|
||||
redirected:
|
||||
description: Whether the request was redirected
|
||||
@@ -260,7 +260,7 @@ status:
|
||||
url:
|
||||
description: The actual URL used for the request
|
||||
returned: always
|
||||
type: string
|
||||
type: str
|
||||
sample: https://www.ansible.com/
|
||||
'''
|
||||
|
||||
|
||||
@@ -233,17 +233,17 @@ record:
|
||||
content:
|
||||
description: the record content (details depend on record type)
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: 192.0.2.91
|
||||
created_on:
|
||||
description: the record creation date
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: 2016-03-25T19:09:42.516553Z
|
||||
data:
|
||||
description: additional record data
|
||||
returned: success, if type is SRV, DS, SSHFP or TLSA
|
||||
type: dictionary
|
||||
type: dict
|
||||
sample: {
|
||||
name: "jabber",
|
||||
port: 8080,
|
||||
@@ -256,27 +256,27 @@ record:
|
||||
id:
|
||||
description: the record id
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: f9efb0549e96abcb750de63b38c9576e
|
||||
locked:
|
||||
description: No documentation available
|
||||
returned: success
|
||||
type: boolean
|
||||
type: bool
|
||||
sample: False
|
||||
meta:
|
||||
description: No documentation available
|
||||
returned: success
|
||||
type: dictionary
|
||||
type: dict
|
||||
sample: { auto_added: false }
|
||||
modified_on:
|
||||
description: record modification date
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: 2016-03-25T19:09:42.516553Z
|
||||
name:
|
||||
description: the record name as FQDN (including _service and _proto for SRV)
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: www.sample.com
|
||||
priority:
|
||||
description: priority of the MX record
|
||||
@@ -286,12 +286,12 @@ record:
|
||||
proxiable:
|
||||
description: whether this record can be proxied through cloudflare
|
||||
returned: success
|
||||
type: boolean
|
||||
type: bool
|
||||
sample: False
|
||||
proxied:
|
||||
description: whether the record is proxied through cloudflare
|
||||
returned: success
|
||||
type: boolean
|
||||
type: bool
|
||||
sample: False
|
||||
ttl:
|
||||
description: the time-to-live for the record
|
||||
@@ -301,17 +301,17 @@ record:
|
||||
type:
|
||||
description: the record type
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: A
|
||||
zone_id:
|
||||
description: the id of the zone containing the record
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: abcede0bf9f0066f94029d2e6b73856a
|
||||
zone_name:
|
||||
description: the name of the zone containing the record
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: sample.com
|
||||
'''
|
||||
|
||||
|
||||
@@ -68,12 +68,12 @@ exo_dns_domain:
|
||||
created_at:
|
||||
description: When the domain was created
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: "2016-08-12T15:24:23.989Z"
|
||||
expires_on:
|
||||
description: When the domain expires
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: "2016-08-12T15:24:23.989Z"
|
||||
id:
|
||||
description: ID of the domain
|
||||
@@ -88,7 +88,7 @@ exo_dns_domain:
|
||||
name:
|
||||
description: Domain name
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: example.com
|
||||
record_count:
|
||||
description: Number of records related to this domain
|
||||
@@ -108,22 +108,22 @@ exo_dns_domain:
|
||||
state:
|
||||
description: State of the domain
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: "hosted"
|
||||
token:
|
||||
description: Token
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: "r4NzTRp6opIeFKfaFYvOd6MlhGyD07jl"
|
||||
unicode_name:
|
||||
description: Domain name as unicode
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: "example.com"
|
||||
updated_at:
|
||||
description: When the domain was updated last.
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: "2016-08-12T15:24:23.989Z"
|
||||
user_id:
|
||||
description: ID of the user
|
||||
|
||||
@@ -131,17 +131,17 @@ exo_dns_record:
|
||||
content:
|
||||
description: value of the record
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: 1.2.3.4
|
||||
created_at:
|
||||
description: When the record was created
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: "2016-08-12T15:24:23.989Z"
|
||||
domain:
|
||||
description: Name of the domain
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: example.com
|
||||
domain_id:
|
||||
description: ID of the domain
|
||||
@@ -156,7 +156,7 @@ exo_dns_record:
|
||||
name:
|
||||
description: name of the record
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: www
|
||||
parent_id:
|
||||
description: ID of the parent
|
||||
@@ -171,7 +171,7 @@ exo_dns_record:
|
||||
record_type:
|
||||
description: Priority of the record
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: A
|
||||
system_record:
|
||||
description: Whether the record is a system record or not
|
||||
@@ -186,7 +186,7 @@ exo_dns_record:
|
||||
updated_at:
|
||||
description: When the record was updated
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: "2016-08-12T15:24:23.989Z"
|
||||
'''
|
||||
|
||||
|
||||
@@ -124,17 +124,17 @@ RETURN = """
|
||||
network_id:
|
||||
description: id for a given network
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: '1501'
|
||||
ip_info:
|
||||
description: when reserve next available ip address from a network, the ip address info ) is returned.
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: '{"address": "192.168.10.3", "hostname": "", "FQDN": "", "domainname": "", "id": 3229}'
|
||||
network_info:
|
||||
description: when reserving a LAN network from a Infinity supernet by providing network_size, the information about the reserved network is returned.
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: {"network_address": "192.168.10.32/28","network_family": "4", "network_id": 3102,
|
||||
"network_size": null,"description": null,"network_location": "3085",
|
||||
"ranges": { "id": 0, "name": null,"first_ip": null,"type": null,"last_ip": null},
|
||||
|
||||
@@ -62,7 +62,7 @@ RETURN = '''
|
||||
ipify_public_ip:
|
||||
description: Public IP of the internet gateway.
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: 1.2.3.4
|
||||
'''
|
||||
|
||||
|
||||
@@ -49,35 +49,35 @@ ansible_facts:
|
||||
contains:
|
||||
ip:
|
||||
description: "Public IP address of a host"
|
||||
type: string
|
||||
type: str
|
||||
sample: "8.8.8.8"
|
||||
hostname:
|
||||
description: Domain name
|
||||
type: string
|
||||
type: str
|
||||
sample: "google-public-dns-a.google.com"
|
||||
country:
|
||||
description: ISO 3166-1 alpha-2 country code
|
||||
type: string
|
||||
type: str
|
||||
sample: "US"
|
||||
region:
|
||||
description: State or province name
|
||||
type: string
|
||||
type: str
|
||||
sample: "California"
|
||||
city:
|
||||
description: City name
|
||||
type: string
|
||||
type: str
|
||||
sample: "Mountain View"
|
||||
loc:
|
||||
description: Latitude and Longitude of the location
|
||||
type: string
|
||||
type: str
|
||||
sample: "37.3860,-122.0838"
|
||||
org:
|
||||
description: "organization's name"
|
||||
type: string
|
||||
type: str
|
||||
sample: "AS3356 Level 3 Communications, Inc."
|
||||
postal:
|
||||
description: Postal code
|
||||
type: string
|
||||
type: str
|
||||
sample: "94035"
|
||||
'''
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
@@ -137,17 +137,17 @@ records:
|
||||
name:
|
||||
description: the record name
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: fancy-hostname
|
||||
type:
|
||||
description: the record type
|
||||
returned: succcess
|
||||
type: string
|
||||
type: str
|
||||
sample: A
|
||||
value:
|
||||
description: the record destination
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: 127.0.0.1
|
||||
priority:
|
||||
description: the record priority (only relevant if type=MX)
|
||||
|
||||
@@ -118,11 +118,11 @@ RETURN = '''
|
||||
changed:
|
||||
description: If module has modified record
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
record:
|
||||
description: DNS record
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: 'ansible'
|
||||
ttl:
|
||||
description: DNS record TTL
|
||||
@@ -132,7 +132,7 @@ ttl:
|
||||
type:
|
||||
description: DNS record type
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: 'CNAME'
|
||||
value:
|
||||
description: DNS record value(s)
|
||||
@@ -142,7 +142,7 @@ value:
|
||||
zone:
|
||||
description: DNS record zone
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: 'example.org.'
|
||||
dns_rc:
|
||||
description: dnspython return code
|
||||
@@ -152,7 +152,7 @@ dns_rc:
|
||||
dns_rc_str:
|
||||
description: dnspython return code (string representation)
|
||||
returned: always
|
||||
type: string
|
||||
type: str
|
||||
sample: 'REFUSED'
|
||||
'''
|
||||
|
||||
|
||||
@@ -98,7 +98,7 @@ RETURN = '''
|
||||
changed:
|
||||
description: If module has modified a host
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
lease:
|
||||
description: dictionary containing host information
|
||||
returned: success
|
||||
@@ -107,12 +107,12 @@ lease:
|
||||
ip-address:
|
||||
description: IP address, if there is.
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: '192.168.1.5'
|
||||
hardware-address:
|
||||
description: MAC address
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: '00:11:22:33:44:55'
|
||||
hardware-type:
|
||||
description: hardware type, generally '1'
|
||||
@@ -122,7 +122,7 @@ lease:
|
||||
name:
|
||||
description: hostname
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: 'mydesktop'
|
||||
'''
|
||||
|
||||
|
||||
@@ -91,12 +91,12 @@ RETURN = '''
|
||||
ansible_sysdescr:
|
||||
description: A textual description of the entity.
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: Linux ubuntu-user 4.4.0-93-generic #116-Ubuntu SMP Fri Aug 11 21:17:51 UTC 2017 x86_64
|
||||
ansible_sysobjectid:
|
||||
description: The vendor's authoritative identification of the network management subsystem contained in the entity.
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: 1.3.6.1.4.1.8072.3.2.10
|
||||
ansible_sysuptime:
|
||||
description: The time (in hundredths of a second) since the network management portion of the system was last re-initialized.
|
||||
@@ -106,17 +106,17 @@ ansible_sysuptime:
|
||||
ansible_syscontact:
|
||||
description: The textual identification of the contact person for this managed node, together with information on how to contact this person.
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: Me <me@example.org>
|
||||
ansible_sysname:
|
||||
description: An administratively-assigned name for this managed node.
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: ubuntu-user
|
||||
ansible_syslocation:
|
||||
description: The physical location of this node (e.g., `telephone closet, 3rd floor').
|
||||
returned: success
|
||||
type: string
|
||||
type: str
|
||||
sample: Sitting on the Dock of the Bay
|
||||
ansible_all_ipv4_addresses:
|
||||
description: List of all IPv4 addresses.
|
||||
|
||||
Reference in New Issue
Block a user