Try SpotterConfigure FortiClient Enterprise Management Server
| "added in version" 2.1.6 of drmofu.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 drmofu.fortimanager:==2.2.2
collections:
- name: drmofu.fortimanager
version: 2.2.2This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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: Configure FortiClient Enterprise Management Server
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
- tenant-id
- single-vdom-connector
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]>
status-check-interval: <value of integer>
certificate: <value of string>
admin-username: <value of string>
serial-number: <value of string>
admin-password: <value of string>
interface: <value of string>
interface-select-method: <value in [auto, sdwan, specify]>
dirty-reason: <value in [none, mismatched-ems-sn]>
ems-id: <value of integer>
status: <value in [disable, enable]>
ca-cn-info: <value of string>
trust-ca-cn: <value in [disable, enable]>
tenant-id: <value of 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
required: false
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool
access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
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.
required: false
type: bool
endpointcontrol_fctems:
description: the top level parameters set
required: false
suboptions:
admin-password:
description: description
type: str
admin-username:
description: FortiClient EMS admin username.
type: str
ca-cn-info:
description: no description
type: str
call-timeout:
description: 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
description: description
elements: str
type: list
certificate:
description: FortiClient EMS certificate.
type: str
certificate-fingerprint:
description: EMS certificate fingerprint.
type: str
cloud-server-type:
choices:
- production
- alpha
- beta
description: Cloud server type.
type: str
dirty-reason:
choices:
- none
- mismatched-ems-sn
description: Dirty Reason for FortiClient EMS.
type: str
ems-id:
description: EMS ID in order
type: int
fortinetone-cloud-authentication:
choices:
- disable
- enable
description: Enable/disable authentication of FortiClient EMS Cloud through FortiCloud
account.
type: str
https-port:
description: 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: Specify how to select outgoing interface to reach server.
type: str
name:
description: FortiClient Enterprise Management Server
type: str
out-of-sync-threshold:
description: Outdated resource threshold in seconds
type: int
preserve-ssl-session:
choices:
- disable
- enable
description: Enable/disable preservation of EMS SSL session connection.
type: str
pull-avatars:
choices:
- disable
- enable
description: Enable/disable pulling avatars from EMS.
type: str
pull-malware-hash:
choices:
- disable
- enable
description: Enable/disable pulling FortiClient malware hash from EMS.
type: str
pull-sysinfo:
choices:
- disable
- enable
description: Enable/disable pulling SysInfo from EMS.
type: str
pull-tags:
choices:
- disable
- enable
description: Enable/disable pulling FortiClient user tags from EMS.
type: str
pull-vulnerabilities:
choices:
- disable
- enable
description: Enable/disable pulling vulnerabilities from EMS.
type: str
serial-number:
description: FortiClient EMS Serial Number.
type: str
server:
description: FortiClient EMS FQDN or IPv4 address.
type: str
source-ip:
description: REST API call source IP.
type: str
status:
choices:
- disable
- enable
description: Enable or disable this EMS configuration.
type: str
status-check-interval:
description: FortiClient EMS call timeout in seconds
type: int
tenant-id:
description: EMS Tenant ID.
type: str
trust-ca-cn:
choices:
- disable
- enable
description: no description
type: str
websocket-override:
choices:
- disable
- enable
description: Enable/disable override behavior for how this FortiGate unit connects
to EMS using a WebSocket connection.
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.
required: false
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
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