cp_mgmt_best_practice_facts
Get best-practice 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_best_practice_facts
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Get best-practice objects facts on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| best_practice_id | str | Best Practice ID. | ||
| blade | list | Returns all the relevant Best Practices of the selected Software Blades. When empty will return all the Best Practices. | ||
| defined_by | str | Returns all the relevant Best Practices of the selected type. | ||
| 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. | ||
| gateway_name | str | Returns all the relevant Best Practices of the selected Security Gateway object. | ||
| limit | int | The maximal number of returned results. This parameter is relevant only for getting few objects. Valid values are between 1 and 500. | ||
| name | str | Best Practice Name. This parameter is relevant only for getting a specific object. | ||
| offset | int | Number of the results to initially skip. This parameter is relevant only for getting few objects. | ||
| show_only_local_domain | bool | Indicates whether the query should return only objects from the current local domain. This parameter is only valid for local domain. | ||
| show_regulations | bool | Show the applicable regulations of the Best Practice. | ||
| status | list | Returns all the relevant best practices with the selected statuses. When empty will return all best practices. | ||
| version | str | Management API version path; omitted uses the default API version. |
Example
yaml
- name: show-best-practice
check_point.mgmt.cp_mgmt_best_practice_facts:
best_practice_id: FW183
- name: show-best-practices
check_point.mgmt.cp_mgmt_best_practice_facts:
limit: '5'