check_point.mgmt.cp_mgmt_interface_facts module – Get interface objects facts on Checkpoint over Web Services API

Note

This module is part of the check_point.mgmt collection (version 6.2.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install check_point.mgmt.

To use it in a playbook, specify: check_point.mgmt.cp_mgmt_interface_facts.

New in check_point.mgmt 6.2.0

Synopsis

  • Get interface objects facts on Checkpoint devices.

  • Available for R82 and above machines.

  • 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’.

Parameters

Parameter

Comments

details_level

string

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.

Choices:

  • "uid"

  • "standard"

  • "full"

domains_to_process

list / elements=string

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.

filter

string

Filter interfaces by name or IP address.

gateway_uid

string

Gateway or cluster object uid that the interfaces belongs to.

limit

integer

The maximal number of returned results. This parameter is relevant only for getting few objects.

name

string

Network interface name.

offset

integer

Number of the results to initially skip. This parameter is relevant only for getting few objects.

order

list / elements=dictionary

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.

ASC

string

Sorts results by the given field in ascending order.

Choices:

  • "name"

DESC

string

Sorts results by the given field in descending order.

Choices:

  • "name"

show_membership

boolean

Indicates whether to calculate and show “groups” field for every object in reply.

Choices:

  • false

  • true

version

string

Version of checkpoint. If not given one, the latest version taken.

Examples

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

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

Authors

  • Eden Brillant (@chkp-edenbr)