fmgr_user_fssopolling – Configure FSSO active directory servers for polling mode.¶
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_fssopolling - Configure FSSO active directory servers for polling mode. type: dict
- _gui_meta - No description for the parameter type: str
- adgrp - No description for the parameter type: array
- name - Name. type: str
- default-domain - Default domain managed by this Active Directory server. type: str
- id - Active Directory server ID. type: int
- ldap-server - LDAP server name used in LDAP connection strings. type: str
- logon-history - Number of hours of logon history to keep, 0 means keep all history. type: int
- password - No description for the parameter type: str
- polling-frequency - Polling frequency (every 1 to 30 seconds). type: int
- port - Port to communicate with this Active Directory server. type: int
- server - Host name or IP address of the Active Directory server. type: str
- status - Enable/disable polling for the status of this Active Directory server. type: str choices: [disable, enable]
- user - User name required to log into this Active Directory server. 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 FSSO active directory servers for polling mode.
fmgr_user_fssopolling:
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_fssopolling:
_gui_meta: <value of string>
adgrp:
-
name: <value of string>
default-domain: <value of string>
id: <value of integer>
ldap-server: <value of string>
logon-history: <value of integer>
password: <value of string>
polling-frequency: <value of integer>
port: <value of integer>
server: <value of string>
status: <value in [disable, enable]>
user: <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