check_point.gaia.cp_gaia_task_facts (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

Show task.

Requirements

• supported starting from gaia_api >= 1.6

Usage examples

Scanned by Steampunk Spotter

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

- name: Show task
  check_point.gaia.cp_gaia_task_facts:
    task_id: ["ccc88f8f-ee65-44d2-bdc6-797f8347f6e1"]

Inputs

    
task_id:
    description: List of task ids to show.
    elements: str
    required: true
    type: list

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

Outputs

ansible_facts:
  contains:
    tasks:
      contains:
        execution_time:
          description: Time in seconds.
          returned: always
          type: int
        last_update_time:
          description:
          - Last update timestamp from task's execution. A task can update its status
            during execution. Updates interval will change from one API to another.
          returned: always
          type: str
        progress_description:
          description: Progress description will change between one API to another.
          returned: always
          type: str
        progress_percentage:
          description: Note Percentage will be marked as 100 upon failure as well.
          returned: always
          type: int
        start_time:
          description: Execution start time, in iso8601 format.
          returned: always
          type: str
        status:
          description: Status.
          returned: always
          type: str
        status_code:
          description: HTTP return code.
          returned: always
          type: int
        task_details:
          description: The type of object depends on the request. See 'run-script'
            output for example.
          elements: dict
          returned: always
          type: list
        task_id:
          description: ID of the task being executed.
          returned: always
          type: str
        task_name:
          description: Request URL. For example '/run-script' for run-script tasks.
          returned: always
          type: str
        time_spent_in_queue:
          description: Time in seconds.
          returned: always
          type: int
      description: Tasks.
      elements: dict
      returned: always
      type: list
  description: The checkpoint object facts.
  returned: always.
  type: dict