ansible.builtin.fortios_system_ddns (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ddns category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

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

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure DDNS.
    fortios_system_ddns:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      system_ddns:
        bound_ip: "<your_own_value>"
        clear_text: "disable"
        ddns_auth: "disable"
        ddns_domain: "<your_own_value>"
        ddns_key: "<your_own_value>"
        ddns_keyname: "<your_own_value>"
        ddns_password: "<your_own_value>"
        ddns_server: "dyndns.org"
        ddns_server_ip: "<your_own_value>"
        ddns_sn: "<your_own_value>"
        ddns_ttl: "13"
        ddns_username: "<your_own_value>"
        ddns_zone: "<your_own_value>"
        ddnsid: "16"
        monitor_interface:
         -
            interface_name: "<your_own_value> (source system.interface.name)"
        ssl_certificate: "<your_own_value> (source certificate.local.name)"
        update_interval: "20"
        use_public_ip: "disable"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.
    type: str

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

system_ddns:
    default: null
    description:
    - Configure DDNS.
    suboptions:
      bound_ip:
        description:
        - Bound IP address.
        type: str
      clear_text:
        choices:
        - disable
        - enable
        description:
        - Enable/disable use of clear text connections.
        type: str
      ddns_auth:
        choices:
        - disable
        - tsig
        description:
        - Enable/disable TSIG authentication for your DDNS server.
        type: str
      ddns_domain:
        description:
        - Your fully qualified domain name (for example, yourname.DDNS.com).
        type: str
      ddns_key:
        description:
        - DDNS update key (base 64 encoding).
        type: str
      ddns_keyname:
        description:
        - DDNS update key name.
        type: str
      ddns_password:
        description:
        - DDNS password.
        type: str
      ddns_server:
        choices:
        - dyndns.org
        - dyns.net
        - tzo.com
        - vavic.com
        - dipdns.net
        - now.net.cn
        - dhs.org
        - easydns.com
        - genericDDNS
        - FortiGuardDDNS
        - noip.com
        description:
        - Select a DDNS service provider.
        type: str
      ddns_server_ip:
        description:
        - Generic DDNS server IP.
        type: str
      ddns_sn:
        description:
        - DDNS Serial Number.
        type: str
      ddns_ttl:
        description:
        - Time-to-live for DDNS packets.
        type: int
      ddns_username:
        description:
        - DDNS user name.
        type: str
      ddns_zone:
        description:
        - Zone of your domain name (for example, DDNS.com).
        type: str
      ddnsid:
        description:
        - DDNS ID.
        required: true
        type: int
      monitor_interface:
        description:
        - Monitored interface.
        suboptions:
          interface_name:
            description:
            - Interface name. Source system.interface.name.
            type: str
        type: list
      ssl_certificate:
        description:
        - Name of local certificate for SSL connections. Source certificate.local.name.
        type: str
      update_interval:
        description:
        - DDNS update interval (60 - 2592000 sec).
        type: int
      use_public_ip:
        choices:
        - disable
        - enable
        description:
        - Enable/disable use of public IP address.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str