Skip to content

Models

airvpn.web.services.ports.models

Port

A single forwarded port owned by the authenticated user.

Constructed from the port entries returned by the PortManager manifest, and from the responses of port-mutating actions like PortManager.open.

Attributes:

Name Type Description
port int | None

The forwarded port number.

pool int | None

Identifier of the pool the port belongs to.

notes str | None

Free-text note/description attached to the port.

device str | None

Name of the device associated with the port.

enabled bool | None

Whether the port is currently enabled.

protocol Literal['both', 'tcp', 'udp'] | None

Protocol restriction for the port.

iplayer Literal['both', 'v6', 'v4'] | None

IP layer restriction for the port.

local int | None

Local port the forwarded port maps to.

dns str | None

Dynamic DNS hostname associated with the port.

PortSession

An active session using one of the user's forwarded ports.

Constructed from the session entries returned by PortManager.get_sessions, and used by PortManager.test_open to check connectivity.

Attributes:

Name Type Description
port int | None

The forwarded port number the session is using.

pool int | None

Identifier of the pool the port belongs to.

dns_name str | None

Dynamic DNS hostname associated with the port.

notes str | None

Free-text note/description attached to the port.

local int | None

Local port the forwarded port maps to.

iplayer Literal['both', 'v6', 'v4'] | None

IP layer restriction for the port.

protocol Literal['both', 'tcp', 'udp'] | None

Protocol used by the session.

server_name str | None

Name of the VPN server handling the session.

server_planet str | None

Planet designation of the VPN server (AirVPN's naming scheme for servers).

server_continent str | None

Continent the VPN server is located on.

server_location str | None

City/location of the VPN server.

server_country str | None

Country the VPN server is located in.

device_name str | None

Name of the device that opened the session.

device_description str | None

Description of the device that opened the session.

server_ip str | None

IP address of the VPN server.

client_ip str | None

IP address of the connecting client.