About the Network Implementation Plan Page
To access this page, click Inventory > Device Onboarding > Network Implementation Plan.
The configured network implementation plans and candidates of the plans are displayed on the Network Implementation Plan page. If the Pending Changes column displays Yes, then the plan has a candidate.
A network implementation plan or a candidate version of a network implementation plan includes:
-
One or more devices.
-
One or more device profiles, interface profiles, and port profiles assigned to configure the devices. The configurations in the assigned profiles are committed on the devices during device onboarding.
-
Link configuration between devices in the plan.
Tasks You Can Perform
You can perform the following tasks from this page:
-
View details of a network implementation plan or a candidate version of a network implementation plan.
You can view details of a plan or a candidate version of a plan in the following ways:
-
Click the plan name to view the details of the Network Implementation Plan-Name page. The details are displayed in the following tabs:
-
Properties—View general properties such as name, service design version, status message, and so on for the plan.
-
Order Status—View the status of the last service order issued for the plan.
-
Active Assurance—View the number and result of Active Assurance Tests and Monitors that are run to check the quality of connections of the devices.
-
Order History—View the history of all service orders generated for the plan.
-
Configurations—View the configurations of devices managed by the plan.
-
- Click More > Detail or hover over the plan name and click the Details icon that appears to view the details on pane on the right-side of the Network Implementation Plan page.
The Network-Implementation-Plan-Name pane appears on the right of the page displaying information such as the number of devices to which the plan is applied, status of the plan, description and so on. See Table 2.
In addition to the fields listed in Table 2, you can see the following details on the Network Implementation Plan table:
-
Service Design Version—Service design version associated with the network implementation plan.
-
Devices—Devices added to the network implementation plan.
-
Device Count—Number of devices included in the network implementation plan.
-
Tags—Tags assigned to the network implementation plan.
If there are more than one tag assigned to the plan, an integer is present next to the displayed tag. For example, +2 in the Tags column indicates that there are two more tags in addition to what is currently listed under Tags. You can hover over the integer to view the additional tags assigned to the plan.
-
-
Add a network implementation plan. See Add a Network Implementation Plan.
-
Publish a network implementation plan. See Provision a Network Implementation Plan.
-
Execute dry run on a network implementation plan.
Execute dry run after making changes to a network implementation plan to evaluate their impact. Dry run does not apply or commit the configuration to the device; instead, it allows you to preview and assess how the changes would affect the device and the network.
To execute dry run on a plan, select a plan and click More > Dry run with validation. A confirmation message appears that dry run is initiated.
You can view the generated dry-run configuration on the Configuration tab of the Network Implementation Plan-Name Details page that opens when you click on the network implementation plan name link.
-
Export a network implementation plan.
To export a network implementation plan, select the plan and click More > Export. The network implementation plan is exported in the JSON format.
The exported file contains all the tasks executed to onboard the devices in the plan. You can export a network implementation plan and use it to:
-
View the progress of the onboarding workflow.
-
Troubleshoot issues in onboarding.
-
-
Trigger Onboarding
Use the Trigger Onboarding option to commit the configuration in a network implementation plan on to a device. The device must be onboarded and connected to Routing Director. Any pending changes saved in the candidate version of the network implementation plan are automatically committed and provisoned when you trigger onboarding. To commit the network implementation plan configuration onto a device:
Click More > Trigger Onboarding.
The Trigger onboarding page appears.
Select the device on which you want to commit the configurations in the network implementation plan and click OK.
A confirmation message that the workflow to onboard the device has started appears.
After the configurations are committed successfully, the Order Status changes to Success or Success with Warnings.
-
Resume the Onboarding workflow.
Use the Resume Onboarding option to resume onboarding a device when the onboarding of a device fails for any reason. Before resuming onboarding, ensure that you have resolved the reason for the onboarding to fail.
To resume the onboarding workflow:
-
Click More > Resume Onboarding.
The Resume Onboarding page appears listing the devices included in the plan that have failed onboarding.
-
Select a device from the list and click OK.
The onboarding workflow restarts from where it failed and a message indicating that the onboarding workflow has resumed appears.
-
Monitor the progress of the onboarding on the Put Devices into Service page (Inventory > Device Onboarding > Onboarding Dashboard).
-
-
Offboard a network implementation plan. See Offboard a Network Implementation Plan.
-
Discard Changes—To delete a candidate or a candidate version of a network implementation plan, select the candidate and click More > Discard Changes. Click Yes when prompted for confirmation.
When you discard a candidate, the candidate is deleted from the Plans table.
When you discard the candidate version of a network implementation plan, the provisioned network implementation plan remains unchanged and continues to display in the Plans table and the candidate version is deleted from the table.
Note:Discard Changes option is available only for a candidate and candidate version of the network implementation plan.
-
Commit Changes—To commit the candidate or a candidate version of the network implementation plan, select the candidate and click More > Commit Changes. Click Yes when prompted for confirmation.
When you commit a candidate or a candidate of a network implementation plan, the changes are committed as a plan. The Pending Changes column displays NO for the plan. To push the committed changes to devices, select the plan for which you committed the changes and click Provision.
Note:Commit Changes option is available only for a candidate and candidate version of the network implementation plan.
-
Rollback—You can roll back a network implementation plan to an earlier version. Rolling back restores the configuration of the selected version and saves it as the new version for the network implementation plan.
To roll back a network implementation plan to a previous version:
Select the network implementation plan and click More > Rollback.
The Rollback Network Implementation Plan page appears.
In the Select Version section of the Rollback Network Implementation Plan page, select a network implementation plan for which you want to roll back the instance version.
In addition to rolling back the instance version, you can also restore the associated design version.
Table 1 lists the fields in the Select Version section.
Table 1: Fields in the Select Version Section (Rollback Network Implementation Plan Page) Field
Description
Plan
Displays the name of the network implementation plan.
Rollback Version
Displays the earlier version of the network implementation plan.
Design Version
Displays the design version associated with the instance version.
Description
Displays the description provided during rollback.
Upload Time
Displays the upload time and timestamp of the instance version.
Click Next to review the changes.
In the Review Changes section of the Rollback Network Implementation Plan page, you can review the following changes:
Compare the configuration between the Current and Target versions of the plan. Current is the active instance version and target is the version that you want to roll back to.
Select the comparison view by clicking Inline for an inline view of the comparison or Side-by-Side for an adjacent view.
View a summary of the configuration changes between versions, where the number in green with a plus (+) sign indicates added configuration and the number in red with a minus (-) sign indicates deleted configuration.
View the parameters that differentiate the configuration between the current and target versions.
Replace—Indicates that the configuration highlighted in red in the current version is replaced with configuration highlighted in green in the target version.
Insert—Indicates that the configuration highlighted in green is additional in the target version.
Delete—Indicates that the configuration highlighted in red in the current version is unavailable in the target version.
Click Next to complete the Rollback.
In the Finish section of the Rollback Network Implementation Plan page, you must enter a description or edit the default description. You can view the name, target version, and design version of the network implementation plan in this section.
Click Rollback.
A confirmation message appears that the operation is successfully performed and you are returned to the Network Implementation Plan page.
If the rollback of a network implementation plan fails, click Cancel to exit or click Back to review and modify the selected options.
On the Network Implementation Plan page, the Instance Version column displays a new version number incremented by one from the current version. Rolling back restores the configuration of the selected version and saves it as the new version for the plan.
For example, if you rollback a network implementation plan from version 5.0.0 to 2.0.0, the Version column displays version 6.0.0 using the configuration of version 2.0.0.
-
Force sync a device.
To use the Force Sync option, click More > Force Sync.
The Force Sync option reverts a device configuration in the
paragon-service-orchestrationconfiguration group to the configuration defined by the network implementation plan that was used to onboard the device. Use this option when you have made changes to the device configuration and want to revert to the configuration defined in the network implementation plan. -
View the history of a network implementation plan.
To view the change history of a network implementation plan, click More > Order History. The Order History: Plan-Name pane displays the operation (create, modify), status, device count, the user who created or edited the plan and the version of the plan.
Click View Content to view the plan in JSON format.
- Add a tag—A tag is a label in the key:value format that you add to a network
implementation plan so that you can group plans. For example, you can assign the tag
type:PE to all plans associated with devices deployed as provider edge devices.
To add one or more tags to a device:
Click More > Add Tags.
The Manage Tags page appears.
In the Tags field, select a tag to be applied from the drop-down list.
Alternatively, you can also create a new tag by clicking the Create New Tag link at the bottom of the page and apply the new tag. If you are creating a new tag, ensure that:
The key starts with a letter and is followed by letters, numbers, periods (.), hyphens (-), or underscores (_), and is between 1 and 200 characters long.
The value includes alphanumeric characters, periods (.), hyphens (-), and underscores (_), and is between 1 and 200 characters long.
You can view all the tags applied to the network implementation plan in the Tags column.
-
Upgrade the infrastructure service design used by a network implementation plan.
Before initiating an upgrade, we recommend that you complete any ongoing network implementation plan upgrades. If you initiate another upgrade while existing upgrades are still in progress, any unfinished upgrades are automatically included in the bulk upgrade operation. Running multiple upgrades simultaneously can make it difficult to track the upgrade progress.
An upgrade is considered complete only when the Status of the plan changes to Active after the upgrade.
A maximum of five operations can be performed at a time. These operations include create, modify, delete, onboard, and upgrade. Any additional operations are placed in a queue and are performed sequentially. The status of plans in the queue is displayed as Queued.
You can monitor the ongoing bulk upgrade from the Workflows page (Orchestration > Monitoring > Workflows).
To upgrade the infrastructure service design used by an implementation plan:
Select one or more plans and click More > Upgrade Service Design.
The Bulk Service Design Upgrade page appears.
To select all the plans listed on the Network Implementation Plan page, click the check-box beside the Name column. The number of selected plans is displayed beside the Plans table name.
To select all saved and provisioned plans, click the down arrow next to the check-box and select Select all n items, where n is the total number of plans. The number of selected plans is displayed beside the name of the Plans table.
Note:We recommend that you upgrade no more than 1000 network implementation plans at a time. Exceeding this limit may cause some plans to fail to upgrade. Failed plans can then be included in a later bulk upgrade.
To clear all the selected plans, click Clear selection.
If the service design used by the network implementation plan is already upgraded to the latest version, a message appears at the top of the page stating that no upgrade is required.
On the Bulk Service Design Upgrade page, the plans and their service design versions are displayed. Select a version from the drop-down list and click Next.
The selected plans and their service design versions that are available for upgrade are categorized into the following sections:
Ready For Upgrade—Displays service design versions of plans or their dependent network resources that are ready for upgrade.
When you initiate an upgrade for a plan, the upgrade workflow automatically includes any dependent network resources. These resources are upgraded before the plan to maintain compatibility with the target version.
Select the versions that you want to upgrade. To select all the versions, click Select All in Phase.
Upcoming Upgrade—Displays service design versions of plans that must be upgraded next. These service design versions can be upgraded only after completing the upgrades listed in the Ready For Upgrade section.
When the upgrades listed in the Ready For Upgrade section are complete, the corresponding service designs move from the Upcoming Upgrade section to Ready For Upgrade section.
This section does not appear if there are no upcoming upgrades for the selected plans.
Blocked Upgrade—Displays service design versions of plans that are currently dependent on the upgrade of service designs in the Upcoming Upgrade section. These versions can be upgraded only after completing the corresponding upgrades listed in both the Ready For Upgrade and Upcoming Upgrade sections.
This section does not appear if there are no dependent upgrades for the selected plans.
You can upgrade a service design by only one version at a time even if multiple higher versions are available.
(Optional) Select or clear the Dry Run with Validation check box.
Select the Dry Run with Validation check box to execute a dry run on the selected plans. When you execute a dry run, the configuration generated for the plan is validated on the devices.
A confirmation message appears indicating that the dry run workflow is created. You can view the dry-run workflow on the Workflows page (Orchestration > Monitoring > Workflows).
If the dry run fails, an error message is displayed on the Network Implementation Plan page. You can troubleshoot the error from the Workflows page.
Clear the Dry Run with Validation check box to upgrade the selected plans without executing a dry run. By default, the Dry Run with Validation check box is not selected.
Do any of the following:
Click OK to upgrade the selected plans.
Click Cancel to discard the changes.
After a successful upgrade, the Design Version column on the Network Implementation Plan page displays the upgraded version of the infrastructure service design used by the network implementation plan.
On the Upgrade Service Design dialog box, click the drop-down list to select the service design version to which you want to upgrade the network implementation plan and click Yes.
A message indicating that service design upgrade is in process is displayed. After successful upgrade, the Service Design column displays the new version of the infrastructure service design used by the network implementation plan.
-
Re-run service design upgrade for a network implementation plan.
To re-run a service design upgrade, select the network implementation plan and click More > Re-run Service Design Upgrade. The Re-run Service Design Upgrade option retries upgrading the service design version of the selected plan. Use this option to retry a previously failed upgrade.
-
Search by using keywords—Click the search icon (magnifying glass), enter the search term in the text box, and press Enter. The search results are displayed on the same page.
-
Filter the data displayed in the table—Click the filter icon (funnel) and select whether you want to show or hide advanced filters. You can then add or remove filter criteria, save criteria as a filter, apply or clear filters, and so on. The filtered results are displayed on the same page.
-
Show or hide columns in the table or reset page preferences, using the vertical ellipsis menu.
-
Sort, resize, or re-arrange columns in a table (grid).
-
Refresh the Network implementation Plan table and set auto refresh frequency—A Refresh icon is provided at the bottom left-corner of the Network Implementation Plan table. Click the Refresh icon to view the most recent updates made to the network implementation plans.
Click the ellipsis next to the Refresh icon to set the auto refresh frequency. You can either turn off the auto refresh of the table or set the auto refresh frequency to 30 seconds, 1 min, 3 mins, and 5 mins.
-
Set the number of rows to be displayed in the table—Set the number of rows (15, 30, 50, or 100) to be displayed in the Network Implementation Plan table in the Display drop-down list provided at the bottom right-corner of the table.
If there are multiple pages of rows, use the arrow heads to traverse through the pages or enter a page number to view the entries listed on that page.
| Field | Description |
|---|---|
|
Properties |
|
| Name | Name of the network implementation plan. |
| Description | Short description of the network implementation plan. |
|
Design Version |
Design version associated with the network implementation plan. |
|
Instance Version |
The version of the network implementation plan. For example, 1.0.0. The version of the instance is displayed in the Major.Minor.Patch format.
|
|
Candidate Version |
The candidate version of the network implementation plan. For example, 1.1.0. The candidate version of the network implementation plan is displayed in the Major.Minor.Patch format. This column appears blank after the changes are committed, either after creating or modifying the plan.
|
| Sites | Name of the site where the devices are installed. |
|
Order State |
The execution state of the network implementation plan. A network implementation plan can have the following execution states:
|
| Status |
Status of the network implementation plan. A network implementation plan can have one of the following provisioning states:
|
|
Status Message |
Additional information about the status of the network implementation plan. The status is Uploaded after the network implementation plan is provisioned either after creating or modifying. |
|
Pending Changes |
Pending changes for the network implementation plan. A network implementation plan can have one of the following values in the Pending Changes column:
|
|
Device Profiles |
Device profiles included in the plan. |
|
Interface Profiles |
Interface profiles included in the plan. |
|
Port Profiles |
Port profiles included in the plan. |
| Last Modified | Date and time in the Month Day, Year HH:MM:SS format when the network implementation plan was last modified. |
| Last Modified By | User who last modified the network implementation plan. |
|
Devices |
View the devices included in the plan along with the information if the device is onboarded or not. You can:
|
|
Device Count |
Number of devices added to the network implementation plan. |
|
More |
You can see:
|