fortinet.fortimanager.fmgr_system_dnsdatabase module – Configure DNS databases.
Note
This module is part of the fortinet.fortimanager collection (version 2.12.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_dnsdatabase.
New in fortinet.fortimanager 2.12.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The change note that can be specified when an object is created or updated. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
DNS zone transfer IP address list. |
|
Enable/disable authoritative zone. Choices:
|
|
Email address of the administrator for this zone. |
|
Dns entry. |
|
Canonical name of the host. |
|
Name of the host. |
|
DNS entry ID. |
|
IPv4 address of the host. |
|
IPv6 address of the host. |
|
DNS entry preference |
|
Enable/disable resource record status. Choices:
|
|
Time-to-live for this entry |
|
Resource record type. Choices:
|
|
Domain name. |
|
DNS zone forwarder IP address list. |
|
Forwarder IPv6 address. |
|
Specify outgoing interface to reach server. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
IP address of master DNS server. |
|
IP address of primary DNS server. |
|
Zone name. |
|
Domain name of the default DNS server for this zone. |
|
Maximum number of resource records |
|
Source IP for forwarding to DNS server. |
|
IPv6 source IP address for forwarding to DNS server. |
|
IP address of the specified interface as the source IP address. |
|
Enable/disable this DNS zone. Choices:
|
|
Default time-to-live value for the entries of this DNS zone |
|
Zone type Choices:
|
|
Zone view Choices:
|
|
VRF ID used for connection to server. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure DNS databases.
fortinet.fortimanager.fmgr_system_dnsdatabase:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
state: present # <value in [present, absent]>
system_dnsdatabase:
name: "your value" # Required variable, string
# allow_transfer: <list or string>
# authoritative: <value in [disable, enable]>
# contact: <string>
# dns_entry:
# - canonical_name: <string>
# hostname: <string>
# id: <integer>
# ip: <string>
# ipv6: <string>
# preference: <integer>
# status: <value in [disable, enable]>
# ttl: <integer>
# type: <value in [NS, MX, CNAME, ...]>
# domain: <string>
# forwarder: <list or string>
# forwarder6: <string>
# ip_primary: <string>
# primary_name: <string>
# rr_max: <integer>
# source_ip: <string>
# source_ip6: <string>
# status: <value in [disable, enable]>
# ttl: <integer>
# type: <value in [primary, secondary, master, ...]>
# view: <value in [shadow, public, shadow-ztna, ...]>
# interface_select_method: <value in [auto, sdwan, specify]>
# interface: <list or string>
# source_ip_interface: <list or string>
# vrf_select: <integer>
# ip_master: <string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |