fortios_endpoint_control_settings – Configure endpoint control settings in Fortinet’s FortiOS and FortiGate.¶
New in version 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
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
|
fortios_endpoint_control_settings | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- endpoint_control_settings - Configure endpoint control settings. type: dict more...
- download_custom_link - Customized URL for downloading FortiClient. type: str more...
- download_location - FortiClient download location (FortiGuard or custom). type: str choices: fortiguard, custom more...
- forticlient_avdb_update_interval - Period of time between FortiClient AntiVirus database updates (0 - 24 hours). type: int more...
- forticlient_dereg_unsupported_client - Enable/disable deregistering unsupported FortiClient endpoints. type: str choices: enable, disable more...
- forticlient_disconnect_unsupported_client - Enable/disable disconnecting of unsupported FortiClient endpoints. type: str choices: enable, disable more...
- forticlient_ems_rest_api_call_timeout - FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds). type: int more...
- forticlient_keepalive_interval - Interval between two KeepAlive messages from FortiClient (20 - 300 sec). type: int more...
- forticlient_offline_grace - Enable/disable grace period for offline registered clients. type: str choices: enable, disable more...
- forticlient_offline_grace_interval - Grace period for offline registered FortiClient (60 - 600 sec). type: int more...
- forticlient_reg_key - FortiClient registration key. type: str more...
- forticlient_reg_key_enforce - Enable/disable requiring or enforcing FortiClient registration keys. type: str choices: enable, disable more...
- forticlient_reg_timeout - FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited). type: int more...
- forticlient_sys_update_interval - Interval between two system update messages from FortiClient (30 - 1440 min). type: int more...
- forticlient_user_avatar - Enable/disable uploading FortiClient user avatars. type: str choices: enable, disable more...
- forticlient_warning_interval - Period of time between FortiClient portal warnings (0 - 24 hours). type: int more...
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"
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3