fortinet.fortimanager.fmgr_system_saml module – Global settings for SAML authentication.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
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 fortinet.fortimanager 2.0.0
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 |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The top level parameters set. |
|
Deprecated, please rename it to acs_url. SP ACS |
|
Deprecated, please rename it to auth_request_signed. Enable/Disable auth request signed. disable - Disable setting. enable - Enable setting. Choices:
|
|
Certificate name. |
|
Deprecated, please rename it to default_profile. Default Profile Name. |
|
Deprecated, please rename it to entity_id. SP entity ID. |
|
Deprecated, please rename it to fabric_idp. Fabric idp. |
|
Deprecated, please rename it to dev_id. IDP Device ID. |
|
Deprecated, please rename it to idp_cert. IDP Certificate name. |
|
Deprecated, please rename it to idp_entity_id. IDP entity ID. |
|
Deprecated, please rename it to idp_single_logout_url. IDP single logout url. |
|
Deprecated, please rename it to idp_single_sign_on_url. IDP single sign-on URL. |
|
Deprecated, please rename it to idp_status. Enable/disable SAML authentication disable - Disable SAML authentication. enable - Enabld SAML authentication. Choices:
|
|
Deprecated, please rename it to forticloud_sso. Enable/disable FortiCloud SSO disable - Disable Forticloud SSO. enable - Enabld Forticloud SSO. Choices:
|
|
Deprecated, please rename it to idp_cert. IDP Certificate name. |
|
Deprecated, please rename it to idp_entity_id. IDP entity ID. |
|
Deprecated, please rename it to idp_single_logout_url. IDP single logout url. |
|
Deprecated, please rename it to idp_single_sign_on_url. IDP single sign-on URL. |
|
Deprecated, please rename it to login_auto_redirect. Enable/Disable auto redirect to IDP login page. disable - Disable auto redirect to IDP Login Page. enable - Enable auto redirect to IDP Login Page. Choices:
|
|
SAML role. IDP - IDentiy Provider. SP - Service Provider. Choices:
|
|
Deprecated, please rename it to server_address. Server address. |
|
Deprecated, please rename it to service_providers. Service providers. |
|
Deprecated, please rename it to idp_entity_id. IDP Entity ID. |
|
Deprecated, please rename it to idp_single_logout_url. IDP single logout url. |
|
Deprecated, please rename it to idp_single_sign_on_url. IDP single sign-on URL. |
|
Name. |
|
Prefix. |
|
Deprecated, please rename it to sp_adom. SP adom name. |
|
Deprecated, please rename it to sp_cert. SP certificate name. |
|
Deprecated, please rename it to sp_entity_id. SP Entity ID. |
|
Deprecated, please rename it to sp_profile. SP profile name. |
|
Deprecated, please rename it to sp_single_logout_url. SP single logout URL. |
|
Deprecated, please rename it to sp_single_sign_on_url. SP single sign-on URL. |
|
Deprecated, please rename it to sls_url. SP SLS |
|
Enable/disable SAML authentication disable - Disable SAML authentication. enable - Enabld SAML authentication. Choices:
|
|
Deprecated, please rename it to user_auto_create. Enable/disable user auto creation disable - Disable auto create user. enable - Enable auto create user. Choices:
|
|
Deprecated, please rename it to want_assertions_signed. Enable/Disable want assertions signed. disable - Disable setting. enable - Enable setting. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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.
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 (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Global settings for SAML authentication.
fortinet.fortimanager.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: <string>
cert: <string>
entity_id: <string>
idp_cert: <string>
idp_entity_id: <string>
idp_single_logout_url: <string>
idp_single_sign_on_url: <string>
login_auto_redirect: <value in [disable, enable]>
role: <value in [IDP, SP, FAB-SP]>
server_address: <string>
service_providers:
-
idp_entity_id: <string>
idp_single_logout_url: <string>
idp_single_sign_on_url: <string>
name: <string>
prefix: <string>
sp_cert: <string>
sp_entity_id: <string>
sp_single_logout_url: <string>
sp_single_sign_on_url: <string>
sp_adom: <string>
sp_profile: <string>
sls_url: <string>
status: <value in [disable, enable]>
default_profile: <string>
fabric_idp:
-
dev_id: <string>
idp_cert: <string>
idp_entity_id: <string>
idp_single_logout_url: <string>
idp_single_sign_on_url: <string>
idp_status: <value in [disable, enable]>
forticloud_sso: <value in [disable, enable]>
user_auto_create: <value in [disable, enable]>
auth_request_signed: <value in [disable, enable]>
want_assertions_signed: <value in [disable, enable]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |