Try SpotterConfigure FortiClient Enterprise Management Server
| "added in version" 2.1.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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
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>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
endpointcontrol_fctems:
description: The top level parameters set.
required: false
suboptions:
admin-password:
description: (list) Deprecated, please rename it to admin_password.
type: raw
admin-username:
description: Deprecated, please rename it to admin_username. FortiClient EMS admin
username.
type: str
ca-cn-info:
description: Deprecated, please rename it to ca_cn_info.
type: str
call-timeout:
description: Deprecated, please rename it to call_timeout. FortiClient EMS call
timeout in seconds
type: int
capabilities:
choices:
- fabric-auth
- silent-approval
- websocket
- websocket-malware
- push-ca-certs
- common-tags-api
- tenant-id
- single-vdom-connector
- client-avatars
description: No description.
elements: str
type: list
certificate:
description: FortiClient EMS certificate.
type: str
certificate-fingerprint:
description: Deprecated, please rename it to certificate_fingerprint. EMS certificate
fingerprint.
type: str
cloud-server-type:
choices:
- production
- alpha
- beta
description: Deprecated, please rename it to cloud_server_type. Cloud server type.
type: str
dirty-reason:
choices:
- none
- mismatched-ems-sn
description: Deprecated, please rename it to dirty_reason. Dirty Reason for FortiClient
EMS.
type: str
ems-id:
description: Deprecated, please rename it to ems_id. EMS ID in order
type: int
fortinetone-cloud-authentication:
choices:
- disable
- enable
description: Deprecated, please rename it to fortinetone_cloud_authentication.
Enable/disable authentication of FortiClient EMS Cloud t...
type: str
https-port:
description: Deprecated, please rename it to https_port. FortiClient EMS HTTPS
access port number.
type: int
interface:
description: Specify outgoing interface to reach server.
type: str
interface-select-method:
choices:
- auto
- sdwan
- specify
description: Deprecated, please rename it to interface_select_method. Specify
how to select outgoing interface to reach server.
type: str
name:
description: FortiClient Enterprise Management Server
required: true
type: str
out-of-sync-threshold:
description: Deprecated, please rename it to out_of_sync_threshold. Outdated resource
threshold in seconds
type: int
preserve-ssl-session:
choices:
- disable
- enable
description: Deprecated, please rename it to preserve_ssl_session. Enable/disable
preservation of EMS SSL session connection.
type: str
pull-avatars:
choices:
- disable
- enable
description: Deprecated, please rename it to pull_avatars. Enable/disable pulling
avatars from EMS.
type: str
pull-malware-hash:
choices:
- disable
- enable
description: Deprecated, please rename it to pull_malware_hash. Enable/disable
pulling FortiClient malware hash from EMS.
type: str
pull-sysinfo:
choices:
- disable
- enable
description: Deprecated, please rename it to pull_sysinfo. Enable/disable pulling
SysInfo from EMS.
type: str
pull-tags:
choices:
- disable
- enable
description: Deprecated, please rename it to pull_tags. Enable/disable pulling
FortiClient user tags from EMS.
type: str
pull-vulnerabilities:
choices:
- disable
- enable
description: Deprecated, please rename it to pull_vulnerabilities. Enable/disable
pulling vulnerabilities from EMS.
type: str
send-tags-to-all-vdoms:
choices:
- disable
- enable
description: Deprecated, please rename it to send_tags_to_all_vdoms. Relax restrictions
on tags to send all EMS tags to all VDOMs
type: str
serial-number:
description: Deprecated, please rename it to serial_number. FortiClient EMS Serial
Number.
type: str
server:
description: FortiClient EMS FQDN or IPv4 address.
type: str
source-ip:
description: Deprecated, please rename it to source_ip. REST API call source IP.
type: str
status:
choices:
- disable
- enable
description: Enable or disable this EMS configuration.
type: str
status-check-interval:
description: Deprecated, please rename it to status_check_interval. FortiClient
EMS call timeout in seconds
type: int
tenant-id:
description: Deprecated, please rename it to tenant_id. EMS Tenant ID.
type: str
trust-ca-cn:
choices:
- disable
- enable
description: Deprecated, please rename it to trust_ca_cn.
type: str
verified-cn:
description: Deprecated, please rename it to verified_cn. EMS certificate CN.
type: str
verifying-ca:
description: Deprecated, please rename it to verifying_ca. Lowest CA cert on Fortigate
in verified EMS cert chain.
type: str
websocket-override:
choices:
- disable
- enable
description: Deprecated, please rename it to websocket_override. Enable/disable
override behavior for how this FortiGate unit connects ...
type: str
type: dict
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list