Avi DebugVirtualService Object API

##CLI## ``` - debug virtualservice - show debug virtualservice ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /debugvirtualservice
  2. post /debugvirtualservice
  3. delete /debugvirtualservice/{uuid}
  4. get /debugvirtualservice/{uuid}
  5. patch /debugvirtualservice/{uuid}
  6. put /debugvirtualservice/{uuid}
Up
get /debugvirtualservice
(debugvirtualserviceGet)

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.
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

DebugVirtualServiceApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "capture_params" : {
      "duration" : 123,
      "pkt_size" : 123,
      "num_pkts" : 123
    },
    "debug_ip" : {
      "prefixes" : [ {
        "ip_addr" : "",
        "mask" : 123
      } ],
      "ranges" : [ {
        "end" : "",
        "begin" : ""
      } ],
      "addrs" : [ {
        "addr" : "aeiou",
        "type" : "aeiou"
      } ]
    },
    "cloud_ref" : "aeiou",
    "debug_hm" : "aeiou",
    "tenant_ref" : "aeiou",
    "flags" : [ {
      "flag" : "aeiou"
    } ],
    "name" : "aeiou",
    "capture" : true,
    "se_params" : {
      "se_refs" : [ "aeiou" ]
    },
    "uuid" : "aeiou",
    "url" : "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.

Responses

200

OK DebugVirtualServiceApiResponse

401

log in failed

Up
post /debugvirtualservice
(debugvirtualservicePost)

Consumes

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

Request body

body (required)
Body Parameter — DebugVirtualService object creation

Return type

DebugVirtualService

Example data

Content-Type: application/json
{
  "capture_params" : {
    "duration" : 123,
    "pkt_size" : 123,
    "num_pkts" : 123
  },
  "debug_ip" : {
    "prefixes" : [ {
      "ip_addr" : "",
      "mask" : 123
    } ],
    "ranges" : [ {
      "end" : "",
      "begin" : ""
    } ],
    "addrs" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ]
  },
  "cloud_ref" : "aeiou",
  "debug_hm" : "aeiou",
  "tenant_ref" : "aeiou",
  "flags" : [ {
    "flag" : "aeiou"
  } ],
  "name" : "aeiou",
  "capture" : true,
  "se_params" : {
    "se_refs" : [ "aeiou" ]
  },
  "uuid" : "aeiou",
  "url" : "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.

Responses

200

OK DebugVirtualService

401

log in failed

Up
delete /debugvirtualservice/{uuid}
(debugvirtualserviceUuidDelete)

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /debugvirtualservice/{uuid}
(debugvirtualserviceUuidGet)

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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

DebugVirtualService

Example data

Content-Type: application/json
{
  "capture_params" : {
    "duration" : 123,
    "pkt_size" : 123,
    "num_pkts" : 123
  },
  "debug_ip" : {
    "prefixes" : [ {
      "ip_addr" : "",
      "mask" : 123
    } ],
    "ranges" : [ {
      "end" : "",
      "begin" : ""
    } ],
    "addrs" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ]
  },
  "cloud_ref" : "aeiou",
  "debug_hm" : "aeiou",
  "tenant_ref" : "aeiou",
  "flags" : [ {
    "flag" : "aeiou"
  } ],
  "name" : "aeiou",
  "capture" : true,
  "se_params" : {
    "se_refs" : [ "aeiou" ]
  },
  "uuid" : "aeiou",
  "url" : "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.

Responses

200

OK DebugVirtualService

401

log in failed

Up
patch /debugvirtualservice/{uuid}
(debugvirtualserviceUuidPatch)

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 — DebugVirtualService object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

DebugVirtualService

Example data

Content-Type: application/json
{
  "capture_params" : {
    "duration" : 123,
    "pkt_size" : 123,
    "num_pkts" : 123
  },
  "debug_ip" : {
    "prefixes" : [ {
      "ip_addr" : "",
      "mask" : 123
    } ],
    "ranges" : [ {
      "end" : "",
      "begin" : ""
    } ],
    "addrs" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ]
  },
  "cloud_ref" : "aeiou",
  "debug_hm" : "aeiou",
  "tenant_ref" : "aeiou",
  "flags" : [ {
    "flag" : "aeiou"
  } ],
  "name" : "aeiou",
  "capture" : true,
  "se_params" : {
    "se_refs" : [ "aeiou" ]
  },
  "uuid" : "aeiou",
  "url" : "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.

Responses

200

OK DebugVirtualService

401

log in failed

Up
put /debugvirtualservice/{uuid}
(debugvirtualserviceUuidPut)

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 — DebugVirtualService object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

DebugVirtualService

Example data

Content-Type: application/json
{
  "capture_params" : {
    "duration" : 123,
    "pkt_size" : 123,
    "num_pkts" : 123
  },
  "debug_ip" : {
    "prefixes" : [ {
      "ip_addr" : "",
      "mask" : 123
    } ],
    "ranges" : [ {
      "end" : "",
      "begin" : ""
    } ],
    "addrs" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ]
  },
  "cloud_ref" : "aeiou",
  "debug_hm" : "aeiou",
  "tenant_ref" : "aeiou",
  "flags" : [ {
    "flag" : "aeiou"
  } ],
  "name" : "aeiou",
  "capture" : true,
  "se_params" : {
    "se_refs" : [ "aeiou" ]
  },
  "uuid" : "aeiou",
  "url" : "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.

Responses

200

OK DebugVirtualService

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. DebugIpAddr
  2. DebugVirtualService
  3. DebugVirtualServiceApiResponse
  4. DebugVirtualServiceCapture
  5. DebugVirtualServiceSeParams
  6. DebugVsDataplane
  7. IpAddr
  8. IpAddrPrefix
  9. IpAddrRange

DebugIpAddr Up

addrs (optional)
array[IpAddr] Placeholder for description of property addrs of obj type DebugIpAddr field type str type object
prefixes (optional)
array[IpAddrPrefix] Placeholder for description of property prefixes of obj type DebugIpAddr field type str type object
ranges (optional)
array[IpAddrRange] Placeholder for description of property ranges of obj type DebugIpAddr field type str type object

DebugVirtualService Up

capture (optional)
Boolean Placeholder for description of property capture of obj type DebugVirtualService field type str type boolean
capture_params (optional)
DebugVirtualServiceCapture Placeholder for description of property capture_params of obj type DebugVirtualService field type str type object
cloud_ref (optional)
String It is a reference to an object of type Cloud.
debug_hm (optional)
String This option controls the capture of Health Monitor flows. Enum options - DEBUG_VS_HM_NONE, DEBUG_VS_HM_ONLY, DEBUG_VS_HM_INCLUDE.
debug_ip (optional)
DebugIpAddr Placeholder for description of property debug_ip of obj type DebugVirtualService field type str type object
flags (optional)
array[DebugVsDataplane] Placeholder for description of property flags of obj type DebugVirtualService field type str type object
name
String Name of the object.
se_params (optional)
DebugVirtualServiceSeParams Placeholder for description of property se_params of obj type DebugVirtualService field type str type object
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.

DebugVirtualServiceApiResponse Up

count
Integer format: int32
results

DebugVirtualServiceCapture Up

duration (optional)
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

DebugVirtualServiceSeParams Up

se_refs (optional)
array[String] It is a reference to an object of type ServiceEngine.

DebugVsDataplane Up

flag
String Enum options - DEBUG_VS_TCP_CONNECTION, DEBUG_VS_TCP_PKT, DEBUG_VS_TCP_APP, DEBUG_VS_TCP_APP_PKT, DEBUG_VS_TCP_RETRANSMIT, DEBUG_VS_TCP_TIMER, DEBUG_VS_TCP_CONN_ERROR, DEBUG_VS_TCP_PKT_ERROR, DEBUG_VS_TCP_REXMT, DEBUG_VS_TCP_ALL, DEBUG_VS_CREDIT, DEBUG_VS_PROXY_CONNECTION, DEBUG_VS_PROXY_PKT, DEBUG_VS_PROXY_ERR, DEBUG_VS_UDP, DEBUG_VS_UDP_PKT, DEBUG_VS_HM, DEBUG_VS_HM_ERR, DEBUG_VS_HM_PKT, DEBUG_VS_HTTP_CORE, DEBUG_VS_HTTP_ALL, DEBUG_VS_CONFIG, DEBUG_VS_EVENTS, DEBUG_VS_HTTP_RULES, DEBUG_VS_HM_EXT, DEBUG_VS_SSL, DEBUG_VS_WAF, DEBUG_VS_ALL, DEBUG_VS_ERROR, DEBUG_VS_NONE.

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

IpAddrRange Up

begin
IpAddr Starting IP address of the range.
end
IpAddr Ending IP address of the range.