fortios_system_dhcp6_server – Configure DHCPv6 servers in Fortinet’s FortiOS and FortiGate.¶
New in version 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
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_system_dhcp6_server | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
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...
- delegated_prefix_iaid - IAID of obtained delegated-prefix from the upstream interface. type: int more...
- dns_search_list - DNS search list options. type: str choices: delegated, specify more...
- dns_server1 - DNS server 1. type: str more...
- dns_server2 - DNS server 2. type: str more...
- dns_server3 - DNS server 3. type: str more...
- dns_server4 - DNS server 4. type: str more...
- dns_service - Options for assigning DNS servers to DHCPv6 clients. type: str choices: delegated, default, specify more...
- domain - Domain name suffix for the IP addresses that the DHCP server assigns to clients. type: str more...
- id - ID. type: int required: true more...
- interface - DHCP server can assign IP configurations to clients connected to this interface. Source system.interface.name. type: str more...
- ip_mode - Method used to assign client IP. type: str choices: range, delegated more...
- ip_range - DHCP IP range configuration. type: list more...
- end_ip - End of IP range. type: str more...
- id - ID. type: int more...
- start_ip - Start of IP range. type: str more...
- 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 - Assigning a prefix from a DHCPv6 client or RA. type: str choices: dhcp6, ra more...
- prefix_range - DHCP prefix configuration. type: list more...
- end_prefix - End of prefix range. type: str more...
- id - ID. type: int more...
- prefix_length - Prefix length. type: int more...
- start_prefix - Start of prefix range. type: str more...
- 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 - Interface name from where delegated information is provided. Source system.interface.name. type: str more...
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure DHCPv6 servers.
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