ansible.builtin.cp_mgmt_session_facts (v2.9.17) — module

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

Get session objects facts on Check Point 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-session
  cp_mgmt_session_facts:

Scanned by Steampunk Spotter

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

- name: show-sessions
  cp_mgmt_session_facts:
    details_level: standard
    limit: 50
    offset: 0

Inputs

    
limit:
    description:
    - No more than that many results will be returned. 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 session publish time. This parameter is relevant only for getting few
      objects.
    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:
    - Skip that many results before beginning to return them. This parameter is relevant
      only for getting few objects.
    type: int

version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    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

view_published_sessions:
    description:
    - Show a list of published sessions.
    type: bool

Outputs

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