fmgr_system_saml – Global settings for SAML authentication.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager 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

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
system_saml yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: 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 FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • 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
  • system_saml - no description type: dict
    • acs-url - SP ACS(login) URL. type: str more...
    • cert - Certificate name. type: str more...
    • entity-id - SP entity 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...
    • 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 - Service-Providers. type: array 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...
    • default-profile - Default Profile Name. type: str default: Restricted_User more...
    • fabric-idp - Fabric-Idp. type: array 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...
    • 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...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • 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: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: no description
     fmgr_system_saml:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        system_saml:
           acs-url: <value of string>
           cert: <value of string>
           entity-id: <value of string>
           idp-cert: <value of string>
           idp-entity-id: <value of string>
           idp-single-logout-url: <value of string>
           idp-single-sign-on-url: <value of string>
           login-auto-redirect: <value in [disable, enable]>
           role: <value in [IDP, SP, FAB-SP]>
           server-address: <value of string>
           service-providers:
             -
                 idp-entity-id: <value of string>
                 idp-single-logout-url: <value of string>
                 idp-single-sign-on-url: <value of string>
                 name: <value of string>
                 prefix: <value of string>
                 sp-cert: <value of string>
                 sp-entity-id: <value of string>
                 sp-single-logout-url: <value of string>
                 sp-single-sign-on-url: <value of string>
                 sp-adom: <value of string>
                 sp-profile: <value of string>
           sls-url: <value of string>
           status: <value in [disable, enable]>
           default-profile: <value of string>
           fabric-idp:
             -
                 dev-id: <value of string>
                 idp-cert: <value of string>
                 idp-entity-id: <value of string>
                 idp-single-logout-url: <value of string>
                 idp-single-sign-on-url: <value of string>
                 idp-status: <value in [disable, enable]>
           forticloud-sso: <value in [disable, enable]>
           user-auto-create: <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:

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