source:	fortios_endpoint_control_fctems.py
orphan:

fortios_endpoint_control_fctems -- Configure FortiClient Enterprise Management Server (EMS) entries in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis
Requirements
Tips
FortiOS Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

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.15

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

Supported Version Ranges: v6.2.0 -> 7.4.3

Parameters

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_fctems - Configure FortiClient Enterprise Management Server (EMS) entries. type: dict more...

Supported Version Ranges

endpoint_control_fctems v6.2.0 -> 7.4.3

admin_password - FortiClient EMS admin password. type: str more...

Supported Version Ranges

admin_password v6.2.0 -> v6.2.7
admin_username - FortiClient EMS admin username. type: str more...

Supported Version Ranges

admin_username v6.2.0 -> v6.2.7
call_timeout - FortiClient EMS call timeout in seconds (1 - 180 seconds). type: int more...

Supported Version Ranges

call_timeout v6.2.0 -> 7.4.3

capabilities - List of EMS capabilities. type: list choices: fabric-auth, silent-approval, websocket, websocket-malware, push-ca-certs, common-tags-api, tenant-id, client-avatars, single-vdom-connector more...

	Supported Version Ranges
capabilities	`v7.0.0 -> 7.4.3`
[fabric-auth]	`v7.0.0 -> 7.4.3`
[silent-approval]	`v7.0.0 -> 7.4.3`
[websocket]	`v7.0.0 -> 7.4.3`
[websocket-malware]	`v7.0.1 -> 7.4.3`
[push-ca-certs]	`v7.0.1 -> 7.4.3`
[common-tags-api]	`v7.0.4 -> 7.4.3`
[tenant-id]	`v7.2.1 -> 7.4.3`
[client-avatars]	`v7.4.1 -> 7.4.3`
[single-vdom-connector]	`v7.4.0 -> 7.4.3`

certificate - FortiClient EMS certificate. Source certificate.remote.name. type: str more...

Supported Version Ranges

certificate v6.4.0 -> v6.4.4
cloud_server_type - Cloud server type. type: str choices: production, alpha, beta more...

Supported Version Ranges

cloud_server_type v6.4.0 -> v7.4.0

[production] v6.4.0 -> v7.4.0
[alpha] v6.4.0 -> v7.4.0
[beta] v6.4.0 -> v7.4.0
dirty_reason - Dirty Reason for FortiClient EMS. type: str choices: none, mismatched-ems-sn more...

Supported Version Ranges

dirty_reason v7.0.8 -> v7.0.12 v7.2.1 -> 7.4.3

[none] v7.0.8 -> v7.0.12
[mismatched-ems-sn] v7.0.8 -> v7.0.12
ems_id - EMS ID in order (1 - 7). see Notes. type: int required: true more...

Supported Version Ranges

ems_id v7.0.8 -> v7.0.12 v7.2.1 -> 7.4.3
fortinetone_cloud_authentication - Enable/disable authentication of FortiClient EMS Cloud through FortiCloud account. type: str choices: enable, disable more...

Supported Version Ranges

fortinetone_cloud_authentication v6.2.0 -> 7.4.3

[enable] v6.2.0 -> 7.4.3
[disable] v6.2.0 -> 7.4.3
https_port - FortiClient EMS HTTPS access port number. (1 - 65535). type: int more...

Supported Version Ranges

https_port v6.2.0 -> 7.4.3
interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...

Supported Version Ranges

interface v7.0.6 -> v7.0.12 v7.2.1 -> 7.4.3
interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...

Supported Version Ranges

interface_select_method v7.0.6 -> v7.0.12 v7.2.1 -> 7.4.3

[auto] v7.0.6 -> v7.0.12
[sdwan] v7.0.6 -> v7.0.12
[specify] v7.0.6 -> v7.0.12
name - FortiClient Enterprise Management Server (EMS) name. type: str more...

Supported Version Ranges

name v6.2.0 -> 7.4.3
out_of_sync_threshold - Outdated resource threshold in seconds (10 - 3600). type: int more...

Supported Version Ranges

out_of_sync_threshold v7.0.8 -> 7.4.3
preserve_ssl_session - Enable/disable preservation of EMS SSL session connection. Warning, most users should not touch this setting. type: str choices: enable, disable more...

Supported Version Ranges

preserve_ssl_session v7.0.1 -> 7.4.3

[enable] v7.0.1 -> 7.4.3
[disable] v7.0.1 -> 7.4.3
pull_avatars - Enable/disable pulling avatars from EMS. type: str choices: enable, disable more...

Supported Version Ranges

pull_avatars v6.4.0 -> 7.4.3

[enable] v6.4.0 -> 7.4.3
[disable] v6.4.0 -> 7.4.3
pull_malware_hash - Enable/disable pulling FortiClient malware hash from EMS. type: str choices: enable, disable more...

Supported Version Ranges

pull_malware_hash v7.0.0 -> 7.4.3

[enable] v7.0.0 -> 7.4.3
[disable] v7.0.0 -> 7.4.3
pull_sysinfo - Enable/disable pulling SysInfo from EMS. type: str choices: enable, disable more...

Supported Version Ranges

pull_sysinfo v6.4.0 -> 7.4.3

[enable] v6.4.0 -> 7.4.3
[disable] v6.4.0 -> 7.4.3
pull_tags - Enable/disable pulling FortiClient user tags from EMS. type: str choices: enable, disable more...

Supported Version Ranges

pull_tags v6.4.0 -> 7.4.3

[enable] v6.4.0 -> 7.4.3
[disable] v6.4.0 -> 7.4.3
pull_vulnerabilities - Enable/disable pulling vulnerabilities from EMS. type: str choices: enable, disable more...

Supported Version Ranges

pull_vulnerabilities v6.4.0 -> 7.4.3

[enable] v6.4.0 -> 7.4.3
[disable] v6.4.0 -> 7.4.3
send_tags_to_all_vdoms - Relax restrictions on tags to send all EMS tags to all VDOMs type: str choices: enable, disable more...

Supported Version Ranges

send_tags_to_all_vdoms v7.4.2 -> 7.4.3

[enable] v7.4.2 -> 7.4.3
[disable] v7.4.2 -> 7.4.3
serial_number - EMS Serial Number. type: str more...

Supported Version Ranges

serial_number v6.2.0 -> v6.2.7 v7.0.8 -> v7.0.12 v7.2.1 -> 7.4.3
server - FortiClient EMS FQDN or IPv4 address. type: str more...

Supported Version Ranges

server v6.2.0 -> 7.4.3
source_ip - REST API call source IP. type: str more...

Supported Version Ranges

source_ip v6.2.0 -> 7.4.3
status - Enable or disable this EMS configuration. type: str choices: enable, disable more...

Supported Version Ranges

status v7.0.8 -> v7.0.12 v7.2.1 -> 7.4.3

[enable] v7.0.8 -> v7.0.12
[disable] v7.0.8 -> v7.0.12
status_check_interval - FortiClient EMS call timeout in seconds (1 - 120 seconds). type: int more...

Supported Version Ranges

status_check_interval v6.4.4 -> v6.4.4
tenant_id - EMS Tenant ID. type: str more...

Supported Version Ranges

tenant_id v7.2.1 -> 7.4.3
trust_ca_cn - Enable/disable trust of the EMS certificate issuer(CA) and common name(CN) for certificate auto-renewal. type: str choices: enable, disable more...

Supported Version Ranges

trust_ca_cn v7.0.12 -> v7.0.12 v7.2.4 -> 7.4.3

[enable] v7.0.12 -> v7.0.12
[disable] v7.0.12 -> v7.0.12
verifying_ca - Lowest CA cert on Fortigate in verified EMS cert chain. Source certificate.ca.name vpn.certificate.ca.name. type: str more...

Supported Version Ranges

verifying_ca v7.4.2 -> 7.4.3
websocket_override - Enable/disable override behavior for how this FortiGate unit connects to EMS using a WebSocket connection. type: str choices: enable, disable more...

Supported Version Ranges

websocket_override v7.0.0 -> 7.4.3

[enable] v7.0.0 -> 7.4.3
[disable] v7.0.0 -> 7.4.3

Notes

Note

We highly recommend using your own value as the ems_id instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure FortiClient Enterprise Management Server (EMS) entries.
  fortinet.fortios.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: "30"
          capabilities: "fabric-auth"
          certificate: "<your_own_value> (source certificate.remote.name)"
          cloud_server_type: "production"
          dirty_reason: "none"
          ems_id: "<you_own_value>"
          fortinetone_cloud_authentication: "enable"
          https_port: "443"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          name: "default_name_15"
          out_of_sync_threshold: "180"
          preserve_ssl_session: "enable"
          pull_avatars: "enable"
          pull_malware_hash: "enable"
          pull_sysinfo: "enable"
          pull_tags: "enable"
          pull_vulnerabilities: "enable"
          send_tags_to_all_vdoms: "enable"
          serial_number: "<your_own_value>"
          server: "192.168.100.40"
          source_ip: "84.230.14.43"
          status: "enable"
          status_check_interval: "90"
          tenant_id: "<your_own_value>"
          trust_ca_cn: "enable"
          verifying_ca: "<your_own_value> (source certificate.ca.name vpn.certificate.ca.name)"
          websocket_override: "enable"

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

Status

This module is not guaranteed to have a backwards compatible interface.

Authors

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.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fortios_endpoint_control_fctems.rst

fortios_endpoint_control_fctems.rst

fortios_endpoint_control_fctems -- Configure FortiClient Enterprise Management Server (EMS) entries in Fortinet's FortiOS and FortiGate.

Synopsis

Requirements

Tips

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors

	Supported Version Ranges
endpoint_control_fctems	`v6.2.0 -> 7.4.3`

	Supported Version Ranges
cloud_server_type	`v6.4.0 -> v7.4.0`
[production]	`v6.4.0 -> v7.4.0`
[alpha]	`v6.4.0 -> v7.4.0`
[beta]	`v6.4.0 -> v7.4.0`

	Supported Version Ranges
dirty_reason	`v7.0.8 -> v7.0.12`	`v7.2.1 -> 7.4.3`
[none]	`v7.0.8 -> v7.0.12`
[mismatched-ems-sn]	`v7.0.8 -> v7.0.12`

	Supported Version Ranges
ems_id	`v7.0.8 -> v7.0.12`	`v7.2.1 -> 7.4.3`

	Supported Version Ranges
fortinetone_cloud_authentication	`v6.2.0 -> 7.4.3`
[enable]	`v6.2.0 -> 7.4.3`
[disable]	`v6.2.0 -> 7.4.3`

	Supported Version Ranges
interface	`v7.0.6 -> v7.0.12`	`v7.2.1 -> 7.4.3`

	Supported Version Ranges
interface_select_method	`v7.0.6 -> v7.0.12`	`v7.2.1 -> 7.4.3`
[auto]	`v7.0.6 -> v7.0.12`
[sdwan]	`v7.0.6 -> v7.0.12`
[specify]	`v7.0.6 -> v7.0.12`

	Supported Version Ranges
out_of_sync_threshold	`v7.0.8 -> 7.4.3`

	Supported Version Ranges
preserve_ssl_session	`v7.0.1 -> 7.4.3`
[enable]	`v7.0.1 -> 7.4.3`
[disable]	`v7.0.1 -> 7.4.3`

	Supported Version Ranges
pull_avatars	`v6.4.0 -> 7.4.3`
[enable]	`v6.4.0 -> 7.4.3`
[disable]	`v6.4.0 -> 7.4.3`

	Supported Version Ranges
status_check_interval	`v6.4.4 -> v6.4.4`

	Supported Version Ranges
pull_malware_hash	`v7.0.0 -> 7.4.3`
[enable]	`v7.0.0 -> 7.4.3`
[disable]	`v7.0.0 -> 7.4.3`

	Supported Version Ranges
pull_sysinfo	`v6.4.0 -> 7.4.3`
[enable]	`v6.4.0 -> 7.4.3`
[disable]	`v6.4.0 -> 7.4.3`

	Supported Version Ranges
pull_tags	`v6.4.0 -> 7.4.3`
[enable]	`v6.4.0 -> 7.4.3`
[disable]	`v6.4.0 -> 7.4.3`

	Supported Version Ranges
pull_vulnerabilities	`v6.4.0 -> 7.4.3`
[enable]	`v6.4.0 -> 7.4.3`
[disable]	`v6.4.0 -> 7.4.3`

	Supported Version Ranges
send_tags_to_all_vdoms	`v7.4.2 -> 7.4.3`
[enable]	`v7.4.2 -> 7.4.3`
[disable]	`v7.4.2 -> 7.4.3`

	Supported Version Ranges
serial_number	`v6.2.0 -> v6.2.7`	`v7.0.8 -> v7.0.12`	`v7.2.1 -> 7.4.3`

	Supported Version Ranges
trust_ca_cn	`v7.0.12 -> v7.0.12`	`v7.2.4 -> 7.4.3`
[enable]	`v7.0.12 -> v7.0.12`
[disable]	`v7.0.12 -> v7.0.12`

	Supported Version Ranges
websocket_override	`v7.0.0 -> 7.4.3`
[enable]	`v7.0.0 -> 7.4.3`
[disable]	`v7.0.0 -> 7.4.3`

Files

fortios_endpoint_control_fctems.rst

Latest commit

History

fortios_endpoint_control_fctems.rst

File metadata and controls

fortios_endpoint_control_fctems -- Configure FortiClient Enterprise Management Server (EMS) entries in Fortinet's FortiOS and FortiGate.