fmgr_fsp_vlan_dhcpserver – Configure DHCP servers.
Added in version 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.
Synopsis
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 v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
Parameters
- 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
- fsp_vlan_dhcpserver - Configure DHCP servers. type: dict
- auto_configuration (Alias name: auto-configuration) Auto configuration. type: str choices: [disable, enable] more...
- conflicted_ip_timeout (Alias name: conflicted-ip-timeout) Conflicted ip timeout. type: int more...
- ddns_auth (Alias name: ddns-auth) Ddns auth. type: str choices: [disable, tsig] more...
- ddns_key (Alias name: ddns-key) Ddns key. type: list or str more...
- ddns_keyname (Alias name: ddns-keyname) Ddns keyname. type: str more...
- ddns_server_ip (Alias name: ddns-server-ip) Ddns server ip. type: str more...
- ddns_ttl (Alias name: ddns-ttl) Ddns ttl. type: int more...
- ddns_update (Alias name: ddns-update) Ddns update. type: str choices: [disable, enable] more...
- ddns_update_override (Alias name: ddns-update-override) Ddns update override. type: str choices: [disable, enable] more...
- ddns_zone (Alias name: ddns-zone) Ddns zone. type: str more...
- default_gateway (Alias name: default-gateway) Default gateway. type: str more...
- dns_server1 (Alias name: dns-server1) Dns server1. type: str more...
- dns_server2 (Alias name: dns-server2) Dns server2. type: str more...
- dns_server3 (Alias name: dns-server3) Dns server3. type: str more...
- dns_service (Alias name: dns-service) Dns service. type: str choices: [default, specify, local] more...
- domain Domain. type: str more...
- enable Enable. type: str choices: [disable, enable] more...
- exclude_range (Alias name: exclude-range) Exclude range. type: list
more...
- end_ip (Alias name: end-ip) End ip. type: str more...
- id Id. type: int more...
- start_ip (Alias name: start-ip) Start ip. type: str more...
- vci_match (Alias name: vci-match) Enable/disable vendor class identifier (vci) matching. type: str choices: [disable, enable] more...
- vci_string (Alias name: vci-string) One or more vci strings in quotes separated by spaces. type: list more...
- lease_time (Alias name: lease-time) Lease time in seconds, 0 means default lease time. type: int more...
- uci_match (Alias name: uci-match) Enable/disable user class identifier (uci) matching. type: str choices: [disable, enable] more...
- uci_string (Alias name: uci-string) One or more uci strings in quotes separated by spaces. type: list more...
- filename Filename. type: str more...
- forticlient_on_net_status (Alias name: forticlient-on-net-status) Forticlient on net status. type: str choices: [disable, enable] more...
- id Id. type: int more...
- interface Interface. type: str more...
- ip_mode (Alias name: ip-mode) Ip mode. type: str choices: [range, usrgrp] more...
- ip_range (Alias name: ip-range) Ip range. type: list
more...
- end_ip (Alias name: end-ip) End ip. type: str more...
- id Id. type: int more...
- start_ip (Alias name: start-ip) Start ip. type: str more...
- vci_match (Alias name: vci-match) Enable/disable vendor class identifier (vci) matching. type: str choices: [disable, enable] more...
- vci_string (Alias name: vci-string) One or more vci strings in quotes separated by spaces. type: list more...
- lease_time (Alias name: lease-time) Lease time in seconds, 0 means default lease time. type: int more...
- uci_match (Alias name: uci-match) Enable/disable user class identifier (uci) matching. type: str choices: [disable, enable] more...
- uci_string (Alias name: uci-string) One or more uci strings in quotes separated by spaces. type: list more...
- ipsec_lease_hold (Alias name: ipsec-lease-hold) Ipsec lease hold. type: int more...
- lease_time (Alias name: lease-time) Lease time. type: int more...
- mac_acl_default_action (Alias name: mac-acl-default-action) Mac acl default action. type: str choices: [assign, block] more...
- netmask Netmask. type: str more...
- next_server (Alias name: next-server) Next server. type: str more...
- ntp_server1 (Alias name: ntp-server1) Ntp server1. type: str more...
- ntp_server2 (Alias name: ntp-server2) Ntp server2. type: str more...
- ntp_server3 (Alias name: ntp-server3) Ntp server3. type: str more...
- ntp_service (Alias name: ntp-service) Ntp service. type: str choices: [default, specify, local] more...
- option1 Option1. type: list more...
- option2 Option2. type: list more...
- option3 Option3. type: list more...
- option4 Option4. type: str more...
- option5 Option5. type: str more...
- option6 Option6. type: str more...
- options Options. type: list
more...
- code Code. type: int more...
- id Id. type: int more...
- ip Ip. type: list more...
- type Type. type: str choices: [hex, string, ip, fqdn] more...
- value Value. type: str more...
- vci_match (Alias name: vci-match) Enable/disable vendor class identifier (vci) matching. type: str choices: [disable, enable] more...
- vci_string (Alias name: vci-string) One or more vci strings in quotes separated by spaces. type: list more...
- uci_match (Alias name: uci-match) Enable/disable user class identifier (uci) matching. type: str choices: [disable, enable] more...
- uci_string (Alias name: uci-string) One or more uci strings in quotes separated by spaces. type: list more...
- reserved_address (Alias name: reserved-address) Reserved address. type: list
more...
- action Action. type: str choices: [assign, block, reserved] more...
- circuit_id (Alias name: circuit-id) Circuit id. type: str more...
- circuit_id_type (Alias name: circuit-id-type) Circuit id type. type: str choices: [hex, string] more...
- description Description. type: str more...
- id Id. type: int more...
- ip Ip. type: str more...
- mac Mac. type: str more...
- remote_id (Alias name: remote-id) Remote id. type: str more...
- remote_id_type (Alias name: remote-id-type) Remote id type. type: str choices: [hex, string] more...
- type Type. type: str choices: [mac, option82] more...
- server_type (Alias name: server-type) Server type. type: str choices: [regular, ipsec] more...
- status Status. type: str choices: [disable, enable] more...
- tftp_server (Alias name: tftp-server) Tftp server. type: list more...
- timezone 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...
- timezone_option (Alias name: timezone-option) Timezone option. type: str choices: [disable, default, specify] more...
- vci_match (Alias name: vci-match) Vci match. type: str choices: [disable, enable] more...
- vci_string (Alias name: vci-string) Vci string. type: list more...
- wifi_ac1 (Alias name: wifi-ac1) Wifi ac1. type: str more...
- wifi_ac2 (Alias name: wifi-ac2) Wifi ac2. type: str more...
- wifi_ac3 (Alias name: wifi-ac3) Wifi ac3. type: str more...
- wins_server1 (Alias name: wins-server1) Wins server1. type: str more...
- wins_server2 (Alias name: wins-server2) Wins server2. type: str more...
- dns_server4 (Alias name: dns-server4) Dns server4. type: str more...
- wifi_ac_service (Alias name: wifi-ac-service) Wifi ac service. type: str choices: [specify, local] more...
- auto_managed_status (Alias name: auto-managed-status) Auto managed status. type: str choices: [disable, enable] more...
- dhcp_settings_from_fortiipam (Alias name: dhcp-settings-from-fortiipam) Dhcp settings from fortiipam. type: str choices: [disable, enable] more...
- relay_agent (Alias name: relay-agent) Relay agent ip. type: str more...
- shared_subnet (Alias name: shared-subnet) Enable/disable shared subnet. type: str choices: [disable, enable] more...
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
- 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: 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
Status
This module is not guaranteed to have a backwards compatible interface.