Avi VrfContext Object API
CLI ``` - configure vrfcontext - show vrfcontext ```
Contact Info: support@avinetworks.com
Version: 20.1.9
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /vrfcontextpost /vrfcontextdelete /vrfcontext/{uuid}get /vrfcontext/{uuid}patch /vrfcontext/{uuid}put /vrfcontext/{uuid}
(vrfcontextGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
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.
skip_default (optional)
Query Parameter — Default values are not set.
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
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"static_routes" : [ {
"route_id" : "aeiou",
"disable_gateway_monitor" : true,
"next_hop" : "",
"prefix" : "",
"if_name" : "aeiou",
"labels" : [ "" ]
} ],
"bfd_profile" : {
"mintx" : 123,
"minrx" : 123,
"multi" : 123
},
"gateway_mon" : [ {
"subnet" : "",
"gateway_monitor_fail_threshold" : 123,
"gateway_monitor_success_threshold" : 123,
"gateway_ip" : "",
"gateway_monitor_interval" : 123
} ],
"description" : "aeiou",
"debugvrfcontext" : {
"flags" : [ {
"flag" : "aeiou"
} ],
"command_buffer_interval" : 123,
"command_buffer_size" : 123
},
"lldp_enable" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"attrs" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"labels" : [ "" ],
"system_default" : true,
"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,
"label" : "aeiou",
"connect_timer" : 123,
"local_as" : 123,
"advertise_vip" : true,
"peer_ip" : "",
"subnet6" : "",
"peer_ip6" : "",
"remote_as" : 123,
"ibgp_local_as_override" : true,
"md5_secret" : "aeiou",
"network_ref" : "aeiou",
"advertise_snat_ip" : true,
"advertisement_interval" : 123,
"shutdown" : true,
"ebgp_multihop" : 123
} ],
"hold_time" : 123,
"community" : [ "aeiou" ],
"local_preference" : 123,
"local_as" : 123,
"num_as_path_prepend" : 123,
"routing_options" : [ {
"learn_routes" : true,
"advertise_default_route" : true,
"max_learn_limit" : 123,
"learn_only_default_route" : true,
"label" : "aeiou",
"advertise_learned_routes" : true
} ],
"shutdown" : true
},
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"internal_gateway_monitor" : {
"disable_gateway_monitor" : true,
"gateway_monitor_failure_threshold" : 123,
"gateway_monitor_success_threshold" : 123,
"gateway_monitor_interval" : 123
}
} ]
}
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.
Responses
200
OK
VrfContextApiResponse
401
log in failed
(vrfcontextPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VrfContext object creation
Return type
Example data
Content-Type: application/json
{
"static_routes" : [ {
"route_id" : "aeiou",
"disable_gateway_monitor" : true,
"next_hop" : "",
"prefix" : "",
"if_name" : "aeiou",
"labels" : [ "" ]
} ],
"bfd_profile" : {
"mintx" : 123,
"minrx" : 123,
"multi" : 123
},
"gateway_mon" : [ {
"subnet" : "",
"gateway_monitor_fail_threshold" : 123,
"gateway_monitor_success_threshold" : 123,
"gateway_ip" : "",
"gateway_monitor_interval" : 123
} ],
"description" : "aeiou",
"debugvrfcontext" : {
"flags" : [ {
"flag" : "aeiou"
} ],
"command_buffer_interval" : 123,
"command_buffer_size" : 123
},
"lldp_enable" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"attrs" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"labels" : [ "" ],
"system_default" : true,
"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,
"label" : "aeiou",
"connect_timer" : 123,
"local_as" : 123,
"advertise_vip" : true,
"peer_ip" : "",
"subnet6" : "",
"peer_ip6" : "",
"remote_as" : 123,
"ibgp_local_as_override" : true,
"md5_secret" : "aeiou",
"network_ref" : "aeiou",
"advertise_snat_ip" : true,
"advertisement_interval" : 123,
"shutdown" : true,
"ebgp_multihop" : 123
} ],
"hold_time" : 123,
"community" : [ "aeiou" ],
"local_preference" : 123,
"local_as" : 123,
"num_as_path_prepend" : 123,
"routing_options" : [ {
"learn_routes" : true,
"advertise_default_route" : true,
"max_learn_limit" : 123,
"learn_only_default_route" : true,
"label" : "aeiou",
"advertise_learned_routes" : true
} ],
"shutdown" : true
},
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"internal_gateway_monitor" : {
"disable_gateway_monitor" : true,
"gateway_monitor_failure_threshold" : 123,
"gateway_monitor_success_threshold" : 123,
"gateway_monitor_interval" : 123
}
}
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.
Responses
200
OK
VrfContext
401
log in failed
Up
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:
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.
Responses
204
object deleted
String
404
not found
Up
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:
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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"static_routes" : [ {
"route_id" : "aeiou",
"disable_gateway_monitor" : true,
"next_hop" : "",
"prefix" : "",
"if_name" : "aeiou",
"labels" : [ "" ]
} ],
"bfd_profile" : {
"mintx" : 123,
"minrx" : 123,
"multi" : 123
},
"gateway_mon" : [ {
"subnet" : "",
"gateway_monitor_fail_threshold" : 123,
"gateway_monitor_success_threshold" : 123,
"gateway_ip" : "",
"gateway_monitor_interval" : 123
} ],
"description" : "aeiou",
"debugvrfcontext" : {
"flags" : [ {
"flag" : "aeiou"
} ],
"command_buffer_interval" : 123,
"command_buffer_size" : 123
},
"lldp_enable" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"attrs" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"labels" : [ "" ],
"system_default" : true,
"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,
"label" : "aeiou",
"connect_timer" : 123,
"local_as" : 123,
"advertise_vip" : true,
"peer_ip" : "",
"subnet6" : "",
"peer_ip6" : "",
"remote_as" : 123,
"ibgp_local_as_override" : true,
"md5_secret" : "aeiou",
"network_ref" : "aeiou",
"advertise_snat_ip" : true,
"advertisement_interval" : 123,
"shutdown" : true,
"ebgp_multihop" : 123
} ],
"hold_time" : 123,
"community" : [ "aeiou" ],
"local_preference" : 123,
"local_as" : 123,
"num_as_path_prepend" : 123,
"routing_options" : [ {
"learn_routes" : true,
"advertise_default_route" : true,
"max_learn_limit" : 123,
"learn_only_default_route" : true,
"label" : "aeiou",
"advertise_learned_routes" : true
} ],
"shutdown" : true
},
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"internal_gateway_monitor" : {
"disable_gateway_monitor" : true,
"gateway_monitor_failure_threshold" : 123,
"gateway_monitor_success_threshold" : 123,
"gateway_monitor_interval" : 123
}
}
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.
Responses
200
OK
VrfContext
401
log in failed
Up
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:
Request body
body (required)
Body Parameter — VrfContext object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"static_routes" : [ {
"route_id" : "aeiou",
"disable_gateway_monitor" : true,
"next_hop" : "",
"prefix" : "",
"if_name" : "aeiou",
"labels" : [ "" ]
} ],
"bfd_profile" : {
"mintx" : 123,
"minrx" : 123,
"multi" : 123
},
"gateway_mon" : [ {
"subnet" : "",
"gateway_monitor_fail_threshold" : 123,
"gateway_monitor_success_threshold" : 123,
"gateway_ip" : "",
"gateway_monitor_interval" : 123
} ],
"description" : "aeiou",
"debugvrfcontext" : {
"flags" : [ {
"flag" : "aeiou"
} ],
"command_buffer_interval" : 123,
"command_buffer_size" : 123
},
"lldp_enable" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"attrs" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"labels" : [ "" ],
"system_default" : true,
"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,
"label" : "aeiou",
"connect_timer" : 123,
"local_as" : 123,
"advertise_vip" : true,
"peer_ip" : "",
"subnet6" : "",
"peer_ip6" : "",
"remote_as" : 123,
"ibgp_local_as_override" : true,
"md5_secret" : "aeiou",
"network_ref" : "aeiou",
"advertise_snat_ip" : true,
"advertisement_interval" : 123,
"shutdown" : true,
"ebgp_multihop" : 123
} ],
"hold_time" : 123,
"community" : [ "aeiou" ],
"local_preference" : 123,
"local_as" : 123,
"num_as_path_prepend" : 123,
"routing_options" : [ {
"learn_routes" : true,
"advertise_default_route" : true,
"max_learn_limit" : 123,
"learn_only_default_route" : true,
"label" : "aeiou",
"advertise_learned_routes" : true
} ],
"shutdown" : true
},
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"internal_gateway_monitor" : {
"disable_gateway_monitor" : true,
"gateway_monitor_failure_threshold" : 123,
"gateway_monitor_success_threshold" : 123,
"gateway_monitor_interval" : 123
}
}
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.
Responses
200
OK
VrfContext
401
log in failed
Up
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:
Request body
body (required)
Body Parameter — VrfContext object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"static_routes" : [ {
"route_id" : "aeiou",
"disable_gateway_monitor" : true,
"next_hop" : "",
"prefix" : "",
"if_name" : "aeiou",
"labels" : [ "" ]
} ],
"bfd_profile" : {
"mintx" : 123,
"minrx" : 123,
"multi" : 123
},
"gateway_mon" : [ {
"subnet" : "",
"gateway_monitor_fail_threshold" : 123,
"gateway_monitor_success_threshold" : 123,
"gateway_ip" : "",
"gateway_monitor_interval" : 123
} ],
"description" : "aeiou",
"debugvrfcontext" : {
"flags" : [ {
"flag" : "aeiou"
} ],
"command_buffer_interval" : 123,
"command_buffer_size" : 123
},
"lldp_enable" : true,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"attrs" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"labels" : [ "" ],
"system_default" : true,
"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,
"label" : "aeiou",
"connect_timer" : 123,
"local_as" : 123,
"advertise_vip" : true,
"peer_ip" : "",
"subnet6" : "",
"peer_ip6" : "",
"remote_as" : 123,
"ibgp_local_as_override" : true,
"md5_secret" : "aeiou",
"network_ref" : "aeiou",
"advertise_snat_ip" : true,
"advertisement_interval" : 123,
"shutdown" : true,
"ebgp_multihop" : 123
} ],
"hold_time" : 123,
"community" : [ "aeiou" ],
"local_preference" : 123,
"local_as" : 123,
"num_as_path_prepend" : 123,
"routing_options" : [ {
"learn_routes" : true,
"advertise_default_route" : true,
"max_learn_limit" : 123,
"learn_only_default_route" : true,
"label" : "aeiou",
"advertise_learned_routes" : true
} ],
"shutdown" : true
},
"cloud_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"internal_gateway_monitor" : {
"disable_gateway_monitor" : true,
"gateway_monitor_failure_threshold" : 123,
"gateway_monitor_success_threshold" : 123,
"gateway_monitor_interval" : 123
}
}
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.
Responses
200
OK
VrfContext
401
log in failed
[ Jump to Methods ]
Table of Contents
BfdProfileBgpPeerBgpProfileBgpRoutingOptionsDebugVrfDebugVrfContextGatewayMonitorInternalGatewayMonitorIpAddrIpAddrPrefixIpCommunityKeyValueRoleFilterMatchLabelStaticRouteVrfContextVrfContextApiResponse
minrx (optional)
Integer Default required minimum receive interval (in ms) used in BFD. Allowed values are 500-4000000. Field introduced in 20.1.1. Unit is MILLISECONDS. format: int32
mintx (optional)
Integer Default desired minimum transmit interval (in ms) used in BFD. Allowed values are 500-4000000. Field introduced in 20.1.1. Unit is MILLISECONDS. format: int32
multi (optional)
Integer Default detection multiplier used in BFD. Allowed values are 3-255. Field introduced in 20.1.1. format: int32
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
ibgp_local_as_override (optional)
Boolean Override the profile level local_as with the peer level remote_as. Field introduced in 20.1.6.
keepalive_interval (optional)
Integer Keepalive interval for this Peer. Allowed values are 0-3600. format: int32
label (optional)
String Label used to enable learning and/or advertisement of routes to this peer. Field introduced in 20.1.1.
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 (optional)
IpAddr IP Address of the BGP Peer.
peer_ip6 (optional)
IpAddr IPv6 Address of the BGP Peer. Field introduced in 18.1.1.
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 (optional)
subnet6 (optional)
IpAddrPrefix IPv6 subnet providing reachability for Peer. Field introduced in 18.1.1.
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. Maximum of 16 items allowed.
hold_time (optional)
Integer Hold time for Peers. Allowed values are 3-7200. format: int32
ibgp
ip_communities (optional)
array[IpCommunity] Communities per IP address range. Field introduced in 17.1.3. Maximum of 1024 items allowed.
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
local_preference (optional)
Integer LOCAL_PREF to be used for routes advertised. Applicable only over iBGP. Field introduced in 20.1.1. format: int32
num_as_path_prepend (optional)
Integer Number of times the local AS should be prepended additionally. Allowed values are 1-10. Field introduced in 20.1.1. format: int32
peers (optional)
routing_options (optional)
array[BgpRoutingOptions] Learning and advertising options for BGP peers. Field introduced in 20.1.1. Maximum of 128 items allowed.
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.
advertise_default_route (optional)
Boolean Advertise self as default router to the BGP peer. Field introduced in 20.1.1.
advertise_learned_routes (optional)
Boolean Advertise the learned routes to the BGP peer. Field introduced in 20.1.1.
label
String Features are applied to peers matching this label. Field introduced in 20.1.1.
learn_only_default_route (optional)
Boolean Learn only default route from the BGP peer. Field introduced in 20.1.1.
learn_routes (optional)
Boolean Learn routes from the BGP peer. Field introduced in 20.1.1.
max_learn_limit (optional)
Integer Maximum number of routes that can be learned from a BGP peer. Allowed values are 50-250. Field introduced in 20.1.1. format: int32
flag
String Enum options - DEBUG_VRF_BGP, DEBUG_VRF_QUAGGA, DEBUG_VRF_ALL, DEBUG_VRF_NONE. Field introduced in 17.1.1.
command_buffer_interval (optional)
Integer Vrf config command buffer process interval. Allowed values are 1-4. Field introduced in 17.2.13,18.1.5,18.2.1. Unit is SECONDS. format: int32
command_buffer_size (optional)
Integer Vrf config command buffer size. Allowed values are 1-32768. Field introduced in 17.2.13,18.1.5,18.2.1. Unit is BYTES. format: int32
flags (optional)
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. Unit is MILLISECONDS. 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 18.1.1.
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. Unit is MILLISECONDS. 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
addr
type
String Enum options - V4, DNS, V6.
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
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. Minimum of 1 items required. Maximum of 16 items allowed.
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.
key
String Key for filter match. Field introduced in 20.1.3.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3.
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.
labels (optional)
array[KeyValue] Labels associated with this route. Field introduced in 20.1.1. Maximum of 1 items allowed.
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.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
attrs (optional)
array[KeyValue] Key/value vrfcontext attributes. Field introduced in 20.1.2. Allowed in Basic edition, Essentials edition, Enterprise edition.
bfd_profile (optional)
BfdProfile BFD configuration profile. Field introduced in 20.1.1. Allowed in Basic edition, Essentials edition, Enterprise edition.
bgp_profile (optional)
cloud_ref (optional)
String It is a reference to an object of type Cloud.
debugvrfcontext (optional)
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. Maximum of 32 items allowed.
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.
labels (optional)
array[KeyValue] Key/value labels which can be used for Object Access Policy permission scoping. Field deprecated in 20.1.5. Field introduced in 18.2.7, 20.1.1.
lldp_enable (optional)
Boolean Enable LLDP. Field introduced in 18.2.10, 20.1.1. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Basic edition, Essentials edition, Enterprise edition.
name
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)
uuid (optional)
String Unique object identifier of the object.
count
results
next (optional)