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

Configure DHCPv6 servers in Fortinet's FortiOS and FortiGate.

| "added in version" 2.9 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

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_dhcp6 feature and server category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5


Requirements

Usage examples

  • 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 DHCPv6 servers.
    fortios_system_dhcp6_server:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      system_dhcp6_server:
        dns_search_list: "delegated"
        dns_server1: "<your_own_value>"
        dns_server2: "<your_own_value>"
        dns_server3: "<your_own_value>"
        dns_service: "delegated"
        domain: "<your_own_value>"
        id:  "9"
        interface: "<your_own_value> (source system.interface.name)"
        ip_mode: "range"
        ip_range:
         -
            end_ip: "<your_own_value>"
            id:  "14"
            start_ip: "<your_own_value>"
        lease_time: "16"
        option1: "<your_own_value>"
        option2: "<your_own_value>"
        option3: "<your_own_value>"
        prefix_range:
         -
            end_prefix: "<your_own_value>"
            id:  "22"
            prefix_length: "23"
            start_prefix: "<your_own_value>"
        rapid_commit: "disable"
        status: "disable"
        subnet: "<your_own_value>"
        upstream_interface: "<your_own_value> (source system.interface.name)"

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_dhcp6_server:
    default: null
    description:
    - Configure DHCPv6 servers.
    suboptions:
      dns_search_list:
        choices:
        - delegated
        - specify
        description:
        - DNS search list options.
        type: str
      dns_server1:
        description:
        - DNS server 1.
        type: str
      dns_server2:
        description:
        - DNS server 2.
        type: str
      dns_server3:
        description:
        - DNS server 3.
        type: str
      dns_service:
        choices:
        - delegated
        - default
        - specify
        description:
        - Options for assigning DNS servers to DHCPv6 clients.
        type: str
      domain:
        description:
        - Domain name suffix for the IP addresses that the DHCP server assigns to clients.
        type: str
      id:
        description:
        - ID.
        required: true
        type: int
      interface:
        description:
        - DHCP server can assign IP configurations to clients connected to this interface.
          Source system.interface.name.
        type: str
      ip_mode:
        choices:
        - range
        - delegated
        description:
        - Method used to assign client IP.
        type: str
      ip_range:
        description:
        - DHCP IP range configuration.
        suboptions:
          end_ip:
            description:
            - End of IP range.
            type: str
          id:
            description:
            - ID.
            required: true
            type: int
          start_ip:
            description:
            - Start of IP range.
            type: str
        type: list
      lease_time:
        description:
        - Lease time in seconds, 0 means unlimited.
        type: int
      option1:
        description:
        - Option 1.
        type: str
      option2:
        description:
        - Option 2.
        type: str
      option3:
        description:
        - Option 3.
        type: str
      prefix_range:
        description:
        - DHCP prefix configuration.
        suboptions:
          end_prefix:
            description:
            - End of prefix range.
            type: str
          id:
            description:
            - ID.
            required: true
            type: int
          prefix_length:
            description:
            - Prefix length.
            type: int
          start_prefix:
            description:
            - Start of prefix range.
            type: str
        type: list
      rapid_commit:
        choices:
        - disable
        - enable
        description:
        - Enable/disable allow/disallow rapid commit.
        type: str
      status:
        choices:
        - disable
        - enable
        description:
        - Enable/disable this DHCPv6 configuration.
        type: str
      subnet:
        description:
        - Subnet or subnet-id if the IP mode is delegated.
        type: str
      upstream_interface:
        description:
        - Interface name from where delegated information is provided. Source system.interface.name.
        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