- source
fmgr_fsp_vlan_dynamicmapping_dhcpserver.py
- orphan
2.0.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.0.0 -> v7.4.0
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- vlan - The parameter in requested url type: str required: true
- dynamic_mapping - The parameter in requested url type: str required: true
- fsp_vlan_dynamicmapping_dhcpserver - Configure DHCP servers. type: dict
- auto_configuration (Alias name: auto-configuration) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- conflicted_ip_timeout (Alias name: conflicted-ip-timeout) type: int
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- ddns_auth (Alias name: ddns-auth) type: str choices: [disable, tsig]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- ddns_key (Alias name: ddns-key) type: list or str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- ddns_keyname (Alias name: ddns-keyname) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- ddns_server_ip (Alias name: ddns-server-ip) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- ddns_ttl (Alias name: ddns-ttl) type: int
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- ddns_update (Alias name: ddns-update) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- ddns_update_override (Alias name: ddns-update-override) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- ddns_zone (Alias name: ddns-zone) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- default_gateway (Alias name: default-gateway) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- dns_server1 (Alias name: dns-server1) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- dns_server2 (Alias name: dns-server2) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- dns_server3 (Alias name: dns-server3) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- dns_service (Alias name: dns-service) type: str choices: [default, specify, local]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- domain type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- enable type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- exclude_range (Alias name: exclude-range) type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- end_ip (Alias name: end-ip) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- id type: int
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- start_ip (Alias name: start-ip) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- vci_match (Alias name: vci-match) Enable/disable vendor class identifier (vci) matching. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.2.1 -> v7.4.0
- vci_string (Alias name: vci-string) type: list
more...
Supported Version Ranges:
v7.2.1 -> v7.4.0
- lease_time (Alias name: lease-time) Lease time in seconds, 0 means default lease time. type: int
more...
Supported Version Ranges:
v7.2.2 -> v7.4.0
- uci_match (Alias name: uci-match) Enable/disable user class identifier (uci) matching. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.2.2 -> v7.4.0
- uci_string (Alias name: uci-string) type: list
more...
Supported Version Ranges:
v7.2.2 -> v7.4.0
- end_ip (Alias name: end-ip) type: str
more...
- filename type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- forticlient_on_net_status (Alias name: forticlient-on-net-status) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- id type: int
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- interface type: str
more...
Supported Version Ranges:
v6.0.0 -> v6.2.1
- ip_mode (Alias name: ip-mode) type: str choices: [range, usrgrp]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- ip_range (Alias name: ip-range) type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- end_ip (Alias name: end-ip) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- id type: int
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- start_ip (Alias name: start-ip) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- vci_match (Alias name: vci-match) Enable/disable vendor class identifier (vci) matching. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.2.1 -> v7.4.0
- vci_string (Alias name: vci-string) type: list
more...
Supported Version Ranges:
v7.2.1 -> v7.4.0
- lease_time (Alias name: lease-time) Lease time in seconds, 0 means default lease time. type: int
more...
Supported Version Ranges:
v7.2.2 -> v7.4.0
- uci_match (Alias name: uci-match) Enable/disable user class identifier (uci) matching. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.2.2 -> v7.4.0
- uci_string (Alias name: uci-string) type: list
more...
Supported Version Ranges:
v7.2.2 -> v7.4.0
- end_ip (Alias name: end-ip) type: str
more...
- ipsec_lease_hold (Alias name: ipsec-lease-hold) type: int
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- lease_time (Alias name: lease-time) type: int
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- mac_acl_default_action (Alias name: mac-acl-default-action) type: str choices: [assign, block]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- netmask type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- next_server (Alias name: next-server) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- ntp_server1 (Alias name: ntp-server1) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- ntp_server2 (Alias name: ntp-server2) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- ntp_server3 (Alias name: ntp-server3) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- ntp_service (Alias name: ntp-service) type: str choices: [default, specify, local]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- option1 type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- option2 type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- option3 type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- option4 type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- option5 type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- option6 type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- options type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- code type: int
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- id type: int
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- ip type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- type type: str choices: [hex, string, ip, fqdn]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- value type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- vci_match (Alias name: vci-match) Enable/disable vendor class identifier (vci) matching. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.2.1 -> v7.4.0
- vci_string (Alias name: vci-string) type: list
more...
Supported Version Ranges:
v7.2.1 -> v7.4.0
- uci_match (Alias name: uci-match) Enable/disable user class identifier (uci) matching. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.2.2 -> v7.4.0
- uci_string (Alias name: uci-string) type: list
more...
Supported Version Ranges:
v7.2.2 -> v7.4.0
- code type: int
more...
- reserved_address (Alias name: reserved-address) type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- action type: str choices: [assign, block, reserved]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- circuit_id (Alias name: circuit-id) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- circuit_id_type (Alias name: circuit-id-type) type: str choices: [hex, string]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- description type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- id type: int
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- ip type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- mac type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- remote_id (Alias name: remote-id) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- remote_id_type (Alias name: remote-id-type) type: str choices: [hex, string]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- type type: str choices: [mac, option82]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- action type: str choices: [assign, block, reserved]
more...
- server_type (Alias name: server-type) type: str choices: [regular, ipsec]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- status type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- tftp_server (Alias name: tftp-server) type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- timezone type: str 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]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- timezone_option (Alias name: timezone-option) type: str choices: [disable, default, specify]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- vci_match (Alias name: vci-match) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- vci_string (Alias name: vci-string) type: list
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- wifi_ac1 (Alias name: wifi-ac1) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- wifi_ac2 (Alias name: wifi-ac2) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- wifi_ac3 (Alias name: wifi-ac3) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- wins_server1 (Alias name: wins-server1) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- wins_server2 (Alias name: wins-server2) type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.4.0
- dns_server4 (Alias name: dns-server4) type: str
more...
Supported Version Ranges:
v6.2.2 -> v7.4.0
- wifi_ac_service (Alias name: wifi-ac-service) type: str choices: [specify, local]
more...
Supported Version Ranges:
v6.2.2 -> v7.4.0
- auto_managed_status (Alias name: auto-managed-status) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.0 -> v7.4.0
- dhcp_settings_from_fortiipam (Alias name: dhcp-settings-from-fortiipam) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.0 -> v7.4.0
- relay_agent (Alias name: relay-agent) Relay agent ip. type: str
more...
Supported Version Ranges:
v7.4.0 -> v7.4.0
- shared_subnet (Alias name: shared-subnet) Enable/disable shared subnet. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.0 -> v7.4.0
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
- 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]>
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)