check_point.mgmt.cp_mgmt_task_facts (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

Get task objects facts on Checkpoint devices.

All operations are performed over Web Services API.

This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Usage examples

Scanned by Steampunk Spotter

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

- name: show-task
  cp_mgmt_task_facts:
    task_id: 2eec70e5-78a8-4bdb-9a76-cfb5601d0bcb

Scanned by Steampunk Spotter

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

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

Inputs

    
limit:
    description:
    - The maximal number of returned results. This parameter is relevant only for getting
      few objects.
    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. This parameter is relevant only for getting
      few objects.
    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. This parameter is relevant only for getting
      few objects.
    type: int

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

task_id:
    description:
    - Unique identifier of one or more tasks.
    elements: str
    type: list

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

Outputs

ansible_facts:
  description: The checkpoint object facts.
  returned: always.
  type: dict