cp_mgmt_where_used
Searches for usage of the target object in other objects and rules through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_where_used
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Searches for usage of the target object in other objects and rules through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| async_response | bool | Run command in asynchronous mode and return task UID. Use show-task command to check the progress of the task. Available from R81.20 management version. | ||
| auto_publish_session | bool | false | Publish this owned session explicitly after the operation; default false. | |
| 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. | ||
| domains_to_process | list | 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. Available from R81 management version. | ||
| indirect | bool | Search for indirect usage. | ||
| indirect_max_depth | int | Maximum nesting level during indirect usage search. | ||
| name | str | Object name. | ||
| show_membership | bool | Indicates whether to calculate and show “groups” field for every object in reply. Available from R80.10 management version. | ||
| version | str | Management API version path; omitted uses the default API version. | ||
| wait_for_task | bool | true | Wait for returned asynchronous task identifiers; default true. | |
| wait_for_task_timeout | int | 30 | Polling deadline in minutes; default 30, negative values use 30, maximum 1440. |
Example
yaml
- name: where-used
check_point.mgmt.cp_mgmt_where_used:
name: Host 1