Cisco Prime Provisioning API Programmer Guide, 7.0

General Limitations

Let issued service requests finish deployment before issuing other service requests to avoid conflicts.

Prime Provisioning manages a single IS-IS level and multiple OSPF areas. TEM supports one user per OSPF area for managed and backup tunnels and one user per head end device for unmanaged tunnels. However, it does not support tunnels between areas. Each OSPF area is mapped to a TE provider and is discovered area by area independently.

Prime Provisioning only supports MPLS-TE topology with point-to-point links.

Feature-Specific Prerequisites and Limitations

Some features might only be available with a particular license. In addition, the number of nodes provided by the license limits the size of the network. For more information, see the Cisco Prime Provisioning 7.0 User Guide .

A number of specific requirements are associated with the TE Discovery task. Helpful information is available in the Cisco Prime Provisioning 7.0 User Guide .

Concurrent use is supported in the Planning portion of the current implementation of Prime Provisioning.

If your repository predates the ISC 4.1 release and has been upgraded to a 4.1 or later repository, you need to run a TE Discovery task to collect software version information from the devices before deploying service requests.

Non-Cisco Devices and Prime Provisioning TEM

Prime Provisioning does not manage non-Cisco devices and Prime Provisioning cannot be used to provision them.

Prime Provisioning will, however, discover non-Cisco devices and store them in the repository. Tunnels can be run through these devices, the bandwidth consumed can be accounted for, but the devices are not otherwise managed by Prime Provisioning. TE tunnels originating from non-Cisco devices will not be discovered.

Supported TEM Features

Prime Provisioning supports the following TEM features:

• TE Provider

– Create TE Provider

– Delete TE Provider

– Modify TE Provider

– View TE Provider

• Seed Router

– Create Seed Router

• TE Discovery Task

– Create Discovery Task (full and incremental)

– Discovery Status.

• TE Policy

– Create Managed and Unmanaged TE Policies

– Create Managed TE Policy with MPLS enabled/disabled

– Delete Policy

– Modify Policy

– View Policy

• TE Explicit Paths

– Create Explicit Path

– Delete Explicit Path

– Modify Explicit Path

– View Explicit Path

• TE SRLG (Shared-Risk Link Group)

– Create SRLG

– Delete SRLG

– Modify SRLG

– View SRLG

• TE Links (created during discovery)

– Delete TE Links

– View TE Links

• TE Traffic Admission (with Policy-Based Tunnel Selection [PBTS] or Class-Based Tunnel Selection [PBTS])

– Create PBTS TE Traffic Admission SR

– Modify PBTS TE Traffic Admission SR

– Delete PBTS TE Traffic Admission SR

– View PBTS TE Traffic Admission SR

– Create CBTS TE Traffic Admission SR

– Modify CBTS TE Traffic Admission SR

– Delete CBTS TE Traffic Admission SR

– View CBTS TE Traffic Admission SR

• TE Managed Primary Tunnels

– Create Managed Tunnel

– Modify Managed Tunnel

– Delete Managed Tunnel

– View Managed Tunnel

• TE Unmanaged Primary Tunnels

– Create Unmanaged Tunnel

– Modify Unmanaged Tunnel

– Delete Unmanaged Tunnel

– View Unmanaged Tunnel

• TE Backup Tunnels

– Create Backup Tunnel

– Delete Backup Tunnel

– Modify Backup Tunnel

– View TE Tunnel

• TE Routers

– View TE Routers

• TE Protected Elements

– Create TE Protected Element

– View TE Protected Element

– Create Compute Backup for TE Protected Element

– View Compute Backup for TE Protected Element.

The above operations are supported for policies and service requests, which are created to provision a variety of network configurations.

The API XMLs for the above operations are contained in the Cisco Prime Provisioning API 7.0 Programmer Reference.

Policy Examples

The following constitute some common XML policy examples:

• Create TE Policy
• Delete TE Policy
• View TE Policy.

Create TE Policy

Managed policies have setup/hold priorities of 0/0 and can have additional routing constraints such as protection level and max delay.

Unmanaged policies cannot have a setup/hold priority of zero.

Example: TeManagedPolicyCreateRequest.xml

 

Delete TE Policy

A policy can also be deleted based on its name.

Example: TeTunnelPolicyDeleteRequest.xml

View TE Policy

A policy can be viewed based on its name.

Example: TeTunnelPolicyView.xml

TE Discovery Examples

Incremental TE Discovery includes two types of incremental discovery tasks:

• Create Incremental TE Device Discovery
• Create Incremental TE Link Discovery

Create Incremental TE Device Discovery

This example shows how a device that has been added to the network can be discovered. This device needs to be added in the inventory with the TE ID as management IP address. The relevant attributes are highlighted in bold below.

Example: TeIncrementalDiscoveryDevice.xml

Create Incremental TE Link Discovery

This example shows how a link that has been added to the network can be discovered using Link Discovery. The devices EndDeviceA and EndDeviceB must have been discovered already. The relevant attributes are highlighted in bold below.

 

Example: TeIncrementalDiscoveryLink.xml

TE Topology Example

As an example of provisioning service requests, this section depicts a TE network in a number of OSPF areas.

A TE network is discovered by first gathering the TE topology information through a seed device. This device must be configured in Prime Provisioning TEM.

Below is a sample network topology with five IOS devices. To discover the network, isctmp1 is used as the seed router. Discovery, management, and provisioning of TE Tunnels is performed within multiple OSPF areas where each area belongs to a separate Prime Provisioning provider.

Figure 10-1 TE Discovery Through Seed Router

 

For more information about the discovery of multiple OSPF areas, see the Cisco Prime Provisioning 7.0 User Guide.

Service Request Examples

The following XML examples show a typical sequence of events from an API perspective, starting with the creation and deployment of a primary tunnel service request and followed by a short example of creating and deploying a backup tunnel service request.

They also demonstrate the kinds of properties that need to be specified for each request.

• Create and Deploy TE Managed Primary Tunnel SR.
• Create and Deploy Unmanaged Primary Tunnel SR.
• Create and Deploy TE Backup Tunnel SR.
• Create and Deploy TE Traffic Admission SR.

Create and Deploy TE Managed Primary Tunnel SR

In this sequence of events, we go through the following steps:

1. Create TE Managed Primary Tunnel SR.

2. Create TE Managed Primary Tunnel SR Response.

3. Request Performance Computation Status.

4. Receive Computation Response.

5. Save and Deploy Managed Primary Tunnel SR Request.

6. Save and Deploy Managed Primary Tunnel SR Response.

Create TE Managed Primary Tunnel SR

In this example, a managed primary tunnel is created. The request XML returns a response with a Computation ID. Using this Computation ID in the deployment XML, we can deploy the managed tunnel.

Example: CreateTeManagedTunnel.xml

Create TE Managed Primary Tunnel SR Response

The above create request generates the following XML response, which returns a Computation ID.

Example: DeployManagedTunnelComputationResponse.xml

Request Performance Computation Status

Using the Computation ID returned by the above XML response, the Computation ID can now be plugged into a request that goes to the server to check on the status of the computation.

Example: ViewTePrimaryPlanningRequest.xml

Receive Computation Response

Following the foregoing status request, the Prime Provisioning server will respond that it is still working on it. After the computation is finished, the server reports back whether it was a success or a failure. In this case we have a success.

Example: ViewPerformComputationResponse.xml

Save and Deploy Managed Primary Tunnel SR Request

Based on the successful computation in the previous example, we can now use the Computation ID to save and deploy the service request that represents the solution computed by the Prime Provisioning server. After it has run, it returns the subsequrent deployManagedComputation.xml response.

Example: DeployManagedTunnelComputationRequest.xml

Save and Deploy Managed Primary Tunnel SR Response

In response to the foregoing deployment request, the following example executes the deployment based on the provided Computation ID.

Example: DeployManagedTunnelComputationResponse.xml

Create and Deploy Unmanaged Primary Tunnel SR

Unmanaged tunnels are provisioned in the same manner as backup tunnels. See the Cisco Prime Provisioning API 7.0 Programmer Reference for XML examples.

Example: CreateTeUnmanagedTunnel.xml.

Create and Deploy TE Backup Tunnel SR

This request XML creates and deploys a backup tunnel based on a similar set of XML requests and responses as described above for the managed primary tunnel.

Example: CreateTeBackupTunnel.xml

Backup Tunnel SR Response

The following is an example of a response to the backup tunnel service request.

Example: DeployTeBackupTunnel.xml

Create and Deploy TE Traffic Admission SR

Based on the Locator ID, you can now use a TE Traffic Admission service request to enable services on the created tunnel.

This involves the following steps:

1. Create TE Traffic Admission SR Request.

2. Create TE Traffic Admission SR Response.

3. Save and Deploy TE Traffic Admission SR Request.

4. Save and Deploy TE Traffic Admission SR Response.

Create TE Traffic Admission SR Request

In this example, a TE Traffic Admission service request is created to provision a TE Tunnel.

Example: CreateTeAdmissionSrCBTSRequest.xml

Create TE Traffic Admission SR Response

If the service request is successful, the response provides a Locator ID needed for the subsequent deployment step.

Example: CreateTeAdmissionSrCBTSResponse.xml

Save and Deploy TE Traffic Admission SR Request

Run the following XML to save and deploy the TE Traffic Admission service request and have it provisioned on the device.

Example: DeployTeAdmissionSrRequest.xml

Save and Deploy TE Traffic Admission SR Response

After the TE Traffic Admission service request has been processed, a response is returned.

Example: DeployTeAdmissionSrResponse.xml

After this response has been received, the TE Traffic Admission service request will be in the Requested state in Prime Provisioning. It now needs to be saved and deployed to actually be provisioned on the device.

---

Note TE Traffic Admission SR's are deleted and unprovisioned from a device by first decommissioning the TE Traffic Admission service request and then saving and deploying the same service request. By saving and deploying the service request after decommissioning it, the TE Traffic Admission configuration is removed from the device. Force Purge will only remove the TE Traffic Admission service request from Prime Provisioning's database; it will not remove the configuration from the device.

Process Summary

This TEM provisioning example documents the following process:

1. Create provider.

2. Create regions.

3. Create seed device.

4. Create TE provider.

5. Create and run TE Discovery task.

6. Create service definition (policy).

7. Create explicit path.

8. Create managed primary tunnel.

9. Create service request.

Provisioning Process

To provision TEM using Prime Provisioning APIs, a TEM service definition (policy) and a TEM service request are required.

This section describes the process for provisioning TEM using XML examples.

The complete list of XML examples for TEM is available here:
Cisco Prime Provisioning API 7.0 Programmer Reference

---

Note For clarity, this provisioning process shows each step as a separate XML request. Many of these steps can be combined using performBatchOperations.

---

Step 1 Create a provider.

The provider is the administrative domain of an ISP, with one BGP autonomous system (AS) number. The network owned by the provider is called the backbone network. If an ISP has two AS numbers, you must define it as two provider administrative domains.

Use the TeAreaIdentifier parameter to define OSPF areas and for discovering multiple OSPF areas.

 

XML Examples:

ISCProviderCreateRequest.xml

 

Step 2 Create regions.

Each provider can contain multiple regions.

 

XML Examples:

ISCDefaultRegionCreateRequest.xml

 

Step 3 Create a seed device.

This IOS or IOS XR device will be the seed router for TE Discovery. The network discovery process uses the seed router as an initial communication point to discover the MPLS TE network topology.

 

XML Examples:

ISCSeedRouterCreateRequest.xml

 

Step 4 Create a TE provider.

Providers can be defined as TE provider, if they are supporting MPLS TE in their network. To enable a TE network to be managed, it is necessary to create a TE provider. All TE related data associated with a given network is stored under a unique TE provider. A provider and region uniquely define a TE provider .

 

XML Examples:

• ISCTEProviderCreateRequest.xml

 

Step 5 Run a TE Full Discovery task.

Discover the TE network for a particular TE provider to populate the repository with a view to creating primary and backup tunnels.

 

XML Examples:

• TEDiscoveryTaskCreateRequest.xml
• incremetal_discovery_device
• incremetal_discovery_link

 

Step 6 Create service definition (policy).

Service definitions or policies are used to define common tunnel attributes.

 

XML Examples:

• TeManagedPolicyCreateRequest.xml
• TeUnmanagedPolicyCreateRequest.xml.

 

Step 7 Create explicit path.

Paths are defined between source and destination routers, possibly with one or more hops in between. For managed tunnels, the path should not contain any non-TE enabled interfaces.

 

XML Examples:

• TeExplicitPathExcludeCreateRequest.xml

 

Step 8 Create a managed primary tunnel.

Once a TE Policy and an explicit path have been set up, a primary tunnel can be created. The process is very similar for managed and unmanaged tunnels.

 

XML Examples:

• CreateManagedTunnel.xml

 

Step 9 Create service request.

A TE service request defines the service definition and assigns interfaces and attributes.

 

---

Tip Record the LocatorId value from the XML response for the service request. The Locator ID is required for subsequent service request tasks.

XML Example:

• SaveAndDeployPlanningRequest.xml

 

Using Computation ID and Locator ID

The ComputationID is returned by TEM for certain processes and is as important as the Locator ID.

Locator ID refers to a service request object in Prime Provisioning that you are working on, whereas Computation ID refers to a server computation that must be completed satisfactorily before you can work with the servicer request object (Locator ID) again. The Computation ID is returned by an API request that require server input, for example any managed tunnel operations.

Examples of how the Computation ID and Locator ID are used are found in the section Service Request Examples.

Planning Tools

Planning Tools, also referred to as Placement Tools, are used to perform planning functions on the existing network. They are intended for evaluating planned improvements to a traffic-engineered network based on What-If scenarios.

At the present time, most of these tools do not have API support (except Compute Backup) but can be activated from the GUI. See the Cisco Prime Provisioning 7.0 User Guide under Advanced Primary Tunnel Management and Protection Planning.

The planning tools include the following features:

• Primary planning tools:

– Tunnel Audit—Audits for inconsistencies in primary placement on the existing network with or without proposed tunnel or resource changes.

– Tunnel Placement—Usually for new tunnels. Tunnel Placement can generate a new route. It can be used for a tunnel that did not have a path before and needs to be placed.

– Tunnel Repair—Logically performed after Tunnel Audit (if something is wrong). Tunnel Repair has rerouting capabilities and can be used to move tunnels.

– Grooming—An optimization tool that works on the whole network. It is only available when no tunnel attributes have been changed.

• Protection planning tools:

– Audit SR—Audits protection for manually added, modified, and deleted backup tunnels before they are deployed.

– Compute Backup—Automatically calculates the optimal backup tunnel for selected network elements.

– Audit Protection—Audits protection of the selected elements against the existing backup tunnels.

Compute Backup

Compute Backup is used to let TEM automatically compute the necessary backup tunnels to protect specified network elements.

The Compute Backup examples are found in the Cisco Prime Provisioning 7.0 User Guide in the tem\TeProtectedElements folder.

The following example shows how Compute Backup is performed for a TE node.

Example: CreateTeProtectedElementNode.xml

Auditing Service Requests

A configuration audit occurs automatically each time you deploy a service request. During this configuration audit, Prime Provisioning verifies that all Cisco IOS commands are present and that they have the correct syntax. An audit also verifies that there were no errors during deployment by examining the commands configured by the service request on the target devices. If the device configuration does not match what is defined in the service request, the audit flags a warning and sets the service request to a Failed Audit or Lost state.

If you do not want the configuration audit to occur, change the value for the Audit parameter. The Audit parameter supports these values:

• Audit—This is the default. A successfully deployed service request is automatically audited unless this flag is changed.
• NoAudit—Do not perform a configuration audit when the service request is deployed.
• ForceAudit—Perform a configuration audit even if the service request deployment is not successful.

You can use the Audit parameter with a Create, Modify, or Decommission service request or a Deployment task. See the “Service Decommission” section for more information. To perform a configuration audit as a separate task, see the “Configuration Audit” section.