check_point.mgmt.cp_mgmt_get_interfaces (5.2.3) — module

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

| "added in version" 5.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 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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get-interfaces
  cp_mgmt_get_interfaces:
    target_name: gw1
    with_topology: true

Inputs

    
version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

target_name:
    description:
    - Target name.
    type: str

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

with_topology:
    description:
    - Specify whether to fetch the interfaces with their topology. Otherwise, the Management
      Server fetches the interfaces without their topology.
    type: bool

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

use_defined_by_routes:
    description:
    - Specify whether to configure the topology "Defined by Routes" where applicable.
      Otherwise, configure the topology to "This Network" as default for internal interfaces.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

group_interfaces_by_subnet:
    description:
    - Specify whether to group the cluster interfaces by a subnet. Otherwise, group the
      cluster interfaces by their names.
    type: bool

Outputs

cp_mgmt_get_interfaces:
  description: The checkpoint get-interfaces output.
  returned: always.
  type: dict