-
Administration of Cisco Prime LAN Management Solution 4.1
-
Preface
-
Open Source License Acknowledgements
-
Chapter 1: Overview of Administration
-
Chapter 2: Setting up Security
-
Chapter 3: Administering LMS Server
-
Chapter 4: Administering Discovery Settings and Device and Credential Repository
-
Chapter 5: Managing Groups
-
Chapter 6: Administering Data Collection
-
Chapter 7: User Tracking and Dynamic Updates
-
Chapter 8: Administering Collection Settings
-
Chapter 9: Monitoring and Troubleshooting Settings
-
Chapter 10: Notification and Action Settings
-
Chapter 11: Administering Change Audit and Software Management
-
Chapter 12: Managing Jobs
-
Chapter 13: Working With Software Center
-
Chapter 14: Discrepancies and Best Practices Deviations
-
Chapter 15: Report Setting
-
Chapter 16: Purge Settings
-
Chapter 17: Debugging Options
-
Chapter 18: Understanding LMS Tasks
-
Appendix A: CLI Tools
-
Appendix B: Troubleshooting and FAQs
-
Appendix C: Data Extraction Engine
-
Appendix D: Understanding Cisco Prime Security
-
Appendix E:Commands to Enable Mac Notification Traps
-
Appendix F: Recommended Best Practices
-
Index
-
Feedback
Table Of Contents
Overview of Data Extraction Engine
cmexport Arguments and Options
User Tracking Schema for Switch Data
User Tracking Schema for Phone Data
User Tracking Schema for Subnet Data
Using Servlet to Export Data from LMS
Data Extraction Engine
Cisco Prime Data Extraction Engine (DEE) is a utility to export User Tracking, Topology, and Discrepancy application data.
This utility provides servlet and command line access to User Tracking, Topology and Discrepancy) and allows you to extract data in Extensible Markup Language (XML) format.
This chapter contains:
•
Overview of Data Extraction Engine
Overview of Data Extraction Engine
Data Extraction Engine (DEE) is a utility that provides servlet access to User Tracking, Layer 2 topology, and discrepancy data.
It also includes a command line utility that you can use to fetch user tracking data, Layer 2 topology, and discrepancy data for devices discovered by LMS server.
This utility supports the following features:
•
Allows you to access servlet and command line utilities that can generate user tracking data for devices discovered by LMS Server.
•
Allows you to generate the latest Layer 2 topology data including information on neighbor devices. Elements in XML file are created at the device level.
•
Allows you to use discrepancy APIs to retrieve latest discrepancy data from LMS server.
•
Data generated through CLI is archived at the following locations:
where PX_DATADIR is either %NMSROOT%/files folder (on Windows) or /var/adm/CSCOpx/files directory (on Solaris/Soft Appliance).
NMSROOT is the directory where you installed LMS; timestamp is the time at which the log was written in YearMonthDateHourOfDayMinuteSecond format.
You can also specify a directory to store the output. This utility does not delete the files created in the archive. You should delete these files when necessary. While generating data through the servlet, the output appears at the client terminal.
•
Allows you to generate and download the user tracking, topology and discrepancy XML files using the servlet.
You must upload a payload XML file, which contains the cmexport and utexport command options and Cisco Prime user credentials.
You should write your own script to invoke the servlet with a payload of this XML file. If the credentials are correct and options are valid, the servlet returns the exported file in XML format.
The cmexport Command
cmexport is the Cisco Prime LMS command line interface for exporting discrepancy and Layer 2 topology data details into XML format.
This section contains the following topics:
•
Running cmexport Command
This section contains:
Command Line Syntax
The command line syntax of the utility is in the following format:
cmexport command arguments optionswhere:
•
•
•
•
The order of the arguments and options are not important. However, you must enter the core command immediately after cmexport.
Commands
Table C-2 lists the command part of the cmexport syntax.
You must invoke the cmexport command with one of the core commands specified in the above table. If you do not specify any core commands, cmexport can only execute the -v or -h options:
•
•
cmexport Arguments and Options
This section contains:
Mandatory Arguments
The arguments that must be specified with all functions are:
•
•
–
You must maintain this file and control access permissions to prevent unauthorized access. cmexport looks for current working directory if CMEXPORTFILE is set only to the file name instead of to the full path.
–
You must enter the password in the file in the following format:
userid password
where userid is the Cisco Prime user name given in the command line. The delimiter between the userid and password is a single blank space.
You must provide the delimiter if the password is blank. Otherwise, cmexport will not validate the password.
The password file can contain multiple entries with different user names. If there are duplicate entries the password that matches the first user name is considered.
Note
Optional Arguments
The arguments you can specify with any function are:
•
Sets the debug level based on which debug information is printed. There are two levels of debugging—TRACE and DEBUG. If you do not specify the -d option, logging will not occur.
•
Logs the results of the cmexport command to the specified log file name. By default the command output is displayed in the standard output.
Function-Specific Options
DEE supports the following function-specific option:
-f filename
If used with:
•
Specifies the name of the file to which the user tracking information is to be exported.
•
Specifies the name of the file to which the layer 2 topology information is to be exported.
•
Specifies the name of the file to which the discrepancy information is to be exported.
Displaying Help
To display help for cm export Enter the following at a CLI prompt: cmexport -h.
This displays a list of options for cmexport.
On Solaris, you can also enter the following at a CLI prompt:
man cmexportUses of cmexport
If you enter:
cmexport ut {-u userid} -p password -host -f filename.xml
User Tracking XML output for host will be generated and it is stored in the file filename.xml.
If you want to export the latest topology details for all Layer 2 devices enter:
cmexport L2Topology {-u userid} -p password -f filename.xml
If you want to export the latest discrepancy details, enter:
cmexport Discrepancy {-u userid} -p password -f filename.xml
Notations
The notations followed in describing the command line arguments are explained below:
{argument}—Argument is a mandatory parameter.
[argument]—Argument is an optional parameter.
argument—Argument is a variable.
argument 1 | argument 2—Either argument 1 or argument 2 may be specified but not both.
Table C-3 lists the notations part of the cmexport syntax.
-v—Displays the version of the cmexport utility.
-h—Lists the options available and function of each option.
cmexport User Tracking
This topic describes the cmexport User Tracking command, and the various options available to you. It contains the following sections:
•
Name
cmexport ut: CiscoWorks cmexport user tracking function
Synopsis
cmexport ut: {-u userid} [ -p password ] -host [ host-options ] | -phone [ phone-options ] [ options ]
Table C-4 lists the command part of the cmexport syntax.
Description
User Tracking (specified by ut) exports the user tracking data into an XML file based on a predefined schema.
Mandatory Arguments
The options that must be specified with the cmexport ut function are:
•
•
If you want to avoid -p option, which will reveal the password in clear text in CLI, you must store your userid and password in a file and set a variable CMEXPORTFILE which points to this file.
You must maintain this file and control access permissions to prevent unauthorized access. cmexport looks for current working directory if CMEXPORTFILE is set only to the file name instead of to the full path.
If you use the -p option, even after setting the CMEXPORTFILE variable, the password is taken from the command line instead of from CMEXPORTFILE. This is not secure and we recommend that you do not use this option.
The password must be provided in the file in the following format:
userid password
where userid is the Cisco Prime user name given in the command line. The delimiter between the userid and password is a single blank space.
You must provide the delimiter if the password is blank. Otherwise, cmexport will not validate the password. The password file can contain multiple entries with different user names. The password that matches the first user name is considered in case of duplicate entries.
Note
•
•
Options
The options you can specify with the ut function are:
•
Sets the debug level based on which debug information is printed. There are two levels of debugging—TRACE and DEBUG. If you do not specify the -d option, no logging will occur.
•
Logs the results of the cmexport command to the specified logfile name. By default the command output will be displayed in the standard output.
•
The file option specifies the filename where the XML output is to be stored. If the filename is not specified with -f option, an XML file of the format timestamput.xml is stored in the following directory: PX_DATADIR/cmexport/ut
•
Specifies the format in which the user tracking XML data is to be presented. It supports two optional arguments:
a.
b.
The -view options are not case sensitive.
•
User Tracking host data is exported in XML format for the query provided in queryname. This option must be used with the -host argument. For this option:
–
Reports > Report Designer > User Tracking > Custom Reports.
–
•
User Tracking host data is exported in XML format for the layout provided in layoutname. This option must be used with the -host argument. For this option:
–
Reports > Report Designer > User Tracking > Custom Layouts.
–
Note
•
User Tracking phone data is exported in XML format for the query given in queryname. This option must be used with the -phone argument. For this option:
–
Reports > Report Designer > User Tracking > Custom Reports.
–
•
User Tracking phone data is exported in XML format for the layout given in layoutPhone. This option must be used with the -phone argument. For this option:
–
Reports > Report Designer > User Tracking > Custom Layouts.
–
Accessing Help
Enter the following in the CLI:
•
•
On Solaris, you can also enter the following in the CLI:
man cmexportExamples
Considering userid: admin, password: admin, queryname: host1Query, layoutname: host1Layout, queryphone: phone1Query, layoutphone: phone1Layout, filename: file1.xml, we can have the following:
cmexport ut -u admin -p admin -hostcmexport ut -u admin -p admin -phonecmexport ut -u admin -p admin -host -query host1Query -layout allcmexport ut -u admin -p admin -host -query host1Query -layout layoutnamecmexport ut -u admin -p admin -phone -queryPhone phone1Query -layoutPhone phone1Layoutcmexport ut -u admin -p admin -host -f file1.xmlcmexport ut -u admin -view switch -hostcmexport Topology Command
This section contains:
•
Name
cmexport L2Topology: CiscoWorks cmexport layer 2 topology function
Synopsis
cmexport l2topology {-u userid} [ -p password ] [ options ]
Table C-5 Command Description
options
-f filename
-d debuglevel
-l logfile
where cmexport l2topology -h lists the options available and function of each option.
Description
Layer 2 Topology (specified by l2topology) exports the Layer 2 topology data into an XML file based on a predefined schema.
Mandatory Arguments
The options that you must specify with the cmexport L2Topology function are:
The options that you must specify with the cmexport L2Topology function are:
•
•
Specifies the password for Cisco Prime user ID.
If you want to avoid -p option, which will reveal the password in clear text in CLI, you must store your userid and password in a file and set a variable CMEXPORTFILE which points to this file.
You must maintain this file and control access permissions to prevent unauthorized access. cmexport looks for current working directory if CMEXPORTFILE is set only to the file name instead of to the full path.
If you use the -p option, even after setting the CMEXPORTFILE variable, the password is taken from the command line instead of from CMEXPORTFILE. This is not secure and we recommend that you do not use this option.
The password must be provided in the file in the following format:
userid password
where userid is the Cisco Prime user name given in the command line. The delimiter between the userid and password is a single blank space.
You must provide the delimiter if the password is blank. Otherwise, cmexport will not validate the password. The password file can contain multiple entries with different user names. The password that matches the first user name is considered in case of duplicate entries.
Note
Options
The options you can specify with the layer 2 topology function are:
•
Sets the debug level based on which debug information is printed. There are two levels of debugging—TRACE and DEBUG. If you do not specify the -d option, no logging will occur.
•
Logs the results of the cmexport command to the specified logfile name. By default the command output will be displayed in the standard output.
•
The file option specifies the filename where the XML output is to be stored. If the filename is not specified with -f option an XML file of the format timestampL2Topology.xml is stored in the following directory: PX_DATADIR/cmexport/L2Topology
Accessing Help
Enter the following in the CLI:
cmexport -h: Displays a list of options for cmexport.
cmexport l2topology -h: Displays a list of options for the cmexport l2topology command.
On Solaris, you can also enter the following at a CLI:
man cmexport
Examples
Considering userid: admin, password: admin, filename: file1.xml, you can have the following:
cmexport L2Topology -u admin -p admincmexport L2Topology -u admin -p admin -f file1.xmlcmexport L2Topology -u admin -l file.logcmexport Discrepancy Command
This section contains:
•
Name
cmexport Discrepancy: CiscoWorks cmexport Discrepancy function.
Synopsis
cmexport discrepancy {-u userid} [ -p password ] [ options ]
where
Table C-6 Command Description
options
-f filename
-d debuglevel
-l logfile
cmexport discrepancy -help lists the options available and the function of each option.
Description
Discrepancy (specified by Discrepancy) exports the Discrepancy data into an XML file based on a predefined schema.
Mandatory Arguments
The options that you must specify with the cmexport Discrepancy function are:
•
•
Specifies the password for Cisco Prime userid.
If you want to avoid -p option, which will reveal the password in clear text in CLI, you must store your userid and password in a file and set a variable CMEXPORTFILE which points to this file.
You must maintain this file and control access permissions to prevent unauthorized access. cmexport looks for current working directory if CMEXPORTFILE is set only to the file name instead of to the full path.
If you use the -p option, even after setting the CMEXPORTFILE variable, the password is taken from the command line instead of from CMEXPORTFILE. This is not secure and we recommend that you do not use this option.
The password must be provided in the file in the following format:
userid password
where userid is the Cisco Prime user name given in the command line. The delimiter between the userid and password is a single blank space.
You must provide the delimiter if the password is blank. Otherwise, cmexport will not validate the password. The password file can contain multiple entries with different user names. The password that matches the first user name is considered in case of duplicate entries.
Note
Options
The options you can specify with the Discrepancy function are:
•
Sets the debug level based on which debug information is printed. There are two levels of debugging—TRACE and DEBUG. If you do not specify the -d option, no logging will occur.
•
Logs the results of the cmexport command to the specified log file name. By default the command output will be displayed in the standard output.
•
The file option specifies the filename where the XML output is to be stored. If the filename is not specified with -f option an XML file of the format timestampDiscrepancy.xml is stored in the following directory: PX_DATADIR/cmexport/Discrepancy
Accessing Help
Enter the following in the CLI:
cmexport -h: Displays a list of options for cmexport.
cmexport discrepancy -h: Displays a list of options for the cmexport discrepancy command.
On Solaris, you can also enter the following in the CLI:
man cmexportExamples
Considering userid: admin, password:admin, filename: file1.xml, you can have the following:
cmexport Discrepancy -u admin -p admincmexport Discrepancy -u admin -p admin -f file1.xmlcmexport Discrepancy -u admin -d 2cmexport Manpage
This sections contains:
Command Line Syntax
The command line syntax of the utility is in the following format:
cmexport command arguments options
where:
•
•
•
•
The order of the arguments and options is not important. However, you must enter the core command immediately after cmexport.
Commands
Table C-7 lists the command part of the cmexport syntax.
You must invoke the cmexport command with one of the core commands specified in the above table. If no core command is specified, cmexport can execute the -v or -h options only:
•
•
Arguments and Options
This sections contains:
Mandatory Arguments
The options that must be specified with all functions are:
-u userid: Specifies the Cisco Prime userid.
Optional Arguments
The options you can specify with any function are:
•
Specifies the password for Cisco Prime userid.
If you want to avoid -p option, which will reveal the password in clear text in CLI, you must store your userid and password in a file and set a variable CMEXPORTFILE which points to this file.
You must maintain this file and control access permissions to prevent unauthorized access. cmexport looks for current working directory if CMEXPORTFILE is set only to the file name instead of to the full path.
If you use the -p option, even after setting the CMEXPORTFILE variable, the password is taken from the command line instead of from CMEXPORTFILE. This is not secure and we recommend that you do not use this option.
The password must be provided in the file in the following format:
userid password
where userid is the Cisco Prime user name given in the command line. The delimiter between the userid and password is a single blank space.
You must provide the delimiter if the password is blank. Otherwise, cmexport will not validate the password. The password file can contain multiple entries with different user names. The password that matches the first user name is considered in case of duplicate entries.
Note
•
Sets the debug level based on which debug information is printed. There are two levels of debugging—TRACE and DEBUG. If you do not specify the -d option, no logging will occur.
•
Logs the results of the cmexport command to the specified log file name. By default the command output will be displayed in the standard output.
Function-Specific Options
The following function-specific option is supported
-f filename
If used with the:
•
•
•
Accessing Help
Enter the following in the CLI:
•
•
On Solaris, you can also enter the following in the CLI:
man cmexport
DEE Developer's Reference
The cmexport command exports data to XML format, as per the schema defined. When you need data only for a few columns, remove the unwanted columns in the schema file. The schema files are available in the following path in the LMS Server:
NMSROOT/campus/bin (Solaris/Soft Appliance)
NMSROOT\campus\bin (Windows)
The following are the schemas used for exporting the user tracking data in XML format:
•
•
•
•
•
Schema for User Tracking Data
<?xml version="1.0" encoding="UTF-8" ?><!-- Copyright (c) 2003, 2004 Cisco Systems Inc. All rights reserved.--><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"><xs:element name="UTDetails"><xs:complexType><xs:sequence><xs:element name="CMServer" type="xs:string" /><xs:element name="CreatedAt" type="xs:string" /><xs:element name="SchemaVersion" type="xs:string" /><xs:element name="Heading" type="xs:string" /><xs:element name="Query" type="xs:string" /><xs:element name="Layout" type="xs:string" /><xs:element ref="UTData" minOccurs="0" maxOccurs="unbounded" /></xs:sequence></xs:complexType></xs:element><xs:element name="UTData"><xs:complexType><xs:sequence><xs:element name="Index" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="UserName" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="MACAddress" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="HostName" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="IPAddress" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="Subnet" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="IPv6Address" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="PrefixLength" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="Prefix" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="DeviceName" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="Device" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="Port" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="PortName" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="PortState" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="PortDuplex" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="PortSpeed" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="VTPDomain" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="VLAN" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="VLANId" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="VLANType" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="ParentVLAN" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="SecondaryVlan" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="Ring" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="Bridge" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="LastSeen" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="Notes" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="dot1xEnabled" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="associatedRouters" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="discrepancyEnabled" type="xs:string" minOccurs="0" maxOccurs="1" /><xs:element name="bestPracticesDeviationEnabled" type="xs:string" minOccurs="0" maxOccurs="1" /></xs:sequence></xs:complexType></xs:element></xs:schema>User Tracking Schema for Switch Data
<?xml version="1.0" encoding="UTF-8"?><!-- Copyright (c) 2003, 2004 Cisco Systems Inc. All rights reserved. --><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"><xs:element name="UTDetails"><xs:complexType><xs:sequence><xs:element name="CMServer" type="xs:string"/><xs:element name="CreatedAt" type="xs:string"/><xs:element name="SchemaVersion" type="xs:string"/><xs:element name="Heading" type="xs:string"/><xs:element name="Query" type="xs:string"/><xs:element name="Layout" type="xs:string"/><xs:element ref="SwitchUTData" minOccurs="0" maxOccurs="unbounded"/></xs:sequence></xs:complexType></xs:element><xs:element name="SwitchUTData"><xs:complexType><xs:sequence><xs:element name="DeviceName" type="xs:string"/><xs:element name="DeviceIP" type="xs:string"/><xs:element name="UTData" maxOccurs="unbounded"/></xs:sequence></xs:complexType></xs:element><xs:element name="UTData"><xs:complexType><xs:sequence><xs:element name="UserName" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="MACAddress" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="HostName" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="IPAddress" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="Subnet" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="IPv6Address" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="PrefixLength" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="Prefix" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="Port" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="PortName" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="PortState" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="PortDuplex" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="PortSpeed" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="VTPDomain" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="VLAN" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="VLANId" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="VLANType" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="trBRFVLAN" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="SecondaryVlan" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="Ring" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="Bridge" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="LastSeen" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="Notes" type="xs:string" minOccurs="0" maxOccurs="1"/></xs:sequence></xs:complexType></xs:element></xs:schema>User Tracking Schema for Phone Data
<?xml version="1.0" encoding="UTF-8"?><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"><xs:element name="UTDetails"><xs:annotation><xs:documentation>It gives the Phone details</xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element name="CMServer" type="xs:string"/><xs:element name="CreatedAt" type="xs:string"/><xs:element name="SchemaVersion" type="xs:string"/><xs:element name="Heading" type="xs:string"/><xs:element name="PhoneQuery" type="xs:string"/><xs:element name="PhoneLayout" type="xs:string"/><xs:element ref="PhoneData" maxOccurs="unbounded"/></xs:sequence></xs:complexType></xs:element><xs:element name="PhoneData"><xs:complexType><xs:sequence><xs:element name="PhoneNumber" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="MACAddress" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="IPAddress" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="CCMAddress" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="Status" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="PhoneType" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="PhoneDescr" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="DeviceName" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="Device" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="Port" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="PortName" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="LastSeen" type="xs:string" minOccurs="0" maxOccurs="1"/></xs:sequence></xs:complexType></xs:element></xs:schema>User Tracking Schema for Subnet Data
<?xml version="1.0" encoding="UTF-8"?><!-- Copyright (c) 2003, 2004 Cisco Systems Inc. All rights reserved. --><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"><xs:element name="UTDetails"><xs:complexType><xs:sequence><xs:element name="CMServer" type="xs:string"/><xs:element name="CreatedAt" type="xs:string"/><xs:element name="SchemaVersion" type="xs:string"/><xs:element name="Heading" type="xs:string"/><xs:element name="Query" type="xs:string"/><xs:element name="Layout" type="xs:string"/><xs:element ref="SubnetUTData" minOccurs="0" maxOccurs="unbounded"/></xs:sequence></xs:complexType></xs:element><xs:element name="SubnetUTData"><xs:complexType><xs:sequence><xs:element name="SubnetId" type="xs:string"/><xs:element name="UTData" maxOccurs="unbounded"/></xs:sequence></xs:complexType></xs:element><xs:element name="UTData"><xs:complexType><xs:sequence><xs:element name="UserName" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="MACAddress" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="HostName" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="IPAddress" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="IPv6Address" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="PrefixLength" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="Prefix" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="DeviceName" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="Device" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="Port" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="PortName" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="PortState" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="PortDuplex" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="PortSpeed" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="VTPDomain" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="VLAN" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="VLANId" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="VLANType" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="trBRFVLAN" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="SecondaryVlan" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="Ring" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="Bridge" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="LastSeen" type="xs:string" minOccurs="0" maxOccurs="1"/><xs:element name="Notes" type="xs:string" minOccurs="0" maxOccurs="1"/></xs:sequence></xs:complexType></xs:element></xs:schema>Schema for Topology Data
<?xml version="1.0" encoding="UTF-8"?><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"><xs:element name="CMData"><xs:complexType><xs:sequence><xs:element name="CMServer" type="xs:string"/><xs:element name="CreatedAt" type="xs:string"/><xs:element name="SchemaVersion" type="xs:string"/><xs:element name="Heading" type="xs:string"/><xs:element ref="Layer2Details" minOccurs="0" maxOccurs="unbounded"/></xs:sequence></xs:complexType></xs:element><xs:element name="Layer2Details"><xs:complexType><xs:sequence><xs:element ref="Device" minOccurs="0" maxOccurs="unbounded"/></xs:sequence></xs:complexType></xs:element><xs:element name="Device"><xs:complexType><xs:sequence><xs:element name="DeviceName" type="xs:string"/><xs:element name="IPAddress" type="xs:string"/><xs:element name="DeviceState"><xs:simpleType><xs:restriction base="xs:string"><xs:pattern value="Reachable"/><xs:pattern value="UnReachable"/></xs:restriction></xs:simpleType></xs:element><xs:element name="DeviceType" type="xs:string"/><xs:element ref="Neighbors" minOccurs="0" maxOccurs="unbounded"/></xs:sequence></xs:complexType></xs:element><xs:element name="Neighbors"><xs:complexType><xs:sequence><xs:element ref="Neighbor" minOccurs="0" maxOccurs="unbounded"/></xs:sequence></xs:complexType></xs:element><xs:element name="Neighbor"><xs:complexType><xs:sequence><xs:element name="NeighborIPAddress" type="xs:string"/><xs:element name="NeighborDeviceType" type="xs:string"/><xs:element name="Link" type="xs:string"/><xs:element name="LocalPort" type="xs:string"/><xs:element name="RemotePort" type="xs:string"/></xs:sequence></xs:complexType></xs:element></xs:schema>Schema for Discrepancy Data
<?xml version="1.0" encoding="UTF-8" ?><!-- Copyright (c) 2003, 2004 Cisco Systems Inc. All rights reserved.--><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"><xs:element name="CMData"><xs:complexType><xs:sequence><xs:element name="CMServer" type="xs:string" /><xs:element name="CreatedAt" type="xs:string" /><xs:element name="SchemaVersion" type="xs:string" /><xs:element name="Heading" type="xs:string" /><xs:element ref="Discrepancies" minOccurs="0" maxOccurs="unbounded" /></xs:sequence></xs:complexType></xs:element><xs:element name="Discrepancies"><xs:complexType><xs:sequence><xs:element ref="Best-Practices-Deviation" minOccurs="0" maxOccurs="unbounded" /><xs:element ref="Network-Discrepancy" minOccurs="0" maxOccurs="unbounded" /></xs:sequence></xs:complexType></xs:element><xs:element name="Best-Practices-Deviation"><xs:complexType><xs:sequence><xs:element name="Details" type="xs:string" /><xs:element name="Type" type="xs:string" /><xs:element name="Severity"><xs:simpleType><xs:restriction base="xs:string"><xs:pattern value="High" /><xs:pattern value="Medium" /><xs:pattern value="Low" /></xs:restriction></xs:simpleType></xs:element><xs:element name="Description" type="xs:string" /><xs:element name="FirstFound" type="xs:string" /><xs:element name="Acknowledged" type="xs:string" /></xs:sequence></xs:complexType></xs:element><xs:element name="Network-Discrepancy"><xs:complexType><xs:sequence><xs:element name="Details" type="xs:string" /><xs:element name="Type" type="xs:string" /><xs:element name="Severity"><xs:simpleType><xs:restriction base="xs:string"><xs:pattern value="High" /><xs:pattern value="Medium" /><xs:pattern value="Low" /></xs:restriction></xs:simpleType></xs:element><xs:element name="Description" type="xs:string" /><xs:element name="FirstFound" type="xs:string" /><xs:element name="Acknowledged" type="xs:string" /></xs:sequence></xs:complexType></xs:element></xs:schema>Using Servlet to Export Data from LMS
The servlet allows you to access DEE features using simple scripts. You can invoke DEE functions by running the script that connects to the LMS server and retrieves the data.
You can send the commands to export user tracking, topology, and discrepancy data (cmexport and utexport) as HTTP or HTTPS requests to a special LMS server URL. This URL identifies a servlet that accepts the request and authenticates the requesting user identity and credentials before authorizing the information exchange.
•
•
•
–
–
–
The servlet then parses the payload file encoded in XML, performs the operations, and returns the results in XML format. You must create the payload file to include the input details and submit it when you ask for servlet access.
Typically, servlet access is used when you need to use the data export feature from a client system.
To use DEE export features, you can write a script to upload the payload file and perform the data export functions.
See the following sample scripts:
•
•
For example, if you are using the script test.pl, you can invoke the servlet in either of these modes:
HTTP Mode
•
perl test.pl http://campus-server:1741/campus/servlet/CMExportServlet payload.xml
•
perl test.pl http://campus-server:1741/cmapps/UTExportServlet payload.xml
HTTPS Mode
•
perl test.pl https://campus-server/campus/servlet/CMExportServlet payload.xml
•
perl test.pl https://campus-server/cmapps/UTExportServlet payload.xml
Sample Perl Script (test.pl) to Access the Servlet
#!/opt/CSCOpx/bin/perluse LWP::UserAgent;$| = 1;$temp = $ARGV[0] ;$fname = $ARGV[1] ;if ( -f $fname ) {open (FILE,"$fname") || die "File open Failed $!";while ( <FILE> ){$str .= $_ ;}close(FILE);}url_call($temp);#-- Activate a CGI:sub url_call {my ($url) = @_;my $ua = new LWP::UserAgent;$ua->timeout(5000);my $hdr = new HTTP::Headers 'Content-Type' => 'text/html';my $req = new HTTP::Request ('GET', $url, $hdr);$req->content($str);my $res = $ua->request($req);my $result;if ($res->is_error){print "ERROR : ", $res->code, " : ", $res->message, "\n";$result = '';}else{$result = $res->content;if($result =~ /Authorization error/){print "Authorization error\n";}else{print $result ;}}}Sample Java Code to Access the Servlet
import java.io.*;import java.net.URL;import java.net.HttpURLConnection;import java.lang.String;import java.lang.Byte;class CMExportServletRun {static void main (String args[]){try {URL url = new URL("http://localhost:1741/campus/servlet/CMExportServlet");String payload = "adminadminut_hostdee.log1";HttpURLConnection con;InputStream is;//opens connection to servletcon = (HttpURLConnection)url.openConnection();con.setRequestMethod("POST");con.setRequestProperty("Content-type", "text/xml");con.setDoOutput(true);con.setUseCaches(false);OutputStream bos = new BufferedOutputStream(con.getOutputStream());PrintWriter out = new PrintWriter(bos);out.println(payload);out.flush();out.close();//prints out response from CMExportServletbyte [] strBytes=new byte[10];int noOfBytes = 0;is = con.getInputStream();BufferedReader bfr = new BufferedReader(new InputStreamReader(is));String str = null ;while ( ( str = bfr.readLine()) != null ) {System.out.println(str);}}catch (Exception e) {System.out.println(e.toString());}}}Payload File
The payload file is an XML file that contains inputs required for the DEE servlet to process requests for data export. Schema for the payload XML file is given in Schema for Payload File.
Table C-8 describes the elements in the schema.
This section also describes:
Sample Payload File
<payload><username>username</username><password>password</password><command>ut_host</command><debug>1</debug><view></view></payload>Schema for Payload File
You can use the following schema for creating the payload file in XML format.
<?xml version="1.0" encoding="UTF-8"?><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"><xs:element name="payload"><xs:complex Type><xs:sequence><xs:element name="username" type="xs:string"/><xs:element name="password" type="xs:string"/><xs:element name="command" type="xs:string"/><xs:element name="view" type="xs:string"/><xs:element name="queryname" type="xs:string"/><xs:element name="layoutname" type="xs:string"/><xs:element name="queryphone" type="xs:string"/><xs:element name="layoutphone" type="xs:string"/><xs:element name="debug" type="xs:string"/></xs:sequence></xs:complex Type></xs:element>
