fortinet.fortios.fortios_user_saml – SAML server entry configuration 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_user_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 user 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 |
| Enable/Disable logging for task. | |
state string / required |
| Indicates whether to create or remove the object. | |
user_saml dictionary | SAML server entry configuration. | ||
adfs_claim string |
| Enable/disable ADFS Claim for user/group attribute in assertion statement . | |
cert string | Certificate to sign SAML messages. Source vpn.certificate.local.name. | ||
digest_method string |
| Digest Method Algorithm. . | |
entity_id string | SP entity ID. | ||
group_claim_type string |
| Group claim in assertion statement. | |
group_name string | Group name in assertion statement. | ||
idp_cert string | IDP Certificate name. Source vpn.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. | ||
limit_relaystate string |
| Enable/disable limiting of relay-state parameter when it exceeds SAML 2.0 specification limits (80 bytes). | |
name string / required | SAML server entry name. | ||
single_logout_url string | SP single logout URL. | ||
single_sign_on_url string | SP single sign-on URL. | ||
user_claim_type string |
| User name claim in assertion statement. | |
user_name string | User name in assertion statement. | ||
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: SAML server entry configuration. fortios_user_saml: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" user_saml: adfs_claim: "enable" cert: "<your_own_value> (source vpn.certificate.local.name)" digest_method: "sha1" entity_id: "<your_own_value>" group_claim_type: "email" group_name: "<your_own_value>" idp_cert: "<your_own_value> (source vpn.certificate.remote.name)" idp_entity_id: "<your_own_value>" idp_single_logout_url: "<your_own_value>" idp_single_sign_on_url: "<your_own_value>" limit_relaystate: "enable" name: "default_name_14" single_logout_url: "<your_own_value>" single_sign_on_url: "<your_own_value>" user_claim_type: "email" user_name: "<your_own_value>"
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_user_saml_module.html