dux_fortinet / dux_fortinet.fortianalyzer_dev / 1.4.0 / module / faz_cli_system_saml Global settings for SAML authentication. | "added in version" 1.0.0 of dux_fortinet.fortianalyzer_dev" Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydux_fortinet.fortianalyzer_dev.faz_cli_system_saml (1.4.0) — module
Install with ansible-galaxy collection install dux_fortinet.fortianalyzer_dev:==1.4.0
collections: - name: dux_fortinet.fortianalyzer_dev version: 1.4.0
This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook connection: httpapi hosts: fortianalyzers tasks: - name: Global settings for SAML authentication. fortinet.fortianalyzer.faz_cli_system_saml: cli_system_saml: # forticloud_sso: disable login_auto_redirect: disable status: disable vars: ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false
log_path: default: /tmp/fortianalyzer.ansible.log description: - The path to save log. Used if enable_log is true. - Please use absolute path instead of relative path. - If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.log required: false type: str rc_failed: description: the rc codes list with which the conditions to fail will be overriden elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: the rc codes list with which the conditions to succeed will be overriden elements: int required: false type: list cli_system_saml: description: The top level parameters set. required: false suboptions: acs-url: description: SP ACS(login) URL. type: str auth-request-signed: choices: - disable - enable description: - Enable/Disable auth request signed. - disable - Disable setting. - enable - Enable setting. type: str cert: description: Certificate name. type: str default-profile: description: Default Profile Name. type: str entity-id: description: SP entity ID. type: str fabric-idp: description: no description elements: dict suboptions: dev-id: description: IDP Device ID. type: str idp-cert: description: IDP Certificate name. type: str idp-entity-id: description: IDP entity ID. type: str idp-single-logout-url: description: IDP single logout url. type: str idp-single-sign-on-url: description: IDP single sign-on URL. type: str idp-status: choices: - disable - enable description: - Enable/disable SAML authentication (default = disable). - disable - Disable SAML authentication. - enable - Enabld SAML authentication. type: str type: list forticloud-sso: choices: - disable - enable description: - Enable/disable FortiCloud SSO (default = disable). - disable - Disable Forticloud SSO. - enable - Enabld Forticloud SSO. type: str idp-cert: description: IDP Certificate name. type: str idp-entity-id: description: IDP entity ID. type: str idp-single-logout-url: description: IDP single logout url. type: str idp-single-sign-on-url: description: IDP single sign-on URL. type: str login-auto-redirect: choices: - disable - enable description: - 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. - FAB-SP - Fabric Service Provider. type: str server-address: description: server address. type: str service-providers: description: no description elements: dict suboptions: idp-entity-id: description: IDP Entity ID. type: str idp-single-logout-url: description: IDP single logout url. type: str idp-single-sign-on-url: description: IDP single sign-on URL. type: str name: description: Name. type: str prefix: description: Prefix. type: str sp-adom: description: SP adom name. type: str sp-cert: description: SP certificate name. type: str sp-entity-id: description: SP Entity ID. type: str sp-profile: description: SP profile name. type: str sp-single-logout-url: description: SP single logout URL. type: str sp-single-sign-on-url: description: SP single sign-on URL. type: str type: list sls-url: description: SP SLS(logout) URL. type: str status: choices: - disable - enable description: - Enable/disable SAML authentication (default = disable). - disable - Disable SAML authentication. - enable - Enabld SAML authentication. type: str user-auto-create: choices: - disable - enable description: - Enable/disable user auto creation (default = disable). - disable - Disable auto create user. - enable - Enable auto create user. type: str want-assertions-signed: choices: - disable - enable description: - Enable/Disable want assertions signed. - disable - Disable setting. - enable - Enable setting. type: str type: dict proposed_method: choices: - set - update - add description: The overridden method for the underlying Json RPC request required: false type: str bypass_validation: default: false description: only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters required: false type: bool forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str
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 fortianalyzer version. returned: complex type: list