faz_cli_system_csf – Add this device to a Security Fabric or set up a new Security Fabric on this device.

New in version 1.3.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.name

• Corresponding 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.

Requirements

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

• ansible>=2.15.0

FortiAnalyzer Version Compatibility

6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
None	False	False	False	None	False	False	False	False	False	False	False	False
6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
False	False	False	False	False	False	False	False	False	False	False	False
7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
False	False	False	False	False
7.4.0	7.4.1	7.4.2
False	True	True

Parameters

• access_token -The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str required: false
• enable_log - Enable/Disable logging for task type: bool required: false default: False
• forticloud_access_token - Access token of forticloud analyzer API users. type: str required: false
• 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 required: false default: "/tmp/fortianalyzer.ansible.log"
• 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_csf - Add this device to a Security Fabric or set up a new Security Fabric on this device. type: dict
• accept_auth_by_cert - Accept connections with unknown certificates and ask admin for approval. type: str choices: [disable, enable] default: enable more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• authorization_request_type - Authorization request type. type: str choices: [certificate, serial] default: certificate more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• certificate - Certificate. type: str default: Fortinet_Local more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• configuration_sync - Configuration sync mode. type: str choices: [default, local] default: default more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• downstream_access - Enable/disable downstream device access to this devices configuration and data. type: str choices: [disable, enable] default: disable more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• downstream_accprofile - Default access profile for requests from downstream devices. type: str more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• fabric_connector - No description for the parameter type: array more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

  • accprofile - Override access profile. type: str more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	False	False	False	None	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    False	False	False	False	False
    7.4.0	7.4.1	7.4.2
    False	True	True

  • configuration_write_access - Enable/disable downstream device write access to configuration. type: str choices: [disable, enable] default: disable more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	False	False	False	None	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    False	False	False	False	False
    7.4.0	7.4.1	7.4.2
    False	True	True

  • serial - Serial. type: str more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	False	False	False	None	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    False	False	False	False	False
    7.4.0	7.4.1	7.4.2
    False	True	True

• fabric_object_unification - Fabric CMDB Object Unification. type: str choices: [local, default] default: default more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• fabric_workers - Number of worker processes for Security Fabric daemon. type: int default: 2 more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• file_mgmt - Enable/disable Security Fabric daemon file management. type: str choices: [disable, enable] default: enable more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• file_quota - Maximum amount of memory that can be used by the daemon files (in bytes). type: int default: 0 more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• file_quota_warning - Warn when the set percentage of quota has been used. type: int default: 90 more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• fixed_key - No description for the parameter type: str more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• forticloud_account_enforcement - Fabric FortiCloud account unification. type: str choices: [disable, enable] default: enable more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• group_name - Security Fabric group name. type: str more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• group_password - No description for the parameter type: str more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• log_unification - Enable/disable broadcast of discovery messages for log unification. type: str choices: [disable, enable] default: enable more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• saml_configuration_sync - SAML setting configuration synchronization. type: str choices: [local, default] default: default more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• status - Enable/disable Security Fabric. type: str choices: [disable, enable] default: disable more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• trusted_list - No description for the parameter type: array more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

  • action - Security fabric authorization action. type: str choices: [accept, deny] default: accept more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	False	False	False	None	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    False	False	False	False	False
    7.4.0	7.4.1	7.4.2
    False	True	True

  • authorization_type - Authorization type. type: str choices: [serial, certificate] default: serial more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	False	False	False	None	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    False	False	False	False	False
    7.4.0	7.4.1	7.4.2
    False	True	True

  • certificate - Certificate. type: str more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	False	False	False	None	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    False	False	False	False	False
    7.4.0	7.4.1	7.4.2
    False	True	True

  • downstream_authorization - Trust authorizations by this nodes administrator. type: str choices: [disable, enable] default: disable more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	False	False	False	None	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    False	False	False	False	False
    7.4.0	7.4.1	7.4.2
    False	True	True

  • ha_members - HA members. type: str more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	False	False	False	None	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    False	False	False	False	False
    7.4.0	7.4.1	7.4.2
    False	True	True

  • index - Index of the downstream in tree. type: int default: 0 more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	False	False	False	None	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    False	False	False	False	False
    7.4.0	7.4.1	7.4.2
    False	True	True

  • name - Name. type: str more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	False	False	False	None	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    False	False	False	False	False
    7.4.0	7.4.1	7.4.2
    False	True	True

  • serial - Serial. type: str more...

    6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
    None	False	False	False	None	False	False	False	False	False	False	False	False
    6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
    None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
    7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
    False	False	False	False	False	False	False	False	False	False	False	False
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    False	False	False	False	False
    7.4.0	7.4.1	7.4.2
    False	True	True

• upstream - IP/FQDN of the FortiGate upstream from this FortiGate in the Security Fabric. type: str more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	True

• upstream_port - The port number to use to communicate with the FortiGate upstream from this FortiGate in the Security Fabric (default = 8013). type: int default: 8013 more...

  6.2.0	6.2.1	6.2.2	6.2.3	6.2.4	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11	6.2.12
  None	False	False	False	None	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12	6.4.13	6.4.14
  None	False	False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8	7.0.9	7.0.10	7.0.11
  False	False	False	False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  False	False	False	False	False
  7.4.0	7.4.1	7.4.2
  False	True	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

- name: Example playbook
  hosts: fortianalyzers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Add this device to a Security Fabric or set up a new Security Fabric on this device.
      fortinet.fortianalyzer.faz_cli_system_csf:
        # bypass_validation: false
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        cli_system_csf:
          accept_auth_by_cert: <value in [disable, enable]>
          authorization_request_type: <value in [certificate, serial]>
          certificate: <value of string>
          configuration_sync: <value in [default, local]>
          downstream_access: <value in [disable, enable]>
          downstream_accprofile: <value of string>
          fabric_connector:
            -
              accprofile: <value of string>
              configuration_write_access: <value in [disable, enable]>
              serial: <value of string>
          fabric_object_unification: <value in [local, default]>
          fabric_workers: <value of integer>
          file_mgmt: <value in [disable, enable]>
          file_quota: <value of integer>
          file_quota_warning: <value of integer>
          fixed_key: <value of string>
          forticloud_account_enforcement: <value in [disable, enable]>
          group_name: <value of string>
          group_password: <value of string>
          log_unification: <value in [disable, enable]>
          saml_configuration_sync: <value in [local, default]>
          status: <value in [disable, enable]>
          trusted_list:
            -
              action: <value in [accept, deny]>
              authorization_type: <value in [serial, certificate]>
              certificate: <value of string>
              downstream_authorization: <value in [disable, enable]>
              ha_members: <value of string>
              index: <value of integer>
              name: <value of string>
              serial: <value of string>
          upstream: <value of string>
          upstream_port: <value of integer>

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.

Authors

• Xinwei Du (@dux-fortinet)

• 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.