New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
endpoint_control_settings
-
|
Default: null
|
Configure endpoint control settings.
|
|
download-custom-link
-
|
Customized URL for downloading FortiClient.
|
||
download-location
-
|
|
FortiClient download location (FortiGuard or custom).
|
|
forticlient-avdb-update-interval
-
|
Period of time between FortiClient AntiVirus database updates (0 - 24 hours, default = 8).
|
||
forticlient-dereg-unsupported-client
-
|
|
Enable/disable deregistering unsupported FortiClient endpoints.
|
|
forticlient-ems-rest-api-call-timeout
-
|
FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds, default = 5000).
|
||
forticlient-keepalive-interval
-
|
Interval between two KeepAlive messages from FortiClient (20 - 300 sec, default = 60).
|
||
forticlient-offline-grace
-
|
|
Enable/disable grace period for offline registered clients.
|
|
forticlient-offline-grace-interval
-
|
Grace period for offline registered FortiClient (60 - 600 sec, default = 120).
|
||
forticlient-reg-key
-
|
FortiClient registration key.
|
||
forticlient-reg-key-enforce
-
|
|
Enable/disable requiring or enforcing FortiClient registration keys.
|
|
forticlient-reg-timeout
-
|
FortiClient registration license timeout (days, min = 1, max = 180, 0 means unlimited).
|
||
forticlient-sys-update-interval
-
|
Interval between two system update messages from FortiClient (30 - 1440 min, default = 720).
|
||
forticlient-user-avatar
-
|
|
Enable/disable uploading FortiClient user avatars.
|
|
forticlient-warning-interval
-
|
Period of time between FortiClient portal warnings (0 - 24 hours, default = 1).
|
||
host
-
/ required
|
FortiOS or FortiGate ip address.
|
||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
|
password
-
|
Default: ""
|
FortiOS or FortiGate password.
|
|
username
-
/ required
|
FortiOS or FortiGate username.
|
||
vdom
-
|
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.
|
Note
- 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"
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
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.