check_point.mgmt.cp_mgmt_get_interfaces module – Get physical interfaces with or without their topology from a Gaia Security Gateway or Cluster.

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_get_interfaces.

New in check_point.mgmt 5.0.0

Synopsis

  • Get physical interfaces with or without their topology from a Gaia Security Gateway or Cluster.

  • The fetched topology is based on static routes.

  • SIC must be established in the Security Gateway or Cluster Member object.

  • Security Gateway or Cluster Members must be up and running.

  • All operations are performed over Web Services API.

Parameters

Parameter

Comments

auto_publish_session

boolean

Publish the current session if changes have been performed after task completes.

Choices:

  • false ← (default)

  • true

group_interfaces_by_subnet

boolean

Specify whether to group the cluster interfaces by a subnet. Otherwise, group the cluster interfaces by their names.

Choices:

  • false

  • true

target_name

string

Target name.

use_defined_by_routes

boolean

Specify whether to configure the topology “Defined by Routes” where applicable. Otherwise, configure the topology to “This Network” as default for internal interfaces.

Choices:

  • false

  • true

version

string

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

wait_for_task

boolean

Wait for the task to end. Such as publish task.

Choices:

  • false

  • true ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

with_topology

boolean

Specify whether to fetch the interfaces with their topology. Otherwise, the Management Server fetches the interfaces without their topology.

Choices:

  • false

  • true

Examples

- name: get-interfaces
  cp_mgmt_get_interfaces:
    target_name: gw1
    with_topology: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

cp_mgmt_get_interfaces

dictionary

The checkpoint get-interfaces output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)