check_point.mgmt.cp_mgmt_lock_object (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

Lock object using name and type. Can lock object only if the object is not locked by another session.

The object can be unlocked by the unlock, publish or discard commands.

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: lock-object
  cp_mgmt_lock_object:
    name: host5
    type: host

Inputs

    
name:
    description:
    - Object name. Must be unique in the domain.
    type: str

type:
    description:
    - Object type.
    type: str

layer:
    description:
    - Object layer, need to specify the layer if the object is rule/section and uid is
      not supplied.
    type: str

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

details_level:
    choices:
    - uid
    - standard
    - full
    description:
    - 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.
    type: str

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    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_lock_object:
  description: The checkpoint lock-object output.
  returned: always.
  type: dict