fortinet.fortios.fortios_system_saml module – Global settings for SAML authentication in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.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.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_system_saml.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and saml category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.9
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Global settings for SAML authentication. |
|
SP artifact resolution URL. |
|
IdP Binding protocol. Choices:
|
|
Certificate to sign SAML messages. Source certificate.local.name. |
|
Choose default login page. Choices:
|
|
Default profile for new SSO admin. Source system.accprofile.name. |
|
SP entity ID. |
|
IDP artifact resolution URL. |
|
IDP certificate name. Source certificate.remote.name. |
|
IDP entity ID. |
|
IDP single logout URL. |
|
IDP single sign-on URL. |
|
Length of the range of time when the assertion is valid (in minutes). |
|
SP portal URL. |
|
SAML role. Choices:
|
|
Server address. |
|
Authorized service providers. |
|
Customized SAML attributes to send along with assertion. |
|
Name. |
|
Type. Choices:
|
|
IDP artifact resolution URL. |
|
IDP entity ID. |
|
IDP single logout URL. |
|
IDP single sign-on URL. |
|
Name. |
|
Prefix. |
|
SP artifact resolution URL. |
|
SP binding protocol. Choices:
|
|
SP certificate name. Source certificate.remote.name. |
|
SP entity ID. |
|
SP portal URL. |
|
SP single logout URL. |
|
SP single sign-on URL. |
|
SP single logout URL. |
|
SP single sign-on URL. |
|
Enable/disable SAML authentication . Choices:
|
|
Tolerance to the range of time when the assertion is valid (in minutes). |
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Global settings for SAML authentication.
fortios_system_saml:
vdom: "{{ vdom }}"
system_saml:
artifact_resolution_url: "<your_own_value>"
binding_protocol: "post"
cert: "<your_own_value> (source certificate.local.name)"
default_login_page: "normal"
default_profile: "<your_own_value> (source system.accprofile.name)"
entity_id: "<your_own_value>"
idp_artifact_resolution_url: "<your_own_value>"
idp_cert: "<your_own_value> (source certificate.remote.name)"
idp_entity_id: "<your_own_value>"
idp_single_logout_url: "<your_own_value>"
idp_single_sign_on_url: "<your_own_value>"
life: "30"
portal_url: "<your_own_value>"
role: "identity-provider"
server_address: "<your_own_value>"
service_providers:
-
assertion_attributes:
-
name: "default_name_20"
type: "username"
idp_artifact_resolution_url: "<your_own_value>"
idp_entity_id: "<your_own_value>"
idp_single_logout_url: "<your_own_value>"
idp_single_sign_on_url: "<your_own_value>"
name: "default_name_26"
prefix: "<your_own_value>"
sp_artifact_resolution_url: "<your_own_value>"
sp_binding_protocol: "post"
sp_cert: "<your_own_value> (source certificate.remote.name)"
sp_entity_id: "<your_own_value>"
sp_portal_url: "<your_own_value>"
sp_single_logout_url: "<your_own_value>"
sp_single_sign_on_url: "<your_own_value>"
single_logout_url: "<your_own_value>"
single_sign_on_url: "<your_own_value>"
status: "enable"
tolerance: "5"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |