W3cubDocs

/Ansible

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

Note

This plugin is part of the check_point.mgmt collection (version 2.1.1).

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 version 2.9: of check_point.mgmt

Synopsis

  • Executes the script on a given list of targets.
  • All operations are performed over Web Services API.

Parameters

Parameter Choices/Defaults Comments
args
string
Script arguments.
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
    Choices:
  • no
  • yes ←
Wait for the task to end. Such as publish task.
wait_for_task_timeout
integer
Default:
30
How many minutes to wait until throwing a timeout error.

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 Returned Description
cp_mgmt_run_script
dictionary
always.
The checkpoint run-script output.


Authors

  • Or Soffer (@chkp-orso)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/check_point/mgmt/cp_mgmt_run_script_module.html