interface.update

Update Interface of id.

Update network interface static IP:

> network interface update enp0s3 aliases=”192.168.0.10”

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

Parameter 2: data

data

Type: object
No Additional Properties

name

Name

Type: string

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

description

Description

Type: string

ipv4_dhcp

Ipv4 Dhcp

Type: boolean

ipv6_auto

Ipv6 Auto

Type: boolean

aliases

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

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

Must be one of:

• "INET"
• "INET6"

address Required

Address

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

netmask Required

Netmask

Type: integer

failover_critical

Failover Critical

Type: boolean

failover_group

Failover Group

Any of

• Option 1
• Option 2

Type: integer

Type: null

failover_vhid

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

Failover Aliases

Type: array of object
No Additional Items

Each item of this array must be:

InterfaceCreateFailoverAlias

Type: object
No Additional Properties

type

Type

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

Must be one of:

• "INET"
• "INET6"

address Required

Address

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

failover_virtual_aliases

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

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

Must be one of:

• "INET"
• "INET6"

address Required

Address

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

bridge_members

Bridge Members

Type: array
No Additional Items

Each item of this array must be:

Type: object

enable_learning

Enable Learning

Type: boolean

stp

Stp

Type: boolean

lag_protocol

Lag Protocol

Type: enum (of string)

Must be one of:

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

xmit_hash_policy

Xmit Hash Policy

Type: enum (of null or string)

Must be one of:

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

lacpdu_rate

Lacpdu Rate

Type: enum (of null or string)

Must be one of:

• "SLOW"
• "FAST"
• null

lag_ports

Lag Ports

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

vlan_parent_interface

Vlan Parent Interface

Type: string

vlan_tag

Vlan Tag

Type: integer

vlan_pcp

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

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

Return value

InterfaceEntry

Type: object

id Required

Id

Type: string

name Required

Name

Type: string

fake Required

Fake

Type: boolean

type Required

Type

Type: string

state Required

InterfaceEntryState

Type: object
No Additional Properties

name Required

Name

Type: string

orig_name Required

Orig Name

Type: string

description Required

Description

Type: string

mtu Required

Mtu

Type: integer

cloned Required

Cloned

Type: boolean

flags Required

Flags

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

nd6_flags Required

Nd6 Flags

Type: array
No Additional Items

Each item of this array must be:

Type: object

capabilities Required

Capabilities

Type: array
No Additional Items

Each item of this array must be:

Type: object

link_state Required

Link State

Type: string

media_type Required

Media Type

Type: string

media_subtype Required

Media Subtype

Type: string

active_media_type Required

Active Media Type

Type: string

active_media_subtype Required

Active Media Subtype

Type: string

supported_media Required

Supported Media

Type: array
No Additional Items

Each item of this array must be:

Type: object

media_options Required

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 Required

Link Address

Type: string

permanent_link_address Required

Permanent Link Address

Any of

• Option 1
• Option 2

Type: string

Type: null

hardware_link_address Required

Hardware Link Address

Type: string

rx_queues

Rx Queues

Type: integer

tx_queues

Tx Queues

Type: integer

aliases Required

Aliases

Type: array of object
No Additional Items

Each item of this array must be:

InterfaceEntryStateAlias

Type: object
No Additional Properties

type Required

Type

Type: string

address Required

Address

Type: string

netmask

Netmask

Any of

• Option 1
• Option 2

Type: string

Type: integer

broadcast

Broadcast

Type: string

vrrp_config

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

Protocol

Any of

• Option 1
• Option 2

Type: string

Type: null

ports

Ports

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

Each item of this array must be:

InterfaceEntryStatePort

Type: object
No Additional Properties

name Required

Name

Type: string

flags Required

Flags

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

xmit_hash_policy

Xmit Hash Policy

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

lacpdu_rate

Lacpdu Rate

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

parent

Parent

Any of

• Option 1
• Option 2

Type: string

Type: null

tag

Tag

Any of

• Option 1
• Option 2

Type: integer

Type: null

pcp

Pcp

Any of

• Option 1
• Option 2

Type: integer

Type: null

aliases Required

Aliases

Type: array of object
No Additional Items

Each item of this array must be:

InterfaceEntryAlias

Type: object
No Additional Properties

type Required

Type

Type: string

address Required

Address

Type: string

netmask Required

Netmask

Any of

• Option 1
• Option 2

Type: string

Type: integer

ipv4_dhcp Required

Ipv4 Dhcp

Type: boolean

ipv6_auto Required

Ipv6 Auto

Type: boolean

description Required

Description

Type: string

mtu Required

Mtu

Any of

• Option 1
• Option 2

Type: integer

Type: null

vlan_parent_interface

Vlan Parent Interface

Any of

• Option 1
• Option 2

Type: string

Type: null

vlan_tag

Vlan Tag

Any of

• Option 1
• Option 2

Type: integer

Type: null

vlan_pcp

Vlan Pcp

Any of

• Option 1
• Option 2

Type: integer

Type: null

lag_protocol

Lag Protocol

Type: string

lag_ports

Lag Ports

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

Each item of this array must be:

Type: string

bridge_members

Bridge Members

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

Each item of this array must be:

Type: string

enable_learning

Enable Learning

Type: boolean

Additional Properties

Additional Properties of any type are allowed.

Type: object

Required roles: NETWORK_INTERFACE_WRITE