Cisco IOS XR XML API Guide, Cisco IOS XR Release 4.1
Index
Downloads: This chapterpdf (PDF - 633.0KB) The complete bookPDF (PDF - 7.34MB) | Feedback

Index

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

<AdminAction> 4-54

<AdminOperational> 4-54

<Alarm> 10-117

<Clear> 1-9

<ClearConfigurationInconsistency> 1-9

<ClearConfigurationSession> 1-9

<CLI> 1-9

<CLI> tag 2-45, 3-49, 6-91

<Client> 2-41

<ClientName> 2-43

<Comment> 2-41

<Commit> 1-9, 2-22

Comment attribute 2-23

Confirmed attribute 2-23

errors 2-25

IgnoreOtherSessions attribute 2-24

KeepFailedConfig attribute 2-23

Label attribute 2-23

Mode attribute 2-23

Replace attribute 2-24

Rollback 2-33

<Commit> operation 2-27

<CommitId> 2-41

<CommitId> tag 2-25, 2-33

<Configuration> 4-54

<Configuration⁄> tag 5-68

<Delete> 1-8, 2-25, 4-53

AAA privileges 8-102

native data operations 4-59

<Delete⁄> tag 4-65

<destination> 16-149

<Detail> 2-41

<EBGPMultihopMaxHopCount> 5-72

<Elapsed> 2-43

<Error> element 8-102

<FailedConfig> tag 2-27

<File> 2-19

<Filter> 5-85

<Get> 1-8, 2-15, 2-17, 3-49, 4-53

AAA privileges 8-102

native data operations 4-59

triggering 4-58

<GetConfigurationCommitList> 1-9

<GetConfigurationHistory> 1-9, 2-38

maximum attribute 2-38

<GetConfigurationSession> 1-9

<GetConfigurationSessions> 2-43

<GetDataSpaceInfo⁄> tag 4-66

<GetDataSpaceInformation> 1-8

<GetNext> 1-9

IteratorID 7-94

<GetVersionInfo⁄> tag 4-66

<GetVersionInformation> 1-8

<HoldTime> 4-58

<Label> 2-41

<Line> 2-41, 2-43

<Load> 1-9, 2-19, 2-27, 3-52

<Lock> 1-9, 2-15

<LockHeld> 2-43

<LoopbackCheck> 5-72

<Maximum> 2-41

<Naming> tag 4-58

<Node> 2-43

<Operational> 3-49, 4-54

<Previous> 2-34

<Process> 2-43

<ProcessID> 2-43

<Register> 10-117

<RemoteAS> 5-72

<Response>

IteratorID 7-94

<Rollback> 1-9, 2-25, 2-33, 2-34

<Save> 1-9, 2-19, 2-21

<SessionId> 2-43

<Set> 1-8, 2-25, 2-45, 4-53

AAA privileges 8-102

native data operations 4-59

<Since> 2-43

<Timestamp> 2-41

<Unlock> 1-9, 2-28

<Unlock⁄> 2-28

<User> 2-41

<UserId> 2-43

<version> 16-149

A

AAA (authentication, authorization, and accounting)

authorization 8-101

definition 1-2

security (perl scripting toolkit) 16-148

access control list

See ACL 8-105

ACL 8-105

ACL (Access Control List)

CLI commands 16-176

entry, add 16-176

inbound traffic 16-176

list 16-176

perl data object API 16-176

add_neighbors_to_group.pl file 16-173

alarm_deregister function 16-167

alarm_operations.xsd 14-136

alarm_receive function 16-167

alarm_register function 16-166

alarms

deregistration 10-118

filter criteria, types of 10-117

notification 10-119

registration 10-117

tags, types of 10-119

API (application programming interface)

perl data object 16-148

perl notification/alarm 16-148

perl XML

concept 16-148

configuration examples 16-171

operational examples 16-177

arguments, management session

connection_timeout 16-151

host 16-151

interactive 16-150

password 16-151

port 16-151

prompt 16-151

response_timeout 16-151

ssh_version 16-151

transport 16-151

use_command_line 16-150

username 16-151

Atomic mode 2-23

B

BASE package common schemas 14-136

batch_send method 16-165

batch_start method 16-164

batch API

batch_send method 16-165

batch_start method 16-164

usage 16-164

batched requests 1-10

BestEffort 2-23

BGP (Border Gateway Protocol)

CLI commands 16-172

configuration 17-185

data object interface 16-172

get request 3-49

neighbor

add list 16-172

members, display 16-173

set description 16-172

bgp_neighbor_table_html.pl file 16-183

Border Gateway Protocol

See BGP 3-49

browse, target configuration 2-15

C

cerrno 11-126

ChangedConfig 2-16

chmod command 16-170

CircuitType object 16-174

Cisco-IOS_XR-Perl-Scripting-Toolkit-.tar.gz file 16-149

ClearConfigurationInconsistency tag 1-9

ClearConfigurationSession tag 1-9

Clear tag 1-9

CLI (command-line interface)

defined 1-2

operations 1-9

cli_operations.xsd 14-136

CLI command

encapsulated 1-3, 1-9

show 4-54

show aaa userdb 16-175

show bgp neighbors 16-182

show interfaces 16-179, 16-180

show isis database level 16-178

show isis neighbors 16-180

xml agent tty 13-129

ClientID attribute 1-5

client session

commit operation 2-25

limitation 2-13

CLI tag 1-9

Comment 2-23

comment 2-33

commit 2-29

changes 2-29

database 2-25

identifier 2-33

CommitChanges 2-16

Commit tag 1-9

common_datatypes.xsd 14-136

common datatype definitions 14-136

component-specific schemas 14-135, 14-136

Comprehensive Perl Archive Network

See CPAN 16-149

config_clear_sessions function example 16-156

config_clear function example 16-155

config_cli() function example 16-156

config_commit () function 16-154

config_commit function example 16-154

config_get_commitlist function example 16-155

config_get_history function example 16-155

config_get_sessions function example 16-156

config_load_commit_changes function example 16-156

config_load_failed function example 16-155

config_load_rollback_changes function example 16-156

config_load function example 16-155

config_lock function example 16-155

config_rollback() function example 16-156

config_save() function example 16-155

config_services_operations.xsd 14-136

config_unlock function example 16-155

Configuration change event 16-183

configuration change notification 3-52

Configuration function 16-174

configuration history 2-14

Configuration Manager 1-3, 1-9, 8-102

and error reporting 11-125

Configuration services 1-3, 1-9, 8-102

configuration session information 2-14

Confirmed 2-23

connection_timeout argument 16-151

container 5-67, 5-69

Content attribute 5-67, 5-82

Count argument 16-163

Count attribute 5-67, 5-83

CurrentConfig 2-16

custom filters 5-67

D

data, display how to

example 16-165

get_data function 16-165

data objects

create 16-159

operation methods 16-161

schema version 16-161

data operation methods, management session 16-166

debug facility

definition, types of 16-168

disable 16-169

enable 16-169

insert message 16-169

overview 16-168

debug option 16-152

declaration

attributes 1-5

tag 1-4, 1-5

delete_data method

definition 16-164

example 16-164

Delete tag 1-8

deny_access.pl file 16-177

dependencies 4-58

deregistering, alarms 10-118

Details 2-38

display_neighbor_group_members.pl file 16-173

documentation, perl data object

definition items 16-158

overview 16-158

Document Type Definition 14-135

DOM (Data Object Model)

example 16-153

tree type 16-153

DTD (Document Type Definition)

See document type definition 14-135

E

element, null value 4-58

enable the dedicated agent 13-131

encoding (UTF-8), XML 1-5

error attributes 11-122, 11-123

ErrorCode 11-122

ErrorMsg 11-122

error object, methods

get_code 16-154

get_dom_node 16-154

get_element 16-154

get_message 16-154

to_string 16-154

error reporting

nonexistent data 4-63

types of 11-121

event notification 3-51

Event Type 2-38

EventType 2-38

F

files, perl scripting toolkit

add_neighbors_to_group.pl 16-173

bgp_neighbor_table_html.pl 16-183

Cisco-IOS_XR-Perl-Scripting-Toolkit-.tar.gz 16-149

deny_access.pl 16-177

display_neighbor_group_members.pl 16-173

generic_interface_props_table.pl 16-181

get_ip_interfaces.pm 16-179

interface_props_table.pl 16-182

interface_props_table.xsl 16-182

ios_xr_log.txt 16-169

list_isis_neighbors.pm 16-180

notification.pl 16-184

show_bgp_neighbors.pl 16-181

show_ip_interfaces.pl 16-180

xml_to_html_table.pm 16-181

xml_to_html_table.xsl 16-181

filter, criteria types 10-117

Filter argument 16-163

find_data function 16-175

find_data method

definition 16-162

example 16-162

G

generic_interface_props_table.pl file 16-181

get_code method 16-154

get_commit_id() method example 16-155

get_data method

definition 16-161

example 16-161

get_dom_node method 16-154

get_dom_tree method 16-176

get_element method 16-154

get_entries function 16-178, 16-180

get_entries method

definition 16-163

example 16-163

get_error method example 16-153

get_errors method example 16-153

get_ip_interfaces() function 16-179, 16-180

get_ip_interfaces.pm file 16-179

get_keys function 16-180

get_keys method

definition 16-162

example 16-162

get_message method 16-154

GetConfigurationCommitList tag 1-9

GetConfigurationHistory tag 1-9

GetConfigurationSessions tag 1-9

GetDataSpaceInfo tag 1-8

GetNext tag operation 1-8, 1-9

Get tag 1-8

GetVersionInfo tag 1-8

H

hash structure

definition 16-157

example 16-157

hierarchy

leaf nodes 4-57

structure 4-55

tables 4-55

host argument 16-151

HostnameTable object 16-180

HTML table

customize, interface state display 16-182

enhancement list 16-182

I

IgnoreOtherSessions 2-24

installation, perl scripting toolkit

directory parameters 16-149

procedure 16-149

interactive argument 16-150

interface_props_table.pl file 16-182

interface_props_table.xsl file 16-182

interfaces, get list

examples 16-179

procedure 16-179

Interfaces going up/down event 16-183

InterfaceTable object 16-174

ios_xr_log.txt file 16-169

IP address, find interfaces 16-175

IPv4 address family example 16-173

ISIS (Intermediate System-to-Intermediate System)

circuit type, find 16-173

CLI commands 16-173

hostname and interface, list 16-180

instance ID 16-173

set up 16-173

ItemNotFound 1-6

ItemNotFoundBelow 1-6

IteratorID 7-94

K

KeepFailedConfig 2-23

keys, display how to

example 16-165

get_keys function 16-165

L

Label 2-23

label 2-33

leaf nodes 4-57

leaf object 5-71

link state database, retrieval

examples 16-178

procedure 16-178

list_isis_neighbors.pm file 16-180

Load tag 1-9

lock 2-13, 2-14

Lock tag 1-9

log_file option 16-152

logging facility

arguments, types of 16-170

disable 16-169

enable 16-169

overview 16-169

logging option 16-152

M

make command 16-149

make install command 16-149

Management Plane Protection

See MPP 8-104

management session

close

close()method 16-152

script 16-152

data operation methods 16-166

start

arguments 16-150

create, object type 16-150

Match attribute 5-75

Maximum 2-38

MergedConfig 2-16

Mode 2-23

modules, perl scripting toolkit 16-148

mpls-te task name 8-103

MPP 8-104

inband traffic 8-104

out-of-band traffic 8-104

N

namespace 4-54

native_data_common.xsd 14-136

native_data_operations.xsd 14-136

native data

access techniques 5-67

model, types of 1-3

operations 4-53

request, nonexistent data 4-63

tags 1-8

native management data model 1-8

NET (Network Entity Title) example 16-173

nonexistent data 4-63

NotFound 1-6

notification.pl file 16-184

notifications

alarms 10-119

list of events 16-183

steps for script 16-183

null value 4-58

O

object class, hierarchy

combine 5-67, 5-72

compressed 5-74

content 4-53

duplicated 5-72

nonexistent data 4-63

operational 5-71

operation information, retrieval

examples 16-178

procedure 16-178

operation processing errors 11-121, 11-125

OperationType attribute 2-17

operation type tag

CLI 1-9

configuration services 1-9

definition 1-8

native data 1-8

structure, top-level 1-4

options, command-line

debug 16-152

log_file 16-152

logging 16-152

telnet_dump_log 16-152

telnet_input_log 16-152

OSPF (Open Shortest Path First)

CLI commands 16-175

configuration 16-175

router ID 16-175

ouni task name 8-103

P

password argument 16-151

perl scripting toolkit, concepts

perl data object API 16-148

perl notification/alarm API 16-148

perl XML API 16-148

port argument 16-151

privileges, security 8-101

prompt argument 16-151

R

read privileges 8-102

registering, alarms 10-117

repeat naming information 5-67, 5-79

Replace 2-24

request

<Get>

ChangedConfig 2-17

batching 1-10

definition 1-2

maximum size 1-6

minor and major version numbers 1-5

repeated naming information 5-79

tag 1-4

top level structure of 1-4

Request Type tag 4-54

response

block size 7-93

definition 1-2

error reporting 11-121

large data retrieval (using iterators) 7-93

major and minor version numbers 1-5

minimum 1-6

namespace declaration in 4-58

nonexistent data 4-63

tag 2-24

response_timeout argument 16-151

Reverse 2-38

rollback 2-14

RollbackChanges 2-16

Rollback tag 1-9

router administration, operational data 4-54

RP 8-105, 13-129

running configuration

browse 2-15

browsing 2-14

locking 2-14

replacing 2-14, 2-45

target configuration commit 2-22

unlocking 2-14, 2-28

S

Save tag 1-9

schema file organization 14-136

schemas, XML 14-135

set_data method

definition 16-163

example 16-163

Set tag 1-8

show_bgp_neighbors.pl file 16-181

show_ip_interfaces.pl file 16-180

show aaa userdb CLI command 16-175

show bgp neighbors CLI command 16-182

show interfaces CLI command 16-179, 16-180

show isis database level CLI command 16-178

show isis neighbors CLI command 16-180

Source attribute 2-15

SSH

definition 1-2

option 13-129

ssh_version argument 16-151

streaming 7-99

system logging message (syslog) 3-51

T

tag

configuration services operation, types of 1-9

XML 1-3

XML <Response> 1-5

XML API 1-1

XML mapping, types of 12-127

target configuration

browsing 2-14

commit 2-13, 2-14, 2-45

syslog 3-51

commit record 2-25

loading 2-14

modified, uncommitted 2-17

saving to file 2-14, 2-22

TaskGrouping attribute 8-103

task names

mpls-te 8-103

ouni 8-103

telnet_dump_log

argument 16-170

option 16-152

telnet_input_log

argument 16-170

option 16-152

Telnet option 13-129

throttle

cpu 7-99

memory 7-99

timestamp 2-29

to_string method

description 16-154

example 16-153

XML response 16-176

transport argument 16-151

transport debug type 16-168

transport errors 11-121, 11-122

triggering a <Get> operation 4-58

TTY transport

enable agent, how to 13-129

enable session, how to 13-129

error code 13-130

exit, how to 13-130

options

SSH 13-129

Telnet 13-129

U

Unlock tag 1-9

upgrades, schema file 14-137

use_command_line argument 16-150

useid 2-29

user debug type 16-168

username argument 16-151

usernames, get list 16-175

V

version

major and minor 9-107

mismatch 9-111

placement in xml 9-109

retrieving 9-113

retrieving schema 9-115

run-time usage 9-108

VersionMismatchExists 9-110

version, XML 1-5

VersionMismatchExists 9-111

VersionMismatchExistsBelow 9-111

virtual route forwarding

See VRF 8-105

VRF 8-105

W

wildcards 5-67

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

write_file method example 16-153

write privileges 8-102

X

XLST

procedure 16-181

tabular XML data, display 16-181

XML (extensible markup language)

agent 1-2, 1-3

client 1-2

instance 4-58

operation 1-2

operation provider 1-2

parse errors 11-121, 11-122

schema 1-2

definitions for the native data operation type tags 1-8

errors 11-121, 11-123

session 1-5

xml_api_common.xsd 14-136

xml_api_protocol.xsd 14-136

xml_response_parts debug type 16-168

xml_to_html_table.pm file 16-181

xml_to_html_table.xsl file 16-181

xml agent tty CLI command 13-129

xml debug type 16-168

XML mapping tags 12-127

XML request

receiving 13-130

sending 13-130

XML schemas 14-135