faz_cli_fmupdate_fgdsetting – Cli fmupdate fgd setting
Added in version 1.9.0.
Warning
Starting in version 2.0.0, all variables will be named in the underscore naming convention.
Possible variable names before 2.0.0:
variable-name,variable name,variable.nameCorresponding variable names since 2.0.0:
variable_name
FortiAnalyzer Ansible v1.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 FortiAnalyzer device.
Examples include all parameters and values need to be adjusted to data sources before usage.
This module supports check mode and diff mode.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.16.0
FortiAnalyzer Version Compatibility
Supported Version Ranges: v7.6.3 -> latest
Parameters
- access_token The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str
- bypass_validation Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool default: False
- enable_log Enable/Disable logging for task type: bool default: False
- forticloud_access_token Access token of forticloud analyzer API users. type: str
- log_path The path to save log. Used if enable_log is true. Please use absolute path instead of relative path. If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.logtype: str default: "/tmp/fortianalyzer.ansible.log"
- proposed_method The overridden method for the underlying Json RPC request type: str choices: set, update, add
- version_check If set to True, it will check whether the parameters used are supported by the corresponding version of FortiAnazlyer locally based on FNDN data. A warning will be returned in version_check_warning if there is a mismatch. This warning is only a suggestion and may not be accurate. type: bool default: False
- rc_succeeded The rc codes list with which the conditions to succeed will be overriden type: list
- rc_failed The rc codes list with which the conditions to fail will be overriden type: list
- cli_fmupdate_fgdsetting Cli fmupdate fgd setting type: dict
- as_cache type: int default: 300 more...
- as_log type: str choices: [disable, nospam, all] default: nospam more...
- as_preload type: str choices: [disable, enable] default: disable more...
- av_cache type: int default: 300 more...
- av_log type: str choices: [disable, novirus, all] default: novirus more...
- av_preload type: str choices: [disable, enable] default: disable more...
- av2_cache type: int default: 800 more...
- av2_log type: str choices: [disable, noav2, all] default: noav2 more...
- av2_preload type: str choices: [disable, enable] default: disable more...
- eventlog_query type: str choices: [disable, enable] default: disable more...
- fgd_pull_interval type: int default: 10 more...
- fq_cache type: int default: 300 more...
- fq_log type: str choices: [disable, nofilequery, all] default: nofilequery more...
- fq_preload type: str choices: [disable, enable] default: disable more...
- iot_cache type: int default: 300 more...
- iot_log type: str choices: [disable, noiot, all] default: noiot more...
- iot_preload type: str choices: [disable, enable] default: disable more...
- iotv_preload type: str choices: [disable, enable] default: disable more...
- linkd_log type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: debug more...
- max_client_worker type: int default: 0 more...
- max_log_quota type: int default: 6144 more...
- max_unrated_site type: int default: 500 more...
- restrict_as1_dbver type: str more...
- restrict_as2_dbver type: str more...
- restrict_as4_dbver type: str more...
- restrict_av_dbver type: str more...
- restrict_av2_dbver type: str more...
- restrict_fq_dbver type: str more...
- restrict_iots_dbver type: str more...
- restrict_wf_dbver type: str more...
- server_override type: dict more...
- stat_log type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: disable more...
- stat_log_interval type: int default: 60 more...
- stat_sync_interval type: int default: 60 more...
- update_interval type: int default: 6 more...
- update_log type: str choices: [disable, enable] default: enable more...
- wf_cache type: int default: 0 more...
- wf_dn_cache_expire_time type: int default: 30 more...
- wf_dn_cache_max_number type: int default: 10000 more...
- wf_log type: str choices: [disable, nourl, all] default: nourl more...
- wf_preload type: str choices: [disable, enable] default: enable more...
Notes
Note
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
hosts: fortianalyzers
connection: httpapi
gather_facts: false
vars:
ansible_network_os: fortinet.fortianalyzer.fortianalyzer
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
tasks:
- name: Cli fmupdate fgd setting
fortinet.fortianalyzer.faz_cli_fmupdate_fgdsetting:
# bypass_validation: false
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
cli_fmupdate_fgdsetting:
# as_cache: <value of integer>
# as_log: <value in [disable, nospam, all]>
# as_preload: <value in [disable, enable]>
# av_cache: <value of integer>
# av_log: <value in [disable, novirus, all]>
# av_preload: <value in [disable, enable]>
# av2_cache: <value of integer>
# av2_log: <value in [disable, noav2, all]>
# av2_preload: <value in [disable, enable]>
# eventlog_query: <value in [disable, enable]>
# fgd_pull_interval: <value of integer>
# fq_cache: <value of integer>
# fq_log: <value in [disable, nofilequery, all]>
# fq_preload: <value in [disable, enable]>
# iot_cache: <value of 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: <value of integer>
# max_log_quota: <value of integer>
# max_unrated_site: <value of integer>
# restrict_as1_dbver: <value of string>
# restrict_as2_dbver: <value of string>
# restrict_as4_dbver: <value of string>
# restrict_av_dbver: <value of string>
# restrict_av2_dbver: <value of string>
# restrict_fq_dbver: <value of string>
# restrict_iots_dbver: <value of string>
# restrict_wf_dbver: <value of string>
# server_override:
# servlist:
# - id: <value of integer>
# ip: <value of string>
# ip6: <value of string>
# port: <value of integer>
# service_type: <value in [fgd, fsa, fgfq, ...]>
# status: <value in [disable, enable]>
# stat_log: <value in [emergency, alert, critical, ...]>
# stat_log_interval: <value of integer>
# stat_sync_interval: <value of integer>
# update_interval: <value of integer>
# update_log: <value in [disable, enable]>
# wf_cache: <value of integer>
# wf_dn_cache_expire_time: <value of integer>
# wf_dn_cache_max_number: <value of 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 fortianalyzer version. returned: if params are not supported in the current version type: list
Status
This module is not guaranteed to have a backwards compatible interface.