fortios_endpoint_control_forticlient_ems – Configure FortiClient Enterprise Management Server (EMS) entries in Fortinet’s FortiOS and FortiGate
New in version 2.8.
Synopsis
- This module is able to configure a FortiGate or FortiOS by allowing the user to configure endpoint_control feature and forticlient_ems category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2
Requirements
The below requirements are needed on the host that executes this module.
- fortiosapi>=0.9.8
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| endpoint_control_forticlient_ems
-
|
Default:
null
|
Configure FortiClient Enterprise Management Server (EMS) entries.
|
|
| address
-
|
Firewall address name. Source firewall.address.name.
|
||
| admin-password
-
|
FortiClient EMS admin password.
|
||
| admin-type
-
|
|
FortiClient EMS admin type.
|
|
| admin-username
-
|
FortiClient EMS admin username.
|
||
| https-port
-
|
FortiClient EMS HTTPS access port number. (1 - 65535, default: 443).
|
||
| listen-port
-
|
FortiClient EMS telemetry listen port number. (1 - 65535, default: 8013).
|
||
| name
- / required
|
FortiClient Enterprise Management Server (EMS) name.
|
||
| rest-api-auth
-
|
|
FortiClient EMS REST API authentication.
|
|
| serial-number
-
|
FortiClient EMS Serial Number.
|
||
| state
-
|
|
Indicates whether to create or remove the object
|
|
| upload-port
-
|
FortiClient EMS telemetry upload port number. (1 - 65535, default: 8014).
|
||
| 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.
|
|
Notes
Note
- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook
Examples
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure FortiClient Enterprise Management Server (EMS) entries.
fortios_endpoint_control_forticlient_ems:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
endpoint_control_forticlient_ems:
state: "present"
address: "<your_own_value> (source firewall.address.name)"
admin-password: "<your_own_value>"
admin-type: "Windows"
admin-username: "<your_own_value>"
https-port: "7"
listen-port: "8"
name: "default_name_9"
rest-api-auth: "disable"
serial-number: "<your_own_value>"
upload-port: "12"
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
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/fortios_endpoint_control_forticlient_ems_module.html