fmgr_endpointcontrol_fctems – Configure FortiClient Enterprise Management Server (EMS) entries.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- endpointcontrol_fctems - no description type: dict
- call-timeout - FortiClient EMS call timeout in seconds (1 - 180 seconds, default = 30). type: int more...
- capabilities - No description for the parameter type: array choices: [fabric-auth, silent-approval, websocket, websocket-malware, push-ca-certs, common-tags-api] more...
- certificate-fingerprint - EMS certificate fingerprint. type: str more...
- cloud-server-type - Cloud server type. type: str choices: [production, alpha, beta] more...
- fortinetone-cloud-authentication - Enable/disable authentication of FortiClient EMS Cloud through FortiCloud account. type: str choices: [disable, enable] more...
- https-port - FortiClient EMS HTTPS access port number. type: int more...
- name - FortiClient Enterprise Management Server (EMS) name. type: str more...
- out-of-sync-threshold - Outdated resource threshold in seconds (10 - 3600, default = 180). type: int more...
- preserve-ssl-session - Enable/disable preservation of EMS SSL session connection. type: str choices: [disable, enable] more...
- pull-avatars - Enable/disable pulling avatars from EMS. type: str choices: [disable, enable] more...
- pull-malware-hash - Enable/disable pulling FortiClient malware hash from EMS. type: str choices: [disable, enable] more...
- pull-sysinfo - Enable/disable pulling SysInfo from EMS. type: str choices: [disable, enable] more...
- pull-tags - Enable/disable pulling FortiClient user tags from EMS. type: str choices: [disable, enable] more...
- pull-vulnerabilities - Enable/disable pulling vulnerabilities from EMS. type: str choices: [disable, enable] more...
- server - FortiClient EMS FQDN or IPv4 address. type: str more...
- source-ip - REST API call source IP. type: str more...
- websocket-override - Enable/disable override behavior for how this FortiGate unit connects to EMS using a WebSocket connection. type: str choices: [disable, enable] more...
Notes¶
Note
- 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¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
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: <value in [present, absent]>
endpointcontrol_fctems:
call-timeout: <value of integer>
capabilities:
- fabric-auth
- silent-approval
- websocket
- websocket-malware
- push-ca-certs
- common-tags-api
certificate-fingerprint: <value of string>
cloud-server-type: <value in [production, alpha, beta]>
fortinetone-cloud-authentication: <value in [disable, enable]>
https-port: <value of integer>
name: <value of string>
out-of-sync-threshold: <value of 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: <value of string>
source-ip: <value of string>
websocket-override: <value in [disable, 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:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict