Avi VrfContext Object API

##CLI## ``` - configure vrfcontext - show vrfcontext ```

More information: https://avinetworks.com/contact-us

Contact Info: support@avinetworks.com

Version: 17.2.4

BasePath:/api

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /vrfcontext
post /vrfcontext
delete /vrfcontext/{uuid}
get /vrfcontext/{uuid}
patch /vrfcontext/{uuid}
put /vrfcontext/{uuid}

get /vrfcontext

( vrfcontextGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

refers_to (optional)

Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid

referred_by (optional)

Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

cloud_uuid (optional)

Query Parameter — Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.

cloud_ref.name (optional)

Query Parameter — Filter to get objects that belongs to a specific cloud usings its name. This uses cloud name rather than uuid. Eg. cloud_ref.name=Default-Cloud.

Return type

VrfContextApiResponse

Example data

Content-Type: application/json

{
  "count" : 123,
  "results" : [ {
    "static_routes" : [ {
      "route_id" : "aeiou",
      "disable_gateway_monitor" : true,
      "next_hop" : "",
      "prefix" : "",
      "if_name" : "aeiou"
    } ],
    "bgp_profile" : {
      "ip_communities" : [ {
        "ip_end" : "",
        "ip_begin" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "community" : [ "aeiou" ]
      } ],
      "ibgp" : true,
      "keepalive_interval" : 123,
      "send_community" : true,
      "peers" : [ {
        "bfd" : true,
        "subnet" : {
          "ip_addr" : "",
          "mask" : 123
        },
        "keepalive_interval" : 123,
        "hold_time" : 123,
        "connect_timer" : 123,
        "local_as" : 123,
        "advertise_vip" : true,
        "peer_ip" : "",
        "remote_as" : 123,
        "md5_secret" : "aeiou",
        "network_ref" : "aeiou",
        "advertise_snat_ip" : true,
        "advertisement_interval" : 123,
        "shutdown" : true,
        "ebgp_multihop" : 123
      } ],
      "hold_time" : 123,
      "community" : [ "aeiou" ],
      "local_as" : 123,
      "shutdown" : true
    },
    "gateway_mon" : [ {
      "subnet" : "",
      "gateway_monitor_fail_threshold" : 123,
      "gateway_monitor_success_threshold" : 123,
      "gateway_ip" : "",
      "gateway_monitor_interval" : 123
    } ],
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "description" : "aeiou",
    "debugvrfcontext" : {
      "flags" : [ {
        "flag" : "aeiou"
      } ]
    },
    "internal_gateway_monitor" : {
      "disable_gateway_monitor" : true,
      "gateway_monitor_failure_threshold" : 123,
      "gateway_monitor_success_threshold" : 123,
      "gateway_monitor_interval" : 123
    },
    "uuid" : "aeiou",
    "url" : "aeiou",
    "system_default" : true
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK VrfContextApiResponse

401

post /vrfcontext

( vrfcontextPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — VrfContext object creation

Return type

VrfContext

Example data

Content-Type: application/json

{
  "static_routes" : [ {
    "route_id" : "aeiou",
    "disable_gateway_monitor" : true,
    "next_hop" : "",
    "prefix" : "",
    "if_name" : "aeiou"
  } ],
  "bgp_profile" : {
    "ip_communities" : [ {
      "ip_end" : "",
      "ip_begin" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "community" : [ "aeiou" ]
    } ],
    "ibgp" : true,
    "keepalive_interval" : 123,
    "send_community" : true,
    "peers" : [ {
      "bfd" : true,
      "subnet" : {
        "ip_addr" : "",
        "mask" : 123
      },
      "keepalive_interval" : 123,
      "hold_time" : 123,
      "connect_timer" : 123,
      "local_as" : 123,
      "advertise_vip" : true,
      "peer_ip" : "",
      "remote_as" : 123,
      "md5_secret" : "aeiou",
      "network_ref" : "aeiou",
      "advertise_snat_ip" : true,
      "advertisement_interval" : 123,
      "shutdown" : true,
      "ebgp_multihop" : 123
    } ],
    "hold_time" : 123,
    "community" : [ "aeiou" ],
    "local_as" : 123,
    "shutdown" : true
  },
  "gateway_mon" : [ {
    "subnet" : "",
    "gateway_monitor_fail_threshold" : 123,
    "gateway_monitor_success_threshold" : 123,
    "gateway_ip" : "",
    "gateway_monitor_interval" : 123
  } ],
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "debugvrfcontext" : {
    "flags" : [ {
      "flag" : "aeiou"
    } ]
  },
  "internal_gateway_monitor" : {
    "disable_gateway_monitor" : true,
    "gateway_monitor_failure_threshold" : 123,
    "gateway_monitor_success_threshold" : 123,
    "gateway_monitor_interval" : 123
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "system_default" : true
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK VrfContext

401

delete /vrfcontext/{uuid}

( vrfcontextUuidDelete)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

Return type

String

Example data

Content-Type: application/json

"aeiou"

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204

object deleted String

404

not found

get /vrfcontext/{uuid}

( vrfcontextUuidGet)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

VrfContext

Example data

Content-Type: application/json

{
  "static_routes" : [ {
    "route_id" : "aeiou",
    "disable_gateway_monitor" : true,
    "next_hop" : "",
    "prefix" : "",
    "if_name" : "aeiou"
  } ],
  "bgp_profile" : {
    "ip_communities" : [ {
      "ip_end" : "",
      "ip_begin" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "community" : [ "aeiou" ]
    } ],
    "ibgp" : true,
    "keepalive_interval" : 123,
    "send_community" : true,
    "peers" : [ {
      "bfd" : true,
      "subnet" : {
        "ip_addr" : "",
        "mask" : 123
      },
      "keepalive_interval" : 123,
      "hold_time" : 123,
      "connect_timer" : 123,
      "local_as" : 123,
      "advertise_vip" : true,
      "peer_ip" : "",
      "remote_as" : 123,
      "md5_secret" : "aeiou",
      "network_ref" : "aeiou",
      "advertise_snat_ip" : true,
      "advertisement_interval" : 123,
      "shutdown" : true,
      "ebgp_multihop" : 123
    } ],
    "hold_time" : 123,
    "community" : [ "aeiou" ],
    "local_as" : 123,
    "shutdown" : true
  },
  "gateway_mon" : [ {
    "subnet" : "",
    "gateway_monitor_fail_threshold" : 123,
    "gateway_monitor_success_threshold" : 123,
    "gateway_ip" : "",
    "gateway_monitor_interval" : 123
  } ],
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "debugvrfcontext" : {
    "flags" : [ {
      "flag" : "aeiou"
    } ]
  },
  "internal_gateway_monitor" : {
    "disable_gateway_monitor" : true,
    "gateway_monitor_failure_threshold" : 123,
    "gateway_monitor_success_threshold" : 123,
    "gateway_monitor_interval" : 123
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "system_default" : true
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK VrfContext

401

patch /vrfcontext/{uuid}

( vrfcontextUuidPatch)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — VrfContext object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

VrfContext

Example data

Content-Type: application/json

{
  "static_routes" : [ {
    "route_id" : "aeiou",
    "disable_gateway_monitor" : true,
    "next_hop" : "",
    "prefix" : "",
    "if_name" : "aeiou"
  } ],
  "bgp_profile" : {
    "ip_communities" : [ {
      "ip_end" : "",
      "ip_begin" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "community" : [ "aeiou" ]
    } ],
    "ibgp" : true,
    "keepalive_interval" : 123,
    "send_community" : true,
    "peers" : [ {
      "bfd" : true,
      "subnet" : {
        "ip_addr" : "",
        "mask" : 123
      },
      "keepalive_interval" : 123,
      "hold_time" : 123,
      "connect_timer" : 123,
      "local_as" : 123,
      "advertise_vip" : true,
      "peer_ip" : "",
      "remote_as" : 123,
      "md5_secret" : "aeiou",
      "network_ref" : "aeiou",
      "advertise_snat_ip" : true,
      "advertisement_interval" : 123,
      "shutdown" : true,
      "ebgp_multihop" : 123
    } ],
    "hold_time" : 123,
    "community" : [ "aeiou" ],
    "local_as" : 123,
    "shutdown" : true
  },
  "gateway_mon" : [ {
    "subnet" : "",
    "gateway_monitor_fail_threshold" : 123,
    "gateway_monitor_success_threshold" : 123,
    "gateway_ip" : "",
    "gateway_monitor_interval" : 123
  } ],
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "debugvrfcontext" : {
    "flags" : [ {
      "flag" : "aeiou"
    } ]
  },
  "internal_gateway_monitor" : {
    "disable_gateway_monitor" : true,
    "gateway_monitor_failure_threshold" : 123,
    "gateway_monitor_success_threshold" : 123,
    "gateway_monitor_interval" : 123
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "system_default" : true
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK VrfContext

401

put /vrfcontext/{uuid}

( vrfcontextUuidPut)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — VrfContext object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

VrfContext

Example data

Content-Type: application/json

{
  "static_routes" : [ {
    "route_id" : "aeiou",
    "disable_gateway_monitor" : true,
    "next_hop" : "",
    "prefix" : "",
    "if_name" : "aeiou"
  } ],
  "bgp_profile" : {
    "ip_communities" : [ {
      "ip_end" : "",
      "ip_begin" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "community" : [ "aeiou" ]
    } ],
    "ibgp" : true,
    "keepalive_interval" : 123,
    "send_community" : true,
    "peers" : [ {
      "bfd" : true,
      "subnet" : {
        "ip_addr" : "",
        "mask" : 123
      },
      "keepalive_interval" : 123,
      "hold_time" : 123,
      "connect_timer" : 123,
      "local_as" : 123,
      "advertise_vip" : true,
      "peer_ip" : "",
      "remote_as" : 123,
      "md5_secret" : "aeiou",
      "network_ref" : "aeiou",
      "advertise_snat_ip" : true,
      "advertisement_interval" : 123,
      "shutdown" : true,
      "ebgp_multihop" : 123
    } ],
    "hold_time" : 123,
    "community" : [ "aeiou" ],
    "local_as" : 123,
    "shutdown" : true
  },
  "gateway_mon" : [ {
    "subnet" : "",
    "gateway_monitor_fail_threshold" : 123,
    "gateway_monitor_success_threshold" : 123,
    "gateway_ip" : "",
    "gateway_monitor_interval" : 123
  } ],
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "debugvrfcontext" : {
    "flags" : [ {
      "flag" : "aeiou"
    } ]
  },
  "internal_gateway_monitor" : {
    "disable_gateway_monitor" : true,
    "gateway_monitor_failure_threshold" : 123,
    "gateway_monitor_success_threshold" : 123,
    "gateway_monitor_interval" : 123
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "system_default" : true
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK VrfContext

401

Models

[ Jump to Methods ]

BgpPeer
BgpProfile
DebugVrf
DebugVrfContext
GatewayMonitor
InternalGatewayMonitor
IpAddr
IpAddrPrefix
IpCommunity
StaticRoute
VrfContext
VrfContextApiResponse

BgpPeer Up

advertise_snat_ip (optional)

Boolean Advertise SNAT IP to this Peer.

advertise_vip (optional)

Boolean Advertise VIP to this Peer.

advertisement_interval (optional)

Integer Advertisement interval for this Peer. Allowed values are 1-60. format: int32

bfd (optional)

Boolean Enable Bi-Directional Forward Detection. Only async mode supported.

connect_timer (optional)

Integer Connect timer for this Peer. Allowed values are 1-120. format: int32

ebgp_multihop (optional)

Integer TTL for multihop ebgp Peer. Allowed values are 0-255. Field introduced in 17.1.3. format: int32

hold_time (optional)

Integer Hold time for this Peer. Allowed values are 3-7200. format: int32

keepalive_interval (optional)

Integer Keepalive interval for this Peer. Allowed values are 0-3600. format: int32

local_as (optional)

Integer Local AS to use for this ebgp peer. If specified, this will override the local AS configured at the VRF level. Allowed values are 1-4294967295. Field introduced in 17.1.6,17.2.2. format: int32

md5_secret (optional)

String Peer Autonomous System Md5 Digest Secret Key.

network_ref (optional)

String Network providing reachability for Peer. It is a reference to an object of type Network.

peer_ip

IpAddr IP Address of the BGP Peer.

remote_as (optional)

Integer Peer Autonomous System ID. Allowed values are 1-4294967295. format: int32

shutdown (optional)

Boolean Shutdown the bgp peer. Field introduced in 17.2.4.

subnet

IpAddrPrefix Subnet providing reachability for Peer.

BgpProfile Up

community (optional)

array[String] Community string either in aa nn format where aa, nn is within [1,65535] or local-AS|no-advertise|no-export|internet. Field introduced in 17.1.2.

hold_time (optional)

Integer Hold time for Peers. Allowed values are 3-7200. format: int32

ibgp

Boolean BGP peer type.

ip_communities (optional)

array[IpCommunity] Communities per IP address range. Field introduced in 17.1.3.

keepalive_interval (optional)

Integer Keepalive interval for Peers. Allowed values are 0-3600. format: int32

local_as

Integer Local Autonomous System ID. Allowed values are 1-4294967295. format: int32

peers (optional)

array[BgpPeer] BGP Peers.

send_community (optional)

Boolean Send community attribute to all peers. Field introduced in 17.1.2.

shutdown (optional)

Boolean Shutdown the bgp. Field introduced in 17.2.4.

DebugVrf Up

flag

String Enum options - DEBUG_VRF_BGP, DEBUG_VRF_ALL, DEBUG_VRF_NONE. Field introduced in 17.1.1.

DebugVrfContext Up

flags (optional)

array[DebugVrf] Field introduced in 17.1.1.

GatewayMonitor Up

gateway_ip

IpAddr IP address of next hop gateway to be monitored.

gateway_monitor_fail_threshold (optional)

Integer The number of consecutive failed gateway health checks before a gateway is marked down. Allowed values are 3-50. format: int32

gateway_monitor_interval (optional)

Integer The interval between two ping requests sent by the gateway monitor in milliseconds. If a value is not specified, requests are sent every second. Allowed values are 100-60000. format: int32

gateway_monitor_success_threshold (optional)

Integer The number of consecutive successful gateway health checks before a gateway that was marked down by the gateway monitor is marked up. Allowed values are 3-50. format: int32

subnet (optional)

IpAddrPrefix Subnet providing reachability for Multi-hop Gateway. Field introduced in 17.2.3.

InternalGatewayMonitor Up

disable_gateway_monitor (optional)

Boolean Disable the gateway monitor for default gateway. They are monitored by default. Field introduced in 17.1.1.

gateway_monitor_failure_threshold (optional)

Integer The number of consecutive failed gateway health checks before a gateway is marked down. Allowed values are 3-50. Field introduced in 17.1.1. format: int32

gateway_monitor_interval (optional)

Integer The interval between two ping requests sent by the gateway monitor in milliseconds. If a value is not specified, requests are sent every second. Allowed values are 100-60000. Field introduced in 17.1.1. format: int32

gateway_monitor_success_threshold (optional)

Integer The number of consecutive successful gateway health checks before a gateway that was marked down by the gateway monitor is marked up. Allowed values are 3-50. Field introduced in 17.1.1. format: int32

IpAddr Up

addr

String IP address.

type

String Enum options - V4, DNS.

IpAddrPrefix Up

ip_addr

IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object

mask

Integer Number of mask. format: int32

IpCommunity Up

community (optional)

array[String] Community string either in aa nn format where aa, nn is within [1,65535] or local-AS|no-advertise|no-export|internet. Field introduced in 17.1.3.

ip_begin

IpAddr Beginning of IP address range. Field introduced in 17.1.3.

ip_end (optional)

IpAddr End of IP address range. Optional if ip_begin is the only IP address in specified IP range. Field introduced in 17.1.3.

StaticRoute Up

disable_gateway_monitor (optional)

Boolean Disable the gateway monitor for default gateway. They are monitored by default. Field introduced in 17.1.1.

if_name (optional)

String if_name of StaticRoute.

next_hop

IpAddr Placeholder for description of property next_hop of obj type StaticRoute field type str type object

prefix

IpAddrPrefix Placeholder for description of property prefix of obj type StaticRoute field type str type object

route_id

String route_id of StaticRoute.

VrfContext Up

bgp_profile (optional)

BgpProfile Bgp Local and Peer Info.

cloud_ref (optional)

String It is a reference to an object of type Cloud.

debugvrfcontext (optional)

DebugVrfContext Configure debug flags for VRF. Field introduced in 17.1.1.

description (optional)

String User defined description for the object.

gateway_mon (optional)

array[GatewayMonitor] Configure ping based heartbeat check for gateway in service engines of vrf.

internal_gateway_monitor (optional)

InternalGatewayMonitor Configure ping based heartbeat check for all default gateways in service engines of vrf. Field introduced in 17.1.1.

name

String Name of the object.

static_routes (optional)

array[StaticRoute] Placeholder for description of property static_routes of obj type VrfContext field type str type object

system_default (optional)

Boolean Placeholder for description of property system_default of obj type VrfContext field type str type boolean

tenant_ref (optional)

String It is a reference to an object of type Tenant.

url (optional)

String url

uuid (optional)

String Unique object identifier of the object.

VrfContextApiResponse Up

count

Integer format: int32

results

array[VrfContext]

Avi VrfContext Object API

Access

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

204

404

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Table of Contents