Try SpotterConfigure DHCP servers.
| "added in version" 2.0.0 of drmofu.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections:
- name: drmofu.fortimanager
version: 2.2.2This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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_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: <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>
enable: <value in [disable, enable]>
exclude-range:
-
end-ip: <value of string>
id: <value of integer>
start-ip: <value of string>
vci-match: <value in [disable, enable]>
vci-string: <value of string>
lease-time: <value of integer>
uci-match: <value in [disable, enable]>
uci-string: <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>
vci-match: <value in [disable, enable]>
vci-string: <value of string>
lease-time: <value of integer>
uci-match: <value in [disable, enable]>
uci-string: <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]>
option1: <value of string>
option2: <value of string>
option3: <value of string>
option4: <value of string>
option5: <value of string>
option6: <value of string>
options:
-
code: <value of integer>
id: <value of integer>
ip: <value of string>
type: <value in [hex, string, ip, ...]>
value: <value of string>
vci-match: <value in [disable, enable]>
vci-string: <value of string>
uci-match: <value in [disable, enable]>
uci-string: <value of string>
reserved-address:
-
action: <value in [assign, block, reserved]>
circuit-id: <value of string>
circuit-id-type: <value in [hex, string]>
description: <value of string>
id: <value of integer>
ip: <value of string>
mac: <value of string>
remote-id: <value of 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: <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>
dns-server4: <value of 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: <value of string>
shared-subnet: <value in [disable, enable]>
adom:
description: the parameter (adom) in requested url
required: true
type: str
vlan:
description: the parameter (vlan) in requested url
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
required: false
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool
access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
required: false
type: bool
fsp_vlan_dhcpserver:
description: the top level parameters set
required: false
suboptions:
auto-configuration:
choices:
- disable
- enable
description: no description
type: str
auto-managed-status:
choices:
- disable
- enable
description: no description
type: str
conflicted-ip-timeout:
description: no description
type: int
ddns-auth:
choices:
- disable
- tsig
description: no description
type: str
ddns-key:
description: no description
type: str
ddns-keyname:
description: no description
type: str
ddns-server-ip:
description: no description
type: str
ddns-ttl:
description: no description
type: int
ddns-update:
choices:
- disable
- enable
description: no description
type: str
ddns-update-override:
choices:
- disable
- enable
description: no description
type: str
ddns-zone:
description: no description
type: str
default-gateway:
description: no description
type: str
dhcp-settings-from-fortiipam:
choices:
- disable
- enable
description: no description
type: str
dns-server1:
description: no description
type: str
dns-server2:
description: no description
type: str
dns-server3:
description: no description
type: str
dns-server4:
description: no description
type: str
dns-service:
choices:
- default
- specify
- local
description: no description
type: str
domain:
description: no description
type: str
enable:
choices:
- disable
- enable
description: no description
type: str
exclude-range:
description: description
elements: dict
suboptions:
end-ip:
description: no description
type: str
id:
description: no description
type: int
lease-time:
description: Lease time in seconds, 0 means default lease time.
type: int
start-ip:
description: no description
type: str
uci-match:
choices:
- disable
- enable
description: Enable/disable user class identifier
type: str
uci-string:
description: description
type: str
vci-match:
choices:
- disable
- enable
description: Enable/disable vendor class identifier
type: str
vci-string:
description: description
type: str
type: list
filename:
description: no description
type: str
forticlient-on-net-status:
choices:
- disable
- enable
description: no description
type: str
id:
description: no description
type: int
interface:
description: no description
type: str
ip-mode:
choices:
- range
- usrgrp
description: no description
type: str
ip-range:
description: description
elements: dict
suboptions:
end-ip:
description: no description
type: str
id:
description: no description
type: int
lease-time:
description: Lease time in seconds, 0 means default lease time.
type: int
start-ip:
description: no description
type: str
uci-match:
choices:
- disable
- enable
description: Enable/disable user class identifier
type: str
uci-string:
description: description
type: str
vci-match:
choices:
- disable
- enable
description: Enable/disable vendor class identifier
type: str
vci-string:
description: description
type: str
type: list
ipsec-lease-hold:
description: no description
type: int
lease-time:
description: no description
type: int
mac-acl-default-action:
choices:
- assign
- block
description: no description
type: str
netmask:
description: no description
type: str
next-server:
description: no description
type: str
ntp-server1:
description: no description
type: str
ntp-server2:
description: no description
type: str
ntp-server3:
description: no description
type: str
ntp-service:
choices:
- default
- specify
- local
description: no description
type: str
option1:
description: description
type: str
option2:
description: description
type: str
option3:
description: description
type: str
option4:
description: no description
type: str
option5:
description: no description
type: str
option6:
description: no description
type: str
options:
description: description
elements: dict
suboptions:
code:
description: no description
type: int
id:
description: no description
type: int
ip:
description: description
type: str
type:
choices:
- hex
- string
- ip
- fqdn
description: no description
type: str
uci-match:
choices:
- disable
- enable
description: Enable/disable user class identifier
type: str
uci-string:
description: description
type: str
value:
description: no description
type: str
vci-match:
choices:
- disable
- enable
description: Enable/disable vendor class identifier
type: str
vci-string:
description: description
type: str
type: list
relay-agent:
description: Relay agent IP.
type: str
reserved-address:
description: description
elements: dict
suboptions:
action:
choices:
- assign
- block
- reserved
description: no description
type: str
circuit-id:
description: no description
type: str
circuit-id-type:
choices:
- hex
- string
description: no description
type: str
description:
description: no description
type: str
id:
description: no description
type: int
ip:
description: no description
type: str
mac:
description: no description
type: str
remote-id:
description: no description
type: str
remote-id-type:
choices:
- hex
- string
description: no description
type: str
type:
choices:
- mac
- option82
description: no description
type: str
type: list
server-type:
choices:
- regular
- ipsec
description: no description
type: str
shared-subnet:
choices:
- disable
- enable
description: Enable/disable shared subnet.
type: str
status:
choices:
- disable
- enable
description: no description
type: str
tftp-server:
description: description
type: str
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'
description: no description
type: str
timezone-option:
choices:
- disable
- default
- specify
description: no description
type: str
vci-match:
choices:
- disable
- enable
description: no description
type: str
vci-string:
description: description
type: str
wifi-ac-service:
choices:
- specify
- local
description: no description
type: str
wifi-ac1:
description: no description
type: str
wifi-ac2:
description: no description
type: str
wifi-ac3:
description: no description
type: str
wins-server1:
description: no description
type: str
wins-server2:
description: no description
type: str
type: dict
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
required: false
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list