faz_cli_system_global – Global range attributes.¶

New in version 2.10.

Synopsis
Requirements
FortiAnalyzer Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

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.

Requirements ¶

The below requirements are needed on the host that executes this module.

ansible>=2.9.0

FortiAnalyzer Version Compatibility ¶

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

cli_system_global yes yes yes yes yes yes yes yes yes yes yes yes

Parameters ¶

enable_log - Enable/Disable logging for task type: bool required: false default: False
proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
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
cli_system_global - Global range attributes. type: dict

admin-lockout-duration - Lockout duration(sec) for administration. type: int default: 60 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

admin-lockout-duration True True True True True True True True True True True True
admin-lockout-threshold - Lockout threshold for administration. type: int default: 3 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

admin-lockout-threshold True True True True True True True True True True True True
adom-mode - ADOM mode. type: str choices: [normal, advanced] default: normal more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

adom-mode True True True True True True True True True True True True
adom-select - Enable/disable select ADOM after login. type: str choices: [disable, enable] default: enable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

adom-select True True True True True True True True True True True True
adom-status - ADOM status. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

adom-status True True True True True True True True True True True True
backup-compression - Compression level. type: str choices: [none, low, normal, high] default: normal more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

backup-compression True True True True True True True True True True True True
backup-to-subfolders - Enable/disable creation of subfolders on server for backup storage. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

backup-to-subfolders True True True True True True True True True True True True
clone-name-option - set the clone object names option. type: str choices: [default, keep] default: default more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

clone-name-option True True True True True True True True True True True True
clt-cert-req - Require client certificate for GUI login. type: str choices: [disable, enable, optional] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

clt-cert-req True True True True True True True True True True True True
console-output - Console output mode. type: str choices: [standard, more] default: standard more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

console-output True True True True True True True True True True True True
country-flag - Country flag Status. type: str choices: [disable, enable] default: enable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

country-flag True True True True True True True True True True True True
create-revision - Enable/disable create revision by default. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

create-revision True True True True True True True True True True True True
daylightsavetime - Enable/disable daylight saving time. type: str choices: [disable, enable] default: enable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

daylightsavetime True True True True True True True True True True True True
default-logview-auto-completion - Enable/disable log view filter auto-completion. type: str choices: [disable, enable] default: enable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

default-logview-auto-completion True False False False False True True True True True True True
default-search-mode - Set the default search mode of log view. type: str choices: [filter-based, advanced] default: filter-based more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

default-search-mode True True True True True True True True True True True True
detect-unregistered-log-device - Detect unregistered logging device from log message. type: str choices: [disable, enable] default: enable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

detect-unregistered-log-device True True True True True True True True True True True True
device-view-mode - Set devices/groups view mode. type: str choices: [regular, tree] default: regular more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

device-view-mode True True True True True True True True True True True True
dh-params - Minimum size of Diffie-Hellman prime for SSH/HTTPS (bits). type: str choices: [1024, 1536, 2048, 3072, 4096, 6144, 8192] default: 2048 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

dh-params True True True True True True True True True True True True
disable-module - No description for the parameter type: array choices: [fortiview-noc, siem, soar, none, soc, fortirecorder, ai] more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

disable-module True True True True True True True True True True True True
enc-algorithm - SSL communication encryption algorithms. type: str choices: [low, medium, high, custom] default: high more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

enc-algorithm True True True True True True True True True True True True
fgfm-ca-cert - set the extra fgfm CA certificates. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

fgfm-ca-cert True False True True True True True True True True True True
fgfm-local-cert - set the fgfm local certificate. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

fgfm-local-cert True True True True True True True True True True True True
fgfm-ssl-protocol - set the lowest SSL protocols for fgfmsd. type: str choices: [sslv3, tlsv1.0, tlsv1.1, tlsv1.2, tlsv1.3] default: tlsv1.2 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

fgfm-ssl-protocol True True True True True True True True True True True True
ha-member-auto-grouping - Enable/disable automatically group HA members feature type: str choices: [disable, enable] default: enable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ha-member-auto-grouping True True True True True True True True True True True True
hitcount_concurrent - The number of FortiGates that FortiManager polls at one time (10 - 500, default = 100). type: int default: 100 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

hitcount_concurrent True True True True True True True False False False False False
hitcount_interval - The interval for getting hit count from managed FortiGate devices, in seconds (60 - 86400, default = 900). type: int default: 900 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

hitcount_interval True True True True True True True False False False False False
hostname - System hostname. type: str default: FAZVM64 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

hostname True True True True True True True True True True True True
language - System global language. type: str choices: [english, simch, japanese, korean, spanish, trach] default: english more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

language True True True True True True True True True True True True
latitude - fmg location latitude type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

latitude True True True True True True True True True True True True
ldap-cache-timeout - LDAP browser cache timeout (seconds). type: int default: 86400 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ldap-cache-timeout True True True True True True True True True True True True
ldapconntimeout - LDAP connection timeout (msec). type: int default: 60000 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ldapconntimeout True True True True True True True True True True True True
lock-preempt - Enable/disable ADOM lock override. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

lock-preempt True True True True True True True True True True True True
log-checksum - Record log file hash value, timestamp, and authentication code at transmission or rolling. type: str choices: [none, md5, md5-auth] default: none more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

log-checksum True True True True True True True True True True True True
log-forward-cache-size - Log forwarding disk cache size (GB). type: int default: 0 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

log-forward-cache-size True True True True True True True True True True True True
log-mode - Log system operation mode. type: str choices: [analyzer, collector] default: analyzer more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

log-mode True True True True True True True True True True True True
longitude - fmg location longitude type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

longitude True True True True True True True True True True True True
max-aggregation-tasks - Maximum number of concurrent tasks of a log aggregation session. type: int default: 0 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

max-aggregation-tasks True True True True True True True True True True True True
max-log-forward - Maximum number of log-forward and aggregation settings. type: int default: 5 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

max-log-forward True True True True True True True True True True True True
max-running-reports - Maximum number of reports generating at one time. type: int default: 1 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

max-running-reports True True True True True True True True True True True True
oftp-ssl-protocol - set the lowest SSL protocols for oftpd. type: str choices: [sslv3, tlsv1.0, tlsv1.1, tlsv1.2, tlsv1.3] default: tlsv1.2 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

oftp-ssl-protocol True True True True True True True True True True True True
policy-hit-count - show policy hit count. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

policy-hit-count True True True True True True True False False False False False
policy-object-icon - show icons of policy objects. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

policy-object-icon True True True True True True True True True True True True
policy-object-in-dual-pane - show policies and objects in dual pane. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

policy-object-in-dual-pane True True True True True True True True True True True True
pre-login-banner - Enable/disable pre-login banner. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

pre-login-banner True True True True True True True True True True True True
pre-login-banner-message - Pre-login banner message. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

pre-login-banner-message True True True True True True True True True True True True
private-data-encryption - Enable/disable private data encryption using an AES 128-bit key. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

private-data-encryption True False False True True True True True True True True True
remoteauthtimeout - Remote authentication (RADIUS/LDAP) timeout (sec). type: int default: 10 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

remoteauthtimeout True True True True True True True True True True True True
search-all-adoms - Enable/Disable Search all ADOMs for where-used query. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

search-all-adoms True True True True True True True True True True True True
ssl-low-encryption - SSL low-grade encryption. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ssl-low-encryption True True True True True True True True True True True True
ssl-protocol - No description for the parameter type: array choices: [tlsv1.3, tlsv1.2, tlsv1.1, tlsv1.0, sslv3] more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ssl-protocol True True True True True True True True True True True True
ssl-static-key-ciphers - Enable/disable SSL static key ciphers. type: str choices: [disable, enable] default: enable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ssl-static-key-ciphers True True True True True True True True True True True True
task-list-size - Maximum number of completed tasks to keep. type: int default: 2000 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

task-list-size True True True True True True True True True True True True
tftp - Enable/disable TFTP in `exec restore image` command (disabled by default in FIPS mode) type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

tftp True True True True True True True True True True True True
timezone - Time zone. 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, 88, 89, 90, 91] default: 04 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

timezone True True True True True True True True True True True True
tunnel-mtu - Maximum transportation unit(68 - 9000). type: int default: 1500 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

tunnel-mtu True True True True True True True True True True True True
usg - Enable/disable Fortiguard server restriction. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

usg True True True True True True True True True True True True
webservice-proto - No description for the parameter type: array choices: [tlsv1.3, tlsv1.2, tlsv1.1, tlsv1.0, sslv3, sslv2] more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

webservice-proto True True True True True True True True True True True True
workflow-max-sessions - Maximum number of workflow sessions per ADOM (minimum 100). type: int default: 500 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

workflow-max-sessions True True True True True True True True True True True True
multiple-steps-upgrade-in-autolink - Enable/disable multiple steps upgade in autolink process type: str choices: [disable, enable] default: disable more...

6.4.5 7.0.0 7.2.0

multiple-steps-upgrade-in-autolink True True True
object-revision-db-max - Maximum revisions for a single database (10,000-1,000,000 default 100,000). type: int default: 100000 more...

7.0.0 7.2.0

object-revision-db-max True True
object-revision-mandatory-note - Enable/disable mandatory note when create revision. type: str choices: [disable, enable] default: enable more...

7.0.0 7.2.0

object-revision-mandatory-note True True
object-revision-object-max - Maximum revisions for a single object (10-1000 default 100). type: int default: 100 more...

7.0.0 7.2.0

object-revision-object-max True True
object-revision-status - Enable/disable create revision when modify objects. type: str choices: [disable, enable] default: enable more...

7.0.0 7.2.0

object-revision-status True True
normalized-intf-zone-only - allow normalized interface to be zone only. type: str choices: [disable, enable] default: disable more...

7.2.0

normalized-intf-zone-only True
ssl-cipher-suites - No description for the parameter type: array more...

7.2.0

ssl-cipher-suites True
- cipher - Cipher name type: str more...
  
  7.2.0
  
  cipher True
- priority - SSL/TLS cipher suites priority. type: int default: 0 more...
  
  7.2.0
  
  priority True
- version - SSL/TLS version the cipher suite can be used with. type: str choices: [tls1.2-or-below, tls1.3] default: tls1.2-or-below more...
  
  7.2.0
  
  version True

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 ¶

- hosts: fortianalyzer-inventory
  connection: httpapi
  collections:
  - fortinet.fortianalyzer
  vars:
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
   - name: Alert console
     faz_cli_system_global:
        enable_log: true
        cli_system_global:
            language: english

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:

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_message - The descriptive message of the api response returned: always type: str sample: OK
response_data - The data body of the api response returned: optional type: list or dict

Status ¶

This module is not guaranteed to have a backwards compatible interface.

Authors ¶

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.