check_point.mgmt.cp_mgmt_threat_emulation_image_facts module – Get threat-emulation-image objects facts on Checkpoint over Web Services API

Note

This module is part of the check_point.mgmt collection (version 7.0.0).

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

New in check_point.mgmt 7.0.0

Synopsis

  • Get threat-emulation-image objects facts on Checkpoint devices.

  • All operations are performed over Web Services API.

  • This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter ‘name’.

  • Available from R82.20 management version.

Parameters

Parameter

Comments

filter

string

Search expression to filter objects by. The provided text should be exactly the same as it would be given in SmartConsole Object Explorer. The logical operators in the expression (‘AND’, ‘OR’) should be provided in capital letters. The search involves both a IP search and a textual search in name, comment, tags etc.

image_id

string

Image id.

limit

integer

The maximal number of returned results. This parameter is relevant only for getting few objects.

name

string

Image name. This parameter is relevant only for getting a specific object.

offset

integer

Number of the results to initially skip. This parameter is relevant only for getting few objects.

order

list / elements=dictionary

Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. This parameter is relevant only for getting few objects.

ASC

string

Sorts results by the given field in ascending order.

Choices:

  • "name"

DESC

string

Sorts results by the given field in descending order.

Choices:

  • "name"

show_only_local_domain

boolean

Indicates whether the query should return only objects from the current local domain. This parameter is only valid for local domain.

Choices:

  • false

  • true

version

string

Version of checkpoint. If not given one, the latest version taken.

Examples

- name: show-threat-emulation-image
  cp_mgmt_threat_emulation_image_facts:
    name: Win10_64b

- name: show-threat-emulation-images
  cp_mgmt_threat_emulation_image_facts:
    limit: 50
    offset: 0

Authors

  • Dor Berenstein (@chkp-dorbe)