check_point.mgmt.cp_mgmt_abort_get_interfaces (5.2.3) — module

Attempt to abort an on-going "get-interfaces" operation.

| "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

Attempt to abort an on-going "get-interfaces" operation. This API might fail if the "get-interfaces" operation is in its final stage.

All operations are performed over Web Services API.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: abort-get-interfaces
  cp_mgmt_abort_get_interfaces:
    task_id: 45b185e7-9ccd-4971-b74b-d212282f8f96

Inputs

    
task_id:
    description:
    - get-interfaces task UID.
    type: str

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

force_cleanup:
    description:
    - Forcefully abort the "get-interfaces" task.
    type: bool

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_abort_get_interfaces:
  description: The checkpoint abort-get-interfaces output.
  returned: always.
  type: dict