fortinet.fortios.fortios_endpoint_control_settings module – Configure endpoint control settings in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.0).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_endpoint_control_settings.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify endpoint_control feature and settings 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
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure endpoint control settings. |
|
Customized URL for downloading FortiClient. |
|
FortiClient download location (FortiGuard or custom). Choices:
|
|
Period of time between FortiClient AntiVirus database updates (0 - 24 hours). |
|
Enable/disable deregistering unsupported FortiClient endpoints. Choices:
|
|
Enable/disable disconnecting of unsupported FortiClient endpoints. Choices:
|
|
FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds). |
|
Interval between two KeepAlive messages from FortiClient (20 - 300 sec). |
|
Enable/disable grace period for offline registered clients. Choices:
|
|
Grace period for offline registered FortiClient (60 - 600 sec). |
|
FortiClient registration key. |
|
Enable/disable requiring or enforcing FortiClient registration keys. Choices:
|
|
FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited). |
|
Interval between two system update messages from FortiClient (30 - 1440 min). |
|
Enable/disable uploading FortiClient user avatars. Choices:
|
|
Period of time between FortiClient portal warnings (0 - 24 hours). |
|
Override global EMS table for this VDOM. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
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. Default: |
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: Configure endpoint control settings.
fortios_endpoint_control_settings:
vdom: "{{ vdom }}"
endpoint_control_settings:
download_custom_link: "<your_own_value>"
download_location: "fortiguard"
forticlient_avdb_update_interval: "12"
forticlient_dereg_unsupported_client: "enable"
forticlient_disconnect_unsupported_client: "enable"
forticlient_ems_rest_api_call_timeout: "15000"
forticlient_keepalive_interval: "150"
forticlient_offline_grace: "enable"
forticlient_offline_grace_interval: "300"
forticlient_reg_key: "<your_own_value>"
forticlient_reg_key_enforce: "enable"
forticlient_reg_timeout: "90"
forticlient_sys_update_interval: "720"
forticlient_user_avatar: "enable"
forticlient_warning_interval: "12"
override: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |