cp_mgmt_run_script
Executes the script on a given list of targets through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_run_script
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Executes the script on a given list of targets through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| args | str | Script arguments. | ||
| auto_publish_session | bool | false | Publish this owned session explicitly after the operation; default false. | |
| comments | str | Comments string. | ||
| script | str | Script body. | ||
| script_name | str | Script name. | ||
| targets | list | On what targets to execute this command. Targets may be identified by their name, or object unique identifier. | ||
| version | str | Management API version path; omitted uses the default API version. | ||
| wait_for_task | bool | true | Wait for returned asynchronous task identifiers; default true. | |
| wait_for_task_timeout | int | 30 | Polling deadline in minutes; default 30, negative values use 30, maximum 1440. |
Example
yaml
- name: run-script
check_point.mgmt.cp_mgmt_run_script:
script: ls -l /
script_name: 'Script Example: List files under / dir'
targets:
- corporate-gateway