check_point.mgmt.cp_mgmt_run_script module – Executes the script on a given list of targets.

Note

This module is part of the check_point.mgmt collection (version 6.5.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_run_script.

New in check_point.mgmt 1.0.0

Synopsis

  • Executes the script on a given list of targets.

  • All operations are performed over Web Services API.

  • Available from R80 management version.

Parameters

Parameter

Comments

args

string

Script arguments.

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

comments

string

Comments string.

script

string

Script body.

script_name

string

Script name.

targets

list / elements=string

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: run-script
  cp_mgmt_run_script:
    script: ls -l /
    script_name: 'Script Example: List files under / dir'
    targets:
      - corporate-gateway

Return Values

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

Key

Description

cp_mgmt_run_script

dictionary

The checkpoint run-script output.

Returned: always.

Authors

  • Or Soffer (@chkp-orso)