fortinet.fortios.fortios_endpoint_control_fctems – Configure FortiClient Enterprise Management Server (EMS) entries in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
To use it in a playbook, specify: fortinet.fortios.fortios_endpoint_control_fctems.
New in version 2.10: of fortinet.fortios
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 fctems 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.0
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
||
| enable_log
boolean
|
|
Enable/Disable logging for task.
|
|
| endpoint_control_fctems
dictionary
|
Configure FortiClient Enterprise Management Server (EMS) entries.
|
||
| admin_password
string
|
FortiClient EMS admin password.
|
||
| admin_username
string
|
FortiClient EMS admin username.
|
||
| call_timeout
integer
|
FortiClient EMS call timeout in milliseconds (500 - 30000 milliseconds).
|
||
| capabilities
list / elements=string
|
|
List of EMS capabilities.
|
|
| certificate
string
|
FortiClient EMS certificate. Source certificate.remote.name.
|
||
| cloud_server_type
string
|
|
Cloud server type.
|
|
| fortinetone_cloud_authentication
string
|
|
Enable/disable authentication of FortiClient EMS Cloud through FortiCloud account.
|
|
| https_port
integer
|
FortiClient EMS HTTPS access port number. (1 - 65535).
|
||
| name
string / required
|
FortiClient Enterprise Management Server (EMS) name.
|
||
| pull_avatars
string
|
|
Enable/disable pulling avatars from EMS.
|
|
| pull_malware_hash
string
|
|
Enable/disable pulling FortiClient malware hash from EMS.
|
|
| pull_sysinfo
string
|
|
Enable/disable pulling SysInfo from EMS.
|
|
| pull_tags
string
|
|
Enable/disable pulling FortiClient user tags from EMS.
|
|
| pull_vulnerabilities
string
|
|
Enable/disable pulling vulnerabilities from EMS.
|
|
| serial_number
string
|
FortiClient EMS Serial Number.
|
||
| server
string
|
FortiClient EMS FQDN or IPv4 address.
|
||
| source_ip
string
|
REST API call source IP.
|
||
| status_check_interval
integer
|
FortiClient EMS call timeout in seconds (1 - 120 seconds).
|
||
| websocket_override
string
|
|
Enable/disable override behavior for how this FortiGate unit connects to EMS using a WebSocket connection.
|
|
| state
string / required
|
|
Indicates whether to create or remove the object.
|
|
| vdom
string
|
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.
|
|
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 FortiClient Enterprise Management Server (EMS) entries.
fortios_endpoint_control_fctems:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
endpoint_control_fctems:
admin_password: "<your_own_value>"
admin_username: "<your_own_value>"
call_timeout: "5"
capabilities: "fabric-auth"
certificate: "<your_own_value> (source certificate.remote.name)"
cloud_server_type: "production"
fortinetone_cloud_authentication: "enable"
https_port: "10"
name: "default_name_11"
pull_avatars: "enable"
pull_malware_hash: "enable"
pull_sysinfo: "enable"
pull_tags: "enable"
pull_vulnerabilities: "enable"
serial_number: "<your_own_value>"
server: "192.168.100.40"
source_ip: "84.230.14.43"
status_check_interval: "20"
websocket_override: "enable"
Return Values
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
|
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_endpoint_control_fctems_module.html