fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_dhcpserver module – Configure DHCP servers.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.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_dynamicmapping_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

dynamic_mapping

string / required

The parameter (dynamic_mapping) in requested url.

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_dynamicmapping_dhcpserver

dictionary

The top level parameters set.

auto_configuration

string

Auto configuration.

Choices:

  • "disable"

  • "enable"

auto_managed_status

string

Auto managed status.

Choices:

  • "disable"

  • "enable"

conflicted_ip_timeout

integer

Conflicted ip timeout.

ddns_auth

string

Ddns auth.

Choices:

  • "disable"

  • "tsig"

ddns_key

any

(list or str) Ddns key.

ddns_keyname

string

Ddns keyname.

ddns_server_ip

string

Ddns server ip.

ddns_ttl

integer

Ddns ttl.

ddns_update

string

Ddns update.

Choices:

  • "disable"

  • "enable"

ddns_update_override

string

Ddns update override.

Choices:

  • "disable"

  • "enable"

ddns_zone

string

Ddns zone.

default_gateway

string

Default gateway.

dhcp_settings_from_fortiipam

string

Dhcp settings from fortiipam.

Choices:

  • "disable"

  • "enable"

dns_server1

string

Dns server1.

dns_server2

string

Dns server2.

dns_server3

string

Dns server3.

dns_server4

string

Dns server4.

dns_service

string

Dns service.

Choices:

  • "default"

  • "specify"

  • "local"

domain

string

Domain.

enable

string

Enable.

Choices:

  • "disable"

  • "enable"

exclude_range

list / elements=dictionary

Exclude range.

end_ip

string

End ip.

id

integer

Id.

lease_time

integer

Lease time in seconds, 0 means default lease time.

start_ip

string

Start ip.

uci_match

string

Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci_string

any

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

vci_match

string

Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci_string

any

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

filename

string

Filename.

forticlient_on_net_status

string

Forticlient on net status.

Choices:

  • "disable"

  • "enable"

id

integer

Id.

interface

string

Interface.

ip_mode

string

Ip mode.

Choices:

  • "range"

  • "usrgrp"

ip_range

list / elements=dictionary

Ip range.

end_ip

string

End ip.

id

integer

Id.

lease_time

integer

Lease time in seconds, 0 means default lease time.

start_ip

string

Start ip.

uci_match

string

Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci_string

any

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

vci_match

string

Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci_string

any

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

ipsec_lease_hold

integer

Ipsec lease hold.

lease_time

integer

Lease time.

mac_acl_default_action

string

Mac acl default action.

Choices:

  • "assign"

  • "block"

netmask

string

Netmask.

next_server

string

Next server.

ntp_server1

string

Ntp server1.

ntp_server2

string

Ntp server2.

ntp_server3

string

Ntp server3.

ntp_service

string

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

Enable/disable user class identifier

Choices:

  • "disable"

  • "enable"

uci_string

any

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

value

string

Value.

vci_match

string

Enable/disable vendor class identifier

Choices:

  • "disable"

  • "enable"

vci_string

any

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

relay_agent

string

Relay agent IP.

reserved_address

list / elements=dictionary

Reserved address.

action

string

Action.

Choices:

  • "assign"

  • "block"

  • "reserved"

circuit_id

string

Circuit id.

circuit_id_type

string

Circuit id type.

Choices:

  • "hex"

  • "string"

description

string

Description.

id

integer

Id.

ip

string

Ip.

mac

string

Mac.

remote_id

string

Remote id.

remote_id_type

string

Remote id type.

Choices:

  • "hex"

  • "string"

type

string

Type.

Choices:

  • "mac"

  • "option82"

server_type

string

Server type.

Choices:

  • "regular"

  • "ipsec"

shared_subnet

string

Enable/disable shared subnet.

Choices:

  • "disable"

  • "enable"

status

string

Status.

Choices:

  • "disable"

  • "enable"

tftp_server

any

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

Timezone option.

Choices:

  • "disable"

  • "default"

  • "specify"

vci_match

string

Vci match.

Choices:

  • "disable"

  • "enable"

vci_string

any

(list) Vci string.

wifi_ac1

string

Wifi ac1.

wifi_ac2

string

Wifi ac2.

wifi_ac3

string

Wifi ac3.

wifi_ac_service

string

Wifi ac service.

Choices:

  • "specify"

  • "local"

wins_server1

string

Wins server1.

wins_server2

string

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_dynamicmapping_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>
        dynamic_mapping: <your own value>
        fsp_vlan_dynamicmapping_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)