fmgr_fmupdate_fgdsetting – Cli fmupdate fgd setting.
Added in version 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.nameNew 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-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.6.3 -> 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
- fmupdate_fgdsetting - Cli fmupdate fgd setting type: dict
- as_cache (Alias name: as-cache) As cache. type: int default: 300 more...
- as_log (Alias name: as-log) As log. type: str choices: [disable, nospam, all] default: nospam more...
- as_preload (Alias name: as-preload) As preload. type: str choices: [disable, enable] default: disable more...
- av_cache (Alias name: av-cache) Av cache. type: int default: 300 more...
- av_log (Alias name: av-log) Av log. type: str choices: [disable, novirus, all] default: novirus more...
- av_preload (Alias name: av-preload) Av preload. type: str choices: [disable, enable] default: disable more...
- av2_cache (Alias name: av2-cache) Av2 cache. type: int default: 800 more...
- av2_log (Alias name: av2-log) Av2 log. type: str choices: [disable, noav2, all] default: noav2 more...
- av2_preload (Alias name: av2-preload) Av2 preload. type: str choices: [disable, enable] default: disable more...
- eventlog_query (Alias name: eventlog-query) Eventlog query. type: str choices: [disable, enable] default: disable more...
- fgd_pull_interval (Alias name: fgd-pull-interval) Fgd pull interval. type: int default: 10 more...
- fq_cache (Alias name: fq-cache) Fq cache. type: int default: 300 more...
- fq_log (Alias name: fq-log) Fq log. type: str choices: [disable, nofilequery, all] default: nofilequery more...
- fq_preload (Alias name: fq-preload) Fq preload. type: str choices: [disable, enable] default: disable more...
- iot_cache (Alias name: iot-cache) Iot cache. type: int default: 300 more...
- iot_log (Alias name: iot-log) Iot log. type: str choices: [disable, noiot, all] default: noiot more...
- iot_preload (Alias name: iot-preload) Iot preload. type: str choices: [disable, enable] default: disable more...
- iotv_preload (Alias name: iotv-preload) Iotv preload. type: str choices: [disable, enable] default: disable more...
- linkd_log (Alias name: linkd-log) Linkd log. type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: debug more...
- max_client_worker (Alias name: max-client-worker) Max client worker. type: int default: 0 more...
- max_log_quota (Alias name: max-log-quota) Max log quota. type: int default: 6144 more...
- max_unrated_site (Alias name: max-unrated-site) Max unrated site. type: int default: 500 more...
- restrict_as1_dbver (Alias name: restrict-as1-dbver) Restrict as1 dbver. type: str more...
- restrict_as2_dbver (Alias name: restrict-as2-dbver) Restrict as2 dbver. type: str more...
- restrict_as4_dbver (Alias name: restrict-as4-dbver) Restrict as4 dbver. type: str more...
- restrict_av_dbver (Alias name: restrict-av-dbver) Restrict av dbver. type: str more...
- restrict_av2_dbver (Alias name: restrict-av2-dbver) Restrict av2 dbver. type: str more...
- restrict_fq_dbver (Alias name: restrict-fq-dbver) Restrict fq dbver. type: str more...
- restrict_iots_dbver (Alias name: restrict-iots-dbver) Restrict iots dbver. type: str more...
- restrict_wf_dbver (Alias name: restrict-wf-dbver) Restrict wf dbver. type: str more...
- server_override (Alias name: server-override) Server override. type: dict more...
- stat_log (Alias name: stat-log) Stat log. type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: disable more...
- stat_log_interval (Alias name: stat-log-interval) Stat log interval. type: int default: 60 more...
- stat_sync_interval (Alias name: stat-sync-interval) Stat sync interval. type: int default: 60 more...
- update_interval (Alias name: update-interval) Update interval. type: int default: 6 more...
- update_log (Alias name: update-log) Update log. type: str choices: [disable, enable] default: enable more...
- wf_cache (Alias name: wf-cache) Wf cache. type: int default: 0 more...
- wf_dn_cache_expire_time (Alias name: wf-dn-cache-expire-time) Wf dn cache expire time. type: int default: 30 more...
- wf_dn_cache_max_number (Alias name: wf-dn-cache-max-number) Wf dn cache max number. type: int default: 10000 more...
- wf_log (Alias name: wf-log) Wf log. type: str choices: [disable, nourl, all] default: nourl more...
- wf_preload (Alias name: wf-preload) Wf preload. type: str choices: [disable, enable] default: 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
gather_facts: false
tasks:
- name: Cli fmupdate fgd setting
fortinet.fortimanager.fmgr_fmupdate_fgdsetting:
# workspace_locking_adom: <global or your adom name>
fmupdate_fgdsetting:
# as_cache: <integer>
# as_log: <value in [disable, nospam, all]>
# as_preload: <value in [disable, enable]>
# av_cache: <integer>
# av_log: <value in [disable, novirus, all]>
# av_preload: <value in [disable, enable]>
# av2_cache: <integer>
# av2_log: <value in [disable, noav2, all]>
# av2_preload: <value in [disable, enable]>
# eventlog_query: <value in [disable, enable]>
# fgd_pull_interval: <integer>
# fq_cache: <integer>
# fq_log: <value in [disable, nofilequery, all]>
# fq_preload: <value in [disable, enable]>
# iot_cache: <integer>
# iot_log: <value in [disable, noiot, all]>
# iot_preload: <value in [disable, enable]>
# iotv_preload: <value in [disable, enable]>
# linkd_log: <value in [emergency, alert, critical, ...]>
# max_client_worker: <integer>
# max_log_quota: <integer>
# max_unrated_site: <integer>
# restrict_as1_dbver: <string>
# restrict_as2_dbver: <string>
# restrict_as4_dbver: <string>
# restrict_av_dbver: <string>
# restrict_av2_dbver: <string>
# restrict_fq_dbver: <string>
# restrict_iots_dbver: <string>
# restrict_wf_dbver: <string>
# server_override:
# servlist:
# - id: <integer>
# ip: <string>
# ip6: <string>
# port: <integer>
# service_type: <value in [fgd, fsa, fgfq, ...]>
# status: <value in [disable, enable]>
# stat_log: <value in [emergency, alert, critical, ...]>
# stat_log_interval: <integer>
# stat_sync_interval: <integer>
# update_interval: <integer>
# update_log: <value in [disable, enable]>
# wf_cache: <integer>
# wf_dn_cache_expire_time: <integer>
# wf_dn_cache_max_number: <integer>
# wf_log: <value in [disable, nourl, all]>
# wf_preload: <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.