Table Of Contents

Symbols - A - B - C - D - E - F - G - H - I - K - L - M - N - O - P - R - S - T - U - V - W - X -

Index

Symbols

<Action>     4-58

<AdminAction>     4-58

<AdminOperational>     4-58

<Alarm>     10-105

<Clear>     1-25

<CLI>     1-26

<CLI> tag     2-50, 3-53, 6-87

<ClientName>     2-47, 2-49

<Comment>     2-47

<Commit>     1-25, 2-37

errors     2-39

Mode attribute     2-38

Rollback     2-44

<Commit> operation     2-40

<CommitId> tag     2-39, 2-44, 2-47

<Configuration>     4-58

<Configuration⁄> tag     5-70

<Delete>     1-25, 2-39, 2-50, 4-57

AAA privileges     8-95

native data operations     4-63

<Delete⁄> tag     4-67

<destination>     15-131

<EBGPMultihopMaxHopCount>     5-74

<Error> element     8-96

<FailedConfig> tag     2-40

<File>     2-35

<Filter>     5-83

<Get>     1-25, 2-31, 2-33, 3-53, 4-57

AAA privileges     8-95

native data operations     4-63

triggering     4-62

<GetConfigurationHistory>     1-25, 2-47

maximum attribute     2-48

<GetConfigurationSession>     1-25

<GetConfigurationSessions>     2-49

<GetNext>     1-26

IteratorID     7-89

<GetVersionInformation>     1-25

<HoldTime>     4-62

<Label>     2-47

<Line>     2-47, 2-49

<Load>     1-25, 2-35, 2-40, 3-55

<Lock>     1-25, 2-31

<LockHeld>     2-49

<LoopbackCheck>     5-74

<Naming> tag     4-62

<Operational>     3-53, 4-58

<Previous>     2-45

<Register>     10-105

<RemoteAS>     5-74

<Response>

IteratorID     7-89

<Rollback>     1-25, 2-39, 2-44, 2-45

<Save>     1-25, 2-35, 2-37

<SessionId>     2-49

<Set>     1-25, 2-39, 2-50, 4-57

AAA privileges     8-95

native data operations     4-63

<Since>     2-49

<Timestamp>     2-47

<Unlock>     1-25, 2-41

<Unlock⁄>     2-41

<UserId>     2-47, 2-49

<version>     15-131

A

AAA (authentication, authorization, and accounting)

authorization     8-95

definition     1-20

login     2-29

options

ASCII authentication     12-117

default     12-117

security (perl scripting toolkit)     15-130

ACL (Access Control List)

CLI commands     15-156

entry, add     15-156

inbound traffic     15-156

list     15-157

perl data object API     15-156

add_neighbors_to_group.pl file     15-153

alarm_deregister function     15-147

alarm_operations.xsd     14-126

alarm_receive function     15-147

alarm_register function     15-147

alarms

deregistration     10-106

event notification     3-55

filter criteria, types of     10-105

notification     10-107

registration     10-105

tags, types of     10-107

API (application programming interface)

perl data object     15-130

perl notification/alarm     15-130

perl XML

concept     15-130

configuration examples     15-151

operational examples     15-158

arguments, management session

connection_timeout     15-133

host     15-133

interactive     15-132

password     15-133

port     15-133

prompt     15-133

response_timeout     15-133

ssh_version     15-133

transport     15-133

use_command_line     15-132

username     15-133

ASCII authentication option     12-117

Atomic mode     2-38

B

BASE package common schemas     14-126

batch_send method     15-145

batch_start method     15-145

batch API

batch_send method     15-145

batch_start method     15-145

usage     15-144

batched requests     1-26

BestEffort     2-38

BGP (Border Gateway Protocol)

CLI commands     15-152

configuration     A-165

data object interface     15-152

get request     3-53

neighbor

add list     15-152

members, display     15-153

set description     15-152

bgp_neighbor_table_html.pl file     15-164

Border Gateway Protocol

See BGP     3-53

browse, target configuration     2-31

C

cerrno     11-113

ChangedConfig     2-32

chmod command     15-151

CircuitType object     15-154

Cisco-IOS_XR-Perl-Scripting-Toolkit-.tar.gz file     15-131

Clear tag     1-25

CLI (command-line interface)

CLI-based scripts     1-19

defined     1-20

operations     1-26

cli_operations.xsd     14-126

CLI command

encapsulated     1-21, 1-26, 6-87

show     4-58

show aaa userdb     15-155

show bgp neighbors     15-163

show ip interfaces     15-160, 15-161

show isis database level     15-159

show isis neighbors     15-161

show rollback points     2-48

xml agent tty     12-121

XML and     6-88

ClientID attribute     1-24

client session

commit operation     2-39

limitation     2-29

CLI tag     1-26

commit

changes     2-42

database     2-39

identifier     2-44

Commit tag     1-25

commit target configuration example     15-136

common_datatypes.xsd     14-126

common datatype definitions     14-126

Common Object Request Broker Architecture

See CORBA     1-19

component-specific schemas     14-125, 14-126

Comprehensive Perl Archive Network

See CPAN     15-131

config_clear function example     15-137

config_cli() function example     15-138

config_commit () function     15-136

config_get_history() function example     15-137

config_get_sessions function example     15-137

config_load_failed function example     15-137

config_rollback() function example     15-137

config_save() function example     15-137

config_services_operations.xsd     14-126

Configuration change event     15-158

configuration change notification     3-55

Configuration function     15-154

configuration history     2-30

Configuration Manager     1-21, 1-25, 8-96

and error reporting     11-113

Configuration services     1-21, 1-25, 8-96

configuration session information     2-30

connection_timeout argument     15-133

container     5-69, 5-71

Content attribute     5-69, 5-80

CORBA (Common Object Request Broker Architecture)

event notification channel     3-55

support, type of     1-19

Count argument     15-143

Count attribute     5-69, 5-82

Craft Works Interface     1-20

CurrentConfig     2-32

custom filters     5-69

CWI (Craft Works Interface)

See Craft Works Interface     1-20

D

data, display how to

example     15-145

get_data function     15-145

data objects

create     15-139

operation methods     15-141

schema version     15-141

data operation methods, management session     15-146

debug facility

definition, types of     15-149

disable     15-149

enable     15-149

insert message     15-149

overview     15-148

debug option     15-133

declaration

attributes     1-23

tag     1-22, 1-23

default option     12-117

delete_data method

definition     15-144

example     15-144

Delete tag     1-25

deny_access.pl file     15-157

dependencies     4-61

deregistering, alarms     10-106

display_neighbor_group_members.pl file     15-153

documentation, perl data object

definition items     15-139

overview     15-139

Document Type Definition     14-125

DOM (Data Object Model)

example     15-135

tree type     15-135

DTD (Document Type Definition)

See document type definition     14-125

E

element, null value     4-62

encoding (UTF-8), XML     1-23

error attributes     11-110, 11-111

ErrorCode     11-110

ErrorMsg     11-110

error object, methods

get_code     15-136

get_dom_node     15-136

get_element     15-136

get_message     15-136

to_string     15-136

error reporting

nonexistent data     4-66

types of     11-109

event notification     3-55

extensible markup language

See XML     ix

F

files, perl scripting toolkit

add_neighbors_to_group.pl     15-153

bgp_neighbor_table_html.pl     15-164

Cisco-IOS_XR-Perl-Scripting-Toolkit-.tar.gz     15-131

deny_access.pl     15-157

display_neighbor_group_members.pl     15-153

generic_interface_props_table.pl     15-162

get_ip_interfaces.pm     15-160

interface_props_table.pl     15-163

interface_props_table.xsl     15-163

ios_xr_log.txt     15-150

list_isis_neighbors.pm     15-161

notification.pl     15-158

show_bgp_neighbors.pl     15-162

show_ip_interfaces.pl     15-161

xml_to_html_table.pm     15-162

xml_to_html_table.xsl     15-162

filter, criteria types     10-105

Filter argument     15-143

find_data function     15-156

find_data method

definition     15-142

example     15-142

G

generic_interface_props_table.pl file     15-162

get_code method     15-136

get_commit_id() method example     15-136

get_data method

definition     15-142

example     15-142

get_dom_node method     15-136

get_dom_tree method     15-156

get_element method     15-136

get_entries function     15-159, 15-161

get_entries method

definition     15-143

example     15-143

get_error method example     15-135

get_errors method example     15-135

get_ip_interfaces() function     15-160, 15-161

get_ip_interfaces.pm file     15-160

get_keys function     15-161

get_keys method

definition     15-142

example     15-142

get_message method     15-136

GetConfigurationHistory tag     1-25

GetConfigurationSessions tag     1-25

GetNext tag operation     1-25, 1-26

Get tag     1-25

GetVersionInfo tag     1-25

H

hash structure

definition     15-138

example     15-138

host argument     15-133

HostnameTable object     15-161

HTML table

customize, interface state display     15-163

enhancement list     15-163

I

installation, perl scripting toolkit

directory parameters     15-131

procedure     15-131

interactive argument     15-132

interface_props_table.pl file     15-163

interface_props_table.xsl file     15-163

interfaces, get list

examples     15-160

procedure     15-160

Interfaces going up/down event     15-158

InterfaceTable object     15-154

ios_xr_log.txt file     15-150

IP address, find interfaces     15-156

IPv4 address family example     15-154

ISIS (Intermediate System-to-Intermediate System)

circuit type, find     15-154

CLI commands     15-153

hostname and interface, list     15-161

instance ID     15-153

set up     15-153

IteratorID     7-89

K

keys, display how to

example     15-145

get_keys function     15-145

L

leaf object     5-72

link state database, retrieval

examples     15-159

procedure     15-159

list_isis_neighbors.pm file     15-161

load configuration file example     15-137

Load tag     1-25

lock     2-29, 2-30

lock and unlock configuration example     15-136

Lock tag     1-25

log_file option     15-133

logging facility

arguments, types of     15-150

disable     15-150

enable     15-149

overview     15-149

logging option     15-133

M

make command     15-131

make install command     15-131

management session

close

close()method     15-134

script     15-134

data operation methods     15-146

start

arguments     15-132

create, object type     15-132

Match attribute     5-76

MergedConfig     2-32

modules, perl scripting toolkit     15-130

mpls-te task name     8-97

N

namespace     4-58

native_data_common.xsd     14-126

native_data_operations.xsd     14-126

native data

access techniques     5-69

model, types of     1-21

operations     4-57

request, nonexistent data     4-66

tags     1-25

native management data model     1-25

NET (Network Entity Title) example     15-153

nonexistent data     4-66

notification.pl file     15-158

notifications

alarms     10-107

list of events     15-158

steps for script     15-158

null value     4-62

O

object class, hierarchy

combine     5-69, 5-73

compressed     5-75

content     4-57

duplicated     5-74

nonexistent data     4-66

operational     5-72

operation information, retrieval

examples     15-159

procedure     15-159

operation processing errors     11-109, 11-113

OperationType attribute     2-33

operation type tag

CLI     1-26

configuration services     1-25

definition     1-25

native data     1-25

structure, top-level     1-22

options, command-line

debug     15-133

log_file     15-133

logging     15-133

telnet_dump_log     15-133

telnet_input_log     15-133

OSPF (Open Shortest Path First)

CLI commands     15-155

configuration     15-155

router ID     15-155

ouni task name     8-97

P

password argument     15-133

perl scripting toolkit, concepts

perl data object API     15-130

perl notification/alarm API     15-130

perl XML API     15-130

port argument     15-133

privileges, security     8-95

prompt argument     15-133

R

read privileges     8-95

registering, alarms     10-105

repeat naming information     5-69, 5-78

request

<Get>

ChangedConfig     2-33

batching     1-26

definition     1-20

maximum size     1-24

minor and major version numbers     1-24

repeated naming information     5-78

tag     1-22

top level structure of     1-22

Request Type tag     4-58

response

block size     7-89

definition     1-20

error reporting     11-109

large data retrieval (using iterators)     7-89

major and minor version numbers     1-24

minimum     1-24

namespace declaration in     4-62

nonexistent data     4-66

tag     2-38

response_timeout argument     15-133

rollback     2-30

RollbackOnly attribute     2-48

Rollback tag     1-25

router administration, operational data     4-58

running configuration

browse     2-31

browsing     2-30

locking     2-30

replacing     2-30, 2-50

target configuration commit     2-37

unlocking     2-30, 2-41

S

Save tag     1-25

schema file organization     14-126

schemas, XML     14-125

set_data method

definition     15-143

example     15-143

Set tag     1-25

show_bgp_neighbors.pl file     15-162

show_ip_interfaces.pl file     15-161

show aaa userdb CLI command     15-155

show bgp neighbors CLI command     15-163

show ip interfaces CLI command     15-160, 15-161

show isis database level CLI command     15-159

show isis neighbors CLI command     15-161

Source attribute     2-31

SSH

definition     1-20

option     12-122

ssh_version argument     15-133

system logging message (syslog)     3-55

T

tag

configuration services operation, types of     1-25

XML     1-22

XML <Response>     1-24

XML API     1-19

XML mapping, types of     13-123

target configuration

browsing     2-30

commit     2-29, 2-30, 2-50

syslog     3-55

commit record     2-39

loading     2-30

modified, uncommitted     2-33

saving to file     2-30, 2-37

TaskGrouping attribute     8-97

task names

mpls-te     8-97

ouni     8-97

telnet_dump_log

argument     15-150

option     15-133

telnet_input_log

argument     15-150

option     15-133

Telnet option     12-122

to_string method

description     15-136

example     15-135

XML response     15-156

transport argument     15-133

transport debug type     15-149

transport errors     11-109, 11-110

triggering a <Get> operation     4-62

TTY transport

enable agent, how to     12-121

enable session, how to     12-122

error code     12-122

exit, how to     12-122

options

SSH     12-122

Telnet     12-122

U

Unlock tag     1-25

upgrades, schema file     14-127

use_command_line argument     15-132

user debug type     15-149

username argument     15-133

usernames, get list     15-155

V

version, XML     1-23

W

wildcards     5-69

World Wide Web Consortium (W3C) XML Schema Language     14-125

write_file method example     15-135

write privileges     8-95

X

XLST

procedure     15-162

tabular XML data, display     15-162

XML (extensible markup language)

agent     1-20, 1-21

client     1-20

instance     4-62

operation     1-20

operation provider     1-20

parse errors     11-109, 11-110

schema     1-20

definitions for the native data operation type tags     1-25

errors     11-109, 11-111

session     1-24

xml_api_common.xsd     14-126

xml_api_protocol.xsd     14-126

xml_response_parts debug type     15-149

xml_to_html_table.pm file     15-162

xml_to_html_table.xsl file     15-162

xml agent tty CLI command     12-121

xml debug type     15-149

XML mapping tags     13-123

XML request

receiving     12-122

sending     12-122

XML schemas     14-125