@itentialopensource/adapter-paragon_pathfinder 1.2.7 → 1.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. package/CALLS.md +30 -0
  2. package/CHANGELOG.md +8 -0
  3. package/adapter.js +418 -0
  4. package/entities/Config/schema.json +1 -1
  5. package/entities/Netconf/schema.json +1 -1
  6. package/entities/Scheduler/schema.json +1 -1
  7. package/entities/Topology/action.json +102 -0
  8. package/entities/Topology/schema.json +7 -2
  9. package/entities/TransportControllerGroups/schema.json +1 -1
  10. package/entities/TransportControllers/schema.json +1 -1
  11. package/package.json +1 -1
  12. package/pronghorn.json +1593 -0
  13. package/refs?service=git-upload-pack +0 -0
  14. package/report/adapterInfo.json +7 -7
  15. package/report/update-pathfinder-api-v2.json +31139 -0
  16. package/test/integration/adapterTestIntegration.js +453 -0
  17. package/test/unit/adapterTestUnit.js +162 -0
package/pronghorn.json CHANGED
@@ -28972,6 +28972,1599 @@
28972
28972
  "path": "/getComponentConfig"
28973
28973
  },
28974
28974
  "task": true
28975
+ },
28976
+ {
28977
+ "name": "getTopologyV2TopologyIdIpePolicy",
28978
+ "summary": "Get all IPE Policie",
28979
+ "description": "Get all IPE Policies",
28980
+ "input": [
28981
+ {
28982
+ "name": "topologyId",
28983
+ "type": "number",
28984
+ "info": "A unique identifier for the topology. In Paragon PathFinder version 2, the unique identifier is set to 1. \n \n: 123",
28985
+ "required": true,
28986
+ "schema": {
28987
+ "title": "topologyId",
28988
+ "type": "number"
28989
+ }
28990
+ }
28991
+ ],
28992
+ "output": {
28993
+ "name": "result",
28994
+ "type": "object",
28995
+ "description": "A JSON Object containing status, code and the result",
28996
+ "schema": {
28997
+ "title": "result",
28998
+ "type": "object"
28999
+ }
29000
+ },
29001
+ "roles": [
29002
+ "admin"
29003
+ ],
29004
+ "route": {
29005
+ "verb": "POST",
29006
+ "path": "/getTopologyV2TopologyIdIpePolicy"
29007
+ },
29008
+ "task": true
29009
+ },
29010
+ {
29011
+ "name": "postTopologyV2TopologyIdIpePolicy",
29012
+ "summary": "Create IPE Policies",
29013
+ "description": "Create IPE Policies",
29014
+ "input": [
29015
+ {
29016
+ "name": "topologyId",
29017
+ "type": "number",
29018
+ "info": "A unique identifier for the topology. In Paragon PathFinder version 2, the unique identifier is set to 1. \n \n: 123",
29019
+ "required": true,
29020
+ "schema": {
29021
+ "title": "topologyId",
29022
+ "type": "number"
29023
+ }
29024
+ },
29025
+ {
29026
+ "name": "body",
29027
+ "type": "array",
29028
+ "info": ": array",
29029
+ "required": false,
29030
+ "schema": {
29031
+ "items": {
29032
+ "additionalProperties": false,
29033
+ "allOf": [
29034
+ {},
29035
+ {}
29036
+ ],
29037
+ "description": "Set of parameters allowed on IP policy creation",
29038
+ "properties": {
29039
+ "asPath": {
29040
+ "description": "The AS path regular expression used as the match condition for an IPE policy ",
29041
+ "properties": {
29042
+ "regex": {
29043
+ "pattern": "^[0-9{},*+?|\\-^$()\\[\\].,_ ]+$",
29044
+ "type": "string"
29045
+ }
29046
+ },
29047
+ "required": [
29048
+ "regex"
29049
+ ],
29050
+ "type": "object"
29051
+ },
29052
+ "med": {
29053
+ "maximum": 4294967295,
29054
+ "minimum": 0,
29055
+ "type": "integer"
29056
+ },
29057
+ "neighbor": {},
29058
+ "node": {
29059
+ "description": "represents a single node",
29060
+ "properties": {
29061
+ "AutonomousSystem": {
29062
+ "additionalProperties": false,
29063
+ "properties": {
29064
+ "asNumber": {}
29065
+ },
29066
+ "required": [
29067
+ "asNumber"
29068
+ ],
29069
+ "title": "siteAS Number",
29070
+ "type": "object"
29071
+ },
29072
+ "activeAssurance": {
29073
+ "description": "only valid for layer == ActiveAssurance, contains Test agent association data",
29074
+ "properties": {
29075
+ "agentPath": {
29076
+ "description": "URI to the RESTCONF test agent",
29077
+ "type": "string"
29078
+ }
29079
+ },
29080
+ "type": "object"
29081
+ },
29082
+ "comment": {
29083
+ "description": "Comment",
29084
+ "type": "string"
29085
+ },
29086
+ "configurationDataSource": {
29087
+ "description": "For node whith configuration collection configured, this attributes provide the configuration data source",
29088
+ "properties": {
29089
+ "latest": {
29090
+ "properties": {
29091
+ "href": {
29092
+ "type": "string"
29093
+ },
29094
+ "rel": {
29095
+ "type": "string"
29096
+ },
29097
+ "schema": {
29098
+ "description": "Optional schema information."
29099
+ },
29100
+ "type": {
29101
+ "type": "string"
29102
+ }
29103
+ },
29104
+ "type": "object"
29105
+ }
29106
+ },
29107
+ "type": "object"
29108
+ },
29109
+ "design": {
29110
+ "description": "user-defined design properties",
29111
+ "properties": {
29112
+ "delay": {
29113
+ "description": "node delay in milliseconds",
29114
+ "type": "integer"
29115
+ },
29116
+ "simulation": {
29117
+ "properties": {
29118
+ "canFail": {
29119
+ "type": "boolean"
29120
+ }
29121
+ },
29122
+ "type": "object"
29123
+ },
29124
+ "trafficRerouteThreshold": {
29125
+ "description": "the percentage of utilization that trigger a reroute based on analytics",
29126
+ "maximum": 100,
29127
+ "minimum": 0,
29128
+ "type": "integer"
29129
+ },
29130
+ "userCost": {
29131
+ "description": "User metric",
29132
+ "type": "number"
29133
+ }
29134
+ },
29135
+ "type": "object"
29136
+ },
29137
+ "deviceUuid": {
29138
+ "description": "Uuid of the device correspodning to this node",
29139
+ "type": "string"
29140
+ },
29141
+ "epeProperties": {
29142
+ "additionalProperties": false,
29143
+ "properties": {
29144
+ "bandwidth": {
29145
+ "description": "bandwidth reserved for Egress Peer Engineering",
29146
+ "type": "integer"
29147
+ },
29148
+ "externalRates": {
29149
+ "description": "list of ipv4 and/or ipv6 prefix objects",
29150
+ "items": {},
29151
+ "type": "array"
29152
+ },
29153
+ "internalRate": {
29154
+ "description": "the cost per bandwidth unit for using this tunnel for Egress Peer Engineering",
29155
+ "type": "integer"
29156
+ },
29157
+ "peeringRatePlan": {
29158
+ "description": "an ordered list of bandwidth bounds and peering rates for bandwidth below that bound (and above the pervious bound)",
29159
+ "items": {
29160
+ "additionalProperties": false,
29161
+ "properties": {
29162
+ "bound": {
29163
+ "description": "bandwidth bound of point where cost rate changes",
29164
+ "type": "integer"
29165
+ },
29166
+ "rate": {
29167
+ "description": "cost rate of bandwidth between this and previous bound",
29168
+ "type": "integer"
29169
+ }
29170
+ },
29171
+ "required": [
29172
+ "bound",
29173
+ "rate"
29174
+ ],
29175
+ "type": "object"
29176
+ },
29177
+ "type": "array"
29178
+ }
29179
+ },
29180
+ "type": "object"
29181
+ },
29182
+ "extraIpAddresses": {
29183
+ "items": {},
29184
+ "type": "array"
29185
+ },
29186
+ "hostName": {
29187
+ "description": "node hostname",
29188
+ "maxLength": 255,
29189
+ "minLength": 1,
29190
+ "type": "string"
29191
+ },
29192
+ "id": {
29193
+ "description": "object name, string without space, comma, limited to 64 chars (repeated due to some validator handling of references)",
29194
+ "maxLength": 255,
29195
+ "minLength": 1,
29196
+ "pattern": "^[a-zA-Z0-9_\\-\\.\\:\\>\\<]*$",
29197
+ "type": "string"
29198
+ },
29199
+ "layer": {
29200
+ "description": "node layer",
29201
+ "type": "string"
29202
+ },
29203
+ "live": {
29204
+ "description": "indicate if the node has properties coming from topology acquisition",
29205
+ "type": "boolean"
29206
+ },
29207
+ "logicalSystemParent": {
29208
+ "description": "For logical system discovered using CLI/Netconf data, this is set for logical system and contains the hostname of the logical system parent (i.e real router). This property is read-only",
29209
+ "type": "string"
29210
+ },
29211
+ "name": {
29212
+ "description": "object name, string without space, comma, limited to 64 chars (repeated due to some validator handling of references)",
29213
+ "maxLength": 255,
29214
+ "minLength": 1,
29215
+ "pattern": "^[a-zA-Z0-9_\\-\\.\\:\\>\\<]*$",
29216
+ "type": "string"
29217
+ },
29218
+ "nodeIndex": {
29219
+ "description": "Application Server index",
29220
+ "type": "integer"
29221
+ },
29222
+ "nodeType": {
29223
+ "description": "node hardware type (any user string)",
29224
+ "type": "string"
29225
+ },
29226
+ "prefixes": {
29227
+ "items": {
29228
+ "properties": {
29229
+ "SR": {
29230
+ "properties": {
29231
+ "algo": {
29232
+ "description": "Spring Algorithm (0 for ECMP-aware CSPF, 1 for strict ECMP aware CSPF)",
29233
+ "type": "number"
29234
+ },
29235
+ "flags": {
29236
+ "description": "Flags associated to this prefix, see draft-ietf-isis-segment-routing-extensions-07#section-2.1, Flags not defined for OSPF are 0",
29237
+ "type": "number"
29238
+ },
29239
+ "index": {
29240
+ "description": "Index of the prefix in the global SR tables",
29241
+ "type": "number"
29242
+ }
29243
+ },
29244
+ "type": "object"
29245
+ },
29246
+ "SRv6": {
29247
+ "properties": {
29248
+ "algo": {
29249
+ "description": "Algorithm associated with the SID",
29250
+ "type": "number"
29251
+ },
29252
+ "flags": {
29253
+ "description": "Flags associated to this ipv6 prefix, see draft-ietf-idr-bgpls-srv6-ext#page-10",
29254
+ "type": "number"
29255
+ },
29256
+ "metric": {
29257
+ "description": "The value of the metric for the Locator",
29258
+ "type": "number"
29259
+ }
29260
+ },
29261
+ "type": "object"
29262
+ },
29263
+ "role": {
29264
+ "description": "indicate the role of the address when its derived from a particular protocol, for instance routerID, teRouterID, ipv6address,..etc ",
29265
+ "type": "string"
29266
+ }
29267
+ },
29268
+ "type": "object"
29269
+ },
29270
+ "type": "array"
29271
+ },
29272
+ "protocols": {
29273
+ "description": "protocols configuration and information on the node",
29274
+ "properties": {
29275
+ "BGP": {
29276
+ "additionalProperties": false,
29277
+ "properties": {
29278
+ "AutonomousSystem": {
29279
+ "additionalProperties": false,
29280
+ "properties": {
29281
+ "asNumber": {}
29282
+ },
29283
+ "required": [
29284
+ "asNumber"
29285
+ ],
29286
+ "title": "siteAS Number",
29287
+ "type": "object"
29288
+ },
29289
+ "id": {
29290
+ "type": "string"
29291
+ }
29292
+ },
29293
+ "type": "object"
29294
+ },
29295
+ "ISIS": {
29296
+ "additionalProperties": false,
29297
+ "properties": {
29298
+ "TERouterId": {
29299
+ "type": "string"
29300
+ },
29301
+ "TERouterIdIPv6": {
29302
+ "type": "string"
29303
+ },
29304
+ "area": {
29305
+ "type": "string"
29306
+ },
29307
+ "isoAddress": {
29308
+ "type": "string"
29309
+ },
29310
+ "overloadBit": {
29311
+ "description": "ISIS overload bit set (from device collection)",
29312
+ "type": "boolean"
29313
+ },
29314
+ "routerId": {
29315
+ "type": "string"
29316
+ },
29317
+ "routerIdIPv6": {
29318
+ "type": "string"
29319
+ }
29320
+ },
29321
+ "type": "object"
29322
+ },
29323
+ "NETCONF": {
29324
+ "description": "Netconf provisioning protocol status",
29325
+ "properties": {
29326
+ "clientAddress": {},
29327
+ "clientCapabilities": {
29328
+ "items": {
29329
+ "description": "NETCONF discovered capabilitu, for instance urn:ietf:params:netconf:base:1.0",
29330
+ "type": "string"
29331
+ },
29332
+ "type": "array"
29333
+ },
29334
+ "operationalState": {
29335
+ "enum": [
29336
+ "Connected",
29337
+ "Disconnected",
29338
+ "Session_close",
29339
+ "Connecting",
29340
+ "Invalid_credentials",
29341
+ "Deleted"
29342
+ ],
29343
+ "type": "string"
29344
+ },
29345
+ "operationalStatus": {
29346
+ "description": "Operational status",
29347
+ "enum": [
29348
+ "Up",
29349
+ "Down",
29350
+ "Unknown",
29351
+ "Empty"
29352
+ ],
29353
+ "type": "string"
29354
+ },
29355
+ "sessionParameters": {
29356
+ "description": "remote peer NETCONF session parameters",
29357
+ "properties": {
29358
+ "keepalive": {
29359
+ "description": "session keepalive time, in seconds",
29360
+ "type": "integer"
29361
+ }
29362
+ },
29363
+ "type": "object"
29364
+ }
29365
+ },
29366
+ "type": "object"
29367
+ },
29368
+ "OSPF": {
29369
+ "additionalProperties": false,
29370
+ "properties": {
29371
+ "TERouterId": {
29372
+ "type": "string"
29373
+ },
29374
+ "TERouterIdIPv6": {
29375
+ "type": "string"
29376
+ },
29377
+ "overloadBit": {
29378
+ "description": "OSPF overload bit set (from device collection)",
29379
+ "type": "boolean"
29380
+ },
29381
+ "referenceBw": {
29382
+ "description": "OSPF reference bandwidth (read-only,from device collection)",
29383
+ "type": "number"
29384
+ },
29385
+ "routerId": {
29386
+ "type": "string"
29387
+ },
29388
+ "routerIdIPv6": {
29389
+ "type": "string"
29390
+ }
29391
+ },
29392
+ "type": "object"
29393
+ },
29394
+ "PCEP": {
29395
+ "additionalProperties": false,
29396
+ "properties": {
29397
+ "extensions": {
29398
+ "description": "forces NorthStar support of specific extensions",
29399
+ "properties": {
29400
+ "lsp-association-protection": {
29401
+ "description": "Support for Primary/Secondary LSP using draft-ananthakrishnan-pce-stateful-path-protection-00. ",
29402
+ "type": "boolean"
29403
+ }
29404
+ },
29405
+ "type": "object"
29406
+ },
29407
+ "operationalStatus": {
29408
+ "description": "Operational status",
29409
+ "enum": [
29410
+ "Up",
29411
+ "Down",
29412
+ "Unknown",
29413
+ "Empty"
29414
+ ],
29415
+ "type": "string"
29416
+ },
29417
+ "pccAddress": {},
29418
+ "peerStatefullCapabilities": {
29419
+ "description": "represents the remote peer advertised capabilites",
29420
+ "properties": {
29421
+ "SRCapability": {
29422
+ "description": "Segment Routing capability",
29423
+ "type": "boolean"
29424
+ },
29425
+ "SRv6Capability": {
29426
+ "description": "Segment Routing v6 capability",
29427
+ "type": "boolean"
29428
+ },
29429
+ "lspInstantiation": {
29430
+ "description": "Stateful PCE LSP Create",
29431
+ "type": "boolean"
29432
+ },
29433
+ "lspUpdate": {
29434
+ "description": "Stateful PCE LSP Update ",
29435
+ "type": "boolean"
29436
+ },
29437
+ "p2mp": {
29438
+ "description": "Stateful PCE P2MP LSP reporting",
29439
+ "type": "boolean"
29440
+ },
29441
+ "p2mpInstantiation": {
29442
+ "description": "Stateful PCE P2MP LSP Create",
29443
+ "type": "boolean"
29444
+ },
29445
+ "p2mpUpdate": {
29446
+ "description": "Stateful PCE P2MP LSP Update",
29447
+ "type": "boolean"
29448
+ }
29449
+ },
29450
+ "type": "object"
29451
+ },
29452
+ "sessionParameters": {
29453
+ "description": "remote peer pcep session parameters",
29454
+ "properties": {
29455
+ "deadtimer": {
29456
+ "description": "PCEP session DeadTimer time, in seconds",
29457
+ "type": "integer"
29458
+ },
29459
+ "keepalive": {
29460
+ "description": "PCEP session keepalive time, in seconds",
29461
+ "type": "integer"
29462
+ },
29463
+ "maximumStackDepth": {
29464
+ "description": "The SR maximum Stack Depth (MSD) reported by the PCC",
29465
+ "type": "integer"
29466
+ }
29467
+ },
29468
+ "type": "object"
29469
+ }
29470
+ },
29471
+ "type": "object"
29472
+ },
29473
+ "SR": {
29474
+ "description": "Represent the node Segment Routing (SR) parameters",
29475
+ "properties": {
29476
+ "SRGBs": {
29477
+ "description": "List of SRGB Ranges",
29478
+ "items": {
29479
+ "description": "One range",
29480
+ "properties": {
29481
+ "range": {
29482
+ "type": "integer"
29483
+ },
29484
+ "start": {
29485
+ "type": "integer"
29486
+ }
29487
+ },
29488
+ "type": "object"
29489
+ },
29490
+ "type": "array"
29491
+ },
29492
+ "capabilities": {
29493
+ "additionalProperties": false,
29494
+ "description": "Options for path computation for SR",
29495
+ "properties": {
29496
+ "unrestrictedFirstHop": {
29497
+ "default": false,
29498
+ "description": "if not present or set to false, NorthStar will always include an adjacency SID as first hop. If set to true this won't be enforced",
29499
+ "type": "boolean"
29500
+ }
29501
+ },
29502
+ "type": "object"
29503
+ },
29504
+ "enabled": {
29505
+ "description": "If true the node can be used to route SR Tunnels. This flag is set to true if the node has SRGB and a node index (Prefix with routerId role and SR properties)",
29506
+ "type": "boolean"
29507
+ },
29508
+ "nodeCapabilities": {
29509
+ "description": "The Node capabilities, as defined in draft-ietf-isis-segment-routing-extensions-07#section-3, draft-ietf-ospf-ospfv3-segment-routing-extensions-05#section-3.3 ",
29510
+ "type": "integer"
29511
+ }
29512
+ },
29513
+ "type": "object"
29514
+ },
29515
+ "SRv6": {
29516
+ "description": "Represent the node Segment Routing v6 (SRv6) parameters",
29517
+ "properties": {
29518
+ "enabled": {
29519
+ "description": "Ignored on create, If true the node can be used to route SRv6 Tunnels. This flag is set to true if the node has msd type and a node index (Prefix with routerIdIPv6 role and SRv6 properties)",
29520
+ "type": "boolean"
29521
+ },
29522
+ "msdType": {
29523
+ "description": "node SRv6 capabilities",
29524
+ "properties": {
29525
+ "baseMplsImposition": {
29526
+ "type": "number"
29527
+ },
29528
+ "erld": {
29529
+ "type": "number"
29530
+ },
29531
+ "srhMaxEndD": {
29532
+ "type": "number"
29533
+ },
29534
+ "srhMaxEndPop": {
29535
+ "type": "number"
29536
+ },
29537
+ "srhMaxHEncaps": {
29538
+ "type": "number"
29539
+ },
29540
+ "srhMaxLs": {
29541
+ "type": "number"
29542
+ }
29543
+ },
29544
+ "type": "object"
29545
+ },
29546
+ "nodeCapabilities": {
29547
+ "description": "The Node capabilities of SRv6, as defined in draft-ietf-idr-bgpls-srv6-ext#section-3.1 ",
29548
+ "type": "integer"
29549
+ }
29550
+ },
29551
+ "type": "object"
29552
+ },
29553
+ "management": {
29554
+ "description": "Management Protocol information schema",
29555
+ "properties": {
29556
+ "address": {},
29557
+ "operatingSystem": {
29558
+ "description": "operating system information",
29559
+ "maxLength": 31,
29560
+ "type": "string"
29561
+ },
29562
+ "operatingSystemVersion": {
29563
+ "description": "operating system Version",
29564
+ "type": "string"
29565
+ },
29566
+ "vendor": {
29567
+ "description": "Device vendor. This is a free text with the following special values that influence NorthStar behavior: JUNIPER, CISCO (legacy cisco devices), Alcatel, HUAWEI, IOS-XR, SITE, CE. This parameter is inherited from device profile and also can be discovered by device collection. SITE and CE Nodes vendor type influence the LSP signaling: those nodes are pruned from the signaled path. Nodes with CE/SITE vendor are used for path computation but not signaling, allowing NorthStar to include routing constraints behond the PE node.",
29568
+ "maxLength": 31,
29569
+ "type": "string"
29570
+ }
29571
+ },
29572
+ "type": "object"
29573
+ }
29574
+ },
29575
+ "type": "object"
29576
+ },
29577
+ "pseudoNode": {
29578
+ "default": false,
29579
+ "description": "indicates if the node is a pseudo node created by the underlying IGP protocol",
29580
+ "type": "boolean"
29581
+ },
29582
+ "routerId": {
29583
+ "description": "router ID derived from protocols or device collection, read only",
29584
+ "type": "string"
29585
+ },
29586
+ "routerIdIPv6": {
29587
+ "description": "IPv6 router ID derived from device collection, read only",
29588
+ "type": "string"
29589
+ },
29590
+ "site": {
29591
+ "description": "node site ID",
29592
+ "type": "string"
29593
+ },
29594
+ "slices": {
29595
+ "items": {
29596
+ "additionalProperties": true,
29597
+ "description": "Minimal reference to a slice. Only the sliceId is processed unless explicitely mentioned by the refering schema.",
29598
+ "properties": {
29599
+ "sliceId": {
29600
+ "description": "Application server index limited to uint32.",
29601
+ "maximum": 4294967295,
29602
+ "minimum": 0,
29603
+ "type": "integer"
29604
+ }
29605
+ },
29606
+ "required": [
29607
+ "sliceId"
29608
+ ],
29609
+ "type": "object"
29610
+ },
29611
+ "type": "array"
29612
+ },
29613
+ "switchingCapabilities": {
29614
+ "items": {
29615
+ "additionalProperties": false,
29616
+ "description": "description of the interface type, based on transport topology",
29617
+ "properties": {
29618
+ "encoding": {
29619
+ "enum": [
29620
+ "lsp-encoding-pdh",
29621
+ "lsp-encoding-optical-channel",
29622
+ "lsp-encoding-sdh",
29623
+ "lsp-encoding-packet",
29624
+ "lsp-encoding-digital-wrapper",
29625
+ "lsp-encoding-fiber",
29626
+ "lsp-encoding-line",
29627
+ "lsp-encoding-ethernet",
29628
+ "lsp-encoding-fiber-channel",
29629
+ "lsp-encoding-oduk",
29630
+ "lsp-encoding-lambda"
29631
+ ],
29632
+ "type": "string"
29633
+ },
29634
+ "switchingCapability": {
29635
+ "enum": [
29636
+ "switching-packet",
29637
+ "switching-dcsc",
29638
+ "switching-otn",
29639
+ "switching-psc1",
29640
+ "switching-lsc",
29641
+ "switching-evpl",
29642
+ "switching-tdm",
29643
+ "switching-fsc",
29644
+ "switching-l2sc"
29645
+ ],
29646
+ "type": "string"
29647
+ }
29648
+ },
29649
+ "type": "object"
29650
+ },
29651
+ "type": "array"
29652
+ },
29653
+ "topoObjectType": {
29654
+ "enum": [
29655
+ "node"
29656
+ ],
29657
+ "type": "string"
29658
+ },
29659
+ "topology": {
29660
+ "additionalProperties": false,
29661
+ "properties": {
29662
+ "coordinates": {
29663
+ "description": "Schema for a Geo JSON object",
29664
+ "properties": {
29665
+ "bbox": {
29666
+ "description": "A bounding box as defined by GeoJSON",
29667
+ "items": {
29668
+ "type": "number"
29669
+ },
29670
+ "type": "array"
29671
+ },
29672
+ "crs": {
29673
+ "additionalProperties": false,
29674
+ "description": "a Coordinate Reference System object",
29675
+ "properties": {
29676
+ "properties": {
29677
+ "type": "object"
29678
+ },
29679
+ "type": {
29680
+ "type": "string"
29681
+ }
29682
+ },
29683
+ "required": [
29684
+ "type",
29685
+ "properties"
29686
+ ],
29687
+ "title": "crs",
29688
+ "type": "object"
29689
+ }
29690
+ },
29691
+ "required": [
29692
+ "type"
29693
+ ],
29694
+ "title": "Geo JSON object",
29695
+ "type": "object"
29696
+ }
29697
+ },
29698
+ "type": "object"
29699
+ },
29700
+ "topologyIndex": {
29701
+ "description": "Application Server index",
29702
+ "type": "integer"
29703
+ },
29704
+ "userProperties": {
29705
+ "type": "object"
29706
+ }
29707
+ },
29708
+ "required": [
29709
+ "topologyIndex",
29710
+ "topoObjectType",
29711
+ "id"
29712
+ ],
29713
+ "type": "object"
29714
+ },
29715
+ "prefix": {},
29716
+ "priority": {
29717
+ "maximum": 10,
29718
+ "minimum": 1,
29719
+ "type": "integer"
29720
+ }
29721
+ },
29722
+ "required": [
29723
+ "node",
29724
+ "neighbor"
29725
+ ],
29726
+ "type": "object"
29727
+ },
29728
+ "type": "array",
29729
+ "definitions": {}
29730
+ }
29731
+ }
29732
+ ],
29733
+ "output": {
29734
+ "name": "result",
29735
+ "type": "object",
29736
+ "description": "A JSON Object containing status, code and the result",
29737
+ "schema": {
29738
+ "title": "result",
29739
+ "type": "object"
29740
+ }
29741
+ },
29742
+ "roles": [
29743
+ "admin"
29744
+ ],
29745
+ "route": {
29746
+ "verb": "POST",
29747
+ "path": "/postTopologyV2TopologyIdIpePolicy"
29748
+ },
29749
+ "task": true
29750
+ },
29751
+ {
29752
+ "name": "putTopologyV2TopologyIdIpePolicy",
29753
+ "summary": "Update IPE Policies",
29754
+ "description": "Update IPE Policies",
29755
+ "input": [
29756
+ {
29757
+ "name": "topologyId",
29758
+ "type": "number",
29759
+ "info": "A unique identifier for the topology. In Paragon PathFinder version 2, the unique identifier is set to 1. \n \n: 123",
29760
+ "required": true,
29761
+ "schema": {
29762
+ "title": "topologyId",
29763
+ "type": "number"
29764
+ }
29765
+ },
29766
+ {
29767
+ "name": "body",
29768
+ "type": "array",
29769
+ "info": ": array",
29770
+ "required": false,
29771
+ "schema": {
29772
+ "items": {
29773
+ "additionalProperties": false,
29774
+ "description": "Set of parameters allowed on IP policy update",
29775
+ "properties": {
29776
+ "asPath": {
29777
+ "description": "The AS path regular expression used as the match condition for an IPE policy ",
29778
+ "properties": {
29779
+ "regex": {
29780
+ "pattern": "^[0-9{},*+?|\\-^$()\\[\\].,_ ]+$",
29781
+ "type": "string"
29782
+ }
29783
+ },
29784
+ "required": [
29785
+ "regex"
29786
+ ],
29787
+ "type": "object"
29788
+ },
29789
+ "id": {
29790
+ "description": "Application Server index",
29791
+ "type": "integer"
29792
+ },
29793
+ "med": {
29794
+ "maximum": 4294967295,
29795
+ "minimum": 0,
29796
+ "type": "integer"
29797
+ },
29798
+ "neighbor": {},
29799
+ "node": {
29800
+ "description": "represents a single node",
29801
+ "properties": {
29802
+ "AutonomousSystem": {
29803
+ "additionalProperties": false,
29804
+ "properties": {
29805
+ "asNumber": {}
29806
+ },
29807
+ "required": [
29808
+ "asNumber"
29809
+ ],
29810
+ "title": "siteAS Number",
29811
+ "type": "object"
29812
+ },
29813
+ "activeAssurance": {
29814
+ "description": "only valid for layer == ActiveAssurance, contains Test agent association data",
29815
+ "properties": {
29816
+ "agentPath": {
29817
+ "description": "URI to the RESTCONF test agent",
29818
+ "type": "string"
29819
+ }
29820
+ },
29821
+ "type": "object"
29822
+ },
29823
+ "comment": {
29824
+ "description": "Comment",
29825
+ "type": "string"
29826
+ },
29827
+ "configurationDataSource": {
29828
+ "description": "For node whith configuration collection configured, this attributes provide the configuration data source",
29829
+ "properties": {
29830
+ "latest": {
29831
+ "properties": {
29832
+ "href": {
29833
+ "type": "string"
29834
+ },
29835
+ "rel": {
29836
+ "type": "string"
29837
+ },
29838
+ "schema": {
29839
+ "description": "Optional schema information."
29840
+ },
29841
+ "type": {
29842
+ "type": "string"
29843
+ }
29844
+ },
29845
+ "type": "object"
29846
+ }
29847
+ },
29848
+ "type": "object"
29849
+ },
29850
+ "design": {
29851
+ "description": "user-defined design properties",
29852
+ "properties": {
29853
+ "delay": {
29854
+ "description": "node delay in milliseconds",
29855
+ "type": "integer"
29856
+ },
29857
+ "simulation": {
29858
+ "properties": {
29859
+ "canFail": {
29860
+ "type": "boolean"
29861
+ }
29862
+ },
29863
+ "type": "object"
29864
+ },
29865
+ "trafficRerouteThreshold": {
29866
+ "description": "the percentage of utilization that trigger a reroute based on analytics",
29867
+ "maximum": 100,
29868
+ "minimum": 0,
29869
+ "type": "integer"
29870
+ },
29871
+ "userCost": {
29872
+ "description": "User metric",
29873
+ "type": "number"
29874
+ }
29875
+ },
29876
+ "type": "object"
29877
+ },
29878
+ "deviceUuid": {
29879
+ "description": "Uuid of the device correspodning to this node",
29880
+ "type": "string"
29881
+ },
29882
+ "epeProperties": {
29883
+ "additionalProperties": false,
29884
+ "properties": {
29885
+ "bandwidth": {
29886
+ "description": "bandwidth reserved for Egress Peer Engineering",
29887
+ "type": "integer"
29888
+ },
29889
+ "externalRates": {
29890
+ "description": "list of ipv4 and/or ipv6 prefix objects",
29891
+ "items": {},
29892
+ "type": "array"
29893
+ },
29894
+ "internalRate": {
29895
+ "description": "the cost per bandwidth unit for using this tunnel for Egress Peer Engineering",
29896
+ "type": "integer"
29897
+ },
29898
+ "peeringRatePlan": {
29899
+ "description": "an ordered list of bandwidth bounds and peering rates for bandwidth below that bound (and above the pervious bound)",
29900
+ "items": {
29901
+ "additionalProperties": false,
29902
+ "properties": {
29903
+ "bound": {
29904
+ "description": "bandwidth bound of point where cost rate changes",
29905
+ "type": "integer"
29906
+ },
29907
+ "rate": {
29908
+ "description": "cost rate of bandwidth between this and previous bound",
29909
+ "type": "integer"
29910
+ }
29911
+ },
29912
+ "required": [
29913
+ "bound",
29914
+ "rate"
29915
+ ],
29916
+ "type": "object"
29917
+ },
29918
+ "type": "array"
29919
+ }
29920
+ },
29921
+ "type": "object"
29922
+ },
29923
+ "extraIpAddresses": {
29924
+ "items": {},
29925
+ "type": "array"
29926
+ },
29927
+ "hostName": {
29928
+ "description": "node hostname",
29929
+ "maxLength": 255,
29930
+ "minLength": 1,
29931
+ "type": "string"
29932
+ },
29933
+ "id": {
29934
+ "description": "object name, string without space, comma, limited to 64 chars (repeated due to some validator handling of references)",
29935
+ "maxLength": 255,
29936
+ "minLength": 1,
29937
+ "pattern": "^[a-zA-Z0-9_\\-\\.\\:\\>\\<]*$",
29938
+ "type": "string"
29939
+ },
29940
+ "layer": {
29941
+ "description": "node layer",
29942
+ "type": "string"
29943
+ },
29944
+ "live": {
29945
+ "description": "indicate if the node has properties coming from topology acquisition",
29946
+ "type": "boolean"
29947
+ },
29948
+ "logicalSystemParent": {
29949
+ "description": "For logical system discovered using CLI/Netconf data, this is set for logical system and contains the hostname of the logical system parent (i.e real router). This property is read-only",
29950
+ "type": "string"
29951
+ },
29952
+ "name": {
29953
+ "description": "object name, string without space, comma, limited to 64 chars (repeated due to some validator handling of references)",
29954
+ "maxLength": 255,
29955
+ "minLength": 1,
29956
+ "pattern": "^[a-zA-Z0-9_\\-\\.\\:\\>\\<]*$",
29957
+ "type": "string"
29958
+ },
29959
+ "nodeIndex": {
29960
+ "description": "Application Server index",
29961
+ "type": "integer"
29962
+ },
29963
+ "nodeType": {
29964
+ "description": "node hardware type (any user string)",
29965
+ "type": "string"
29966
+ },
29967
+ "prefixes": {
29968
+ "items": {
29969
+ "properties": {
29970
+ "SR": {
29971
+ "properties": {
29972
+ "algo": {
29973
+ "description": "Spring Algorithm (0 for ECMP-aware CSPF, 1 for strict ECMP aware CSPF)",
29974
+ "type": "number"
29975
+ },
29976
+ "flags": {
29977
+ "description": "Flags associated to this prefix, see draft-ietf-isis-segment-routing-extensions-07#section-2.1, Flags not defined for OSPF are 0",
29978
+ "type": "number"
29979
+ },
29980
+ "index": {
29981
+ "description": "Index of the prefix in the global SR tables",
29982
+ "type": "number"
29983
+ }
29984
+ },
29985
+ "type": "object"
29986
+ },
29987
+ "SRv6": {
29988
+ "properties": {
29989
+ "algo": {
29990
+ "description": "Algorithm associated with the SID",
29991
+ "type": "number"
29992
+ },
29993
+ "flags": {
29994
+ "description": "Flags associated to this ipv6 prefix, see draft-ietf-idr-bgpls-srv6-ext#page-10",
29995
+ "type": "number"
29996
+ },
29997
+ "metric": {
29998
+ "description": "The value of the metric for the Locator",
29999
+ "type": "number"
30000
+ }
30001
+ },
30002
+ "type": "object"
30003
+ },
30004
+ "role": {
30005
+ "description": "indicate the role of the address when its derived from a particular protocol, for instance routerID, teRouterID, ipv6address,..etc ",
30006
+ "type": "string"
30007
+ }
30008
+ },
30009
+ "type": "object"
30010
+ },
30011
+ "type": "array"
30012
+ },
30013
+ "protocols": {
30014
+ "description": "protocols configuration and information on the node",
30015
+ "properties": {
30016
+ "BGP": {
30017
+ "additionalProperties": false,
30018
+ "properties": {
30019
+ "AutonomousSystem": {
30020
+ "additionalProperties": false,
30021
+ "properties": {
30022
+ "asNumber": {}
30023
+ },
30024
+ "required": [
30025
+ "asNumber"
30026
+ ],
30027
+ "title": "siteAS Number",
30028
+ "type": "object"
30029
+ },
30030
+ "id": {
30031
+ "type": "string"
30032
+ }
30033
+ },
30034
+ "type": "object"
30035
+ },
30036
+ "ISIS": {
30037
+ "additionalProperties": false,
30038
+ "properties": {
30039
+ "TERouterId": {
30040
+ "type": "string"
30041
+ },
30042
+ "TERouterIdIPv6": {
30043
+ "type": "string"
30044
+ },
30045
+ "area": {
30046
+ "type": "string"
30047
+ },
30048
+ "isoAddress": {
30049
+ "type": "string"
30050
+ },
30051
+ "overloadBit": {
30052
+ "description": "ISIS overload bit set (from device collection)",
30053
+ "type": "boolean"
30054
+ },
30055
+ "routerId": {
30056
+ "type": "string"
30057
+ },
30058
+ "routerIdIPv6": {
30059
+ "type": "string"
30060
+ }
30061
+ },
30062
+ "type": "object"
30063
+ },
30064
+ "NETCONF": {
30065
+ "description": "Netconf provisioning protocol status",
30066
+ "properties": {
30067
+ "clientAddress": {},
30068
+ "clientCapabilities": {
30069
+ "items": {
30070
+ "description": "NETCONF discovered capabilitu, for instance urn:ietf:params:netconf:base:1.0",
30071
+ "type": "string"
30072
+ },
30073
+ "type": "array"
30074
+ },
30075
+ "operationalState": {
30076
+ "enum": [
30077
+ "Connected",
30078
+ "Disconnected",
30079
+ "Session_close",
30080
+ "Connecting",
30081
+ "Invalid_credentials",
30082
+ "Deleted"
30083
+ ],
30084
+ "type": "string"
30085
+ },
30086
+ "operationalStatus": {
30087
+ "description": "Operational status",
30088
+ "enum": [
30089
+ "Up",
30090
+ "Down",
30091
+ "Unknown",
30092
+ "Empty"
30093
+ ],
30094
+ "type": "string"
30095
+ },
30096
+ "sessionParameters": {
30097
+ "description": "remote peer NETCONF session parameters",
30098
+ "properties": {
30099
+ "keepalive": {
30100
+ "description": "session keepalive time, in seconds",
30101
+ "type": "integer"
30102
+ }
30103
+ },
30104
+ "type": "object"
30105
+ }
30106
+ },
30107
+ "type": "object"
30108
+ },
30109
+ "OSPF": {
30110
+ "additionalProperties": false,
30111
+ "properties": {
30112
+ "TERouterId": {
30113
+ "type": "string"
30114
+ },
30115
+ "TERouterIdIPv6": {
30116
+ "type": "string"
30117
+ },
30118
+ "overloadBit": {
30119
+ "description": "OSPF overload bit set (from device collection)",
30120
+ "type": "boolean"
30121
+ },
30122
+ "referenceBw": {
30123
+ "description": "OSPF reference bandwidth (read-only,from device collection)",
30124
+ "type": "number"
30125
+ },
30126
+ "routerId": {
30127
+ "type": "string"
30128
+ },
30129
+ "routerIdIPv6": {
30130
+ "type": "string"
30131
+ }
30132
+ },
30133
+ "type": "object"
30134
+ },
30135
+ "PCEP": {
30136
+ "additionalProperties": false,
30137
+ "properties": {
30138
+ "extensions": {
30139
+ "description": "forces NorthStar support of specific extensions",
30140
+ "properties": {
30141
+ "lsp-association-protection": {
30142
+ "description": "Support for Primary/Secondary LSP using draft-ananthakrishnan-pce-stateful-path-protection-00. ",
30143
+ "type": "boolean"
30144
+ }
30145
+ },
30146
+ "type": "object"
30147
+ },
30148
+ "operationalStatus": {
30149
+ "description": "Operational status",
30150
+ "enum": [
30151
+ "Up",
30152
+ "Down",
30153
+ "Unknown",
30154
+ "Empty"
30155
+ ],
30156
+ "type": "string"
30157
+ },
30158
+ "pccAddress": {},
30159
+ "peerStatefullCapabilities": {
30160
+ "description": "represents the remote peer advertised capabilites",
30161
+ "properties": {
30162
+ "SRCapability": {
30163
+ "description": "Segment Routing capability",
30164
+ "type": "boolean"
30165
+ },
30166
+ "SRv6Capability": {
30167
+ "description": "Segment Routing v6 capability",
30168
+ "type": "boolean"
30169
+ },
30170
+ "lspInstantiation": {
30171
+ "description": "Stateful PCE LSP Create",
30172
+ "type": "boolean"
30173
+ },
30174
+ "lspUpdate": {
30175
+ "description": "Stateful PCE LSP Update ",
30176
+ "type": "boolean"
30177
+ },
30178
+ "p2mp": {
30179
+ "description": "Stateful PCE P2MP LSP reporting",
30180
+ "type": "boolean"
30181
+ },
30182
+ "p2mpInstantiation": {
30183
+ "description": "Stateful PCE P2MP LSP Create",
30184
+ "type": "boolean"
30185
+ },
30186
+ "p2mpUpdate": {
30187
+ "description": "Stateful PCE P2MP LSP Update",
30188
+ "type": "boolean"
30189
+ }
30190
+ },
30191
+ "type": "object"
30192
+ },
30193
+ "sessionParameters": {
30194
+ "description": "remote peer pcep session parameters",
30195
+ "properties": {
30196
+ "deadtimer": {
30197
+ "description": "PCEP session DeadTimer time, in seconds",
30198
+ "type": "integer"
30199
+ },
30200
+ "keepalive": {
30201
+ "description": "PCEP session keepalive time, in seconds",
30202
+ "type": "integer"
30203
+ },
30204
+ "maximumStackDepth": {
30205
+ "description": "The SR maximum Stack Depth (MSD) reported by the PCC",
30206
+ "type": "integer"
30207
+ }
30208
+ },
30209
+ "type": "object"
30210
+ }
30211
+ },
30212
+ "type": "object"
30213
+ },
30214
+ "SR": {
30215
+ "description": "Represent the node Segment Routing (SR) parameters",
30216
+ "properties": {
30217
+ "SRGBs": {
30218
+ "description": "List of SRGB Ranges",
30219
+ "items": {
30220
+ "description": "One range",
30221
+ "properties": {
30222
+ "range": {
30223
+ "type": "integer"
30224
+ },
30225
+ "start": {
30226
+ "type": "integer"
30227
+ }
30228
+ },
30229
+ "type": "object"
30230
+ },
30231
+ "type": "array"
30232
+ },
30233
+ "capabilities": {
30234
+ "additionalProperties": false,
30235
+ "description": "Options for path computation for SR",
30236
+ "properties": {
30237
+ "unrestrictedFirstHop": {
30238
+ "default": false,
30239
+ "description": "if not present or set to false, NorthStar will always include an adjacency SID as first hop. If set to true this won't be enforced",
30240
+ "type": "boolean"
30241
+ }
30242
+ },
30243
+ "type": "object"
30244
+ },
30245
+ "enabled": {
30246
+ "description": "If true the node can be used to route SR Tunnels. This flag is set to true if the node has SRGB and a node index (Prefix with routerId role and SR properties)",
30247
+ "type": "boolean"
30248
+ },
30249
+ "nodeCapabilities": {
30250
+ "description": "The Node capabilities, as defined in draft-ietf-isis-segment-routing-extensions-07#section-3, draft-ietf-ospf-ospfv3-segment-routing-extensions-05#section-3.3 ",
30251
+ "type": "integer"
30252
+ }
30253
+ },
30254
+ "type": "object"
30255
+ },
30256
+ "SRv6": {
30257
+ "description": "Represent the node Segment Routing v6 (SRv6) parameters",
30258
+ "properties": {
30259
+ "enabled": {
30260
+ "description": "Ignored on create, If true the node can be used to route SRv6 Tunnels. This flag is set to true if the node has msd type and a node index (Prefix with routerIdIPv6 role and SRv6 properties)",
30261
+ "type": "boolean"
30262
+ },
30263
+ "msdType": {
30264
+ "description": "node SRv6 capabilities",
30265
+ "properties": {
30266
+ "baseMplsImposition": {
30267
+ "type": "number"
30268
+ },
30269
+ "erld": {
30270
+ "type": "number"
30271
+ },
30272
+ "srhMaxEndD": {
30273
+ "type": "number"
30274
+ },
30275
+ "srhMaxEndPop": {
30276
+ "type": "number"
30277
+ },
30278
+ "srhMaxHEncaps": {
30279
+ "type": "number"
30280
+ },
30281
+ "srhMaxLs": {
30282
+ "type": "number"
30283
+ }
30284
+ },
30285
+ "type": "object"
30286
+ },
30287
+ "nodeCapabilities": {
30288
+ "description": "The Node capabilities of SRv6, as defined in draft-ietf-idr-bgpls-srv6-ext#section-3.1 ",
30289
+ "type": "integer"
30290
+ }
30291
+ },
30292
+ "type": "object"
30293
+ },
30294
+ "management": {
30295
+ "description": "Management Protocol information schema",
30296
+ "properties": {
30297
+ "address": {},
30298
+ "operatingSystem": {
30299
+ "description": "operating system information",
30300
+ "maxLength": 31,
30301
+ "type": "string"
30302
+ },
30303
+ "operatingSystemVersion": {
30304
+ "description": "operating system Version",
30305
+ "type": "string"
30306
+ },
30307
+ "vendor": {
30308
+ "description": "Device vendor. This is a free text with the following special values that influence NorthStar behavior: JUNIPER, CISCO (legacy cisco devices), Alcatel, HUAWEI, IOS-XR, SITE, CE. This parameter is inherited from device profile and also can be discovered by device collection. SITE and CE Nodes vendor type influence the LSP signaling: those nodes are pruned from the signaled path. Nodes with CE/SITE vendor are used for path computation but not signaling, allowing NorthStar to include routing constraints behond the PE node.",
30309
+ "maxLength": 31,
30310
+ "type": "string"
30311
+ }
30312
+ },
30313
+ "type": "object"
30314
+ }
30315
+ },
30316
+ "type": "object"
30317
+ },
30318
+ "pseudoNode": {
30319
+ "default": false,
30320
+ "description": "indicates if the node is a pseudo node created by the underlying IGP protocol",
30321
+ "type": "boolean"
30322
+ },
30323
+ "routerId": {
30324
+ "description": "router ID derived from protocols or device collection, read only",
30325
+ "type": "string"
30326
+ },
30327
+ "routerIdIPv6": {
30328
+ "description": "IPv6 router ID derived from device collection, read only",
30329
+ "type": "string"
30330
+ },
30331
+ "site": {
30332
+ "description": "node site ID",
30333
+ "type": "string"
30334
+ },
30335
+ "slices": {
30336
+ "items": {
30337
+ "additionalProperties": true,
30338
+ "description": "Minimal reference to a slice. Only the sliceId is processed unless explicitely mentioned by the refering schema.",
30339
+ "properties": {
30340
+ "sliceId": {
30341
+ "description": "Application server index limited to uint32.",
30342
+ "maximum": 4294967295,
30343
+ "minimum": 0,
30344
+ "type": "integer"
30345
+ }
30346
+ },
30347
+ "required": [
30348
+ "sliceId"
30349
+ ],
30350
+ "type": "object"
30351
+ },
30352
+ "type": "array"
30353
+ },
30354
+ "switchingCapabilities": {
30355
+ "items": {
30356
+ "additionalProperties": false,
30357
+ "description": "description of the interface type, based on transport topology",
30358
+ "properties": {
30359
+ "encoding": {
30360
+ "enum": [
30361
+ "lsp-encoding-pdh",
30362
+ "lsp-encoding-optical-channel",
30363
+ "lsp-encoding-sdh",
30364
+ "lsp-encoding-packet",
30365
+ "lsp-encoding-digital-wrapper",
30366
+ "lsp-encoding-fiber",
30367
+ "lsp-encoding-line",
30368
+ "lsp-encoding-ethernet",
30369
+ "lsp-encoding-fiber-channel",
30370
+ "lsp-encoding-oduk",
30371
+ "lsp-encoding-lambda"
30372
+ ],
30373
+ "type": "string"
30374
+ },
30375
+ "switchingCapability": {
30376
+ "enum": [
30377
+ "switching-packet",
30378
+ "switching-dcsc",
30379
+ "switching-otn",
30380
+ "switching-psc1",
30381
+ "switching-lsc",
30382
+ "switching-evpl",
30383
+ "switching-tdm",
30384
+ "switching-fsc",
30385
+ "switching-l2sc"
30386
+ ],
30387
+ "type": "string"
30388
+ }
30389
+ },
30390
+ "type": "object"
30391
+ },
30392
+ "type": "array"
30393
+ },
30394
+ "topoObjectType": {
30395
+ "enum": [
30396
+ "node"
30397
+ ],
30398
+ "type": "string"
30399
+ },
30400
+ "topology": {
30401
+ "additionalProperties": false,
30402
+ "properties": {
30403
+ "coordinates": {
30404
+ "description": "Schema for a Geo JSON object",
30405
+ "properties": {
30406
+ "bbox": {
30407
+ "description": "A bounding box as defined by GeoJSON",
30408
+ "items": {
30409
+ "type": "number"
30410
+ },
30411
+ "type": "array"
30412
+ },
30413
+ "crs": {
30414
+ "additionalProperties": false,
30415
+ "description": "a Coordinate Reference System object",
30416
+ "properties": {
30417
+ "properties": {
30418
+ "type": "object"
30419
+ },
30420
+ "type": {
30421
+ "type": "string"
30422
+ }
30423
+ },
30424
+ "required": [
30425
+ "type",
30426
+ "properties"
30427
+ ],
30428
+ "title": "crs",
30429
+ "type": "object"
30430
+ }
30431
+ },
30432
+ "required": [
30433
+ "type"
30434
+ ],
30435
+ "title": "Geo JSON object",
30436
+ "type": "object"
30437
+ }
30438
+ },
30439
+ "type": "object"
30440
+ },
30441
+ "topologyIndex": {
30442
+ "description": "Application Server index",
30443
+ "type": "integer"
30444
+ },
30445
+ "userProperties": {
30446
+ "type": "object"
30447
+ }
30448
+ },
30449
+ "required": [
30450
+ "topologyIndex",
30451
+ "topoObjectType",
30452
+ "id"
30453
+ ],
30454
+ "type": "object"
30455
+ },
30456
+ "prefix": {},
30457
+ "priority": {
30458
+ "maximum": 10,
30459
+ "minimum": 1,
30460
+ "type": "integer"
30461
+ }
30462
+ },
30463
+ "required": [
30464
+ "id"
30465
+ ],
30466
+ "type": "object"
30467
+ },
30468
+ "type": "array",
30469
+ "definitions": {}
30470
+ }
30471
+ }
30472
+ ],
30473
+ "output": {
30474
+ "name": "result",
30475
+ "type": "object",
30476
+ "description": "A JSON Object containing status, code and the result",
30477
+ "schema": {
30478
+ "title": "result",
30479
+ "type": "object"
30480
+ }
30481
+ },
30482
+ "roles": [
30483
+ "admin"
30484
+ ],
30485
+ "route": {
30486
+ "verb": "POST",
30487
+ "path": "/putTopologyV2TopologyIdIpePolicy"
30488
+ },
30489
+ "task": true
30490
+ },
30491
+ {
30492
+ "name": "deleteTopologyV2TopologyIdIpePolicy",
30493
+ "summary": "Delete IPE Policies",
30494
+ "description": "Delete IPE Policies",
30495
+ "input": [
30496
+ {
30497
+ "name": "topologyId",
30498
+ "type": "number",
30499
+ "info": "A unique identifier for the topology. In Paragon PathFinder version 2, the unique identifier is set to 1. \n \n: 123",
30500
+ "required": true,
30501
+ "schema": {
30502
+ "title": "topologyId",
30503
+ "type": "number"
30504
+ }
30505
+ }
30506
+ ],
30507
+ "output": {
30508
+ "name": "result",
30509
+ "type": "object",
30510
+ "description": "A JSON Object containing status, code and the result",
30511
+ "schema": {
30512
+ "title": "result",
30513
+ "type": "object"
30514
+ }
30515
+ },
30516
+ "roles": [
30517
+ "admin"
30518
+ ],
30519
+ "route": {
30520
+ "verb": "POST",
30521
+ "path": "/deleteTopologyV2TopologyIdIpePolicy"
30522
+ },
30523
+ "task": true
30524
+ },
30525
+ {
30526
+ "name": "getTopologyV2TopologyIdIpePolicyIpePolicyId",
30527
+ "summary": "Get single IPE policy",
30528
+ "description": "Get single IPE policy",
30529
+ "input": [
30530
+ {
30531
+ "name": "topologyId",
30532
+ "type": "number",
30533
+ "info": "A unique identifier for the topology. In Paragon PathFinder version 2, the unique identifier is set to 1. \n \n: 123",
30534
+ "required": true,
30535
+ "schema": {
30536
+ "title": "topologyId",
30537
+ "type": "number"
30538
+ }
30539
+ },
30540
+ {
30541
+ "name": "ipePolicyId",
30542
+ "type": "number",
30543
+ "info": "Program ID of an IPE policy \n \n: 123",
30544
+ "required": true,
30545
+ "schema": {
30546
+ "title": "ipePolicyId",
30547
+ "type": "number"
30548
+ }
30549
+ }
30550
+ ],
30551
+ "output": {
30552
+ "name": "result",
30553
+ "type": "object",
30554
+ "description": "A JSON Object containing status, code and the result",
30555
+ "schema": {
30556
+ "title": "result",
30557
+ "type": "object"
30558
+ }
30559
+ },
30560
+ "roles": [
30561
+ "admin"
30562
+ ],
30563
+ "route": {
30564
+ "verb": "POST",
30565
+ "path": "/getTopologyV2TopologyIdIpePolicyIpePolicyId"
30566
+ },
30567
+ "task": true
28975
30568
  }
28976
30569
  ],
28977
30570
  "views": []