check_point.mgmt.cp_mgmt_dynamic_global_network_object_facts module – Get dynamic-global-network-object objects facts on Checkpoint over Web Services API
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_dynamic_global_network_object_facts
.
New in check_point.mgmt 5.0.0
Synopsis
Get dynamic-global-network-object 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 |
---|---|
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. |
|
Object name. This parameter is relevant only for getting a specific object. |
|
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:
|
|
Version of checkpoint. If not given one, the latest version taken. |
Examples
- name: show-dynamic-global-network-object
cp_mgmt_dynamic_global_network_object_facts:
name: obj_global
- name: show-dynamic-global-network-objects
cp_mgmt_dynamic_global_network_object_facts:
details_level: full