Cisco IP Solution Center API Programmer Guide, 5.1
Index

Table Of Contents

Numerics - A - B - C - D - E - F - G - H - I - J - L - M - N - O - P - Q - R - S - T - U - V - W - X - Z

Index

Numerics

802.1Q 8-1

A

AAA server 3-2

access domains 2-8, 3-6

access protocol 2-10

active templates 4-22

aggregation, route 2-8

annotations, in schema 1-12

API

checking status 2-1

components 1-1

license 3-7

operations 1-9

port 2-1

server 1-8

XML schema 1-11

appended templates 4-6

asynchronous notifications 1-8

ATM 7-2

L2VPN policy example 7-2

L2VPN service request example 7-11

attachment circuits 7-10

auditing 2-12

configurations 3-11

MPLS service requests 6-15

service requests 3-9

auditing, forced 8-18, 9-50

auditing service request 8-18, 9-49

authentication, HTTP 1-4

authentication, LDAP 5-2

Autodiscovery 2-5

autopick VLAN ID 7-28, 8-15

B

BGP AS 3-6

block call 1-18

body of message, SOAP 1-5

body text, in templates 4-5

BPDU (bridge protocol data unit) 8-1

browser, schema 1-12

buffer templates 4-2

C

canned reports 5-4

Catalyst switches 3-2

CE routing community (CERC) 3-5

certificate chain 3-9

certificate enrollment audit 3-9

checking API status 2-1

CIM objects 1-13

Cisco IOS switches 3-2

Cisco router 3-2

clauses, for searching 5-8

client

connections 1-8

interface 1-2

java 2-1

client, enabling B-1

code attribute, errors 1-17

collection server 5-4, 5-13

collection task 2-10, 3-10

collection zones 3-6

column labels, output file 5-10

command syntax 2-12

comma separated value (CSV) 5-10

common APIs 3-1

components, in errors 1-17

components, of API 1-1

configlet, for templates 4-13

configuration

audit 2-12, 3-11

collection 2-10, 3-10

download 1-14

configurations, for templates 4-2

content, HTTP header 1-3

core type, for VPLS 8-1

CPE, creating 3-3

create session 1-9

creating

objects 1-9

repository inventory 2-5

service orders 2-11

test inventory 3-13

customer reports 5-6

customers, defined 2-7

D

data

file editor 4-19

for templates 4-2

transient 4-15

database, searching 5-4

database change events 1-8, 5-1

data buffer 4-18

datafile

creating from service request 4-10

data records 5-4

data structures 1-11

date and time format in API requests 3-14

debugging 1-18

decommissioning service requests 3-10

default

login session 3-7

MPLS policy 6-3

wait timeout 1-6

define interfaces

MPLS 6-15

VPLS 8-17

defining templates 4-2

deleting

objects 1-9

template data files 4-15

delimiter, output file 5-4

deliver event operation 1-9

deliver event responses 5-3

deploying services 3-11

deploying templates 4-1

description attribute, errors 1-17

device collection 3-10

device group 3-6

device locking 5-21

devices, non-Cisco 3-3

DHCP protocol 3-12

DNS 3-12

DOT1Q, tagging for VPLS 8-1

downloading

configurations 1-14

template files 4-14

templates 4-5

due dates 3-8

dynamic instantiation of templates 4-3

E

editable attributes 2-11, 6-2, 7-2, 8-2

enable client B-1

enabling HTTPS 1-4

enabling SOAP 1-4

enabling VPN 8-14, 9-47

encrypting API messages 1-4

end-to-end wires

FlexUNI/EVC 9-22

L2VPN 7-9

end-user services 1-14

enrollment status 3-9

enumerated schemas 1-11

enumerate instances 1-9

envelope, SOAP 1-5

error

codes 1-18

logs 1-18

messages 1-7, 1-16

responses 1-9

ERS (Ethernet Relay Service) 7-21, 8-1, 8-6

Ethernet Relay Service (ERS)

L2VPN policy example 7-5

L2VPN service request example 7-15

Ethernet TLS 7-2

EVC

see FlexUNI/EVC 9-3

EvcLink attachment circuit 9-14

EVCS 7-2

event listener B-2

event notifications 1-8, 5-1

events, adding to servlet B-3

events, for collection B-5

EWS (Ethernet Wire Service) 7-21, 8-1, 8-6

example servlet B-3

example XML requests 1-13

exception errors 1-7

execQuery operation 5-4

execReport operation 5-7, 5-18

execution status 5-1

expiration, certificate 3-9

exporting records 5-10

F

fault messages 1-5

filenames, for templates 4-2

filters, canned reports 5-9

filters, SLA reports 5-19

filter sets 5-9

flags, wait 1-5

FlexUNI/EVC

connectivity type network diagrams 9-22

create service definition (policy) 9-47

create service request 9-48

end-to-end provisioning process 9-39

link attributes 9-15

local connect policy 9-3

modifying service requests 9-16

MPLS core connectivity types 9-1

overview 9-1

policy examples 9-3

provisioning example 9-39

Pseudowire policy 9-7

service definitions 9-1

service request examples 9-24

service requests 9-14

summary of provisioning process 9-39

VPLS policy 9-10

force audit 8-18, 9-50

force deploy 3-11

format, output data 5-11

FTP 3-12

full mesh VPNs 6-12

G

general purpose APIs 3-13

groupings, for device inventory 3-5

GUI port 2-1

H

header

details 1-6

length 1-3

SOAP 1-5

HTTP 3-12

authentication 1-4

POST 1-3

response 1-3

transport 1-3

httpd server 2-2

HTTPS, enabling 1-4

hub-and-spoke VPNs 6-12

I

ICMP 3-12

IE2100 3-3

implementing service requests 1-14

inactive templates 4-22

infrastructure services 1-14

installation notes 2-1

instance indications 5-1

introduction 1-1

inventory APIs 3-1

Inventory Manager, GUI 2-5

inventory queries 5-7

IP address pools 3-3

J

java client library 2-1

jitter, measuring 3-12, 5-12

joins 5-8

L

L2VPN

policy attributes 7-30

policy examples 7-2

policy subtypes 7-31

provisioning example 7-20

service definitions 7-1

service request examples 7-10

service requests 7-9

LDAP authentication 5-2

length, of headers 1-3

level usage 3-14

libraries, SOAP 1-4

library, java client 2-1

link attributes 6-6

link template 4-16

lists, in reports 5-7

local connect

FlexUNI/EVC network diagram 9-24

FlexUNI/EVC policy examples 9-3

FlexUNI/EVC service request 9-24

locator IDs, for service requests 1-16

locator IDs, tasks 3-9, 5-23

locking devices 5-21

login 1-9, 2-3, 3-7

logs, error 1-18

logs, task 5-23

M

MAC addresses 8-15, 9-48

mandatory elements 1-11

manual confg, for VPLS 8-17

mapping, GUI to API A-1

maximum records 5-11

measuring network performance 3-12, 5-12

merging template data 4-6

messages, SOAP 1-5

message transport 1-3

metadata 1-2

method call 1-6

metrics, SLA 3-12, 5-12

MIB 3-12, 5-12

mode, transparent 8-6, 9-40

model for API 1-14

modifying objects 1-9

modifying service requests 1-15, 4-21

monitoring 5-1

MPLS

auditing 6-15

functional audit 3-12

policy attributes 6-3

service definitions 6-2

templates 4-22

VPN links 6-6

multicast pools 3-3

MVRFCE, for MPLS 6-3

N

name/value pairs 4-5

named filter sets 5-10

named physical connections 2-10

namespaces 1-5, 1-11

native VLAN 8-15

negate template

for removing templates 4-21

negate templates

creating 4-8

prerequisites 3-10

network diagrams

local connect in FlexUNI/EVC 9-24

Pseudowire in FlexUNI/EVC 9-22

VPLS in FlexUNI/EVC 9-23

network objects 3-7

network performance 3-12

network topology 2-9

non-Cisco devices 3-3

notifications, for events 5-1

notifications server 1-8

NPC 2-10, 3-5, 7-27, 8-11, 9-44

NPC ring 3-5, 7-28, 8-13, 9-46

O

object path 1-13

one-dimensional templates 4-12

operation, in SOAP messages 1-6

operations, defined 1-9

operations, for templates 4-5

operations, work flow 2-4

operators, for reports 5-10

Oracle database 4-11, 5-5

orderby clause 5-5

organizations, creating 3-6

output, records for reports 5-5

output, report formats 5-10

output file, for servlet B-4

P

packet loss, measuring 3-12, 5-12

parameter definitions 5-9

pathname, for templates 4-13

PE, creating 3-3

PE roles 7-27

physical links 2-10, 7-27, 8-11, 9-44

pinging devices 3-12

PIX security appliances 3-3

policy attributes

L2VPN 7-30

MPLS 6-3

policy examples

L2VPN 7-2

pools 3-3

populating repository 2-5

port, CE-facing 8-3

port, for API 2-1

POST header 1-3

prepended templates 4-6

probes

parameters 5-13

SLA 5-4, 5-13

types 5-16

viewing 5-18

process flow 1-2

processing server 1-8

properties file 1-8

protocols 3-12

access 2-10

for L2VPN 7-2

for SLA probe 5-16

HTTP 1-3

redistributed 6-2

SNMP 5-12

SOAP 1-4

providers

creating 3-6

defined 2-6

Provisioning

FlexUNI/EVC provisioning process 9-39

provisioning examples

FlexUNI/EVC 9-3, 9-16, 9-24, 9-39

L2VPN 7-20

MPLS 6-7

VPLS 8-6

provisioning steps, generic 2-4

provisioning templates 4-11

Pseudowire

creating PseudowireClass 7-29

FlexUNI/EVC network diagram 9-22

FlexUNI/EVC policy examples 9-7

FlexUNI/EVC service request 9-30

Q

queries, SLA 1-9

queries for reports 5-7

query database 5-4

R

RBAC 1-8, 2-3

receiving servlet, eventListener B-3

record elements 5-10

records

exporting 5-10

SLA data 5-5

redistributed protocols 6-2

region

creating 3-6

defined 2-7

remote authentication 5-2

removing template configurations 3-10, 4-21

report definitions 5-8

reports 5-4

output formats 5-10

SLA 1-9, 3-12

sorting 5-10

repository

change events 5-2

populating 2-5

SLA 5-4

variable chooser 4-19

request method 1-3

resource lists 5-7

resource locking 5-21

resource pools 2-8, 3-3

response time 3-12

return codes, HTTP 1-4

route aggregation 2-8

route distinguisher (RD) 3-3

routes, auditing 3-12

route target (RT) 3-3

routing tables 3-5

S

SA Agent 3-12, 5-12

scheduling service orders 2-11

scheduling tasks 3-8

schema

defined 1-10

enumerations 1-11

viewing 1-12

search criteria 5-8

search database 5-4

secure MAC addresses 8-15, 9-48

security, for messages 1-8

security, LDAP 5-2

service definitions

defined 1-16

L2VPN 7-1

MPLS 6-2

templates 4-5

VPLS 8-2

service deployment 3-11

service level agreement 3-12

service model 1-14

service names 1-16

service order responses 2-12

service orders, defined 1-14

service requests

FlexUNI/EVC 9-14

L2VPN 7-9

MPLS 6-6

state changes 5-3

VPLS 8-3

with templates 4-21

servlet, API 1-8

servlet, for notifications B-1

session APIs 3-7

session ID 3-8

session token 1-5, 2-3

site-of-origin 3-4

sites, creating 3-6

sites, defined 2-8

SLA

collection 3-12

probes 5-4, 5-13

protocols, for probes 5-16

provisioning 5-12

reports 1-9

repository 5-4

SNMP, for SLA 5-12

SNMP notifications 3-12

SNMP version 2-10

SOAP

encoding 1-8

libraries 1-4

operations 1-6

requests 1-3

sort criteria, canned reports 5-10

spreadsheet, output data 5-11

SQL-based reports 5-4

SSL 1-4

stack trace 1-18

state changes, for service requests 5-3

status of API 2-1

status of certificate 3-9

status of templates 4-22

steps for provisioning, generic 2-4

subelements 1-11

subtemplate

creating 4-9

definition 4-3

subtemplates

creating 4-8

subtypes

for L2VPN 7-2

for MPLS 6-3

super template

definition 4-3

Sybase 4-11

synchronous messages 1-8

syntax, for IOS commands 2-12

T

task APIs 3-8

task locator ID 3-9, 5-23

task logs 5-23

TCP Connect 3-12

templates

creating templates in policies 4-10

data for 4-2

defined 4-1

defining 4-2

deploying 4-1

downloading 4-14

dynamic instantiation 4-3

in service requests 4-16, 4-21

order of operations 4-6

removing configurations 4-21

service definitions 4-5

service orders 4-5

setting up optional attributes 4-8

subtypes 4-4

transient 4-15

terminal server 3-3

Tibco bus 5-1

timeline, SLA reports 5-19

timeout, wait 1-6

time-to-live (ttl) 3-7

token, session 1-5, 2-3

Tomcat 2-1

topology, of network 2-9

tracking service requests 1-14

transient templates 4-2, 4-15

transparent mode 7-21, 8-6, 9-40

transport headers 1-3

transport layer 1-8

traps, enable/disable 5-12

turning off templates 4-22

two-dimensional templates 4-12

U

UDP Echo 3-12

UNI (user network interface) 7-2

UNI MAC address 8-15

UNI port security 8-2

unlocking devices 5-21

V

validation, failure messages 1-7

validation, XML 1-2

variable chooser, GUI 4-19

variables

for templates 4-19

two dimensional 4-12

VC ID pools 3-4

VC IDs 8-13, 9-46

viewing

device lock status 5-21

object properties 1-9

probes 5-18

schema 1-12

service order 1-16

task logs 5-23

virtual circuit 8-13, 9-46

virtual terminal protocol (VTP) 7-21, 8-6, 9-40

VLAN, native 8-15

VLAN ID, autopick 7-28, 8-13, 9-46

VLAN ID pools 3-4

VPLS

enabling VPN 8-14, 9-47

FlexUNI/EVC network diagram 9-23

FlexUNI/EVC policy examples 9-10

FlexUNI/EVC service request 9-34

link attributes 8-4

physical links 8-11, 9-44

provisioning example 8-6

service definition 8-2

service requests 8-3

summary of provisioning process 8-6

UNI MAC address 8-15

VLAN ID 8-10, 9-43

VplsLink 8-3

VPN ID 8-13, 9-46

VPNs

creating 3-5

defined 2-9

full mesh 6-12

VPNSM (VPN service module) 3-3

VRF tables 3-5

W

W3C organization 1-11

wait flags 1-5

wait timeout 1-6

well-formed XML requests 1-7

work flow, provisioning 2-4

X

XML

encoding 1-5

examples 1-13

responses 5-3

schema 1-10

validation 1-2

Z

zones, collection 3-6