AXP 1.6 Developer Guide
AXP API Files

Table Of Contents

AXP API Files

Library Paths

IOS CLI API Files

AXP CLI API Files

SysInfo API Files

SysOp API Files

Event API Files


AXP API Files


Files and libraries for the AXP APIs are listed in the following sections:

Library Paths

IOS CLI API Files

AXP CLI API Files

SysInfo API Files

SysOp API Files

Event API Files

Library Paths

File paths for Java, C/C++, Python, and Perl:

Java

Path in the virtual instance: /usr/lib/java

C/C++

Path in the virtual instance: /lib

Perl

The following path libraries are for perl5

Path in the SDK: perl.

Path in the virtual instance:

/usr/lib/perl5/5.8.8/serviceapi

Python

The following path libraries are for version 2.5

Path in SDK: Python 2.5

Path in the virtual instance:

/usr/lib/python2.5/serviceapi/

IOS CLI API Files

The following table shows the files in the SDK package that are used by the Cisco IOS CLI API. For further information on the IOS CLI API, refer to the "IOS CLI API" section on page 43.

Table 5 IOS CLI API Files 

Language
Files/Packages
Description

Java

/jar/iosapi.jar

Java Jar file containing IOS API methods.

C/C++

/include/iosapi.h

Header file for IOS API.

/lib/iosapi.so

C IOS API library procedures.

Python

/python2.3/IosapiFactory.py

IOS API Factory Interface.

/python2.3/Iosapi.py

Python IOS API procedures.

Perl

/perl/iosapi.pm

Perl IOS API procedures.


AXP CLI API Files

The following table shows the files in the SDK package that are used by the Cisco AXP CLI API. For further information on the AXP CLI API, refer to the "AXP CLI API" section on page 53.

Table 6 AXP CLI API Files 

Language
Files/Packages
Description

Java

/jar/appreapi.jar

Jar file containing AXP CLI API methods.

C/C++

/include/appreapi.h

C Header file for AXP CLI API.

/lib/lib/appreapi.so

C library procedures for AXP CLI API.

Python

/python2.3/AppreAPI.py

Python library procedures for AXP CLI API.

Perl

/perl/AppreAPI.pm

Perl library procedures for AXP CLI API.


SysInfo API Files

The following table shows the files in the SDK package that are used by the SysInfo API. For further information on the SysInfo API, refer to the "AXP SysInfo API" section on page 91.

Table 7 SysInfo API Files 

Language
Files/Packages
Description

Java

axpsystemapi.jar

 

localsocket.jar

AXP local socket IPC library.

 

xercesImpl.jar

Apache open source library for XML parsing.

C/C++

libaxpsystemapi.so

AXP custom library containing methods used to invoke other sysInfo related methods.

 

liblocal_socket.so

AXP local socket IPC library.

 

libxerces-c.so

Apache open source C library for XML parsing.

Python

AxpSystemAPI.py

SysInfoRequest.py

SysInfoResponse.py

ErrorInfo.py

ParamList.py

ParamListList.py

ConnectionHandler.py

Perl

AxpSystemAPI.pm

ApiConnector.pm

SysInfoRequest.pm

SysInfoResponse.pm

Error.pm

ParamList.pm

ParamListList.pm


SysOp API Files

Table 8 shows the files in the SDK package that are used by the SysOp API.

For further information on the SysOp API, refer to the "AXP SysOp API" section on page 111.

Table 8 SysOP API Files 

Language
Files/Packages
Description

Java

axpsystemapi.jar

 

localsocket.jar

AXP local socket IPC library.

 

xercesImpl.jar

Apache open source library for XML parsing.

C/C++

libaxpsystemapi.so

AXP custom library containing methods used to invoke other sysOp related methods.

 

liblocal_socket.so

AXP local socket IPC library.

 

libxerces-c.so

Apache open source C library for XML parsing.

Python

AxpSystemAPI.py

SysOpRequest.py

SysOpResponse.py

ErrorInfo.py

ParamList.py

ParamListList.py

ConnectionHandler.py

AXP custom library containing methods used to invoke other sysOp related methods.

Perl

AxpSystemAPI.pm

ApiConnector.pm

Error.pm

SysOpRequest.pm

SysOpResponse.pm

ParamList.pm

ParamListList.pm

AXP custom library containing methods used to invoke other sysOp related methods.


Event API Files

Table 9 shows the files in the SDK package that are used by the Event API.

Table 9 Event API Files 

     

Java

eventapi.jar

 

localsocket.jar

AXP local socket IPC library.

 

xercesImpl.jar

Apache open source Java library for XML parsing.

C/C++

libeventapi.so

 

libxerces-c.so

Xerces library.

 

liblocal_socket.so

Local socket library.

Python

AxpEventAPI.py

NotifyRequest.py

PolicyInfo.py

NotifyResponse.py

ConfigChange.py

Notification.py

ErrorInfo.py

ParamList.py

 

Perl

AxpEventAPI.pm

NotifyRequest.pm

PolicyInfo.pm

NotifyResponse.pm

ConfigChange.pm

Notification.pm

ErrorInfo.pm

ParamList.pm