faz_cli_system_saml – Global settings for SAML authentication.

New in version 1.0.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	True	True	True	None	True	True	True	True	True	True	True	True
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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
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
True	True	True	True	True	True	True	True	True	True	True	True
7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
True	True	True	True	True
7.4.0	7.4.1	7.4.2
True	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_saml - Global settings for SAML authentication. type: dict
• acs_url - SP ACS(login) URL. 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	True	True	True	None	True	True	True	True	True	True	True	True
  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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• cert - Certificate 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	True	True	True	None	True	True	True	True	True	True	True	True
  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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• default_profile - Default Profile Name. type: str default: Restricted_User 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	True	False	False	None	True	True	True	True	True	True	True	True
  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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• entity_id - SP entity ID. 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	True	True	True	None	True	True	True	True	True	True	True	True
  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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• fabric_idp - 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	True	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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

  • dev_id - IDP Device ID. 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	True	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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    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
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • idp_cert - IDP Certificate 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	True	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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    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
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • idp_entity_id - IDP entity ID. 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	True	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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    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
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • idp_single_logout_url - IDP single logout url. 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	True	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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    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
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • idp_single_sign_on_url - IDP single sign-on URL. 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	True	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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    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
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • idp_status - Enable/disable SAML authentication (default = disable). 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	True	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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    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
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

• idp_cert - IDP Certificate 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	True	True	True	None	True	True	True	True	True	True	True	True
  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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• idp_entity_id - IDP entity ID. 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	True	True	True	None	True	True	True	True	True	True	True	True
  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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• idp_single_logout_url - IDP single logout url. 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	True	True	True	None	True	True	True	True	True	True	True	True
  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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• idp_single_sign_on_url - IDP single sign-on URL. 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	True	True	True	None	True	True	True	True	True	True	True	True
  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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• login_auto_redirect - Enable/Disable auto redirect to IDP login page. 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	True	True	True	None	True	True	True	True	True	True	True	True
  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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• role - SAML role. type: str choices: [IDP, SP, FAB-SP] default: SP 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	True	True	True	None	True	True	True	True	True	True	True	True
  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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• server_address - server address. 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	True	True	True	None	True	True	True	True	True	True	True	True
  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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• service_providers - 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	True	True	True	None	True	True	True	True	True	True	True	True
  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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

  • idp_entity_id - IDP Entity ID. 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	True	True	True	None	True	True	True	True	True	True	True	True
    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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    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
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • idp_single_logout_url - IDP single logout url. 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	True	True	True	None	True	True	True	True	True	True	True	True
    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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    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
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • idp_single_sign_on_url - IDP single sign-on URL. 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	True	True	True	None	True	True	True	True	True	True	True	True
    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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    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
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	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	True	True	True	None	True	True	True	True	True	True	True	True
    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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    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
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • prefix - Prefix. 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	True	True	True	None	True	True	True	True	True	True	True	True
    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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    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
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • sp_cert - SP certificate 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	True	True	True	None	True	True	True	True	True	True	True	True
    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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    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
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • sp_entity_id - SP Entity ID. 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	True	True	True	None	True	True	True	True	True	True	True	True
    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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    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
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • sp_single_logout_url - SP single logout URL. 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	True	True	True	None	True	True	True	True	True	True	True	True
    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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    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
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • sp_single_sign_on_url - SP single sign-on URL. 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	True	True	True	None	True	True	True	True	True	True	True	True
    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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
    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
    True	True	True	True	True	True	True	True	True	True	True	True
    7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • sp_adom - SP adom 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
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

  • sp_profile - SP profile 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
    True	True	True	True	True
    7.4.0	7.4.1	7.4.2
    True	True	True

• sls_url - SP SLS(logout) URL. 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	True	True	True	None	True	True	True	True	True	True	True	True
  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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• status - Enable/disable SAML authentication (default = disable). 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	True	True	True	None	True	True	True	True	True	True	True	True
  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	True	True	True	True	True	True	True	True	True	True	True	True	True	True
  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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• forticloud_sso - Enable/disable FortiCloud SSO (default = disable). 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
  True	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• user_auto_create - Enable/disable user auto creation (default = disable). 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	True	True	True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3	7.2.4
  True	True	True	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• auth_request_signed - Enable/Disable auth request signed. 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	True	True
  7.4.0	7.4.1	7.4.2
  True	True	True

• want_assertions_signed - Enable/Disable want assertions signed. 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	True	True
  7.4.0	7.4.1	7.4.2
  True	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
  connection: httpapi
  hosts: fortianalyzers
  tasks:
    - name: Global settings for SAML authentication.
      fortinet.fortianalyzer.faz_cli_system_saml:
        cli_system_saml:
          # forticloud_sso: disable
          login_auto_redirect: disable
          status: disable
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

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.