check_point.mgmt.cp_mgmt_domain_permissions_profile_facts (5.2.3) — module

Get domain-permissions-profile objects facts on Checkpoint over Web Services API

| "added in version" 3.0.0 of check_point.mgmt"

Authors: Eden Brillant (@chkp-edenbr)

preview | supported by community

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

Get domain-permissions-profile objects facts on Checkpoint devices.

All operations are performed over Web Services API.

This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: show-domain-permissions-profile
  cp_mgmt_domain_permissions_profile_facts:
    name: profile
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: show-domain-permissions-profiles
  cp_mgmt_domain_permissions_profile_facts:
    details_level: standard
    limit: 50
    offset: 0

Inputs

    
name:
    description:
    - Object name. This parameter is relevant only for getting a specific object.
    type: str

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

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

Outputs

ansible_facts:
  description: The checkpoint object facts.
  returned: always.
  type: dict