check_point.mgmt.cp_mgmt_data_center_object_facts (5.2.3) — module

Get data-center-object objects facts on Checkpoint over Web Services API

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

Authors: Or Soffer (@chkp-orso)

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 data-center-object 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-data-center-object
  cp_mgmt_data_center_object_facts:
    name: VM1 mgmt name
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: show-data-center-objects
  cp_mgmt_data_center_object_facts:

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

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

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

Outputs

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