fortios_endpoint_control_fctems.rst

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
• 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.9

FortiOS Version Compatibility

v6.2.0

v6.2.3

v6.2.5

v6.2.7

v6.4.0

v6.4.1

v6.4.4

v7.0.0

v7.0.1

v7.0.2

v7.0.3

v7.0.4

v7.0.5

v7.0.6

v7.0.7

v7.0.8

v7.2.0

v7.2.1

v7.2.2

fortios_endpoint_control_fctems

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

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

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  endpoint_control_fctems

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

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

  	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  admin_password	yes	yes	yes	yes

• admin_username - FortiClient EMS admin username. type: str more...

  	v6.2.0	v6.2.3	v6.2.5	v6.2.7
  admin_username	yes	yes	yes	yes

• call_timeout - FortiClient EMS call timeout in seconds (1 - 180 seconds). type: int more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  call_timeout

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

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

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  capabilities

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [fabric-auth]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [silent-approval]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [websocket]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [websocket-malware]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [push-ca-certs]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [common-tags-api]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [tenant-id]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

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

  	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1	v6.4.4
  certificate	no	no	no	no	yes	yes	yes

• cloud_server_type - Cloud server type. type: str choices: production, alpha, beta more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  cloud_server_type

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [production]

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [alpha]

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [beta]

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• dirty_reason - Dirty Reason for FortiClient EMS. type: str choices: none, mismatched-ems-sn more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  dirty_reason

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  no

  yes

  yes

  [none]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  n/a

  yes

  yes

  [mismatched-ems-sn]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  n/a

  yes

  yes

• ems_id - EMS ID in order (1 - 5) type: int more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  ems_id

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  no

  yes

  yes

• fortinetone_cloud_authentication - Enable/disable authentication of FortiClient EMS Cloud through FortiCloud account. type: str choices: enable, disable more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  fortinetone_cloud_authentication

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• https_port - FortiClient EMS HTTPS access port number. (1 - 65535). type: int more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  https_port

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  interface

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  no

  yes

  yes

• interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  interface_select_method

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  no

  yes

  yes

  [auto]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  n/a

  yes

  yes

  [sdwan]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  n/a

  yes

  yes

  [specify]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  n/a

  yes

  yes

• name - FortiClient Enterprise Management Server (EMS) name. type: str more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  name

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• out_of_sync_threshold - Outdated resource threshold in seconds (10 - 3600). type: int more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  out_of_sync_threshold

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

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

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  preserve_ssl_session

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• pull_avatars - Enable/disable pulling avatars from EMS. type: str choices: enable, disable more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  pull_avatars

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• pull_malware_hash - Enable/disable pulling FortiClient malware hash from EMS. type: str choices: enable, disable more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  pull_malware_hash

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• pull_sysinfo - Enable/disable pulling SysInfo from EMS. type: str choices: enable, disable more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  pull_sysinfo

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• pull_tags - Enable/disable pulling FortiClient user tags from EMS. type: str choices: enable, disable more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  pull_tags

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• pull_vulnerabilities - Enable/disable pulling vulnerabilities from EMS. type: str choices: enable, disable more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  pull_vulnerabilities

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• serial_number - EMS Serial Number. type: str more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  serial_number

  yes

  yes

  yes

  yes

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  no

  yes

  yes

• server - FortiClient EMS FQDN or IPv4 address. type: str more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  server

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• source_ip - REST API call source IP. type: str more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  source_ip

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• status - Enable or disable this EMS configuration. type: str choices: enable, disable more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  status

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  no

  yes

  yes

  [enable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  n/a

  yes

  yes

  [disable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  n/a

  yes

  yes

• status_check_interval - FortiClient EMS call timeout in seconds (1 - 120 seconds). type: int more...

  	v6.2.0	v6.2.3	v6.2.5	v6.2.7	v6.4.0	v6.4.1	v6.4.4
  status_check_interval	no	no	no	no	no	no	yes

• tenant_id - EMS Tenant ID. type: str more...

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  tenant_id

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

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

  v6.2.0

  v6.2.3

  v6.2.5

  v6.2.7

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.2.0

  v7.2.1

  v7.2.2

  websocket_override

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  n/a

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

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: "30"
        capabilities: "fabric-auth"
        certificate: "<your_own_value> (source certificate.remote.name)"
        cloud_server_type: "production"
        dirty_reason: "none"
        ems_id: "0"
        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"
        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>"
        websocket_override: "disable"

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.