fortinet.fortimanager.fmgr_devprof_system_dns (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure DNS.
      fortinet.fortimanager.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: <integer>
          dns_cache_ttl: <integer>
          domain: <list or string>
          ip6_primary: <string>
          ip6_secondary: <string>
          primary: <string>
          secondary: <string>
          dns_over_tls: <value in [disable, enable, enforce]>
          retry: <integer>
          server_hostname: <list or string>
          ssl_certificate: <string>
          timeout: <integer>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

devprof:
    description: The parameter (devprof) in requested url.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

devprof_system_dns:
    description: The top level parameters set.
    required: false
    suboptions:
      cache-notfound-responses:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to cache_notfound_responses. Enable/disable
          response from the DNS server when a record is not...
        type: str
      dns-cache-limit:
        description: Deprecated, please rename it to dns_cache_limit. Maximum number of
          records in the DNS cache.
        type: int
      dns-cache-ttl:
        description: Deprecated, please rename it to dns_cache_ttl. Duration in seconds
          that the DNS cache retains information.
        type: int
      dns-over-tls:
        choices:
        - disable
        - enable
        - enforce
        description: Deprecated, please rename it to dns_over_tls. Enable/disable/enforce
          DNS over TLS.
        type: str
      domain:
        description: (list or str) Domain name suffix for the IP addresses of the DNS
          server.
        type: raw
      interface:
        description: Specify outgoing interface to reach server.
        type: str
      interface-select-method:
        choices:
        - auto
        - sdwan
        - specify
        description: Deprecated, please rename it to interface_select_method. Specify
          how to select outgoing interface to reach server.
        type: str
      ip6-primary:
        description: Deprecated, please rename it to ip6_primary. Primary DNS server IPv6
          address.
        type: str
      ip6-secondary:
        description: Deprecated, please rename it to ip6_secondary. Secondary DNS server
          IPv6 address.
        type: str
      primary:
        description: Primary DNS server IP address.
        type: str
      retry:
        description: Number of times to retry
        type: int
      secondary:
        description: Secondary DNS server IP address.
        type: str
      server-hostname:
        description: (list) Deprecated, please rename it to server_hostname.
        type: raw
      ssl-certificate:
        description: Deprecated, please rename it to ssl_certificate. Name of local certificate
          for SSL connections.
        type: str
      timeout:
        description: DNS query timeout interval in seconds
        type: int
    type: dict

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list