source: | fortios_endpoint_control_forticlient_ems.py |
---|---|
orphan: |
fortios_endpoint_control_forticlient_ems -- Configure FortiClient Enterprise Management Server (EMS) entries in Fortinet's FortiOS and FortiGate.
.. versionadded:: 2.0.0
- 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
The below requirements are needed on the host that executes this module.
- ansible>=2.14
Using member operation to add an element to an existing object.
Supported Version Ranges | |
fortios_endpoint_control_forticlient_ems | v6.0.0 -> v6.0.11 |
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: 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
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- endpoint_control_forticlient_ems - Configure FortiClient Enterprise Management Server (EMS) entries. type: dict
more...
Supported Version Ranges endpoint_control_forticlient_ems v6.0.0 -> v6.0.11
- address - Firewall address name. Source firewall.address.name. type: str
more...
Supported Version Ranges address v6.0.0 -> v6.0.11
- admin_password - FortiClient EMS admin password. type: str
more...
Supported Version Ranges admin_password v6.0.0 -> v6.0.11
- admin_type - FortiClient EMS admin type. type: str choices: Windows, LDAP
more...
Supported Version Ranges admin_type v6.0.0 -> v6.0.11
[Windows] v6.0.0 -> latest
[LDAP] v6.0.0 -> latest
- admin_username - FortiClient EMS admin username. type: str
more...
Supported Version Ranges admin_username v6.0.0 -> v6.0.11
- https_port - FortiClient EMS HTTPS access port number. (1 - 65535). type: int
more...
Supported Version Ranges https_port v6.0.0 -> v6.0.11
- listen_port - FortiClient EMS telemetry listen port number. (1 - 65535). type: int
more...
Supported Version Ranges listen_port v6.0.0 -> v6.0.11
- name - FortiClient Enterprise Management Server (EMS) name. type: str required: true
more...
Supported Version Ranges name v6.0.0 -> v6.0.11
- rest_api_auth - FortiClient EMS REST API authentication. type: str choices: disable, userpass
more...
Supported Version Ranges rest_api_auth v6.0.0 -> v6.0.11
[disable] v6.0.0 -> latest
[userpass] v6.0.0 -> latest
- serial_number - FortiClient EMS Serial Number. type: str
more...
Supported Version Ranges serial_number v6.0.0 -> v6.0.11
- upload_port - FortiClient EMS telemetry upload port number. (1 - 65535). type: int
more...
Supported Version Ranges upload_port v6.0.0 -> v6.0.11
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Configure FortiClient Enterprise Management Server (EMS) entries.
fortinet.fortios.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: "32767"
listen_port: "32767"
name: "default_name_9"
rest_api_auth: "disable"
serial_number: "<your_own_value>"
upload_port: "32767"
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
- This module is not guaranteed to have a backwards compatible interface.
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can create a pull request to improve it.