- Index
- About This Guide
- Introduction to the PRIME Fulfillment API
- Getting Started
- Common APIs
- Using Templates
- Monitoring APIs
- MPLS Provisioning
- L2VPN Provisioning
- VPLS Provisioning
- FlexUNI/EVC Provisioning
- Traffic Engineering Management Provisioning
- GUI to API Mapping
- Implementing a Notification Server
- Scripts
- Prime Fulfillment XDE SDK
Index
A
access domains 2-9
defining 2-8
introduction 2-8
API components 1-1
API notifications server 1-8
API server/servlet 1-8
client 1-2
HTTP/HTTPS server 1-3
HTTP authentication/encryption 1-4
HTTP response 1-3
HTTP transport 1-3
message security 1-8
message validation/SOAP faults 1-7
SOAP message envelope 1-5
SOAP message header 1-5
SOAP messages 1-5
SOAP plug-in 1-4
API error messages 1-14
API notifications server 1-8
API operations 1-9
API requests
date/time format 3-14
API server/servlet 1-8
API status
checking from the API 2-1
checking from the GUI 2-2
overview 2-1
attributes
setting up optional attributes 4-8
audit
about configuration audit 3-11
certificate enrollment 3-9
L2VPN service requests 7-32
MPLS service requests 6-44
performing configuration audits 2-12
TEM service requests 10-31
VPLS service requests 8-18
authentication
HTTP authentication/encryption 1-4
remote authentication 5-2
C
canned reports 5-6
certificate enrollment audit 3-9
client 1-2
setting up 5-2
collection
events B-5
operation 3-10
SLA 3-12
common APIs
devices 3-2
groupings 3-5
introduction 3-1
inventory 3-1
resource pools 3-3
session 3-7
topology 3-4
computation ID
using in TEM 10-29
compute backup 10-29
configuration audit
about 3-11
performing 2-12
D
data file
creating data file from service request 4-11
date/time format in API requests 3-14
decommissioning
service 3-10
deployment
service deployment 3-11
device configurations
device locking 5-22
dynamic instantiation of templates 4-3
E
encryption
HTTP authentication/encryption 1-4
error logs 1-16
error messages 1-14
event notification
overview B-1
events
collection B-5
notification B-1
F
FlexUNI/EVC
end-to-end provisioning process 9-93
end-to-end wires 9-34
MPLS core connectivity types 9-2
policy examples 9-3
policy types 9-2
service definitions 9-1
supported service definitions and service orders 9-2
FlexUNI/EVC network diagrams
local connect 9-36
pseudowire 9-34
VPLS 9-34
FlexUNI/EVC policies
Configuring an SVI/EVC Hybrid Scenario 9-25
Create VPLS Policy 9-20
local connect policy 9-3, 9-15
Policy for specifying Service Instance Name for EVC/FlexUNI Service Requests 9-29
pseudowire policy 9-7
VPLS policy 9-10
FlexUNI/EVC policy examples
Create Local Connect Policy with ATM/Ethernet internetworking 9-15
Create Pseudowire Policy with ATM/Ethernet Internetworking 9-20
FlexUNI/EVC provisioning
detailed process 9-94
end-to-end provisioning process 9-93
prerequisites 9-94
process summary 9-93
FlexUNI/EVC service request examples
Configuring an SVI/EVC Hybrid Scenario Service Request 9-61
Create Access Ring with two NPEs 9-58
Create NPC 9-60
Creating a Local Connect Service Request for IOS-XR using Bridge Domain 9-69
Creating a Local Connect Service Request with ATM Ethernet 9-78
Creating a Pseudowire Service Request with ATM Ethernet 9-83
Creating a Pseudowire Service Request with P2P E-line Name 9-74
Creating a VPLS Service Request with IOS XR 9-89
Local Connect Service Request 9-37
Modifying a FlexUNI/EVC Service Request 9-52
Pseudowire Service Request 9-42
Specifying Service Instance Name for FlexUNI/EVC Service Requests 9-65
VPLS Service Request 9-47
FlexUNI/EVC service requests
examples 9-36
introduction 9-32
overview 9-32
functional audit 3-12
G
general purpose APIs 3-13
getting started 2-1
H
HTTP
authentication/encryption 1-4
response 1-3
transport 1-3
HTTP/HTTPS server 1-3
I
installation notes 2-1
introduction to the ISC API 1-1
inventory
creating 2-5
L
L2VPN
ATM policy 7-2
ATM service request 7-11
end-to-end wires 7-9
ERS policy 7-5
ERS service request 7-15
policy examples 7-2
service definitions 7-1
service requests 7-9
supported service definitions 7-2
L2VPN provisioning
introduction 7-1
prerequisites 7-21
process summary 7-20
provisioning process 7-22
RBAC 7-21
link template 4-18
locator ID
using in TEM 10-28
locator IDs 1-14
locking mechanism
device locking 5-22
LOG C-3
logging in 2-3
M
message security 1-8
message validation/SOAP faults 1-7
monitoring
output for reports 5-10
monitoring APIs 5-1
MPLS
core connectivity types 9-2
end-to-end provisioning process 6-35
policy attributes 6-4
schema diagram 6-2
service definitions/policies 6-2
service requests 6-8
supported operations 6-3
MPLS functional audit 3-12
MPLS policy
creating 6-42
MPLS policy example
Create Bundled/Physical Interface 6-5
MPLS provisioning
creating inventory 6-37
detailed process and attributes 6-37
introduction 6-1
process summary 6-36
MPLS service request
creating 6-42
MPLS service request examples
Create BGP Max Prefix with Second VLAN ID and BGP DIO 6-20
Create EIGRP Key Chain 6-26
Create Independent Route Target 6-10
Create OSPF Default Info Originate 6-32
Create Static Route Configuration 6-16
MPLS service requests 6-8
N
negate templates
creating 4-8
using 4-22
non-Cisco devices
in TEM 10-2
notifications
event notifications 5-1
responses 5-3
notification server
implementing B-1
O
optional attributes
setting up 4-8
P
planning tools
compute backup 10-29
oveview 10-29
policies
creating service policy 2-11
L2VPN policy examples 7-2
prerequisites
for FlexUNI/EVC provisioning 9-94
for L2VPN provisioning 7-21
for TEM provisioning 10-1
for VPLS provisioning 8-6
provisioning examples 4-12
probes
SLA 5-13
provider and customer relationship
customer 2-7
defining 2-5
provider 2-5
region 2-7
site 2-8
provisioning examples
prerequisites 4-12
process summary 4-12
templates 4-12
provisioning process
detailed 4-13
R
remote authentication 5-2
reports
canned reports 5-6
introduction 5-4
report definition filters 5-8
report definitions 5-8
SQL-based 5-4
repository
populating 2-4
resource pools
creating 6-39
route aggregation
assigning 2-8
S
scripts
changeMaxRoutes C-2
changepasswd C-3
changepw C-3
collectConfig C-4
command syntax C-2, C-3, C-4, C-5, C-6, C-7, C-8, C-9, C-10, C-11, C-12, C-13, C-14, C-16, C-18, C-19, C-20
deletece C-5
deleteSR C-6
deletesr C-5
deleteUnusedCpes C-6
deployAllSR C-7
deployallsr C-7
deploysr C-7
downinterface C-8
env C-2
Fcollect C-4
File Output Example C-4
file output example C-9
filters C-21
getfile C-9
getpe C-9
getPEs C-10
LOG C-3
log name C-3, C-5, C-7, C-11, C-12
log output example C-3, C-5, C-7, C-11, C-12
Main directory C-2
modifyce C-10
purgeces C-11
purgeConfigs C-12
purgesrs C-12
queries C-21
removesr C-13
showces C-13
showsr C-13
srDump C-16
srdump C-14
STDOUT C-3, C-4, C-5, C-6, C-8, C-9, C-11, C-13, C-14, C-15, C-18, C-20
subdirectories C-20
taskDump C-18
taskdump C-18
upinterface C-19
util C-21
VrfPing C-20
xml C-21
script subdirectories C-20
service decommissioning 3-10
service definitions
introduction 1-14
templates 4-5
service deployment 3-11
service model 1-11
service orders
creating 2-11
example 1-13
introduction 1-12
life cycle 1-12
response 2-12
templates 4-5
service policy
creating 2-11
service requests
auditing 6-44, 7-32, 8-18, 9-103, 10-31
creating 2-11
creating data file from service request 4-11
FlexcUNI/EVC end-to-end wires 9-34
FlexcUNI/EVC service requests 9-32
FlexUNI/EVC examples 9-36
introduction 1-12
L2VPN ATM service request 7-10
L2VPN ERS service request 7-15
L2VPN examples 7-10
TEM 10-9
TEM examples 10-10
templates in service requests 4-18
turning off templates 4-23
VPLS 8-3
servlet
API servlet 1-8
customizing the example servlet B-5
running the example servlet B-3
SLA collection 3-12
SLA probes
common probe parameters 5-16
creating and deploying 5-13
introduction 5-13
types 5-17
viewing 5-18
SLA provisioning 5-12
introduction 5-12
process 5-12
SLA reports 5-19
SOAP
faults 1-7
message body 1-6
message envelope 1-5
message header 1-5
messages 1-5
plug-in 1-4
SQL-based reports 5-4
SRAssociatedTemplate 4-19
subtemplate
creating 4-9
T
task logs
viewing 5-24
tasks
introduction 3-8
viewing 3-9
TE backup tunnel SR
create and deploy 10-18
response 10-19
TEM
compute backup 10-29
non-Cisco devices and ISC TEM 10-2
planning tools 10-29
policy examples 10-4
service definitions 10-2
supported features 10-2
using computation ID and locator ID 10-29
TE managed primary tunnel SR
create and deploy 10-10
create request 10-11
create response 10-12
receive computation response 10-13
request performance computation status 10-12
save and deploy request 10-15
save and deploy response 10-17
template examples
creating templates in policies (N-PE) 4-10
creating templates in policies (U-PE) 4-10
template node objects
data buffer object 4-20
link template 4-18
SRAssociatedTemplate 4-19
using 4-18
templates
adding 4-6
basic template manager functions 4-4
creating in policies 4-10
data 4-2
definition 4-2
detailed provisioning process 4-13
dynamic instantiation 4-3
examples of template operations 4-6
introduction 4-1
policy-level functions 4-4
process summary 4-12
provisioning examples 4-12
removing configurations 4-22
service definitions 4-5
service-level template functions 4-4
service orders 4-5
subtypes 4-4
templates in a service request 4-18
transient 4-17
using 4-1
TEM provisioning
example 10-24
general limitations 10-1
introduction 10-1
prerequisites and limitations 10-1, 10-2
process summary 10-24
provisioning process 10-24
TEM service requests
examples 10-10
introduction 10-9
TE network discovery 10-7
TE policy
creating 10-4
deleting 10-6
viewing 10-6
TE topology example 10-9
TE traffic admission service request
create and deploy 10-19
create request 10-20
create response 10-21
save and deploy request 10-21
save and deploy response 10-22
TE unmanaged primary tunnel SR
create and deploy 10-17
topology
creating physical topology 2-9
Traffic Engineering Management, see TEM 10-1
transient templates 4-17
turning off templates
turning off for MPLS service requests 4-23
turning off for non-MPLS service types 4-24
V
Virtual Private Networks 2-9
virtual private networks (VPNs) 2-8
VPLS
service definitions 8-2
service requests 8-3
VPLS provisioning
prerequisites 8-6
process summary 8-6
provisioning example 8-6
provisioning process 8-7
RBAC 8-7
VPNs 2-9
defining 2-8
W
work flow 2-4
X
XML examples
introduction 1-11
see under templates, MPLS, L2VPN, VPLS, FlexUNI/EVC, TEM 1-11
XML schema 1-10