Skip to content

Latest commit

 

History

History
643 lines (598 loc) · 27.3 KB

fortios_system_dhcp6_server.rst

File metadata and controls

643 lines (598 loc) · 27.3 KB
Raw
source:fortios_system_dhcp6_server.py
orphan:

fortios_system_dhcp6_server -- Configure DHCPv6 servers in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • 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.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_system_dhcp6_server v6.0.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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 default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • system_dhcp6_server - Configure DHCPv6 servers. type: dict more...
    Supported Version Ranges
    system_dhcp6_server v6.0.0 -> latest
    • delegated_prefix_iaid - IAID of obtained delegated-prefix from the upstream interface. type: int more...
      Supported Version Ranges
      delegated_prefix_iaid v7.0.2 -> latest
    • dns_search_list - DNS search list options. type: str choices: delegated, specify more...
      Supported Version Ranges
      dns_search_list v6.0.0 -> latest
      [delegated] v6.0.0 -> latest
      [specify] v6.0.0 -> latest
    • dns_server1 - DNS server 1. type: str more...
      Supported Version Ranges
      dns_server1 v6.0.0 -> latest
    • dns_server2 - DNS server 2. type: str more...
      Supported Version Ranges
      dns_server2 v6.0.0 -> latest
    • dns_server3 - DNS server 3. type: str more...
      Supported Version Ranges
      dns_server3 v6.0.0 -> latest
    • dns_server4 - DNS server 4. type: str more...
      Supported Version Ranges
      dns_server4 v6.2.0 -> latest
    • dns_service - Options for assigning DNS servers to DHCPv6 clients. type: str choices: delegated, default, specify more...
      Supported Version Ranges
      dns_service v6.0.0 -> latest
      [delegated] v6.0.0 -> latest
      [default] v6.0.0 -> latest
      [specify] v6.0.0 -> latest
    • domain - Domain name suffix for the IP addresses that the DHCP server assigns to clients. type: str more...
      Supported Version Ranges
      domain v6.0.0 -> latest
    • id - ID. see Notes. type: int required: true more...
      Supported Version Ranges
      id v6.0.0 -> latest
    • interface - DHCP server can assign IP configurations to clients connected to this interface. Source system.interface.name. type: str more...
      Supported Version Ranges
      interface v6.0.0 -> latest
    • ip_mode - Method used to assign client IP. type: str choices: range, delegated more...
      Supported Version Ranges
      ip_mode v6.0.0 -> latest
      [range] v6.0.0 -> latest
      [delegated] v6.0.0 -> latest
    • ip_range - DHCP IP range configuration. type: list member_path: ip_range:id more...
      Supported Version Ranges
      ip_range v6.0.0 -> latest
      • end_ip - End of IP range. type: str more...
        Supported Version Ranges
        end_ip v6.0.0 -> latest
      • id - ID. see Notes. type: int required: true more...
        Supported Version Ranges
        id v6.0.0 -> latest
      • start_ip - Start of IP range. type: str more...
        Supported Version Ranges
        start_ip v6.0.0 -> latest
    • lease_time - Lease time in seconds, 0 means unlimited. type: int more...
      Supported Version Ranges
      lease_time v6.0.0 -> latest
    • option1 - Option 1. type: str more...
      Supported Version Ranges
      option1 v6.0.0 -> latest
    • option2 - Option 2. type: str more...
      Supported Version Ranges
      option2 v6.0.0 -> latest
    • option3 - Option 3. type: str more...
      Supported Version Ranges
      option3 v6.0.0 -> latest
    • prefix_mode - Assigning a prefix from a DHCPv6 client or RA. type: str choices: dhcp6, ra more...
      Supported Version Ranges
      prefix_mode v7.0.0 -> latest
      [dhcp6] v6.0.0 -> latest
      [ra] v6.0.0 -> latest
    • prefix_range - DHCP prefix configuration. type: list member_path: prefix_range:id more...
      Supported Version Ranges
      prefix_range v6.0.0 -> latest
      • end_prefix - End of prefix range. type: str more...
        Supported Version Ranges
        end_prefix v6.0.0 -> latest
      • id - ID. see Notes. type: int required: true more...
        Supported Version Ranges
        id v6.0.0 -> latest
      • prefix_length - Prefix length. type: int more...
        Supported Version Ranges
        prefix_length v6.0.0 -> latest
      • start_prefix - Start of prefix range. type: str more...
        Supported Version Ranges
        start_prefix v6.0.0 -> latest
    • rapid_commit - Enable/disable allow/disallow rapid commit. type: str choices: disable, enable more...
      Supported Version Ranges
      rapid_commit v6.0.0 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • status - Enable/disable this DHCPv6 configuration. type: str choices: disable, enable more...
      Supported Version Ranges
      status v6.0.0 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • subnet - Subnet or subnet-id if the IP mode is delegated. type: str more...
      Supported Version Ranges
      subnet v6.0.0 -> latest
    • upstream_interface - Interface name from where delegated information is provided. Source system.interface.name. type: str more...
      Supported Version Ranges
      upstream_interface v6.0.0 -> latest

Notes

Note

  • We highly recommend using your own value as the id instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure DHCPv6 servers.
  fortinet.fortios.fortios_system_dhcp6_server:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_dhcp6_server:
          delegated_prefix_iaid: "0"
          dns_search_list: "delegated"
          dns_server1: "<your_own_value>"
          dns_server2: "<your_own_value>"
          dns_server3: "<your_own_value>"
          dns_server4: "<your_own_value>"
          dns_service: "delegated"
          domain: "<your_own_value>"
          id: "11"
          interface: "<your_own_value> (source system.interface.name)"
          ip_mode: "range"
          ip_range:
              -
                  end_ip: "<your_own_value>"
                  id: "16"
                  start_ip: "<your_own_value>"
          lease_time: "604800"
          option1: "<your_own_value>"
          option2: "<your_own_value>"
          option3: "<your_own_value>"
          prefix_mode: "dhcp6"
          prefix_range:
              -
                  end_prefix: "<your_own_value>"
                  id: "25"
                  prefix_length: "0"
                  start_prefix: "<your_own_value>"
          rapid_commit: "disable"
          status: "disable"
          subnet: "<your_own_value>"
          upstream_interface: "<your_own_value> (source system.interface.name)"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.