W3cubDocs

/Ansible

fortinet.fortimanager.fmgr_system_saml – Global settings for SAML authentication.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_saml.

New in version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter			Choices/Defaults	Comments
bypass_validation boolean			Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log boolean			Choices: no ← yes	Enable/Disable logging for task
proposed_method string			Choices: update set add	The overridden method for the underlying Json RPC request
rc_failed list / elements=string				the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string				the rc codes list with which the conditions to succeed will be overriden
state string / required			Choices: present absent	the directive to create, update or delete an object
system_saml dictionary				the top level parameters set
	acs-url string			SP ACS(login) URL.
	cert string			Certificate name.
	default-profile string		Default: "Restricted_User"	Default Profile Name.
	entity-id string			SP entity ID.
	fabric-idp list / elements=string			no description
		dev-id string		IDP Device ID.
		idp-cert string		IDP Certificate name.
		idp-entity-id string		IDP entity ID.
		idp-single-logout-url string		IDP single logout url.
		idp-single-sign-on-url string		IDP single sign-on URL.
		idp-status string	Choices: disable ← enable	Enable/disable SAML authentication (default = disable). disable - Disable SAML authentication. enable - Enabld SAML authentication.
	forticloud-sso string		Choices: disable ← enable	Enable/disable FortiCloud SSO (default = disable). disable - Disable Forticloud SSO. enable - Enabld Forticloud SSO.
	idp-cert string			IDP Certificate name.
	idp-entity-id string			IDP entity ID.
	idp-single-logout-url string			IDP single logout url.
	idp-single-sign-on-url string			IDP single sign-on URL.
	login-auto-redirect string		Choices: disable ← enable	Enable/Disable auto redirect to IDP login page. disable - Disable auto redirect to IDP Login Page. enable - Enable auto redirect to IDP Login Page.
	role string		Choices: IDP SP ← FAB-SP	SAML role. IDP - IDentiy Provider. SP - Service Provider.
	server-address string			server address.
	service-providers list / elements=string			no description
		idp-entity-id string		IDP Entity ID.
		idp-single-logout-url string		IDP single logout url.
		idp-single-sign-on-url string		IDP single sign-on URL.
		name string		Name.
		prefix string		Prefix.
		sp-cert string		SP certificate name.
		sp-entity-id string		SP Entity ID.
		sp-single-logout-url string		SP single logout URL.
		sp-single-sign-on-url string		SP single sign-on URL.
	sls-url string			SP SLS(logout) URL.
	status string		Choices: disable ← enable	Enable/disable SAML authentication (default = disable). disable - Disable SAML authentication. enable - Enabld SAML authentication.
workspace_locking_adom string				the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer			Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

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: Global settings for SAML authentication.
     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>
           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]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_saml_module.html