Try SpotterConfigure Fortinet Single Sign On
| "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
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure Fortinet Single Sign On (FSSO) agents.
fortinet.fortimanager.fmgr_user_fsso:
bypass_validation: false
adom: ansible
state: present
user_fsso:
name: ansible-test-fsso
password: fortinet
port: 9000
server: ansible
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the Fortinet Single Sign On (FSSO) agents
fortinet.fortimanager.fmgr_fact:
facts:
selector: "user_fsso"
params:
adom: "ansible"
fsso: "your_value"
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
user_fsso:
description: The top level parameters set.
required: false
suboptions:
_gui_meta:
description: _Gui_Meta.
type: str
dynamic_mapping:
description: Dynamic_Mapping.
elements: dict
suboptions:
_gui_meta:
description: _Gui_Meta.
type: str
_scope:
description: _Scope.
elements: dict
suboptions:
name:
description: Name.
type: str
vdom:
description: Vdom.
type: str
type: list
group-poll-interval:
description: Deprecated, please rename it to group_poll_interval. Interval
in minutes within to fetch groups from FSSO server, ...
type: int
interface:
description: Specify outgoing interface to reach server.
type: str
interface-select-method:
choices:
- auto
- sdwan
- specify
description: Deprecated, please rename it to interface_select_method. Specify
how to select outgoing interface to reach server.
type: str
ldap-poll:
choices:
- disable
- enable
description: Deprecated, please rename it to ldap_poll. Enable/disable automatic
fetching of groups from LDAP server.
type: str
ldap-poll-filter:
description: Deprecated, please rename it to ldap_poll_filter. Filter used
to fetch groups.
type: str
ldap-poll-interval:
description: Deprecated, please rename it to ldap_poll_interval. Interval
in minutes within to fetch groups from LDAP server.
type: int
ldap-server:
description: Deprecated, please rename it to ldap_server. LDAP server to get
group information.
type: str
logon-timeout:
description: Deprecated, please rename it to logon_timeout. Interval in minutes
to keep logons after FSSO server down.
type: int
password:
description: (list) Password of the first FSSO collector agent.
type: raw
password2:
description: (list) Password of the second FSSO collector agent.
type: raw
password3:
description: (list) Password of the third FSSO collector agent.
type: raw
password4:
description: (list) Password of the fourth FSSO collector agent.
type: raw
password5:
description: (list) Password of the fifth FSSO collector agent.
type: raw
port:
description: Port of the first FSSO collector agent.
type: int
port2:
description: Port of the second FSSO collector agent.
type: int
port3:
description: Port of the third FSSO collector agent.
type: int
port4:
description: Port of the fourth FSSO collector agent.
type: int
port5:
description: Port of the fifth FSSO collector agent.
type: int
server:
description: Domain name or IP address of the first FSSO collector agent.
type: str
server2:
description: Domain name or IP address of the second FSSO collector agent.
type: str
server3:
description: Domain name or IP address of the third FSSO collector agent.
type: str
server4:
description: Domain name or IP address of the fourth FSSO collector agent.
type: str
server5:
description: Domain name or IP address of the fifth FSSO collector agent.
type: str
sni:
description: Server Name Indication.
type: str
source-ip:
description: Deprecated, please rename it to source_ip. Source IP for communications
to FSSO agent.
type: str
source-ip6:
description: Deprecated, please rename it to source_ip6. IPv6 source for communications
to FSSO agent.
type: str
ssl:
choices:
- disable
- enable
description: Enable/disable use of SSL.
type: str
ssl-server-host-ip-check:
choices:
- disable
- enable
description: Deprecated, please rename it to ssl_server_host_ip_check. Enable/disable
server host/IP verification.
type: str
ssl-trusted-cert:
description: Deprecated, please rename it to ssl_trusted_cert. Trusted server
certificate or CA certificate.
type: str
type:
choices:
- default
- fortiems
- fortinac
- fortiems-cloud
description: Server type.
type: str
user-info-server:
description: (list or str) Deprecated, please rename it to user_info_server.
LDAP server to get user information.
type: raw
type: list
group-poll-interval:
description: Deprecated, please rename it to group_poll_interval. Interval in
minutes within to fetch groups from FSSO server, or unset...
type: int
interface:
description: Specify outgoing interface to reach server.
type: str
interface-select-method:
choices:
- auto
- sdwan
- specify
description: Deprecated, please rename it to interface_select_method. Specify
how to select outgoing interface to reach server.
type: str
ldap-poll:
choices:
- disable
- enable
description: Deprecated, please rename it to ldap_poll. Enable/disable automatic
fetching of groups from LDAP server.
type: str
ldap-poll-filter:
description: Deprecated, please rename it to ldap_poll_filter. Filter used to
fetch groups.
type: str
ldap-poll-interval:
description: Deprecated, please rename it to ldap_poll_interval. Interval in minutes
within to fetch groups from LDAP server.
type: int
ldap-server:
description: Deprecated, please rename it to ldap_server. LDAP server to get group
information.
type: str
logon-timeout:
description: Deprecated, please rename it to logon_timeout. Interval in minutes
to keep logons after FSSO server down.
type: int
name:
description: Name.
required: true
type: str
password:
description: (list) Password of the first FSSO collector agent.
type: raw
password2:
description: (list) Password of the second FSSO collector agent.
type: raw
password3:
description: (list) Password of the third FSSO collector agent.
type: raw
password4:
description: (list) Password of the fourth FSSO collector agent.
type: raw
password5:
description: (list) Password of the fifth FSSO collector agent.
type: raw
port:
description: Port of the first FSSO collector agent.
type: int
port2:
description: Port of the second FSSO collector agent.
type: int
port3:
description: Port of the third FSSO collector agent.
type: int
port4:
description: Port of the fourth FSSO collector agent.
type: int
port5:
description: Port of the fifth FSSO collector agent.
type: int
server:
description: Domain name or IP address of the first FSSO collector agent.
type: str
server2:
description: Domain name or IP address of the second FSSO collector agent.
type: str
server3:
description: Domain name or IP address of the third FSSO collector agent.
type: str
server4:
description: Domain name or IP address of the fourth FSSO collector agent.
type: str
server5:
description: Domain name or IP address of the fifth FSSO collector agent.
type: str
sni:
description: Server Name Indication.
type: str
source-ip:
description: Deprecated, please rename it to source_ip. Source IP for communications
to FSSO agent.
type: str
source-ip6:
description: Deprecated, please rename it to source_ip6. IPv6 source for communications
to FSSO agent.
type: str
ssl:
choices:
- disable
- enable
description: Enable/disable use of SSL.
type: str
ssl-server-host-ip-check:
choices:
- disable
- enable
description: Deprecated, please rename it to ssl_server_host_ip_check. Enable/disable
server host/IP verification.
type: str
ssl-trusted-cert:
description: Deprecated, please rename it to ssl_trusted_cert. Trusted server
certificate or CA certificate.
type: str
type:
choices:
- default
- fortiems
- fortinac
- fortiems-cloud
description: Server type.
type: str
user-info-server:
description: Deprecated, please rename it to user_info_server. LDAP server to
get user information.
type: str
type: dict
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
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