check_point.mgmt.cp_mgmt_unlock_object module – Unlock object using uid or {name and type}.

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

New in check_point.mgmt 5.0.0

Synopsis

  • Unlock object using uid or {name and type}.

  • Can unlock object only if the current session owns the lock and there are no changes on the object.

  • All operations are performed over Web Services API.

Parameters

Parameter

Comments

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

details_level

string

The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.

Choices:

  • "uid"

  • "standard"

  • "full"

layer

string

Object layer, need to specify the layer if the object is rule/section and uid is not supplied.

name

string

Object name. Must be unique in the domain.

type

string

Object type.

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: unlock-object
  cp_mgmt_unlock_object:
    name: host5
    type: host

Return Values

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

Key

Description

cp_mgmt_unlock_object

dictionary

The checkpoint unlock-object output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)