cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update azure_rm_dnsrecordset relate document (#56895)

Browse source 
* Update azure_rm_dnsrecordset related documentation
This commit is contained in:
Fred-sun 2019-05-30 10:25:16 -04:00 committed by Alicia Cozine
parent bf25889bfd
commit a7e53906a6
2 changed files with 105 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

103
lib/ansible/modules/cloud/azure/azure_rm_dnsrecordset.py
View file

@ -18,7 +18,7 @@ module: azure_rm_dnsrecordset
version_added: "2.4" version_added: "2.4"
short_description: Create, delete and update DNS record sets and records. short_description: Create, delete and update DNS record sets and records
description: description:
- Creates, deletes, and updates DNS records sets and records within an existing Azure DNS Zone. - Creates, deletes, and updates DNS records sets and records within an existing Azure DNS Zone.
@ -26,19 +26,19 @@ description:
options: options:
resource_group: resource_group:
description: description:
- name of resource group - Name of resource group.
required: true required: true
zone_name: zone_name:
description: description:
- name of the existing DNS zone in which to manage the record set - Name of the existing DNS zone in which to manage the record set.
required: true required: true
relative_name: relative_name:
description: description:
- relative name of the record set - Relative name of the record set.
required: true required: true
record_type: record_type:
description: description:
- the type of record set to create or delete - The type of record set to create or delete.
choices: choices:
- A - A
- AAAA - AAAA
@ -53,50 +53,49 @@ options:
required: true required: true
record_mode: record_mode:
description: description:
- whether existing record values not sent to the module should be purged - Whether existing record values not sent to the module should be purged.
default: purge default: purge
choices: choices:
- append - append
- purge - purge
state: state:
description: description:
- Assert the state of the record set. Use C(present) to create or update and - Assert the state of the record set. Use C(present) to create or update and C(absent) to delete.
C(absent) to delete.
default: present default: present
choices: choices:
- absent - absent
- present - present
time_to_live: time_to_live:
description: description:
- time to live of the record set in seconds - Time to live of the record set in seconds.
default: 3600 default: 3600
records: records:
description: description:
- list of records to be created depending on the type of record (set) - List of records to be created depending on the type of record (set).
suboptions: suboptions:
preference: preference:
description: description:
- used for creating an MX record set/records - Used for creating an C(MX) record set/records.
priority: priority:
description: description:
- used for creating an SRV record set/records - Used for creating an C(SRV) record set/records.
weight: weight:
description: description:
- used for creating an SRV record set/records - Used for creating an C(SRV) record set/records.
port: port:
description: description:
- used for creating an SRV record set/records - Used for creating an C(SRV) record set/records.
entry: entry:
description: description:
- primary data value for all record types. - Primary data value for all record types.
extends_documentation_fragment: extends_documentation_fragment:
- azure - azure
- azure_tags - azure_tags
author: author:
- "Obezimnaka Boms (@ozboms)" - Obezimnaka Boms (@ozboms)
- "Matt Davis (@nitzmahone)" - Matt Davis (@nitzmahone)
''' '''
EXAMPLES = ''' EXAMPLES = '''
@ -167,6 +166,76 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
state:
description:
- Current state of the DNS record set.
returned: always
type: complex
contains:
id:
description:
- The DNS record set ID.
returned: always
type: str
sample: "/subscriptions/xxxx......xxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/dnszones/b57dc95985712e4523282.com/A/www"
name:
description:
- Relate name of the record set.
returned: always
type: str
sample: 'www'
fqdn:
description:
- Fully qualified domain name of the record set.
return: always
type: str
sample: www.b57dc95985712e4523282.com
etag:
description:
- The etag of the record set.
return: always
type: str
sample: 692c3e92-a618-46fc-aecd-8f888807cd6c
provisioning_state:
description:
- The DNS record set state.
return: always
type: str
sample: Succeeded
target_resource:
description:
- The target resource of the record set.
return: always
type: dict
sample: {}
ttl:
description:
- The TTL(time-to-live) of the records in the records set.
return: always
type: int
sample: 3600
type:
description:
- The type of DNS record in this record set.
return: always
type: str
sample: A
arecords:
description:
- A list of records in the record set.
return: always
type: list
sample: [
{
"ipv4_address": "192.0.2.2"
},
{
"ipv4_address": "192.0.2.4"
},
{
"ipv4_address": "192.0.2.8"
}
]
''' '''
import inspect import inspect

30
lib/ansible/modules/cloud/azure/azure_rm_dnsrecordset_facts.py
View file

@ -17,7 +17,7 @@ module: azure_rm_dnsrecordset_facts
version_added: "2.4" version_added: "2.4"
short_description: Get DNS Record Set facts. short_description: Get DNS Record Set facts
description: description:
- Get facts for a specific DNS Record Set in a Zone, or a specific type in all Zones or in one Zone etc. - Get facts for a specific DNS Record Set in a Zone, or a specific type in all Zones or in one Zone etc.
@ -37,7 +37,7 @@ options:
- Limit record sets by record type. - Limit record sets by record type.
top: top:
description: description:
- Limit the maximum number of record sets to return - Limit the maximum number of record sets to return.
type: int type: int
extends_documentation_fragment: extends_documentation_fragment:
@ -45,7 +45,7 @@ extends_documentation_fragment:
- azure_tags - azure_tags
author: author:
- "Ozi Boms (@ozboms)" - Ozi Boms (@ozboms)
''' '''
@ -69,7 +69,8 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
azure_dnsrecordset: azure_dnsrecordset:
description: List of record set dicts. description:
- List of record set dicts.
returned: always returned: always
type: list type: list
example: [ example: [
@ -91,16 +92,19 @@ azure_dnsrecordset:
"type": "Microsoft.Network/dnszones/A" "type": "Microsoft.Network/dnszones/A"
}] }]
dnsrecordsets: dnsrecordsets:
description: List of record set dicts, which shares the same hierarchy as azure_rm_dnsrecordset module's parameter. description:
- List of record set dicts, which shares the same hierarchy as M(azure_rm_dnsrecordset) module's parameter.
returned: always returned: always
type: list type: list
contains: contains:
id: id:
description: ID of the dns recordset. description:
- ID of the dns recordset.
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/dnszones/newzone. sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/dnszones/newzone.
com/A/servera" com/A/servera"
relative_name: relative_name:
description: Name of the dns recordset. description:
- Name of the dns recordset.
sample: servera sample: servera
record_type: record_type:
description: description:
@ -108,10 +112,12 @@ dnsrecordsets:
- Can be C(A), C(AAAA), C(CNAME), C(MX), C(NS), C(SRV), C(TXT), C(PTR). - Can be C(A), C(AAAA), C(CNAME), C(MX), C(NS), C(SRV), C(TXT), C(PTR).
sample: A sample: A
time_to_live: time_to_live:
description: Time to live of the record set in seconds. description:
- Time to live of the record set in seconds.
sample: 12900 sample: 12900
records: records:
description: List of records depending on the type of recordset. description:
- List of records depending on the type of recordset.
sample: [ sample: [
{ {
"ipv4Address": "10.4.5.7" "ipv4Address": "10.4.5.7"
@ -121,10 +127,12 @@ dnsrecordsets:
} }
] ]
provisioning_state: provisioning_state:
description: Provision state of the resource. description:
- Provision state of the resource.
sample: Successed sample: Successed
fqdn: fqdn:
description: Fully qualified domain name of the record set. description:
- Fully qualified domain name of the record set.
sample: www.newzone.com sample: www.newzone.com
''' '''