fmgr_user_fsso – Configure Fortinet Single Sign On (FSSO) agents.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- user_fsso - Configure Fortinet Single Sign On (FSSO) agents. type: dict
- _gui_meta - No description for the parameter type: str
- dynamic_mapping - No description for the parameter type: array
- _gui_meta - No description for the parameter type: str
- _scope - No description for the parameter type: array
- name - No description for the parameter type: str
- vdom - No description for the parameter type: str
- ldap-server - No description for the parameter type: str
- password - No description for the parameter type: str
- password2 - No description for the parameter type: str
- password3 - No description for the parameter type: str
- password4 - No description for the parameter type: str
- password5 - No description for the parameter type: str
- port - No description for the parameter type: int
- port2 - No description for the parameter type: int
- port3 - No description for the parameter type: int
- port4 - No description for the parameter type: int
- port5 - No description for the parameter type: int
- server - No description for the parameter type: str
- server2 - No description for the parameter type: str
- server3 - No description for the parameter type: str
- server4 - No description for the parameter type: str
- server5 - No description for the parameter type: str
- source-ip - No description for the parameter type: str
- source-ip6 - No description for the parameter type: str
- ssl - No description for the parameter type: str choices: [disable, enable]
- ssl-trusted-cert - No description for the parameter type: str
- type - No description for the parameter type: str choices: [default, fortiems, fortinac]
- user-info-server - No description for the parameter type: str
- ldap-server - LDAP server to get group information. type: str
- name - Name. type: str
- password - No description for the parameter type: str
- password2 - No description for the parameter type: str
- password3 - No description for the parameter type: str
- password4 - No description for the parameter type: str
- password5 - No description for the parameter type: str
- port - Port of the first FSSO collector agent. type: int
- port2 - Port of the second FSSO collector agent. type: int
- port3 - Port of the third FSSO collector agent. type: int
- port4 - Port of the fourth FSSO collector agent. type: int
- port5 - Port of the fifth FSSO collector agent. type: int
- server - Domain name or IP address of the first FSSO collector agent. type: str
- server2 - Domain name or IP address of the second FSSO collector agent. type: str
- server3 - Domain name or IP address of the third FSSO collector agent. type: str
- server4 - Domain name or IP address of the fourth FSSO collector agent. type: str
- server5 - Domain name or IP address of the fifth FSSO collector agent. type: str
- source-ip - Source IP for communications to FSSO agent. type: str
- source-ip6 - IPv6 source for communications to FSSO agent. type: str
Notes¶
Note
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state: present directive.
- To delete an object, use state: absent directive
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
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.
fmgr_user_fsso:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
user_fsso:
_gui_meta: <value of string>
dynamic_mapping:
-
_gui_meta: <value of string>
_scope:
-
name: <value of string>
vdom: <value of string>
ldap-server: <value of string>
password: <value of string>
password2: <value of string>
password3: <value of string>
password4: <value of string>
password5: <value of string>
port: <value of integer>
port2: <value of integer>
port3: <value of integer>
port4: <value of integer>
port5: <value of integer>
server: <value of string>
server2: <value of string>
server3: <value of string>
server4: <value of string>
server5: <value of string>
source-ip: <value of string>
source-ip6: <value of string>
ssl: <value in [disable, enable]>
ssl-trusted-cert: <value of string>
type: <value in [default, fortiems, fortinac]>
user-info-server: <value of string>
ldap-server: <value of string>
name: <value of string>
password: <value of string>
password2: <value of string>
password3: <value of string>
password4: <value of string>
password5: <value of string>
port: <value of integer>
port2: <value of integer>
port3: <value of integer>
port4: <value of integer>
port5: <value of integer>
server: <value of string>
server2: <value of string>
server3: <value of string>
server4: <value of string>
server5: <value of string>
source-ip: <value of string>
source-ip6: <value of string>
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict