fortinet.fortios.fortios_endpoint_control_settings – Configure endpoint control settings in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

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.

To use it in a playbook, specify: fortinet.fortios.fortios_endpoint_control_settings.

New in version 2.10: of fortinet.fortios

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.0

Parameters

Parameter		Choices/Defaults	Comments
access_token string			Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean		Choices: no ← yes	Enable/Disable logging for task.
endpoint_control_settings dictionary			Configure endpoint control settings.
	download_custom_link string		Customized URL for downloading FortiClient.
	download_location string	Choices: fortiguard custom	FortiClient download location (FortiGuard or custom).
	forticlient_avdb_update_interval integer		Period of time between FortiClient AntiVirus database updates (0 - 24 hours).
	forticlient_dereg_unsupported_client string	Choices: enable disable	Enable/disable deregistering unsupported FortiClient endpoints.
	forticlient_disconnect_unsupported_client string	Choices: enable disable	Enable/disable disconnecting of unsupported FortiClient endpoints.
	forticlient_ems_rest_api_call_timeout integer		FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds).
	forticlient_keepalive_interval integer		Interval between two KeepAlive messages from FortiClient (20 - 300 sec).
	forticlient_offline_grace string	Choices: enable disable	Enable/disable grace period for offline registered clients.
	forticlient_offline_grace_interval integer		Grace period for offline registered FortiClient (60 - 600 sec).
	forticlient_reg_key string		FortiClient registration key.
	forticlient_reg_key_enforce string	Choices: enable disable	Enable/disable requiring or enforcing FortiClient registration keys.
	forticlient_reg_timeout integer		FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
	forticlient_sys_update_interval integer		Interval between two system update messages from FortiClient (30 - 1440 min).
	forticlient_user_avatar string	Choices: enable disable	Enable/disable uploading FortiClient user avatars.
	forticlient_warning_interval integer		Period of time between FortiClient portal warnings (0 - 24 hours).
vdom string		Default: "root"	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.

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: "5"
        forticlient_dereg_unsupported_client: "enable"
        forticlient_disconnect_unsupported_client: "enable"
        forticlient_ems_rest_api_call_timeout: "8"
        forticlient_keepalive_interval: "9"
        forticlient_offline_grace: "enable"
        forticlient_offline_grace_interval: "11"
        forticlient_reg_key: "<your_own_value>"
        forticlient_reg_key_enforce: "enable"
        forticlient_reg_timeout: "14"
        forticlient_sys_update_interval: "15"
        forticlient_user_avatar: "enable"
        forticlient_warning_interval: "17"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
build string	always	Build number of the fortigate image Sample: 1547
http_method string	always	Last method used to provision the content into FortiGate Sample: PUT
http_status string	always	Last result given by FortiGate on last operation applied Sample: 200
mkey string	success	Master key (id) used in the last call to FortiGate Sample: id
name string	always	Name of the table used to fulfill the request Sample: urlfilter
path string	always	Path of the table used to fulfill the request Sample: webfilter
revision string	always	Internal revision number Sample: 17.0.2.10658
serial string	always	Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string	always	Indication of the operation's result Sample: success
vdom string	always	Virtual domain used Sample: root
version string	always	Version of the FortiGate Sample: v5.6.3

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_endpoint_control_settings_module.html

Docs

Docs4dev

Title here