interface.query¶

Sent on interface changes.

Type: object

InterfaceAddedEvent

Type: object
No Additional Properties

Id

Type: string

InterfaceEntry

Type: object

Id

Type: string

Name

Type: string

Fake

Type: boolean

Type

Type: string

InterfaceEntryState

Type: object
No Additional Properties

Name

Type: string

Orig Name

Type: string

Description

Type: string

Mtu

Type: integer

Cloned

Type: boolean

Flags

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Nd6 Flags

Type: array
No Additional Items

Each item of this array must be:

Type: object

Capabilities

Type: array
No Additional Items

Each item of this array must be:

Type: object

Link State

Type: string

Media Type

Type: string

Media Subtype

Type: string

Active Media Type

Type: string

Active Media Subtype

Type: string

Supported Media

Type: array
No Additional Items

Each item of this array must be:

Type: object

Media Options

Type: array
No Additional Items

Each item of this array must be:

Type: object

Type: null

Link Address

Type: string

Permanent Link Address

Any of

Option 1
Option 2

Type: string

Type: null

Hardware Link Address

Type: string

Rx Queues

Type: integer

Tx Queues

Type: integer

Aliases

Type: array of object
No Additional Items

Each item of this array must be:

InterfaceEntryStateAlias

Type: object
No Additional Properties

Type

Type: string

Address

Type: string

Netmask

Any of

Option 1
Option 2

Type: string

Type: integer

Broadcast

Type: string

Vrrp Config

Default: []

Any of

Option 1
Option 2

Type: array
No Additional Items

Each item of this array must be:

Type: object

Type: null

Protocol

Any of

Option 1
Option 2

Type: string

Type: null

Ports

Type: array of object Default: []
No Additional Items

Each item of this array must be:

InterfaceEntryStatePort

Type: object
No Additional Properties

Name

Type: string

Flags

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Xmit Hash Policy

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Lacpdu Rate

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Parent

Any of

Option 1
Option 2

Type: string

Type: null

Tag

Any of

Option 1
Option 2

Type: integer

Type: null

Pcp

Any of

Option 1
Option 2

Type: integer

Type: null

Aliases

Type: array of object
No Additional Items

Each item of this array must be:

InterfaceEntryAlias

Type: object
No Additional Properties

Type

Type: string

Address

Type: string

Netmask

Any of

Option 1
Option 2

Type: string

Type: integer

Ipv4 Dhcp

Type: boolean

Ipv6 Auto

Type: boolean

Description

Type: string

Mtu

Any of

Option 1
Option 2

Type: integer

Type: null

Vlan Parent Interface

Any of

Option 1
Option 2

Type: string

Type: null

Vlan Tag

Any of

Option 1
Option 2

Type: integer

Type: null

Vlan Pcp

Any of

Option 1
Option 2

Type: integer

Type: null

Lag Protocol

Type: string

Lag Ports

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

Bridge Members

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

Enable Learning

Type: boolean

Additional Properties of any type are allowed.

Type: object

InterfaceChangedEvent

Type: object
No Additional Properties

Id

Type: string

InterfaceEntry

Type: object

Id

Type: string

Name

Type: string

Fake

Type: boolean

Type

Type: string

InterfaceEntryState

Type: object
No Additional Properties

Name

Type: string

Orig Name

Type: string

Description

Type: string

Mtu

Type: integer

Cloned

Type: boolean

Flags

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Nd6 Flags

Type: array
No Additional Items

Each item of this array must be:

Type: object

Capabilities

Type: array
No Additional Items

Each item of this array must be:

Type: object

Link State

Type: string

Media Type

Type: string

Media Subtype

Type: string

Active Media Type

Type: string

Active Media Subtype

Type: string

Supported Media

Type: array
No Additional Items

Each item of this array must be:

Type: object

Media Options

Any of

Option 1
Option 2

Type: array
No Additional Items

Each item of this array must be:

Type: object

Type: null

Link Address

Type: string

Permanent Link Address

Any of

Option 1
Option 2

Type: string

Type: null

Hardware Link Address

Type: string

Rx Queues

Type: integer

Tx Queues

Type: integer

Aliases

Type: array of object
No Additional Items

Each item of this array must be:

InterfaceEntryStateAlias

Type: object
No Additional Properties

Type

Type: string

Address

Type: string

Netmask

Any of

Option 1
Option 2

Type: string

Type: integer

Broadcast

Type: string

Vrrp Config

Default: []

Any of

Option 1
Option 2

Type: array
No Additional Items

Each item of this array must be:

Type: object

Type: null

Protocol

Any of

Option 1
Option 2

Type: string

Type: null

Ports

Type: array of object Default: []
No Additional Items

Each item of this array must be:

InterfaceEntryStatePort

Type: object
No Additional Properties

Name

Type: string

Flags

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Xmit Hash Policy

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Lacpdu Rate

Default: null

Any of

Option 1
Option 2

Type: string

Type: null

Parent

Any of

Option 1
Option 2

Type: string

Type: null

Tag

Any of

Option 1
Option 2

Type: integer

Type: null

Pcp

Any of

Option 1
Option 2

Type: integer

Type: null

Aliases

Type: array of object
No Additional Items

Each item of this array must be:

InterfaceEntryAlias

Type: object
No Additional Properties

Type

Type: string

Address

Type: string

Netmask

Any of

Option 1
Option 2

Type: string

Type: integer

Ipv4 Dhcp

Type: boolean

Ipv6 Auto

Type: boolean

Description

Type: string

Mtu

Any of

Option 1
Option 2

Type: integer

Type: null

Vlan Parent Interface

Any of

Option 1
Option 2

Type: string

Type: null

Vlan Tag

Any of

Option 1
Option 2

Type: integer

Type: null

Vlan Pcp

Any of

Option 1
Option 2

Type: integer

Type: null

Lag Protocol

Type: string

Lag Ports

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

Bridge Members

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

Enable Learning

Type: boolean

Additional Properties of any type are allowed.

Type: object

InterfaceRemovedEvent

Type: object
No Additional Properties

Id

Type: string

Required roles: NETWORK_INTERFACE_READ

Table Of Contents

Previous topic

Next topic

interface.query¶

ADDED

InterfaceAddedEvent

id Required

Id

fields Required

InterfaceEntry

id Required

Id

name Required

Name

fake Required

Fake

type Required

Type

state Required

InterfaceEntryState

name Required

Name

orig_name Required

Orig Name

description Required

Description

mtu Required

Mtu

cloned Required

Cloned

flags Required

Flags

Each item of this array must be:

nd6_flags Required

Nd6 Flags

Each item of this array must be:

capabilities Required

Capabilities

Each item of this array must be:

link_state Required

Link State

media_type Required

Media Type

media_subtype Required

Media Subtype

active_media_type Required

Active Media Type

active_media_subtype Required

Active Media Subtype

supported_media Required

Supported Media

Each item of this array must be:

media_options Required

Media Options

Any of

Each item of this array must be:

link_address Required

Link Address

permanent_link_address Required

Permanent Link Address

Any of

hardware_link_address Required

Hardware Link Address

rx_queues

Rx Queues

tx_queues

Tx Queues

aliases Required

Aliases

Each item of this array must be:

InterfaceEntryStateAlias

type Required

Type

address Required

Address

netmask

Netmask

Any of

broadcast

Broadcast