fortinet.fortios.fortios_system_dhcp6_server module – Configure DHCPv6 servers in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_system_dhcp6_server.
New in fortinet.fortios 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.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure DHCPv6 servers. |
|
IAID of obtained delegated-prefix from the upstream interface. |
|
DNS search list options. Choices:
|
|
DNS server 1. |
|
DNS server 2. |
|
DNS server 3. |
|
DNS server 4. |
|
Options for assigning DNS servers to DHCPv6 clients. Choices:
|
|
Domain name suffix for the IP addresses that the DHCP server assigns to clients. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
DHCP server can assign IP configurations to clients connected to this interface. Source system.interface.name. |
|
Method used to assign client IP. Choices:
|
|
DHCP IP range configuration. |
|
End of IP range. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
Start of IP range. |
|
Enable/disable vendor class option matching. When enabled only DHCP requests with a matching VC are served with this range. Choices:
|
|
One or more VCI strings in quotes separated by spaces. |
|
VCI strings. |
|
Lease time in seconds, 0 means unlimited. |
|
Option 1. |
|
Option 2. |
|
Option 3. |
|
DHCPv6 options. |
|
DHCPv6 option code. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
DHCP option IP6s. |
|
DHCPv6 option type. Choices:
|
|
DHCPv6 option value (hexadecimal value must be even). |
|
Enable/disable vendor class option matching. When enabled only DHCP requests with a matching VCI are served with this option. Choices:
|
|
One or more VCI strings in quotes separated by spaces. |
|
VCI strings. |
|
Assigning a prefix from a DHCPv6 client or RA. Choices:
|
|
DHCP prefix configuration. |
|
End of prefix range. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
Prefix length. |
|
Start of prefix range. |
|
Enable/disable allow/disallow rapid commit. Choices:
|
|
Enable/disable this DHCPv6 configuration. Choices:
|
|
Subnet or subnet-id if the IP mode is delegated. |
|
Interface name from where delegated information is provided. Source system.interface.name. |
|
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. Default: |
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
The module supports check_mode.
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>"
vci_match: "disable"
vci_string:
-
vci_string: "<your_own_value>"
lease_time: "604800"
option1: "<your_own_value>"
option2: "<your_own_value>"
option3: "<your_own_value>"
options:
-
code: "0"
id: "27"
ip6: "<your_own_value>"
type: "hex"
value: "<your_own_value>"
vci_match: "disable"
vci_string:
-
vci_string: "<your_own_value>"
prefix_mode: "dhcp6"
prefix_range:
-
end_prefix: "<your_own_value>"
id: "37"
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 here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |