fmgd_system_dhcp6_server – Configure DHCPv6 servers.

Added in version 1.0.0.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • system_dhcp6_server - Configure DHCPv6 servers. type: dict
    • delegated_prefix_iaid (Alias name: delegated-prefix-iaid) Iaid of obtained delegated-prefix from the upstream interface. type: int more...
    • dns_search_list (Alias name: dns-search-list) Dns search list options. type: str choices: [specify, delegated] more...
    • dns_server1 (Alias name: dns-server1) Dns server 1. type: str more...
    • dns_server2 (Alias name: dns-server2) Dns server 2. type: str more...
    • dns_server3 (Alias name: dns-server3) Dns server 3. type: str more...
    • dns_server4 (Alias name: dns-server4) Dns server 4. type: str more...
    • dns_service (Alias name: dns-service) Options for assigning dns servers to dhcpv6 clients. type: str choices: [default, specify, delegated] more...
    • domain Domain name suffix for the ip addresses that the dhcp server assigns to clients. type: str more...
    • id Id. type: int more...
    • interface Dhcp server can assign ip configurations to clients connected to this interface. type: list more...
    • ip_mode (Alias name: ip-mode) Method used to assign client ip. type: str choices: [range, delegated] more...
    • ip_range (Alias name: ip-range) Ip range. type: list more...
      • end_ip (Alias name: end-ip) End of ip range. type: str more...
      • id Id. type: int more...
      • start_ip (Alias name: start-ip) Start of ip range. type: str more...
      • vci_match (Alias name: vci-match) Enable/disable vendor class option matching. type: str choices: [disable, enable] more...
      • vci_string (Alias name: vci-string) One or more vci strings in quotes separated by spaces. type: list more...
    • lease_time (Alias name: lease-time) Lease time in seconds, 0 means unlimited. type: int more...
    • option1 Option 1. type: str more...
    • option2 Option 2. type: str more...
    • option3 Option 3. type: str more...
    • prefix_mode (Alias name: prefix-mode) Assigning a prefix from a dhcpv6 client or ra. type: str choices: [dhcp6, ra] more...
    • prefix_range (Alias name: prefix-range) Prefix range. type: list more...
      • end_prefix (Alias name: end-prefix) End of prefix range. type: str more...
      • id Id. type: int more...
      • prefix_length (Alias name: prefix-length) Prefix length. type: int more...
      • start_prefix (Alias name: start-prefix) Start of prefix range. type: str more...
    • rapid_commit (Alias name: rapid-commit) Enable/disable allow/disallow rapid commit. type: str choices: [disable, enable] more...
    • status Enable/disable this dhcpv6 configuration. type: str choices: [disable, enable] more...
    • subnet Subnet or subnet-id if the ip mode is delegated. type: str more...
    • upstream_interface (Alias name: upstream-interface) Interface name from where delegated information is provided. type: list more...
    • options Options. type: list more...
      • code Dhcpv6 option code. type: int more...
      • id Id. type: int more...
      • ip6 Dhcp option ip6s. type: str more...
      • type Dhcpv6 option type. type: str choices: [hex, string, ip6, fqdn] more...
      • value Dhcpv6 option value (hexadecimal value must be even). type: str more...
      • vci_match (Alias name: vci-match) Enable/disable vendor class option matching. type: str choices: [disable, enable] more...
      • vci_string (Alias name: vci-string) One or more vci strings in quotes separated by spaces. type: list more...
    • delegated_prefix_route (Alias name: delegated-prefix-route) Enable/disable automatically adding of routing for delegated prefix. type: str choices: [disable, enable] more...

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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure DHCPv6 servers.
      fortinet.fmgdevice.fmgd_system_dhcp6_server:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        system_dhcp6_server:
          id: 0 # Required variable, integer
          # delegated_prefix_iaid: <integer>
          # dns_search_list: <value in [specify, delegated]>
          # dns_server1: <string>
          # dns_server2: <string>
          # dns_server3: <string>
          # dns_server4: <string>
          # dns_service: <value in [default, specify, delegated]>
          # domain: <string>
          # interface: <list or string>
          # ip_mode: <value in [range, delegated]>
          # ip_range:
          #   - end_ip: <string>
          #     id: <integer>
          #     start_ip: <string>
          #     vci_match: <value in [disable, enable]>
          #     vci_string: <list or string>
          # lease_time: <integer>
          # option1: <string>
          # option2: <string>
          # option3: <string>
          # prefix_mode: <value in [dhcp6, ra]>
          # prefix_range:
          #   - end_prefix: <string>
          #     id: <integer>
          #     prefix_length: <integer>
          #     start_prefix: <string>
          # rapid_commit: <value in [disable, enable]>
          # status: <value in [disable, enable]>
          # subnet: <string>
          # upstream_interface: <list or string>
          # options:
          #   - code: <integer>
          #     id: <integer>
          #     ip6: <string>
          #     type: <value in [hex, string, ip6, ...]>
          #     value: <string>
          #     vci_match: <value in [disable, enable]>
          #     vci_string: <list or string>
          # delegated_prefix_route: <value in [disable, enable]>

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:

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

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)