Show Simplified Routes.

POST

/api/operate/namespaces/{namespace}/sites/{site}/ver/simplified_routes

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/operate/namespaces/example/sites/example/ver/simplified_routes \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "all_nodes": {}, "family": "INET4", "global_network": "example", "namespace": "example", "node": "example", "prefix": { "prefix": [ "example" ] }, "segment": "example", "site": "example", "sli": {}, "slo": {} }'

• F5 Distributed Cloud Console

Show user-friendly VER routes matching the request.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace for which the request is sent (system)

site

required

string

Site Name Name of the site for which request is sent.

Request Body^required

Media typeapplication/json

SimplifiedRoute Request

Request to GET list of VER routes matching the request.

object

all_nodes

object

family

string

default: INET4

Allowed values: INET4 INET6

global_network

Global Network Name

Exclusive with [segment sli slo] Name of the Global Network for which routes are required.

string

<= 1024 characters

namespace

Namespace

Namespace for which the request is sent (system)

string

>= 6 characters <= 1024 characters

node

Node Name

Exclusive with [all_nodes] Fetch routes from this node.

string

>= 1 characters <= 64 characters

prefix

object

prefix

Prefix

IP Address prefix in string format. String must contain both prefix and prefix-length.

Array<string>

<= 256 items

segment

Segment name

Exclusive with [global_network sli slo] Name of Segment for which routes are required.

string

<= 1024 characters

site

Site Name

Name of the site for which request is sent.

string

<= 1024 characters

sli

object

slo

object

Responses

200

A successful response.

Media typeapplication/json

Route Response

List of routes from ver instances in the site.

object

ver_routes

Ver Routes

Routes from ver instance.

Array<object>

Simplified Routes

Matching routes from VER.

object

node

Ver Hostname

Host name of VER instance.

string

<= 1024 characters

route

Route Info

Route information.

Array<object>

Simplified Route Information

Simplified Route information.

object

ecmp

object

members

Nexthop Members

Member nexthops of the ECMP type nexthop.

Array<object>

NexthopType

Information about the nexthop based on type.

object

drop

object

local

object

interface

Interface

X-dsiplayName: “Interface Name” Interface on which the packet goes out on, or interface which created the nexthop.

string

<= 1024 characters

subnet

object

intf_name

Interface name

Resolve on this interface.

string

<= 1024 characters

tunnel

object

gre

object

interface

GRE Tunnel Interface

Interface over which GRE tunnel is created.

string

<= 1024 characters

ip_in_ip

object

intermediate_hop

Via Information

Entity via which packet is routed to final destination.

Array<object>

Via Information Type

Type of entity via which packet is routed to final destination.

object

dcg

object

site_ip

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

site_name

DC Cluster Site Name

Destination site name in the DC Cluster.

string

<= 1024 characters

gre

object

site_ip

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

site_name

GRE Site Name

Destination site name for the GRE tunnel.

string

<= 1024 characters

ipsec

object

site_ip

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

site_name

IPSec Site Name

Destination site name for the IPsec tunnel.

string

<= 1024 characters

node

Via node

Exclusive with [dcg GRE IPsec SSL] Name of node.

string

<= 1024 characters

ssl

object

site_ip

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

site_name

SSL Site Name

Destination site name for the SSL tunnel.

string

<= 1024 characters

ip_in_udp

object

intermediate_hop

Via Information

Entity via which packet is routed to final destination.

Array<object>

Via Information Type

Type of entity via which packet is routed to final destination.

object

dcg

object

site_ip

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

site_name

DC Cluster Site Name

Destination site name in the DC Cluster.

string

<= 1024 characters

gre

object

site_ip

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

site_name

GRE Site Name

Destination site name for the GRE tunnel.

string

<= 1024 characters

ipsec

object

site_ip

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

site_name

IPSec Site Name

Destination site name for the IPsec tunnel.

string

<= 1024 characters

node

Via node

Exclusive with [dcg GRE IPsec SSL] Name of node.

string

<= 1024 characters

ssl

object

site_ip

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

site_name

SSL Site Name

Destination site name for the SSL tunnel.

string

<= 1024 characters

ipsec

object

interface

IPSec Tunnel Interface

Interface over which IPsec tunnel is created.

string

<= 1024 characters

mpls

object

intermediate_hop

Via Information

Entity via which packet is routed to final destination.

Array<object>

Via Information Type

Type of entity via which packet is routed to final destination.

object

dcg

object

site_ip

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

site_name

DC Cluster Site Name

Destination site name in the DC Cluster.

string

<= 1024 characters

gre

object

site_ip

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

site_name

GRE Site Name

Destination site name for the GRE tunnel.

string

<= 1024 characters

ipsec

object

site_ip

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

site_name

IPSec Site Name

Destination site name for the IPsec tunnel.

string

<= 1024 characters

node

Via node

Exclusive with [dcg GRE IPsec SSL] Name of node.

string

<= 1024 characters

ssl

object

site_ip

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

site_name

SSL Site Name

Destination site name for the SSL tunnel.

string

<= 1024 characters

remote_ip

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

remote_site

Remote Site

Site name for the final destination.

string

<= 1024 characters

ssl

object

interface

SSL Tunnel Interface

Interface over which SSL tunnel is created.

string

<= 1024 characters

flags

Flags

Route Flags.

Array<string>

nexthop

object

drop

object

local

object

interface

Interface

X-dsiplayName: “Interface Name” Interface on which the packet goes out on, or interface which created the nexthop.

string

<= 1024 characters

subnet

object

intf_name

Interface name

Resolve on this interface.

string

<= 1024 characters

tunnel

object

gre

object

interface

GRE Tunnel Interface

Interface over which GRE tunnel is created.

string

<= 1024 characters

ip_in_ip

object

intermediate_hop

Via Information

Entity via which packet is routed to final destination.

Array<object>

Via Information Type

Type of entity via which packet is routed to final destination.

object

dcg

object

site_ip

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

site_name

DC Cluster Site Name

Destination site name in the DC Cluster.

string

<= 1024 characters

gre

object

site_ip

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

site_name

GRE Site Name

Destination site name for the GRE tunnel.

string

<= 1024 characters

ipsec

object

site_ip

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

site_name

IPSec Site Name

Destination site name for the IPsec tunnel.

string

<= 1024 characters

node

Via node

Exclusive with [dcg GRE IPsec SSL] Name of node.

string

<= 1024 characters

ssl

object

site_ip

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

site_name

SSL Site Name

Destination site name for the SSL tunnel.

string

<= 1024 characters

ip_in_udp

object

intermediate_hop

Via Information

Entity via which packet is routed to final destination.

Array<object>

Via Information Type

Type of entity via which packet is routed to final destination.

object

dcg

object

site_ip

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

site_name

DC Cluster Site Name

Destination site name in the DC Cluster.

string

<= 1024 characters

gre

object

site_ip

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

site_name

GRE Site Name

Destination site name for the GRE tunnel.

string

<= 1024 characters

ipsec

object

site_ip

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

site_name

IPSec Site Name

Destination site name for the IPsec tunnel.

string

<= 1024 characters

node

Via node

Exclusive with [dcg GRE IPsec SSL] Name of node.

string

<= 1024 characters

ssl

object

site_ip

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

site_name

SSL Site Name

Destination site name for the SSL tunnel.

string

<= 1024 characters

ipsec

object

interface

IPSec Tunnel Interface

Interface over which IPsec tunnel is created.

string

<= 1024 characters

mpls

object

intermediate_hop

Via Information

Entity via which packet is routed to final destination.

Array<object>

Via Information Type

Type of entity via which packet is routed to final destination.

object

dcg

object

site_ip

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

site_name

DC Cluster Site Name

Destination site name in the DC Cluster.

string

<= 1024 characters

gre

object

site_ip

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

site_name

GRE Site Name

Destination site name for the GRE tunnel.

string

<= 1024 characters

ipsec

object

site_ip

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

site_name

IPSec Site Name

Destination site name for the IPsec tunnel.

string

<= 1024 characters

node

Via node

Exclusive with [dcg GRE IPsec SSL] Name of node.

string

<= 1024 characters

ssl

object

site_ip

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

site_name

SSL Site Name

Destination site name for the SSL tunnel.

string

<= 1024 characters

remote_ip

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

remote_site

Remote Site

Site name for the final destination.

string

<= 1024 characters

ssl

object

interface

SSL Tunnel Interface

Interface over which SSL tunnel is created.

string

<= 1024 characters

prefix

Prefix

Route prefix.

string

<= 1024 characters

route_type

string

default: REMOTE_SITE_ROUTE

Allowed values: REMOTE_SITE_ROUTE LOCAL_ROUTE STATIC_ROUTE BGP_ROUTE

Example

{
  "ver_routes": [
    {
      "route": [
        {
          "route_type": "REMOTE_SITE_ROUTE"
        }
      ]
    }
  ]
}

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