Skip to content
API Enriched

Replace Network Interface.

PUT
/api/config/namespaces/{metadata.namespace}/network_interfaces/{metadata.name}
curl --request PUT \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/network_interfaces/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "metadata": { "annotations": {}, "description": "example", "disable": true, "labels": {}, "name": "example", "namespace": "example" }, "spec": { "dedicated_interface": { "cluster": {}, "device": "example", "is_primary": {}, "monitor": {}, "monitor_disabled": {}, "mtu": 1, "node": "example", "not_primary": {}, "priority": 1 }, "dedicated_management_interface": { "cluster": {}, "device": "example", "mtu": 1, "node": "example" }, "ethernet_interface": { "cluster": {}, "device": "example", "dhcp_client": {}, "dhcp_server": { "automatic_from_end": {}, "automatic_from_start": {}, "dhcp_networks": [ { "dgw_address": "example", "dns_address": "example", "first_address": {}, "last_address": {}, "network_prefix": "example", "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS", "pools": [ { "end_ip": "example", "start_ip": "example" } ], "same_as_dgw": {} } ], "fixed_ip_map": {}, "interface_ip_map": { "interface_ip_map": {} } }, "ipv6_auto_config": { "host": {}, "router": { "dns_config": { "configured_list": { "dns_list": [ "example" ] }, "local_dns": { "configured_address": "example", "first_address": {}, "last_address": {} } }, "network_prefix": "example", "stateful": { "automatic_from_end": {}, "automatic_from_start": {}, "dhcp_networks": [ { "network_prefix": "example", "pool_settings": "INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS", "pools": [ { "end_ip": "example", "start_ip": "example" } ] } ], "fixed_ip_map": {}, "interface_ip_map": { "interface_ip_map": {} } } } }, "is_primary": {}, "monitor": {}, "monitor_disabled": {}, "mtu": 1, "no_ipv6_address": {}, "node": "example", "not_primary": {}, "priority": 1, "site_local_inside_network": {}, "site_local_network": {}, "static_ip": { "cluster_static_ip": { "interface_ip_map": {} }, "node_static_ip": { "default_gw": "example", "ip_address": "example" } }, "static_ipv6_address": { "cluster_static_ip": { "interface_ip_map": {} }, "node_static_ip": { "default_gw": "example", "ip_address": "example" } }, "storage_network": {}, "untagged": {}, "vlan_id": 1 }, "layer2_interface": { "l2sriov_interface": { "device": "example", "untagged": {}, "vlan_id": 1 }, "l2vlan_interface": { "device": "example", "vlan_id": 1 }, "l2vlan_slo_interface": { "vlan_id": 1 } }, "legacy_interface": { "DHCP_server": "NETWORK_INTERFACE_DHCP_SERVER_DISABLE", "DNS_server": { "dns_mode": "NETWORK_INTERFACE_DNS_DISABLE", "dns_server": [ { "addr": "example" } ] }, "address_allocator": [ { "name": "example", "namespace": "example" } ], "default_gateway": { "default_gateway_address": { "addr": "example" }, "default_gateway_mode": "NETWORK_INTERFACE_GATEWAY_DISABLE" }, "device_name": "example", "dhcp_address": "NETWORK_INTERFACE_DHCP_DISABLE", "monitor": {}, "monitor_disabled": {}, "mtu": 1, "priority": 1, "static_addresses": [ { "plen": 1, "prefix": "example" } ], "tunnel": { "tunnel": [ { "name": "example", "namespace": "example" } ] }, "type": "NETWORK_INTERFACE_ETHERNET", "virtual_network": [ { "name": "example", "namespace": "example" } ], "vlan_tag": 1, "vlan_tagging": "NETWORK_INTERFACE_VLAN_TAGGING_DISABLE" }, "tunnel_interface": { "mtu": 1, "node": "example", "priority": 1, "site_local_inside_network": {}, "site_local_network": {}, "static_ip": { "cluster_static_ip": { "interface_ip_map": {} }, "node_static_ip": { "default_gw": "example", "ip_address": "example" } }, "tunnel": { "name": "example", "namespace": "example" } } } }'

Network interface represents configuration of a network device. Replace network interface will replace the contents of given network interface object.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
metadata.namespace
required
string

Namespace This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

metadata.name
required
string

Name The configuration object to be replaced will be looked up by name.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ReplaceRequest is used to replace contents of a network_interface

This is the input message of the ‘Replace’ RPC.

object
metadata
object
annotations
annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

object
description
description

Human readable description for the object.

string
>= 21 characters <= 1200 characters
disable
disable

A value of true will administratively disable the object.

boolean format: boolean
labels
labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object
name
name

This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.

string
>= 6 characters <= 1024 characters
namespace
namespace

This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

string
>= 6 characters <= 1024 characters
spec
object
dedicated_interface
object
cluster
object
device
Device

Name of the device for which interface is configured. Use wwan0 for 4G/LTE. Required: YES.

string
>= 1 characters <= 64 characters
is_primary
object
monitor
object
monitor_disabled
object
mtu
Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64
node
Node

Exclusive with [cluster] Configuration will apply to a device on the given node of the site.

string
>= 1 characters <= 64 characters
not_primary
object
priority
Priority

Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.

integer format: int64
dedicated_management_interface
object
cluster
object
device
Device

Name of the device for which interface is configured Required: YES.

string
>= 1 characters <= 64 characters
mtu
Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64
node
Node

Exclusive with [cluster] Configuration will apply to a device on the given node of the site.

string
>= 1 characters <= 64 characters
ethernet_interface
object
cluster
object
device
Device

Interface configuration for the ethernet device Required: YES.

string
>= 1 characters <= 64 characters
dhcp_client
object
dhcp_server
object
automatic_from_end
object
automatic_from_start
object
dhcp_networks
DHCP Networks

List of networks from which DHCP Server can allocate IPv4 Addresses

Required: YES.

Array<object>
>= 1 items <= 1 items
DHCP Network

DHCP network configuration.

object
dgw_address
Configured Address

Exclusive with [first_address last_address] Enter a IPv4 address from the network prefix to be used as the default gateway.

string
<= 1024 characters
dns_address
Configured Address

Exclusive with [same_as_dgw] Enter a IPv4 address from the network prefix to be used as the DNS server.

string
<= 1024 characters
first_address
object
last_address
object
network_prefix
Network Prefix

Exclusive with [] Set the network prefix for the site. Ex: 10.1.1.0/24.

string
<= 1024 characters
pool_settings
string
default: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS
Allowed values: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS
pools
DHCP pools

List of non overlapping IP address ranges.

Array<object>
<= 16 items
DHCP IP Range

DHCP pool is a range of IP addresses (start IP and end IP).

object
end_ip
End IP

Ending IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.200 with prefix length of 24, end offset is 0.0.0.200.

string
<= 1024 characters
start_ip
Start IP

Starting IP of the pool range. In case of address allocator, offset is derived based on network prefix. 10.1.1.5 with prefix length of 24, start offset is 0.0.0.5.

string
<= 1024 characters
same_as_dgw
object
fixed_ip_map
Fixed IP Assignments

Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client.

object
interface_ip_map
object
interface_ip_map
Site:Node to IP mapping

Specify static IPv4 addresses per site:node.

object
ipv6_auto_config
object
host
object
router
object
dns_config
object
configured_list
object
dns_list
Dns List

List of IPv6 Addresses acting as DNS servers Required: YES.

Array<string>
>= 1 items <= 4 items
local_dns
object
configured_address
Configured Address

Exclusive with [first_address last_address] Configured address from the network prefix is chosen as DNS server.

string
<= 1024 characters
first_address
object
last_address
object
network_prefix
Prefix Info

Exclusive with [stateful] Nework prefix that is used as Prefix information Allowed only /64 prefix length as per RFC 4862.

string
<= 1024 characters
stateful
object
automatic_from_end
object
automatic_from_start
object
dhcp_networks
DHCP IPV6 Networks

List of networks from which DHCP server can allocate IP addresses

Required: YES.

Array<object>
>= 1 items <= 1 items
DHCPIPV6NetworkType

DHCP IPv6 network type configuration.

object
network_prefix
Network Prefix

Exclusive with [] Network Prefix to be used for IPv6 address auto configuration.

string
<= 1024 characters
pool_settings
string
default: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS
Allowed values: INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS
pools
DHCP pools

List of non overlapping IP address ranges.

Array<object>
<= 16 items
DHCP IPV6 Range

DHCP IPv6 pool is a range of IP addresses (start IP and end IP).

object
end_ip
End IP

Ending IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix.

string
<= 1024 characters
start_ip
Start IPV6

Starting IPv6 address of the pool range. In case of address allocator, offset is derived based on network prefix. 2001::1 with prefix length of 64, start offset is 5.

string
<= 1024 characters
fixed_ip_map
Fixed IPV6 Assignments

Fixed MAC address to IPv6 assignments, Key: MAC address, Value: IPv6 Address Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.

object
interface_ip_map
object
interface_ip_map
Site:Node to IPV6 mapping

Map of Site:Node to IPv6 address.

object
is_primary
object
monitor
object
monitor_disabled
object
mtu
Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64
no_ipv6_address
object
node
Node

Exclusive with [cluster] Configuration will apply to a device on the given node.

string
>= 1 characters <= 64 characters
not_primary
object
priority
Priority

Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.

integer format: int64
site_local_inside_network
object
site_local_network
object
static_ip
object
cluster_static_ip
object
interface_ip_map
Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object
node_static_ip
object
default_gw
Default Gateway

IP address of the default gateway.

string
<= 1024 characters
ip_address
Default Gateway

IP address of the interface and prefix length Required: YES.

string
<= 1024 characters
static_ipv6_address
object
cluster_static_ip
object
interface_ip_map
Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object
node_static_ip
object
default_gw
Default Gateway

IP address of the default gateway.

string
<= 1024 characters
ip_address
Default Gateway

IP address of the interface and prefix length Required: YES.

string
<= 1024 characters
storage_network
object
untagged
object
vlan_id
VLAN Id

Exclusive with [untagged] Configure a VLAN tagged ethernet interface.

integer format: int64
>= 1 <= 4094
layer2_interface
object
l2sriov_interface
object
device
Device

Physical ethernet interface Required: YES.

string
>= 1 characters <= 64 characters
untagged
object
vlan_id
VLAN Id

Exclusive with [untagged] Configure a VLAN tagged interface.

integer format: int64
>= 1 <= 4094
l2vlan_interface
object
device
Device

Physical ethernet interface Required: YES.

string
>= 1 characters <= 64 characters
vlan_id
VLAN Id

VLAN ID Required: YES.

integer format: int64
>= 1 <= 4094
l2vlan_slo_interface
object
vlan_id
VLAN Id

VLAN ID Required: YES.

integer format: int64
>= 1 <= 4094
legacy_interface
object
DHCP_server
string
default: NETWORK_INTERFACE_DHCP_SERVER_DISABLE
Allowed values: NETWORK_INTERFACE_DHCP_SERVER_DISABLE NETWORK_INTERFACE_DHCP_SERVER_ENABLE NETWORK_INTERFACE_ENHANCED_DHCP_SERVER_ENABLE
DNS_server
object
dns_mode
string
default: NETWORK_INTERFACE_DNS_DISABLE
Allowed values: NETWORK_INTERFACE_DNS_DISABLE NETWORK_INTERFACE_DNS_AUTO_ALLOCATE NETWORK_INTERFACE_DNS_USE_CONFIGURED
dns_server
DNS Server

Address of DNS server when mode is “use-configured”

Array<object>
IPv4 Address

IPv4 Address in dot-decimal notation.

object
addr
IPv4 Address

IPv4 Address in string form with dot-decimal notation.

string
<= 1024 characters
address_allocator
Address Allocator

Reference to an address allocator for the network interface. When set, the allocator is used to allocate a subnet for the interface and an address from the subnet is set on the interface.

Array<object>
<= 1 items
ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object
kind
kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string
>= 12 characters <= 1024 characters
name
name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string
>= 6 characters <= 1024 characters
namespace
namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string
>= 6 characters <= 1024 characters
tenant
tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string
>= 6 characters <= 1024 characters
uid
uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid
>= 36 characters <= 1024 characters
default_gateway
object
default_gateway_address
object
addr
IPv4 Address

IPv4 Address in string form with dot-decimal notation.

string
<= 1024 characters
default_gateway_mode
string
default: NETWORK_INTERFACE_GATEWAY_DISABLE
Allowed values: NETWORK_INTERFACE_GATEWAY_DISABLE NETWORK_INTERFACE_GATEWAY_AUTO_ALLOCATE NETWORK_INTERFACE_GATEWAY_USE_CONFIGURED
device_name
Device Name

Name of the physical network interface device which this network interface represents. Required: YES.

string
<= 1024 characters
dhcp_address
string
default: NETWORK_INTERFACE_DHCP_DISABLE
Allowed values: NETWORK_INTERFACE_DHCP_DISABLE NETWORK_INTERFACE_DHCP_ENABLE
monitor
object
monitor_disabled
object
mtu
Mtu

Maximum Transfer Unit (Max packet length) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64
priority
Priority

Priority of the network interface when multiple network interfaces are present in the fleet object Greater the value, higher the priority.

integer format: int64
static_addresses
Static IP

If DHCP server is enabled, configures the subnet to be used for IP allocation.

Array<object>
IPv4 Subnet

IPv4 subnets specified as prefix and prefix-length. Prefix length must be <= 32.

object
plen
Prefix Length

Prefix-length of the IPv4 subnet. Must be <= 32.

integer format: int64
prefix
Prefix

Prefix part of the IPv4 subnet in string form with dot-decimal notation.

string
<= 1024 characters
tunnel
object
tunnel
Tunnel

Tunnel which is attached to this interface.

Array<object>
<= 1 items
ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object
kind
kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string
>= 12 characters <= 1024 characters
name
name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string
>= 6 characters <= 1024 characters
namespace
namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string
>= 6 characters <= 1024 characters
tenant
tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string
>= 6 characters <= 1024 characters
uid
uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid
>= 36 characters <= 1024 characters
type
string
default: NETWORK_INTERFACE_ETHERNET
Allowed values: NETWORK_INTERFACE_ETHERNET NETWORK_INTERFACE_VLAN_INTERFACE NETWORK_INTERFACE_LACP_INTERFACE NETWORK_INTERFACE_TUNNEL_INTERFACE NETWORK_INTERFACE_LOOPBACK_INTERFACE NETWORK_INTERFACE_LAYER2_INTERFACE
virtual_network
Virtual Network

Virtual-network for the interface This is optional and can contain at most one entry.

Array<object>
<= 1 items
ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object
kind
kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string
>= 12 characters <= 1024 characters
name
name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string
>= 6 characters <= 1024 characters
namespace
namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string
>= 6 characters <= 1024 characters
tenant
tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string
>= 6 characters <= 1024 characters
uid
uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid
>= 36 characters <= 1024 characters
vlan_tag
Vlan Tag

VLAN tag of the interface, valid only if VLAN tagging is enabled when vlan_tagging is enabled, value must be between 1 - 4094.

integer format: int64
vlan_tagging
string
default: NETWORK_INTERFACE_VLAN_TAGGING_DISABLE
Allowed values: NETWORK_INTERFACE_VLAN_TAGGING_DISABLE NETWORK_INTERFACE_VLAN_TAGGING_ENABLE
tunnel_interface
object
mtu
Maximum Packet Size (MTU)

Maximum packet size (Maximum Transfer Unit) of the interface When configured, MTU must be between 512 and 16384.

integer format: int64
node
Node

Exclusive with [] Configuration will apply to a given device on the given node.

string
>= 1 characters <= 64 characters
priority
Priority

Priority of the network interface when multiple network interfaces are present in outside network Greater the value, higher the priority.

integer format: int64
site_local_inside_network
object
site_local_network
object
static_ip
object
cluster_static_ip
object
interface_ip_map
Site:Node to IP mapping

Map of Node to Static IP configuration value, Key:Node, Value:IP Address.

object
node_static_ip
object
default_gw
Default Gateway

IP address of the default gateway.

string
<= 1024 characters
ip_address
Default Gateway

IP address of the interface and prefix length Required: YES.

string
<= 1024 characters
tunnel
object
name
name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string
>= 1 characters <= 128 characters
namespace
namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string
>= 6 characters <= 64 characters
tenant
tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string
>= 6 characters <= 64 characters

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
object
Examplegenerated
{}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example