fmgd_ips_global – Configure IPS global parameter.
Added in version 1.0.0.
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.
Tested with FortiManager v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
- 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
- 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
- device - The parameter in requested url type: str required: true
- ips_global - Configure IPS global parameter. type: dict
- anomaly_mode (Alias name: anomaly-mode) Global blocking mode for rate-based anomalies. type: str choices: [periodical, continuous] more...
- av_mem_limit (Alias name: av-mem-limit) Maximum percentage of system memory allowed for use on av scanning (10 - 50, default = zero). type: int more...
- cp_accel_mode (Alias name: cp-accel-mode) Ips pattern matching acceleration/offloading to cpx processors. type: str choices: [none, basic, advanced] more...
- database Regular or extended ips database. type: str choices: [regular, extended] more...
- deep_app_insp_db_limit (Alias name: deep-app-insp-db-limit) Limit on number of entries in deep application inspection database (1 - 2147483647, use recommended setting = 0). type: int more...
- deep_app_insp_timeout (Alias name: deep-app-insp-timeout) Timeout for deep application inspection (1 - 2147483647 sec. type: int more...
- engine_count (Alias name: engine-count) Number of ips engines running. type: int more...
- exclude_signatures (Alias name: exclude-signatures) Excluded signatures. type: str choices: [none, industrial, ot] more...
- fail_open (Alias name: fail-open) Enable to allow traffic if the ips buffer is full. type: str choices: [disable, enable] more...
- ips_reserve_cpu (Alias name: ips-reserve-cpu) Enable/disable ips daemons use of cpus other than cpu 0. type: str choices: [disable, enable] more...
- ngfw_max_scan_range (Alias name: ngfw-max-scan-range) Ngfw policy-mode app detection threshold. type: int more...
- np_accel_mode (Alias name: np-accel-mode) Acceleration mode for ips processing by npx processors. type: str choices: [none, basic] more...
- packet_log_queue_depth (Alias name: packet-log-queue-depth) Packet/pcap log queue depth per ips engine. type: int more...
- session_limit_mode (Alias name: session-limit-mode) Method of counting concurrent sessions used by session limit anomalies. type: str choices: [accurate, heuristic] more...
- socket_size (Alias name: socket-size) Ips socket buffer size. type: int more...
- sync_session_ttl (Alias name: sync-session-ttl) Enable/disable use of kernel session ttl for ips sessions. type: str choices: [disable, enable] more...
- tls_active_probe (Alias name: tls-active-probe) Tls active probe. type: dict
more...
- interface Specify outgoing interface to reach server. type: list more...
- interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...
- source_ip (Alias name: source-ip) Source ip address used for tls active probe. type: str more...
- source_ip6 (Alias name: source-ip6) Source ipv6 address used for tls active probe. type: str more...
- vdom Virtual domain name for tls active probe. type: list more...
- traffic_submit (Alias name: traffic-submit) Enable/disable submitting attack data found by this fortigate to fortiguard. type: str choices: [disable, enable] more...
- intelligent_mode (Alias name: intelligent-mode) Enable/disable ips adaptive scanning (intelligent mode). type: str choices: [disable, enable] more...
- skype_client_public_ipaddr (Alias name: skype-client-public-ipaddr) Public ip addresses of your network that receive skype sessions. type: str more...
- machine_learning_detection (Alias name: machine-learning-detection) Enable/disable machine learning detection. 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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure IPS global parameter.
fortinet.fmgdevice.fmgd_ips_global:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
ips_global:
# anomaly_mode: <value in [periodical, continuous]>
# av_mem_limit: <integer>
# cp_accel_mode: <value in [none, basic, advanced]>
# database: <value in [regular, extended]>
# deep_app_insp_db_limit: <integer>
# deep_app_insp_timeout: <integer>
# engine_count: <integer>
# exclude_signatures: <value in [none, industrial, ot]>
# fail_open: <value in [disable, enable]>
# ips_reserve_cpu: <value in [disable, enable]>
# ngfw_max_scan_range: <integer>
# np_accel_mode: <value in [none, basic]>
# packet_log_queue_depth: <integer>
# session_limit_mode: <value in [accurate, heuristic]>
# socket_size: <integer>
# sync_session_ttl: <value in [disable, enable]>
# tls_active_probe:
# interface: <list or string>
# interface_select_method: <value in [auto, sdwan, specify]>
# source_ip: <string>
# source_ip6: <string>
# vdom: <list or string>
# traffic_submit: <value in [disable, enable]>
# intelligent_mode: <value in [disable, enable]>
# skype_client_public_ipaddr: <string>
# machine_learning_detection: <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:
- 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
Status
This module is not guaranteed to have a backwards compatible interface.