Replace GCP VPC site.

PUT

/api/config/namespaces/{metadata.namespace}/gcp_vpc_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/gcp_vpc_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", "block_all_services": {}, "blocked_services": { "blocked_sevice": [ { "dns": {}, "network_type": "VIRTUAL_NETWORK_SITE_LOCAL", "ssh": {}, "web_user_interface": {} } ] }, "cloud_credentials": { "name": "example", "namespace": "example" }, "coordinates": { "latitude": 1, "longitude": 1 }, "custom_dns": { "inside_nameserver": "example", "outside_nameserver": "example" }, "default_blocked_services": {}, "disk_size": 1, "gcp_region": "example", "ingress_egress_gw": { "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" } ] }, "dc_cluster_group_inside_vn": { "name": "example", "namespace": "example" }, "dc_cluster_group_outside_vn": { "name": "example", "namespace": "example" }, "forward_proxy_allow_all": {}, "gcp_zone_names": [ "example" ], "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" } } } ] }, "inside_network": { "existing_network": { "name": "example" }, "new_network": { "name": "example" }, "new_network_autogenerate": {} }, "inside_static_routes": { "static_route_list": [ { "custom_static_route": { "attrs": [ "ROUTE_ATTR_NO_OP" ], "labels": {}, "nexthop": { "interface": [ { "name": "example", "namespace": "example" } ], "nexthop_address": { "ipv4": { "addr": "example" }, "ipv6": { "addr": "example" } }, "type": "NEXT_HOP_DEFAULT_GATEWAY" }, "subnets": [ { "ipv4": { "plen": 1, "prefix": "example" }, "ipv6": { "plen": 1, "prefix": "example" } } ] }, "simple_static_route": "example" } ] }, "inside_subnet": { "existing_subnet": { "subnet_name": "example" }, "new_subnet": { "primary_ipv4": "example", "subnet_name": "example" } }, "no_dc_cluster_group": {}, "no_forward_proxy": {}, "no_global_network": {}, "no_inside_static_routes": {}, "no_network_policy": {}, "no_outside_static_routes": {}, "node_number": 1, "outside_network": { "existing_network": { "name": "example" }, "new_network": { "name": "example" }, "new_network_autogenerate": {} }, "outside_static_routes": { "static_route_list": [ { "custom_static_route": { "attrs": [ "ROUTE_ATTR_NO_OP" ], "labels": {}, "nexthop": { "interface": [ { "name": "example", "namespace": "example" } ], "nexthop_address": { "ipv4": { "addr": "example" }, "ipv6": { "addr": "example" } }, "type": "NEXT_HOP_DEFAULT_GATEWAY" }, "subnets": [ { "ipv4": { "plen": 1, "prefix": "example" }, "ipv6": { "plen": 1, "prefix": "example" } } ] }, "simple_static_route": "example" } ] }, "outside_subnet": { "existing_subnet": { "subnet_name": "example" }, "new_subnet": { "primary_ipv4": "example", "subnet_name": "example" } }, "performance_enhancement_mode": { "perf_mode_l3_enhanced": { "jumbo": {}, "no_jumbo": {} }, "perf_mode_l7_enhanced": {} }, "sm_connection_public_ip": {}, "sm_connection_pvt_ip": {} }, "ingress_gw": { "gcp_zone_names": [ "example" ], "local_network": { "existing_network": { "name": "example" }, "new_network": { "name": "example" }, "new_network_autogenerate": {} }, "local_subnet": { "existing_subnet": { "subnet_name": "example" }, "new_subnet": { "primary_ipv4": "example", "subnet_name": "example" } }, "node_number": 1, "performance_enhancement_mode": { "perf_mode_l3_enhanced": { "jumbo": {}, "no_jumbo": {} }, "perf_mode_l7_enhanced": {} } }, "instance_type": "example", "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": {}, "offline_survivability_mode": { "enable_offline_survivability_mode": {}, "no_offline_survivability_mode": {} }, "private_connect_disabled": {}, "private_connectivity": { "cloud_link": { "name": "example", "namespace": "example" }, "inside": {}, "outside": {} }, "ssh_key": "example", "voltstack_cluster": { "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" } ] }, "dc_cluster_group": { "name": "example", "namespace": "example" }, "forward_proxy_allow_all": {}, "gcp_zone_names": [ "example" ], "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" } } } ] }, "k8s_cluster": { "name": "example", "namespace": "example" }, "no_dc_cluster_group": {}, "no_forward_proxy": {}, "no_global_network": {}, "no_k8s_cluster": {}, "no_network_policy": {}, "no_outside_static_routes": {}, "node_number": 1, "outside_static_routes": { "static_route_list": [ { "custom_static_route": { "attrs": [ "ROUTE_ATTR_NO_OP" ], "labels": {}, "nexthop": { "interface": [ { "name": "example", "namespace": "example" } ], "nexthop_address": { "ipv4": { "addr": "example" }, "ipv6": { "addr": "example" } }, "type": "NEXT_HOP_DEFAULT_GATEWAY" }, "subnets": [ { "ipv4": { "plen": 1, "prefix": "example" }, "ipv6": { "plen": 1, "prefix": "example" } } ] }, "simple_static_route": "example" } ] }, "site_local_network": { "existing_network": { "name": "example" }, "new_network": { "name": "example" }, "new_network_autogenerate": {} }, "site_local_subnet": { "existing_subnet": { "subnet_name": "example" }, "new_subnet": { "primary_ipv4": "example", "subnet_name": "example" } }, "sm_connection_public_ip": {}, "sm_connection_pvt_ip": {} } } }'

• F5 Distributed Cloud Console

Shape of the GCP VPC site replace specification.

Authorizations

• ApiToken

Parameters

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 Body^required

Media typeapplication/json

ReplaceRequest is used to replace contents of a gcp_vpc_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

block_all_services

object

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

cloud_credentials

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

coordinates

object

latitude

latitude

Latitude of the site location.

number format: float

longitude

longitude

Longitude of site location.

number format: float

custom_dns

object

inside_nameserver

inside_nameserver

Optional DNS server IP to be used for name resolution in inside network.

string

<= 1024 characters

outside_nameserver

outside_nameserver

Optional DNS server IP to be used for name resolution in outside network.

string

<= 1024 characters

default_blocked_services

object

disk_size

Disk size to be used for this instance in GiB. 80 is 80 GiB.

integer format: int64

gcp_region

Name for GCP Region. Required: YES.

string

<= 64 characters

ingress_egress_gw

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

dc_cluster_group_inside_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

dc_cluster_group_outside_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

forward_proxy_allow_all

object

gcp_zone_names

GCP zones

X-required List of zones when instances will be created, needs to match with region selected. Required: YES.

Array<string>

<= 3 items

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

inside_network

object

existing_network

object

name

GCP VPC Network Name

Name for your GCP VPC Network Required: YES.

string

>= 1 characters <= 64 characters

new_network

object

name

GCP VPC Network Name

Name for your GCP VPC Network Required: YES.

string

>= 1 characters <= 64 characters

new_network_autogenerate

object

inside_static_routes

object

static_route_list

List of Static Routes

List of Static routes

Required: YES.

Array<object>

>= 1 items <= 64 items

Site Static Route Config Modes

Different ways to configure static routes.

object

custom_static_route

object

attrs

Attributes

List of route attributes associated with the static route.

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

labels

Static Route labels

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

object

nexthop

object

interface

Network Interface

Nexthop is network interface when type is “Network-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

nexthop_address

object

ipv4

object

addr

IPv4 Address

IPv4 Address in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

addr

IPv6 Address

IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’

string

<= 1024 characters

type

string

default: NEXT_HOP_DEFAULT_GATEWAY

Allowed values: NEXT_HOP_DEFAULT_GATEWAY NEXT_HOP_USE_CONFIGURED NEXT_HOP_NETWORK_INTERFACE

subnets

Subnets

List of route prefixes

Required: YES.

Array<object>

<= 256 items

IP Subnet

IP Address used to specify an IPv4 or IPv6 subnet addresses.

object

ipv4

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

ipv6

object

plen

Prefix length

Prefix length of the IPv6 subnet. Must be <= 128.

integer format: int64

prefix

Prefix

Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”

string

<= 1024 characters

simple_static_route

Simple Static Route

Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.

string

<= 1024 characters

inside_subnet

object

existing_subnet

object

subnet_name

GCP VPC Subnet Name

Name of your subnet in VPC network Required: YES.

string

>= 1 characters <= 64 characters

new_subnet

object

primary_ipv4

IPv4 CIDR block

IPv4 prefix for this Subnet. It has to be private address space. Required: YES.

string

<= 1024 characters

subnet_name

GCP VPC Subnet Name

Name of new VPC Subnet, will be autogenerated if empty.

string

<= 64 characters

no_dc_cluster_group

object

no_forward_proxy

object

no_global_network

object

no_inside_static_routes

object

no_network_policy

object

no_outside_static_routes

object

node_number

Number of main nodes

Number of main nodes to create, either 1 or 3.

integer format: int64

outside_network

object

existing_network

object

name

GCP VPC Network Name

Name for your GCP VPC Network Required: YES.

string

>= 1 characters <= 64 characters

new_network

object

name

GCP VPC Network Name

Name for your GCP VPC Network Required: YES.

string

>= 1 characters <= 64 characters

new_network_autogenerate

object

outside_static_routes

object

static_route_list

List of Static Routes

List of Static routes

Required: YES.

Array<object>

>= 1 items <= 64 items

Site Static Route Config Modes

Different ways to configure static routes.

object

custom_static_route

object

attrs

Attributes

List of route attributes associated with the static route.

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

labels

Static Route labels

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

object

nexthop

object

interface

Network Interface

Nexthop is network interface when type is “Network-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

nexthop_address

object

ipv4

object

addr

IPv4 Address

IPv4 Address in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

addr

IPv6 Address

IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’

string

<= 1024 characters

type

string

default: NEXT_HOP_DEFAULT_GATEWAY

Allowed values: NEXT_HOP_DEFAULT_GATEWAY NEXT_HOP_USE_CONFIGURED NEXT_HOP_NETWORK_INTERFACE

subnets

Subnets

List of route prefixes

Required: YES.

Array<object>

<= 256 items

IP Subnet

IP Address used to specify an IPv4 or IPv6 subnet addresses.

object

ipv4

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

ipv6

object

plen

Prefix length

Prefix length of the IPv6 subnet. Must be <= 128.

integer format: int64

prefix

Prefix

Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”

string

<= 1024 characters

simple_static_route

Simple Static Route

Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.

string

<= 1024 characters

outside_subnet

object

existing_subnet

object

subnet_name

GCP VPC Subnet Name

Name of your subnet in VPC network Required: YES.

string

>= 1 characters <= 64 characters

new_subnet

object

primary_ipv4

IPv4 CIDR block

IPv4 prefix for this Subnet. It has to be private address space. Required: YES.

string

<= 1024 characters

subnet_name

GCP VPC Subnet Name

Name of new VPC Subnet, will be autogenerated if empty.

string

<= 64 characters

performance_enhancement_mode

object

perf_mode_l3_enhanced

object

jumbo

object

no_jumbo

object

perf_mode_l7_enhanced

object

sm_connection_public_ip

object

sm_connection_pvt_ip

object

ingress_gw

object

gcp_zone_names

GCP zones

X-required List of zones when instances will be created, needs to match with region selected. Required: YES.

Array<string>

<= 3 items

local_network

object

existing_network

object

name

GCP VPC Network Name

Name for your GCP VPC Network Required: YES.

string

>= 1 characters <= 64 characters

new_network

object

name

GCP VPC Network Name

Name for your GCP VPC Network Required: YES.

string

>= 1 characters <= 64 characters

new_network_autogenerate

object

local_subnet

object

existing_subnet

object

subnet_name

GCP VPC Subnet Name

Name of your subnet in VPC network Required: YES.

string

>= 1 characters <= 64 characters

new_subnet

object

primary_ipv4

IPv4 CIDR block

IPv4 prefix for this Subnet. It has to be private address space. Required: YES.

string

<= 1024 characters

subnet_name

GCP VPC Subnet Name

Name of new VPC Subnet, will be autogenerated if empty.

string

<= 64 characters

node_number

Number of main nodes

Number of main nodes to create, either 1 or 3.

integer format: int64

performance_enhancement_mode

object

perf_mode_l3_enhanced

object

jumbo

object

no_jumbo

object

perf_mode_l7_enhanced

object

instance_type

Select Instance size based on performance needed Required: YES.

string

<= 64 characters

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

offline_survivability_mode

object

enable_offline_survivability_mode

object

no_offline_survivability_mode

object

private_connect_disabled

object

private_connectivity

object

cloud_link

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

inside

object

outside

object

ssh_key

Public SSH key for accessing the site. Required: YES.

string

>= 1 characters <= 8192 characters

voltstack_cluster

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

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

forward_proxy_allow_all

object

gcp_zone_names

GCP zones

X-required List of zones when instances will be created, needs to match with region selected. Required: YES.

Array<string>

<= 3 items

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

k8s_cluster

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

no_dc_cluster_group

object

no_forward_proxy

object

no_global_network

object

no_k8s_cluster

object

no_network_policy

object

no_outside_static_routes

object

node_number

Number of main nodes

Number of main nodes to create, either 1 or 3.

integer format: int64

outside_static_routes

object

static_route_list

List of Static Routes

List of Static routes

Required: YES.

Array<object>

>= 1 items <= 64 items

Site Static Route Config Modes

Different ways to configure static routes.

object

custom_static_route

object

attrs

Attributes

List of route attributes associated with the static route.

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

labels

Static Route labels

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

object

nexthop

object

interface

Network Interface

Nexthop is network interface when type is “Network-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

nexthop_address

object

ipv4

object

addr

IPv4 Address

IPv4 Address in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

addr

IPv6 Address

IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’

string

<= 1024 characters

type

string

default: NEXT_HOP_DEFAULT_GATEWAY

Allowed values: NEXT_HOP_DEFAULT_GATEWAY NEXT_HOP_USE_CONFIGURED NEXT_HOP_NETWORK_INTERFACE

subnets

Subnets

List of route prefixes

Required: YES.

Array<object>

<= 256 items

IP Subnet

IP Address used to specify an IPv4 or IPv6 subnet addresses.

object

ipv4

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

ipv6

object

plen

Prefix length

Prefix length of the IPv6 subnet. Must be <= 128.

integer format: int64

prefix

Prefix

Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”

string

<= 1024 characters

simple_static_route

Simple Static Route

Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.

string

<= 1024 characters

site_local_network

object

existing_network

object

name

GCP VPC Network Name

Name for your GCP VPC Network Required: YES.

string

>= 1 characters <= 64 characters

new_network

object

name

GCP VPC Network Name

Name for your GCP VPC Network Required: YES.

string

>= 1 characters <= 64 characters

new_network_autogenerate

object

site_local_subnet

object

existing_subnet

object

subnet_name

GCP VPC Subnet Name

Name of your subnet in VPC network Required: YES.

string

>= 1 characters <= 64 characters

new_subnet

object

primary_ipv4

IPv4 CIDR block

IPv4 prefix for this Subnet. It has to be private address space. Required: YES.

string

<= 1024 characters

subnet_name

GCP VPC Subnet Name

Name of new VPC Subnet, will be autogenerated if empty.

string

<= 64 characters

sm_connection_public_ip

object

sm_connection_pvt_ip

object

Responses

200

A successful response.

Media typeapplication/json

object

Example^generated

{}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

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

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example