check_point.mgmt.cp_mgmt_show_logs – Showing logs according to the given filter.
check_point.mgmt.cp_mgmt_show_logs – Showing logs according to the given filter.
Note
This plugin is part of the check_point.mgmt collection (version 2.0.0).
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 version 2.9: of check_point.mgmt
Synopsis
- Showing logs according to the given filter.
- All operations are performed over Web Services API.
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
ignore_warnings boolean |
|
Ignore warnings if exist. | ||
new_query dictionary |
Running a new query. | |||
custom_end string |
This option is only applicable when using the custom time-frame option. | |||
custom_start string |
This option is only applicable when using the custom time-frame option. | |||
filter string |
The filter as entered in SmartConsole/SmartView. | |||
log_servers list / elements=string |
List of IP's of logs servers to query. | |||
max_logs_per_request integer |
Limit the number of logs to be retrieved. | |||
time_frame string |
|
Specify the time frame to query logs. | ||
top dictionary |
Top results configuration. | |||
count integer |
The number of results to retrieve. | |||
field string |
|
The field on which the top command is executed. | ||
type string |
|
Type of logs to return. | ||
query_id string |
Get the next page of last run query with specified limit. | |||
version string |
Version of checkpoint. If not given one, the latest version taken. | |||
wait_for_task boolean |
|
Wait for the task to end. Such as publish task. | ||
wait_for_task_timeout integer |
Default: 30 |
How many minutes to wait until throwing a timeout error. |
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 | Returned | Description |
---|---|---|
cp_mgmt_show_logs dictionary |
always. |
The checkpoint show-logs output.
|
Authors
- Or Soffer (@chkp-orso)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/check_point/mgmt/cp_mgmt_show_logs_module.html