fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver – no description
fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver – no description
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_fsp_vlan_dhcpserver.
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 |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | ||
|
fsp_vlan_dhcpserver dictionary |
the top level parameters set | |||
|
auto-configuration string |
|
no description | ||
|
conflicted-ip-timeout integer |
no description | |||
|
ddns-auth string |
|
no description | ||
|
ddns-key string |
no description | |||
|
ddns-keyname string |
no description | |||
|
ddns-server-ip string |
no description | |||
|
ddns-ttl integer |
no description | |||
|
ddns-update string |
|
no description | ||
|
ddns-update-override string |
|
no description | ||
|
ddns-zone string |
no description | |||
|
default-gateway string |
no description | |||
|
dns-server1 string |
no description | |||
|
dns-server2 string |
no description | |||
|
dns-server3 string |
no description | |||
|
dns-service string |
|
no description | ||
|
domain string |
no description | |||
|
enable string |
|
no description | ||
|
exclude-range list / elements=string |
no description | |||
|
end-ip string |
no description | |||
|
id integer |
no description | |||
|
start-ip string |
no description | |||
|
filename string |
no description | |||
|
forticlient-on-net-status string |
|
no description | ||
|
id integer |
no description | |||
|
interface string |
no description | |||
|
ip-mode string |
|
no description | ||
|
ip-range list / elements=string |
no description | |||
|
end-ip string |
no description | |||
|
id integer |
no description | |||
|
start-ip string |
no description | |||
|
ipsec-lease-hold integer |
no description | |||
|
lease-time integer |
no description | |||
|
mac-acl-default-action string |
|
no description | ||
|
netmask string |
no description | |||
|
next-server string |
no description | |||
|
ntp-server1 string |
no description | |||
|
ntp-server2 string |
no description | |||
|
ntp-server3 string |
no description | |||
|
ntp-service string |
|
no description | ||
|
option1 string |
no description | |||
|
option2 string |
no description | |||
|
option3 string |
no description | |||
|
option4 string |
no description | |||
|
option5 string |
no description | |||
|
option6 string |
no description | |||
|
options list / elements=string |
no description | |||
|
code integer |
no description | |||
|
id integer |
no description | |||
|
ip string |
no description | |||
|
type string |
|
no description | ||
|
value string |
no description | |||
|
reserved-address list / elements=string |
no description | |||
|
action string |
|
no description | ||
|
circuit-id string |
no description | |||
|
circuit-id-type string |
|
no description | ||
|
description string |
no description | |||
|
id integer |
no description | |||
|
ip string |
no description | |||
|
mac string |
no description | |||
|
remote-id string |
no description | |||
|
remote-id-type string |
|
no description | ||
|
type string |
|
no description | ||
|
server-type string |
|
no description | ||
|
status string |
|
no description | ||
|
tftp-server string |
no description | |||
|
timezone string |
|
no description | ||
|
timezone-option string |
|
no description | ||
|
vci-match string |
|
no description | ||
|
vci-string string |
no description | |||
|
wifi-ac1 string |
no description | |||
|
wifi-ac2 string |
no description | |||
|
wifi-ac3 string |
no description | |||
|
wins-server1 string |
no description | |||
|
wins-server2 string |
no description | |||
|
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 |
|
the directive to create, update or delete an object | ||
|
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 |
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: no description
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>
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]>
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>
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>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_fsp_vlan_dhcpserver_module.html
