Cisco Prime Provisioning API Programmer Guide, 7.2

Schema Diagram

Figure 6-1 shows the schema diagram for an MPLS service definition.

Figure 6-1 MPLS Service Definition Schema Diagram

For each service definition property, you can set an additional attribute, editable=true, to allow the network operator to override these attributes when creating the service request. If an attribute is set to editable=false, these attributes cannot be changed in the service request.

Note When a property has the additional attribute editable=true, all the related and child attributes are also editable.

See the following example:

Supported MPLS Operations

The following basic API operations are supported in this release:

Policies

• PE_CE

– Create PE_CE Policy

– Modify PE_CE Policy

– Delete the PE_CE Policy

• PE_NOCE

– Create PE_NOCE Policy

– Modify the PE_NOCE Policy

– Delete the PE_NOCE Policy

• MVRF_CE

– Create MVRF_CE Policy

– Modify MVRF_CE Policy

– Delete MVRF_CE Policy

• MVRF_NO_CE

– Create MVRF_NO_CE Policy

– Modify MVRF_NOCE Policy

– Delete MVRF_NOCE Policy

Service Requests

• PE_CE SR

– Create PE_CE SR

– Modify PE_CE SR

– Delete the PE_CE SR

• PE_CE SR

– Create PE_CE SR

– Modify the PE_NOCE SR

– Delete the PE_NOCE SR

• MVRF_CE SR

– Create MVRF_CE SR

– Modify MVRF_CE SR

– Delete MVRF_CE SR

• MVRF_NO_CE SR

– Create MVRF_NO_CE SR

– Modify MVRF_NOCE SR

– Delete MVRF_NOCE SR

Besides the above, you can also perform the following operations:

• View MPLS Policy
• View MPLS SR Response
• View MPLS SR

The End-to-End Provisioning section of this document includes examples of inventory and resource pool operations.

MPLS Policy Attributes

The MPLS policy attributes include; the policy subtype, device interfaces and encapsulation types, IP addressing schemes, routing protocols, and VPN membership information. These values are set based on the policy subtype.

The following MPLS policy subtypes are supported:

• PE_CE—A standard MPLS policy for the PE_CE link. This is the default MPLS policy for Prime Provisioning.
• PE_NO_CE—In this policy type, you specify only the PE interface information. The CE device at the customer location is not managed by Prime Provisioning.
• PE_MVRFCE_CE—A Multi-VPN routing and forwarding CE (MVRFCE) network has multiple CE devices that connect to one MVRFCE device. The MVRFCE stores the VRFs for all VPNs in the customer network and connects directly with the PE device at the edge of the provider network. Prime Provisioning manages the PE to MVRFCE to CE link.
• PE_MVRFCE_NO_CE—Prime Provisioning manages the PE to MVRFCE link. The CE device at the customer site is not managed by Prime Provisioning.

Note For all policy subtypes with no CE present, you do not declare the CE devices to be CPEs, and you do not set policy attributes for the CE devices in the service definition.

There are numerous properties that can be set for an MPLS policy. Figure 6-2 shows a partial schema diagram for the MPLSPolicAttributes with SubType=PE_CE.

Figure 6-2 MPLS Policy Attributes Schema Diagram

Policy Examples

This section contains API XML examples of the following MPLS policies:

• Creating an MPLS Pseudowire Policy
• Creating an MPLS VPN Topology

Creating an MPLS Pseudowire Policy

As an example of an MPLS pseudowire policy, the following illustrates how to create a BGP policy for a PE no CE case.

Example: CreateMPLSServiceDefn_PE_NO_CE_PW_MPLS.xml

Creating an MPLS VPN Topology

This example is used to set up a L3VPN topology in a service policy. To do this, the VPN_TOPOLOGY attribute must be set to true as in the example. Also make sure to set the attribute CERC_RTTYPE.

Example: CreateMPLSServiceDefn_PE_NO_CE_VPN_TOPOLOGY.xml

Other Policy Examples

• CreateMPLSServiceDef_BGPMaxPrefix_PE_NO_CE_IPV4
• CreateMPLSServiceDef_BGPMaxPrefix_PE_NO_CE_IPV6
• CreateMPLSServiceDefn_BGPMapPrefix_PE_CE_IPV4_IPV6
• CreateMPLSServiceDefn_BGPMapPrefix_PE_NOCE_IPV4_IPV6
• CreateMPLSServiceDefn_EIGRP_KeyChain_PE_CE_IPV4
• CreateMPLSServiceDefn_EIGRP_KeyChain_PE_CE_IPV6
• CreateMPLSServiceDefn_EIGRP_KeyChain_PE_NO_CE_IPV4
• CreateMPLSServiceDefn_EIGRP_KeyChain_PE_NO_CE_IPV6
• CreateMPLSServiceDefn_MVRF_CE
• CreateMPLSServiceDefn_MVRF_NO_CE
• CreateMPLSServiceDefn_MVRF_NO_CE_OSPFPOLICY
• CreateMPLSServiceDefn_OSPF_DefaultInfoOriginate_PE_CE_IPV4
• CreateMPLSServiceDefn_OSPF_DefaultInfoOriginate_PE_NO_CE_IPV4
• CreateMPLSServiceDefn_PE_CE
• CreateMPLSServiceDefn_PE_CE_BGP_DEFAULT_INFO_ORIGINATE_IPV4
• CreateMPLSServiceDefn_PE_CE_BGP_DEFAULT_INFO_ORIGINATE_IPV6
• CreateMPLSServiceDefn_PE_CE_BGP_IPV4_BGPROUTEMAP
• CreateMPLSServiceDefn_PE_CE_BGP_IPV4_IPV6_BGPROUTEMAP
• CreateMPLSServiceDefn_PE_CE_BGP_IPV4_IPV6_RdFormat
• CreateMPLSServiceDefn_PE_CE_BGP_IPV4_RdFormat
• CreateMPLSServiceDefn_PE_CE_CRSPRT
• CreateMPLSServiceDefn_PE_CE_OSPFMATCH
• CreateMPLSServiceDefn_PE_CE_OSPFPOLICY
• CreateMPLSServiceDefn_PE_NO_CE
• CreateMPLSServiceDefn_PE_NO_CE_ALLOW_DUPLICATE_IP
• CreateMPLSServiceDefn_PE_NO_CE_BGP_DEFAULT_INFO_ORIGINATE_IPV4
• CreateMPLSServiceDefn_PE_NO_CE_BGP_DEFAULT_INFO_ORIGINATE_IPV6
• CreateMPLSServiceDefn_PE_NO_CE_BGP_IPV4_IPV6_BGPROUTEMAP
• CreateMPLSServiceDefn_PE_NO_CE_BGP_IPV4_IPV6_RdFormat
• CreateMPLSServiceDefn_PE_NO_CE_BGP_IPV6
• CreateMPLSServiceDefn_PE_NO_CE_BGP_IPV6_RdFormat
• CreateMPLSServiceDefn_PE_NO_CE_BGP_redis_IPV6

Service Request Examples

The following XML examples illustrate how MPLS APIs can be used. They also demonstrate the kinds of properties that need to be specified for each request.

In the following examples, significant attributes are highlighted in bold.

Examples of these three features are included below:

• Creating an Independent Route Target Service Request
• Creating a Static Route Configuration Service Request
• Creating a BGP Max Prefix Service Request with Second VLAN ID and BGP DIO
• Creating an EIGRP Key Chain Service Request
• Creating an OSPF Default Info Originate Service Request
• Creating an MPLS Pseudowire Service Request
• Creating an MPLS VPN PE No CE EVC UPE Service Request
• Creating an MPLS VPN Topology Service Request
• Creating an MPLS 6VPE Grey Management Service Request

Creating an Independent Route Target Service Request

In this example, a service order is created with a unique route target for IPv4 and IPv6.

The attribute relevant for the unique route target example is CERC_RTTYPE (in bold below). The preferred values for CERC_RTTYPE tag are IPv4, IPv6 and dual. If the RT Type mentioned does not match with IPv4 or IPv6 or dual, it will throw an error.

Note the following:

• The unique RT feature is supported only for IOS XR devices and only when the corresponding DCPL property is set to true.
• When a service request is created, the RT Type of the CERCs mentioned in the CERC_MEMBERSHIP should be indicated.
• When modifying a service request, a new CERC of RT Type can be added according to the address family only. Otherwise, it will throw error.
• If the CERC_RTTYPE tag is not indicated when modifying the script, the newly added CERC will take RT Type as its address family.
• When modifying a service request, the CERC_RTTYPE of an existing CERC can be modified.
• When modifying a CERC of RT Type dual to IPv6, pass the CERC name with the RT Type to be modified.

Example:

cerc1= dual is the RT Type at the time the service request is created. This now needs to be changed to IPv6 and when modifying the script, pass cerc1= IPv6 in the CERC_RTTYPE tag. Then the cerc1 RT configuration will be changed to IPv6.

If a CERC needs to be deleted, specify the CERC name in deleteInstance. The specified CERC will be deleted.

Note When creating a service request for dual address family, the RT configuration can be IPv4 and IPv6, or dual. There should be two CERCs, one with IPv4 and another with IPv6, or one CERC with the RT configuration dual. If a service request is created for IPV4 address family, the RT configuration should be only IPv4, and if it is created for IPv6 address family, it should be only IPv6.

Example: CreateMPLSServiceOrder_PE_NO_CE_IPV4_IPV6_Unique_RT.xml

Creating a Static Route Configuration Service Request

In this example XML script, a static route configuration is created. Both the IPv4 attribute Static_Next_Hop_Option and the IPv6 attribute Static_Next_Hop_Option_IPV6 are given the new value OUTGOING_INTF_NAME_NEXT_HOP_IPADDR when the service request is created.

The preferred values for Static_Next_Hop_Option are OUT_GOING_INTF_NAME, NEXT_HOP_IPADDR, and OUTGOING_INTF_NAME_NEXT_HOP_IPADDR.

Other relevant attributers are the IPv4 attribute STATIC_NEXT_HOP_IP_ADDR, which is set to 2.22.29.28 and the IPv6 attribute STATIC_NEXT_HOP_IPV6_ADDR, which is set to 89::68.

Note In the PE_CE case, no values have been specified for Next Hop Ip Address. For PE_NO_CE, the Next Hop Ip Address value should be specified when selecting NEXT_HOP_IPADDR or OUTGOING_INTF_NAME_NEXT_HOP_IPADDR for Static_Next_Hop_Option.

File: CreateMPLSServiceOrder_StaticRoute_PE_NO_CE.xml

Creating a BGP Max Prefix Service Request with Second VLAN ID and BGP DIO

This example shows how to create a service request for BGP max prefix, BGP Default Info Originate and second VLAN ID with a PE no CE case (IPv4 and IPv6).

The significant attributes for this specific example are highlighted in bold.

Example: CreateMPLSServiceOrder_BGP_MaxPrefix_BGP_DIO_SecondVlanId_PE_NO_CE_IPV4_IPV6.xml

Creating an EIGRP Key Chain Service Request

This example shows how to create a service request for the EIGRP key chain feature with a PE and a CE (IPv4 or IPv6).

Example: CreateMPLSServiceOrder_EIGRP_KeyChain_PE_CE_IPV4_IPV6.xml

Creating an OSPF Default Info Originate Service Request

This example shows how to create a service request for generating a default route into an OSPF routing domain with a PE and no CE (IPv4 only).

Example: CreateMPLSServiceOrder_OSPF_DefaultInfoOriginate_PE_NO_CE_IPV4.xml

Creating an MPLS Pseudowire Service Request

As an example of an MPLS pseudowire service request, the following illustrates how to create a BGP service request for a PE no CE case.

Example: CreateMPLSServiceOrder_PE_NO_CE_PW_MPLS.xml

Creating an MPLS VPN PE No CE EVC UPE Service Request

This XML example creates an L3VPN service request for a PE no CE EVC UPE case. The relevant attributes to set are the child attributes for the class path UpeEVCServiceInstanceAttrs, which have been highlighted below.

Example: CreateMPLSServiceOrder_PE_NO_CE_EVC_UPE.xml

Creating an MPLS VPN Topology Service Request

This example is used to set up a L3VPN topology service request. To do this, set the attributes of the LinkAttrs class and the attribute CERC_RTTYPE, both highlighted below.

Example: CreateMPLSServiceOrder_PE_NO_CE_VPN_TOPOLOGY.xml

Creating an MPLS 6VPE Grey Management Service Request

This example is used to create an MPLS 6VPE Grey Management Service Request for IOS and IOS XR. Do this by setting the attribute Join_Grey_Mgmt_Vpn to true and the attribute JOIN_GREY_MGMT_VPN_OPTION to IPv6. Both are highlighted below.

Example: CreateMPLSServiceOrder_PE_CE_Grey_Mgmt.xml