check_point.mgmt.cp_mgmt_show_logs module – Showing logs according to the given filter.
Note
This module is part of the check_point.mgmt collection (version 5.2.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install check_point.mgmt
.
To use it in a playbook, specify: check_point.mgmt.cp_mgmt_show_logs
.
New in check_point.mgmt 2.0.0
Synopsis
Showing logs according to the given filter.
All operations are performed over Web Services API.
Parameters
Parameter |
Comments |
---|---|
Publish the current session if changes have been performed after task completes. Choices:
|
|
Ignore warnings if exist. Choices:
|
|
Running a new query. |
|
This option is only applicable when using the custom time-frame option. |
|
This option is only applicable when using the custom time-frame option. |
|
The filter as entered in SmartConsole/SmartView. |
|
List of IP’s of logs servers to query. |
|
Limit the number of logs to be retrieved. |
|
Specify the time frame to query logs. Choices:
|
|
Top results configuration. |
|
The number of results to retrieve. |
|
The field on which the top command is executed. Choices:
|
|
Type of logs to return. Choices:
|
|
Get the next page of last run query with specified limit. |
|
Version of checkpoint. If not given one, the latest version taken. |
|
Wait for the task to end. Such as publish task. Choices:
|
|
How many minutes to wait until throwing a timeout error. Default: |
Examples
- name: show-logs
cp_mgmt_show_logs:
new_query:
filter: blade:"Threat Emulation"
max_logs_per_request: '2'
time_frame: today
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The checkpoint show-logs output. Returned: always. |