Orchestration v2 Attributes for Route

The following sample JSON shows the required attributes of the Route object type. A description of each of the required and optional attributes of this object type is provided in the table that follows the JSON sample.

       {
                    "name": "/Compute-acme/joe/route1",
                    "nextHopVnicSet": "/Compute-acme/joe/vnicset1",
                    "ipAddressPrefix": "192.168.0.0/16"
       }
Parameter Required or Optional Description

name

required

The three-part name of the object (/Compute-identity_domain/user/object).

Object names can contain only alphanumeric characters, hyphens, underscores, and periods. Object names are case-sensitive.

When you specify the object name, ensure that an object of the same type and with the same name doesn’t already exist. If such an object already exists, another object of the same type and with the same name won’t be created and the existing object won’t be updated.

ipAddressPrefix

required

The IP address prefix, in CIDR format, of the destination network that you want to specify the route to.

nextHopVnicSet

required

The vNICset that you want to use to route packets to the destination network. When a vNICset containing multiple vNICs is used in a route, Equal Cost Multipath (ECMP) anycast routing is implemented. Traffic routed by that route is load balanced across all the vNICs in the vNICset. Using vNICsets with multiple vNICs also ensures high availability for traffic across the specified vNICs.

adminDistance

optional

The route’s administrative distance. Specify 0 (the default), 1, or 2.

The administrative distance indicates the priority of a route. The highest priority is 0. The route with the highest priority is used. If multiple routes have the highest priority, all those routes are used.

description

optional

Description of the route.

tags

optional

Strings that you can use to tag the route.