check_point.mgmt.cp_mgmt_show_unused_objects (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

Retrieve all unused objects.

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: show-unused-objects
  cp_mgmt_show_unused_objects:
    details_level: standard
    limit: 50
    offset: 0

Inputs

    
limit:
    description:
    - The maximal number of returned results. This parameter is relevant only for getting
      few objects.
    type: int

order:
    description:
    - 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.
    elements: dict
    suboptions:
      ASC:
        choices:
        - name
        description:
        - Sorts results by the given field in ascending order.
        type: str
      DESC:
        choices:
        - name
        description:
        - Sorts results by the given field in descending order.
        type: str
    type: list

filter:
    description:
    - 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.
    type: str

offset:
    description:
    - Number of the results to initially skip. This parameter is relevant only for getting
      few objects.
    type: int

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

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

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

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_show_unused_objects:
  description: The checkpoint show-unused-objects output.
  returned: always.
  type: dict