check_point.mgmt.cp_mgmt_where_used (5.2.3) — module

Install collection

Install with ansible-galaxy collection install check_point.mgmt:==5.2.3

Add to requirements.yml

  collections:
    - name: check_point.mgmt
      version: 5.2.3

Description

Searches for usage of the target object in other objects and rules.

All operations are performed over Web Services API.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: where-used
  cp_mgmt_where_used:
    name: Host 1

Inputs

    
name:
    description:
    - Object name.
    type: str

version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

indirect:
    description:
    - Search for indirect usage.
    type: bool

details_level:
    choices:
    - uid
    - standard
    - full
    description:
    - 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.
    type: str

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

async_response:
    description:
    - Run command in asynchronous mode and return task UID. Use show-task command to check
      the progress of the task.
    type: bool

show_membership:
    description:
    - Indicates whether to calculate and show "groups" field for every object in reply.
    type: bool

domains_to_process:
    description:
    - 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.
    elements: str
    type: list

indirect_max_depth:
    description:
    - Maximum nesting level during indirect usage search.
    type: int

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

dereference_group_members:
    description:
    - Indicates whether to dereference "members" field by details level for every object
      in reply.
    type: bool

Outputs

cp_mgmt_where_used:
  description: The checkpoint where-used output.
  returned: always.
  type: dict