Tunnel Interface

The TunnelInterface class manages tunnel interface objects in Palo Alto Networks' Strata Cloud Manager. Tunnel interfaces are used for VPN tunnels (IPsec, GRE, etc.) and provide a logical interface for encrypted traffic.

Class Overview

from scm.client import Scm

client = Scm(
    client_id="your_client_id",
    client_secret="your_client_secret",
    tsg_id="your_tsg_id"
)

tunnel_interfaces = client.tunnel_interface

Method	Description	Parameters	Return Type
`create()`	Creates a new tunnel interface	`data: Dict[str, Any]`	`TunnelInterfaceResponseModel`
`get()`	Retrieves a tunnel interface by ID	`object_id: str`	`TunnelInterfaceResponseModel`
`update()`	Updates an existing tunnel interface	`tunnel: TunnelInterfaceUpdateModel`	`TunnelInterfaceResponseModel`
`list()`	Lists tunnel interfaces with optional filtering	`folder`, `snippet`, `device`, plus filters	`List[TunnelInterfaceResponseModel]`
`fetch()`	Fetches a single tunnel interface by name within a container	`name: str`, `folder`, `snippet`, `device`	`TunnelInterfaceResponseModel`
`delete()`	Deletes a tunnel interface by ID	`object_id: str`	`None`

Tunnel Interface Model Attributes

Attribute	Type	Required	Default	Description
`name`	str	Yes	None	Interface name (e.g., "tunnel.1")
`id`	UUID	Yes*	None	Unique identifier (*response/update only)
`comment`	str	No	None	Description. Max 1023 chars
`ip`	List[str]	No	None	List of IPv4 addresses
`mtu`	int	No	1500	MTU (576-9216)
`interface_management_profile`	str	No	None	Management profile name. Max 31 chars
`folder`	str	No**	None	Folder location. Max 64 chars
`snippet`	str	No**	None	Snippet location. Max 64 chars
`device`	str	No**	None	Device location. Max 64 chars

* Only required for update and response models ** Exactly one container must be provided for create operations

Exceptions

Exception	HTTP Code	Description
`InvalidObjectError`	400	Invalid data or parameters
`MissingQueryParameterError`	400	Missing required parameters
`ObjectNotPresentError`	404	Interface not found
`AuthenticationError`	401	Authentication failed
`ServerError`	500	Internal server error

Methods

List Tunnel Interfaces

# List all tunnels
tunnels = client.tunnel_interface.list(folder="Interfaces")

for tunnel in tunnels:
    print(f"Name: {tunnel.name}, MTU: {tunnel.mtu}")
    if tunnel.ip:
        print(f"  IP: {', '.join(tunnel.ip)}")

# Filter by MTU
low_mtu = client.tunnel_interface.list(folder="Interfaces", mtu=1400)

Fetch a Tunnel Interface

# Fetch by name
tunnel = client.tunnel_interface.fetch(
    name="tunnel.1",
    folder="Interfaces"
)
print(f"Found: {tunnel.name}")

# Get by ID
tunnel_by_id = client.tunnel_interface.get(tunnel.id)

Create a Tunnel Interface

# Create tunnel interface for IPsec VPN
tunnel_data = {
    "name": "tunnel.1",
    "comment": "Site-to-Site VPN Tunnel",
    "ip": ["10.254.0.1/30"],
    "mtu": 1400,  # Lower MTU for encapsulation overhead
    "folder": "Interfaces"
}

result = client.tunnel_interface.create(tunnel_data)
print(f"Created tunnel: {result.id}")

# Create tunnel without IP (unnumbered)
unnumbered_tunnel = {
    "name": "tunnel.2",
    "comment": "GRE Tunnel",
    "mtu": 1476,
    "folder": "Interfaces"
}

result = client.tunnel_interface.create(unnumbered_tunnel)

Update a Tunnel Interface

existing = client.tunnel_interface.fetch(name="tunnel.1", folder="Interfaces")

existing.mtu = 1380
existing.comment = "Updated VPN Tunnel"

updated = client.tunnel_interface.update(existing)

Delete a Tunnel Interface

client.tunnel_interface.delete("123e4567-e89b-12d3-a456-426655440000")

Use Cases

Managing Configuration Changes

result = client.commit(
    folders=["Interfaces"],
    description="Updated tunnel interfaces",
    sync=True
)

Error Handling

from scm.exceptions import InvalidObjectError, ObjectNotPresentError

try:
    tunnel = client.tunnel_interface.create({
        "name": "tunnel.1",
        "mtu": 100,  # Error: MTU too low
        "folder": "Interfaces"
    })
except InvalidObjectError as e:
    print(f"Invalid configuration: {e.message}")

Class Overview​

Tunnel Interface Model Attributes​

Exceptions​

Methods​

List Tunnel Interfaces​

Fetch a Tunnel Interface​

Create a Tunnel Interface​

Update a Tunnel Interface​

Delete a Tunnel Interface​

Use Cases​

Managing Configuration Changes​

Error Handling​

Related Topics​