Docs4dev
Docs
ansible / latest / collections / fortinet / fortios / fortios_system_saml_module.html

fortinet.fortios.fortios_system_saml – Global settings for SAML authentication in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

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.

To use it in a playbook, specify: fortinet.fortios.fortios_system_saml.

New in version 2.10: of fortinet.fortios

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

Parameters

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
system_saml
dictionary
Global settings for SAML authentication.
artifact_resolution_url
string
SP artifact resolution URL.
binding_protocol
string
    Choices:
  • post
  • redirect
Binding protocol.
cert
string
Certificate to sign SAML messages. Source certificate.local.name.
default_login_page
string
    Choices:
  • normal
  • sso
Choose default login page.
default_profile
string
Default profile for new SSO admin. Source system.accprofile.name.
entity_id
string
SP entity ID.
idp_artifact_resolution_url
string
IDP artifact resolution URL.
idp_cert
string
IDP certificate name. Source certificate.remote.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.
life
integer
Length of the range of time when the assertion is valid (in minutes).
portal_url
string
SP portal URL.
role
string
    Choices:
  • identity-provider
  • service-provider
SAML role.
server_address
string
Server address.
service_providers
list / elements=string
Authorized service providers.
assertion_attributes
list / elements=string
Customized SAML attributes to send along with assertion.
name
string / required
Name.
type
string
    Choices:
  • username
  • email
  • profile-name
Type.
idp_artifact_resolution_url
string
IDP artifact resolution URL.
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 / required
Name.
prefix
string
Prefix.
sp_artifact_resolution_url
string
SP artifact resolution URL.
sp_binding_protocol
string
    Choices:
  • post
  • redirect
SP binding protocol.
sp_cert
string
SP certificate name. Source certificate.remote.name.
sp_entity_id
string
SP entity ID.
sp_portal_url
string
SP portal URL.
sp_single_logout_url
string
SP single logout URL.
sp_single_sign_on_url
string
SP single sign-on URL.
single_logout_url
string
SP single logout URL.
single_sign_on_url
string
SP single sign-on URL.
status
string
    Choices:
  • enable
  • disable
Enable/disable SAML authentication .
tolerance
integer
Tolerance to the range of time when the assertion is valid (in minutes).
vdom
string
Default:
"root"
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.

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: "14"
        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: "38"

Return Values

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

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

Sample:
v5.6.3


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

© 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/fortios/fortios_system_saml_module.html