check_point.mgmt.checkpoint_run_script module – Run scripts on Check Point devices over Web Services API

Note

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

New in version 2.7: of check_point.mgmt

Synopsis

  • Run scripts on Check Point devices. All operations are performed over Web Services API.

Parameters

Parameter

Comments

script

string / required

Script body contents.

script_name

string / required

Name of the script.

targets

list / elements=string / required

Targets the script should be run against. Can reference either name or UID.

Examples

- name: Run script
  checkpoint_run_script:
    script_name: "List root"
    script: ls -l /
    targets:
      - mycheckpointgw

Return Values

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

Key

Description

checkpoint_run_script

list / elements=string

The checkpoint run script output.

Returned: always.

Authors

  • Ansible by Red Hat (@rcarrillocruz)