-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathSTONEWORK-CONFIG.jsonschema
3405 lines (3405 loc) · 182 KB
/
STONEWORK-CONFIG.jsonschema
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
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"linuxConfig": {
"properties": {
"RuleChainList": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"name": {
"type": "string",
"description": "logical name of the rule chain across all configured\nrule chains (mandatory)"
},
"namespace": {
"$ref": "ligato.linux.namespace.NetNamespace",
"additionalProperties": true,
"description": "network namespace in which this rule chain is applied"
},
"interfaces": {
"items": {
"type": "string"
},
"type": "array",
"description": "list of interfaces referred by the rules (optional)"
},
"protocol": {
"enum": [
"IPV4",
0,
"IPV6",
1
],
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
],
"description": "protocol (address family) of the rule chain"
},
"table": {
"enum": [
"FILTER",
0,
"NAT",
1,
"MANGLE",
2,
"RAW",
3,
"SECURITY",
4
],
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
],
"description": "table the rule chain belongs to"
},
"chainType": {
"enum": [
"CUSTOM",
0,
"INPUT",
1,
"OUTPUT",
2,
"FORWARD",
3,
"PREROUTING",
4,
"POSTROUTING",
5
],
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
],
"description": "type of the chain"
},
"chainName": {
"type": "string",
"description": "name of the chain, used only for chains with CUSTOM chain_type"
},
"defaultPolicy": {
"enum": [
"NONE",
0,
"ACCEPT",
1,
"DROP",
2,
"QUEUE",
3,
"RETURN",
4
],
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
],
"description": "default policy of the chain. Used for FILTER tables only."
},
"rules": {
"items": {
"type": "string"
},
"type": "array",
"description": "ordered list of strings containing the match and action part of\nthe rules, e.g. \"-i eth0 -s 192.168.0.1 -j ACCEPT\""
}
},
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
"arpEntries": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"interface": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"hwAddress": {
"type": "string"
}
},
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
"interfaces": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"name": {
"type": "string",
"description": "Name is mandatory field representing logical name for the interface.\n It must be unique across all configured interfaces."
},
"type": {
"enum": [
"UNDEFINED",
0,
"VETH",
1,
"TAP_TO_VPP",
2,
"LOOPBACK",
3,
"EXISTING",
4,
"VRF_DEVICE",
5,
"DUMMY",
6
],
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
],
"description": "Type represents the type of interface and It must match with actual Link."
},
"namespace": {
"$ref": "ligato.linux.namespace.NetNamespace",
"additionalProperties": true,
"description": "Namespace is a reference to a Linux network namespace where the interface\n should be put into."
},
"hostIfName": {
"type": "string",
"description": "Name of the interface in the host OS. If not set, the host name will be\n the same as the interface logical name."
},
"enabled": {
"type": "boolean",
"description": "Enabled controls if the interface should be UP."
},
"ipAddresses": {
"items": {
"type": "string"
},
"type": "array",
"description": "IPAddresses define list of IP addresses for the interface and must be\n defined in the following format: \u003cipAddress\u003e/\u003cipPrefix\u003e.\n Interface IP address can be also allocated via netalloc plugin and\n referenced here, see: api/models/netalloc/netalloc.proto"
},
"physAddress": {
"type": "string",
"description": "PhysAddress represents physical address (MAC) of the interface.\n Random address will be assigned if left empty.\n Not used (and not supported) by VRF devices."
},
"mtu": {
"type": "integer",
"description": "MTU is the maximum transmission unit value."
},
"veth": {
"properties": {
"peerIfName": {
"type": "string",
"description": "Name of the VETH peer, i.e. other end of the linux veth (mandatory for VETH)"
},
"rxChecksumOffloading": {
"enum": [
"CHKSM_OFFLOAD_DEFAULT",
0,
"CHKSM_OFFLOAD_ENABLED",
1,
"CHKSM_OFFLOAD_DISABLED",
2
],
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
],
"description": "Checksum offloading - Rx side (enabled by default)"
},
"txChecksumOffloading": {
"enum": [
"CHKSM_OFFLOAD_DEFAULT",
0,
"CHKSM_OFFLOAD_ENABLED",
1,
"CHKSM_OFFLOAD_DISABLED",
2
],
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
],
"description": "Checksum offloading - Tx side (enabled by default)"
}
},
"additionalProperties": true,
"type": "object",
"description": "VETH-specific configuration"
},
"tap": {
"properties": {
"vppTapIfName": {
"type": "string",
"description": "Logical name of the VPP TAP interface (mandatory for TAP_TO_VPP)"
}
},
"additionalProperties": true,
"type": "object",
"description": "TAP_TO_VPP-specific configuration"
},
"vrfDev": {
"properties": {
"routingTable": {
"type": "integer",
"description": "Routing table associated with the VRF.\n Table ID is an 8-bit unsigned integer value. Please note that 253, 254 and 255 are reserved values\n for special routing tables (main, default, local).\n Multiple VRFs inside the same network namespace should each use a different routing table.\n For more information, visit: http://linux-ip.net/html/routing-tables.html"
}
},
"additionalProperties": true,
"type": "object",
"description": "VRF_DEVICE-specific configuration"
},
"linkOnly": {
"type": "boolean",
"description": "Configure/Resync link only. IP/MAC addresses are expected to be configured\n externally - i.e. by a different agent or manually via CLI."
},
"vrfMasterInterface": {
"type": "string",
"description": "Reference to the logical name of a VRF_DEVICE interface.\n If defined, this interface will be enslaved to the VRF device and will thus become\n part of the VRF (L3-level separation) that the device represents.\n Interfaces enslaved to the same VRF_DEVICE master interface therefore\n comprise single VRF with a separate routing table."
}
},
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
"routes": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"outgoingInterface": {
"type": "string",
"description": "Outgoing interface logical name (mandatory)."
},
"scope": {
"enum": [
"UNDEFINED",
0,
"GLOBAL",
1,
"SITE",
2,
"LINK",
3,
"HOST",
4
],
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
],
"description": "The scope of the area where the link is valid."
},
"dstNetwork": {
"type": "string",
"description": "Destination network address in the format \u003caddress\u003e/\u003cprefix\u003e (mandatory)\n Address can be also allocated via netalloc plugin and referenced here,\n see: api/models/netalloc/netalloc.proto"
},
"gwAddr": {
"type": "string",
"description": "Gateway IP address (without mask, optional).\n Address can be also allocated via netalloc plugin and referenced here,\n see: api/models/netalloc/netalloc.proto"
},
"metric": {
"type": "integer",
"description": "routing metric (weight)"
}
},
"additionalProperties": true,
"type": "object"
},
"type": "array"
}
},
"additionalProperties": true,
"type": "object"
},
"netallocConfig": {
"properties": {
"ipAddresses": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"networkName": {
"type": "string",
"description": "NetworkName is some label assigned to the network where the IP address\n was assigned to the given interface.\n In theory, interface can have multiple IP adresses or there can be multiple\n address allocators and the network name allows to separate them.\n The network name is not allowed to contain forward slashes."
},
"interfaceName": {
"type": "string",
"description": "InterfaceName is the logical VPP or Linux interface name for which the\n address is allocated."
},
"address": {
"type": "string",
"description": "Address is an IP addres allocated to the interface inside the given\n network.\n If the address is specified without a mask, the all-ones mask (/32 for\n IPv4, /128 for IPv6) will be assumed."
},
"gw": {
"type": "string",
"description": "Gw is the address of the default gateway assigned to the interface in\n the given network.\n If the address is specified without a mask, then either:\n a) the mask of the \u003caddress\u003e is used provided that GW IP falls into the\n same network IP range, or\n b) the all-ones mask is used otherwise"
}
},
"additionalProperties": true,
"type": "object",
"description": "IPAllocation represents a single allocated IP address.\n\n To reference allocated address, instead of entering specific IP address\n for interface/route/ARP/..., use one of the following string templates\n prefixed with netalloc keyword \"alloc\" followed by colon:\n a) reference IP address allocated for an interface:\n \"alloc:\u003cnetwork_name\u003e/\u003cinterface_name\u003e\"\n b) when interface is given (e.g. when asked for IP from interface model),\n interface_name can be omitted:\n \"alloc:\u003cnetwork_name\u003e\"\n c) reference default gateway IP address assigned to an interface:\n \"alloc:\u003cnetwork_name\u003e/\u003cinterface_name\u003e/GW\"\n d) when asking for GW IP for interface which is given, interface_name\n can be omitted:\n \"alloc:\u003cnetwork_name\u003e/GW\""
},
"type": "array"
}
},
"additionalProperties": true,
"type": "object"
},
"vppConfig": {
"properties": {
"ABXList": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"index": {
"type": "integer",
"description": "ABX index (unique identifier)"
},
"aclName": {
"type": "string",
"description": "Name of the associated access list"
},
"outputInterface": {
"type": "string",
"description": "Name of outgoing interface"
},
"dstMac": {
"type": "string",
"description": "Rewrite destination mac address"
},
"attachedInterfaces": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"inputInterface": {
"type": "string"
},
"priority": {
"type": "integer"
}
},
"additionalProperties": true,
"type": "object",
"description": "List of interfaces attached to the ABX"
},
"type": "array"
}
},
"additionalProperties": true,
"type": "object",
"description": "ACL based xconnect"
},
"type": "array"
},
"BFDList": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"interface": {
"type": "string",
"description": "Name of the interface the BFD session is attached to."
},
"localIp": {
"type": "string",
"description": "Local IP address. The interface must have the same address configured."
},
"peerIp": {
"type": "string",
"description": "IP address of the peer, must be the same IP version as the local address."
},
"minTxInterval": {
"type": "integer",
"description": "Desired minimum TX interval in milliseconds."
},
"minRxInterval": {
"type": "integer",
"description": "Required minimum RX interval in milliseconds."
},
"detectMultiplier": {
"type": "integer",
"description": "Detect multiplier, must be non-zero value."
}
},
"additionalProperties": true,
"type": "object",
"description": "Single-hop UDP-based bidirectional forwarding detection session"
},
"type": "array"
},
"DNSCache": {
"properties": {
"upstreamDnsServers": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of upstream DNS servers that are contacted by VPP when unknown domain name needs to be resolved.\nThe results are cached and there should be no further upstream DNS server request for the same domain\nname until cached DNS record expiration."
}
},
"additionalProperties": true,
"type": "object"
},
"ISISXConnectionList": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"inputInterface": {
"type": "string",
"description": "Name of input interface"
},
"outputInterface": {
"type": "string",
"description": "Name of outgoing interface"
}
},
"additionalProperties": true,
"type": "object",
"description": "Unidirectional cross-connection between 2 interfaces that will cross-connect only ISIS protocol data traffic"
},
"type": "array"
},
"Nat64AddressPoolList": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"vrfId": {
"type": "integer",
"description": "VRF id of tenant, 0xFFFFFFFF means independent of VRF.\n Non-zero (and not all-ones) VRF has to be explicitly created (see proto/ligato/vpp/l3/vrf.proto)."
},
"firstIp": {
"type": "string",
"description": "First IP address of the pool."
},
"lastIp": {
"type": "string",
"description": "Last IP address of the pool. Should be higher than first_ip or empty."
}
},
"additionalProperties": true,
"type": "object",
"description": "Nat44AddressPool defines an address pool used for NAT64."
},
"type": "array"
},
"Nat64IPv6PrefixList": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"vrfId": {
"type": "integer",
"description": "VRF id of tenant.\n At most one IPv6 prefix can be configured for a given VRF (that's why VRF is part of the key but prefix is not).\n Non-zero (and not all-ones) VRF has to be explicitly created (see proto/ligato/vpp/l3/vrf.proto)."
},
"prefix": {
"type": "string",
"description": "NAT64 prefix in the \u003cIPv6-Address\u003e/\u003cIPv6-Prefix\u003e format."
}
},
"additionalProperties": true,
"type": "object",
"description": "IPv4-Embedded IPv6 Address Prefix used for NAT64.\n If no prefix is configured (at all or for a given VRF), then the well-known prefix (64:ff9b::/96) is used."
},
"type": "array"
},
"Nat64InterfaceList": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"name": {
"type": "string",
"description": "Interface name (logical)."
},
"type": {
"enum": [
"IPV6_INSIDE",
0,
"IPV4_OUTSIDE",
1
],
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"additionalProperties": true,
"type": "object",
"description": "Nat64Interface defines a local network interfaces enabled for NAT64."
},
"type": "array"
},
"Nat64StaticBIBList": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"vrfId": {
"type": "integer",
"description": "VRF (table) ID. Non-zero VRF has to be explicitly created (see proto/ligato/vpp/l3/vrf.proto)."
},
"insideIpv6Address": {
"type": "string",
"description": "IPv6 host from the inside/local network."
},
"insidePort": {
"type": "integer",
"description": "Inside port number (of the IPv6 host)."
},
"outsideIpv4Address": {
"type": "string",
"description": "IPv4 host from the outside/external network."
},
"outsidePort": {
"type": "integer",
"description": "Outside port number (of the IPv4 host)."
},
"protocol": {
"enum": [
"TCP",
0,
"UDP",
1,
"ICMP",
2
],
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"additionalProperties": true,
"type": "object",
"description": "Static NAT64 binding allowing IPv4 host from the outside to access IPv6 host from the inside."
},
"type": "array"
},
"RuleList": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"ipAddress": {
"type": "string"
},
"interface": {
"type": "string"
}
},
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
"VRRPEntryList": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"interface": {
"type": "string",
"description": "This field refers to logical interface name"
},
"vrId": {
"type": "integer",
"description": "Should be \u003e 0 and \u003c= 255"
},
"priority": {
"type": "integer",
"description": "Priority defines which router becomes master. Should be \u003e 0 and \u003c= 255."
},
"interval": {
"type": "integer",
"description": "VR advertisement interval in milliseconds, should be =\u003e 10 and \u003c= 65535.\n (Later, in implemetation it is converted into centiseconds, so precision may be lost)."
},
"preempt": {
"type": "boolean",
"description": "Controls whether a (starting or restarting) \n higher-priority Backup router preempts a lower-priority Master router."
},
"accept": {
"type": "boolean",
"description": "Controls whether a virtual router in Master state will accept packets\n addressed to the address owner's IPvX address as its own if it is not the IPvX address owner."
},
"unicast": {
"type": "boolean",
"description": "Unicast mode may be used to take\n advantage of newer token ring adapter implementations that support\n non-promiscuous reception for multiple unicast MAC addresses and to\n avoid both the multicast traffic and usage conflicts associated with\n the use of token ring functional addresses."
},
"ipAddresses": {
"items": {
"type": "string"
},
"type": "array",
"description": "Ip address quantity should be \u003e 0 and \u003c= 255."
},
"enabled": {
"type": "boolean"
}
},
"additionalProperties": true,
"type": "object",
"description": "VRRPEntry represents Virtual Router desired state."
},
"type": "array"
},
"abfs": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"index": {
"type": "integer",
"description": "ABF index (unique identifier)"
},
"aclName": {
"type": "string",
"description": "Name of the associated access list"
},
"attachedInterfaces": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"inputInterface": {
"type": "string"
},
"priority": {
"type": "integer"
},
"isIpv6": {
"type": "boolean"
}
},
"additionalProperties": true,
"type": "object",
"description": "List of interfaces attached to the ABF"
},
"type": "array"
},
"forwardingPaths": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"nextHopIp": {
"type": "string"
},
"interfaceName": {
"type": "string"
},
"weight": {
"type": "integer"
},
"preference": {
"type": "integer"
},
"dvr": {
"type": "boolean"
}
},
"additionalProperties": true,
"type": "object",
"description": "List of forwarding paths added to the ABF policy (via)"
},
"type": "array"
}
},
"additionalProperties": true,
"type": "object",
"description": "ABF defines ACL based forwarding."
},
"type": "array"
},
"acls": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"name": {
"type": "string",
"description": "The name of an access list. A device MAY restrict the length\n and value of this name, possibly spaces and special\n characters are not allowed."
},
"rules": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"action": {
"enum": [
"DENY",
0,
"PERMIT",
1,
"REFLECT",
2
],
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"ipRule": {
"properties": {
"ip": {
"properties": {
"destinationNetwork": {
"type": "string",
"description": "Destination IPv4/IPv6 network address (\u003cip\u003e/\u003cnetwork\u003e)"
},
"sourceNetwork": {
"type": "string",
"description": "Destination IPv4/IPv6 network address (\u003cip\u003e/\u003cnetwork\u003e)"
},
"protocol": {
"type": "integer",
"description": "IP protocol number (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)\n Zero value (i.e. undefined protocol) means that the protocol to match will be automatically\n selected from one of the ICMP/ICMP6/TCP/UDP based on the rule definition. For example, if \"icmp\"\n is defined and src/dst addresses are IPv6 then packets of the ICMP6 protocol will be matched, etc."
}
},
"additionalProperties": true,
"type": "object"
},
"icmp": {
"properties": {
"icmpv6": {
"type": "boolean",
"description": "ICMPv6 flag, if false ICMPv4 will be used"
},
"icmpCodeRange": {
"$ref": "ligato.vpp.acl.ACL.Rule.IpRule.Icmp.Range",
"additionalProperties": true,
"description": "Inclusive range representing icmp codes to be used."
},
"icmpTypeRange": {
"$ref": "ligato.vpp.acl.ACL.Rule.IpRule.Icmp.Range",
"additionalProperties": true
}
},
"additionalProperties": true,
"type": "object"
},
"tcp": {
"properties": {
"destinationPortRange": {
"$ref": "ligato.vpp.acl.ACL.Rule.IpRule.PortRange",
"additionalProperties": true
},
"sourcePortRange": {
"$ref": "ligato.vpp.acl.ACL.Rule.IpRule.PortRange",
"additionalProperties": true
},
"tcpFlagsMask": {
"type": "integer",
"description": "Binary mask for tcp flags to match. MSB order (FIN at position 0).\n Applied as logical AND to tcp flags field of the packet being matched,\n before it is compared with tcp-flags-value."
},
"tcpFlagsValue": {
"type": "integer",
"description": "Binary value for tcp flags to match. MSB order (FIN at position 0).\n Before tcp-flags-value is compared with tcp flags field of the packet being matched,\n tcp-flags-mask is applied to packet field value."
}
},
"additionalProperties": true,
"type": "object"
},
"udp": {
"properties": {
"destinationPortRange": {
"$ref": "ligato.vpp.acl.ACL.Rule.IpRule.PortRange",
"additionalProperties": true
},
"sourcePortRange": {
"$ref": "ligato.vpp.acl.ACL.Rule.IpRule.PortRange",
"additionalProperties": true
}
},
"additionalProperties": true,
"type": "object"
}
},
"additionalProperties": true,
"type": "object"
},
"macipRule": {
"properties": {
"sourceAddress": {
"type": "string"
},
"sourceAddressPrefix": {
"type": "integer"
},
"sourceMacAddress": {
"type": "string",
"description": "Before source-mac-address is compared with source mac address field of the packet\n being matched, source-mac-address-mask is applied to packet field value."
},
"sourceMacAddressMask": {
"type": "string",
"description": "Source MAC address mask.\n Applied as logical AND with source mac address field of the packet being matched,\n before it is compared with source-mac-address."
}
},
"additionalProperties": true,
"type": "object"
}
},
"additionalProperties": true,
"type": "object",
"description": "List of access list entries (Rules). Each Access Control Rule has\n a list of match criteria and a list of actions.\n Access List entry that can define:\n - IPv4/IPv6 src ip prefix\n - src MAC address mask\n - src MAC address value\n - can be used only for static ACLs."
},
"type": "array"
},
"interfaces": {
"properties": {
"egress": {
"items": {
"type": "string"
},
"type": "array"
},
"ingress": {
"items": {
"type": "string"
},
"type": "array"
}
},
"additionalProperties": true,
"type": "object"
}
},
"additionalProperties": true,
"type": "object",
"description": "ACL defines Access Control List."
},
"type": "array"
},
"arps": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"interface": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"physAddress": {
"type": "string"
},
"static": {
"type": "boolean"
}
},
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
"bridgeDomains": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"name": {
"type": "string",
"description": "bridge domain name (can be any string)"
},
"flood": {
"type": "boolean",
"description": "enable/disable broadcast/multicast flooding in the BD"
},
"unknownUnicastFlood": {
"type": "boolean",
"description": "enable/disable unknown unicast flood in the BD"
},
"forward": {
"type": "boolean",
"description": "enable/disable forwarding on all interfaces in the BD"
},
"learn": {
"type": "boolean",
"description": "enable/disable learning on all interfaces in the BD"
},
"arpTermination": {
"type": "boolean",
"description": "enable/disable ARP termination in the BD"
},
"macAge": {
"type": "integer",
"description": "MAC aging time in min, 0 for disabled aging"
},
"interfaces": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"name": {
"type": "string",
"description": "interface name belonging to this bridge domain"
},
"bridgedVirtualInterface": {
"type": "boolean",
"description": "true if this is a BVI interface"
},
"splitHorizonGroup": {
"type": "integer",
"description": "VXLANs in the same BD need the same non-zero SHG"
}
},
"additionalProperties": true,
"type": "object"
},
"type": "array",
"description": "list of interfaces"
},
"arpTerminationTable": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"ipAddress": {
"type": "string",
"description": "IP address"
},
"physAddress": {
"type": "string",
"description": "MAC address matching to the IP"
}
},
"additionalProperties": true,