PARALLAX

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

NameTypeRequiredDefaultDescription
async_responseboolRun 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_sessionboolfalsePublish this owned session explicitly after the operation; default false.
dereference_group_membersboolIndicates whether to dereference “members” field by details level for every object in reply. Available from R80.10 management version.
details_levelstrThe 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_processlistIndicates 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.
indirectboolSearch for indirect usage.
indirect_max_depthintMaximum nesting level during indirect usage search.
namestrObject name.
show_membershipboolIndicates whether to calculate and show “groups” field for every object in reply. Available from R80.10 management version.
versionstrManagement API version path; omitted uses the default API version.
wait_for_taskbooltrueWait for returned asynchronous task identifiers; default true.
wait_for_task_timeoutint30Polling 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
Search
    ↑ ↓ move↵ openesc close