fortinet.fortimanager.fmgr_devprof_system_dns – Configure DNS.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_devprof_system_dns.

New in version 2.10: of fortinet.fortimanager

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
devprof
string / required
the parameter (devprof) in requested url
devprof_system_dns
dictionary
the top level parameters set
cache-notfound-responses
string
    Choices:
  • disable
  • enable
Enable/disable response from the DNS server when a record is not in cache.
dns-cache-limit
integer
Maximum number of records in the DNS cache.
dns-cache-ttl
integer
Duration in seconds that the DNS cache retains information.
dns-over-tls
string
    Choices:
  • disable
  • enable
  • enforce
Enable/disable/enforce DNS over TLS.
domain
string
Domain name suffix for the IP addresses of the DNS server.
interface
string
Specify outgoing interface to reach server.
interface-select-method
string
    Choices:
  • auto
  • sdwan
  • specify
Specify how to select outgoing interface to reach server.
ip6-primary
string
Primary DNS server IPv6 address.
ip6-secondary
string
Secondary DNS server IPv6 address.
primary
string
Primary DNS server IP address.
retry
integer
Number of times to retry (0 - 5).
secondary
string
Secondary DNS server IP address.
server-hostname
string
no description
ssl-certificate
string
Name of local certificate for SSL connections.
timeout
integer
DNS query timeout interval in seconds (1 - 10).
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • 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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure DNS.
     fmgr_devprof_system_dns:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        devprof: <your own value>
        devprof_system_dns:
           cache-notfound-responses: <value in [disable, enable]>
           dns-cache-limit: <value of integer>
           dns-cache-ttl: <value of integer>
           domain: <value of string>
           ip6-primary: <value of string>
           ip6-secondary: <value of string>
           primary: <value of string>
           secondary: <value of string>
           dns-over-tls: <value in [disable, enable, enforce]>
           retry: <value of integer>
           server-hostname: <value of string>
           ssl-certificate: <value of string>
           timeout: <value of integer>
           interface: <value of string>
           interface-select-method: <value in [auto, sdwan, specify]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)