Network Interface#

This class is used to manage Network Interface

class NetworkInterface#
abort_get_interfaces(task_id, force_cleanup=False)#

Attempt to abort an on-going “get-interfaces” operation. This API might fail if the “get-interfaces” operation is in its final stage.

Parameters

  • task_id (str) – get-interfaces task UID.

  • force_cleanup (bool, optional) – Forcefully abort the “get-interfaces” task.

Returns

The response from the server

Return type

Box

Examples

>>> firewall.network_objects.network_interface.abort_get_interfaces(
    task_id="01234567-89ab-cdef-a930-8c37a59972b3")
get_interfaces(target_uid=None, target_name=None, group_interfaces_by_subnet=False, use_defined_by_routes=True, with_topology=False)#

Get physical interfaces with or without their topology from a Gaia Security Gateway or Cluster. Note: The fetched topology is based on static routes. Prerequisites: 1) SIC must be established in the Security Gateway or Cluster Member object. 2) Security Gateway or Cluster Members must be up and running.

Parameters

  • target_uid (str, optional) – Target unique identifier.

  • target_name (str, optional) – Target name.

  • group_interfaces_by_subnet (bool, optional) – Specify whether to group the cluster interfaces by a subnet. Otherwise, group the cluster interfaces by their names.

  • use_defined_by_routes (bool, optional) – Specify whether to configure the topology “Defined by Routes” where applicable. Otherwise, configure the topology to “This Network” as default for internal interfaces. with_topology (bool, optional): Specify whether to fetch the interfaces with their topology. Otherwise, the Management Server fetches the interfaces without their topology.

Returns

The response from the server

Return type

Box

Examples

>>> firewall.network_objects.network_interface.get_interfaces(
... target_name="gw123")