fortinet.fortimanager.fmgr_system_dhcp_server module – Configure DHCP servers.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

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.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_dhcp_server.

New in fortinet.fortimanager 2.0.0

Synopsis

  • This module is able to configure a FortiManager device.

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

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

system_dhcp_server

dictionary

The top level parameters set.

auto-configuration

string

Deprecated, please rename it to auto_configuration. Enable/disable auto configuration.

Choices:

  • "disable"

  • "enable"

auto-managed-status

string

Deprecated, please rename it to auto_managed_status. Enable/disable use of this DHCP server once this interface has been a…

Choices:

  • "disable"

  • "enable"

conflicted-ip-timeout

integer

Deprecated, please rename it to conflicted_ip_timeout. Time in seconds to wait after a conflicted IP address is removed fr…

ddns-auth

string

Deprecated, please rename it to ddns_auth. DDNS authentication mode.

Choices:

  • "disable"

  • "tsig"

ddns-key

any

(list or str) Deprecated, please rename it to ddns_key. DDNS update key

ddns-keyname

string

Deprecated, please rename it to ddns_keyname. DDNS update key name.

ddns-server-ip

string

Deprecated, please rename it to ddns_server_ip. DDNS server IP.

ddns-ttl

integer

Deprecated, please rename it to ddns_ttl. TTL.

ddns-update

string

Deprecated, please rename it to ddns_update. Enable/disable DDNS update for DHCP.

Choices:

  • "disable"

  • "enable"

ddns-update-override

string

Deprecated, please rename it to ddns_update_override. Enable/disable DDNS update override for DHCP.

Choices:

  • "disable"

  • "enable"

ddns-zone

string

Deprecated, please rename it to ddns_zone. Zone of your domain name

default-gateway

string

Deprecated, please rename it to default_gateway. Default gateway IP address assigned by the DHCP server.

dhcp-settings-from-fortiipam

string

Deprecated, please rename it to dhcp_settings_from_fortiipam. Enable/disable populating of DHCP server settings from Forti…

Choices:

  • "disable"

  • "enable"

dns-server1

string

Deprecated, please rename it to dns_server1. DNS server 1.

dns-server2

string

Deprecated, please rename it to dns_server2. DNS server 2.

dns-server3

string

Deprecated, please rename it to dns_server3. DNS server 3.

dns-server4

string

Deprecated, please rename it to dns_server4. DNS server 4.

dns-service

string

Deprecated, please rename it to dns_service. Options for assigning DNS servers to DHCP clients.

Choices:

  • "default"

  • "specify"

  • "local"

domain

string

Domain name suffix for the IP addresses that the DHCP server assigns to clients.

exclude-range

list / elements=dictionary

Deprecated, please rename it to exclude_range. Exclude range.

end-ip

string

Deprecated, please rename it to end_ip. End of IP range.

id

integer

ID.

lease-time

integer

Deprecated, please rename it to lease_time. Lease time in seconds, 0 means default lease time.

start-ip

string

Deprecated, please rename it to start_ip. Start of IP range.

uci-match

string

Deprecated, please rename it to uci_match. Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci-string

any

(list) Deprecated, please rename it to uci_string. One or more UCI strings in quotes separated by spaces.

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string. One or more VCI strings in quotes separated by spaces.

filename

string

Name of the boot file on the TFTP server.

forticlient-on-net-status

string

Deprecated, please rename it to forticlient_on_net_status. Enable/disable FortiClient-On-Net service for this DHCP server.

Choices:

  • "disable"

  • "enable"

id

integer / required

ID.

interface

string

DHCP server can assign IP configurations to clients connected to this interface.

ip-mode

string

Deprecated, please rename it to ip_mode. Method used to assign client IP.

Choices:

  • "range"

  • "usrgrp"

ip-range

list / elements=dictionary

Deprecated, please rename it to ip_range. Ip range.

end-ip

string

Deprecated, please rename it to end_ip. End of IP range.

id

integer

ID.

lease-time

integer

Deprecated, please rename it to lease_time. Lease time in seconds, 0 means default lease time.

start-ip

string

Deprecated, please rename it to start_ip. Start of IP range.

uci-match

string

Deprecated, please rename it to uci_match. Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci-string

any

(list) Deprecated, please rename it to uci_string. One or more UCI strings in quotes separated by spaces.

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string. One or more VCI strings in quotes separated by spaces.

ipsec-lease-hold

integer

Deprecated, please rename it to ipsec_lease_hold. DHCP over IPsec leases expire this many seconds after tunnel down

lease-time

integer

Deprecated, please rename it to lease_time. Lease time in seconds, 0 means unlimited.

mac-acl-default-action

string

Deprecated, please rename it to mac_acl_default_action. MAC access control default action

Choices:

  • "assign"

  • "block"

netmask

string

Netmask assigned by the DHCP server.

next-server

string

Deprecated, please rename it to next_server. IP address of a server

ntp-server1

string

Deprecated, please rename it to ntp_server1. NTP server 1.

ntp-server2

string

Deprecated, please rename it to ntp_server2. NTP server 2.

ntp-server3

string

Deprecated, please rename it to ntp_server3. NTP server 3.

ntp-service

string

Deprecated, please rename it to ntp_service. Options for assigning Network Time Protocol

Choices:

  • "default"

  • "specify"

  • "local"

options

list / elements=dictionary

Options.

code

integer

DHCP option code.

id

integer

ID.

ip

any

(list) DHCP option IPs.

type

string

DHCP option type.

Choices:

  • "hex"

  • "string"

  • "ip"

  • "fqdn"

uci-match

string

Deprecated, please rename it to uci_match. Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci-string

any

(list) Deprecated, please rename it to uci_string. One or more UCI strings in quotes separated by spaces.

value

string

DHCP option value.

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string. One or more VCI strings in quotes separated by spaces.

relay-agent

string

Deprecated, please rename it to relay_agent. Relay agent IP.

reserved-address

list / elements=dictionary

Deprecated, please rename it to reserved_address. Reserved address.

action

string

Options for the DHCP server to configure the client with the reserved MAC address.

Choices:

  • "assign"

  • "block"

  • "reserved"

circuit-id

string

Deprecated, please rename it to circuit_id. Option 82 circuit-ID of the client that will get the reserved IP address.

circuit-id-type

string

Deprecated, please rename it to circuit_id_type. DHCP option type.

Choices:

  • "hex"

  • "string"

description

string

Description.

id

integer

ID.

ip

string

IP address to be reserved for the MAC address.

mac

string

MAC address of the client that will get the reserved IP address.

remote-id

string

Deprecated, please rename it to remote_id. Option 82 remote-ID of the client that will get the reserved IP address.

remote-id-type

string

Deprecated, please rename it to remote_id_type. DHCP option type.

Choices:

  • "hex"

  • "string"

type

string

DHCP reserved-address type.

Choices:

  • "mac"

  • "option82"

server-type

string

Deprecated, please rename it to server_type. DHCP server can be a normal DHCP server or an IPsec DHCP server.

Choices:

  • "regular"

  • "ipsec"

shared-subnet

string

Deprecated, please rename it to shared_subnet. Enable/disable shared subnet.

Choices:

  • "disable"

  • "enable"

status

string

Enable/disable this DHCP configuration.

Choices:

  • "disable"

  • "enable"

tftp-server

any

(list) Deprecated, please rename it to tftp_server. One or more hostnames or IP addresses of the TFTP servers in quotes se…

timezone

string

Select the time zone to be assigned to DHCP clients.

Choices:

  • "00"

  • "01"

  • "02"

  • "03"

  • "04"

  • "05"

  • "06"

  • "07"

  • "08"

  • "09"

  • "10"

  • "11"

  • "12"

  • "13"

  • "14"

  • "15"

  • "16"

  • "17"

  • "18"

  • "19"

  • "20"

  • "21"

  • "22"

  • "23"

  • "24"

  • "25"

  • "26"

  • "27"

  • "28"

  • "29"

  • "30"

  • "31"

  • "32"

  • "33"

  • "34"

  • "35"

  • "36"

  • "37"

  • "38"

  • "39"

  • "40"

  • "41"

  • "42"

  • "43"

  • "44"

  • "45"

  • "46"

  • "47"

  • "48"

  • "49"

  • "50"

  • "51"

  • "52"

  • "53"

  • "54"

  • "55"

  • "56"

  • "57"

  • "58"

  • "59"

  • "60"

  • "61"

  • "62"

  • "63"

  • "64"

  • "65"

  • "66"

  • "67"

  • "68"

  • "69"

  • "70"

  • "71"

  • "72"

  • "73"

  • "74"

  • "75"

  • "76"

  • "77"

  • "78"

  • "79"

  • "80"

  • "81"

  • "82"

  • "83"

  • "84"

  • "85"

  • "86"

  • "87"

timezone-option

string

Deprecated, please rename it to timezone_option. Options for the DHCP server to set the clients time zone.

Choices:

  • "disable"

  • "default"

  • "specify"

vci-match

string

Deprecated, please rename it to vci_match. Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci-string

any

(list) Deprecated, please rename it to vci_string. One or more VCI strings in quotes separated by spaces.

wifi-ac-service

string

Deprecated, please rename it to wifi_ac_service. Options for assigning WiFi Access Controllers to DHCP clients

Choices:

  • "specify"

  • "local"

wifi-ac1

string

Deprecated, please rename it to wifi_ac1. WiFi Access Controller 1 IP address

wifi-ac2

string

Deprecated, please rename it to wifi_ac2. WiFi Access Controller 2 IP address

wifi-ac3

string

Deprecated, please rename it to wifi_ac3. WiFi Access Controller 3 IP address

wins-server1

string

Deprecated, please rename it to wins_server1. WINS server 1.

wins-server2

string

Deprecated, please rename it to wins_server2. WINS server 2.

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure DHCP servers.
      fortinet.fortimanager.fmgr_system_dhcp_server:
        bypass_validation: false
        adom: ansible
        state: present
        system_dhcp_server:
          auto-configuration: enable # <value in [disable, enable]>
          default-gateway: "222.222.222.1"
          filename: ansible-file
          id: 1
          interface: any
          ip-mode: range # <value in [range, usrgrp]>
          ip-range:
            - end-ip: 222.222.222.22
              id: 1
              start-ip: 222.222.222.2
          netmask: 255.255.255.0
          server-type: regular # <value in [regular, ipsec]>
          status: disable # <value in [disable, enable]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the DHCP servers
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_dhcp_server"
          params:
            adom: "ansible"
            server: "your_value"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)