Cisco IP Solution Center API Programmer Guide, 4.0
Index

Table Of Contents

Numerics - A - B - C - D - E - F - G - H - I - J - K - 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, 10-4, 10-14, 12-6

access domains     2-8, 3-6

access hours, for VPN 3000     10-18

access protocol     2-10

ACL (access control lists)     12-1

active templates     4-13

aggregated rate limiters     9-6

aggregated traffic shapers     9-6

aggregation, route     2-8

AH (authentication header)     10-16

algorithm, hash     10-3

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-10

appended templates     4-4

asynchronous notifications     1-8

ATM     7-1

attachment circuits     7-2

attributes, unsetting     9-4

auditing     2-12

configurations     3-11

IPsec service requests     3-9

MPLS service requests     6-13

VPN tunnels     3-12

auditing, forced     8-18

authentication, HTTP     1-4

authentication, LDAP     5-2

authentication proxy     12-2

authentication server type     10-14

Autodiscovery     2-5

autopick VLAN ID     7-12, 8-15

autotranslation     11-1

avoidance, for QoS     9-3

B

BGP AS     3-6

block call     1-18

body of message, SOAP     1-5

body text, in templates     4-3

BPDU (bridge protocol data unit)     8-1

browser, schema     1-12

buffer templates     4-2

C

canned reports     5-4

CAR, interface-based     9-6

Catalyst switches     3-2

CBAC (context-based access control)     12-11

CE routing community (CERC)     3-5

certificate chain     3-9

certificate enrollment audit     3-9

checking API status     2-1

child policies, for firewalls     12-11

CIM objects     1-13

Cisco express forwarding (CEF)     9-2

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

committed information rate     9-18

common APIs     3-1

components, in errors     1-17

components, of API     1-1

compressed real-time protocol (cRTP)     9-6

configlet, for templates     4-6

configuration

audit     2-12, 3-11

collection     2-10, 3-10

download     1-14

configurations, for templates     4-2

congestion management     9-3

content, HTTP header     1-3

core type, for VPLS     8-1

CPE, creating     3-3

CPE role     10-4

create session     1-9

creating

objects     1-9

repository inventory     2-5

service orders     2-11

test inventory     3-14

crypto maps     10-3, 10-8

crypto profiles     10-3

customer reports     5-6

customers, defined     2-7

D

data

file editor     4-11

for templates     4-2

transient     4-8

database, searching     5-4

database change events     1-8, 5-1

data buffer     4-10

data records     5-4

data service class     9-3

data structures     1-10

debugging     1-18

decommissioning service requests     3-10, 4-16

default

login session     3-7

MPLS policy     6-3

wait timeout     1-6

define interfaces

MPLS     6-13

VPLS     8-17

defining templates     4-2

deleting

objects     1-9

template data files     4-8

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 interface, AAA server     10-5

device locking     5-21

device peer IP address ranges     11-8

devices, non-Cisco     3-3

DHCP protocol     3-13

DHCP server     10-19

DHGroup     10-16

DMZ, for firewalls     12-5

DNS     3-13

documents, related     xviii

DOT1Q, tagging for VPLS     8-1

downloading

configurations     1-14

template files     4-7

templates     4-3

DSCP value     9-3

due dates     3-8

dynamic address translation     11-2

E

Easy VPN site-to-site policy     10-3

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

enable client     B-1

enabling HTTPS     1-4

enabling SOAP     1-4

enabling VPN     8-14

encapsulation type, for interfaces     11-6

encrypting API messages     1-4

encryption policies     10-3

end-to-end wires     7-2

end-user services     1-14

enrollment status     3-9

enumerated schemas     1-11

enumerate instances     1-9

envelope, SOAP     1-4

EoMPLS     9-2

error

codes     1-18

logs     1-18

messages     1-7, 1-17

responses     1-9

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

ESP (Encapsulating Security Payload)     10-16

Ethernet TLS     7-1

EVCS     7-1

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-5, 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

external authentication method     10-14

F

failover devices     10-4

fault messages     1-5

filenames, for templates     4-2

filtering URLs, for firewalls     12-1

filter rules, for firewalls     12-11

filters, canned reports     5-9

filters, SLA reports     5-19

filter sets     5-9

Firewall

link object     12-12

provisioning     12-1

provisioning example     12-3

role     12-5

service requests     12-2

flags, wait     1-5

force audit     8-18

force deploy     3-11

format, output data     5-11

FRF.12     9-6

FTP     3-13

full mesh VPNs     6-10, 10-3

functional audit task     3-12

G

general purpose APIs     3-14

GRE (generic routing encapsulation)     10-2

groupings, for device inventory     3-6

group parameters     10-4, 10-18

group preshared key     10-11

GUI port     2-1

H

HA (High Availability)     10-11

hash algorithm     10-3

header

details     1-6

length     1-3

SOAP     1-5

host preshared key     10-11

HTTP     3-13

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-10, 10-3

I

ICMP     3-13

IE2100     3-3

IKE proposals     10-3, 10-16

implementing service requests     1-14

inactive templates     4-13

infrastructure services     1-14

inside interface     11-7

inspection rules     12-1

installation notes     2-1

instance indications     5-1

interface encapsulation type     11-6

interfaces

firewall role     12-5

for NAT     11-7

marking     9-11

public and private     10-13

introduction     1-1

inventory APIs     3-1

Inventory Manager, GUI     2-5

inventory queries     5-7

IP address pools     3-3

IP precedence     9-3

IP QoS     9-15

IPsec

functional audits     3-12

group     10-14

HA (High Availability)     10-11

keys     3-11

link object     10-20

policy types     10-2

proposals     10-3, 10-16

provisioning example     10-8

service requests     10-4

tunnels     3-12

IPsec to MPLS mapping     10-3

IPv4 connectivity     10-8

J

java client library     2-1

jitter, measuring     3-13, 5-12

joins     5-8

K

keepalives     10-16

keys, preshared     10-11

keys, regenerating     3-11

L

L2TP over IPsec     10-17

L2VPN

policy attributes     7-13

policy subtypes     7-15

provisioning example     7-3

service definitions     7-1

service requests     7-2

with QoS     9-18

LDAP authentication     5-2

length, of headers     1-3

level usage     3-14

libraries, SOAP     1-4

library, java client     2-1

lifetime, SA and IPsec     10-3

lifetime attributes     10-16

link attributes     6-6

link bandwidth     9-6

link efficiency settings     9-6

link policy, QoS     9-2

link profile

EoMPLS     9-18

IP QoS     9-15

link template     4-9

lists, in reports     5-7

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

management service class     9-3

mandatory elements     1-11

manual confg, for VPLS     8-17

mapping, GUI to API     A-1

mapping, IPsec to MPLS     10-3

marking interfaces     9-11

maximum records     5-11

measuring network performance     3-13, 5-12

merging template data     4-4

messages, SOAP     1-4

message transport     1-3

metadata     1-2

method call     1-6

metrics, SLA     3-13, 5-12

MIB     3-13, 5-12

MLPPP     9-6

mode, network extension     10-19

mode, transparent     8-6

mode configuration     10-4

model for API     1-14

modifying objects     1-9

modifying service requests     1-15, 4-13

monitoring     5-1

MPLS

auditing     6-13

functional audit     3-12

policy attributes     6-3

service definitions     6-2

templates     4-13

VPN links     6-6

with QoS     9-18

MPLS Exp. value     9-2

multicast pools     3-3

MVRFCE, for MPLS     6-3

N

name/value pairs     4-3

named filter sets     5-10

named physical connections     2-10

namespaces     1-5, 1-10

NAT

address pool     11-8

provisioning example     11-5

service requests     11-1

native VLAN     8-15

negate templates     3-10, 4-14

network-based VPN policies     10-3

network extension mode     10-19

network objects     3-7, 9-13, 12-5

network performance     3-13

network topology     2-9, 10-3

NHRP (next hop resolution protocol)     10-2

No NAT     11-8

non-Cisco devices     3-3

notifications, for events     5-1

notifications server     1-8

NPC     2-10, 3-5, 7-11, 8-11

NPC ring     3-5, 7-12, 8-13

NT Domain     10-14

O

object path     1-13

one-dimensional templates     4-5

operation, in SOAP messages     1-6

operations, defined     1-9

operations, for templates     4-3

operations, work flow     2-4

operators, for reports     5-10

Oracle database     4-4, 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

outside interface     11-7

overlapping IP addresses     11-1

P

packet filtering     12-1

packet loss, measuring     3-13, 5-12

parameter definitions     5-9

parent policies, for firewalls     12-11

pathname, for templates     4-6

PE, creating     3-3

peer IP address ranges     11-2

permit IPsec     12-11

PE roles     7-11

PFS (perfect forward secrecy)     10-3

physical links     2-10, 7-11, 8-11

pinging devices     3-13

PIX security appliances     3-3, 10-9

policy attributes

L2VPN     7-13

MPLS     6-3

QoS     9-13

policy types, for IPsec     10-2

pools     3-3

populating repository     2-5

port, CE-facing     8-3

port, for API     2-1

port type, for IPsec     10-9

POST header     1-3

prepended templates     4-4

preshared keys     10-11

private interface     10-13

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-13

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 examples

Firewall     12-3

L2VPN     7-3

MPLS     6-7

NAT     11-5

QoS     9-8

VPLS     8-6

provisioning steps, generic     2-4

provisioning templates     4-4

public interface     10-13

pure IPsec tunnels     10-2

Q

QoS

link objects     9-7

marking interfaces     9-11

policy     9-1

provisioning example     9-8

service classes     9-2

subtypes     9-2

with service requests     9-17

queries, SLA     1-9

queries for reports     5-7

query database     5-4

R

RADIUS     10-14

rate limiting     9-3

RBAC     1-7, 2-3

receiving servlet, eventListener     B-3

record elements     5-10

records

exporting     5-10

SLA data     5-5

redistributed protocols     6-2

regenerating IPsec keys     3-11

region

creating     3-6

defined     2-7

related documents

ISC     xviii

QoS technology     xix

remarking interfaces     9-2

remote access     3-9, 10-4

remote authentication     5-2

removing template configurations     3-10, 4-13

report definitions     5-8

reports     5-4

output formats     5-10

SLA     1-9, 3-13

sorting     5-10

repository

change events     5-2

populating     2-5

SLA     5-4

variable chooser     4-11

request method     1-3

resource lists     5-7

resource locking     5-21

resource pools     2-8, 3-3

response time     3-13

return codes, HTTP     1-4

route aggregation     2-8

route distinguisher (RD)     3-4

routes, auditing     3-12

route target (RT)     3-4

routing protocol, in tunnel     10-3

routing protocol service class     9-3

routing tables     3-5

S

SA (security association)     10-3

SA Agent     3-13, 5-12

SA lifetime     10-3

scheduling service orders     2-11

scheduling tasks     3-8

schema

defined     1-10

enumerations     1-11

viewing     1-12

SDI (RSA SecurID)     10-14

search criteria     5-8

search database     5-4

secure MAC addresses     8-15

security, for messages     1-7

security, LDAP     5-2

service classes     9-2

service definitions

defined     1-16

IPsec     10-1

L2VPN     7-1

MPLS     6-2

QoS     9-1

templates     4-3

VPLS     8-2

service deployment     3-11

service level agreement     3-13

service model     1-14

service modules, VPN     10-9

service names     1-16

service order responses     2-12

service orders, defined     1-14

service requests

firewall     12-2

IPsec     10-4

L2VPN     7-2

MPLS     6-6

NAT     11-1

state changes     5-3

VPLS     8-3

with QoS     9-17

with templates     4-13

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

site-to-site VPN policies     10-3

SLA

collection     3-13

probes     5-4, 5-13

protocols, for probes     5-16

provisioning     5-12

reports     1-9

repository     5-4

slot number     10-10

SNMP, for SLA     5-12

SNMP notifications     3-13

SNMP version     2-10

SOAP

encoding     1-8

libraries     1-4

operations     1-6

requests     1-3

sort criteria, canned reports     5-10

split tunneling     10-18

spreadsheet, output data     5-11

SQL-based reports     5-4

SSL     1-4

stack trace     1-18

state changes, for service requests     5-3

stateful firewalls     12-1

static address translation     11-2

static crypto maps     10-3

status of API     2-1

status of certificate     3-9

status of templates     4-13

steps for provisioning, generic     2-4

subelements     1-11

subtypes

for L2VPN     7-1

for MPLS     6-3

for QoS     9-2

Sybase     4-4

synchronous messages     1-8

syntax, for IOS commands     2-12

Syslog settings     12-1

T

TACACS     10-14

task APIs     3-8

task locator ID     3-9, 5-23

task logs     5-23

TCP Connect     3-13

templates

defined     4-1

downloading     4-7

in service requests     4-9, 4-13

IPsec remote access     10-5

negate     4-14

order of operations     4-15

removing configurations     4-13

transient     4-8

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

topology type, IPsec service requests     10-20

tracking service requests     1-14

traffic classification     9-13

traffic marking     9-3

traffic redirect     11-8

traffic shaping     9-3, 9-6

transient templates     4-2, 4-8

transparent mode     7-5, 8-6

transport headers     1-3

transport layer     1-7

traps, enable/disable     5-12

tunneling protocol     10-17

tunnels, IPsec     3-12

turning off templates     4-13

two-dimensional templates     4-5

U

UDP Echo     3-13

UNI (user network interface)     7-2

UNI MAC address     8-15

UNI port security     8-2

unlocking devices     5-21

unmanaged devices     10-8

unsetting attributes     9-4

URL filtering     12-1

user group     10-4

V

validation, failure messages     1-7

validation, XML     1-2

variable chooser, GUI     4-11

variables

for templates     4-11

traffic classification     9-13

two dimensional     4-5

VC ID pools     3-4

VC IDs     8-13

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

virtual terminal protocol (VTP)     7-5, 8-6

VLAN, native     8-15

VLAN ID, autopick     7-12, 8-13

VLAN ID pools     3-4

VoIP service class     9-3

VPLS

enabling VPN     8-14

link attributes     8-4

physical links     8-11

provisioning example     8-6

service definition     8-2

service requests     8-3

UNI MAC address     8-15

VLAN ID     8-10

VplsLink     8-3

VPN 3000     3-3, 10-9

VPN ID     8-13

VPNs

creating     3-5

defined     2-9

full mesh     6-10

VPNSM (VPN service module)     3-3, 10-9

VPN traffic     10-1

VRF tables     3-5

W

W3C organization     1-10

wait flags     1-5

wait timeout     1-6

well-formed XML requests     1-7

wildcard preshared key     10-11

work flow, provisioning     2-4

X

XAuth (extended authentication)     10-4

XML

encoding     1-5

examples     1-13

responses     5-3

schema     1-10

validation     1-2

Z

zones, collection     3-6