check_point.gaia.cp_gaia_run_script (5.0.1) — module

Install collection

Install with ansible-galaxy collection install check_point.gaia:==5.0.1

Add to requirements.yml

  collections:
    - name: check_point.gaia
      version: 5.0.1

Description

Run script on Check Point machine.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Run script
  check_point.gaia.cp_gaia_run_script:
    script: "ls -la"
    environment_variables: [{"name": "VAR_NAME", "value": "VAR_VALUE"}]

Inputs

    
args:
    description: Script arguments, separated by space character. Note don't send sensitive
      data on this parameter.
    required: false
    type: str

script:
    description: Script body. Limited by 1300000 characters.
    required: true
    type: str

version:
    description: Gaia API version for example 1.6.
    required: false
    type: str

description:
    description: Script description.
    required: false
    type: str

wait_for_task:
    default: true
    description: Wait for task or return immediately.
    required: false
    type: bool

environment_variables:
    description: Define environment variables to be used in the script, it's better to
      send sensitive data on environment variables since it's not stored.
    elements: dict
    required: false
    suboptions:
      name:
        description: Variable's name.
        required: false
        type: str
      value:
        description: Variable's value.
        required: false
        type: str
    type: list

Outputs

run_script:
  description: The checkpoint object updated.
  returned: always.
  type: dict