check_point.mgmt.cp_mgmt_export_smart_task (5.2.3) — module

Export SmartTask to a file.

| "added in version" 5.0.0 of check_point.mgmt"

Authors: Eden Brillant (@chkp-edenbr)

preview | supported by community

Install collection

Install with ansible-galaxy collection install check_point.mgmt:==5.2.3


Add to requirements.yml

  collections:
    - name: check_point.mgmt
      version: 5.2.3

Description

Export SmartTask to a file. <br>This command is available only in a Security Management environment or in Multi-Domain environment when logged into local domain.

All operations are performed over Web Services API.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: export-smart-task
  cp_mgmt_export_smart_task:
    name: Validate Session Name Before Publish

Inputs

    
name:
    description:
    - Name of task to be exported.
    required: true
    type: str

version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

file_path:
    description:
    - Path to the SmartTask file to be exported. <br>Should be the full file path (example,
      "/home/admin/exported-smart-task.txt)".<br>If no path was inserted the default will
      be, "/var/log/<task_name>.txt".
    type: str

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

Outputs

cp_mgmt_export_smart_task:
  description: The checkpoint export-smart-task output.
  returned: always.
  type: dict