:source: fmgr_fmupdate_fgdsetting.py
:orphan:
.. _fmgr_fmupdate_fgdsetting:
fmgr_fmupdate_fgdsetting -- Cli fmupdate fgd setting.
+++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.10.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: v7.6.3 -> latest
Parameters
----------
.. raw:: html
- 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
- fmupdate_fgdsetting - Cli fmupdate fgd setting type: dict
- as_cache (Alias name: as-cache) As cache. type: int default: 300
more...
Supported Version Ranges: v7.6.3 -> latest
- as_log (Alias name: as-log) As log. type: str choices: [disable, nospam, all] default: nospam
more...
Supported Version Ranges: v7.6.3 -> latest
- as_preload (Alias name: as-preload) As preload. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges: v7.6.3 -> latest
- av_cache (Alias name: av-cache) Av cache. type: int default: 300
more...
Supported Version Ranges: v7.6.3 -> latest
- av_log (Alias name: av-log) Av log. type: str choices: [disable, novirus, all] default: novirus
more...
Supported Version Ranges: v7.6.3 -> latest
- av_preload (Alias name: av-preload) Av preload. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges: v7.6.3 -> latest
- av2_cache (Alias name: av2-cache) Av2 cache. type: int default: 800
more...
Supported Version Ranges: v7.6.3 -> latest
- av2_log (Alias name: av2-log) Av2 log. type: str choices: [disable, noav2, all] default: noav2
more...
Supported Version Ranges: v7.6.3 -> latest
- av2_preload (Alias name: av2-preload) Av2 preload. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges: v7.6.3 -> latest
- eventlog_query (Alias name: eventlog-query) Eventlog query. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges: v7.6.3 -> latest
- fgd_pull_interval (Alias name: fgd-pull-interval) Fgd pull interval. type: int default: 10
more...
Supported Version Ranges: v7.6.3 -> latest
- fq_cache (Alias name: fq-cache) Fq cache. type: int default: 300
more...
Supported Version Ranges: v7.6.3 -> latest
- fq_log (Alias name: fq-log) Fq log. type: str choices: [disable, nofilequery, all] default: nofilequery
more...
Supported Version Ranges: v7.6.3 -> latest
- fq_preload (Alias name: fq-preload) Fq preload. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges: v7.6.3 -> latest
- iot_cache (Alias name: iot-cache) Iot cache. type: int default: 300
more...
Supported Version Ranges: v7.6.3 -> latest
- iot_log (Alias name: iot-log) Iot log. type: str choices: [disable, noiot, all] default: noiot
more...
Supported Version Ranges: v7.6.3 -> latest
- iot_preload (Alias name: iot-preload) Iot preload. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges: v7.6.3 -> latest
- iotv_preload (Alias name: iotv-preload) Iotv preload. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges: v7.6.3 -> latest
- linkd_log (Alias name: linkd-log) Linkd log. type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: debug
more...
Supported Version Ranges: v7.6.3 -> latest
- max_client_worker (Alias name: max-client-worker) Max client worker. type: int default: 0
more...
Supported Version Ranges: v7.6.3 -> latest
- max_log_quota (Alias name: max-log-quota) Max log quota. type: int default: 6144
more...
Supported Version Ranges: v7.6.3 -> latest
- max_unrated_site (Alias name: max-unrated-site) Max unrated site. type: int default: 500
more...
Supported Version Ranges: v7.6.3 -> latest
- restrict_as1_dbver (Alias name: restrict-as1-dbver) Restrict as1 dbver. type: str
more...
Supported Version Ranges: v7.6.3 -> latest
- restrict_as2_dbver (Alias name: restrict-as2-dbver) Restrict as2 dbver. type: str
more...
Supported Version Ranges: v7.6.3 -> latest
- restrict_as4_dbver (Alias name: restrict-as4-dbver) Restrict as4 dbver. type: str
more...
Supported Version Ranges: v7.6.3 -> latest
- restrict_av_dbver (Alias name: restrict-av-dbver) Restrict av dbver. type: str
more...
Supported Version Ranges: v7.6.3 -> latest
- restrict_av2_dbver (Alias name: restrict-av2-dbver) Restrict av2 dbver. type: str
more...
Supported Version Ranges: v7.6.3 -> latest
- restrict_fq_dbver (Alias name: restrict-fq-dbver) Restrict fq dbver. type: str
more...
Supported Version Ranges: v7.6.3 -> latest
- restrict_iots_dbver (Alias name: restrict-iots-dbver) Restrict iots dbver. type: str
more...
Supported Version Ranges: v7.6.3 -> latest
- restrict_wf_dbver (Alias name: restrict-wf-dbver) Restrict wf dbver. type: str
more...
Supported Version Ranges: v7.6.3 -> latest
- server_override (Alias name: server-override) Server override. type: dict
more...
Supported Version Ranges: v7.6.3 -> latest
- servlist Servlist. type: list
more...
Supported Version Ranges: v7.6.3 -> latest
- id Id. type: int default: 0
more...
Supported Version Ranges: v7.6.3 -> latest
- ip Ip. type: str default: 0.0.0.0
more...
Supported Version Ranges: v7.6.3 -> latest
- ip6 Ip6. type: str default: ::
more...
Supported Version Ranges: v7.6.3 -> latest
- port Port. type: int default: 443
more...
Supported Version Ranges: v7.6.3 -> latest
- service_type (Alias name: service-type) Service type. type: str choices: [fgd, fsa, fgfq, geoip, iot-collect] default: fgd
more...
Supported Version Ranges: v7.6.3 -> latest
- status Status. type: str choices: [disable, enable] default: disable
more...
Supported Version Ranges: v7.6.3 -> latest
- stat_log (Alias name: stat-log) Stat log. type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: disable
more...
Supported Version Ranges: v7.6.3 -> latest
- stat_log_interval (Alias name: stat-log-interval) Stat log interval. type: int default: 60
more...
Supported Version Ranges: v7.6.3 -> latest
- stat_sync_interval (Alias name: stat-sync-interval) Stat sync interval. type: int default: 60
more...
Supported Version Ranges: v7.6.3 -> latest
- update_interval (Alias name: update-interval) Update interval. type: int default: 6
more...
Supported Version Ranges: v7.6.3 -> latest
- update_log (Alias name: update-log) Update log. type: str choices: [disable, enable] default: enable
more...
Supported Version Ranges: v7.6.3 -> latest
- wf_cache (Alias name: wf-cache) Wf cache. type: int default: 0
more...
Supported Version Ranges: v7.6.3 -> latest
- wf_dn_cache_expire_time (Alias name: wf-dn-cache-expire-time) Wf dn cache expire time. type: int default: 30
more...
Supported Version Ranges: v7.6.3 -> latest
- wf_dn_cache_max_number (Alias name: wf-dn-cache-max-number) Wf dn cache max number. type: int default: 10000
more...
Supported Version Ranges: v7.6.3 -> latest
- wf_log (Alias name: wf-log) Wf log. type: str choices: [disable, nourl, all] default: nourl
more...
Supported Version Ranges: v7.6.3 -> latest
- wf_preload (Alias name: wf-preload) Wf preload. type: str choices: [disable, enable] default: enable
more...
Supported Version Ranges: v7.6.3 -> latest
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: Cli fmupdate fgd setting
fortinet.fortimanager.fmgr_fmupdate_fgdsetting:
# workspace_locking_adom:
fmupdate_fgdsetting:
# as_cache:
# as_log:
# as_preload:
# av_cache:
# av_log:
# av_preload:
# av2_cache:
# av2_log:
# av2_preload:
# eventlog_query:
# fgd_pull_interval:
# fq_cache:
# fq_log:
# fq_preload:
# iot_cache:
# iot_log:
# iot_preload:
# iotv_preload:
# linkd_log:
# max_client_worker:
# max_log_quota:
# max_unrated_site:
# restrict_as1_dbver:
# restrict_as2_dbver:
# restrict_as4_dbver:
# restrict_av_dbver:
# restrict_av2_dbver:
# restrict_fq_dbver:
# restrict_iots_dbver:
# restrict_wf_dbver:
# server_override:
# servlist:
# - id:
# ip:
# ip6:
# port:
# service_type:
# status:
# stat_log:
# stat_log_interval:
# stat_sync_interval:
# update_interval:
# update_log:
# wf_cache:
# wf_dn_cache_expire_time:
# wf_dn_cache_max_number:
# wf_log:
# wf_preload:
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: 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.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)