cp_mgmt_show_unused_objects
Retrieve all unused objects through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_show_unused_objects
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Retrieve all unused objects through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| 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. | ||
| filter | str | 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. Available from R81 JHF management version. | ||
| limit | int | The maximal number of returned results. This parameter is relevant only for getting few objects. | ||
| 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. | ||
| 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: show-unused-objects
check_point.mgmt.cp_mgmt_show_unused_objects:
details_level: standard
limit: 50
offset: 0