lix_fortinet.fortios.fortios_endpoint_control_settings (102.2.120) — module

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

| "added in version" 2.0.0 of lix_fortinet.fortios"

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

preview | supported by community

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120


Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"

Inputs

    
vdom:
    default: root
    description:
    - 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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - 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.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

endpoint_control_settings:
    default: null
    description:
    - Configure endpoint control settings.
    suboptions:
      download_custom_link:
        description:
        - Customized URL for downloading FortiClient.
        type: str
      download_location:
        choices:
        - fortiguard
        - custom
        description:
        - FortiClient download location (FortiGuard or custom).
        type: str
      forticlient_avdb_update_interval:
        description:
        - Period of time between FortiClient AntiVirus database updates (0 - 24 hours).
        type: int
      forticlient_dereg_unsupported_client:
        choices:
        - enable
        - disable
        description:
        - Enable/disable deregistering unsupported FortiClient endpoints.
        type: str
      forticlient_disconnect_unsupported_client:
        choices:
        - enable
        - disable
        description:
        - Enable/disable disconnecting of unsupported FortiClient endpoints.
        type: str
      forticlient_ems_rest_api_call_timeout:
        description:
        - FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds).
        type: int
      forticlient_keepalive_interval:
        description:
        - Interval between two KeepAlive messages from FortiClient (20 - 300 sec).
        type: int
      forticlient_offline_grace:
        choices:
        - enable
        - disable
        description:
        - Enable/disable grace period for offline registered clients.
        type: str
      forticlient_offline_grace_interval:
        description:
        - Grace period for offline registered FortiClient (60 - 600 sec).
        type: int
      forticlient_reg_key:
        description:
        - FortiClient registration key.
        type: str
      forticlient_reg_key_enforce:
        choices:
        - enable
        - disable
        description:
        - Enable/disable requiring or enforcing FortiClient registration keys.
        type: str
      forticlient_reg_timeout:
        description:
        - FortiClient registration license timeout (days, min = 1, max = 180, 0 means
          unlimited).
        type: int
      forticlient_sys_update_interval:
        description:
        - Interval between two system update messages from FortiClient (30 - 1440 min).
        type: int
      forticlient_user_avatar:
        choices:
        - enable
        - disable
        description:
        - Enable/disable uploading FortiClient user avatars.
        type: str
      forticlient_warning_interval:
        description:
        - Period of time between FortiClient portal warnings (0 - 24 hours).
        type: int
    type: dict

Outputs

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