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 Number of minutes to capture packets. Use 0 to capture until manually stopped. Special values are 0 - 'infinite'. format: int32
num_pkts (optional)
Integer Total number of packets to capture. format: int32
pkt_size (optional)
Integer Number of bytes of each packet to capture. Use 0 to capture the entire packet. Allowed values are 64-1514. Special values are 0 - 'full capture'. format: int32