Cisco Wide Area Application Services API Reference (Software Version 6.4.1)

Book Contents

Find Matches in This Book

Available Languages

Download Options

Book Title

Cisco Wide Area Application Services API Reference (Software Version 6.4.1)

Chapter Title

Preface

PDF - Complete Book (2.33 MB) PDF - This Chapter (56.0 KB)
View with Adobe Reader on a variety of devices

Results

Updated:: June 15, 2018

Chapter: Preface

Audience
Document Organization
Document Conventions
Additional Documentation
Obtaining Documentation and Submitting a Service Request

Preface

This preface describes who should read the Cisco Wide Area Application Services API Reference, how it is organized, and its document conventions. It contains the following sections:

Audience

This application program interface (API) guide is written for the knowledgeable application programmer who understands the basic architecture of the Cisco WAAS software product.

This document provides detailed descriptions of Web Service interfaces supported by the WAAS Central Manager.

This document serves as a reference for developers of open source software (OSS) applications that interface with the WAAS Central Manager Web Service interface. It provides details of input parameters, output parameters and attributes.

Document Organization

This API reference includes the following chapters:

Chapter	Title	Description
Chapter 1	Introduction to the Cisco WAAS Central Manager Monitoring API	Provides an introduction to the programmable interface and the methods and schemas used to retrieve monitoring information using the API.
Chapter 2	Device Configuration Service	Describes the Device Configuration service and the actions it performs.
Chapter 3	Traffic Acceleration Service	Describes the Traffic Acceleration Service and the actions it performs.
Chapter 4	Events and Status Service	Describes the Events and Status service and the actions each performs.
Chapter 5	AppNav Statistics Service	Describes the AppNav Statistics service and the actions it performs.
Chapter 6	SMB Statistics Service	Describes the SMB Statistics service and the actions it performs.
Chapter 7		Describes the ICA Statistics service and the actions it performs.
Chapter 8	HTTP and HTTPS Statistics Services	Describes the HTTP/HTTPS Statistics service and the actions it performs.
Chapter 9	MAPI Statistics Service	Describes the MAPI Statistics service and the actions it performs.
Chapter 10	NFS Statistics Service	Describes the NFS Statistics service and the actions it performs.
Chapter 11	SSL Statistics Service	Describes the SSL Statistics service and the actions it performs.
Chapter 12	Web Service Objects	Describes the data types that are defined structures or objects in the Central Manager Monitoring API.

Document Conventions

This API reference uses basic conventions to represent text and table information.

Convention	Description
boldface font	Commands, keywords, and button names are in boldface.
italic font	Variables for which you supply values are in italics. Directory names and filenames are also in italics.
`screen` font	Terminal sessions and information the system displays are printed in `screen` font.
boldface screen font	Information you must enter is in boldface screen font.
italic screen font	Variables you enter are printed in italic screen font.
plain font	Enter one of a range of options as listed in the syntax description.
^D or Ctrl-D	Hold the Ctrl key while you press the D key.
string	Defined as a nonquoted set of characters. For example, when setting a community string for SNMP to “public,” do not use quotation marks around the string, or the string will include the quotation marks.

Note Means reader take note. Notes contain helpful suggestions or references to materials not contained in the manual.

Tip Means the following information will help you solve a problem. The tips information might not be troubleshooting or even an action, but could be useful information, similar to a Timesaver.

Additional Documentation

For additional information on the Cisco WAAS software, see the following documentation:

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What’s New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to the What’s New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS version 2.0.