Skip to content

Commit 0f998eb

Browse files
committed
Add new API documentation for managing blueprints and visual connections
- Created documentation for removing visual connectors by alias and endpoints. - Added methods for setting visual connector attributes. - Introduced new API endpoints for importing blueprints and managing global inputs. - Documented various operations for updating blueprints, including adding/removing resources, services, and attributes. - Enhanced existing documentation with clearer examples and structured parameters. - Organized new and existing documentation under the "Updating Blueprints" category for better navigation.
1 parent 19dee85 commit 0f998eb

50 files changed

Lines changed: 887 additions & 19 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/api-guide/packaging-api/creat-and-load-blueprint-pkg/packaging-functions/create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@ sidebar_position: 1
1818

1919
**Sample:**
2020
```javascript
21-
`packageEditor.create('c:\\temp\\TestPackage.zip')`
21+
packageEditor.create('c:\\temp\\TestPackage.zip')
2222
```

docs/api-guide/packaging-api/creat-and-load-blueprint-pkg/packaging-functions/get-topology-names.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ sidebar_position: 4
1717
**Sample:**
1818

1919
```javascript
20-
`packageEditor.get_topology_names()`
20+
packageEditor.get_topology_names()
2121
```
2222

2323
```javascript

docs/api-guide/packaging-api/creat-and-load-blueprint-pkg/packaging-functions/load.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ sidebar_position: 2
1717
**Sample:**
1818

1919
```javascript
20-
`packageEditor.load('c:\\temp\\TestPackage.zip')`
20+
packageEditor.load('c:\\temp\\TestPackage.zip')
2121
```
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Editing Blueprint Connectivity",
3+
"position": 5
4+
}
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Editing Blueprint Connectivity
2+
3+
![](/Images/API/Packaging-API/UpdatingDataModel.png)
4+
5+
This section explains how to:
6+
7+
**Routing:**
8+
- [Add Routes](./routing/add-routes.md)
9+
- [Remove Routes (by Alias)](./routing/remove-routes-by-alias.md)
10+
- [Remove Routes (by Endpoints)](./routing/remove-routes-by-endpoint.md)
11+
- [Set a Route's Attributes](./routing/set-route-attr.md)
12+
13+
**Visual Connectors:**
14+
- [Add Visual Connectors](./visual-connections/add-visual-conn.md)
15+
- [Remove Visual Connectors (by Alias)](./visual-connections/remove-visual-conn-by-alias.md)
16+
- [Remove Visual Connectors (by Endpoints)](./visual-connections/remove-visual-conn-vy-endpoint.md)
17+
- [Set a Visual Connector's Attributes](./visual-connections/set-visual-conn-attr.md)
18+
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Routing",
3+
"position": 1,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "This section provides an overview of the APIs available for editing blueprint connectivity using routes. To learn more about these APIs, check out the following articles:"
7+
}
8+
}
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Add Routes
6+
7+
**Description**: Create a route between the source and target resources in a specific blueprint.
8+
9+
**Signature**: `add_route(topology_name, route_alias, source, target, route_interface, max_hops, direction, shared)`
10+
11+
**Parameters**:
12+
13+
| Name | Direction | Required | Description |
14+
| --- | --- | --- | --- |
15+
| `topology_name` | In | Yes | The name of the blueprint |
16+
| `route_alias` | In | Yes | Specify the route’s alias. |
17+
| `source` | In | Yes | The name and path of the source resource (end point) |
18+
| `target` | In | Yes | The name and path of the target resource (end point) |
19+
| `route_interface` | In | Yes | The protocol type of the end points |
20+
| `max_hops` | In | Yes | Specify the maximum number or allowed hops. |
21+
| `direction` | In | Yes | Specify the direction of the route: Uni, Bi |
22+
| `shared` | In | Yes | Specify whether these routes are shared. Shared routes can be used in more than one sandbox. |
23+
24+
**Sample**:
25+
26+
```javascript
27+
packageEditor.add_route('blueprint1', 'ABC','Chassis1/Blade1/Port1','Chassis2/Blade1/Port1','Ethernet',3,'Bi',False)
28+
```
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Remove Routes (by Alias)
6+
7+
**Description**: Remove an existing route from a specific blueprint.
8+
9+
**Signature**: `remove_route_by_alias(topology_name, route_alias)`
10+
11+
**Parameters**:
12+
13+
| Name | Direction | Required | Description |
14+
| --- | --- | --- | --- |
15+
| `topology_name` | In | Yes | The name of the blueprint |
16+
| `route_alias` | In | Yes | Specify the route’s alias. |
17+
18+
**Sample**:
19+
20+
```javascript
21+
packageEditor.remove_route_by_alias('blueprint1', 'ABC')
22+
```
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# Remove Routes (by Endpoints)
6+
7+
**Description**: Remove an existing route from a specific blueprint.
8+
9+
**Signature**: `remove_route_by_endpoints(topology_name, source, target, direction)`
10+
11+
**Parameters**:
12+
13+
| Name | Direction | Required | Description |
14+
| --- | --- | --- | --- |
15+
| `topology_name` | In | Yes | The name of the blueprint |
16+
| `source` | In | Yes | The name and path of the source resource (end point) |
17+
| `target` | In | Yes | The name and path of the target resource (end point) |
18+
| `direction` | In | Yes | Specify the direction of the route: Uni, Bi |
19+
20+
**Sample**:
21+
22+
```javascript
23+
packageEditor.remove_route_by_endpoints('blueprint1', 'Chassis1/Blade1/Port4','Chassis2/Blade1/Port1','Bi')
24+
```
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
sidebar_position: 4
3+
---
4+
5+
# Set a Route's Attributes
6+
7+
**Description**: Set the value for an attribute on the route's L1 ports. The attribute is specified by the route’s alias and attribute name. Note that this action sets the attribute value on the actual L1 resource ports.
8+
9+
**Signature**: `set_route_attribute(topology_name, route_alias, attribute_name, target, attribute_value)`
10+
11+
**Parameters**:
12+
13+
14+
<table>
15+
<thead>
16+
<tr>
17+
<th>Name</th>
18+
<th>Direction</th>
19+
<th>Required</th>
20+
<th>Description</th>
21+
</tr>
22+
</thead>
23+
<tbody>
24+
<tr>
25+
<td>`topology_name`</td>
26+
<td>In</td>
27+
<td>Yes</td>
28+
<td>The name of the blueprint</td>
29+
</tr>
30+
<tr>
31+
<td>`route_alias`</td>
32+
<td>In</td>
33+
<td>Yes</td>
34+
<td>Specify the route’s alias.</td>
35+
</tr>
36+
<tr>
37+
<td>`attribute_name`</td>
38+
<td>In</td>
39+
<td>Yes</td>
40+
<td>Specify the attribute name that you want to add / update, only attributes that have the rule **Link Configurations** can be used as route attributes</td>
41+
</tr>
42+
<tr>
43+
<td>`target`</td>
44+
<td>In</td>
45+
<td>Yes</td>
46+
<td>
47+
Specify on which resources to apply the attribute changes:
48+
<ul>
49+
<li>
50+
**Source** refers to the L1 resource connected to the source endpoint of the route
51+
</li>
52+
<li>
53+
**Target** refers to the L1 resource connected to the target endpoint of the route
54+
</li>
55+
<li>
56+
**All** encompasses all of the route's L1 resources
57+
</li>
58+
</ul>
59+
</td>
60+
</tr>
61+
<tr>
62+
<td>`attribute_value`</td>
63+
<td>In</td>
64+
<td>Yes</td>
65+
<td>Specify the value to set on the attribute</td>
66+
</tr>
67+
</tbody>
68+
</table>
69+
70+
**Sample**:
71+
72+
```javascript
73+
packageEditor.set_route_attribute(‘environment1’, 'alias', 'type', 'All', 'auto connection')
74+
```

0 commit comments

Comments
 (0)