check_point.mgmt.cp_mgmt_get_attachment module – Retrieves a packet capture or blob data, according to the attributes of a log record.

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_get_attachment.

New in check_point.mgmt 5.0.0

Synopsis

  • Retrieves a packet capture or blob data, according to the attributes of a log record.

  • All operations are performed over Web Services API.

Parameters

Parameter

Comments

attachment_id

string

Attachment identifier from a log record.

auto_publish_session

boolean

Publish the current session if changes have been performed after task completes.

Choices:

  • false ← (default)

  • true

id

string

Log id from a log record.

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.

Choices:

  • false

  • true ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

Examples

- name: get-attachment
  cp_mgmt_get_attachment:
    attachment_id: MjY5HlNtYXJ0RGVmZW5zZR5jbj1jcF9tZ210LG89aHVnbzEtYmxvYkFwaS1uZXctdGFrZS0yLmNoZWNrcG9pbnQuY29tLnM2MjdvMx57MHg1OTg4

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

cp_mgmt_get_attachment

dictionary

The checkpoint get-attachment output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)