fortinet.fortimanager.fmgr_endpointcontrol_fctems module – Configure FortiClient Enterprise Management Server
Note
This module is part of the fortinet.fortimanager collection (version 2.8.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 |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
(list) FortiClient EMS admin password. |
|
FortiClient EMS admin username. |
|
Ca cn info. |
|
FortiClient EMS call timeout in seconds |
|
List of EMS capabilities. Choices:
|
|
FortiClient EMS certificate. |
|
EMS certificate fingerprint. |
|
FortiClient EMS Cloud multitenancy access key |
|
Cloud server type. Choices:
|
|
Dirty Reason for FortiClient EMS. Choices:
|
|
EMS ID in order |
|
Enable/disable authentication of FortiClient EMS Cloud through FortiCloud account. Choices:
|
|
FortiClient EMS HTTPS access port number. |
|
Specify outgoing interface to reach server. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
FortiClient Enterprise Management Server |
|
Outdated resource threshold in seconds |
|
Enable/disable preservation of EMS SSL session connection. Choices:
|
|
Enable/disable pulling avatars from EMS. Choices:
|
|
Enable/disable pulling FortiClient malware hash from EMS. Choices:
|
|
Enable/disable pulling SysInfo from EMS. Choices:
|
|
Enable/disable pulling FortiClient user tags from EMS. Choices:
|
|
Enable/disable pulling vulnerabilities from EMS. Choices:
|
|
Relax restrictions on tags to send all EMS tags to all VDOMs Choices:
|
|
FortiClient EMS Serial Number. |
|
FortiClient EMS FQDN or IPv4 address. |
|
REST API call source IP. |
|
Enable or disable this EMS configuration. Choices:
|
|
FortiClient EMS call timeout in seconds |
|
EMS Tenant ID. |
|
Trust ca cn. Choices:
|
|
EMS certificate CN. |
|
Lowest CA cert on Fortigate in verified EMS cert chain. |
|
Enable/disable override behavior for how this FortiGate unit connects to EMS using a WebSocket connection. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |