Skip to content

Latest commit

 

History

History
710 lines (690 loc) · 30 KB

avi_dynamicdnsrecord.rst

File metadata and controls

710 lines (690 loc) · 30 KB

vmware.alb.avi_dynamicdnsrecord

Module for setup of DynamicDnsRecord Avi RESTful Object

Synopsis

Parameters

Parameter Choices/Defaults Comments
state
str
  • absent
  • present ←
- The state that should be applied on the entity.
avi_api_update_method
str
  • put ←
  • patch
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
avi_api_patch_op
str
  • add ←
  • replace
  • delete
  • remove
- Patch operation to use when using avi_api_update_method as patch.
avi_patch_path
str
- Patch path to use when using avi_api_update_method as patch.
avi_patch_value
str
- Patch value to use when using avi_api_update_method as patch.
algorithm
str
- Specifies the algorithm to pick the ip address(es) to be returned,when multiple entries are configured.
- This does not apply if num_records_in_response is 0.
- Default is round-robin.
- Enum options - DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as DNS_RECORD_RESPONSE_ROUND_ROBIN.
cname
dict
- Canonical name in cname record.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
delegated
bool
- Configured fqdns are delegated domains (i.e.
- They represent a zone cut).
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
description
str
- Details of dns record.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
dns_vs_uuid
str
- Uuid of the dns vs.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
fqdn
str
- Fully qualified domain name.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
ip6_address
list
- Ipv6 address in aaaa record.
- Field introduced in 20.1.3.
- Maximum of 4 items allowed.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
ip_address
list
- Ip address in a record.
- Field introduced in 20.1.3.
- Maximum of 4 items allowed.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
metadata
str
- Internal metadata for the dns record.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
mx_records
list
- Mx record.
- Field introduced in 20.1.3.
- Maximum of 4 items allowed.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
name
str
- Dynamicdnsrecord name, needed for a top level uuid protobuf, for display in shell.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
ns
list
- Name server information in ns record.
- Field introduced in 20.1.3.
- Maximum of 13 items allowed.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
num_records_in_response
int
- Specifies the number of records returned by the dns service.enter 0 to return all records.
- Default is 0.
- Allowed values are 0-20.
- Special values are 0- return all records.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
service_locators
list
- Service locator info in srv record.
- Field introduced in 20.1.3.
- Maximum of 4 items allowed.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
tenant_ref
str
- Tenant_uuid from dns vs's tenant_uuid.
- It is a reference to an object of type tenant.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
ttl
int
- Time to live for this dns record.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
txt_records
list
- Text record.
- Field introduced in 20.1.3.
- Maximum of 4 items allowed.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
type
str
- Dns record type.
- Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX,
- DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR,
- DNS_RECORD_ANY.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Uuid of the dns record.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
wildcard_match
bool
- Enable wild-card match of fqdn if an exact match is not found in the dns table, the longest match is chosen by wild-carding the fqdn in the dns
- request.
- Default is false.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "avi_user"
      password: "avi_password"
      controller: "192.168.138.18"
      api_version: "21.1.1"
  tasks:
    - name: Example to create DynamicDnsRecord object
      avi_dynamicdnsrecord:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_dynamicdnsrecord

Authors