Docs4dev
Docs
ansible / 2.11 / collections / fortinet / fortimanager / fmgr_system_dhcp_server_module.html

fortinet.fortimanager.fmgr_system_dhcp_server – Configure DHCP servers.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

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 version 2.10: of fortinet.fortimanager

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
system_dhcp_server
dictionary
the top level parameters set
auto-configuration
string
    Choices:
  • disable
  • enable
Enable/disable auto configuration.
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
string
    Choices:
  • disable
  • tsig
DDNS authentication mode.
ddns-key
string
DDNS update key (base 64 encoding).
ddns-keyname
string
DDNS update key name.
ddns-server-ip
string
DDNS server IP.
ddns-ttl
integer
TTL.
ddns-update
string
    Choices:
  • disable
  • enable
Enable/disable DDNS update for DHCP.
ddns-update-override
string
    Choices:
  • disable
  • enable
Enable/disable DDNS update override for DHCP.
ddns-zone
string
Zone of your domain name (ex. DDNS.com).
default-gateway
string
Default gateway IP address assigned by the DHCP server.
dns-server1
string
DNS server 1.
dns-server2
string
DNS server 2.
dns-server3
string
DNS server 3.
dns-service
string
    Choices:
  • default
  • specify
  • local
Options for assigning DNS servers to DHCP clients.
domain
string
Domain name suffix for the IP addresses that the DHCP server assigns to clients.
exclude-range
list / elements=string
no description
end-ip
string
End of IP range.
id
integer
ID.
start-ip
string
Start of IP range.
filename
string
Name of the boot file on the TFTP server.
forticlient-on-net-status
string
    Choices:
  • disable
  • enable
Enable/disable FortiClient-On-Net service for this DHCP server.
id
integer
ID.
interface
string
DHCP server can assign IP configurations to clients connected to this interface.
ip-mode
string
    Choices:
  • range
  • usrgrp
Method used to assign client IP.
ip-range
list / elements=string
no description
end-ip
string
End of IP range.
id
integer
ID.
start-ip
string
Start of IP range.
ipsec-lease-hold
integer
DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry).
lease-time
integer
Lease time in seconds, 0 means unlimited.
mac-acl-default-action
string
    Choices:
  • assign
  • block
MAC access control default action (allow or block assigning IP settings).
netmask
string
Netmask assigned by the DHCP server.
next-server
string
IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from.
ntp-server1
string
NTP server 1.
ntp-server2
string
NTP server 2.
ntp-server3
string
NTP server 3.
ntp-service
string
    Choices:
  • default
  • specify
  • local
Options for assigning Network Time Protocol (NTP) servers to DHCP clients.
options
list / elements=string
no description
code
integer
DHCP option code.
id
integer
ID.
ip
string
no description
type
string
    Choices:
  • hex
  • string
  • ip
  • fqdn
DHCP option type.
value
string
DHCP option value.
reserved-address
list / elements=string
no description
action
string
    Choices:
  • assign
  • block
  • reserved
Options for the DHCP server to configure the client with the reserved MAC address.
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.
server-type
string
    Choices:
  • regular
  • ipsec
DHCP server can be a normal DHCP server or an IPsec DHCP server.
status
string
    Choices:
  • disable
  • enable
Enable/disable this DHCP configuration.
tftp-server
string
no description
timezone
string
    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
Select the time zone to be assigned to DHCP clients.
timezone-option
string
    Choices:
  • disable
  • default
  • specify
Options for the DHCP server to set the clients time zone.
vci-match
string
    Choices:
  • disable
  • enable
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served.
vci-string
string
no description
wifi-ac1
string
WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417).
wifi-ac2
string
WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417).
wifi-ac3
string
WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417).
wins-server1
string
WINS server 1.
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • 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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure DHCP servers.
     fmgr_system_dhcp_server:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        system_dhcp_server:
           auto-configuration: <value in [disable, enable]>
           conflicted-ip-timeout: <value of integer>
           ddns-auth: <value in [disable, tsig]>
           ddns-key: <value of string>
           ddns-keyname: <value of string>
           ddns-server-ip: <value of string>
           ddns-ttl: <value of integer>
           ddns-update: <value in [disable, enable]>
           ddns-update-override: <value in [disable, enable]>
           ddns-zone: <value of string>
           default-gateway: <value of string>
           dns-server1: <value of string>
           dns-server2: <value of string>
           dns-server3: <value of string>
           dns-service: <value in [default, specify, local]>
           domain: <value of string>
           exclude-range:
             -
                 end-ip: <value of string>
                 id: <value of integer>
                 start-ip: <value of string>
           filename: <value of string>
           forticlient-on-net-status: <value in [disable, enable]>
           id: <value of integer>
           interface: <value of string>
           ip-mode: <value in [range, usrgrp]>
           ip-range:
             -
                 end-ip: <value of string>
                 id: <value of integer>
                 start-ip: <value of string>
           ipsec-lease-hold: <value of integer>
           lease-time: <value of integer>
           mac-acl-default-action: <value in [assign, block]>
           netmask: <value of string>
           next-server: <value of string>
           ntp-server1: <value of string>
           ntp-server2: <value of string>
           ntp-server3: <value of string>
           ntp-service: <value in [default, specify, local]>
           options:
             -
                 code: <value of integer>
                 id: <value of integer>
                 ip: <value of string>
                 type: <value in [hex, string, ip, ...]>
                 value: <value of string>
           reserved-address:
             -
                 action: <value in [assign, block, reserved]>
                 description: <value of string>
                 id: <value of integer>
                 ip: <value of string>
                 mac: <value of string>
           server-type: <value in [regular, ipsec]>
           status: <value in [disable, enable]>
           tftp-server: <value of string>
           timezone: <value in [00, 01, 02, ...]>
           timezone-option: <value in [disable, default, specify]>
           vci-match: <value in [disable, enable]>
           vci-string: <value of string>
           wifi-ac1: <value of string>
           wifi-ac2: <value of string>
           wifi-ac3: <value of string>
           wins-server1: <value of string>
           wins-server2: <value of string>

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_dhcp_server_module.html