Skip to content

Latest commit

 

History

History
657 lines (612 loc) · 24.2 KB

fortios_endpoint_control_settings.rst

File metadata and controls

657 lines (612 loc) · 24.2 KB
Raw
source:fortios_endpoint_control_settings.py
orphan:

fortios_endpoint_control_settings -- Configure endpoint control settings in Fortinet's FortiOS and FortiGate.

.. versionadded:: 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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v7.4.0
fortios_endpoint_control_settings yes 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...
    v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v7.4.0
    endpoint_control_settings yes yes yes yes yes yes yes yes
    • download_custom_link - Customized URL for downloading FortiClient. type: str more...
      v6.0.0 v6.0.5 v6.0.11
      download_custom_link yes yes yes
    • download_location - FortiClient download location (FortiGuard or custom). type: str choices: fortiguard, custom more...
      v6.0.0 v6.0.5 v6.0.11
      download_location yes yes yes
      [fortiguard] yes yes yes
      [custom] yes yes yes
    • forticlient_avdb_update_interval - Period of time between FortiClient AntiVirus database updates (0 - 24 hours). type: int more...
      v6.0.0 v6.0.5 v6.0.11
      forticlient_avdb_update_interval yes yes yes
    • forticlient_dereg_unsupported_client - Enable/disable deregistering unsupported FortiClient endpoints. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11
      forticlient_dereg_unsupported_client yes yes yes
      [enable] yes yes yes
      [disable] yes yes yes
    • forticlient_disconnect_unsupported_client - Enable/disable disconnecting of unsupported FortiClient endpoints. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      forticlient_disconnect_unsupported_client no no no yes yes yes yes
      [enable] n/a n/a n/a yes yes yes yes
      [disable] n/a n/a n/a yes yes yes yes
    • forticlient_ems_rest_api_call_timeout - FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds). type: int more...
      v6.0.0 v6.0.5 v6.0.11
      forticlient_ems_rest_api_call_timeout yes yes yes
    • forticlient_keepalive_interval - Interval between two KeepAlive messages from FortiClient (20 - 300 sec). type: int more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      forticlient_keepalive_interval yes yes yes yes yes yes yes
    • forticlient_offline_grace - Enable/disable grace period for offline registered clients. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11
      forticlient_offline_grace yes yes yes
      [enable] yes yes yes
      [disable] yes yes yes
    • forticlient_offline_grace_interval - Grace period for offline registered FortiClient (60 - 600 sec). type: int more...
      v6.0.0 v6.0.5 v6.0.11
      forticlient_offline_grace_interval yes yes yes
    • forticlient_reg_key - FortiClient registration key. type: str more...
      v6.0.0 v6.0.5 v6.0.11
      forticlient_reg_key yes yes yes
    • forticlient_reg_key_enforce - Enable/disable requiring or enforcing FortiClient registration keys. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11
      forticlient_reg_key_enforce yes yes yes
      [enable] yes yes yes
      [disable] yes yes yes
    • forticlient_reg_timeout - FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited). type: int more...
      v6.0.0 v6.0.5 v6.0.11
      forticlient_reg_timeout yes yes yes
    • forticlient_sys_update_interval - Interval between two system update messages from FortiClient (30 - 1440 min). type: int more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      forticlient_sys_update_interval yes yes yes yes yes yes yes
    • forticlient_user_avatar - Enable/disable uploading FortiClient user avatars. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7
      forticlient_user_avatar yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes
    • forticlient_warning_interval - Period of time between FortiClient portal warnings (0 - 24 hours). type: int more...
      v6.0.0 v6.0.5 v6.0.11
      forticlient_warning_interval yes yes yes
    • override - Override global EMS table for this VDOM. type: str choices: enable, disable more...
      v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v7.4.0
      override no no no no no no no yes
      [enable] n/a n/a n/a n/a n/a n/a n/a yes
      [disable] n/a n/a n/a n/a n/a n/a n/a yes

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: 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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.