:source: fmgr_fsp_vlan_dhcpserver.py
:orphan:
.. _fmgr_fsp_vlan_dhcpserver:
fmgr_fsp_vlan_dhcpserver -- Configure DHCP servers.
+++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 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.
.. contents::
:local:
:depth: 1
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-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v6.0.0 -> latest
Parameters
----------
.. raw:: html
access_token -The token to access FortiManager without using username and password. type: strrequired: false
bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: boolrequired: 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: strrequired: false
proposed_method - The overridden method for the underlying Json RPC request. type: strrequired: false choices: set, update, add
rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: listrequired: false
rc_failed - The rc codes list with which the conditions to fail will be overriden. type: listrequired: false
workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: strrequired: 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: integerrequired: falsedefault: 300
revision_note - The change note that can be specified when an object is created or updated. type: stringrequired: false
adom - The parameter in requested url type: strrequired: true
vlan - The parameter in requested url type: strrequired: true
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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure DHCP servers.
fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver:
# workspace_locking_adom:
adom:
vlan:
fsp_vlan_dhcpserver:
# auto_configuration:
# conflicted_ip_timeout:
# ddns_auth:
# ddns_key:
# ddns_keyname:
# ddns_server_ip:
# ddns_ttl:
# ddns_update:
# ddns_update_override:
# ddns_zone:
# default_gateway:
# dns_server1:
# dns_server2:
# dns_server3:
# dns_service:
# domain:
# enable:
# exclude_range:
# - end_ip:
# id:
# start_ip:
# vci_match:
# vci_string:
# lease_time:
# uci_match:
# uci_string:
# filename:
# forticlient_on_net_status:
# id:
# interface:
# ip_mode:
# ip_range:
# - end_ip:
# id:
# start_ip:
# vci_match:
# vci_string:
# lease_time:
# uci_match:
# uci_string:
# ipsec_lease_hold:
# lease_time:
# mac_acl_default_action:
# netmask:
# next_server:
# ntp_server1:
# ntp_server2:
# ntp_server3:
# ntp_service:
# option1:
# option2:
# option3:
# option4:
# option5:
# option6:
# options:
# - code:
# id:
# ip:
# type:
# value:
# vci_match:
# vci_string:
# uci_match:
# uci_string:
# reserved_address:
# - action:
# circuit_id:
# circuit_id_type:
# description:
# id:
# ip:
# mac:
# remote_id:
# remote_id_type:
# type:
# server_type:
# status:
# tftp_server:
# timezone:
# timezone_option:
# vci_match:
# vci_string:
# wifi_ac1:
# wifi_ac2:
# wifi_ac3:
# wins_server1:
# wins_server2:
# dns_server4:
# wifi_ac_service:
# auto_managed_status:
# dhcp_settings_from_fortiipam:
# relay_agent:
# shared_subnet:
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:
.. raw:: html
meta - The result of the request.returned: alwaystype: dict
request_url - The full url requested. returned: alwaystype: strsample: /sys/login/user
response_code - The status of api request. returned: alwaystype: intsample: 0
response_data - The data body of the api response. returned: optionaltype: list or dict
response_message - The descriptive message of the api response. returned: alwaystype: strsample: OK
system_information - The information of the target system. returned: alwaystype: dict
rc - The status the request. returned: alwaystype: intsample: 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 versiontype: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)