ON THIS PAGE
About the Service Instances Page
The Service Instances page lists the services that you, as a service provider have created within an organization either to save as candidates or to provision as active instances for customers. A candidate is the draft version of a service instance that is saved in the database but has not been provisioned in the network. You can create service instances for L3VPN, EVPN, EVPN-VPWS, or L2 circuit services. The service instances are listed by the instance name, pending changes, customer name, the associated service design and design version, version of the instance, devices on which the service is provisioned, and so on.
To access the Service Instances page, click Orchestration > Instances on the navigation menu.
Tasks You Can Perform
You can perform the following tasks on the Service Instances page:
-
View details of service instances.
Use one of the following options to view details about a service instance:
-
To view service details in a pop-up pane on the right:
-
Hover over the service instance and click the Details icon that appears next to the service instance name.
-
Select the service instance and click More > Detail.
The service-instance-name pane appears on the right side of the GUI. Use the scroll bar at the bottom to scroll left to right or click X to close the pane. For information about the details of the fields, see Table 3.
To view the service instance details in JSON format, click the JSON View hyperlink on the details pane.
To view the network resources allocated for the service instance, click the Placement Resources hyperlink on the details pane.
-
-
Click the service-instance-name hyperlink and view details on the service-instance-name Details page. See View Service Instance Details.
-
-
Create service instances:
-
Create L3VPN service instances. See Add an L3VPN Service Instance.
-
Create EVPN service instances. See Add an EVPN Service Instance
-
Create EVPN-VPWS service instances. See Add an EVPN-VPWS Service Instance.
-
Create L2 circuit service instances. See Add an L2 Circuit Service Instance.
-
-
Modify service instances. See Modify a Service Instance.
- Provision a service instance
To provision a service instance, select the service instance and click Provision. Routing Director generates a corresponding service order to activate the provisioning workflow. You can view the service order in the Service Orders page (Orchestration > Monitoring > Service Orders) and monitor the execution of the corresponding workflow on the Workflows (Orchestration > Monitoring > Workflows) page.
Note:You can also schedule the date and time for provisioning a service when you are creating or modifying a service instance. The Provision option is disabled if you schedule the provisioning of a service instance. The service is provisioned automatically at the scheduled date and time.
-
Deprovision a service—To delete or deprovision a service from your network, select the service instance and click More > Deprovision. Click Yes when prompted for confirmation.
-
Discard Changes—To delete a candidate or a candidate version of a service instance, select the candidate version and click More > Discard Changes. Click Yes when prompted for confirmation.
When you discard the candidate version of a service instance, the provisioned service instance remains unchanged and continues to display in the Service Instances table and the candidate version is deleted from the table.
Note: Discard Changes option is available only for a candidate version of the service instance. -
Commit Changes—To commit the changes, select the candidate version of a service instance and click More > Commit Changes. Click Yes when prompted for confirmation.
When you commit a candidate of a service instance, the configuration is committed and provisioned in the network.
Note: Commit Changes option is available only for a candidate version of the service instance. -
Dry run with Validation—To execute dry run on a service, On the Service Instance page, select the service and click More > Dry run with Validation.
When you execute dry run on a service instance, resources are reserved and the configuration generated for the service instance is validated on the devices without changing the current configuration on the devices. You can view the generated dry-run configuration on the Service Configuration tab of the Service Instance Details page (More > Details).
You can also abandon execution of dry run after initiating it by clicking the Update Placement on the Create Service-Name or Modify Service-Name and then canceling the service creation or modification.
After the dry run is executed successfully, the Order State of the service instance appears as Success and Status as Dry run.
-
Force Sync a service configuration.
To use the Force Sync option, click More > Force Sync.
The Force Sync option reverts a service configuration to the configuration defined by the service instance used to provision the service. Use this option when you have made changes to the service configuration and want to revert to the original configuration defined by the service instance.
-
Upgrade the version of the service design that is associated with a service instance.
To upgrade the service design version for a service instance, select the service instance and click More > Upgrade Service Design. See Upgrade Service Design Version for a Service Instance.
-
Re-run service design upgrade for a service instance—To re-run a service design upgrade, select the service instance and click More > Re-run Service Design Upgrade. The Re-run Service Design Upgrade option retries upgrading the service design version of the selected service instance. Use this option to retry a previously failed upgrade.
-
Export details of a service instance in the JSON format—To export a service instance in the JSON format and save it on your local system, select the service instance and click More > Export. The plan.service-instance-name.json file is downloaded to your local system.
-
Assign placement options for service instances—To automatically assign placement or resource allocation options for an L3VPN, EVPN, or EVPN-VPWS service instance, select the service instance and click More > Update Placements,
Placement options can also be assigned when you are creating or modifying a service instance by using the GUI or service orchestration cMGD CLI. See Manage Placement Configurations for Service Instances.
- Add a tag—A tag is a label in the key:value format that you add to a service
instance so that you can group service instances. For example, you can assign
the tag customer:ABC to all service instances associated with customer ABC.
To add one or more tags to a service instance:
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 a service instance in the Tags column of the Service Instances page.
-
Rollback—You can roll back a service instance version to a previous version. Rolling back restores the configuration of the selected version and saves it as the new version for the service instance.
Note: Rollback is a beta feature in this release.To roll back a service instance to a previous version:
Select the service instance and click More > Rollback.
The Rollback Service Instance page appears.
In the Select Version section of the Rollback Service Instance page, select a service instance for which you want to roll back the service instance version.
In addition to the roll back of the service instance version, the associated service design version can also be restored.
Table 1 lists the fields in the Service Version section.
Table 1: Fields in the Service Version Section (Rollback Service Instance Page) Field
Description
Service Instance
Displays the name of the service instance.
Rollback Version
Displays the earlier version of the service instance.
Design Version
Displays the design version associated with the service instance version.
Description
Displays the description provided during rollback.
Upload Time
Displays the upload date and timestamp of the service instance version.
Click Next to review the changes.
In the Review Changes section of the Rollback Service Instance page, you can review the following changes:
Compare the configuration between the Current and Target versions of the service instance version. Current is the active service 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 finish the Rollback.
In the Finish section of the Rollback Service Instance, you must enter a description or edit the default description. You can view the name of the service instance, target version, and design version of the service instance in this section.
Click Rollback.
A confirmation message appears that the request is submitted and you are returned to the Service Instances page.
If the rollback of a service instance fails, click Cancel to exit or click Back to review and modify the selected options.
On the Service Instances 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 service instance.
For example, if you roll back a service instance from version 7.0.0 to version 3.0.0, the Version column displays version 8.0.0 using the configuration of version 3.0.0.
-
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.
-
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.
-
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).
Note:Sort functionality is not available for the Customer, Devices, Device Count, Sites, and Last Modified By columns.
-
Set the number of rows to be displayed in the table—Click the Display drop-down at the bottom-right corner of the Service Instances table to set the number of rows (15, 30, 50, or 100) to be displayed in the table. The default number of rows displayed is 15.
Use the arrow heads to traverse through the pages or enter a page number to view the entries listed on that page.
-
Set auto refresh frequency—Click the Refresh icon at the bottom-left corner of the Service Instances table to view the most recent updates.
You can also auto refresh the table to view updated details. To set auto refresh frequency:
Click the horizontal ellipsis near the Refresh icon.
Select auto refresh frequency from the available options (30 seconds, 1 minute, 3 minutes, and 5 minutes).
The next refresh time is displayed near the Refresh icon.
To turn off auto refresh, click the horizontal ellipsis and click Off.
Field Descriptions
Table 2 lists the fields on the Service Instances page.
|
Field |
Description |
|---|---|
|
Name |
Name of the service instance. |
|
Customer Id |
Unique ID of the customer for whom you are provisioning the service. |
|
Customer |
Name of the customer for whom you are provisioning the service. |
|
Service Design |
Name of the service design associated with the service instance. |
|
Design version |
Service design version associated with the service instance. |
|
Instance Version |
The version of the service instance. For example, 1.0.0. The version of the service instance is displayed in the Major.Minor.Patch format.
|
|
Devices |
Hostnames of the devices on which you are provisioning the service. |
|
Device Count |
Number of devices on which you are provisioning the service. |
|
Customer Sites |
Customer sites that connect to the service. |
|
Order State |
The execution state of the service order generated for the service instance. A service order can have the following execution states:
|
|
Status |
The provisioning status of the service instance. A service instance can have one of the following provisioning states:
|
|
Status Message |
Additional information about the status of the service order initiated for the service instance. The status is blank for the candidate version of a service instance and Uploaded after the service instance is provisioned (either after creating or modifying). |
|
Pending Changes |
Pending changes for the service instance. A service instance can have one of the following pending changes values:
|
|
Scheduled Time |
The date and time when the service instance is scheduled to be provisioned. The date and time are displayed only if you have scheduled provisioning of the service instance. |
|
Operation Mode |
The mode of operation of the service instance. A service instance can have one of the following operation modes:
|
|
Tags |
Tags assigned to the service instance. If there are more than one tag assigned to the service instance, 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 service instance. |
|
Last Modified |
The date and time when the service instance was last modified. |
|
Last Modified By |
Name of the user who last modified the service instance. |
|
Field |
Description |
|---|---|
|
Name |
Name of the service instance. |
|
Customer |
Name of the customer for whom you are provisioning the service. |
|
Service Design |
Name of the service design associated with the service instance. |
|
Design Version |
Service design version associated with the service instance. |
|
Customer Sites |
Customer sites that connect to the service. |
|
Status Message |
Information about the status of the service order initiated for the service instance. The status is blank for the candidate version of a service instance and Uploaded after the service instance is provisioned (either after creating or modifying). |
|
Order ID |
Unique alphanumeric ID assigned to the service order generated for the service instance. |
|
Scheduled Time |
The date and time when the service instance is scheduled to be provisioned. The date and time are displayed only if you have scheduled provisioning of the service instance. |
|
Last Modified |
The date and time when the service instance was last modified. |
|
Last Modified By |
Name of the user who last modified the service instance. |