Avi DebugVirtualService Object API
CLI ``` - debug virtualservice - show debug virtualservice ```
Contact Info: support@avinetworks.com
Version: 21.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /debugvirtualservicepost /debugvirtualservicedelete /debugvirtualservice/{uuid}get /debugvirtualservice/{uuid}patch /debugvirtualservice/{uuid}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.
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" : [ {
"capture_params" : {
"duration" : 123,
"file_count" : 123,
"pcap_ng" : true,
"enable_ssl_session_key_capture" : true,
"pkt_size" : 123,
"num_pkts" : 123,
"capture_file_size" : {
"percentage_size" : 123,
"absolute_size" : 123
}
},
"latency_audit_filters" : "",
"flags" : [ {
"flag" : "aeiou"
} ],
"objsync" : {
"trigger_initial_sync" : true
},
"capture" : true,
"capture_filters" : {
"src_port" : 123,
"ip_proto" : "aeiou",
"tcp_ack" : true,
"tcp_syn" : true,
"tcp_fin" : true,
"src_port_range_end" : 123,
"dst_port_start" : 123,
"tcp_push" : true,
"capture_ip" : {
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"capture_ipc" : {
"flow_del_probe" : true,
"flow_mirror_del" : true,
"ipc_tx_res" : true,
"ipc_tx_req" : true,
"vs_hb" : true,
"flow_probe" : true,
"ipc_batched" : true,
"ipc_rx_req" : true,
"flow_mirror_add" : true,
"flow_mirror_all" : true,
"flow_probe_all" : true,
"ipc_rx_res" : true
},
"dst_port_end" : 123,
"eth_proto" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"dns_options" : {
"domain_name" : [ "aeiou" ],
"gslb_service_name" : [ "aeiou" ]
},
"debug_ip" : "",
"cloud_ref" : "aeiou",
"debug_hm" : "aeiou",
"resync_flows" : true,
"tenant_ref" : "aeiou",
"name" : "aeiou",
"se_params" : {
"se_refs" : [ "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
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
Example data
Content-Type: application/json
{
"capture_params" : {
"duration" : 123,
"file_count" : 123,
"pcap_ng" : true,
"enable_ssl_session_key_capture" : true,
"pkt_size" : 123,
"num_pkts" : 123,
"capture_file_size" : {
"percentage_size" : 123,
"absolute_size" : 123
}
},
"latency_audit_filters" : "",
"flags" : [ {
"flag" : "aeiou"
} ],
"objsync" : {
"trigger_initial_sync" : true
},
"capture" : true,
"capture_filters" : {
"src_port" : 123,
"ip_proto" : "aeiou",
"tcp_ack" : true,
"tcp_syn" : true,
"tcp_fin" : true,
"src_port_range_end" : 123,
"dst_port_start" : 123,
"tcp_push" : true,
"capture_ip" : {
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"capture_ipc" : {
"flow_del_probe" : true,
"flow_mirror_del" : true,
"ipc_tx_res" : true,
"ipc_tx_req" : true,
"vs_hb" : true,
"flow_probe" : true,
"ipc_batched" : true,
"ipc_rx_req" : true,
"flow_mirror_add" : true,
"flow_mirror_all" : true,
"flow_probe_all" : true,
"ipc_rx_res" : true
},
"dst_port_end" : 123,
"eth_proto" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"dns_options" : {
"domain_name" : [ "aeiou" ],
"gslb_service_name" : [ "aeiou" ]
},
"debug_ip" : "",
"cloud_ref" : "aeiou",
"debug_hm" : "aeiou",
"resync_flows" : true,
"tenant_ref" : "aeiou",
"name" : "aeiou",
"se_params" : {
"se_refs" : [ "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
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 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.
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
{
"capture_params" : {
"duration" : 123,
"file_count" : 123,
"pcap_ng" : true,
"enable_ssl_session_key_capture" : true,
"pkt_size" : 123,
"num_pkts" : 123,
"capture_file_size" : {
"percentage_size" : 123,
"absolute_size" : 123
}
},
"latency_audit_filters" : "",
"flags" : [ {
"flag" : "aeiou"
} ],
"objsync" : {
"trigger_initial_sync" : true
},
"capture" : true,
"capture_filters" : {
"src_port" : 123,
"ip_proto" : "aeiou",
"tcp_ack" : true,
"tcp_syn" : true,
"tcp_fin" : true,
"src_port_range_end" : 123,
"dst_port_start" : 123,
"tcp_push" : true,
"capture_ip" : {
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"capture_ipc" : {
"flow_del_probe" : true,
"flow_mirror_del" : true,
"ipc_tx_res" : true,
"ipc_tx_req" : true,
"vs_hb" : true,
"flow_probe" : true,
"ipc_batched" : true,
"ipc_rx_req" : true,
"flow_mirror_add" : true,
"flow_mirror_all" : true,
"flow_probe_all" : true,
"ipc_rx_res" : true
},
"dst_port_end" : 123,
"eth_proto" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"dns_options" : {
"domain_name" : [ "aeiou" ],
"gslb_service_name" : [ "aeiou" ]
},
"debug_ip" : "",
"cloud_ref" : "aeiou",
"debug_hm" : "aeiou",
"resync_flows" : true,
"tenant_ref" : "aeiou",
"name" : "aeiou",
"se_params" : {
"se_refs" : [ "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
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
Example data
Content-Type: application/json
{
"capture_params" : {
"duration" : 123,
"file_count" : 123,
"pcap_ng" : true,
"enable_ssl_session_key_capture" : true,
"pkt_size" : 123,
"num_pkts" : 123,
"capture_file_size" : {
"percentage_size" : 123,
"absolute_size" : 123
}
},
"latency_audit_filters" : "",
"flags" : [ {
"flag" : "aeiou"
} ],
"objsync" : {
"trigger_initial_sync" : true
},
"capture" : true,
"capture_filters" : {
"src_port" : 123,
"ip_proto" : "aeiou",
"tcp_ack" : true,
"tcp_syn" : true,
"tcp_fin" : true,
"src_port_range_end" : 123,
"dst_port_start" : 123,
"tcp_push" : true,
"capture_ip" : {
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"capture_ipc" : {
"flow_del_probe" : true,
"flow_mirror_del" : true,
"ipc_tx_res" : true,
"ipc_tx_req" : true,
"vs_hb" : true,
"flow_probe" : true,
"ipc_batched" : true,
"ipc_rx_req" : true,
"flow_mirror_add" : true,
"flow_mirror_all" : true,
"flow_probe_all" : true,
"ipc_rx_res" : true
},
"dst_port_end" : 123,
"eth_proto" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"dns_options" : {
"domain_name" : [ "aeiou" ],
"gslb_service_name" : [ "aeiou" ]
},
"debug_ip" : "",
"cloud_ref" : "aeiou",
"debug_hm" : "aeiou",
"resync_flows" : true,
"tenant_ref" : "aeiou",
"name" : "aeiou",
"se_params" : {
"se_refs" : [ "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
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
Example data
Content-Type: application/json
{
"capture_params" : {
"duration" : 123,
"file_count" : 123,
"pcap_ng" : true,
"enable_ssl_session_key_capture" : true,
"pkt_size" : 123,
"num_pkts" : 123,
"capture_file_size" : {
"percentage_size" : 123,
"absolute_size" : 123
}
},
"latency_audit_filters" : "",
"flags" : [ {
"flag" : "aeiou"
} ],
"objsync" : {
"trigger_initial_sync" : true
},
"capture" : true,
"capture_filters" : {
"src_port" : 123,
"ip_proto" : "aeiou",
"tcp_ack" : true,
"tcp_syn" : true,
"tcp_fin" : true,
"src_port_range_end" : 123,
"dst_port_start" : 123,
"tcp_push" : true,
"capture_ip" : {
"prefixes" : [ {
"ip_addr" : "",
"mask" : 123
} ],
"ranges" : [ {
"end" : "",
"begin" : ""
} ],
"addrs" : [ {
"addr" : "aeiou",
"type" : "aeiou"
} ]
},
"capture_ipc" : {
"flow_del_probe" : true,
"flow_mirror_del" : true,
"ipc_tx_res" : true,
"ipc_tx_req" : true,
"vs_hb" : true,
"flow_probe" : true,
"ipc_batched" : true,
"ipc_rx_req" : true,
"flow_mirror_add" : true,
"flow_mirror_all" : true,
"flow_probe_all" : true,
"ipc_rx_res" : true
},
"dst_port_end" : 123,
"eth_proto" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"dns_options" : {
"domain_name" : [ "aeiou" ],
"gslb_service_name" : [ "aeiou" ]
},
"debug_ip" : "",
"cloud_ref" : "aeiou",
"debug_hm" : "aeiou",
"resync_flows" : true,
"tenant_ref" : "aeiou",
"name" : "aeiou",
"se_params" : {
"se_refs" : [ "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
200
OK
DebugVirtualService
401
log in failed
[ Jump to Methods ]
Table of Contents
CaptureFileSizeCaptureFiltersCaptureIPCDebugDnsOptionsDebugIpAddrDebugVirtualServiceDebugVirtualServiceApiResponseDebugVirtualServiceCaptureDebugVirtualServiceObjSyncDebugVirtualServiceSeParamsDebugVsDataplaneIpAddrIpAddrPrefixIpAddrRange
absolute_size (optional)
Integer Maximum size in MB. Set 0 for avi default size. Allowed values are 100-512000. Special values are 0 - AVI_DEFAULT. Field introduced in 18.2.8. Unit is MB. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
percentage_size (optional)
Integer Limits capture to percentage of free disk space. Set 0 for avi default size. Allowed values are 0-75. Field introduced in 18.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
capture_ip (optional)
DebugIpAddr Per packet IP filter. Matches with source and destination address. Curently not applicable for DebugServiceEngine. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
capture_ipc (optional)
CaptureIPC Capture filter for SE IPC. Not applicable for Debug Virtual Service. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dst_port_end (optional)
Integer Destination Port range filter. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
dst_port_start (optional)
Integer Destination Port range filter. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
eth_proto (optional)
String Ethernet Proto filter. Enum options - ETH_TYPE_IPV4. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_proto (optional)
String IP Proto filter. Support for TCP only for now. Enum options - IP_TYPE_TCP. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
src_port (optional)
Integer Source Port filter. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
src_port_range_end (optional)
Integer Source Port range end filter. If specified, the source port filter will be a range. The filter range will be between src_port and src_port_range_end. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
tcp_ack (optional)
Boolean TCP ACK flag filter. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tcp_fin (optional)
Boolean TCP FIN flag filter. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tcp_push (optional)
Boolean TCP PUSH flag filter. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tcp_syn (optional)
Boolean TCP SYN flag filter. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
flow_del_probe (optional)
Boolean Flow del probe filter for SE IPC. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
flow_mirror_add (optional)
Boolean Flow mirror add filter for SE IPC. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
flow_mirror_all (optional)
Boolean Filter for all flow mirror SE IPC. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
flow_mirror_del (optional)
Boolean Flow mirror del filter for SE IPC. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
flow_probe (optional)
Boolean Flow probe filter for SE IPC. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
flow_probe_all (optional)
Boolean Filter for all flow probe SE IPC. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipc_batched (optional)
Boolean IPC batched filter for SE IPC. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipc_rx_req (optional)
Boolean Filter for incoming IPC request. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipc_rx_res (optional)
Boolean Filter for incoming IPC response. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipc_tx_req (optional)
Boolean Filter for outgoing IPC request. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ipc_tx_res (optional)
Boolean Filter for outgoing IPC response. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vs_hb (optional)
Boolean Vs heart beat filter for SE IPC. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
domain_name (optional)
array[String] This field filters the FQDN for Dns debug. Field introduced in 18.2.1. Maximum of 1 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
gslb_service_name (optional)
array[String] This field filters the Gslb service for Dns debug. Field introduced in 18.2.1. Maximum of 1 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
addrs (optional)
array[IpAddr] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
prefixes (optional)
array[IpAddrPrefix] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ranges (optional)
array[IpAddrRange] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
capture (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
capture_filters (optional)
CaptureFilters Per packet capture filters for Debug Virtual Service. Applies to both frontend and backend packets. Field introduced in 18.2.7. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
capture_params (optional)
DebugVirtualServiceCapture Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cloud_ref (optional)
String It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
debug_ip (optional)
DebugIpAddr Filters all packets of a complete transaction (client and server side), based on client ip. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dns_options (optional)
DebugDnsOptions Dns debug options. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
flags (optional)
array[DebugVsDataplane] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
latency_audit_filters (optional)
CaptureFilters Filters for latency audit. Supported only for ingress. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
objsync (optional)
DebugVirtualServiceObjSync Object sync debug options. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
resync_flows (optional)
Boolean This option re-synchronizes flows between Active-Standby service engines for all the virtual services placed on them. It should be used with caution because as it can cause a flood between Active-Standby. Field introduced in 18.1.3,18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
se_params (optional)
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)
capture_file_size (optional)
CaptureFileSize Maximum allowed size of PCAP Capture File per SE. Max(absolute_size, percentage_size) will be final value. Set both to 0 for avi default size. DOS, IPC and DROP pcaps not applicaple. Field introduced in 18.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
duration (optional)
Integer Number of minutes to capture packets. Use 0 to capture until manually stopped. Special values are 0 - infinite. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
enable_ssl_session_key_capture (optional)
Boolean Enable SSL session key capture. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
file_count (optional)
Integer Number of files to maintain for SE pcap file rotation.file count set to 1 indicates no rotate. Allowed values are 1-10. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
num_pkts (optional)
Integer Total number of packets to capture. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
pcap_ng (optional)
Boolean Enable PcapNg for packet capture. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Unit is BYTES. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
trigger_initial_sync (optional)
Boolean Triggers Initial Sync on all the SEs of this VS. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
se_refs (optional)
array[String] It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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_DNS, DEBUG_VS_PAA, DEBUG_VS_AUTH, DEBUG_VS_BOT, DEBUG_VS_ALL, DEBUG_VS_ERROR, DEBUG_VS_NONE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
addr
String IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_addr
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mask
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
begin
IpAddr Starting IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
end
IpAddr Ending IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.