Skip to content
API Enriched

Replace Secure Mesh site.

PUT
/api/config/namespaces/{metadata.namespace}/securemesh_sites/{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/securemesh_sites/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "metadata": { "annotations": {}, "description": "example", "disable": true, "labels": {}, "name": "example", "namespace": "example" }, "spec": { "address": "example", "blocked_services": { "blocked_sevice": [ { "dns": {}, "network_type": "VIRTUAL_NETWORK_SITE_LOCAL", "ssh": {}, "web_user_interface": {} } ] }, "bond_device_list": { "bond_devices": [ { "active_backup": {}, "devices": [ "example" ], "lacp": { "rate": 1 }, "link_polling_interval": 1, "link_up_delay": 1, "name": "example" } ] }, "coordinates": { "latitude": 1, "longitude": 1 }, "custom_network_config": { "active_enhanced_firewall_policies": { "enhanced_firewall_policies": [ { "name": "example", "namespace": "example" } ] }, "active_forward_proxy_policies": { "forward_proxy_policies": [ { "name": "example", "namespace": "example" } ] }, "active_network_policies": { "network_policies": [ { "name": "example", "namespace": "example" } ] }, "default_config": {}, "default_interface_config": {}, "default_sli_config": {}, "forward_proxy_allow_all": {}, "global_network_list": { "global_network_connections": [ { "sli_to_global_dr": { "global_vn": { "name": "example", "namespace": "example" } }, "slo_to_global_dr": { "global_vn": { "name": "example", "namespace": "example" } } } ] }, "interface_list": { "interfaces": [ { "dc_cluster_group_connectivity_interface_disabled": {}, "dc_cluster_group_connectivity_interface_enabled": {}, "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" }, "description": "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", "exclude": true } ], "same_as_dgw": {}, "network_prefix_allocator": { "name": "example", "namespace": "example" } } ], "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 }, "labels": {} } ] }, "no_forward_proxy": {}, "no_global_network": {}, "no_network_policy": {}, "sli_config": { "dc_cluster_group": { "name": "example", "namespace": "example" }, "labels": {}, "nameserver": "example", "no_dc_cluster_group": {}, "no_static_routes": {}, "no_v6_static_routes": {}, "static_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ], "default_gateway": {}, "ip_address": "example", "ip_prefixes": [ "example" ], "node_interface": { "list": [ { "interface": [ { "name": "example", "namespace": "example" } ], "node": "example" } ] } } ] }, "static_v6_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ], "default_gateway": {}, "ip_address": "example", "ip_prefixes": [ "example" ], "node_interface": { "list": [ { "interface": [ { "name": "example", "namespace": "example" } ], "node": "example" } ] } } ] }, "vip": "example" }, "slo_config": { "dc_cluster_group": { "name": "example", "namespace": "example" }, "labels": {}, "nameserver": "example", "no_dc_cluster_group": {}, "no_static_routes": {}, "no_v6_static_routes": {}, "static_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ], "default_gateway": {}, "ip_address": "example", "ip_prefixes": [ "example" ], "node_interface": { "list": [ { "interface": [ { "name": "example", "namespace": "example" } ], "node": "example" } ] } } ] }, "static_v6_routes": { "static_routes": [ { "attrs": [ "ROUTE_ATTR_NO_OP" ], "default_gateway": {}, "ip_address": "example", "ip_prefixes": [ "example" ], "node_interface": { "list": [ { "interface": [ { "name": "example", "namespace": "example" } ], "node": "example" } ] } } ] }, "vip": "example" }, "sm_connection_public_ip": {}, "sm_connection_pvt_ip": {}, "tunnel_dead_timeout": 1, "vip_vrrp_mode": "VIP_VRRP_INVALID" }, "default_blocked_services": {}, "default_network_config": {}, "kubernetes_upgrade_drain": { "disable_upgrade_drain": {}, "enable_upgrade_drain": { "disable_vega_upgrade_mode": {}, "drain_max_unavailable_node_count": 1, "drain_node_timeout": 1, "enable_vega_upgrade_mode": {} } }, "log_receiver": { "name": "example", "namespace": "example" }, "logs_streaming_disabled": {}, "master_node_configuration": [ { "name": "example", "public_ip": "example" } ], "no_bond_devices": {}, "offline_survivability_mode": { "enable_offline_survivability_mode": {}, "no_offline_survivability_mode": {} }, "os": { "default_os_version": {}, "operating_system_version": "example" }, "performance_enhancement_mode": { "perf_mode_l3_enhanced": { "jumbo": {}, "no_jumbo": {} }, "perf_mode_l7_enhanced": {} }, "sw": { "default_sw_version": {}, "volterra_software_version": "example" }, "volterra_certified_hw": "example", "worker_nodes": [ "example" ] } }'

Shape of the Secure Mesh site specification.

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 securemesh_site

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
address

Site’s geographical address that can be used to determine its latitude and longitude.

string
<= 256 characters
blocked_services
object
blocked_sevice
Disable Node Local Services

Blocking or denial configuration

Array<object>
Disable Node Local Service

Disable a node local service on this site.

object
dns
object
network_type
string
default: VIRTUAL_NETWORK_SITE_LOCAL
Allowed values: VIRTUAL_NETWORK_SITE_LOCAL VIRTUAL_NETWORK_SITE_LOCAL_INSIDE VIRTUAL_NETWORK_PER_SITE VIRTUAL_NETWORK_PUBLIC VIRTUAL_NETWORK_GLOBAL VIRTUAL_NETWORK_SITE_SERVICE VIRTUAL_NETWORK_VER_INTERNAL VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE VIRTUAL_NETWORK_IP_AUTO VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK VIRTUAL_NETWORK_SRV6_NETWORK VIRTUAL_NETWORK_IP_FABRIC VIRTUAL_NETWORK_SEGMENT VIRTUAL_NETWORK_MANAGEMENT
ssh
object
web_user_interface
object
bond_device_list
object
bond_devices
Bond Devices List

List of bond devices

Required: YES.

Array<object>
>= 1 items <= 4 items
Bond Device

Bond devices configuration for fleet.

object
active_backup
object
devices
Member Ethernet Devices

Ethernet devices that will make up this bond Required: YES.

Array<string>
>= 1 items <= 8 items
lacp
object
rate
Interval

Interval in seconds to transmit LACP packets.

integer format: int64
link_polling_interval
Link Polling Interval

Link polling interval in milliseconds Required: YES.

integer format: int64
link_up_delay
Link Up Delay

Milliseconds wait before link is declared up Required: YES.

integer format: int64
name
Bond Device

Name for the Bond. Ex ‘bond0’ Required: YES.

string
>= 6 characters <= 64 characters
coordinates
object
latitude
latitude

Latitude of the site location.

number format: float
longitude
longitude

Longitude of site location.

number format: float
custom_network_config
object
active_enhanced_firewall_policies
object
enhanced_firewall_policies
Enhanced Firewall Policy

Ordered List of Enhanced Firewall Policies active

Required: YES.

Array<object>
>= 1 items <= 128 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.

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
active_forward_proxy_policies
object
forward_proxy_policies
Forward Proxy Policies

Ordered List of Forward Proxy Policies active

Required: YES.

Array<object>
>= 1 items <= 128 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.

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
active_network_policies
object
network_policies
Firewall Policy

Ordered List of Firewall Policies active for this network firewall

Required: YES.

Array<object>
>= 1 items <= 128 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.

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
default_config
object
default_interface_config
object
default_sli_config
object
forward_proxy_allow_all
object
global_network_list
object
global_network_connections
Global Network Connections

Global network connections

Required: YES.

Array<object>
>= 1 items <= 8 items
Global Network Connection

Global network connection.

object
sli_to_global_dr
object
global_vn
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
slo_to_global_dr
object
global_vn
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
interface_list
object
interfaces
List of Interfaces

Configure network interfaces for this Secure Mesh site

Required: YES.

Array<object>
>= 1 items <= 128 items
Interface

Interface definition.

object
dc_cluster_group_connectivity_interface_disabled
object
dc_cluster_group_connectivity_interface_enabled
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
description
Interface Description

Description for this Interface.

string
>= 21 characters <= 256 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
exclude
Exclude

X-displayName: “Exclude” If exclude is true, IP addresses are not assigned from this range.

boolean format: boolean
same_as_dgw
object
network_prefix_allocator
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
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
labels
Interface labels

Add Labels for this Interface, these labels can be used in firewall policy.

object
no_forward_proxy
object
no_global_network
object
no_network_policy
object
sli_config
object
dc_cluster_group
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
labels
Network labels

Add Labels for this network, these labels can be used in firewall policy.

object
nameserver
nameserver

Optional DNS V4 server IP to be used for name resolution.

string
<= 1024 characters
no_dc_cluster_group
object
no_static_routes
object
no_v6_static_routes
object
static_routes
object
static_routes
static_routes

List of static routes

Required: YES.

Array<object>
>= 1 items <= 16 items
Static Route

Defines a static route, configuring a list of prefixes and a next-hop to be used for them.

object
attrs
Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>
<= 4 items
Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY
default_gateway
object
ip_address
IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string
<= 1024 characters
ip_prefixes
IP Prefixes

List of route prefixes that have common next hop and attributes Required: YES.

Array<string>
>= 1 items <= 256 items
node_interface
object
list
NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>
<= 8 items
NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object
interface
Interface

Interface reference on this node.

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
node
Node

Node name on this site.

string
<= 1024 characters
static_v6_routes
object
static_routes
static_routes

List of IPv6 static routes

Required: YES.

Array<object>
>= 1 items <= 16 items
Static IPv6 Route

Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.

object
attrs
Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>
<= 4 items
Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY
default_gateway
object
ip_address
IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string
<= 1024 characters
ip_prefixes
IPv6 Prefixes

List of IPv6 route prefixes that have common next hop and attributes Required: YES.

Array<string>
>= 1 items <= 256 items
node_interface
object
list
NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>
<= 8 items
NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object
interface
Interface

Interface reference on this node.

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
node
Node

Node name on this site.

string
<= 1024 characters
vip
Common V4 VIP

Optional common virtual V4 IP across all nodes to be used as automatic VIP.

string
<= 1024 characters
slo_config
object
dc_cluster_group
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
labels
Network labels

Add Labels for this network, these labels can be used in firewall policy.

object
nameserver
nameserver

Optional DNS V4 server IP to be used for name resolution.

string
<= 1024 characters
no_dc_cluster_group
object
no_static_routes
object
no_v6_static_routes
object
static_routes
object
static_routes
static_routes

List of static routes

Required: YES.

Array<object>
>= 1 items <= 16 items
Static Route

Defines a static route, configuring a list of prefixes and a next-hop to be used for them.

object
attrs
Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>
<= 4 items
Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY
default_gateway
object
ip_address
IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string
<= 1024 characters
ip_prefixes
IP Prefixes

List of route prefixes that have common next hop and attributes Required: YES.

Array<string>
>= 1 items <= 256 items
node_interface
object
list
NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>
<= 8 items
NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object
interface
Interface

Interface reference on this node.

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
node
Node

Node name on this site.

string
<= 1024 characters
static_v6_routes
object
static_routes
static_routes

List of IPv6 static routes

Required: YES.

Array<object>
>= 1 items <= 16 items
Static IPv6 Route

Defines a static route of IPv6 prefixes, configuring a list of prefixes and a next-hop to be used for them.

object
attrs
Attributes

List of attributes that control forwarding, dynamic routing and control plane (host) reachability.

Array<string>
<= 4 items
Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY
default_gateway
object
ip_address
IP Address

Exclusive with [default_gateway node_interface] Traffic matching the IP prefixes is sent to this IP Address.

string
<= 1024 characters
ip_prefixes
IPv6 Prefixes

List of IPv6 route prefixes that have common next hop and attributes Required: YES.

Array<string>
>= 1 items <= 256 items
node_interface
object
list
NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding networking_interface.

Array<object>
<= 8 items
NodeInterfaceInfo

On a multinode site, this list holds the nodes and corresponding tunnel transport interface.

object
interface
Interface

Interface reference on this node.

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
node
Node

Node name on this site.

string
<= 1024 characters
vip
Common V4 VIP

Optional common virtual V4 IP across all nodes to be used as automatic VIP.

string
<= 1024 characters
sm_connection_public_ip
object
sm_connection_pvt_ip
object
tunnel_dead_timeout
tunnel_dead_timeout

Time interval, in millisec, within which any IPsec / SSL connection from the site going down is detected. When not set (== 0), a default value of 10000 msec will be used.

integer format: int64
vip_vrrp_mode
string
default: VIP_VRRP_INVALID
Allowed values: VIP_VRRP_INVALID VIP_VRRP_ENABLE VIP_VRRP_DISABLE
default_blocked_services
object
default_network_config
object
kubernetes_upgrade_drain
object
disable_upgrade_drain
object
enable_upgrade_drain
object
disable_vega_upgrade_mode
object
drain_max_unavailable_node_count
Node Batch Size Count

Exclusive with []

integer format: int64
drain_node_timeout
Upgrade Wait Time

Seconds to wait before initiating upgrade on the next set of nodes. Setting it to 0 will wait indefinitely for all services on nodes to be upgraded gracefully before proceeding to the next set of nodes. (Warning: It may block upgrade if services on a node cannot be gracefully upgraded. It is recommended to use the default value).

Required: YES.

integer format: int64
enable_vega_upgrade_mode
object
log_receiver
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
logs_streaming_disabled
object
master_node_configuration

Configuration of master nodes

Required: YES.

Array<object>
<= 3 items
Master Node

Master Node is the configuration of the master node.

object
name
Name

Names of master node Required: YES.

string
>= 6 characters <= 1024 characters
public_ip
Public IP

IP Address of the master node. This IP will be used when other sites connect via Site Mesh Group.

string
<= 1024 characters
no_bond_devices
object
offline_survivability_mode
object
enable_offline_survivability_mode
object
no_offline_survivability_mode
object
os
object
default_os_version
object
operating_system_version
Operating System Version

Exclusive with [default_os_version] Specify a OS version to be used e.g. 9.2024.6.

string
<= 20 characters
performance_enhancement_mode
object
perf_mode_l3_enhanced
object
jumbo
object
no_jumbo
object
perf_mode_l7_enhanced
object
sw
object
default_sw_version
object
volterra_software_version
F5XC Software Version

Exclusive with [default_sw_version] Specify a F5XC Software Version to be used e.g. Crt-20210329-1002.

string
<= 20 characters
volterra_certified_hw

Name for generic server certified hardware to form this Secure Mesh site. Required: YES.

string
>= 1 characters <= 1024 characters
worker_nodes

Names of worker nodes.

Array<string>
<= 128 items

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