Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

Parameter 2: data

data

Type: object
No Additional Properties

Name

Type: string

Generate a name if not provided based on type, e.g. "br0", "bond1", "vlan0".

Description

Type: string

Ipv4 Dhcp

Type: boolean

Ipv6 Auto

Type: boolean

Aliases

Type: array of object

All items must be unique

No Additional Items

Each item of this array must be:

InterfaceCreateAlias

Type: object
No Additional Properties

Type

Type: enum (of string) Default: "INET"

Must be one of:

"INET"
"INET6"

Address

Type: const

Must be one of:

Specific value: ""

Type: string

Netmask

Type: integer

Failover Critical

Type: boolean

Failover Group

Any of

Option 1
Option 2

Type: integer

Type: null

Failover Vhid

Any of

Option 1
Option 2

Type: integer

Value must be greater or equal to 1 and lesser or equal to 255

Type: null

Failover Aliases

Type: array of object
No Additional Items

Each item of this array must be:

InterfaceCreateFailoverAlias

Type: object
No Additional Properties

Type

Type: enum (of string) Default: "INET"

Must be one of:

"INET"
"INET6"

Address

Any of

Option 1
Option 2

Type: const

Must be one of:

Specific value: ""

Type: string

Failover Virtual Aliases

Type: array of object
No Additional Items

Each item of this array must be:

InterfaceCreateFailoverAlias

Type: object
No Additional Properties

Type

Type: enum (of string) Default: "INET"

Must be one of:

"INET"
"INET6"

Address

Any of

Option 1
Option 2

Type: const

Must be one of:

Specific value: ""

Type: string

Bridge Members

Type: array
No Additional Items

Each item of this array must be:

Type: object

Enable Learning

Type: boolean

Stp

Type: boolean

Lag Protocol

Type: enum (of string)

Must be one of:

"LACP"
"FAILOVER"
"LOADBALANCE"
"ROUNDROBIN"
"NONE"

Xmit Hash Policy

Type: enum (of null or string)

Must be one of:

"LAYER2"
"LAYER2+3"
"LAYER3+4"
null

Lacpdu Rate

Type: enum (of null or string)

Must be one of:

"SLOW"
"FAST"
null

Lag Ports

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Vlan Parent Interface

Type: string

Vlan Tag

Type: integer

Vlan Pcp

Any of

Option 1
Option 2

Type: integer

Value must be greater or equal to 0 and lesser or equal to 7

Type: null

Mtu

Any of

Option 1
Option 2

Type: integer

Value must be greater or equal to 68 and lesser or equal to 9216

Type: null

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

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

Call parameters

Tuple Validation

Parameter 1: id

id

Parameter 2: data

data

name

Name

description

Description

ipv4_dhcp

Ipv4 Dhcp

ipv6_auto

Ipv6 Auto

aliases

Aliases

Each item of this array must be:

InterfaceCreateAlias

type

Type

Must be one of:

address Required

Address

Any of

Must be one of:

netmask Required

Netmask

failover_critical

Failover Critical

failover_group

Failover Group

Any of

failover_vhid

Failover Vhid

Any of

failover_aliases

Failover Aliases

Each item of this array must be:

InterfaceCreateFailoverAlias

type

Type

Must be one of:

address Required

Address

Any of

Must be one of:

failover_virtual_aliases

Failover Virtual Aliases

Each item of this array must be:

InterfaceCreateFailoverAlias

type

Type

Must be one of:

address Required

Address

Any of

Must be one of:

bridge_members

Bridge Members

Each item of this array must be:

enable_learning

Enable Learning

stp

Stp

lag_protocol

Lag Protocol

Must be one of:

xmit_hash_policy

Xmit Hash Policy

Must be one of:

lacpdu_rate

Lacpdu Rate

Must be one of:

lag_ports

Lag Ports

Each item of this array must be:

vlan_parent_interface

Vlan Parent Interface

vlan_tag

Vlan Tag