faz_cli_system_saml – Global settings for SAML authentication.

Added 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

Supported Version Ranges: v6.2.1 -> 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_system_saml Global settings for SAML authentication. type: dict
    • acs_url SP ACS(login) URL. type: str more...
    • cert Certificate name. type: str more...
    • default_profile Default Profile Name. type: str default: Restricted_User more...
    • entity_id SP entity ID. type: str more...
    • fabric_idp type: list of dict more...
      • dev_id IDP Device ID. type: str more...
      • idp_cert IDP Certificate name. type: str more...
      • idp_entity_id IDP entity ID. type: str more...
      • idp_single_logout_url IDP single logout url. type: str more...
      • idp_single_sign_on_url IDP single sign-on URL. type: str more...
      • idp_status Enable/disable SAML authentication (default = disable). type: str choices: [disable, enable] default: disable more...
    • idp_cert IDP Certificate name. type: str more...
    • idp_entity_id IDP entity ID. type: str more...
    • idp_single_logout_url IDP single logout url. type: str more...
    • idp_single_sign_on_url IDP single sign-on URL. type: str more...
    • login_auto_redirect Enable/Disable auto redirect to IDP login page. type: str choices: [disable, enable] default: disable more...
    • role SAML role. type: str choices: [IDP, SP, FAB-SP] default: SP more...
    • server_address server address. type: str more...
    • service_providers type: list of dict more...
      • idp_entity_id IDP Entity ID. type: str more...
      • idp_single_logout_url IDP single logout url. type: str more...
      • idp_single_sign_on_url IDP single sign-on URL. type: str more...
      • name Name. type: str more...
      • prefix Prefix. type: str more...
      • sp_cert SP certificate name. type: str more...
      • sp_entity_id SP Entity ID. type: str more...
      • sp_single_logout_url SP single logout URL. type: str more...
      • sp_single_sign_on_url SP single sign-on URL. type: str more...
      • sp_adom SP adom name. type: str more...
      • sp_profile SP profile name. type: str more...
    • sls_url SP SLS(logout) URL. type: str more...
    • status Enable/disable SAML authentication (default = disable). type: str choices: [disable, enable] default: disable more...
    • forticloud_sso Enable/disable FortiCloud SSO (default = disable). type: str choices: [disable, enable] default: disable more...
    • user_auto_create Enable/disable user auto creation (default = disable). type: str choices: [disable, enable] default: disable more...
    • auth_request_signed Enable/Disable auth request signed. type: str choices: [disable, enable] default: disable more...
    • want_assertions_signed Enable/Disable want assertions signed. type: str choices: [disable, enable] default: disable 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
  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_network_os: fortinet.fortianalyzer.fortianalyzer
    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)

  • Maxx Liu (@MaxxLiu22)

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)