:source: fortios_system_dhcp_template.py
:orphan:
.. fortios_system_dhcp_template:
fortios_system_dhcp_template -- Configure DHCP server templates 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 template 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: v8.0.0
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_template - Configure DHCP server templates. type: dict
more...
| Supported Version Ranges |
| system_dhcp_template |
v8.0.0 -> 8.0.0 |
- auto_configuration - Enable/disable auto configuration. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| auto_configuration |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
- ddns_auth - DDNS authentication mode. type: str choices: disable, tsig
more...
|
Supported Version Ranges |
| ddns_auth |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [tsig] |
v8.0.0 -> 8.0.0 |
- ddns_key - DDNS update key (base 64 encoding). type: str
more...
|
Supported Version Ranges |
| ddns_key |
v8.0.0 -> 8.0.0 |
- ddns_keyname - DDNS update key name. type: str
more...
|
Supported Version Ranges |
| ddns_keyname |
v8.0.0 -> 8.0.0 |
- ddns_server_ip - DDNS server IP. type: str
more...
|
Supported Version Ranges |
| ddns_server_ip |
v8.0.0 -> 8.0.0 |
- ddns_ttl - TTL. type: int
more...
|
Supported Version Ranges |
| ddns_ttl |
v8.0.0 -> 8.0.0 |
- ddns_update - Enable/disable DDNS update for DHCP. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| ddns_update |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- ddns_update_override - Enable/disable DDNS update override for DHCP. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| ddns_update_override |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- ddns_zone - Zone of your domain name (ex. DDNS.com). type: str
more...
|
Supported Version Ranges |
| ddns_zone |
v8.0.0 -> 8.0.0 |
- dns_server1 - DNS server 1. type: str
more...
|
Supported Version Ranges |
| dns_server1 |
v8.0.0 -> 8.0.0 |
- dns_server2 - DNS server 2. type: str
more...
|
Supported Version Ranges |
| dns_server2 |
v8.0.0 -> 8.0.0 |
- dns_server3 - DNS server 3. type: str
more...
|
Supported Version Ranges |
| dns_server3 |
v8.0.0 -> 8.0.0 |
- dns_server4 - DNS server 4. type: str
more...
|
Supported Version Ranges |
| dns_server4 |
v8.0.0 -> 8.0.0 |
- dns_service - Options for assigning DNS servers to DHCP clients. type: str choices: local, default, specify
more...
|
Supported Version Ranges |
| dns_service |
v8.0.0 -> 8.0.0 |
| [local] |
v8.0.0 -> 8.0.0 |
| [default] |
v8.0.0 -> 8.0.0 |
| [specify] |
v8.0.0 -> 8.0.0 |
- domain - Domain name suffix for the IP addresses that the DHCP server assigns to clients. type: str
more...
|
Supported Version Ranges |
| domain |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
- id - ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v8.0.0 -> 8.0.0 |
- ip_count - Number of IP addresses to include in the range. type: int
more...
|
Supported Version Ranges |
| ip_count |
v8.0.0 -> 8.0.0 |
- lease_time - Lease time in seconds, 0 means default lease time. type: int
more...
|
Supported Version Ranges |
| lease_time |
v8.0.0 -> 8.0.0 |
- oui_match - Enable/disable organizationally unique identifier (OUI) matching. When enabled only DHCP requests with a matching OUI are served with this range. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| oui_match |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- oui_string - One or more OUI strings in quotes separated by spaces (in format of xx:xx:xx). type: list member_path: exclude_range:id/oui_string:oui_string
more...
| Supported Version Ranges |
| oui_string |
v8.0.0 -> 8.0.0 |
- oui_string - MAC OUI strings. type: str required: true
more...
|
Supported Version Ranges |
| oui_string |
v8.0.0 -> 8.0.0 |
- start_ip_index - Start of IP range. type: int
more...
|
Supported Version Ranges |
| start_ip_index |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
- uci_string - UCI strings. type: str required: true
more...
|
Supported Version Ranges |
| uci_string |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
- vci_string - VCI strings. type: str required: true
more...
|
Supported Version Ranges |
| vci_string |
v8.0.0 -> 8.0.0 |
- vendor - Vendor this ip-range will be assigned to. type: str
more...
|
Supported Version Ranges |
| vendor |
v8.0.0 -> 8.0.0 |
- fabric_force_sync - Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| fabric_force_sync |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
- fabric_object - Security Fabric global object setting. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| fabric_object |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
- fabric_object_source - Source of truth for fabric object. type: str choices: member, local, root
more...
|
Supported Version Ranges |
| fabric_object_source |
v8.0.0 -> 8.0.0 |
| [member] |
v8.0.0 -> 8.0.0 |
| [local] |
v8.0.0 -> 8.0.0 |
| [root] |
v8.0.0 -> 8.0.0 |
- filename - Name of the boot file on the TFTP server. type: str
more...
|
Supported Version Ranges |
| filename |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- ip_range - DHCP IP range configuration. type: list member_path: ip_range:id
more...
| Supported Version Ranges |
| ip_range |
v8.0.0 -> 8.0.0 |
- id - ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v8.0.0 -> 8.0.0 |
- ip_count - Number of IP addresses to include in the range. type: int
more...
|
Supported Version Ranges |
| ip_count |
v8.0.0 -> 8.0.0 |
- lease_time - Lease time in seconds, 0 means default lease time. type: int
more...
|
Supported Version Ranges |
| lease_time |
v8.0.0 -> 8.0.0 |
- oui_match - Enable/disable organizationally unique identifier (OUI) matching. When enabled only DHCP requests with a matching OUI are served with this range. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| oui_match |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- oui_string - One or more OUI strings in quotes separated by spaces (in format of xx:xx:xx). type: list member_path: ip_range:id/oui_string:oui_string
more...
| Supported Version Ranges |
| oui_string |
v8.0.0 -> 8.0.0 |
- oui_string - MAC OUI strings. type: str required: true
more...
|
Supported Version Ranges |
| oui_string |
v8.0.0 -> 8.0.0 |
- reserve - Enable/disable address reservation for use without DHCP. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| reserve |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
- uci_string - UCI strings. type: str required: true
more...
|
Supported Version Ranges |
| uci_string |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
- vci_string - VCI strings. type: str required: true
more...
|
Supported Version Ranges |
| vci_string |
v8.0.0 -> 8.0.0 |
- vendor - Vendor this ip-range will be assigned to. type: str
more...
|
Supported Version Ranges |
| vendor |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
- lease_time - Lease time in seconds, 0 means unlimited. type: int
more...
|
Supported Version Ranges |
| lease_time |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
| [assign] |
v8.0.0 -> 8.0.0 |
| [block] |
v8.0.0 -> 8.0.0 |
- name - DHCP server template name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v8.0.0 -> 8.0.0 |
- next_server - IP address of a server, such as a TFTP server, from which DHCP clients can download a boot file. type: str
more...
|
Supported Version Ranges |
| next_server |
v8.0.0 -> 8.0.0 |
- ntp_server1 - NTP server 1. type: str
more...
|
Supported Version Ranges |
| ntp_server1 |
v8.0.0 -> 8.0.0 |
- ntp_server2 - NTP server 2. type: str
more...
|
Supported Version Ranges |
| ntp_server2 |
v8.0.0 -> 8.0.0 |
- ntp_server3 - NTP server 3. type: str
more...
|
Supported Version Ranges |
| ntp_server3 |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
| [local] |
v8.0.0 -> 8.0.0 |
| [default] |
v8.0.0 -> 8.0.0 |
| [specify] |
v8.0.0 -> 8.0.0 |
- options - DHCP options. type: list member_path: options:id
more...
| Supported Version Ranges |
| options |
v8.0.0 -> 8.0.0 |
- code - DHCP option code. type: int
more...
|
Supported Version Ranges |
| code |
v8.0.0 -> 8.0.0 |
- id - ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v8.0.0 -> 8.0.0 |
- ip - DHCP option IPs. type: list
- type - DHCP option type. type: str choices: hex, string, ip, fqdn
more...
|
Supported Version Ranges |
| type |
v8.0.0 -> 8.0.0 |
| [hex] |
v8.0.0 -> 8.0.0 |
| [string] |
v8.0.0 -> 8.0.0 |
| [ip] |
v8.0.0 -> 8.0.0 |
| [fqdn] |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
- uci_string - UCI strings. type: str required: true
more...
|
Supported Version Ranges |
| uci_string |
v8.0.0 -> 8.0.0 |
- value - DHCP option value. type: str
more...
|
Supported Version Ranges |
| value |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
- vci_string - VCI strings. type: str required: true
more...
|
Supported Version Ranges |
| vci_string |
v8.0.0 -> 8.0.0 |
- relay_agent - Relay agent IP. type: str
more...
|
Supported Version Ranges |
| relay_agent |
v8.0.0 -> 8.0.0 |
- reserve_extra_addresses - Enable/disable reservation of the extra IP addresses in the subnet. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| reserve_extra_addresses |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
| [assign] |
v8.0.0 -> 8.0.0 |
| [block] |
v8.0.0 -> 8.0.0 |
| [reserved] |
v8.0.0 -> 8.0.0 |
- circuit_id - Option 82 circuit-ID of the client that will get the reserved IP address. type: str
more...
|
Supported Version Ranges |
| circuit_id |
v8.0.0 -> 8.0.0 |
- circuit_id_type - DHCP option type. type: str choices: hex, string
more...
|
Supported Version Ranges |
| circuit_id_type |
v8.0.0 -> 8.0.0 |
| [hex] |
v8.0.0 -> 8.0.0 |
| [string] |
v8.0.0 -> 8.0.0 |
- description - Description. type: str
more...
|
Supported Version Ranges |
| description |
v8.0.0 -> 8.0.0 |
- id - ID. see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v8.0.0 -> 8.0.0 |
- ip_index - Index of IP address to be reserved for the MAC address. type: int
more...
|
Supported Version Ranges |
| ip_index |
v8.0.0 -> 8.0.0 |
- mac - MAC address of the client that will get the reserved IP address. type: str
more...
|
Supported Version Ranges |
| mac |
v8.0.0 -> 8.0.0 |
- remote_id - Option 82 remote-ID of the client that will get the reserved IP address. type: str
more...
|
Supported Version Ranges |
| remote_id |
v8.0.0 -> 8.0.0 |
- remote_id_type - DHCP option type. type: str choices: hex, string
more...
|
Supported Version Ranges |
| remote_id_type |
v8.0.0 -> 8.0.0 |
| [hex] |
v8.0.0 -> 8.0.0 |
| [string] |
v8.0.0 -> 8.0.0 |
- type - DHCP reserved-address type. type: str choices: mac, option82
more...
|
Supported Version Ranges |
| type |
v8.0.0 -> 8.0.0 |
| [mac] |
v8.0.0 -> 8.0.0 |
| [option82] |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
| [regular] |
v8.0.0 -> 8.0.0 |
| [ipsec] |
v8.0.0 -> 8.0.0 |
- shared_subnet - Enable/disable shared subnet. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| shared_subnet |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
- tftp_server - TFTP server. type: str required: true
more...
|
Supported Version Ranges |
| tftp_server |
v8.0.0 -> 8.0.0 |
- timezone - Select the time zone to be assigned to DHCP clients. Source system.timezone.name. type: str
more...
|
Supported Version Ranges |
| timezone |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [default] |
v8.0.0 -> 8.0.0 |
| [specify] |
v8.0.0 -> 8.0.0 |
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str
more...
|
Supported Version Ranges |
| uuid |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
| [disable] |
v8.0.0 -> 8.0.0 |
| [enable] |
v8.0.0 -> 8.0.0 |
- 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 |
v8.0.0 -> 8.0.0 |
- vci_string - VCI strings. type: str required: true
more...
|
Supported Version Ranges |
| vci_string |
v8.0.0 -> 8.0.0 |
- wifi_ac_service - Options for assigning WiFi access controllers to DHCP clients. type: str choices: specify, local
more...
|
Supported Version Ranges |
| wifi_ac_service |
v8.0.0 -> 8.0.0 |
| [specify] |
v8.0.0 -> 8.0.0 |
| [local] |
v8.0.0 -> 8.0.0 |
- wifi_ac1 - WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417). type: str
more...
|
Supported Version Ranges |
| wifi_ac1 |
v8.0.0 -> 8.0.0 |
- wifi_ac2 - WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417). type: str
more...
|
Supported Version Ranges |
| wifi_ac2 |
v8.0.0 -> 8.0.0 |
- wifi_ac3 - WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417). type: str
more...
|
Supported Version Ranges |
| wifi_ac3 |
v8.0.0 -> 8.0.0 |
- wins_server1 - WINS server 1. type: str
more...
|
Supported Version Ranges |
| wins_server1 |
v8.0.0 -> 8.0.0 |
- wins_server2 - WINS server 2. type: str
more...
|
Supported Version Ranges |
| wins_server2 |
v8.0.0 -> 8.0.0 |
Notes
-----
.. note::
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
--------
.. code-block:: yaml+jinja
- name: Configure DHCP server templates.
fortinet.fortios.fortios_system_dhcp_template:
vdom: "{{ vdom }}"
state: "present"
access_token: ""
system_dhcp_template:
auto_configuration: "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: ""
dns_server1: ""
dns_server2: ""
dns_server3: ""
dns_server4: ""
dns_service: "local"
domain: ""
exclude_range:
-
id: "20"
ip_count: "0"
lease_time: "0"
oui_match: "disable"
oui_string:
-
oui_string: ""
start_ip_index: "0"
uci_match: "disable"
uci_string:
-
uci_string: ""
vci_match: "disable"
vci_string:
-
vci_string: ""
vendor: ""
fabric_force_sync: "enable"
fabric_object: "enable"
fabric_object_source: "member"
filename: ""
forticlient_on_net_status: "disable"
ip_range:
-
id: "40"
ip_count: "0"
lease_time: "0"
oui_match: "disable"
oui_string:
-
oui_string: ""
reserve: "disable"
uci_match: "disable"
uci_string:
-
uci_string: ""
vci_match: "disable"
vci_string:
-
vci_string: ""
vendor: ""
ipsec_lease_hold: "60"
lease_time: "604800"
mac_acl_default_action: "assign"
name: "default_name_57"
next_server: ""
ntp_server1: ""
ntp_server2: ""
ntp_server3: ""
ntp_service: "local"
options:
-
code: "0"
id: "65"
ip: ""
type: "hex"
uci_match: "disable"
uci_string:
-
uci_string: ""
value: ""
vci_match: "disable"
vci_string:
-
vci_string: ""
relay_agent: ""
reserve_extra_addresses: "disable"
reserved_address:
-
action: "assign"
circuit_id: ""
circuit_id_type: "hex"
description: ""
id: "82"
ip_index: "0"
mac: ""
remote_id: ""
remote_id_type: "hex"
type: "mac"
server_type: "regular"
shared_subnet: "disable"
tftp_server:
-
tftp_server: ""
timezone: " (source system.timezone.name)"
timezone_option: "disable"
uuid: ""
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.