- source
fmgr_endpointcontrol_fctems.py
- orphan
2.1.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v7.0.2 -> latest
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- endpointcontrol_fctems - Configure FortiClient Enterprise Management Server type: dict
- call_timeout (Alias name: call-timeout) Forticlient ems call timeout in seconds (1 - 180 seconds, default = 30). type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- capabilities type: list choices: [fabric-auth, silent-approval, websocket, websocket-malware, push-ca-certs, common-tags-api, tenant-id, single-vdom-connector, client-avatars]
more...
Supported Version Ranges:
v7.0.2 -> latest
- certificate_fingerprint (Alias name: certificate-fingerprint) Ems certificate fingerprint. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- cloud_server_type (Alias name: cloud-server-type) Cloud server type. type: str choices: [production, alpha, beta]
more...
Supported Version Ranges:
v7.0.2 -> latest
- fortinetone_cloud_authentication (Alias name: fortinetone-cloud-authentication) Enable/disable authentication of forticlient ems cloud through forticloud account. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- https_port (Alias name: https-port) Forticlient ems https access port number. type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- name Forticlient enterprise management server (ems) name. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- out_of_sync_threshold (Alias name: out-of-sync-threshold) Outdated resource threshold in seconds (10 - 3600, default = 180). type: int
more...
Supported Version Ranges:
v7.0.5 -> latest
- preserve_ssl_session (Alias name: preserve-ssl-session) Enable/disable preservation of ems ssl session connection. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- pull_avatars (Alias name: pull-avatars) Enable/disable pulling avatars from ems. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- pull_malware_hash (Alias name: pull-malware-hash) Enable/disable pulling forticlient malware hash from ems. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- pull_sysinfo (Alias name: pull-sysinfo) Enable/disable pulling sysinfo from ems. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- pull_tags (Alias name: pull-tags) Enable/disable pulling forticlient user tags from ems. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- pull_vulnerabilities (Alias name: pull-vulnerabilities) Enable/disable pulling vulnerabilities from ems. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- server Forticlient ems fqdn or ipv4 address. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- source_ip (Alias name: source-ip) Rest api call source ip. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- websocket_override (Alias name: websocket-override) Enable/disable override behavior for how this fortigate unit connects to ems using a websocket connection. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- status_check_interval (Alias name: status-check-interval) Forticlient ems call timeout in seconds (1 - 120 seconds, default = 5). type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- certificate Forticlient ems certificate. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- admin_username (Alias name: admin-username) Forticlient ems admin username. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- serial_number (Alias name: serial-number) Forticlient ems serial number. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- admin_password (Alias name: admin-password) type: list
more...
Supported Version Ranges:
v7.0.2 -> latest
- interface Specify outgoing interface to reach server. type: str
more...
Supported Version Ranges:
v7.0.4 -> v7.0.12
,v7.2.1 -> latest
- interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify]
more...
Supported Version Ranges:
v7.0.4 -> v7.0.12
,v7.2.1 -> latest
- dirty_reason (Alias name: dirty-reason) Dirty reason for forticlient ems. type: str choices: [none, mismatched-ems-sn]
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.1 -> latest
- ems_id (Alias name: ems-id) Ems id in order (1 - 5) type: int
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.1 -> latest
- status Enable or disable this ems configuration. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.1 -> latest
- ca_cn_info (Alias name: ca-cn-info) type: str
more...
Supported Version Ranges:
v7.0.6 -> v7.0.12
,v7.2.2 -> latest
- trust_ca_cn (Alias name: trust-ca-cn) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.6 -> v7.0.12
,v7.2.2 -> latest
- tenant_id (Alias name: tenant-id) Ems tenant id. type: str
more...
Supported Version Ranges:
v7.2.1 -> latest
- send_tags_to_all_vdoms (Alias name: send-tags-to-all-vdoms) Relax restrictions on tags to send all ems tags to all vdoms type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- verified_cn (Alias name: verified-cn) Ems certificate cn. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest
- verifying_ca (Alias name: verifying-ca) Lowest ca cert on fortigate in verified ems cert chain. type: str
more...
Supported Version Ranges:
v7.4.2 -> latest
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
- 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>
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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)