check_point.mgmt.cp_mgmt_show_logs (5.2.3) — module

Install collection

Install with ansible-galaxy collection install check_point.mgmt:==5.2.3

Add to requirements.yml

  collections:
    - name: check_point.mgmt
      version: 5.2.3

Description

Showing logs according to the given filter.

All operations are performed over Web Services API.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: show-logs
  cp_mgmt_show_logs:
    new_query:
      filter: blade:"Threat Emulation"
      max_logs_per_request: '2'
      time_frame: today

Inputs

    
version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

query_id:
    description:
    - Get the next page of last run query with specified limit.
    type: str

new_query:
    description:
    - Running a new query.
    suboptions:
      custom_end:
        description:
        - This option is only applicable when using the custom time-frame option.
        type: str
      custom_start:
        description:
        - This option is only applicable when using the custom time-frame option.
        type: str
      filter:
        description:
        - The filter as entered in SmartConsole/SmartView.
        type: str
      log_servers:
        description:
        - List of IP's of logs servers to query.
        elements: str
        type: list
      max_logs_per_request:
        description:
        - Limit the number of logs to be retrieved.
        type: int
      time_frame:
        choices:
        - last-7-days
        - last-hour
        - today
        - last-24-hours
        - yesterday
        - this-week
        - this-month
        - last-30-days
        - all-time
        - custom
        description:
        - Specify the time frame to query logs.
        type: str
      top:
        description:
        - Top results configuration.
        suboptions:
          count:
            description:
            - The number of results to retrieve.
            type: int
          field:
            choices:
            - sources
            - destinations
            - services
            - actions
            - blades
            - origins
            - users
            - applications
            description:
            - The field on which the top command is executed.
            type: str
        type: dict
      type:
        choices:
        - logs
        - audit
        description:
        - Type of logs to return.
        type: str
    type: dict

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

ignore_warnings:
    description:
    - Ignore warnings if exist.
    type: bool

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

Outputs

cp_mgmt_show_logs:
  description: The checkpoint show-logs output.
  returned: always.
  type: dict