check_point.mgmt.cp_mgmt_interface_facts (5.2.2) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: check_point.mgmt
      version: 5.2.2

Description

Get interface 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

Scanned by Steampunk Spotter

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

- name: show-interface
  cp_mgmt_interface_facts:
    name: eth0
    gateway_uid: ff918e85-98c4-4b17-bcac-417aab863d87

Scanned by Steampunk Spotter

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

- name: show-interfaces
  cp_mgmt_interface_facts:
    details_level: full
    gateway_uid: ff918e85-98c4-4b17-bcac-417aab863d87
    limit: 50
    offset: 0

Inputs

    
name:
    description:
    - Network interface name.
    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:
    - Filter interfaces by name or IP address.
    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

gateway_uid:
    description:
    - Gateway or cluster object uid that the interfaces belongs to.
    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

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