:source: fortios_system_dhcp_server.py
:orphan:
.. fortios_system_dhcp_server:
fortios_system_dhcp_server -- Configure DHCP servers in Fortinet's FortiOS and FortiGate.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_dhcp 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.16
Tips
----
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v6.0.0 -> v7.6.6
Parameters
----------
.. raw:: html
- 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_dhcp_server - Configure DHCP servers. type: dict
more...
| Supported Version Ranges |
| system_dhcp_server |
v6.0.0 -> 7.6.6 |
- auto_configuration - Enable/disable auto configuration. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| auto_configuration |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- auto_managed_status - Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| auto_managed_status |
v6.4.0 -> 7.6.6 |
| [disable] |
v6.4.0 -> 7.6.6 |
| [enable] |
v6.4.0 -> 7.6.6 |
- conflicted_ip_timeout - Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused. type: int
more...
|
Supported Version Ranges |
| conflicted_ip_timeout |
v6.0.0 -> 7.6.6 |
- ddns_auth - DDNS authentication mode. type: str choices: disable, tsig
more...
|
Supported Version Ranges |
| ddns_auth |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [tsig] |
v6.0.0 -> 7.6.6 |
- ddns_key - DDNS update key (base 64 encoding). type: str
more...
|
Supported Version Ranges |
| ddns_key |
v6.0.0 -> 7.6.6 |
- ddns_keyname - DDNS update key name. type: str
more...
|
Supported Version Ranges |
| ddns_keyname |
v6.0.0 -> 7.6.6 |
- ddns_server_ip - DDNS server IP. type: str
more...
|
Supported Version Ranges |
| ddns_server_ip |
v6.0.0 -> 7.6.6 |
- ddns_ttl - TTL. type: int
more...
|
Supported Version Ranges |
| ddns_ttl |
v6.0.0 -> 7.6.6 |
- ddns_update - Enable/disable DDNS update for DHCP. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| ddns_update |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- ddns_update_override - Enable/disable DDNS update override for DHCP. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| ddns_update_override |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- ddns_zone - Zone of your domain name (ex. DDNS.com). type: str
more...
|
Supported Version Ranges |
| ddns_zone |
v6.0.0 -> 7.6.6 |
- default_gateway - Default gateway IP address assigned by the DHCP server. type: str
more...
|
Supported Version Ranges |
| default_gateway |
v6.0.0 -> 7.6.6 |
- dhcp_settings_from_fortiipam - Enable/disable populating of DHCP server settings from FortiIPAM. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| dhcp_settings_from_fortiipam |
v6.4.0 -> 7.6.6 |
| [disable] |
v6.4.0 -> 7.6.6 |
| [enable] |
v6.4.0 -> 7.6.6 |
- dns_server1 - DNS server 1. type: str
more...
|
Supported Version Ranges |
| dns_server1 |
v6.0.0 -> 7.6.6 |
- dns_server2 - DNS server 2. type: str
more...
|
Supported Version Ranges |
| dns_server2 |
v6.0.0 -> 7.6.6 |
- dns_server3 - DNS server 3. type: str
more...
|
Supported Version Ranges |
| dns_server3 |
v6.0.0 -> 7.6.6 |
- dns_server4 - DNS server 4. type: str
more...
|
Supported Version Ranges |
| dns_server4 |
v6.2.0 -> 7.6.6 |
- dns_service - Options for assigning DNS servers to DHCP clients. type: str choices: local, default, specify
more...
|
Supported Version Ranges |
| dns_service |
v6.0.0 -> 7.6.6 |
| [local] |
v6.0.0 -> 7.6.6 |
| [default] |
v6.0.0 -> 7.6.6 |
| [specify] |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- exclude_range - Exclude one or more ranges of IP addresses from being assigned to clients. type: list member_path: exclude_range:id
more...
| Supported Version Ranges |
| exclude_range |
v6.0.0 -> 7.6.6 |
- end_ip - End of IP range. type: str
more...
|
Supported Version Ranges |
| end_ip |
v6.0.0 -> 7.6.6 |
- id - ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- lease_time - Lease time in seconds, 0 means default lease time. type: int
more...
|
Supported Version Ranges |
| lease_time |
v7.2.4 -> 7.6.6 |
- start_ip - Start of IP range. type: str
more...
|
Supported Version Ranges |
| start_ip |
v6.0.0 -> 7.6.6 |
- uci_match - Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| uci_match |
v7.2.4 -> 7.6.6 |
| [disable] |
v7.2.4 -> 7.6.6 |
| [enable] |
v7.2.4 -> 7.6.6 |
- uci_string - One or more UCI strings in quotes separated by spaces. type: list member_path: exclude_range:id/uci_string:uci_string
more...
| Supported Version Ranges |
| uci_string |
v7.2.4 -> 7.6.6 |
- uci_string - UCI strings. type: str required: true
more...
|
Supported Version Ranges |
| uci_string |
v7.2.4 -> 7.6.6 |
- vci_match - Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| vci_match |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- vci_string - One or more VCI strings in quotes separated by spaces. type: list member_path: exclude_range:id/vci_string:vci_string
more...
| Supported Version Ranges |
| vci_string |
v7.2.1 -> 7.6.6 |
- vci_string - VCI strings. type: str required: true
more...
|
Supported Version Ranges |
| vci_string |
v7.2.1 -> 7.6.6 |
- filename - Name of the boot file on the TFTP server. type: str
more...
|
Supported Version Ranges |
| filename |
v6.0.0 -> 7.6.6 |
- forticlient_on_net_status - Enable/disable FortiClient-On-Net service for this DHCP server. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| forticlient_on_net_status |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- id - ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- 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 -> 7.6.6 |
- ip_mode - Method used to assign client IP. type: str choices: range, usrgrp
more...
|
Supported Version Ranges |
| ip_mode |
v6.0.0 -> 7.6.6 |
| [range] |
v6.0.0 -> 7.6.6 |
| [usrgrp] |
v6.0.0 -> 7.6.6 |
- ip_range - DHCP IP range configuration. type: list member_path: ip_range:id
more...
| Supported Version Ranges |
| ip_range |
v6.0.0 -> 7.6.6 |
- end_ip - End of IP range. type: str
more...
|
Supported Version Ranges |
| end_ip |
v6.0.0 -> 7.6.6 |
- id - ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- lease_time - Lease time in seconds, 0 means default lease time. type: int
more...
|
Supported Version Ranges |
| lease_time |
v7.2.4 -> 7.6.6 |
- start_ip - Start of IP range. type: str
more...
|
Supported Version Ranges |
| start_ip |
v6.0.0 -> 7.6.6 |
- uci_match - Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| uci_match |
v7.2.4 -> 7.6.6 |
| [disable] |
v7.2.4 -> 7.6.6 |
| [enable] |
v7.2.4 -> 7.6.6 |
- uci_string - One or more UCI strings in quotes separated by spaces. type: list member_path: ip_range:id/uci_string:uci_string
more...
| Supported Version Ranges |
| uci_string |
v7.2.4 -> 7.6.6 |
- uci_string - UCI strings. type: str required: true
more...
|
Supported Version Ranges |
| uci_string |
v7.2.4 -> 7.6.6 |
- vci_match - Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| vci_match |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- vci_string - One or more VCI strings in quotes separated by spaces. type: list member_path: ip_range:id/vci_string:vci_string
more...
| Supported Version Ranges |
| vci_string |
v7.2.1 -> 7.6.6 |
- vci_string - VCI strings. type: str required: true
more...
|
Supported Version Ranges |
| vci_string |
v7.2.1 -> 7.6.6 |
- ipsec_lease_hold - DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry). type: int
more...
|
Supported Version Ranges |
| ipsec_lease_hold |
v6.0.0 -> 7.6.6 |
- lease_time - Lease time in seconds, 0 means unlimited. type: int
more...
|
Supported Version Ranges |
| lease_time |
v6.0.0 -> 7.6.6 |
- mac_acl_default_action - MAC access control default action (allow or block assigning IP settings). type: str choices: assign, block
more...
|
Supported Version Ranges |
| mac_acl_default_action |
v6.0.0 -> 7.6.6 |
| [assign] |
v6.0.0 -> 7.6.6 |
| [block] |
v6.0.0 -> 7.6.6 |
- netmask - Netmask assigned by the DHCP server. type: str
more...
|
Supported Version Ranges |
| netmask |
v6.0.0 -> 7.6.6 |
- next_server - IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from. type: str
more...
|
Supported Version Ranges |
| next_server |
v6.0.0 -> 7.6.6 |
- ntp_server1 - NTP server 1. type: str
more...
|
Supported Version Ranges |
| ntp_server1 |
v6.0.0 -> 7.6.6 |
- ntp_server2 - NTP server 2. type: str
more...
|
Supported Version Ranges |
| ntp_server2 |
v6.0.0 -> 7.6.6 |
- ntp_server3 - NTP server 3. type: str
more...
|
Supported Version Ranges |
| ntp_server3 |
v6.0.0 -> 7.6.6 |
- ntp_service - Options for assigning Network Time Protocol (NTP) servers to DHCP clients. type: str choices: local, default, specify
more...
|
Supported Version Ranges |
| ntp_service |
v6.0.0 -> 7.6.6 |
| [local] |
v6.0.0 -> 7.6.6 |
| [default] |
v6.0.0 -> 7.6.6 |
| [specify] |
v6.0.0 -> 7.6.6 |
- options - DHCP options. type: list member_path: options:id
more...
| Supported Version Ranges |
| options |
v6.0.0 -> 7.6.6 |
- code - DHCP option code. type: int
more...
|
Supported Version Ranges |
| code |
v6.0.0 -> 7.6.6 |
- id - ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- ip - DHCP option IPs. type: list
- type - DHCP option type. type: str choices: hex, string, ip, fqdn
more...
|
Supported Version Ranges |
| type |
v6.0.0 -> 7.6.6 |
| [hex] |
v6.0.0 -> 7.6.6 |
| [string] |
v6.0.0 -> 7.6.6 |
| [ip] |
v6.0.0 -> 7.6.6 |
| [fqdn] |
v6.0.0 -> 7.6.6 |
- uci_match - Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this option. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| uci_match |
v7.2.4 -> 7.6.6 |
| [disable] |
v7.2.4 -> 7.6.6 |
| [enable] |
v7.2.4 -> 7.6.6 |
- uci_string - One or more UCI strings in quotes separated by spaces. type: list member_path: options:id/uci_string:uci_string
more...
| Supported Version Ranges |
| uci_string |
v7.2.4 -> 7.6.6 |
- uci_string - UCI strings. type: str required: true
more...
|
Supported Version Ranges |
| uci_string |
v7.2.4 -> 7.6.6 |
- value - DHCP option value. type: str
more...
|
Supported Version Ranges |
| value |
v6.0.0 -> 7.6.6 |
- vci_match - Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this option. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| vci_match |
v7.2.1 -> 7.6.6 |
| [disable] |
v7.2.1 -> 7.6.6 |
| [enable] |
v7.2.1 -> 7.6.6 |
- vci_string - One or more VCI strings in quotes separated by spaces. type: list member_path: options:id/vci_string:vci_string
more...
| Supported Version Ranges |
| vci_string |
v7.2.1 -> 7.6.6 |
- vci_string - VCI strings. type: str required: true
more...
|
Supported Version Ranges |
| vci_string |
v7.2.1 -> 7.6.6 |
- relay_agent - Relay agent IP. type: str
more...
|
Supported Version Ranges |
| relay_agent |
v7.4.0 -> 7.6.6 |
- reserved_address - Options for the DHCP server to assign IP settings to specific MAC addresses. type: list member_path: reserved_address:id
more...
| Supported Version Ranges |
| reserved_address |
v6.0.0 -> 7.6.6 |
- action - Options for the DHCP server to configure the client with the reserved MAC address. type: str choices: assign, block, reserved
more...
|
Supported Version Ranges |
| action |
v6.0.0 -> 7.6.6 |
| [assign] |
v6.0.0 -> 7.6.6 |
| [block] |
v6.0.0 -> 7.6.6 |
| [reserved] |
v6.0.0 -> 7.6.6 |
- circuit_id - Option 82 circuit-ID of the client that will get the reserved IP address. type: str
more...
|
Supported Version Ranges |
| circuit_id |
v6.2.0 -> 7.6.6 |
- circuit_id_type - DHCP option type. type: str choices: hex, string
more...
|
Supported Version Ranges |
| circuit_id_type |
v6.2.0 -> 7.6.6 |
| [hex] |
v6.2.0 -> 7.6.6 |
| [string] |
v6.2.0 -> 7.6.6 |
- description - Description. type: str
more...
|
Supported Version Ranges |
| description |
v6.0.0 -> 7.6.6 |
- id - ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- ip - IP address to be reserved for the MAC address. type: str
more...
|
Supported Version Ranges |
| ip |
v6.0.0 -> 7.6.6 |
- mac - MAC address of the client that will get the reserved IP address. type: str
more...
|
Supported Version Ranges |
| mac |
v6.0.0 -> 7.6.6 |
- remote_id - Option 82 remote-ID of the client that will get the reserved IP address. type: str
more...
|
Supported Version Ranges |
| remote_id |
v6.2.0 -> 7.6.6 |
- remote_id_type - DHCP option type. type: str choices: hex, string
more...
|
Supported Version Ranges |
| remote_id_type |
v6.2.0 -> 7.6.6 |
| [hex] |
v6.2.0 -> 7.6.6 |
| [string] |
v6.2.0 -> 7.6.6 |
- type - DHCP reserved-address type. type: str choices: mac, option82
more...
|
Supported Version Ranges |
| type |
v6.2.0 -> 7.6.6 |
| [mac] |
v6.2.0 -> 7.6.6 |
| [option82] |
v6.2.0 -> 7.6.6 |
- server_type - DHCP server can be a normal DHCP server or an IPsec DHCP server. type: str choices: regular, ipsec
more...
|
Supported Version Ranges |
| server_type |
v6.0.0 -> 7.6.6 |
| [regular] |
v6.0.0 -> 7.6.6 |
| [ipsec] |
v6.0.0 -> 7.6.6 |
- shared_subnet - Enable/disable shared subnet. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| shared_subnet |
v7.4.0 -> 7.6.6 |
| [disable] |
v7.4.0 -> 7.6.6 |
| [enable] |
v7.4.0 -> 7.6.6 |
- status - Enable/disable this DHCP configuration. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| status |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- tftp_server - One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. type: list member_path: tftp_server:tftp_server
more...
| Supported Version Ranges |
| tftp_server |
v6.0.0 -> 7.6.6 |
- tftp_server - TFTP server. type: str required: true
more...
|
Supported Version Ranges |
| tftp_server |
v6.0.0 -> 7.6.6 |
- timezone - Select the time zone to be assigned to DHCP clients. Source system.timezone.name. type: str choices: 01, 02, 03, 04, 05, 81, 06, 07, 08, 09, 10, 11, 12, 13, 74, 14, 77, 15, 87, 16, 17, 18, 19, 20, 75, 21, 22, 23, 24, 80, 79, 25, 26, 27, 28, 78, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 83, 84, 40, 85, 39, 41, 42, 43, 44, 45, 46, 47, 51, 48, 49, 50, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 00, 82, 73, 86, 76
more...
|
Supported Version Ranges |
| timezone |
v6.0.0 -> 7.6.6 |
| [01] |
v6.0.0 -> v7.4.1 |
| [02] |
v6.0.0 -> v7.4.1 |
| [03] |
v6.0.0 -> v7.4.1 |
| [04] |
v6.0.0 -> v7.4.1 |
| [05] |
v6.0.0 -> v7.4.1 |
| [81] |
v6.0.0 -> v7.4.1 |
| [06] |
v6.0.0 -> v7.4.1 |
| [07] |
v6.0.0 -> v7.4.1 |
| [08] |
v6.0.0 -> v7.4.1 |
| [09] |
v6.0.0 -> v7.4.1 |
| [10] |
v6.0.0 -> v7.4.1 |
| [11] |
v6.0.0 -> v7.4.1 |
| [12] |
v6.0.0 -> v7.4.1 |
| [13] |
v6.0.0 -> v7.4.1 |
| [74] |
v6.0.0 -> v7.4.1 |
| [14] |
v6.0.0 -> v7.4.1 |
| [77] |
v6.0.0 -> v7.4.1 |
| [15] |
v6.0.0 -> v7.4.1 |
| [87] |
v6.0.0 -> v7.4.1 |
| [16] |
v6.0.0 -> v7.4.1 |
| [17] |
v6.0.0 -> v7.4.1 |
| [18] |
v6.0.0 -> v7.4.1 |
| [19] |
v6.0.0 -> v7.4.1 |
| [20] |
v6.0.0 -> v7.4.1 |
| [75] |
v6.0.0 -> v7.4.1 |
| [21] |
v6.0.0 -> v7.4.1 |
| [22] |
v6.0.0 -> v7.4.1 |
| [23] |
v6.0.0 -> v7.4.1 |
| [24] |
v6.0.0 -> v7.4.1 |
| [80] |
v6.0.0 -> v7.4.1 |
| [79] |
v6.0.0 -> v7.4.1 |
| [25] |
v6.0.0 -> v7.4.1 |
| [26] |
v6.0.0 -> v7.4.1 |
| [27] |
v6.0.0 -> v7.4.1 |
| [28] |
v6.0.0 -> v7.4.1 |
| [78] |
v6.0.0 -> v7.4.1 |
| [29] |
v6.0.0 -> v7.4.1 |
| [30] |
v6.0.0 -> v7.4.1 |
| [31] |
v6.0.0 -> v7.4.1 |
| [32] |
v6.0.0 -> v7.4.1 |
| [33] |
v6.0.0 -> v7.4.1 |
| [34] |
v6.0.0 -> v7.4.1 |
| [35] |
v6.0.0 -> v7.4.1 |
| [36] |
v6.0.0 -> v7.4.1 |
| [37] |
v6.0.0 -> v7.4.1 |
| [38] |
v6.0.0 -> v7.4.1 |
| [83] |
v6.0.0 -> v7.4.1 |
| [84] |
v6.0.0 -> v7.4.1 |
| [40] |
v6.0.0 -> v7.4.1 |
| [85] |
v6.0.0 -> v7.4.1 |
| [39] |
v6.0.0 -> v7.4.1 |
| [41] |
v6.0.0 -> v7.4.1 |
| [42] |
v6.0.0 -> v7.4.1 |
| [43] |
v6.0.0 -> v7.4.1 |
| [44] |
v6.0.0 -> v7.4.1 |
| [45] |
v6.0.0 -> v7.4.1 |
| [46] |
v6.0.0 -> v7.4.1 |
| [47] |
v6.0.0 -> v7.4.1 |
| [51] |
v6.0.0 -> v7.4.1 |
| [48] |
v6.0.0 -> v7.4.1 |
| [49] |
v6.0.0 -> v7.4.1 |
| [50] |
v6.0.0 -> v7.4.1 |
| [52] |
v6.0.0 -> v7.4.1 |
| [53] |
v6.0.0 -> v7.4.1 |
| [54] |
v6.0.0 -> v7.4.1 |
| [55] |
v6.0.0 -> v7.4.1 |
| [56] |
v6.0.0 -> v7.4.1 |
| [57] |
v6.0.0 -> v7.4.1 |
| [58] |
v6.0.0 -> v7.4.1 |
| [59] |
v6.0.0 -> v7.4.1 |
| [60] |
v6.0.0 -> v7.4.1 |
| [61] |
v6.0.0 -> v7.4.1 |
| [62] |
v6.0.0 -> v7.4.1 |
| [63] |
v6.0.0 -> v7.4.1 |
| [64] |
v6.0.0 -> v7.4.1 |
| [65] |
v6.0.0 -> v7.4.1 |
| [66] |
v6.0.0 -> v7.4.1 |
| [67] |
v6.0.0 -> v7.4.1 |
| [68] |
v6.0.0 -> v7.4.1 |
| [69] |
v6.0.0 -> v7.4.1 |
| [70] |
v6.0.0 -> v7.4.1 |
| [71] |
v6.0.0 -> v7.4.1 |
| [72] |
v6.0.0 -> v7.4.1 |
| [00] |
v6.0.0 -> v7.4.1 |
| [82] |
v6.0.0 -> v7.4.1 |
| [73] |
v6.0.0 -> v7.4.1 |
| [86] |
v6.0.0 -> v7.4.1 |
| [76] |
v6.0.0 -> v7.4.1 |
- timezone_option - Options for the DHCP server to set the client"s time zone. type: str choices: disable, default, specify
more...
|
Supported Version Ranges |
| timezone_option |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [default] |
v6.0.0 -> 7.6.6 |
| [specify] |
v6.0.0 -> 7.6.6 |
- vci_match - Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| vci_match |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- vci_string - One or more VCI strings in quotes separated by spaces. type: list member_path: vci_string:vci_string
more...
| Supported Version Ranges |
| vci_string |
v6.0.0 -> 7.6.6 |
- vci_string - VCI strings. type: str required: true
more...
|
Supported Version Ranges |
| vci_string |
v6.0.0 -> 7.6.6 |
- wifi_ac_service - Options for assigning WiFi access controllers to DHCP clients. type: str choices: specify, local
more...
|
Supported Version Ranges |
| wifi_ac_service |
v6.2.0 -> 7.6.6 |
| [specify] |
v6.2.0 -> 7.6.6 |
| [local] |
v6.2.0 -> 7.6.6 |
- wifi_ac1 - WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417). type: str
more...
|
Supported Version Ranges |
| wifi_ac1 |
v6.0.0 -> 7.6.6 |
- wifi_ac2 - WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417). type: str
more...
|
Supported Version Ranges |
| wifi_ac2 |
v6.0.0 -> 7.6.6 |
- wifi_ac3 - WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417). type: str
more...
|
Supported Version Ranges |
| wifi_ac3 |
v6.0.0 -> 7.6.6 |
- wins_server1 - WINS server 1. type: str
more...
|
Supported Version Ranges |
| wins_server1 |
v6.0.0 -> 7.6.6 |
- wins_server2 - WINS server 2. type: str
more...
|
Supported Version Ranges |
| wins_server2 |
v6.0.0 -> 7.6.6 |
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
--------
.. code-block:: yaml+jinja
- name: Configure DHCP servers.
fortinet.fortios.fortios_system_dhcp_server:
vdom: "{{ vdom }}"
state: "present"
access_token: ""
system_dhcp_server:
auto_configuration: "disable"
auto_managed_status: "disable"
conflicted_ip_timeout: "1800"
ddns_auth: "disable"
ddns_key: ""
ddns_keyname: ""
ddns_server_ip: ""
ddns_ttl: "300"
ddns_update: "disable"
ddns_update_override: "disable"
ddns_zone: ""
default_gateway: ""
dhcp_settings_from_fortiipam: "disable"
dns_server1: ""
dns_server2: ""
dns_server3: ""
dns_server4: ""
dns_service: "local"
domain: ""
exclude_range:
-
end_ip: ""
id: "24"
lease_time: "0"
start_ip: ""
uci_match: "disable"
uci_string:
-
uci_string: ""
vci_match: "disable"
vci_string:
-
vci_string: ""
filename: ""
forticlient_on_net_status: "disable"
id: "35"
interface: " (source system.interface.name)"
ip_mode: "range"
ip_range:
-
end_ip: ""
id: "40"
lease_time: "0"
start_ip: ""
uci_match: "disable"
uci_string:
-
uci_string: ""
vci_match: "disable"
vci_string:
-
vci_string: ""
ipsec_lease_hold: "60"
lease_time: "604800"
mac_acl_default_action: "assign"
netmask: ""
next_server: ""
ntp_server1: ""
ntp_server2: ""
ntp_server3: ""
ntp_service: "local"
options:
-
code: "0"
id: "60"
ip: ""
type: "hex"
uci_match: "disable"
uci_string:
-
uci_string: ""
value: ""
vci_match: "disable"
vci_string:
-
vci_string: ""
relay_agent: ""
reserved_address:
-
action: "assign"
circuit_id: ""
circuit_id_type: "hex"
description: ""
id: "76"
ip: ""
mac: ""
remote_id: ""
remote_id_type: "hex"
type: "mac"
server_type: "regular"
shared_subnet: "disable"
status: "disable"
tftp_server:
-
tftp_server: ""
timezone: "01"
timezone_option: "disable"
vci_match: "disable"
vci_string:
-
vci_string: ""
wifi_ac_service: "specify"
wifi_ac1: ""
wifi_ac2: ""
wifi_ac3: ""
wins_server1: ""
wins_server2: ""
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:
.. raw:: html
- 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.