fortinet.fortimanager.fmgr_endpointcontrol_fctems module – Configure FortiClient Enterprise Management Server

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_endpointcontrol_fctems.

New in fortinet.fortimanager 2.1.0

Synopsis 

This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters 

Parameter	Comments
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: `false` ← (default) `true`
enable_log boolean	Enable/Disable logging for task. Choices: `false` ← (default) `true`
endpointcontrol_fctems dictionary	The top level parameters set.
admin-password any	(list) Deprecated, please rename it to admin_password. FortiClient EMS admin password.
admin-username string	Deprecated, please rename it to admin_username. FortiClient EMS admin username.
ca-cn-info string	Deprecated, please rename it to ca_cn_info. Ca cn info.
call-timeout integer	Deprecated, please rename it to call_timeout. FortiClient EMS call timeout in seconds
capabilities list / elements=string	List of EMS capabilities. Choices: `"fabric-auth"` `"silent-approval"` `"websocket"` `"websocket-malware"` `"push-ca-certs"` `"common-tags-api"` `"tenant-id"` `"single-vdom-connector"` `"client-avatars"` `"fgt-sysinfo-api"` `"ztna-server-info"`
certificate string	FortiClient EMS certificate.
certificate-fingerprint string	Deprecated, please rename it to certificate_fingerprint. EMS certificate fingerprint.
cloud-authentication-access-key string	Deprecated, please rename it to cloud_authentication_access_key. FortiClient EMS Cloud multitenancy access key
cloud-server-type string	Deprecated, please rename it to cloud_server_type. Cloud server type. Choices: `"production"` `"alpha"` `"beta"`
dirty-reason string	Deprecated, please rename it to dirty_reason. Dirty Reason for FortiClient EMS. Choices: `"none"` `"mismatched-ems-sn"`
ems-id integer	Deprecated, please rename it to ems_id. EMS ID in order
fortinetone-cloud-authentication string	Deprecated, please rename it to fortinetone_cloud_authentication. Enable/disable authentication of FortiClient EMS Cloud t… Choices: `"disable"` `"enable"`
https-port integer	Deprecated, please rename it to https_port. FortiClient EMS HTTPS access port number.
interface string	Specify outgoing interface to reach server.
interface-select-method string	Deprecated, please rename it to interface_select_method. Specify how to select outgoing interface to reach server. Choices: `"auto"` `"sdwan"` `"specify"`
name string / required	FortiClient Enterprise Management Server
out-of-sync-threshold integer	Deprecated, please rename it to out_of_sync_threshold. Outdated resource threshold in seconds
preserve-ssl-session string	Deprecated, please rename it to preserve_ssl_session. Enable/disable preservation of EMS SSL session connection. Choices: `"disable"` `"enable"`
pull-avatars string	Deprecated, please rename it to pull_avatars. Enable/disable pulling avatars from EMS. Choices: `"disable"` `"enable"`
pull-malware-hash string	Deprecated, please rename it to pull_malware_hash. Enable/disable pulling FortiClient malware hash from EMS. Choices: `"disable"` `"enable"`
pull-sysinfo string	Deprecated, please rename it to pull_sysinfo. Enable/disable pulling SysInfo from EMS. Choices: `"disable"` `"enable"`
pull-tags string	Deprecated, please rename it to pull_tags. Enable/disable pulling FortiClient user tags from EMS. Choices: `"disable"` `"enable"`
pull-vulnerabilities string	Deprecated, please rename it to pull_vulnerabilities. Enable/disable pulling vulnerabilities from EMS. Choices: `"disable"` `"enable"`
send-tags-to-all-vdoms string	Deprecated, please rename it to send_tags_to_all_vdoms. Relax restrictions on tags to send all EMS tags to all VDOMs Choices: `"disable"` `"enable"`
serial-number string	Deprecated, please rename it to serial_number. FortiClient EMS Serial Number.
server string	FortiClient EMS FQDN or IPv4 address.
source-ip string	Deprecated, please rename it to source_ip. REST API call source IP.
status string	Enable or disable this EMS configuration. Choices: `"disable"` `"enable"`
status-check-interval integer	Deprecated, please rename it to status_check_interval. FortiClient EMS call timeout in seconds
tenant-id string	Deprecated, please rename it to tenant_id. EMS Tenant ID.
trust-ca-cn string	Deprecated, please rename it to trust_ca_cn. Trust ca cn. Choices: `"disable"` `"enable"`
verified-cn string	Deprecated, please rename it to verified_cn. EMS certificate CN.
verifying-ca string	Deprecated, please rename it to verifying_ca. Lowest CA cert on Fortigate in verified EMS cert chain.
websocket-override string	Deprecated, please rename it to websocket_override. Enable/disable override behavior for how this FortiGate unit connects … Choices: `"disable"` `"enable"`
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: `"present"` `"absent"`
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: `300`

Notes 

Note

Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples 

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure FortiClient Enterprise Management Server
      fortinet.fortimanager.fmgr_endpointcontrol_fctems:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        endpointcontrol_fctems:
          call_timeout: <integer>
          capabilities:
            - fabric-auth
            - silent-approval
            - websocket
            - websocket-malware
            - push-ca-certs
            - common-tags-api
            - tenant-id
            - single-vdom-connector
            - client-avatars
            - fgt-sysinfo-api
            - ztna-server-info
          certificate_fingerprint: <string>
          cloud_server_type: <value in [production, alpha, beta]>
          fortinetone_cloud_authentication: <value in [disable, enable]>
          https_port: <integer>
          name: <string>
          out_of_sync_threshold: <integer>
          preserve_ssl_session: <value in [disable, enable]>
          pull_avatars: <value in [disable, enable]>
          pull_malware_hash: <value in [disable, enable]>
          pull_sysinfo: <value in [disable, enable]>
          pull_tags: <value in [disable, enable]>
          pull_vulnerabilities: <value in [disable, enable]>
          server: <string>
          source_ip: <string>
          websocket_override: <value in [disable, enable]>
          status_check_interval: <integer>
          certificate: <string>
          admin_username: <string>
          serial_number: <string>
          admin_password: <list or string>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>
          dirty_reason: <value in [none, mismatched-ems-sn]>
          ems_id: <integer>
          status: <value in [disable, enable]>
          ca_cn_info: <string>
          trust_ca_cn: <value in [disable, enable]>
          tenant_id: <string>
          send_tags_to_all_vdoms: <value in [disable, enable]>
          verified_cn: <string>
          verifying_ca: <string>
          cloud_authentication_access_key: <string>

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: `"/sys/login/user"`
response_code integer	The status of api request. Returned: always Sample: `0`
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: `"OK."`
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: `0`
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

fortinet.fortimanager.fmgr_endpointcontrol_fctems module – Configure FortiClient Enterprise Management Server

Synopsis

Parameters

Notes

Examples

Return Values