cp_mgmt_nat_rule_facts
Get nat-rule objects facts on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_nat_rule_facts
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Get nat-rule objects facts on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| dereference_group_members | bool | Indicates whether to dereference “members” field by details level for every object in reply. Available from R80.10 management version. | ||
| details_level | str | 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. | ||
| filter | str | Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression (‘AND’, ‘OR’) should be provided in capital letters. If an operator is not used, the default OR operator applies. Available from R80.10 management version. | ||
| filter_settings | dict | Sets filter preferences. | ||
| limit | int | The maximal number of returned results. This parameter is relevant only for getting few objects. | ||
| name | str | Rule name. This parameter is relevant only for getting a specific object. Minimum version required is 1.7.1. Available from R81 management version. | ||
| offset | int | Number of the results to initially skip. This parameter is relevant only for getting few objects. | ||
| order | list | 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. | ||
| package | str | Name of the package. | ||
| rule_number | str | Rule number. | ||
| show_membership | bool | Indicates whether to calculate and show “groups” field for every object in reply. Available from R80.10 management version. | ||
| use_object_dictionary | bool | N/A | ||
| version | str | Management API version path; omitted uses the default API version. |
Example
yaml
- name: show-nat-rule
check_point.mgmt.cp_mgmt_nat_rule_facts:
package: standard
name: nat_rule1
- name: show-nat-rulebase
check_point.mgmt.cp_mgmt_nat_rule_facts:
details_level: standard
limit: 2
offset: 1
package: standard
use_object_dictionary: true