fortinet.fortimanager.fmgr_system_dhcp_server module – Configure DHCP servers.

Note

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

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

aliases: auto-configuration

string

Enable/disable auto configuration.

Choices:

  • "disable"

  • "enable"

auto_managed_status

aliases: auto-managed-status

string

Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM.

Choices:

  • "disable"

  • "enable"

conflicted_ip_timeout

aliases: conflicted-ip-timeout

integer

Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused.

ddns_auth

aliases: ddns-auth

string

DDNS authentication mode.

Choices:

  • "disable"

  • "tsig"

ddns_key

aliases: ddns-key

any

(list or str) DDNS update key

ddns_keyname

aliases: ddns-keyname

string

DDNS update key name.

ddns_server_ip

aliases: ddns-server-ip

string

DDNS server IP.

ddns_ttl

aliases: ddns-ttl

integer

TTL.

ddns_update

aliases: ddns-update

string

Enable/disable DDNS update for DHCP.

Choices:

  • "disable"

  • "enable"

ddns_update_override

aliases: ddns-update-override

string

Enable/disable DDNS update override for DHCP.

Choices:

  • "disable"

  • "enable"

ddns_zone

aliases: ddns-zone

string

Zone of your domain name

default_gateway

aliases: default-gateway

string

Default gateway IP address assigned by the DHCP server.

dhcp_settings_from_fortiipam

aliases: dhcp-settings-from-fortiipam

string

Enable/disable populating of DHCP server settings from FortiIPAM.

Choices:

  • "disable"

  • "enable"

dns_server1

aliases: dns-server1

string

DNS server 1.

dns_server2

aliases: dns-server2

string

DNS server 2.

dns_server3

aliases: dns-server3

string

DNS server 3.

dns_server4

aliases: dns-server4

string

DNS server 4.

dns_service

aliases: dns-service

string

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

aliases: exclude-range

list / elements=dictionary

Exclude range.

end_ip

aliases: end-ip

string

End of IP range.

id

integer

ID.

lease_time

aliases: lease-time

integer

Lease time in seconds, 0 means default lease time.

start_ip

aliases: start-ip

string

Start of IP range.

uci_match

aliases: uci-match

string

Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci_string

aliases: uci-string

any

(list) One or more UCI strings in quotes separated by spaces.

vci_match

aliases: vci-match

string

Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci_string

aliases: vci-string

any

(list) 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

aliases: forticlient-on-net-status

string

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

aliases: ip-mode

string

Method used to assign client IP.

Choices:

  • "range"

  • "usrgrp"

ip_range

aliases: ip-range

list / elements=dictionary

Ip range.

end_ip

aliases: end-ip

string

End of IP range.

id

integer

ID.

lease_time

aliases: lease-time

integer

Lease time in seconds, 0 means default lease time.

start_ip

aliases: start-ip

string

Start of IP range.

uci_match

aliases: uci-match

string

Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci_string

aliases: uci-string

any

(list) One or more UCI strings in quotes separated by spaces.

vci_match

aliases: vci-match

string

Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci_string

aliases: vci-string

any

(list) One or more VCI strings in quotes separated by spaces.

ipsec_lease_hold

aliases: ipsec-lease-hold

integer

DHCP over IPsec leases expire this many seconds after tunnel down

lease_time

aliases: lease-time

integer

Lease time in seconds, 0 means unlimited.

mac_acl_default_action

aliases: mac-acl-default-action

string

MAC access control default action

Choices:

  • "assign"

  • "block"

netmask

string

Netmask assigned by the DHCP server.

next_server

aliases: next-server

string

IP address of a server

ntp_server1

aliases: ntp-server1

string

NTP server 1.

ntp_server2

aliases: ntp-server2

string

NTP server 2.

ntp_server3

aliases: ntp-server3

string

NTP server 3.

ntp_service

aliases: ntp-service

string

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

aliases: uci-match

string

Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci_string

aliases: uci-string

any

(list) One or more UCI strings in quotes separated by spaces.

value

string

DHCP option value.

vci_match

aliases: vci-match

string

Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci_string

aliases: vci-string

any

(list) One or more VCI strings in quotes separated by spaces.

relay_agent

aliases: relay-agent

string

Relay agent IP.

reserved_address

aliases: reserved-address

list / elements=dictionary

Reserved address.

action

string

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

Choices:

  • "assign"

  • "block"

  • "reserved"

circuit_id

aliases: circuit-id

string

Option 82 circuit-ID of the client that will get the reserved IP address.

circuit_id_type

aliases: circuit-id-type

string

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

aliases: remote-id

string

Option 82 remote-ID of the client that will get the reserved IP address.

remote_id_type

aliases: remote-id-type

string

DHCP option type.

Choices:

  • "hex"

  • "string"

type

string

DHCP reserved-address type.

Choices:

  • "mac"

  • "option82"

server_type

aliases: server-type

string

DHCP server can be a normal DHCP server or an IPsec DHCP server.

Choices:

  • "regular"

  • "ipsec"

shared_subnet

aliases: shared-subnet

string

Enable/disable shared subnet.

Choices:

  • "disable"

  • "enable"

status

string

Enable/disable this DHCP configuration.

Choices:

  • "disable"

  • "enable"

tftp_server

aliases: tftp-server

any

(list) One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces.

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

aliases: timezone-option

string

Options for the DHCP server to set the clients time zone.

Choices:

  • "disable"

  • "default"

  • "specify"

vci_match

aliases: vci-match

string

Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci_string

aliases: vci-string

any

(list) One or more VCI strings in quotes separated by spaces.

wifi_ac1

aliases: wifi-ac1

string

WiFi Access Controller 1 IP address

wifi_ac2

aliases: wifi-ac2

string

WiFi Access Controller 2 IP address

wifi_ac3

aliases: wifi-ac3

string

WiFi Access Controller 3 IP address

wifi_ac_service

aliases: wifi-ac-service

string

Options for assigning WiFi Access Controllers to DHCP clients

Choices:

  • "specify"

  • "local"

wins_server1

aliases: wins-server1

string

WINS server 1.

wins_server2

aliases: wins-server2

string

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)