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 (FOS) device by allowing the user to set and modify endpoint_control feature and forticlient_ems 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¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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 default: root
- state - Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. type: str required: False choices: present, absent
- endpoint_control_forticlient_ems - Configure FortiClient Enterprise Management Server (EMS) entries. type: dict
- state - B(Deprecated) type: str required: False choices: present, absent
- address - Firewall address name. Source firewall.address.name. type: str
- admin_password - FortiClient EMS admin password. type: str
- admin_type - FortiClient EMS admin type. type: str choices: Windows, LDAP
- admin_username - FortiClient EMS admin username. type: str
- https_port - FortiClient EMS HTTPS access port number. (1 - 65535). type: int
- listen_port - FortiClient EMS telemetry listen port number. (1 - 65535). type: int
- name - FortiClient Enterprise Management Server (EMS) name. type: str required: True
- rest_api_auth - FortiClient EMS REST API authentication. type: str choices: disable, userpass
- serial_number - FortiClient EMS Serial Number. type: str
- upload_port - FortiClient EMS telemetry upload port number. (1 - 65535). type: int
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_forticlient_ems:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
endpoint_control_forticlient_ems:
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3