cp_mgmt_get_interfaces
Get physical interfaces with or without their topology from a Gaia Security Gateway or Cluster through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_get_interfaces
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Get physical interfaces with or without their topology from a Gaia Security Gateway or Cluster through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| auto_publish_session | bool | false | Publish this owned session explicitly after the operation; default false. | |
| group_interfaces_by_subnet | bool | Specify whether to group the cluster interfaces by a subnet. Otherwise, group the cluster interfaces by their names. | ||
| target_name | str | Target name. | ||
| use_defined_by_routes | bool | Specify whether to configure the topology “Defined by Routes” where applicable. Otherwise, configure the topology to “This Network” as default for internal interfaces. | ||
| version | str | Management API version path; omitted uses the default API version. | ||
| wait_for_task | bool | true | Wait for returned asynchronous task identifiers; default true. | |
| wait_for_task_timeout | int | 30 | Polling deadline in minutes; default 30, negative values use 30, maximum 1440. | |
| with_topology | bool | Specify whether to fetch the interfaces with their topology. Otherwise, the Management Server fetches the interfaces without their topology. |
Example
yaml
- name: get-interfaces
check_point.mgmt.cp_mgmt_get_interfaces:
target_name: gw1
with_topology: true