-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathDebugVirtualService.yaml
792 lines (787 loc) · 44.1 KB
/
DebugVirtualService.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
# Copyright 2021 VMware, Inc.
# SPDX-License-Identifier: Apache License 2.0
# GENERATED FILE - DO NOT EDIT THIS FILE
---
swagger: '2.0'
info:
version: '31.1.1'
title: Avi DebugVirtualService Object API
contact:
name: Avi Networks Inc.
url: https://avinetworks.com/contact-us
email: [email protected]
description: |
CLI
```
- debug virtualservice <key>
- show debug virtualservice <key>
```
securityDefinitions:
basicAuth:
type: basic
description: basic authentication
basePath: /api
paths:
/debugvirtualservice:
get:
consumes:
- application/json
produces:
- application/json
parameters:
- name: name
in: query
description: object name
required: false
type: string
- name: refers_to
in: query
description: 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
type: string
- name: referred_by
in: query
description: 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
type: string
- name: fields
in: query
description: List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
type: string
- name: include_name
in: query
description: 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.
required: false
type: boolean
- name: skip_default
in: query
description: Default values are not set.
required: false
type: boolean
- name: join_subresources
in: query
description: It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
type: string
- name: X-Avi-Tenant
in: header
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- name: cloud_uuid
in: query
description: Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.
type: string
- name: cloud_ref.name
in: query
description: 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.
type: string
- name: cloud_ref.uuid
in: query
description: Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_ref.uuid=cloud_uuid.
type: string
required: false
- name: name.contains
in: query
description: Filter to get objects with name that contains the parameter. This is a case sensitive search. Eg. name.contains=pool-.
type: string
required: false
- name: name.icontains
in: query
description: Filter to get objects with name that contains the parameter. This is a case insensitive search. Eg. name.icontains=pool-.
type: string
required: false
- name: name.in
in: query
description: Filter to get objects that have a uuid matching any of the values in the parameter list. Each value for this parameter is to comma separated. Eg. name.in=pool-1,pool-12.
type: string
required: false
- name: uuid.in
in: query
description: Filter to get objects that have a uuid matching any of the values in the parameter list. Each value for this parameter is to comma separated. Eg. uuid.in=<uuid-1>,<uuid-2>.
type: string
required: false
- name: search
in: query
description: Filter to get objects that contains the search string as value for any of its fields. Eg. search=LEAST_CONN. The search filter can also be used to search under a specific field. This is achieved by sending the parameter as ?search=(<field>,<value>)|(<field>,<value>). Eg. search=(name,vs-pool-).
type: string
required: false
- name: isearch
in: query
description: Filter to get objects that contains case insensitive search string. Eg. isearch=(name,Vs-Pool-).
type: string
required: false
- name: limit_by
in: query
description: Filter to limit the number of objects in the response data. Eg. limit_by=3.
type: string
required: false
- name: exclude
in: query
description: Filter to exclude the uuid(s) contained in the parameter. Eg. uuid.in=<uuid-1>,<uuid-2>&exclude=uuid.in.
type: string
required: false
- name: sort
in: query
description: Parameter to sort the results with respect to a field. Eg. sort=name.
type: string
required: false
- name: page_size
in: query
description: Parameter to specify the maximum number of results to be returned per page. The page_size can range from 1 to 200. Eg. page_size=5.
type: string
required: false
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/DebugVirtualServiceApiResponse"
401:
description: log in failed
post:
consumes:
- application/json
produces:
- application/json
parameters:
- name: X-Avi-Tenant
in: header
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- in: body
name: body
description: DebugVirtualService object creation
required: true
schema:
$ref: "#/definitions/DebugVirtualService"
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/DebugVirtualService"
401:
description: log in failed
/debugvirtualservice/{uuid}:
get:
consumes:
- application/json
produces:
- application/json
parameters:
- name: name
in: query
description: object name
required: false
type: string
- name: X-Avi-Tenant
in: header
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- name: uuid
in: path
description: UUID of the object to fetch
required: true
type: string
- name: fields
in: query
description: List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
type: string
- name: include_name
in: query
description: 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.
required: false
type: boolean
- name: skip_default
in: query
description: Default values are not set.
required: false
type: boolean
- name: join_subresources
in: query
description: It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
type: string
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/DebugVirtualService"
401:
description: log in failed
put:
consumes:
- application/json
produces:
- application/json
parameters:
- in: query
name: name
description: object name
required: false
type: string
- in: header
name: X-Avi-Tenant
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- in: body
name: body
description: DebugVirtualService object creation
required: true
schema:
$ref: "#/definitions/DebugVirtualService"
- in: path
name: uuid
description: UUID of the object to fetch
required: true
type: string
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/DebugVirtualService"
401:
description: log in failed
patch:
consumes:
- application/json
produces:
- application/json
parameters:
- in: query
name: name
description: object name
required: false
type: string
- in: header
name: X-Avi-Tenant
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- in: body
name: body
description: DebugVirtualService object creation
required: true
schema:
$ref: "#/definitions/DebugVirtualService"
- in: path
name: uuid
description: UUID of the object to fetch
required: true
type: string
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/DebugVirtualService"
401:
description: log in failed
delete:
consumes:
- application/json
produces:
- application/json
parameters:
- in: query
name: name
description: object name
required: false
type: string
- in: header
name: X-Avi-Tenant
type: string
required: false
description: Avi Tenant Header
- name: X-Avi-Tenant-UUID
in: header
type: string
required: false
description: Avi Tenant Header UUID
- name: X-Avi-Version
in: header
type: string
required: true
description: The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
- name: X-CSRFToken
in: header
type: string
required: false
description: Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
- in: path
name: uuid
description: UUID of the object to fetch
required: true
type: string
security:
- basicAuth: []
responses:
204:
description: object deleted
schema:
type: string
404:
description: not found
definitions:
CaptureFileSize:
type: object
properties:
absolute_size:
description: "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."
type: integer
format: uint32
percentage_size:
description: "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."
type: integer
format: uint32
CaptureFilters:
type: object
properties:
capture_ip:
description: "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."
$ref: '#/definitions/DebugIpAddr'
capture_ipc:
description: "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."
$ref: '#/definitions/CaptureIPC'
dst_port_end:
description: "Destination Port range filter. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: integer
format: uint32
dst_port_start:
description: "Destination Port range filter. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: integer
format: uint32
eth_proto:
description: "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."
type: string
ip_proto:
description: "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."
type: string
src_port:
description: "Source Port filter. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: integer
format: uint32
src_port_range_end:
description: "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."
type: integer
format: uint32
tcp_ack:
description: "TCP ACK flag filter. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
tcp_fin:
description: "TCP FIN flag filter. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
tcp_push:
description: "TCP PUSH flag filter. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
tcp_syn:
description: "TCP SYN flag filter. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
CaptureIPC:
type: object
properties:
flow_del_probe:
description: "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."
type: boolean
flow_mirror_add:
description: "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."
type: boolean
flow_mirror_all:
description: "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."
type: boolean
flow_mirror_del:
description: "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."
type: boolean
flow_probe:
description: "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."
type: boolean
flow_probe_all:
description: "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."
type: boolean
ipc_batched:
description: "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."
type: boolean
ipc_rx_req:
description: "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."
type: boolean
ipc_rx_res:
description: "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."
type: boolean
ipc_tx_req:
description: "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."
type: boolean
ipc_tx_res:
description: "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."
type: boolean
vs_hb:
description: "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."
type: boolean
CapturePacketFilter:
type: object
properties:
capture_tcp_filters:
description: "TCP Params filter. And'ed internally and Or'ed amongst each other. . Field introduced in 30.2.1. Maximum of 20 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/CaptureTCPFilter'
CaptureTCPFilter:
type: object
properties:
dst_port_range:
description: "Destination Port range filter. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/DestinationPortAddr'
eth_proto:
description: "Ethernet Proto filter. Enum options - ETH_TYPE_IPV4. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
default: "ETH_TYPE_IPV4"
host_ip:
description: "Per packet IP filter for Service Engine PCAP. Matches with source and destination address. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/DebugIpAddr'
src_port_range:
description: "Source Port range filter. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/SourcePortAddr'
tcpflag:
description: "TCP flags filter. Or'ed internally and And'ed amongst each other. . Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/CaptureTCPFlags'
CaptureTCPFlags:
type: object
properties:
filter_op:
description: "Logical operation based filter criteria. Enum options - OR, AND. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
default: "OR"
match_operation:
description: "Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
default: "IS_IN"
tcp_ack:
description: "TCP ACK flag filter. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
tcp_fin:
description: "TCP FIN flag filter. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
tcp_push:
description: "TCP PUSH flag filter. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
tcp_rst:
description: "TCP RST flag filter. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
tcp_syn:
description: "TCP SYN flag filter. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
DebugDnsOptions:
type: object
properties:
domain_name:
description: "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."
type: array
items:
type: string
gslb_service_name:
description: "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."
type: array
items:
type: string
DebugIpAddr:
type: object
properties:
addrs:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/IpAddr'
match_operation:
description: "Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
default: "IS_IN"
prefixes:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/IpAddrPrefix'
ranges:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/IpAddrRange'
DebugVirtualService:
type: object
required:
- name
properties:
_last_modified:
description: "UNIX time since epoch in microseconds. Units(MICROSECONDS)."
readOnly: True
type: string
capture:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
capture_filters:
description: "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."
$ref: '#/definitions/CaptureFilters'
capture_params:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DebugVirtualServiceCapture'
capture_pkt_filter:
description: "Per packet capture filters for Debug Virtual Service. Applies to both frontend and backend packets. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/CapturePacketFilter'
cloud_ref:
description: " It is a reference to an object of type Cloud. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
debug_hm:
description: "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."
type: string
default: "DEBUG_VS_HM_NONE"
debug_ip:
description: "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."
$ref: '#/definitions/DebugIpAddr'
dns_options:
description: "Dns debug options. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DebugDnsOptions'
flags:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/DebugVsDataplane'
latency_audit_filters:
description: "Deprecated in 22.1.1. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/CaptureFilters'
name:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
objsync:
description: "Object sync debug options. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/DebugVirtualServiceObjSync'
resync_flows:
description: "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."
type: boolean
se_params:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DebugVirtualServiceSeParams'
tenant_ref:
description: " It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
url:
description: "url"
readOnly: True
type: string
uuid:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
DebugVirtualServiceApiResponse:
type: object
required:
- count
- results
properties:
count:
type: integer
format: int32
results:
type: array
items:
$ref: "#/definitions/DebugVirtualService"
next:
type: string
DebugVirtualServiceCapture:
type: object
properties:
capture_file_size:
description: "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."
$ref: '#/definitions/CaptureFileSize'
duration:
description: "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."
type: integer
format: uint32
enable_ssl_session_key_capture:
description: "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."
type: boolean
file_count:
description: "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."
type: integer
default: 2
format: uint32
num_pkts:
description: "Total number of packets to capture. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: integer
format: uint32
pcap_ng:
description: "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."
type: boolean
default: True
pkt_size:
description: "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."
type: integer
default: 128
format: uint32
DebugVirtualServiceObjSync:
type: object
properties:
trigger_initial_sync:
description: "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."
type: boolean
DebugVirtualServiceSeParams:
type: object
properties:
se_refs:
description: " It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
type: string
DebugVsDataplane:
type: object
required:
- flag
properties:
flag:
description: " 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_DATASCRIPT, DEBUG_VS_LBACTION, DEBUG_VS_CONTENT_REWRITE, DEBUG_VS_CONNPOOL, DEBUG_VS_WAF_MEMORY, DEBUG_VS_SCTP_PKT, DEBUG_VS_SCTP_PKT_DETAIL, DEBUG_VS_ALL, DEBUG_VS_ERROR, DEBUG_VS_NONE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
DestinationPortAddr:
type: object
properties:
dst_port_end:
description: "TCP/UDP port range end (inclusive). Allowed values are 1-65535. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: integer
format: uint32
dst_port_start:
description: "TCP/UDP port range start (inclusive). Allowed values are 1-65535. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: integer
format: uint32
match_operation:
description: "Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
default: "IS_IN"
IpAddr:
type: object
required:
- addr
- type
properties:
addr:
description: "IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
type:
description: " Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
IpAddrPrefix:
type: object
required:
- ip_addr
- mask
properties:
ip_addr:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/IpAddr'
mask:
description: " Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: integer
format: int32
IpAddrRange:
type: object
required:
- begin
- end
properties:
begin:
description: "Starting IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/IpAddr'
end:
description: "Ending IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/IpAddr'
SourcePortAddr:
type: object
properties:
match_operation:
description: "Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
default: "IS_IN"
src_port_end:
description: "TCP/UDP port range end (inclusive). Allowed values are 1-65535. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: integer
format: uint32
src_port_start:
description: "TCP/UDP port range start (inclusive). Allowed values are 1-65535. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: integer
format: uint32