-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathDnsPolicy.yaml
878 lines (873 loc) · 48.7 KB
/
DnsPolicy.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
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
# 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 DnsPolicy Object API
contact:
name: Avi Networks Inc.
url: https://avinetworks.com/contact-us
email: [email protected]
description: |
CLI
```
- configure dnspolicy <key>
- show dnspolicy <key>
```
securityDefinitions:
basicAuth:
type: basic
description: basic authentication
basePath: /api
paths:
/dnspolicy:
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.
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/DnsPolicyApiResponse"
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: DnsPolicy object creation
required: true
schema:
$ref: "#/definitions/DnsPolicy"
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/DnsPolicy"
401:
description: log in failed
/dnspolicy/{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/DnsPolicy"
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: DnsPolicy object creation
required: true
schema:
$ref: "#/definitions/DnsPolicy"
- in: path
name: uuid
description: UUID of the object to fetch
required: true
type: string
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/DnsPolicy"
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: DnsPolicy object creation
required: true
schema:
$ref: "#/definitions/DnsPolicy"
- in: path
name: uuid
description: UUID of the object to fetch
required: true
type: string
security:
- basicAuth: []
responses:
200:
description: OK
schema:
$ref: "#/definitions/DnsPolicy"
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:
ConfigPbAttributes:
type: object
properties:
version:
description: "Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition."
type: integer
default: 1
format: uint32
DnsAAAARdata:
type: object
required:
- ip6_address
properties:
ip6_address:
description: "IPv6 address for FQDN. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/IpAddr'
DnsARdata:
type: object
required:
- ip_address
properties:
ip_address:
description: "IP address for FQDN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/IpAddr'
DnsClientIpMatch:
type: object
required:
- client_ip
properties:
client_ip:
description: "IP addresses to match against client IP. Field introduced in 17.1.6,17.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/IpAddrMatch'
use_edns_client_subnet_ip:
description: "Use the IP address from the EDNS client subnet option, if available, as the source IP address of the client. It should be noted that the edns subnet IP may not be a /32 IP address. Field introduced in 17.1.6,17.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
default: True
DnsClientPortMatch:
type: object
required:
- client_ports
properties:
client_ports:
description: "Port number to match against client port number in request. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/PortMatchGeneric'
DnsCnameRdata:
type: object
required:
- cname
properties:
cname:
description: "Canonical name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
DnsGeoLocationMatch:
type: object
required:
- match_criteria
properties:
geolocation_name:
description: "Geographical location of the client IP to be used in the match. This location is of the format Country/State/City e.g. US/CA/Santa Clara. Field introduced in 17.1.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
geolocation_tag:
description: "Geolocation tag for the client IP. This could be any string value for the client IP, e.g. client IPs from US East Coast geolocation would be tagged as 'East Coast'. Field introduced in 17.1.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
match_criteria:
description: "Criterion to use for matching the client IP's geographical location. Enum options - IS_IN, IS_NOT_IN. Field introduced in 17.1.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
use_edns_client_subnet_ip:
description: "Use the IP address from the EDNS client subnet option, if available, to derive geo location of the DNS query. Field introduced in 17.1.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
default: True
DnsNsRdata:
type: object
required:
- nsname
properties:
ip6_address:
description: "IPv6 address for Name Server. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/IpAddr'
ip_address:
description: "IP address for Name Server. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/IpAddr'
nsname:
description: "Name Server name. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
DnsPolicy:
type: object
required:
- name
properties:
_last_modified:
description: "UNIX time since epoch in microseconds. Units(MICROSECONDS)."
readOnly: True
type: string
configpb_attributes:
description: "Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/ConfigPbAttributes'
created_by:
description: "Creator name. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
description:
description: " Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
internal:
description: "The DNS policy is created and modified by internal modules only. This should not be modified by users. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: boolean
markers:
description: "List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/RoleFilterMatchLabel'
name:
description: "Name of the DNS Policy. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
rule:
description: "DNS rules. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/DnsRule'
tenant_ref:
description: " It is a reference to an object of type Tenant. Field introduced in 17.1.1. 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: "UUID of the DNS Policy. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
DnsPolicyApiResponse:
type: object
required:
- count
- results
properties:
count:
type: integer
format: int32
results:
type: array
items:
$ref: "#/definitions/DnsPolicy"
next:
type: string
DnsQueryNameMatch:
type: object
required:
- match_criteria
properties:
match_criteria:
description: "Criterion to use for string matching the DNS query domain name in the question section. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL), Basic edition(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL), Enterprise with Cloud Services edition."
type: string
query_domain_names:
description: "Domain name to match against that specified in the question section of the DNS query. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
type: string
string_group_refs:
description: "UUID of the string group(s) for matching against DNS query domain name in the question section. It is a reference to an object of type StringGroup. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
type: string
DnsQueryTypeMatch:
type: object
required:
- match_criteria
properties:
match_criteria:
description: "Criterion to use for matching the DNS query typein the question section. Enum options - IS_IN, IS_NOT_IN. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
query_type:
description: "DNS query types in the request query . Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
type: string
DnsRateLimiter:
type: object
required:
- action
- rate_limiter_object
properties:
action:
description: "Action to perform upon rate limiting. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsRuleRLAction'
rate_limiter_object:
description: "Rate limiting object. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/RateLimiter'
DnsRrSet:
type: object
required:
- fqdn
- ttl
- type
properties:
cname:
description: "Canonical name in CNAME record. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsCnameRdata'
fqdn:
description: "Fully Qualified Domain Name. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
ip6_addresses:
description: "IPv6 address in AAAA record. Field introduced in 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/DnsAAAARdata'
ip_addresses:
description: "IP address in A record. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/DnsARdata'
nses:
description: "Name Server information in NS record. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/DnsNsRdata'
ttl:
description: "Time To Live for this DNS record. Allowed values are 0-2147483647. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: integer
format: uint32
type:
description: "DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
DnsRule:
type: object
required:
- index
- name
properties:
action:
description: "Action to be performed upon successful matching. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsRuleAction'
enable:
description: "Enable or disable the rule. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
default: True
index:
description: "Index of the rule. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: integer
format: int32
log:
description: "Log DNS query upon rule match. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
match:
description: "Add match criteria to the rule. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsRuleMatchTarget'
name:
description: "Name of the rule. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
DnsRuleAction:
type: object
properties:
allow:
description: "Allow or drop the DNS query. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsRuleActionAllowDrop'
dns_rate_limiter:
description: "Rate limits the DNS requests. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsRateLimiter'
gs_group_selection:
description: "GSLB Service group to be selected. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsRuleActionGsGroupSelection'
gslb_site_selection:
description: "Select a specific GSLB site for the DNS query. This action should be used only when GSLB services have been configured for the DNS virtual service. Field introduced in 17.1.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsRuleActionGslbSiteSelection'
pool_switching:
description: "Select a pool or pool group for the passthrough DNS query which cannot be served locally but could be served by upstream servers. Field introduced in 18.1.3, 17.2.12. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsRuleActionPoolSwitching'
response:
description: "Generate a response for the DNS query. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsRuleActionResponse'
DnsRuleActionAllowDrop:
type: object
properties:
allow:
description: "Allow the DNS query. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
default: True
reset_conn:
description: "Reset the TCP connection of the DNS query, if allow is set to false to drop the query. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
default: True
DnsRuleActionGsGroupSelection:
type: object
required:
- group_name
properties:
group_name:
description: "GSLB Service group name. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
DnsRuleActionGslbSiteSelection:
type: object
required:
- site_name
properties:
fallback_site_names:
description: "GSLB fallback sites to use in case the desired site is down. Field introduced in 17.2.5. Maximum of 64 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
type: string
is_site_preferred:
description: "When set to true, GSLB site is a preferred site. This setting comes into play when the site is down, as well as no configured fallback site is available (all fallback sites are also down), then any one available site is selected based on the default algorithm for GSLB pool member selection. Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
default: True
site_name:
description: "GSLB site name. Field introduced in 17.1.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
DnsRuleActionPoolSwitching:
type: object
properties:
pool_group_ref:
description: "Reference of the pool group to serve the passthrough DNS query which cannot be served locally. It is a reference to an object of type PoolGroup. Field introduced in 18.1.3, 17.2.12. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
pool_ref:
description: "Reference of the pool to serve the passthrough DNS query which cannot be served locally. It is a reference to an object of type Pool. Field introduced in 18.1.3, 17.2.12. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
DnsRuleActionResponse:
type: object
properties:
authoritative:
description: "DNS response is authoritative. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
default: True
rcode:
description: "DNS response code. Enum options - DNS_RCODE_NOERROR, DNS_RCODE_FORMERR, DNS_RCODE_SERVFAIL, DNS_RCODE_NXDOMAIN, DNS_RCODE_NOTIMP, DNS_RCODE_REFUSED, DNS_RCODE_YXDOMAIN, DNS_RCODE_YXRRSET, DNS_RCODE_NXRRSET, DNS_RCODE_NOTAUTH, DNS_RCODE_NOTZONE. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
default: "DNS_RCODE_NOERROR"
resource_record_sets:
description: "DNS resource record sets - (resource record set share the DNS domain name, type, and class). Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/DnsRuleDnsRrSet'
truncation:
description: "DNS response is truncated. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: boolean
DnsRuleDnsRrSet:
type: object
required:
- resource_record_set
properties:
resource_record_set:
description: "DNS resource record set - (records in the resource record set share the DNS domain name, type, and class). Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsRrSet'
section:
description: "DNS message section for the resource record set. Enum options - DNS_MESSAGE_SECTION_QUESTION, DNS_MESSAGE_SECTION_ANSWER, DNS_MESSAGE_SECTION_AUTHORITY, DNS_MESSAGE_SECTION_ADDITIONAL. Field introduced in 17.2.12, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
default: "DNS_MESSAGE_SECTION_ANSWER"
DnsRuleMatchTarget:
type: object
properties:
client_ip_address:
description: "IP addresses to match against client IP or the EDNS client subnet IP. Field introduced in 17.1.6,17.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsClientIpMatch'
client_port_numbers:
description: "Port number to match against client port number. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsClientPortMatch'
geo_location:
description: "Geographical location attribute to match against that of the client IP. Field introduced in 17.1.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsGeoLocationMatch'
protocol:
description: "DNS transport protocol match. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsTransportProtocolMatch'
query_name:
description: "Domain names to match against query name. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsQueryNameMatch'
query_type:
description: "DNS query types to match against request query type. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
$ref: '#/definitions/DnsQueryTypeMatch'
DnsRuleRLAction:
type: object
properties:
type:
description: "Type of action to be enforced upon hitting the rate limit. Enum options - DNS_RL_ACTION_NONE, DNS_RL_ACTION_DROP_REQ. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
default: "DNS_RL_ACTION_NONE"
DnsTransportProtocolMatch:
type: object
required:
- match_criteria
- protocol
properties:
match_criteria:
description: "Criterion to use for matching the DNS transport protocol. Enum options - IS_IN, IS_NOT_IN. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
protocol:
description: "Protocol to match against transport protocol used by DNS query. Enum options - DNS_OVER_UDP, DNS_OVER_TCP. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
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
IpAddrMatch:
type: object
required:
- match_criteria
properties:
addrs:
description: "IP address(es). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/IpAddr'
group_refs:
description: "UUID of IP address group(s). It is a reference to an object of type IpAddrGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
type: string
match_criteria:
description: "Criterion to use for IP address matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
prefixes:
description: "IP address prefix(es). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/IpAddrPrefix'
ranges:
description: "IP address range(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/IpAddrRange'
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'
KeyValue:
type: object
required:
- key
properties:
key:
description: "Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
value:
description: "Value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
PortMatchGeneric:
type: object
required:
- match_criteria
properties:
match_criteria:
description: "Criterion to use for src/dest port in a TCP/UDP packet. Enum options - IS_IN, IS_NOT_IN. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
ports:
description: "Listening TCP port(s). Allowed values are 1-65535. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: array
items:
type: integer
format: uint32
ranges:
description: "A port range defined by a start and end, including both. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: array
items:
$ref: '#/definitions/PortRange'
PortRange:
type: object
required:
- end
- start
properties:
end:
description: "TCP/UDP port range end (inclusive). Allowed values are 1-65535. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: integer
format: uint32
start:
description: "TCP/UDP port range start (inclusive). Allowed values are 1-65535. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: integer
format: uint32
RateLimiter:
type: object
required:
- count
- period
properties:
burst_sz:
description: "Maximum number of connections, requests or packets to be let through instantaneously. If this is less than count, it will have no effect. Allowed values are 0-1000000000. Field introduced in 18.2.9. Allowed in Enterprise edition with any value, Basic edition(Allowed values- 0), Essentials, Enterprise with Cloud Services edition."
type: integer
format: uint32
count:
description: "Maximum number of connections, requests or packets permitted each period. Allowed values are 1-1000000000. Field introduced in 18.2.9. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: integer
default: 1000000000
format: uint32
name:
description: "Identifier for Rate Limit. Constructed according to context. Field introduced in 18.2.9. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition."
type: string
period:
description: "Time value in seconds to enforce rate count. Allowed values are 1-1000000000. Field introduced in 18.2.9. Unit is SEC. Allowed in Enterprise edition with any value, Basic edition(Allowed values- 1), Essentials, Enterprise with Cloud Services edition."
type: integer
default: 1
format: uint32
RoleFilterMatchLabel:
type: object
required:
- key
properties:
key:
description: "Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: string
values:
description: "Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition."
type: array
items:
type: string