check_point.mgmt.cp_mgmt_administrator_facts module – Get administrator objects facts on Checkpoint over Web Services API

Note

This module is part of the check_point.mgmt collection (version 6.2.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install check_point.mgmt.

To use it in a playbook, specify: check_point.mgmt.cp_mgmt_administrator_facts.

New in check_point.mgmt 1.0.0

Synopsis

  • Get administrator 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’.

Parameters

Parameter

Comments

details_level

string

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.

Choices:

  • "uid"

  • "standard"

  • "full"

limit

integer

The maximal number of returned results. This parameter is relevant only for getting few objects.

name

string

Object name. This parameter is relevant only for getting a specific object.

offset

integer

Number of the results to initially skip. This parameter is relevant only for getting few objects.

order

list / elements=dictionary

Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. This parameter is relevant only for getting few objects.

ASC

string

Sorts results by the given field in ascending order.

Choices:

  • "name"

DESC

string

Sorts results by the given field in descending order.

Choices:

  • "name"

version

string

Version of checkpoint. If not given one, the latest version taken.

Examples

- name: show-administrator
  cp_mgmt_administrator_facts:
    name: admin

- name: show-administrators
  cp_mgmt_administrator_facts:
    details_level: standard
    limit: 50
    offset: 0

Authors

  • Or Soffer (@chkp-orso)