ansible.builtin.fortios_endpoint_control_settings (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS by allowing the user to configure endpoint_control feature and settings category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure endpoint control settings.
    fortios_endpoint_control_settings:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      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-ems-rest-api-call-timeout: "7"
        forticlient-keepalive-interval: "8"
        forticlient-offline-grace: "enable"
        forticlient-offline-grace-interval: "10"
        forticlient-reg-key: "<your_own_value>"
        forticlient-reg-key-enforce: "enable"
        forticlient-reg-timeout: "13"
        forticlient-sys-update-interval: "14"
        forticlient-user-avatar: "enable"
        forticlient-warning-interval: "16"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

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.

https:
    default: false
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

endpoint_control_settings:
    default: null
    description:
    - Configure endpoint control settings.
    suboptions:
      download-custom-link:
        description:
        - Customized URL for downloading FortiClient.
      download-location:
        choices:
        - fortiguard
        - custom
        description:
        - FortiClient download location (FortiGuard or custom).
      forticlient-avdb-update-interval:
        description:
        - Period of time between FortiClient AntiVirus database updates (0 - 24 hours,
          default = 8).
      forticlient-dereg-unsupported-client:
        choices:
        - enable
        - disable
        description:
        - Enable/disable deregistering unsupported FortiClient endpoints.
      forticlient-ems-rest-api-call-timeout:
        description:
        - FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default
          = 5000).
      forticlient-keepalive-interval:
        description:
        - Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default
          = 60).
      forticlient-offline-grace:
        choices:
        - enable
        - disable
        description:
        - Enable/disable grace period for offline registered clients.
      forticlient-offline-grace-interval:
        description:
        - Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
      forticlient-reg-key:
        description:
        - FortiClient registration key.
      forticlient-reg-key-enforce:
        choices:
        - enable
        - disable
        description:
        - Enable/disable requiring or enforcing FortiClient registration keys.
      forticlient-reg-timeout:
        description:
        - FortiClient registration license timeout (days, min = 1, max = 180, 0 means
          unlimited).
      forticlient-sys-update-interval:
        description:
        - Interval between two system update messages from FortiClient (30 - 1440 min,
          default = 720).
      forticlient-user-avatar:
        choices:
        - enable
        - disable
        description:
        - Enable/disable uploading FortiClient user avatars.
      forticlient-warning-interval:
        description:
        - Period of time between FortiClient portal warnings (0 - 24 hours, default =
          1).

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