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

From Get docs
Ansible/docs/2.11/collections/check point/mgmt/cp mgmt administrator facts module


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

Note

This plugin is part of the check_point.mgmt collection (version 2.0.0).

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 version 2.9: of check_point.mgmt


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 Choices/Defaults Comments

details_level

string

  • uid
  • standard
  • full

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.

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=string

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

  • name

Sorts results by the given field in ascending order.

DESC

string

  • name

Sorts results by the given field in descending order.

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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/check_point/mgmt/cp_mgmt_administrator_facts_module.html