check_point.mgmt.cp_mgmt_show_tasks (5.2.3) — module

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

Retrieve all tasks and show their progress and details.

All operations are performed over Web Services API.

Usage examples

Scanned by Steampunk Spotter

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

- name: show-tasks
  cp_mgmt_show_tasks:
    from_date: '2018-05-23T08:00:00'
    initiator: admin1
    status: successful

Inputs

    
limit:
    description:
    - The maximal number of returned results.
    type: int

order:
    description:
    - Sorts results by the given field. By default the results are sorted in the descending
      order by the task's last update date.
    elements: dict
    suboptions:
      ASC:
        choices:
        - name
        description:
        - Sorts results by the given field in ascending order.
        type: str
      DESC:
        choices:
        - name
        description:
        - Sorts results by the given field in descending order.
        type: str
    type: list

offset:
    description:
    - Number of the results to initially skip.
    type: int

status:
    choices:
    - successful
    - failed
    - in-progress
    - all
    description:
    - Status.
    type: str

to_date:
    description:
    - The date until which tracking tasks is to be performed, by the task's last update
      date. ISO 8601. If timezone isn't specified in the input, the Management server's
      timezone is used.
    type: str

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

from_date:
    description:
    - The date from which tracking tasks is to be performed, by the task's last update
      date. ISO 8601. If timezone isn't specified in the input, the Management server's
      timezone is used.
    type: str

initiator:
    description:
    - Initiator's name. If name isn't specified, tasks from all initiators will be shown.
    type: str

details_level:
    choices:
    - uid
    - standard
    - full
    description:
    - The level of detail for some of the fields in the response can vary from showing
      only the UID value of the object to a fully detailed representation of the object.
    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_show_tasks:
  description: The checkpoint show-tasks output.
  returned: always.
  type: dict