fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver 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_fsp_vlan_dhcpserver.

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.
fsp_vlan_dhcpserver dictionary	The top level parameters set.
auto-configuration string	Deprecated, please rename it to auto_configuration. Auto configuration. Choices: "disable" "enable"
auto-managed-status string	Deprecated, please rename it to auto_managed_status. Auto managed status. Choices: "disable" "enable"
conflicted-ip-timeout integer	Deprecated, please rename it to conflicted_ip_timeout. Conflicted ip timeout.
ddns-auth string	Deprecated, please rename it to ddns_auth. Ddns auth. Choices: "disable" "tsig"
ddns-key any	(list or str) Deprecated, please rename it to ddns_key. Ddns key.
ddns-keyname string	Deprecated, please rename it to ddns_keyname. Ddns keyname.
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. Ddns ttl.
ddns-update string	Deprecated, please rename it to ddns_update. Ddns update. Choices: "disable" "enable"
ddns-update-override string	Deprecated, please rename it to ddns_update_override. Ddns update override. Choices: "disable" "enable"
ddns-zone string	Deprecated, please rename it to ddns_zone. Ddns zone.
default-gateway string	Deprecated, please rename it to default_gateway. Default gateway.
dhcp-settings-from-fortiipam string	Deprecated, please rename it to dhcp_settings_from_fortiipam. Dhcp settings from fortiipam. Choices: "disable" "enable"
dns-server1 string	Deprecated, please rename it to dns_server1. Dns server1.
dns-server2 string	Deprecated, please rename it to dns_server2. Dns server2.
dns-server3 string	Deprecated, please rename it to dns_server3. Dns server3.
dns-server4 string	Deprecated, please rename it to dns_server4. Dns server4.
dns-service string	Deprecated, please rename it to dns_service. Dns service. Choices: "default" "specify" "local"
domain string	Domain.
enable string	Enable. Choices: "disable" "enable"
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 ip.
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 ip.
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	Filename.
forticlient-on-net-status string	Deprecated, please rename it to forticlient_on_net_status. Forticlient on net status. Choices: "disable" "enable"
id integer	Id.
interface string	Interface.
ip-mode string	Deprecated, please rename it to ip_mode. Ip mode. 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 ip.
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 ip.
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. Ipsec lease hold.
lease-time integer	Deprecated, please rename it to lease_time. Lease time.
mac-acl-default-action string	Deprecated, please rename it to mac_acl_default_action. Mac acl default action. Choices: "assign" "block"
netmask string	Netmask.
next-server string	Deprecated, please rename it to next_server. Next server.
ntp-server1 string	Deprecated, please rename it to ntp_server1. Ntp server1.
ntp-server2 string	Deprecated, please rename it to ntp_server2. Ntp server2.
ntp-server3 string	Deprecated, please rename it to ntp_server3. Ntp server3.
ntp-service string	Deprecated, please rename it to ntp_service. Ntp service. Choices: "default" "specify" "local"
option1 any	(list) Option1.
option2 any	(list) Option2.
option3 any	(list) Option3.
option4 string	Option4.
option5 string	Option5.
option6 string	Option6.
options list / elements=dictionary	Options.
code integer	Code.
id integer	Id.
ip any	(list) Ip.
type string	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	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	Action. Choices: "assign" "block" "reserved"
circuit-id string	Deprecated, please rename it to circuit_id. Circuit id.
circuit-id-type string	Deprecated, please rename it to circuit_id_type. Circuit id type. Choices: "hex" "string"
description string	Description.
id integer	Id.
ip string	Ip.
mac string	Mac.
remote-id string	Deprecated, please rename it to remote_id. Remote id.
remote-id-type string	Deprecated, please rename it to remote_id_type. Remote id type. Choices: "hex" "string"
type string	Type. Choices: "mac" "option82"
server-type string	Deprecated, please rename it to server_type. Server type. Choices: "regular" "ipsec"
shared-subnet string	Deprecated, please rename it to shared_subnet. Enable/disable shared subnet. Choices: "disable" "enable"
status string	Status. Choices: "disable" "enable"
tftp-server any	(list) Deprecated, please rename it to tftp_server. Tftp server.
timezone string	Timezone. 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. Timezone option. Choices: "disable" "default" "specify"
vci-match string	Deprecated, please rename it to vci_match. Vci match. Choices: "disable" "enable"
vci-string any	(list) Deprecated, please rename it to vci_string. Vci string.
wifi-ac-service string	Deprecated, please rename it to wifi_ac_service. Wifi ac service. Choices: "specify" "local"
wifi-ac1 string	Deprecated, please rename it to wifi_ac1. Wifi ac1.
wifi-ac2 string	Deprecated, please rename it to wifi_ac2. Wifi ac2.
wifi-ac3 string	Deprecated, please rename it to wifi_ac3. Wifi ac3.
wins-server1 string	Deprecated, please rename it to wins_server1. Wins server1.
wins-server2 string	Deprecated, please rename it to wins_server2. Wins server2.
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.
vlan string / required	The parameter (vlan) in requested url.
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.

• 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 (generated based on argument schema)
  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_fsp_vlan_dhcpserver:
        # 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>
        vlan: <your own value>
        fsp_vlan_dhcpserver:
          auto_configuration: <value in [disable, enable]>
          conflicted_ip_timeout: <integer>
          ddns_auth: <value in [disable, tsig]>
          ddns_key: <list or string>
          ddns_keyname: <string>
          ddns_server_ip: <string>
          ddns_ttl: <integer>
          ddns_update: <value in [disable, enable]>
          ddns_update_override: <value in [disable, enable]>
          ddns_zone: <string>
          default_gateway: <string>
          dns_server1: <string>
          dns_server2: <string>
          dns_server3: <string>
          dns_service: <value in [default, specify, local]>
          domain: <string>
          enable: <value in [disable, enable]>
          exclude_range:
            -
              end_ip: <string>
              id: <integer>
              start_ip: <string>
              vci_match: <value in [disable, enable]>
              vci_string: <list or string>
              lease_time: <integer>
              uci_match: <value in [disable, enable]>
              uci_string: <list or string>
          filename: <string>
          forticlient_on_net_status: <value in [disable, enable]>
          id: <integer>
          interface: <string>
          ip_mode: <value in [range, usrgrp]>
          ip_range:
            -
              end_ip: <string>
              id: <integer>
              start_ip: <string>
              vci_match: <value in [disable, enable]>
              vci_string: <list or string>
              lease_time: <integer>
              uci_match: <value in [disable, enable]>
              uci_string: <list or string>
          ipsec_lease_hold: <integer>
          lease_time: <integer>
          mac_acl_default_action: <value in [assign, block]>
          netmask: <string>
          next_server: <string>
          ntp_server1: <string>
          ntp_server2: <string>
          ntp_server3: <string>
          ntp_service: <value in [default, specify, local]>
          option1: <list or string>
          option2: <list or string>
          option3: <list or string>
          option4: <string>
          option5: <string>
          option6: <string>
          options:
            -
              code: <integer>
              id: <integer>
              ip: <list or string>
              type: <value in [hex, string, ip, ...]>
              value: <string>
              vci_match: <value in [disable, enable]>
              vci_string: <list or string>
              uci_match: <value in [disable, enable]>
              uci_string: <list or string>
          reserved_address:
            -
              action: <value in [assign, block, reserved]>
              circuit_id: <string>
              circuit_id_type: <value in [hex, string]>
              description: <string>
              id: <integer>
              ip: <string>
              mac: <string>
              remote_id: <string>
              remote_id_type: <value in [hex, string]>
              type: <value in [mac, option82]>
          server_type: <value in [regular, ipsec]>
          status: <value in [disable, enable]>
          tftp_server: <list or string>
          timezone: <value in [00, 01, 02, ...]>
          timezone_option: <value in [disable, default, specify]>
          vci_match: <value in [disable, enable]>
          vci_string: <list or string>
          wifi_ac1: <string>
          wifi_ac2: <string>
          wifi_ac3: <string>
          wins_server1: <string>
          wins_server2: <string>
          dns_server4: <string>
          wifi_ac_service: <value in [specify, local]>
          auto_managed_status: <value in [disable, enable]>
          dhcp_settings_from_fortiipam: <value in [disable, enable]>
          relay_agent: <string>
          shared_subnet: <value in [disable, enable]>

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)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)