check_point.mgmt.cp_mgmt_prepare_software_package module – Prepares the software package on target machines.

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

New in check_point.mgmt 7.0.0

Synopsis

  • Prepares the software package on target machines.

  • All operations are performed over Web Services API.

  • Available from R82.20 management version.

Parameters

Parameter

Comments

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

cluster_installation_settings

dictionary

Preparation settings for cluster.

cluster_delay

integer

The delay between end of installation on one cluster members and start of installation on the next cluster member.

cluster_strategy

string

The cluster installation strategy. all-members - Install the package on all members in the cluster non-active-members-and-failover - In the High Availability cluster, install the package only on the selected cluster members with the cluster state ‘Standby’ and then failover from the current ‘Active’ member to one of the updated members non-active-members-no-failover - In the High Availability cluster, install the package only on the selected cluster members with the cluster state ‘Standby’ and then do not failover from the current ‘Active’ member to one of the updated members.

Choices:

  • "all-members"

  • "non-active-members-and-failover"

  • "non-active-members-no-failover"

concurrency_limit

integer

The number of targets, on which the same package is installed at the same time.

name

string / required

The name of the software package.

package_location

string

The package repository.

Choices:

  • "automatic"

  • "target-machine"

  • "central"

targets

list / elements=string / required

On what targets to execute this command. Targets may be identified by their name, or object unique identifier.

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: prepare-software-package
  cp_mgmt_prepare_software_package:
    cluster_installation_settings:
      cluster_strategy: non-active-members-no-failover
    name: Check_Point_R80_40_JHF_MCD_DEMO_019_MAIN_Bundle_T1_VISIBLE_FULL.tgz
    package_location: automatic
    targets:
    - corporate-gateway

Return Values

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

Key

Description

cp_mgmt_prepare_software_package

dictionary

The checkpoint prepare-software-package output.

Returned: always.

Authors

  • Dor Berenstein (@chkp-dorbe)