check_point.mgmt.cp_mgmt_cluster_members_facts module – Retrieve all existing cluster members in domain.
Note
This module is part of the check_point.mgmt collection (version 5.2.3).
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_cluster_members_facts
.
New in check_point.mgmt 3.0.0
Synopsis
Retrieve all existing cluster members in domain.
All operations are performed over Web Services API.
Parameters
Parameter |
Comments |
---|---|
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:
|
|
Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are, CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER. |
|
Search expression to filter objects by. The provided text should be exactly the same as it would be given in SmartConsole Object Explorer. The logical operators in the expression (‘AND’, ‘OR’) should be provided in capital letters. The search involves both a IP search and a textual search in name, comment, tags etc. |
|
The maximal number of returned results. This parameter is relevant only for getting few objects. |
|
Limit number of cluster member interfaces to show. |
|
Number of the results to initially skip. This parameter is relevant only for getting few objects. |
|
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. |
|
Sorts results by the given field in ascending order. Choices:
|
|
Sorts results by the given field in descending order. Choices:
|
|
Indicates whether to calculate and show “groups” field for every object in reply. Choices:
|
|
Cluster member unique identifier. |
|
Version of checkpoint. If not given one, the latest version taken. |
Examples
- name: show-cluster-member
cp_mgmt_cluster_members_facts:
uid: 871a47b9-0000-4444-555-593c2111111
- name: show-cluster-members
cp_mgmt_cluster_members_facts:
details_level: standard
limit: 5