-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
8418 lines (6883 loc) · 263 KB
/
swagger.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
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
basePath: /SEMP/v2/config
consumes:
- application/json
definitions:
EventThreshold:
properties:
clearPercent:
description: Threshold clear percent.
type: integer
clearValue:
description: Threshold clear value.
type: integer
setPercent:
description: Threshold set percent.
type: integer
setValue:
description: Threshold set value.
type: integer
type: object
EventThresholdByPercent:
properties:
clearPercent:
description: Threshold clear percent.
type: integer
setPercent:
description: Threshold set percent.
type: integer
type: object
EventThresholdByValue:
properties:
clearValue:
description: Threshold clear value.
type: integer
setValue:
description: Threshold set value.
type: integer
type: object
MsgVpn:
properties:
authenticationBasicEnabled:
description: Enable or disable basic authentication for clients within the
Message VPN. Basic authentication is authentication that involves the use
of a username and password to prove identity. When enabled, the currently
selected authentication type is used for authentication of users that provide
basic authentication credentials. If a user provides credentials for a different
authentication scheme this setting is not applicable. The default value
is `true`.
type: boolean
authenticationBasicProfileName:
description: The name of the RADIUS or LDAP profile to use when `authenticationBasicType`
is `"radius"` or `"ldap"` respectively. The default value is `"default"`.
type: string
authenticationBasicRadiusDomain:
description: The RADIUS domain string to use when `authenticationBasicType`
is `"radius"`. The default value is `""`.
type: string
authenticationBasicType:
description: "Authentication mechanism to be used for basic authentication\
\ of clients connecting to this Message VPN. The default value is `\"radius\"\
`. The allowed values and their meaning are:\n\n \"radius\" - Radius\
\ authentication. A radius profile must be provided.\n \"ldap\" - LDAP\
\ authentication. An LDAP profile must be provided.\n \"internal\" -\
\ Internal database. Authentication is against Client Usernames.\n \"\
none\" - No authentication. Anonymous login allowed.\n"
enum:
- radius
- ldap
- internal
- none
type: string
authenticationClientCertAllowApiProvidedUsernameEnabled:
description: When enabled, if the client specifies a client-username via the
API connect method, the client provided username is used instead of the
CN (Common Name) field of the certificate's subject. When disabled, the
certificate CN is always used as the client-username. The default value
is `false`.
type: boolean
authenticationClientCertEnabled:
description: Enable or disable client certificate client authentication in
the Message VPN. The default value is `false`.
type: boolean
authenticationClientCertMaxChainDepth:
description: The maximum depth for a client certificate chain. The depth of
a chain is defined as the number of signing CA certificates that are present
in the chain back to a trusted self-signed root CA certificate. The default
value is `3`.
type: integer
authenticationClientCertValidateDateEnabled:
description: Enable or disable validation of the "Not Before" and "Not After"
validity dates in the certificate. When disabled, a certificate will be
accepted even if the certificate is not valid according to the "Not Before"
and "Not After" validity dates in the certificate. The default value is
`true`.
type: boolean
authenticationKerberosAllowApiProvidedUsernameEnabled:
description: When enabled, if the client specifies a client-username via the
API connect method, the client provided username is used instead of the
Kerberos Principal name in Kerberos token. When disabled, the Kerberos Principal
name is always used as the client-username. The default value is `false`.
type: boolean
authenticationKerberosEnabled:
description: Enable or disable Kerberos authentication for clients in the
Message VPN. If a user provides credentials for a different authentication
scheme, this setting is not applicable. The default value is `false`.
type: boolean
authorizationLdapGroupMembershipAttributeName:
description: The name of the attribute that should be retrieved from the LDAP
server as part of the LDAP search when authorizing a client. It indicates
that the client belongs to a particular group (i.e. the value associated
with this attribute). The default value is `"memberOf"`.
type: string
authorizationProfileName:
description: The LDAP profile name to be used when `authorizationType` is
`"ldap"`. The default value is `""`.
type: string
authorizationType:
description: "Authorization mechanism to be used for clients connecting to\
\ this Message VPN. The default value is `\"internal\"`. The allowed values\
\ and their meaning are:\n\n \"ldap\" - LDAP authorization.\n \"internal\"\
\ - Internal authorization.\n"
enum:
- ldap
- internal
type: string
bridgingTlsServerCertEnforceTrustedCommonNameEnabled:
description: Enable or disable validation of the common name in the server
certificate on the remote router. If enabled, the common name is checked
against the list of trusted common names configured for the bridge. The
default value is `true`.
type: boolean
bridgingTlsServerCertMaxChainDepth:
description: The maximum depth for a server certificate chain. The depth of
a chain is defined as the number of signing CA certificates that are present
in the chain back to a trusted self-signed root CA certificate. The default
value is `3`.
type: integer
bridgingTlsServerCertValidateDateEnabled:
description: Enable or disable validation of the "Not Before" and "Not After"
validity dates in the server certificate. When disabled, a certificate will
be accepted even if the certificate is not valid according to the "Not Before"
and "Not After" validity dates in the certificate. The default value is
`true`.
type: boolean
distributedCacheManagementEnabled:
description: Enable or disable managing of cache instances over the message
bus. For a given Message VPN only one router in the network should have
this attribute enabled. The default value is `true`.
type: boolean
enabled:
description: Enable or disable the Message VPN. The default value is `false`.
type: boolean
eventConnectionCountThreshold:
$ref: '#/definitions/EventThreshold'
eventEgressFlowCountThreshold:
$ref: '#/definitions/EventThreshold'
eventEgressMsgRateThreshold:
$ref: '#/definitions/EventThresholdByValue'
eventEndpointCountThreshold:
$ref: '#/definitions/EventThreshold'
eventIngressFlowCountThreshold:
$ref: '#/definitions/EventThreshold'
eventIngressMsgRateThreshold:
$ref: '#/definitions/EventThresholdByValue'
eventLargeMsgThreshold:
description: Size in KB for what is being considered a large message for the
Message VPN. The default value is `1024`.
type: integer
eventLogTag:
description: A prefix applied to all publish events in this Message VPN. The
default is to have no `eventLogTag`.
type: string
eventMsgSpoolUsageThreshold:
$ref: '#/definitions/EventThreshold'
eventPublishClientEnabled:
description: Enable or disable client level event message publishing. The
default value is `false`.
type: boolean
eventPublishMsgVpnEnabled:
description: Enable or disable Message VPN level event message publishing.
The default value is `false`.
type: boolean
eventPublishSubscriptionMode:
description: "\nSubscription level event message publishing mode. Format v1\
\ modes use a publish topic of the form:\n\n #LOG/INFO/SUB_ADD/subscribed-topic\n\
\ #LOG/INFO/SUB_DEL/subscribed-topic\n\nFormat v2 modes use a publish\
\ topic of the form:\n\n #LOG/INFO/SUB/router-name/ADD/vpn-name/client-name/subscribed-topic\n\
\ #LOG/INFO/SUB/router-name/DEL/vpn-name/client-name/subscribed-topic\n\
\nFormat v2 is recommended.\n. The default value is `\"off\"`. The allowed\
\ values and their meaning are:\n\n \"off\" - Disable client level event\
\ message publishing.\n \"on-with-format-v1\" - Enable client level event\
\ message publishing with format v1.\n \"on-with-no-unsubscribe-events-on-disconnect-format-v1\"\
\ - As \"on-with-format-v1\", but unsubscribe events are not generated when\
\ a client disconnects. Unsubscribe events are still raised when a client\
\ explicitly unsubscribes from its subscriptions.\n \"on-with-format-v2\"\
\ - Enable client level event message publishing with format v2.\n \"\
on-with-no-unsubscribe-events-on-disconnect-format-v2\" - As \"on-with-format-v2\"\
, but unsubscribe events are not generated when a client disconnects. Unsubscribe\
\ events are still raised when a client explicitly unsubscribes from its\
\ subscriptions.\n"
enum:
- 'off'
- on-with-format-v1
- on-with-no-unsubscribe-events-on-disconnect-format-v1
- on-with-format-v2
- on-with-no-unsubscribe-events-on-disconnect-format-v2
type: string
eventPublishTopicFormatMqttEnabled:
description: Enable or disable event publish topics in MQTT format. The default
value is `false`.
type: boolean
eventPublishTopicFormatSmfEnabled:
description: Enable or disable event publish topics in SMF format. The default
value is `true`.
type: boolean
eventServiceRestIncomingConnectionCountThreshold:
$ref: '#/definitions/EventThreshold'
eventServiceSmfConnectionCountThreshold:
$ref: '#/definitions/EventThreshold'
eventServiceWebConnectionCountThreshold:
$ref: '#/definitions/EventThreshold'
eventSubscriptionCountThreshold:
$ref: '#/definitions/EventThreshold'
eventTransactedSessionCountThreshold:
$ref: '#/definitions/EventThreshold'
eventTransactionCountThreshold:
$ref: '#/definitions/EventThreshold'
exportSubscriptionsEnabled:
description: Enable or disable the export of subscriptions in this Message
VPN to other routers in the network over neighbor links. The default value
is `false`.
type: boolean
maxConnectionCount:
description: The maximum number of client connections that can be simultaneously
connected to the Message VPN. This value may be higher than supported by
the hardware. The default is the max value supported by the hardware.
type: integer
maxEgressFlowCount:
description: The maximum number of egress flows that can be created on this
Message VPN. The default value is `16000`.
type: integer
maxEndpointCount:
description: The maximum number of queues and topic endpoints that can be
created on this Message VPN. The default value is `16000`.
type: integer
maxIngressFlowCount:
description: The maximum number of ingress flows that can be created on this
Message VPN. The default value is `16000`.
type: integer
maxMsgSpoolUsage:
description: Max spool usage (in MB) allowed for the Message VPN. The default
value is `0`.
type: integer
maxSubscriptionCount:
description: The maximum number of local client subscriptions (both primary
and backup) that can be added to this Message VPN. The default value is
`5000000`.
type: integer
maxTransactedSessionCount:
description: The maximum number of transacted sessions for this Message VPN.
The default value is `16000`.
type: integer
maxTransactionCount:
description: The maximum number of transactions for this Message VPN. The
default value is `50000`.
type: integer
msgVpnName:
description: The name of the Message VPN.
type: string
replicationAckPropagationIntervalMsgCount:
description: The ack-propagation interval, in number of replicated messages.
The default value is `20`.
type: integer
replicationBridgeAuthenticationBasicClientUsername:
description: The client username the replication bridge uses to login to the
Remote Message VPN on the replication mate. The default is to have no `replicationBridgeAuthenticationBasicClientUsername`.
type: string
replicationBridgeAuthenticationBasicPassword:
description: The password that the bridge uses to login to the Remote Message
VPN. The default is to have no `replicationBridgeAuthenticationBasicPassword`.
type: string
replicationBridgeAuthenticationScheme:
description: "The authentication scheme for the replication bridge. The default\
\ value is `\"basic\"`. The allowed values and their meaning are:\n\n \
\ \"basic\" - Basic Authentication Scheme (via username and password).\n\
\ \"client-certificate\" - Client Certificate Authentication Scheme (via\
\ certificate-file).\n"
enum:
- basic
- client-certificate
type: string
replicationBridgeCompressedDataEnabled:
description: Whether compression is used for the bridge. The default value
is `false`.
type: boolean
replicationBridgeEgressFlowWindowSize:
description: The window size of outstanding guaranteed messages. The default
value is `255`.
type: integer
replicationBridgeRetryDelay:
description: Number of seconds that must pass before retrying a connection.
The default value is `3`.
type: integer
replicationBridgeTlsEnabled:
description: Enable or disable use of TLS for the bridge connection. The default
value is `false`.
type: boolean
replicationBridgeUnidirectionalClientProfileName:
description: The client-profile for the unidirectional replication bridge
for the Message VPN. The client-profile must exist in the local Message
VPN, and it is used only for the TCP parameters. The default value is `"#client-profile"`.
type: string
replicationEnabled:
description: Enable or disable the replication feature for the Message VPN.
The default value is `false`.
type: boolean
replicationEnabledQueueBehavior:
description: "The behavior to take when enabling replication, depending on\
\ the existence of the replication queue. This only has meaning in a request\
\ which enables replication. The default value is `\"fail-on-existing-queue\"\
`. The allowed values and their meaning are:\n\n \"fail-on-existing-queue\"\
\ - The data replication queue must not already exist.\n \"force-use-existing-queue\"\
\ - The data replication queue must already exist. Any data messages on\
\ the queue will be forwarded to interested applications. IMPORTANT: Before\
\ using this mode be certain that the messages are not stale or otherwise\
\ unsuitable to be forwarded. This mode can only be specified when the existing\
\ queue is configured the same as is currently specified under replication\
\ configuration otherwise the enabling of replication will fail.\n \"\
force-recreate-queue\" - The data replication queue must already exist.\
\ Any data messages on the queue will be discarded. IMPORTANT: Before using\
\ this mode be certain that the messages on the existing data replication\
\ queue are not needed by interested applications.\n"
enum:
- fail-on-existing-queue
- force-use-existing-queue
- force-recreate-queue
type: string
replicationQueueMaxMsgSpoolUsage:
description: The max spool usage (in MB) of the replication queue. The default
value is `60000`.
type: integer
replicationQueueRejectMsgToSenderOnDiscardEnabled:
description: The message discard behavior. The default value is `true`.
type: boolean
replicationRejectMsgWhenSyncIneligibleEnabled:
description: Enable or disable sync mode ineligible behavior. If enabled and
sync replication becomes ineligible, guaranteed messages published to sync
replicated topics will be rejected to the sender. If disabled, sync replication
will revert to async mode. The default value is `false`.
type: boolean
replicationRole:
description: "The replication role for this Message VPN. The default value\
\ is `\"standby\"`. The allowed values and their meaning are:\n\n \"\
active\" - Assume the active role in replication for the Message VPN.\n\
\ \"standby\" - Assume the standby role in replication for the Message\
\ VPN.\n"
enum:
- active
- standby
type: string
replicationTransactionMode:
description: "The transaction replication mode for all transactions within\
\ a Message VPN. When mode is async, all transactions originated by clients\
\ are replicated to the standby site using async-replication. When mode\
\ is sync, all transactions originated by clients are replicated to the\
\ standby site using sync-replication. Changing this value during operation\
\ will not affect existing transactions. It is only validated upon starting\
\ a transaction. The default value is `\"async\"`. The allowed values and\
\ their meaning are:\n\n \"sync\" - Synchronous replication-mode.\n \
\ \"async\" - Asynchronous replication-mode.\n"
enum:
- sync
- async
type: string
restTlsServerCertEnforceTrustedCommonNameEnabled:
description: Enable or disable whether or not the trusted-common-name attribute
of a REST Consumer is enforced or not. Each REST Consumer has a list of
common-names which it expects to be returned in the server-certificate from
the remote REST Consumer. If enforce-trusted-common-name is enabled, but
the list of common-names has not been configured, the REST Consumer will
not be allowed to be brought into service. An appropriate error message
is provided in the REST Consumer operational display. The default value
is `true`.
type: boolean
restTlsServerCertMaxChainDepth:
description: The maximum depth for the certificate chain. The depth of a chain
is defined as the number of signing CA certificates that are present in
the chain back to a trusted self-signed root CA certificate. The default
value is `3`.
type: integer
restTlsServerCertValidateDateEnabled:
description: Enable or disable validation of the "Not Before" and "Not After"
validity dates in the server certificate. When disabled, a certificate will
be accepted even if the certificate is not valid according to the "Not Before"
and "Not After" validity dates in the certificate. The default value is
`true`.
type: boolean
sempOverMsgBusAdminClientEnabled:
description: Enable or disable "admin client" SEMP over Message Bus for the
current Message VPN. This applies only to SEMPv1. The default value is `false`.
type: boolean
sempOverMsgBusAdminDistributedCacheEnabled:
description: Enable or disable "admin distributed-cache" SEMP over Message
Bus for the current Message VPN. This applies only to SEMPv1. The default
value is `false`.
type: boolean
sempOverMsgBusAdminEnabled:
description: Enable or disable "admin" SEMP over Message Bus for the current
Message VPN. This applies only to SEMPv1. The default value is `false`.
type: boolean
sempOverMsgBusEnabled:
description: Enable or disable SEMP over Message Bus for the current Message
VPN. This applies only to SEMPv1. The default value is `true`.
type: boolean
sempOverMsgBusLegacyShowClearEnabled:
description: Enable or disable "legacy-show-clear" SEMP over Message Bus for
the current Message VPN. This applies only to SEMPv1. The default value
is `true`.
type: boolean
sempOverMsgBusShowEnabled:
description: Enable or disable "show" SEMP over Message Bus for the current
Message VPN. This applies only to SEMPv1. The default value is `false`.
type: boolean
serviceRestIncomingMaxConnectionCount:
description: The maximum number of REST incoming client connections that can
be simultaneously connected to the Message VPN. This value may be higher
than supported by the hardware. The default is the max value supported by
the hardware.
type: integer
serviceRestIncomingPlainTextEnabled:
description: Enable or disable plain-text REST for this Message VPN. The default
value is `false`.
type: boolean
serviceRestIncomingPlainTextListenPort:
description: The TCP port on the NAB for incoming plain-text REST client connections
for the Message VPN. The TCP port must not be in use by another service
in any Message VPN in the msg-backbone VRF. Enabling plain-text REST is
not allowed without a listen-port. The default is to have no `serviceRestIncomingPlainTextListenPort`.
type: integer
serviceRestIncomingTlsEnabled:
description: Enable or disable incoming TLS REST service for this Message
VPN. The default value is `false`.
type: boolean
serviceRestIncomingTlsListenPort:
description: The TCP port on the NAB for incoming TLS REST client connections
for the Message VPN. The TCP port must not be in use by another service
in any Message VPN in the msg-backbone VRF. Enabling plain-text REST is
not allowed without a listen-port. The default is to have no `serviceRestIncomingTlsListenPort`.
type: integer
serviceRestOutgoingMaxConnectionCount:
description: The maximum number of REST consumer connections that can be simultaneously
established from the Message VPN. The default value is `6000`.
type: integer
serviceSmfMaxConnectionCount:
description: The maximum number of SMF client connections that can be simultaneously
connected to the Message VPN. This value may be higher than supported by
the hardware. The default is the max value supported by the hardware.
type: integer
serviceSmfPlainTextEnabled:
description: Enable or disable plain-text SMF service in the Message VPN.
The default value is `true`.
type: boolean
serviceSmfTlsEnabled:
description: Enable or disable TLS SMF service for this Message VPN. The default
value is `true`.
type: boolean
serviceWebMaxConnectionCount:
description: The maximum number of web-transport client connections that can
be simultaneously connected to the Message VPN. This value may be higher
than supported by the hardware. The default is the max value supported by
the hardware.
type: integer
serviceWebPlainTextEnabled:
description: Enable or disable plain-text Web Transport service in the Message
VPN. The default value is `true`.
type: boolean
serviceWebTlsEnabled:
description: Enable or disable TLS Web Transport service in the Message VPN.
The default value is `true`.
type: boolean
tlsAllowDowngradeToPlainTextEnabled:
description: Enable or disable the allowing of TLS SMF clients to downgrade
their connections to plain-text connections. Changing this will not affect
existing connections. The default value is `false`.
type: boolean
type: object
MsgVpnAclProfile:
properties:
aclProfileName:
description: The name of the ACL Profile.
type: string
clientConnectDefaultAction:
description: "The default action to take when a client connects. The default\
\ value is `\"disallow\"`. The allowed values and their meaning are:\n\n\
\ \"allow\" - Allow client connection unless an exception is found for\
\ it.\n \"disallow\" - Disallow client connection unless an exception\
\ is found for it.\n"
enum:
- allow
- disallow
type: string
msgVpnName:
description: The name of the Message VPN.
type: string
publishTopicDefaultAction:
description: "The default action to take when a client publishes to a topic.\
\ The default value is `\"disallow\"`. The allowed values and their meaning\
\ are:\n\n \"allow\" - Allow topic unless an exception is found for it.\n\
\ \"disallow\" - Disallow topic unless an exception is found for it.\n"
enum:
- allow
- disallow
type: string
subscribeTopicDefaultAction:
description: "The default action to take when a client subscribes to a topic.\
\ The default value is `\"disallow\"`. The allowed values and their meaning\
\ are:\n\n \"allow\" - Allow topic unless an exception is found for it.\n\
\ \"disallow\" - Disallow topic unless an exception is found for it.\n"
enum:
- allow
- disallow
type: string
type: object
MsgVpnAclProfileClientConnectException:
properties:
aclProfileName:
description: The name of the ACL Profile.
type: string
clientConnectExceptionAddress:
description: The IP address/Netmask in CIDR form of the Client Connect Exception.
type: string
msgVpnName:
description: The name of the Message VPN.
type: string
type: object
MsgVpnAclProfileClientConnectExceptionLinks:
properties:
uri:
description: The URI of this MsgVpnAclProfileClientConnectException object.
type: string
type: object
MsgVpnAclProfileClientConnectExceptionResponse:
properties:
data:
$ref: '#/definitions/MsgVpnAclProfileClientConnectException'
links:
$ref: '#/definitions/MsgVpnAclProfileClientConnectExceptionLinks'
meta:
$ref: '#/definitions/SempMeta'
required:
- meta
type: object
MsgVpnAclProfileClientConnectExceptionsResponse:
properties:
data:
items:
$ref: '#/definitions/MsgVpnAclProfileClientConnectException'
type: array
links:
items:
$ref: '#/definitions/MsgVpnAclProfileClientConnectExceptionLinks'
type: array
meta:
$ref: '#/definitions/SempMeta'
required:
- meta
type: object
MsgVpnAclProfileLinks:
properties:
clientConnectExceptionsUri:
description: The URI of this MsgVpnAclProfile's clientConnectExceptions collection.
type: string
publishExceptionsUri:
description: The URI of this MsgVpnAclProfile's publishExceptions collection.
type: string
subscribeExceptionsUri:
description: The URI of this MsgVpnAclProfile's subscribeExceptions collection.
type: string
uri:
description: The URI of this MsgVpnAclProfile object.
type: string
type: object
MsgVpnAclProfilePublishException:
properties:
aclProfileName:
description: The name of the ACL Profile.
type: string
msgVpnName:
description: The name of the Message VPN.
type: string
publishExceptionTopic:
description: The topic of the Publish Exception. May include syntax-appropriate
wildcards.
type: string
topicSyntax:
description: "The syntax of the topic of the Publish Exception. The allowed\
\ values and their meaning are:\n\n \"smf\" - Topic uses SMF syntax.\n\
\ \"mqtt\" - Topic uses MQTT syntax.\n"
enum:
- smf
- mqtt
type: string
type: object
MsgVpnAclProfilePublishExceptionLinks:
properties:
uri:
description: The URI of this MsgVpnAclProfilePublishException object.
type: string
type: object
MsgVpnAclProfilePublishExceptionResponse:
properties:
data:
$ref: '#/definitions/MsgVpnAclProfilePublishException'
links:
$ref: '#/definitions/MsgVpnAclProfilePublishExceptionLinks'
meta:
$ref: '#/definitions/SempMeta'
required:
- meta
type: object
MsgVpnAclProfilePublishExceptionsResponse:
properties:
data:
items:
$ref: '#/definitions/MsgVpnAclProfilePublishException'
type: array
links:
items:
$ref: '#/definitions/MsgVpnAclProfilePublishExceptionLinks'
type: array
meta:
$ref: '#/definitions/SempMeta'
required:
- meta
type: object
MsgVpnAclProfileResponse:
properties:
data:
$ref: '#/definitions/MsgVpnAclProfile'
links:
$ref: '#/definitions/MsgVpnAclProfileLinks'
meta:
$ref: '#/definitions/SempMeta'
required:
- meta
type: object
MsgVpnAclProfileSubscribeException:
properties:
aclProfileName:
description: The name of the ACL Profile.
type: string
msgVpnName:
description: The name of the Message VPN.
type: string
subscribeExceptionTopic:
description: The topic of the Subscribe Exception. May include syntax-appropriate
wildcards.
type: string
topicSyntax:
description: "The syntax of the topic of the Subscribe Exception. The allowed\
\ values and their meaning are:\n\n \"smf\" - Topic uses SMF syntax.\n\
\ \"mqtt\" - Topic uses MQTT syntax.\n"
enum:
- smf
- mqtt
type: string
type: object
MsgVpnAclProfileSubscribeExceptionLinks:
properties:
uri:
description: The URI of this MsgVpnAclProfileSubscribeException object.
type: string
type: object
MsgVpnAclProfileSubscribeExceptionResponse:
properties:
data:
$ref: '#/definitions/MsgVpnAclProfileSubscribeException'
links:
$ref: '#/definitions/MsgVpnAclProfileSubscribeExceptionLinks'
meta:
$ref: '#/definitions/SempMeta'
required:
- meta
type: object
MsgVpnAclProfileSubscribeExceptionsResponse:
properties:
data:
items:
$ref: '#/definitions/MsgVpnAclProfileSubscribeException'
type: array
links:
items:
$ref: '#/definitions/MsgVpnAclProfileSubscribeExceptionLinks'
type: array
meta:
$ref: '#/definitions/SempMeta'
required:
- meta
type: object
MsgVpnAclProfilesResponse:
properties:
data:
items:
$ref: '#/definitions/MsgVpnAclProfile'
type: array
links:
items:
$ref: '#/definitions/MsgVpnAclProfileLinks'
type: array
meta:
$ref: '#/definitions/SempMeta'
required:
- meta
type: object
MsgVpnAuthorizationGroup:
properties:
aclProfileName:
description: The ACL Profile of the LDAP Authorization Group. The default
value is `"default"`.
type: string
authorizationGroupName:
description: The name of the LDAP Authorization Group.
type: string
clientProfileName:
description: The Client Profile of the LDAP Authorization Group. The default
value is `"default"`.
type: string
enabled:
description: Enable or disable the authorization feature for this group for
the Message VPN. The default value is `false`.
type: boolean
msgVpnName:
description: The name of the Message VPN.
type: string
orderAfterAuthorizationGroupName:
description: Lower the priority to be less than this group. The default is
not applicable.
type: string
orderBeforeAuthorizationGroupName:
description: Raise the priority to be greater than this group. The default
is not applicable.
type: string
type: object
MsgVpnAuthorizationGroupLinks:
properties:
uri:
description: The URI of this MsgVpnAuthorizationGroup object.
type: string
type: object
MsgVpnAuthorizationGroupResponse:
properties:
data:
$ref: '#/definitions/MsgVpnAuthorizationGroup'
links:
$ref: '#/definitions/MsgVpnAuthorizationGroupLinks'
meta:
$ref: '#/definitions/SempMeta'
required:
- meta
type: object
MsgVpnAuthorizationGroupsResponse:
properties:
data:
items:
$ref: '#/definitions/MsgVpnAuthorizationGroup'
type: array
links:
items:
$ref: '#/definitions/MsgVpnAuthorizationGroupLinks'
type: array
meta:
$ref: '#/definitions/SempMeta'
required:
- meta
type: object
MsgVpnBridge:
properties:
bridgeName:
description: The name of the Bridge.
type: string
bridgeVirtualRouter:
description: "The virtual-router of the Bridge. The allowed values and their\
\ meaning are:\n\n \"primary\" - Bridge belongs to the primary virtual-router.\n\
\ \"backup\" - Bridge belongs to the backup virtual-router.\n"
enum:
- primary
- backup
type: string
enabled:
description: Enable or disable the bridge. The default value is `false`.
type: boolean
maxTtl:
description: The max-ttl value for the bridge, in hops. When a bridge is sending
a message to the remote router, the TTL value for the message becomes the
lower of its current TTL value or this value. The default value is `8`.
type: integer
msgVpnName:
description: The name of the Message VPN.
type: string
remoteAuthenticationBasicClientUsername:
description: The client username the bridge uses to login to the Remote Message
VPN. The default is to have no `remoteAuthenticationBasicClientUsername`.
type: string
remoteAuthenticationBasicPassword:
description: The password for the client username the bridge uses to login
to the Remote Message VPN. The default is to have no `remoteAuthenticationBasicPassword`.
type: string
remoteAuthenticationScheme:
description: "The authentication scheme for the Remote Message VPN. The default\
\ value is `\"basic\"`. The allowed values and their meaning are:\n\n \
\ \"basic\" - Basic Authentication Scheme (via username and password).\n\
\ \"client-certificate\" - Client Certificate Authentication Scheme (via\
\ certificate-file).\n"
enum:
- basic
- client-certificate
type: string
remoteConnectionRetryCount:
description: The number of retries that are attempted for a router name before
the next remote router alternative is attempted. The default value is `0`.
type: integer
remoteConnectionRetryDelay:
description: The number of seconds that must pass before retrying a connection.
The default value is `3`.
type: integer
remoteDeliverToOnePriority:
description: "The deliver-to-one priority for the bridge used on the remote\
\ router. The default value is `\"p1\"`. The allowed values and their meaning\
\ are:\n\n \"p1\" - Priority 1 (highest).\n \"p2\" - Priority 2.\n\
\ \"p3\" - Priority 3.\n \"p4\" - Priority 4 (lowest).\n \"da\"\
\ - Deliver Always.\n"
enum:
- p1
- p2
- p3
- p4
- da
type: string
tlsCipherSuiteList:
description: The colon-separated list of of cipher suites for the TLS authentication
mechanism. The suite selected will be the first suite in the list that is
supported by the remote router. The default value is `"ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:AES256-GCM-SHA384:AES256-SHA256:AES256-SHA:ECDHE-RSA-DES-CBC3-SHA:DES-CBC3-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:AES128-GCM-SHA256:AES128-SHA256:AES128-SHA"`.
type: string
type: object
MsgVpnBridgeLinks:
properties:
remoteMsgVpnsUri:
description: The URI of this MsgVpnBridge's remoteMsgVpns collection.
type: string
remoteSubscriptionsUri:
description: The URI of this MsgVpnBridge's remoteSubscriptions collection.
type: string
tlsTrustedCommonNamesUri:
description: The URI of this MsgVpnBridge's tlsTrustedCommonNames collection.
type: string
uri:
description: The URI of this MsgVpnBridge object.
type: string
type: object
MsgVpnBridgeRemoteMsgVpn:
properties:
bridgeName:
description: The name of the Bridge.
type: string
bridgeVirtualRouter:
description: "The virtual-router of the Bridge. The allowed values and their\
\ meaning are:\n\n \"primary\" - Bridge belongs to the primary virtual-router.\n\
\ \"backup\" - Bridge belongs to the backup virtual-router.\n"
enum:
- primary
- backup
type: string
clientUsername:
description: The client username the bridge uses to login to the Remote Message
VPN. This per Remote Message VPN value overrides the value provided for
the bridge overall. The default is to have no `clientUsername`.
type: string
compressedDataEnabled:
description: Enable or disable data compression for the Remote Message VPN.
The default value is `false`.
type: boolean
connectOrder:
description: The order in which attempts to connect to different Message VPN
hosts are attempted, or the preference given to incoming connections from
remote routers, from `1` (highest priority) to `4` (lowest priority). The
default value is `4`.
type: integer
egressFlowWindowSize:
description: The window size indicates how many outstanding guaranteed messages
can be sent over the Remote Message VPN connection before acknowledgement
is received by the sender. The default value is `255`.
type: integer
enabled:
description: Enable or disable the Remote Message VPN. The default value is
`false`.
type: boolean
msgVpnName:
description: The name of the Message VPN.
type: string
password:
description: The password for the client username the bridge uses to login
to the Remote Message VPN. The default is to have no `password`.
type: string
queueBinding:
description: The queue binding of the bridge for this Remote Message VPN.
The bridge attempts to bind to that queue over the bridge link once the
link has been established, or immediately if it already is established.
The queue must be configured on the remote router when the bridge connection
is established. If the bind fails an event log is generated which includes
the reason for the failure. The default is to have no `queueBinding`.
type: string
remoteMsgVpnInterface:
description: The interface on the local router through which to access the
Remote Message VPN. If not provided (recommended) then an interface will
be chosen automatically based on routing tables. If an interface is provided,
`remoteMsgVpnLocation` must be either a hostname or IP address, not a virtual
router-name.
type: string
remoteMsgVpnLocation:
description: The location of the Remote Message VPN. This may be given as
either a hostname (resolvable via DNS), IP Address, or virtual router-name
(starts with 'v:'). If specified as a hostname or IP Address, a port must
be specified as well.
type: string
remoteMsgVpnName:
description: The name of the Remote Message VPN.
type: string
tlsEnabled:
description: Enable or disable TLS for the Remote Message VPN. The default
value is `false`.
type: boolean
unidirectionalClientProfile:
description: The client-profile for the unidirectional bridge for the Remote
Message VPN. The client-profile must exist in the local Message VPN, and
it is used only for the TCP parameters. The default value is `"#client-profile"`.
type: string
type: object
MsgVpnBridgeRemoteMsgVpnLinks:
properties:
uri:
description: The URI of this MsgVpnBridgeRemoteMsgVpn object.
type: string
type: object
MsgVpnBridgeRemoteMsgVpnResponse:
properties:
data:
$ref: '#/definitions/MsgVpnBridgeRemoteMsgVpn'
links:
$ref: '#/definitions/MsgVpnBridgeRemoteMsgVpnLinks'
meta:
$ref: '#/definitions/SempMeta'
required:
- meta
type: object
MsgVpnBridgeRemoteMsgVpnsResponse:
properties:
data:
items:
$ref: '#/definitions/MsgVpnBridgeRemoteMsgVpn'
type: array
links:
items:
$ref: '#/definitions/MsgVpnBridgeRemoteMsgVpnLinks'
type: array
meta:
$ref: '#/definitions/SempMeta'
required:
- meta
type: object
MsgVpnBridgeRemoteSubscription:
properties:
bridgeName:
description: The name of the Bridge.
type: string
bridgeVirtualRouter:
description: "The virtual-router of the Bridge. The allowed values and their\
\ meaning are:\n\n \"primary\" - Bridge belongs to the primary virtual-router.\n\
\ \"backup\" - Bridge belongs to the backup virtual-router.\n"
enum:
- primary
- backup
type: string
deliverAlwaysEnabled:
description: Flag the topic as deliver-always instead of with the configured
deliver-to-one remote-priority value for the bridge. A given topic may be
deliver-to-one or deliver-always but not both.
type: boolean
msgVpnName:
description: The name of the Message VPN.
type: string
remoteSubscriptionTopic:
description: The topic of the Remote Subscription.
type: string
type: object
MsgVpnBridgeRemoteSubscriptionLinks:
properties:
uri:
description: The URI of this MsgVpnBridgeRemoteSubscription object.
type: string
type: object
MsgVpnBridgeRemoteSubscriptionResponse: