# interface.websocket_interface

Returns the interface this websocket is connected to.

Type: object

##

Type: array
No Additional Items

##

The interface used for the current websocket connection or `null` if not available.

## Any of

#### InterfaceEntry

Type: object

##

#### Id

Type: string

Unique identifier for the network interface.

##

#### Name

Type: string

Name of the network interface.

##

#### Fake

Type: boolean

Whether this is a fake/simulated interface for testing purposes.

##

#### Type

Type: string

Type of interface (PHYSICAL, BRIDGE, LINK_AGGREGATION, VLAN, etc.).

##

#### InterfaceEntryState

Type: object

Current runtime state information for the interface.

No Additional Properties

##

#### Name

Type: string

Current name of the network interface.

##

#### Orig Name

Type: string

Original name of the network interface before any renaming.

##

#### Description

Type: string

Human-readable description of the network interface.

##

#### Mtu

Type: integer

Maximum transmission unit size for the interface.

##

#### Cloned

Type: boolean

Whether the interface is a cloned/virtual interface.

##

#### Flags

Type: array of string

List of interface flags indicating various states and capabilities. Common flags include UP, DOWN, RUNNING, MULTICAST, BROADCAST, LOOPBACK, and POINTOPOINT.

No Additional Items

##### Each item of this array must be:

Type: string

##

#### Nd6 Flags

Type: array

IPv6 neighbor discovery flags. These control IPv6 autoconfiguration behavior and include flags like AUTOLINKLOCAL, ACCEPTRTADV, and PERFORMNUD.

No Additional Items

##### Each item of this array must be:

Type: object

##

#### Capabilities

Type: array

List of hardware capabilities supported by the interface. Common capabilities include VLANMTU, JUMBOMTU, VLANHWTAGGING, VLANHWCSUM, and TSO4.

No Additional Items

##### Each item of this array must be:

Type: object

##

#### Link State

Type: string

Current link state of the interface (up, down, etc.).

##

#### Media Type

Type: string

Type of media/connection for the interface. Examples include Ethernet, 802.11, or loopback.

##

#### Media Subtype

Type: string

Subtype of media/connection for the interface. Examples include 1000baseT, 100baseTX, or autoselect.

##

#### Active Media Type

Type: string

Currently active media type. This may differ from configured media_type during autonegotiation.

##

#### Active Media Subtype

Type: string

Currently active media subtype. This reflects the actual negotiated connection speed and type.

##

#### Supported Media

Type: array

List of supported media types for the interface. Contains media descriptors like '1000baseT <full-duplex>' or 'autoselect'.

No Additional Items

##### Each item of this array must be:

Type: object

##

#### Media Options

Available media options for the interface. Options may include 'full-duplex', 'half-duplex', 'flowcontrol', or 'rxpause'.

## Any of

Type: array
No Additional Items

##### Each item of this array must be:

Type: object
Type: null

##

#### Link Address

Type: string

MAC address of the interface.

##

#### Permanent Link Address

Permanent MAC address of the interface if different from current.

## Any of

Type: string
Type: null

##

#### Hardware Link Address

Type: string

Hardware MAC address of the interface.

##

#### Rx Queues

Type: integer

Number of receive queues configured for the interface.

##

#### Tx Queues

Type: integer

Number of transmit queues configured for the interface.

##

#### Aliases

Type: array of object

List of IP address aliases configured on the interface.

No Additional Items

##### Each item of this array must be:

#### InterfaceEntryStateAlias

Type: object
No Additional Properties

##

#### Type

Type: string

The type of IP address (INET for IPv4, INET6 for IPv6).

##

#### Address

Type: string

The IP address value.

##

#### Netmask

The network mask for the IP address, either as a string or CIDR notation integer.

## Any of

Type: string
Type: integer

##

#### Broadcast

Type: string

Broadcast address for the network interface.

##

#### Vrrp Config

Default: []

VRRP (Virtual Router Redundancy Protocol) configuration for the interface.

## Any of

Type: array
No Additional Items

##### Each item of this array must be:

Type: object
Type: null

##

#### Protocol

Link aggregation protocol used (LACP, FAILOVER, etc.).

## Any of

Type: string
Type: null

##

#### Ports

Type: array of object Default: []

List of ports that are members of this link aggregation group.

No Additional Items

##### Each item of this array must be:

#### InterfaceEntryStatePort

Type: object
No Additional Properties

##

#### Name

Type: string

The name of the port interface.

##

#### Flags

Type: array of string

List of flags associated with the port.

No Additional Items

##### Each item of this array must be:

Type: string

##

#### Xmit Hash Policy

Default: null

Transmit hash policy for load balancing in link aggregation. LAYER2 uses MAC addresses, LAYER2+3 adds IP addresses, and LAYER3+4 includes TCP/UDP ports for distribution.

## Any of

Type: string
Type: null

##

#### Lacpdu Rate

Default: null

LACP data unit transmission rate. SLOW sends LACPDUs every 30 seconds, FAST sends every 1 second for quicker link failure detection.

## Any of

Type: string
Type: null

##

#### Parent

Parent interface for VLAN configuration.

## Any of

Type: string
Type: null

##

#### Tag

VLAN tag number.

## Any of

Type: integer
Type: null

##

#### Pcp

Priority Code Point for VLAN traffic prioritization. Values 0-7 map to different QoS priority levels, with 0 being lowest and 7 highest priority.

## Any of

Type: integer
Type: null

##

#### Aliases

Type: array of object

List of IP address aliases configured on the interface.

No Additional Items

##### Each item of this array must be:

#### InterfaceEntryAlias

Type: object
No Additional Properties

##

#### Type

Type: string

The type of IP address (INET for IPv4, INET6 for IPv6).

##

#### Address

Type: string

The IP address value.

##

#### Netmask

The network mask for the IP address, either as a string or CIDR notation integer.

## Any of

Type: string
Type: integer

##

#### Ipv4 Dhcp

Type: boolean

Whether IPv4 DHCP is enabled for automatic IP address assignment.

##

#### Ipv6 Auto

Type: boolean

Whether IPv6 autoconfiguration is enabled.

##

#### Description

Type: string

Human-readable description of the interface.

##

#### Mtu

Maximum transmission unit size for the interface.

## Any of

Type: integer
Type: null

##

#### Vlan Parent Interface

Parent interface for VLAN configuration.

## Any of

Type: string
Type: null

##

#### Vlan Tag

VLAN tag number for VLAN interfaces.

## Any of

Type: integer
Type: null

##

#### Vlan Pcp

Priority Code Point for VLAN traffic prioritization.

## Any of

Type: integer
Type: null

##

#### Lag Protocol

Type: string

Link aggregation protocol (LACP, FAILOVER, LOADBALANCE, etc.).

##

#### Lag Ports

Type: array of string Default: []

List of interface names that are members of this link aggregation group.

No Additional Items

##### Each item of this array must be:

Type: string

##

#### Bridge Members

Type: array of string Default: []

List of interface names that are members of this bridge.

No Additional Items

##### Each item of this array must be:

Type: string

##

#### Enable Learning

Type: boolean

Whether MAC address learning is enabled for bridge interfaces.

##

Additional Properties of any type are allowed.

Type: object
Type: null

Required roles: NETWORK_INTERFACE_READ