Try SpotterGlobal settings for SAML authentication.
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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]>
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
system_saml:
description: The top level parameters set.
required: false
suboptions:
acs-url:
description: Deprecated, please rename it to acs_url. SP ACS
type: str
auth-request-signed:
choices:
- disable
- enable
description:
- Deprecated, please rename it to auth_request_signed.
- Enable/Disable auth request signed.
- disable - Disable setting.
- enable - Enable setting.
type: str
cert:
description: Certificate name.
type: str
default-profile:
description: Deprecated, please rename it to default_profile. Default Profile
Name.
type: str
entity-id:
description: Deprecated, please rename it to entity_id. SP entity ID.
type: str
fabric-idp:
description: Deprecated, please rename it to fabric_idp. Fabric-Idp.
elements: dict
suboptions:
dev-id:
description: Deprecated, please rename it to dev_id. IDP Device ID.
type: str
idp-cert:
description: Deprecated, please rename it to idp_cert. IDP Certificate name.
type: str
idp-entity-id:
description: Deprecated, please rename it to idp_entity_id. IDP entity ID.
type: str
idp-single-logout-url:
description: Deprecated, please rename it to idp_single_logout_url. IDP single
logout url.
type: str
idp-single-sign-on-url:
description: Deprecated, please rename it to idp_single_sign_on_url. IDP single
sign-on URL.
type: str
idp-status:
choices:
- disable
- enable
description:
- Deprecated, please rename it to idp_status.
- Enable/disable SAML authentication
- disable - Disable SAML authentication.
- enable - Enabld SAML authentication.
type: str
type: list
forticloud-sso:
choices:
- disable
- enable
description:
- Deprecated, please rename it to forticloud_sso.
- Enable/disable FortiCloud SSO
- disable - Disable Forticloud SSO.
- enable - Enabld Forticloud SSO.
type: str
idp-cert:
description: Deprecated, please rename it to idp_cert. IDP Certificate name.
type: str
idp-entity-id:
description: Deprecated, please rename it to idp_entity_id. IDP entity ID.
type: str
idp-single-logout-url:
description: Deprecated, please rename it to idp_single_logout_url. IDP single
logout url.
type: str
idp-single-sign-on-url:
description: Deprecated, please rename it to idp_single_sign_on_url. IDP single
sign-on URL.
type: str
login-auto-redirect:
choices:
- disable
- enable
description:
- 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.
type: str
role:
choices:
- IDP
- SP
- FAB-SP
description:
- SAML role.
- IDP - IDentiy Provider.
- SP - Service Provider.
type: str
server-address:
description: Deprecated, please rename it to server_address. Server address.
type: str
service-providers:
description: Deprecated, please rename it to service_providers. Service-Providers.
elements: dict
suboptions:
idp-entity-id:
description: Deprecated, please rename it to idp_entity_id. IDP Entity ID.
type: str
idp-single-logout-url:
description: Deprecated, please rename it to idp_single_logout_url. IDP single
logout url.
type: str
idp-single-sign-on-url:
description: Deprecated, please rename it to idp_single_sign_on_url. IDP single
sign-on URL.
type: str
name:
description: Name.
type: str
prefix:
description: Prefix.
type: str
sp-adom:
description: Deprecated, please rename it to sp_adom. SP adom name.
type: str
sp-cert:
description: Deprecated, please rename it to sp_cert. SP certificate name.
type: str
sp-entity-id:
description: Deprecated, please rename it to sp_entity_id. SP Entity ID.
type: str
sp-profile:
description: Deprecated, please rename it to sp_profile. SP profile name.
type: str
sp-single-logout-url:
description: Deprecated, please rename it to sp_single_logout_url. SP single
logout URL.
type: str
sp-single-sign-on-url:
description: Deprecated, please rename it to sp_single_sign_on_url. SP single
sign-on URL.
type: str
type: list
sls-url:
description: Deprecated, please rename it to sls_url. SP SLS
type: str
status:
choices:
- disable
- enable
description:
- Enable/disable SAML authentication
- disable - Disable SAML authentication.
- enable - Enabld SAML authentication.
type: str
user-auto-create:
choices:
- disable
- enable
description:
- Deprecated, please rename it to user_auto_create.
- Enable/disable user auto creation
- disable - Disable auto create user.
- enable - Enable auto create user.
type: str
want-assertions-signed:
choices:
- disable
- enable
description:
- Deprecated, please rename it to want_assertions_signed.
- Enable/Disable want assertions signed.
- disable - Disable setting.
- enable - Enable setting.
type: str
type: dict
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list