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.
This API call produces the following media types according to the
Accept request header; the media type will be conveyed by the
Content-Type response header.
This API call produces the following media types according to the
Accept request header; the media type will be conveyed by the
Content-Type response header.
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
Accept request header; the media type will be conveyed by the
Content-Type response header.
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.
This API call produces the following media types according to the
Accept request header; the media type will be conveyed by the
Content-Type response header.
This API call produces the following media types according to the
Accept request header; the media type will be conveyed by the
Content-Type response header.
This API call produces the following media types according to the
Accept request header; the media type will be conveyed by the
Content-Type response header.
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.
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
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.
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
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.