Web Service API Reference Guide for Cisco … · TemplateInstance 2-6 VMMappingInfo 2-6 Vserver ... † User Guide for the Cisco Application Networking Manager —Includes complete

Web Service API Reference Guide for Cisco Application Networking Manager 5.2.2Version 5.2.2 November 2012

Americas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706 USAhttp://www.cisco.comTel: 408 526-4000

800 553-NETS (6387)Fax: 408 527-0883

Text Part Number: OL-25355-03

http://www.cisco.com

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)

Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.

API Reference Guide for Cisco Application Networking Manager 5.2.2 © 2012 Cisco Systems, Inc. All rights reserved.

http://www.cisco.com/go/trademarks

OL-25355-03

C O N T E N T S

Preface ix

Audience ix

Organization ix

Related Documentation x

Conventions x

Open-Source Software Included in the Cisco Application Networking Manager xi

Obtaining Documentation and Submitting a Service Request xi

C H A P T E R 1 Introduction to the Cisco ANM Web Services API 1-1

ANM Web Services Overview 1-1

Using the ANM Web Services 1-2

Required Software, Web Standards, and Supported Hardware 1-2

Enabling the Web Services Interface 1-3

Obtaining the Web Services Description Language File 1-3

Generating the Client Code to Invoke a Web Service 1-3

Calling an ANM Web Service and Posting a SOAP Request 1-4

C H A P T E R 2 ANM Web Services API 2-1

Mapping Table 2-1

OperationManager Web Service APIs 2-3

login 2-5

logout 2-7

listDeviceids 2-8

listVirtualContexts 2-10

listVirtualServers 2-12

listServerFarms 2-15

listRservers 2-17

listServerfarmRservers 2-19

listAnswers 2-22

listDnsRules 2-24

activateVirtualServer 2-26

suspendVirtualServer 2-28

addRserverToServerfarm 2-30

removeRserverFromServerfarm 2-33

iiiAPI Reference Guide for Cisco Application Networking Manager 5.2.2

Contents

activateServerfarmRserver 2-36

suspendServerfarmRserver 2-39

changeServerfarmRserverWeight 2-42

activateAnswer 2-45

suspendAnswer 2-47

activateDnsRule 2-49

suspendDnsRule 2-51

getVMMappingInfo 2-53

syncDevice 2-55

ApplicationTemplateManager Web Service APIs 2-56

listTemplateDefinitions 2-56

getTemplateDefinitionMetadata 2-60

createTemplateInstance 2-65

listTemplateInstances 2-70

deleteTemplateInstance 2-71

listCheckpoints 2-73

createCheckpoint 2-75

deleteCheckpoint 2-77

rollbackCheckpoint 2-79

freeFormShow 2-81

RBACManager Web Service APIs 2-83

createUsers 2-83

updateUsers 2-85

listUsers 2-86

deleteUsers 2-88

listRoles 2-89

listDomainNames 2-90

listDomains 2-91

listOrganizations 2-92

C H A P T E R 2 Web Service Objects 2-1

Answer 2-2

Checkpoints 2-2

DeviceID 2-2

DeviceType 2-3

DnsRule 2-3

MatchCondition 2-4

Rserver 2-4

ivAPI Reference Guide for Cisco Application Networking Manager 5.2.2

OL-25355-03

Contents

Serverfarm 2-4

SessionToken 2-4

SfRserver 2-5

TemplateDefinition 2-5

TemplateInput 2-6

TemplateInstance 2-6

VMMappingInfo 2-6

Vserver 2-7

WSException 2-7

User 2-7

Role 2-8

Domain 2-10

Organization 2-11

C H A P T E R 4 Troubleshooting Problems 4-1

SOAP Message Traffic and Time Taken to Invoke an API 4-1

Custom Application Errors 4-2

Modifying the Number of Concurrent Sessions Allowed 4-3

Use Case 1: SampleWSClient A-1

Use Case 2: ActivateSuspendSfRserverClient A-5

Use Case 3: Virtual Server WS Client A-10

Use Case 4: GSSWSClient A-17

Use Case 5: ApplTemplateCreateWSClient A-23

Use Case 6: RBACManager WS Client code A-31

Use Case 7: SyncDevice WS Client code A-38

I N D E X

vAPI Reference Guide for Cisco Application Networking Manager 5.2.2

OL-25355-03

Contents

viAPI Reference Guide for Cisco Application Networking Manager 5.2.2

OL-25355-03

Preface

This guide describes the Cisco Application Networking Manager Web Services application program interface (API) implementation and explains how to use it to manage your network. This preface provides information about using this guide. This preface includes the following sections:

• Audience, page ix

• Organization, page ix

• Related Documentation, page x

• Conventions, page x

• Open-Source Software Included in the Cisco Application Networking Manager, page xi

• Obtaining Documentation and Submitting a Service Request, page xi

AudienceThis API guide is written for the knowledgeable application programmer who understands the basic architecture of the Cisco Application Networking Manager (ANM). This document provides detailed descriptions of Web Service APIs supported by ANM. Depending on the configuration required, readers should have specific knowledge in the following areas:

• Networking and data communications

• Network security

• Router configuration

• Datacenter products

Organization This document contains the following sections:

• Chapter 1, “Introduction to the Cisco ANM Web Services API” provides an overview of the programmable interface and the methods and schemas used to perform configuration operations using the API.

• Chapter 2, “ANM Web Services API” lists and describes the available APIs.

• Chapter 2, “Web Service Objects” lists the data types that are defined structures or objects in the ANM Web Services APIs.

ixAPI Reference Guide for Cisco Application Networking Manager 5.2.2

OL-25355-03

Preface

• Chapter 4, “Troubleshooting Problems” lists the custom application errors.

• Appendix A, “Use Case Examples” lists the use case sample code examples.

Related DocumentationIn addition to this installation guide, the Application Networking Manager (ANM) documentation set includes the following publications. You can access the ANM documentation on www.cisco.com at: http://www.cisco.com/en/US/products/ps6904/tsd_products_support_series_home.html.

• Installation Guide for the Cisco Application Networking Manager—Includes complete installation and configuration information for the ANM software.

• Installation Guide for the Cisco Application Networking Manager Virtual Appliance—Includes complete information about ANM virtual appliance functionality, installation, configuration, and administration procedures.

• User Guide for the Cisco Application Networking Manager—Includes complete information about ANM functionality and detailed procedures for its use. Contains all of the information found in online help. Available either on cisco.com or from the ANM online help.

• Context-sensitive online help—Includes help topics for all pages in the UI (also provides access to PDFs of the user guide). Select an option from the ANM GUI, and click Help.

• Supported Devices Table for the Cisco Application Networking Manager—Includes complete supported device and firmware versions for ANM.

• Supplemental License Agreement for the Cisco Application Networking Manager—Describes licensing limitations and restrictions.

ConventionsThis document uses the following conventions:

Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the publication.

Item Convention

Commands and keywords boldface font

Variables for which you supply values italic font

Displayed session and system information screen font

Information you enter boldface screen font

Variables you enter italic screen font

Menu items and button names boldface font

Choosing a menu item in paragraphs Option > Network Preferences

Choosing a menu item in tables Option > Network Preferences

xAPI Reference Guide for Cisco Application Networking Manager 5.2.2

OL-25355-03

Preface

Caution Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.

Open-Source Software Included in the Cisco Application Networking Manager

• The Cisco Application Networking Manager includes the following open-source software, which is covered by the Apache 2.0 license (http://www.apache.org/): Ant, Avalon Logkit, Commons, Ehcache, Jetty, Log4J, Oro, Commons_Logging, Xmlrpc.

• The Cisco Application Networking Manager includes the following open-source software, which is covered by The Legion of the Bouncy Castle (http://www.bouncycastle.org/licence.html) license: BouncyCastle.

• The Cisco Application Networking Manager includes the following open-source software, which is covered by the GNU Lesser General Public License Version 2.1 (http://www.gnu.org/licenses/lgpl.html): c3p0-0.9.0.2.jar, Enterprise DT, Jasperreports 1.2, Jcommon 1.2, Jfreechart 1.0.1.

• The Cisco Application Networking Manager includes the following open-source software, which is covered by the Mozilla Public License Version 1.1 (http://www.mozilla.org/MPL/MPL-1.1.html): Itext 1.4.

Obtaining Documentation and Submitting a Service RequestFor 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.

xiAPI Reference Guide for Cisco Application Networking Manager 5.2.2

OL-25355-03

http://www.apache.org/



http://www.bouncycastle.org/licence.html



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

http://www.gnu.org/licenses/lgpl.html

http://www.gnu.org/licenses/lgpl.html

http://www.mozilla.org/MPL/MPL-1.1.html



Preface

xiiAPI Reference Guide for Cisco Application Networking Manager 5.2.2

OL-25355-03

API Reference GuiOL-25355-03

C H A P T E R 1
Introduction to the Cisco ANM Web Services API
This chapter describes the Cisco ANM Web Services application programming interface (API), which provides a programmable interface for system developers to integrate with customized or third-party management applications.

This chapter contains the following sections:

• ANM Web Services Overview, page 1-1

• Obtaining the Web Services Description Language File, page 1-3

• Using the ANM Web Services, page 1-2

ANM Web Services OverviewThe ANM Web Services are a Web Service implementation, which is defined by the W3C standard as a software system designed to support interoperable machine-to-machine (client and server) interaction over the network. Client and server communication follows the Simple Object Access Protocol or Service Oriented Architecture Protocol (SOAP) standard. SOAP, which exchanges XML-based messages over the network using HTTP or HTTPS, is the foundation layer of the Web Service stack. It provides a basic messaging framework that allows more abstract layers to build on. SOAP encoding wraps XML headers and tags in a SOAP envelope.

ANM is a Java application that uses Java SE 6, which is a standard with Web Services support in the form of JSR 224, Java API for XML-Based Web Services (JAX-WS) 2.0. ANM makes use of Java SE 6 Web Services support to implement its Web Services-based NBI. Java SE 6 also supports JSR 181, Web Services Metadata for the Java Platform. JSR 181 makes it possible to develop web services. Additionally, Java SE 6 makes it extremely easy to publish a Java Web Service by using javax.xml ws.Endpoint of JAX-WS.

ANM provides the following Web Services to support the operation of the devices it manages, such as the Cisco Application Control Engine:

• Operation Manager—Perform operational tasks such as:

– Log in and out of ANM.

– List objects such as virtual contexts, real servers, virtual servers, server farms, server farm real servers, VIP answers, and DNS rules.

– Activate or susupend objects.

• ApplicationTemplateManager—Perform the following tasks:

– Manage application templates used to configure ACE devices.

1-1de for Cisco Application Networking Manager 5.2.2

Chapter 1 Introduction to the Cisco ANM Web Services API Using the ANM Web Services

– Manage configuration checkpoints.

– Obtain specific show command output.

• RBACManager—Perform the following tasks:

– Manage user accounts

– List user accounts

– List role, domain, an organization information

For a complete list of the devices that the ANM Web Services support, see the “Required Software, Web Standards, and Supported Hardware” section on page 1-2.

Using the ANM Web Services This section describes how to use the ANM Web Services. It contains the following topics:

• Required Software, Web Standards, and Supported Hardware, page 1-2

• Enabling the Web Services Interface, page 1-3

• Obtaining the Web Services Description Language File, page 1-3

• Generating the Client Code to Invoke a Web Service, page 1-3

• Calling an ANM Web Service and Posting a SOAP Request, page 1-4

Required Software, Web Standards, and Supported HardwareANM Web Services are supported in ANM software Version 4.1 and later. The API examples in this document require the following development environment:

• Java SE 6

Note Java SE 6 is applicable only if the client code is java-based.

• WSDL Support: 1.1

• SOAP 1.1

The ANM Web Services API is supported on the following product types:

• Cisco Application Control Engine (ACE) devices as follows:

– ACE20 and ACE30 modules

– ACE 4710 appliance

• Cisco Content Services Switch (CSS)

• Cisco Content Switching Module (CSM)

• Cisco Content Switching Module with SSL (CSM-S)

• Cisco Global Site Selector (GSS)

1-2API Reference Guide for Cisco Application Networking Manager 5.2.2

OL-25355-03


Enabling the Web Services InterfaceANM uses the following ports for Web Services:

• http port: 8080

• https port: 8443

After you have installed the ANM software, you can reconfigure ANM configuration properties, such as enabling HTTP(S) for Web Services. For information about enabling Web Services, see the Changing ANM Configuration Property Values section in the User Guide for the Cisco Application Networking Manager 5.2.2.

Obtaining the Web Services Description Language FileANM Web Services uses Web Services Description Language (WSDL) with SOAP and XML schemas to provide Web Services. WSDL is an XML-based service that describes the functionality offered by the Web Service and defines the actions, parameter names, input parameter data types, and return data types for the Web Service. When you connect to a Web Service through a web browser, you can read the WSDL file to determine which functions are available on the server. Any special data types that are used are embedded in the WSDL file in an XML schema. You can then call one of the functions listed in the WSDL file by sending a SOAP request message.

To obtain the WSDL file defined for a particular service in the ANM Web Services API implementation, submit a URL to the service with a ?wsdl suffix. For example, to retrieve the WSDL for the OperationManager service running on https://localhost:8443/anm/OperationManager, call the WSDL file by using the following URL: https://<host/ip>:8443/anm/OperationManager?wsdl. For more examples, see the “Generating the Client Code to Invoke a Web Service” section on page 1-3.

Generating the Client Code to Invoke a Web ServiceThis procedure shows how to generate the client source code.

Procedure

Step 1 Download the WSDL file from the server using the following WSDL URL formats:

• OperationManager WSDL:

https://<host/ip>:8443/anm/OperationManager?wsdl

or

http://<host/ip>:8080/anm/OperationManager?wsdl

• ApplicationTemplateManager WSDL:

https://<host/ip>:8443/anm/ApplicationTemplateManager?wsdl

or

http://<host/ip>:8080/anm/ApplicationTemplateManager?wsdl

• RBACManager WSDL

https://<host/ip>:8443/anm/RBACManager?wsdl

or


OL-25355-03


http://<host/ip>:8080/anm/RBACManager?wsdl

where the host/ip value is the hostname or IP address of the ANM that has the service running.

Step 2 Save the file as either OperationManager.wsdl, ApplicationTemplateManager.wsdl, or RBACManager.wsdl, depending on which one you are downloading.

Step 3 Generate and compile the source code by using the wsimport command as follows:

wsimport -d <specify where to place generated output files> -s <specify where to place generated source files> {OperationManager.wsdl | ApplicationTemplateManager.wsdl | RBACManager.wsdl}

The above command generates the java source code from the wsdl file and then compiles it and puts the class file in the same location where the source file .wsimport file is located in the dir $JAVA_HOME/bin.

Note This step is applicable only if the client code is a java-based code.

Calling an ANM Web Service and Posting a SOAP RequestTo call a service, you connect to a particular ANM through a web browser by using a service URL that contains the IP address or hostname of the ANM and the name of the particular service (such as OperationManager). For example, https://<host/ip>:8443/anm/OperationManager?wsdl is the service URL for the OperationManager Web Service. You use the same format to call the ApplicationTemplateManager Web Service.

By default, ANM supports up to 10 concurrent sessions for Web Services (see the “Modifying the Number of Concurrent Sessions Allowed” section on page 4-3).

Next, you must post a SOAP request written in a XML format to retrieve the information. The request calls for a particular action (such as login) and the input parameter content when required. The ANM responds with a SOAP envelope that contains the answer in an XML format. The response contains the output values for this action.

Example Request The following example shows an XML-formatted SOAP request to perform the login action. There are no input parameters for this particular action.

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <login xmlns="http://anm.cisco.com"> <user xmlns="">admin</user> <password xmlns="">admin</password> </login> </SOAP-ENV:Body></SOAP-ENV:Envelope>


OL-25355-03


Example Response The following example shows the XML response to the login request. The response contains output values such as the SessionToken.

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:loginResponse xmlns:ns2="http://anm.cisco.com"> <SessionToken xmlns=""> <sid>5546099606143734326</sid> </SessionToken> </ns2:loginResponse> </S:Body></S:Envelope>


OL-25355-03



OL-25355-03


C H A P T E R 2
ANM Web Services API
This chapter describes the ANM Web Services APIs, which allows you to manage the Cisco devices listed in the “Required Software, Web Standards, and Supported Hardware” section on page 1-2. ANM Web Services provide APIs to support configuration functionalities. All APIs are implemented as synchronous calls and each call is a transaction.

This chapter contains the mapping table and describes the following ANM APIs:

• Mapping Table

• OperationManager Web Service APIs

• ApplicationTemplateManager Web Service APIs

• RBACManager Web Service APIs

Mapping TableTable 2-1 displays the mapping of each API with the specified role and the domain, where

• F = Full access

• N = No access

Table 2-1 Mapping Table

API Name

Role Name

ACE-A

dmin

AN

M-A

dmin

Netw

ork-Adm

in

Netw

ork-Monitor

Org-A

dmin

Security-Adm

in

Server-Appln-M

aintenance

Server-Maintenance

SLB-A

dmin

SSL-Adm

in

SSL-Cert-Key-Adm

in

VM-M

apper

OperationManager Web Service APIs

listDeviceids N F N F F N N N N N N N

listVirtualContexts F F F F F N N N N N N N

listVirtualServers F F N F F N F F F N N N


Chapter 2 ANM Web Services API Mapping Table

listServerFarms F F N F F N F F F N N N

listRservers F F N F F N F F F N N N

listServerfarmRservers F F N F F N F F F N N N

listAnswers N F N N F N F F F N N N

listDnsRules N F N N F N F F F N N N

activateVirtualServer F F N N F N N N F N N N

suspendVirtualServer F F N N F N N N F N N N

addRserverToServerfarm F F N F F N F F F N N N

removeRserverFromServerfarm F F N N F N F N F N N N

activateServerfarmRserver F F N N F N F F F N N N

suspendServerfarmRserver F F N N F N F F F N N N

changeServerfarmRserverWeight F F N N F N F F F N N N

activateAnswer N F N N F N N F F N N N

suspendAnswer N F N N F N N F F N N N

activateDnsRule N F N N F N N F F N N N

suspendDnsRule N F N N F N N F F N N N

getVMMappingInfo N F N N F N N N N N N F

syncDevice N F F N F N N N N N N N

ApplicationTemplateManager Web Service APIs

listTemplateDefinitions F F N N F N N N N N N N

getTemplateDefinitionMetadata F F N N F N N N N N N N

createTemplateInstance F F N N F N N N N N N N

listTemplateInstances F F N N F N N N N N N N

deleteTemplateInstance F F N N F N N N N N N N

listCheckpoints F F N N F N N N N N N N

createCheckpoint F F N N F N N N N N N N

deleteCheckpoint F F N N F N N N N N N N

rollbackCheckpoint F F N N F N N N N N N N

freeFormShow F F N N F N N N N N N N

Table 2-1 Mapping Table (continued)

API Name

Role Name

ACE-A

dmin

AN

M-A

dmin

Netw

ork-Adm

in

Netw

ork-Monitor

Org-A

dmin

Security-Adm

in

Server-Appln-M

aintenance

Server-Maintenance

SLB-A

dmin

SSL-Adm

in

SSL-Cert-Key-Adm

in

VM-M

apper


OL-25355-03

Chapter 2 ANM Web Services API OperationManager Web Service APIs

OperationManager Web Service APIsThis section describes the APIs associated with the OperationManager Web Service, which are as follows:

• login

• logout

• listDeviceids

• listVirtualContexts

• listVirtualServers

• listServerFarms

• listRservers

• listServerfarmRservers

• listAnswers

• listDnsRules

• activateVirtualServer

• suspendVirtualServer

• addRserverToServerfarm

• removeRserverFromServerfarm

• activateServerfarmRserver

RBACManager Web Service APIs

createUsers N F N N F N N N N N N N

updateUsers N F N N F N N N N N N N

listUsers N F N N F N N N N N N N

deleteUsers N F N N F N N N N N N N

listRoles N F N N F N N N N N N N

listDomainNames N F N N F N N N N N N N

listDomains N F N N F N N N N N N N

listOrganizations N F N N F N N N N N N N

Table 2-1 Mapping Table (continued)

API Name

Role Name

ACE-A

dmin

AN

M-A

dmin

Netw

ork-Adm

in

Netw

ork-Monitor

Org-A

dmin

Security-Adm

in

Server-Appln-M

aintenance

Server-Maintenance

SLB-A

dmin

SSL-Adm

in

SSL-Cert-Key-Adm

in

VM-M

apper


OL-25355-03


• suspendServerfarmRserver

• changeServerfarmRserverWeight

• activateAnswer

• suspendAnswer

• activateDnsRule

• suspendDnsRule

• getVMMappingInfo

• syncDevice


OL-25355-03


loginThis request logs in an application user to ANM. The login API validates the credentials and returns a session token. The session times out after being idle for 30 minutes even if the logout is not called.By default, ANM allows 10 concurrent API logins, but you can modify this number (see the “Modifying the Number of Concurrent Sessions Allowed” section on page 4-3).

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the login action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <login xmlns="http://anm.cisco.com"> <user xmlns="">admin</user> <password xmlns="">admin</password> </login> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Example Response The following example shows the XML response:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope

Parameter Description

Username Username of the application user.

Password Password of the application user.


SessionToken Session key of the application user.

Type Exception String

String Maximum session limit configured_limit reached for WS.

Note The default is 10 (see the “Modifying the Number of Concurrent Sessions Allowed” section on page 4-3).

String Invalid username or password. Please try again.

String Session ID is in use. Please try again later.

String Username cannot be null.

String Password cannot be null.


OL-25355-03


xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:loginResponse xmlns:ns2="http://anm.cisco.com"> <SessionToken xmlns=""> <sid>5546099606143734326</sid> </SessionToken> </ns2:loginResponse> </S:Body>

</S:Envelope>


OL-25355-03


logout This request logs out an application user from the ANM. The session times out after being idle for 30 minutes even if the logout is not called. In case of a session timeout, the following exception string is generated: Invalid Session Id.

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the logout action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <logout xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>-6055365969690519291</sid> </sessionToken> </logout> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Example Response The following example shows the XML response that contains no output parameter:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:logoutResponse xmlns:ns2="http://anm.cisco.com"/> </S:Body></S:Envelope>


sessionToken Session key of the application user.


None None.


String Invalid Session ID.


OL-25355-03


listDeviceidsThis request lists all device IDs for a device type from the ANM inventory. If none of the devices is imported in ANM, it returns an empty list.

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the listDeviceids action:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Header /> <S:Body> <ns2:listDeviceIds xmlns:ns2="http://anm.cisco.com"> <sessionToken> <sid>1861222974238016825</sid> </sessionToken> <deviceType>VIRTUAL_CONTEXT</deviceType> </ns2:listDeviceIds> </S:Body></S:Envelope>

Example Response The following example shows the XML response that contains DeviceID as the output parameter:

<?xml version="1.0" encoding="UTF-8"?><ns2:listDeviceIdsResponse xmlns:ns2="http://anm.cisco.com"> <DeviceIDs> <item> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.47</ipAddr> </item> <item> <name>Dora</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.47</ipAddr> </item>



deviceType List of device types including the device name and status. For example, CSS, CSM, CAT6K, GSS, VIRTUAL_CONTEXT, ACE4710, and ACE_BLADE.


DeviceIDs List of device IDs including the device name, device type, IP address, slot, and chassis IP address attributes.



String Unsupported Device Type: device_type.

String Device Type should not be null.


OL-25355-03


<item> <name>new</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.47</ipAddr> </item> <item> <name>rajan</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.47</ipAddr> </item> <item> <name>sab</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.47</ipAddr> </item> <item> <name>san</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.47</ipAddr> </item> <item> <name>test-context</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.47</ipAddr> </item> </DeviceIDs></ns2:listDeviceIdsResponse>


OL-25355-03


listVirtualContextsThis request lists all the virtual contexts for an Application Control Engine (ACE) module or ACE appliance from the ANM inventory.

This API is supported only on ACE modules and appliances (device type: ACE_BLADE and ACE4710).

Input Parameters

Output Parameters

Exceptions



deviceID ACE module: Device ID includes the device type, slot, and chassis IP address attributes.

ACE appliance: Device ID includes the device type, IP address, and name attributes.


DeviceIDs List of virtual context device IDs including the device type, IP address, slot, and chassis IP address attributes.



String Given ACE module is not yet imported in ANM.

String Given ACE Appliance does not exist in ANM.

String None of the devices are imported.


String Given ACE module does not exist in the chassis: Chassis_IPaddress.

String Device Type should be not null.

String “chassisIPAddr” and “ipAddr” are not added in deviceID. Either should be provided.

String Both “chassisIPAddr” and “ipAddr” are added in deviceID. Only one of them can be added.

String DeviceID should not be not null.

String DeviceType is set as ACE_BLADE, but the mandatory field “slot” is set as null or empty.

String DeviceType is set as ACE4710, but the mandatory field “ipAddr” is set as null or empty.

String Invalid IP Address: IPaddress.

String DeviceType is set as ACE_BLADE, but the mandatory field “slot” is set as null or empty.


OL-25355-03


Example Request The following example shows an XML-formatted SOAP request to perform the listVirtualContexts action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <listVirtualContexts xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>-81548021995146358</sid> </sessionToken> <deviceIDs xmlns=""> <deviceType>ACE_BLADE</deviceType> <slot>3</slot> <chassisIPAddr>10.77.247.2</chassisIPAddr> </deviceIDs> </listVirtualContexts> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Example Response The following example shows the XML response that contains the list of virtual context DeviceIDs as the output parameter:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:listVirtualContextsResponse xmlns:ns2="http://anm.cisco.com"> <DeviceIDs xmlns=""> <item> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <slot>3</slot> <chassisIPAddr>10.77.247.2</chassisIPAddr> </item> <item> <name>VC1</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <slot>3</slot> <chassisIPAddr>10.77.247.2</chassisIPAddr> </item> </DeviceIDs> </ns2:listVirtualContextsResponse> </S:Body></S:Envelope>


OL-25355-03


listVirtualServersThis request lists all the virtual servers configured on the specified device. The device can be a CSS, CSM, or a virtual context (VIRTUAL_CONTEXT) on an ACE module or ACE appliance.

Input Parameters

Output Parameters

Exceptions



deviceID Virtual context DeviceID, which contains the virtual server name, device type, IP address, chassis slot, and chassis IP address attributes.

allVSs (Optional) Input parameter that instructs ANM to return a list of all virtual servers that match ANM’s virtual server definition and those that do not match this definition but that ANM can recognize as virtual servers using SNMP polling. By default, ANM returns only the virtual servers that match ANM’s virtual server definition.


vservers List of all virtual servers including the virtual server name, policy-map name, and IP address attributes.




Note The default is 10 (see the “Modifying the Number of Concurrent Sessions Allowed” section on page 4-3).










String DeviceType is set as VIRTUALCONTEXT, but the mandatory field “slot” is set as null or empty.

String DeviceType is set as VIRTUALCONTEXT, but the mandatory field “name” is set as null or empty.


OL-25355-03


Example Request The following example shows an XML-formatted SOAP request to perform the listVirtualServers action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <listVirtualServers xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>7299761084673772498</sid> </sessionToken> <deviceID xmlns=""> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr/> <slot>2</slot> <chassisIPAddr>10.77.247.2</chassisIPAddr> </deviceID> <allVS xmlns="">false</allVS> </listVirtualServers> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Example Response The following example shows the XML response that contains the list of virtual servers as the output parameter:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:listVirtualServersResponse xmlns:ns2="http://anm.cisco.com"> <listVirtualServers xmlns=""> <item> <virtualserverName>14_simple_vs</virtualserverName> <policyMapName>int2</policyMapName> <matchConditions> <ipAddress>15.5.3.2</ipAddress> <protocol>tcp</protocol> <port>2</port>


String Given virtual context name “[VC name]” does not exist in the ACE Devices.

String DeviceType is set as CSS, but the mandatory field “ipAddr” is set as null or empty.

String DeviceType is set as VIRTUAL_CONTEXT, but the mandatory field “ipAddr” is set as null or empty.

String Device Type is set as CSM, but the mandatory field “chassisIPAddr” is set as null or empty.

String Device Type is set as CSM, but the mandatory field “slot” is set as null or empty.


OL-25355-03


</matchConditions> <serverfarms>14_simple_sf</serverfarms> <vlans>2</vlans> <adminState>DOWN</adminState> <operState>DOWN</operState> <lastPolledTime>Fri May 27 16:52:31 IST 2011</lastPolledTime> </item> <item> <virtualserverName>ds_simple_vs</virtualserverName> <policyMapName>int161</policyMapName> <matchConditions> <ipAddress>13.3.3.3</ipAddress> <protocol>tcp</protocol> <port>6</port> </matchConditions> <serverfarms>ds_simple_sf</serverfarms> <vlans>161</vlans> <adminState>DOWN</adminState> <operState>DOWN</operState> <lastPolledTime>Fri May 27 16:52:31 IST 2011</lastPolledTime> </item> <item> <virtualserverName>test</virtualserverName> <policyMapName>global</policyMapName> <matchConditions> <ipAddress>4.5.6.7</ipAddress> <protocol>tcp</protocol> <port>443</port> </matchConditions> <serverfarms>gh</serverfarms> <vlans/> <adminState>UP</adminState> <operState>DOWN</operState> <lastPolledTime>Fri May 27 16:52:31 IST 2011</lastPolledTime> </item> </listVirtualServers> </ns2:listVirtualServersResponse> </S:Body></S:Envelope>


OL-25355-03


listServerFarmsThis request lists all server farms on a virtual context from the ANM inventory. This API is supported only on ACE devices (device type: VIRTUAL_CONTEXT).

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the listServerFarms action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope



deviceID Virtual context device ID including the device name, device type, IP address, slot, and chassis IP address attributes.


Serverfarms List of server farm objects including the name and type (host or redirect) attributes.



String Maximum session limit [configured_limit] reached for WS.

The default is 10 (see the “Modifying the Number of Concurrent Sessions Allowed” section on page 4-3).





String Given ACE module does not exist in the chassis: Chassis_IPaddress








String Given virtual context name VC_name does not exist in the ACE Devices.


OL-25355-03


xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <listServerFarms xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>8368662778638735743</sid> </sessionToken> <deviceID xmlns=""> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.46</ipAddr> </deviceID> </listServerFarms> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Example Response The following example shows the XML response that contains the list of Serverfarm objects as the output parameter:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:listServerFarmsResponse xmlns:ns2="http://anm.cisco.com"> <serverfarms xmlns=""> <item> <name>SF1</name> <serverFarmType>host</serverFarmType> </item> <item> <name>SF2</name> <serverFarmType>host</serverFarmType> </item> </serverfarms> </ns2:listServerFarmsResponse> </S:Body></S:Envelope>


OL-25355-03


listRserversThis request lists all the real servers on a virtual context from the ANM inventory. This API is supported only on ACE devices (device type: VIRTUAL_CONTEXT).

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the listRservers action:






Rservers List of real server objects including the name, IP address, admin state, and weight attributes.






String Given ACE appliance does not exist in ANM.











String Given virtual context name VC_name does not exist in the ACE devices.


OL-25355-03


xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <listRservers xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>8368662778638735743</sid> </sessionToken> <deviceID xmlns=""> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.46</ipAddr> </deviceID> </listRservers> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Example Response The following example shows the XML response that contains the list of real server objects as the output parameter:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:listRserversResponse xmlns:ns2="http://anm.cisco.com"> <Rservers xmlns=""> <item> <name>RS1</name> <type>host</type> <state>IS</state> <weight>8</weight> </item> <item> <name>RS2</name> <type>redirect</type> <state>IS</state> </item> </Rservers> </ns2:listRserversResponse> </S:Body></S:Envelope>


OL-25355-03


listServerfarmRserversThis request lists all the real servers present in the given server farm from the ANM inventory. If the server farm name is provided as empty or null in the input parameters, it lists all the real server objects in the given virtual context. This API is supported on CSS, CSM, and ACE devices (device type: CSS, CSM, and VIRTUAL_CONTEXT).

Input Parameters

Output Parameters

Exceptions



deviceID Device ID of the virtual context including the device name, device type, IP address, slot and chassis IP address attributes.

serverfarmname Name of an existing server farm. It can be empty, null, or a specific server farm configured in the device.


SfRservers List of server farm real server objects including server farm name, server farm real server name, IP address, admin state, weight, and port value attributes.


String Invalid session ID.




String Given ACE appliance does not exist in ANM.













OL-25355-03


Example Request The following example shows an XML-formatted SOAP request to perform the listServerfarmRservers action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <listServerfarmRservers xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>-2221649013806878130</sid> </sessionToken> <deviceID xmlns=""> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.46</ipAddr> </deviceID> <serverfarmname xmlns="">SF1</serverfarmname> </listServerfarmRservers> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Example Response The following example shows the XML response that contains SfRserver as the output parameter:

<S:Envelopexmlns:S="http://schemas.xmlsoap.org/soap/envelope/"><S:Body><ns2:listServerfarmRserversResponsexmlns:ns2="http://anm.cisco.com"><SfRservers xmlns=""><item><serverfarmName>SF1</serverfarmName><realserverName>04122009sanitytesting</realserverName><adminState>IS</adminState><operationState>UP</operationState><weight>8</weight><port>0</port><lastPolledTime>Wed Jun 08 20:53:18 IST 2011</lastPolledTime></item><item><serverfarmName>1</serverfarmName><realserverName>anm-vm-118</realserverName><adminState>IS</adminState>






OL-25355-03


<weight>19</weight><port>0</port></item><item><serverfarmName>SF1</serverfarmName><realserverName>test</realserverName><adminState>OOS</adminState><operationState>UP</operationState><weight>8</weight><port>443</port><ipAddr>10.2.1.11</ipAddr><lastPolledTime>Wed Jun 08 20:53:18 IST 2011</lastPolledTime></item></SfRservers></ns2:listServerfarmRserversResponse></S:Body></S:Envelope>


OL-25355-03


listAnswersThis request lists all the VIP answers configured on the specified given GSS.

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the listAnswers action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <listAnswers xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>7299761084673772498</sid> </sessionToken> <deviceID xmlns=""> <name>GSS</name> <deviceType>GSS</deviceType> <ipAddr>172.23.244.135</ipAddr> <slot>0</slot> <chassisIPAddr/> </deviceID> </listAnswers> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Example Response The following example shows the XML response that contains answers as the output parameter:

<?xml version="1.0" encoding="UTF-8"?>



deviceID GSS device ID, which contains the GSS name, device type, and IP address attributes.


answers List of answer objects, including the answer name, IP address, configuration state, and type attributes. The type attribute is always “vip.”


String Invalid session token.

String GSS does not exist.

String Session timeout.

String Cannot reach the GSS.


OL-25355-03


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:listAnswersResponse xmlns:ns2="http://anm.cisco.com"> <Answers xmlns=""> <item> <ipAddr>10.10.9.99</ipAddr> <answerName>vip2131</answerName> <type>null</type> <configState>ACTIVATE</configState> <anserGroups>vipgrp1066</anserGroups> <location>null</location>

<device>GSS</device> <operState>ACTIVE</operState> <pGssmTime>17:50:19</pGssmTime> </item> </DeviceIDs> </ns2:listAnswersResponse> </S:Body></S:Envelope>


OL-25355-03


listDnsRulesThis request lists all the DNS rules configured on the specified given GSS.

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the listDnsRules action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <listDnsRules xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>6600024266770332702</sid> </sessionToken> <deviceID xmlns=""> <name>40</name> <deviceType>GSS</deviceType> <ipAddr>10.77.241.40</ipAddr> </deviceID> </listDnsRules> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Example Response The following example shows the XML response that contains dnsRules as the output parameter:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body>



deviceID GSS device ID, which contains the GSS name, device type, and IP address attributes.


dnsRules List of DNS rule objects, including the DNS rule name, source IP address, owner, and configuration state attributes.







OL-25355-03


<ns2:listDnsRulesResponse xmlns:ns2="http://anm.cisco.com"> <listDnsRules xmlns=""> <item> <dnsRuleName>dns1</dnsRuleName> <sourceAddress>Anywhere</sourceAddress> <domains>dom1</domains> <dnsConfigState>Active</dnsConfigState> <answerGroups>null</answerGroups> <owner>System</owner> </item> </listDnsRules> </ns2:listDnsRulesResponse> </S:Body></S:Envelope>


OL-25355-03


activateVirtualServerThis request activates an existing virtual server, putting it into service. This API is supported on CSS, CSM, and virtual contexts (VIRTUAL_CONTEXT) on ACE modules and appliances.

Note For CSS and CSM devices, after changing the state, SNMP polling is triggered. The API does not return until the polling is complete.

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the activateVirtualServer action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <activateVirtualServer xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>2713248117084982682</sid> </sessionToken> <deviceID xmlns=""> <name>SysTestApp</name>



deviceID Virtual server device ID, including the device name, device type, IP address, slot, and chassis IP address attributes.

vServer Virtual server object, including the virtual server name, policy-map name, and IP address attributes.

reason Reason for the activation.


None None.



String Virtual context does not exist.


String Cannot reach the virtual context.

String Virtual server does not exist.

String Config errors from the ACE, CSS, or CSM.


OL-25355-03


<deviceType>VIRTUAL_CONTEXT</deviceType> <slot>2</slot> <chassisIPAddr>10.77.247.2</chassisIPAddr> </deviceID> <vserver xmlns=""> <virtualserverName>12_simple_vs</virtualserverName> <policyMapName>NAT_Policy</policyMapName> </vserver> <reason xmlns="">testing</reason> </activateVirtualServer> </SOAP-ENV:Body></SOAP-ENV:Envelope>


<?xml version="1.0" encoding="UTF-8"?><S:Envelopexmlns:S="http://schemas.xmlsoap.org/soap/envelope/"><S:Body><ns2:activateVirtualServerResponse xmlns:ns2="http://anm.cisco.com"/></S:Body></S:Envelope>


OL-25355-03


suspendVirtualServerThis request suspends an existing virtual server, putting it out of service. This API is supported on CSS, CSM, and virtual contexts (VIRTUAL_CONTEXT) on ACE modules and appliances.


Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the suspendVirtualServer action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <suspendVirtualServer xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>2713248117084982688</sid> </sessionToken> <deviceID xmlns=""> <name>SysTestApp</name>



deviceID Virtual server device ID, including the device name, device type, IP address, slot, and chassis IP address attributes.

vServer Virtual server object, including the virtual server name, policy-map name, and IP address attributes.



None None.



String Virtual context does not exist.


String Cannot reach the virtual context.

String Virtual server does not exist.

String Config errors from the ACE, CSS, or CSM.


OL-25355-03


<deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr/> <slot>2</slot> <chassisIPAddr>10.77.247.2</chassisIPAddr> </deviceID> <vserver xmlns=""> <virtualserverName>12_simple_vs</virtualserverName> <policyMapName>NAT_Policy</policyMapName> </vserver> <reason xmlns="">test</reason> </suspendVirtualServer> </SOAP-ENV:Body></SOAP-ENV:Envelope>


<?xml version="1.0" encoding="UTF-8"?><S:Envelopexmlns:S="http://schemas.xmlsoap.org/soap/envelope/"><S:Body><ns2:suspendVirtualServerResponse xmlns:ns2="http://anm.cisco.com"/></S:Body></S:Envelope>


OL-25355-03


addRserverToServerfarmThis request adds a real server to an existing server farm. If it does not find the real server, it creates a real server and adds it to the server farm. This API is supported on ACE devices (device type: ‘VIRTUAL_CONTEXT’).

Input Parameters

Output Parameters

Exceptions



deviceID Device ID of the virtual context including the device name, device type, IP address, slot and chassis IP address attributes.

rserver Real server object including name, IP address, admin state, and weight attributes.

port Port of the server farm real server.

serverfarm Name of an existing server farm.


None None.













String “chassisIPAddr” and “ipAddr” are not added in device ID. Either should be provided.

String Both “chassisIPAddr” and “ipAddr'” are added in device ID. Only one of them can be added.




OL-25355-03


Example Request The following example shows an XML-formatted SOAP request to perform the addRserverToServerfarm action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <addRserverToServerfarm xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>5731694438459731003</sid> </sessionToken> <deviceID xmlns=""> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.46</ipAddr> </deviceID> <serverfarmname xmlns="">SF1</serverfarmname>

String Given Server Farm ServerFarm_name is not available in the given Virtual Context.

String Server Farm name should not be null or empty.



String Given Name: ServerFarm_name exceeds the maximum length of 64 characters.

String Invalid Port: port_number. Port number should be numeric.

String Invalid port value: port_number. Port value is outside the range <0-65535>.

String Invalid weight value: weight_value. Weight value should be numeric.

String Invalid weight value: weight_value. Weight value is outside the range <0-100>.

String Invalid Name: ServerFarm_name. Name should match the format [â-zA-Z0-9._-].

String Invalid Name: RealServer_name. Name should match the format [â-zA-Z0-9._-].

String Invalid Name: ServerFarm_name. Name should not hold any reserved keywords.

String Invalid Name: RealServer_name. Name should not hold any reserved keywords.

String IP address must be provided for the Real Server.

String Given Real Server type RealServer_type is not associated with Server Farm type Server Farm_type.

String Real Server RealServer_name/ Port_value already exist in the Server Farm ServerFarm_name.


OL-25355-03


<rserver xmlns=""> <name>sampletest</name> <type>host</type> <ipAddr>2.3.6.53</ipAddr> <state>IS</state> <weight>34</weight> </rserver> <port xmlns="">0</port> </addRserverToServerfarm> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Example Response The following example shows the XML response that has no output parameter:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:addRserverToServerfarmResponse xmlns:ns2="http://anm.cisco.com"/> </S:Body></S:Envelope>


OL-25355-03


removeRserverFromServerfarmThis request removes an existing server farm real server from a server farm. It removes the real server, if there is no server farm real server reference to the real server. This API is supported on ACE devices (device type: VIRTUAL_CONTEXT).

Input Parameters

Output Parameters

Exceptions




sfRserver Server farm real server object including the server farm name, real server name, IP address, admin state, weight, and port attributes.


None None.




















OL-25355-03


Example Request The following example shows an XML-formatted SOAP request to perform the removeRserverFromServerfarm action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <removeRserverFromServerfarm xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>-81548021995146358</sid> </sessionToken> <deviceID xmlns=""> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.46</ipAddr> </deviceID> <rserver xmlns=""> <serverfarmName>SF1</serverfarmName> <realserverName>sampletest</realserverName> <adminState>IS</adminState> <weight>0</weight> <port>0</port> <ipAddr>2.3.6.53</ipAddr> </rserver>


String Server Farm name should not be null or empty.

String Given Name : ServerFarm_name exceeds the maximum length of 64 characters.



String Invalid weight value: weight_value. Weight value should be numeric.

String Invalid weight value: weight_value. Weight value is outside the range <0-100>.

String Invalid Name: ServerFarm_name. Name should match the format [â-zA-Z0-9._-].

String Invalid Name: RealServer_name. Name should match the format [â-zA-Z0-9._-].

String Invalid Name: ServerFarm_name. Name should not hold any reserved keywords.

String Invalid Name: RealServer_name. Name should not hold any reserved keywords.


String Given Real Server RealServer_name/ port_number does not exist in the Server Farm ServerFarm_name.


OL-25355-03


</removeRserverFromServerfarm> </SOAP-ENV:Body></SOAP-ENV:Envelope>


<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:removeRserverFromServerfarmResponse xmlns:ns2="http://anm.cisco.com"/> </S:Body></S:Envelope>


OL-25355-03


activateServerfarmRserverThis request activates an existing server farm real server in service. This API is supported on CSS, CSM, and ACE devices (device type: CSS, CSM and VIRTUAL_CONTEXT).


Input Parameters

Output Parameters

Exceptions




sfRserver Server farm real server object including the server farm name, real server name, IP address, admin state, weight and port attributes



None None.



String Server Farm name cannot be null.

String Maximum session limit [configured_limit] reached for WS.


String Given Server farm Real Server name cannot be null.

String Given Real Server state cannot be null.

String Given Real server weight cannot be null.

String Server Farm Real server port value should not be null.



String Given Cat6k does not exist in ANM.


String Given CSM does not exist in the chassis: Chassis_IPaddress.

String Given CSS does not exist in ANM.



String Device Type should be null.


OL-25355-03


Example Request The following example shows an XML-formatted SOAP request to perform the activateServerfarmRserver action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <activateServerfarmRserver xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>-5217915770163489503</sid> </sessionToken> <deviceID xmlns=""> <name>Admin</name>



String DeviceID should not be null.



String Invalid IP Address: “IP address.”







String Given Name:ServerFarm_name exceeds the maximum length of 15 characters.




String Given Real Server RealServer_name/port_number does not exist in the Server Farm ServerFarm_name.


OL-25355-03


<deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.46</ipAddr> </deviceID> <rserver xmlns=""> <serverfarmName>SF1</serverfarmName> <realserverName>test</realserverName> <adminState>OOS</adminState> <weight>44</weight> <port>443</port> <ipAddr>10.2.1.11</ipAddr> </rserver> <reason xmlns="">sample Webservices testing</reason> </activateServerfarmRserver> </SOAP-ENV:Body></SOAP-ENV:Envelope>


<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:activateServerfarmRserverResponse xmlns:ns2="http://anm.cisco.com"/> </S:Body></S:Envelope>


OL-25355-03


suspendServerfarmRserverThis request suspends the existing server farm real server. This API is supported on CSS, CSM, and ACE devices (device type: CSS, CSM and VIRTUAL_CONTEXT).


Input Parameters

Output Parameters

Exceptions




sfRserver Server farm real server object including the server farm name, real server name, IP address, admin state, weight and port attributes

state List of options supported are Graceful, Suspend, Suspend_Clear_Connections.

reason Reason for suspension.


None None.



















OL-25355-03


Example Request The following example shows an XML-formatted SOAP request to perform the suspendServerfarmRserver action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <suspendServerfarmRserver xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>2658073681808034239</sid> </sessionToken>



















String Invalid suspend state: suspend_state.


OL-25355-03


<deviceID xmlns=""> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.46</ipAddr> </deviceID> <rserver xmlns=""> <serverfarmName>SF1</serverfarmName> <realserverName>test</realserverName> <adminState>IS</adminState> <weight>44</weight> <port>443</port> <ipAddr>10.2.1.11</ipAddr> </rserver> <suspendState xmlns="">Suspend</suspendState> <reason xmlns=""/> </suspendServerfarmRserver> </SOAP-ENV:Body></SOAP-ENV:Envelope>


<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:suspendServerfarmRserverResponse xmlns:ns2="http://anm.cisco.com"/> </S:Body></S:Envelope>


OL-25355-03


changeServerfarmRserverWeightThis request changes the weight of an existing server farm real server. This API is supported on CSS, CSM, and ACE devices (device type: CSS, CSM, and VIRTUAL_CONTEXT).

Note For CSS & CSM devices, after changing the weight, SNMP polling is triggered. The API does not return until the polling is complete.

Input Parameters

Output Parameters

Exceptions




sfRserver Server farm real server object including the server farm name, real server name, IP address, admin state, weight and port attributes.

reason Reason for the operation.


None None.




















OL-25355-03


Example Request The following example shows an XML-formatted SOAP request to perform the changeServerfarmRserverWeight action:






String Invalid IP Address: “Ip address.”







String Given Name: ServerFarm_name exceeds the maximum length of 15 characters

String Given Name : ServerFarm_name exceeds the maximum length of 31 characters.







String Invalid weight value: weight_value. Weight value is outside the range <1-100> [ace module, ace appliance].

String Invalid weight value: weight_value. Weight value is outside the range <0-100> [csm].

String Invalid weight value: weight_value. Weight value is outside the range <0-10> [css].


OL-25355-03


<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <changeServerfarmRserverWeight xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>-5217915770163489503</sid> </sessionToken> <deviceID xmlns=""> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.46</ipAddr> </deviceID> <rserver xmlns=""> <serverfarmName>SF1</serverfarmName> <realserverName>test</realserverName> <adminState>OOS</adminState> <weight>44</weight> <port>443</port> <ipAddr>10.2.1.11</ipAddr> </rserver> <reason xmlns=""/> </changeServerfarmRserverWeight> </SOAP-ENV:Body></SOAP-ENV:Envelope>


<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:changeServerfarmRserverWeightResponse xmlns:ns2="http://anm.cisco.com"/> </S:Body></S:Envelope>


OL-25355-03


activateAnswerThis request activates an existing answer on the specified GSS, putting the answer into service.

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the activateAnswer action:


xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<SOAP-ENV:Body> <activateAnswer

xmlns="http://anm.cisco.com"><sessionToken

xmlns=""><sid>1861222974238016825</sid>

</sessionToken> <deviceID

xmlns=""> <name>172.23.244.135</name> <deviceType>GSS</deviceType> <ipAddr>172.23.244.135</ipAddr> </deviceID> <answer

xmlns=""><ipAddr>1.2.3.2</ipAddr><answerName>answer1</answerName><type>vip</type>

</answer>



deviceID GSS device ID, including the device name, device type, and IP address attributes.

answer Answer object, including the answer name, IP address, and type attributes. The type is always “vip.”



None None.






String Config errors from the GSS.


OL-25355-03


<reasonxmlns="">test</reason>

</activateAnswer> </SOAP-ENV:Body></SOAP-ENV:Envelope>


<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:activateAnswerResponse xmlns:ns2="http://anm.cisco.com"/> </S:Body></S:Envelope>


OL-25355-03


suspendAnswerThis request suspends an existing answer on the specified GSS, putting the answer out of service.

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the suspendAnswer action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <suspendAnswer xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>1861222974238016825</sid> </sessionToken> <deviceID xmlns=""> <name>172.23.244.135</name> <deviceType>GSS</deviceType> <ipAddr>172.23.244.135</ipAddr> </deviceID> <answer xmlns=""> <ipAddr>1.2.3.2</ipAddr> <answerName>answer1</answerName> <type>vip</type> </answer> <reason xmlns="">test</reason> </suspendAnswer> </SOAP-ENV:Body></SOAP-ENV:Envelope>




answer Answer object, including the answer name, IP address, and type attributes. The type is always “vip.”



None None.








OL-25355-03



<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:suspendAnswerResponse xmlns:ns2="http://anm.cisco.com"/> </S:Body></S:Envelope>


OL-25355-03


activateDnsRuleThis request activates an existing DNS rule on the specified GSS, putting the DNS rule into service.

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the activateDnsRule action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <activateDnsRule xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>6195441786283682375</sid> </sessionToken> <deviceID xmlns=""> <name>172.23.244.135</name> <deviceType>GSS</deviceType> <ipAddr>172.23.244.135</ipAddr> </deviceID> <dnsrule xmlns=""> <dnsRuleName>dns1</dnsRuleName> <sourceAddress>Anywhere</sourceAddress> </dnsrule> <reason xmlns="">test</reason>




dnsRule DNS rule object, including the DNS rule name, source IP address, owner, and configuration state attributes.



None None.








OL-25355-03


</activateDnsRule> </SOAP-ENV:Body></SOAP-ENV:Envelope>


<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:activateDnsRuleResponse xmlns:ns2="http://anm.cisco.com"/> </S:Body></S:Envelope>


OL-25355-03


suspendDnsRuleThis request suspend an existing DNS rule on the specified GSS, putting the DNS rule out of service.

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the suspendDnsRule action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <suspendDnsRule xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>6195441786283682370</sid> </sessionToken> <deviceID xmlns=""> <name>172.23.244.135</name> <deviceType>GSS</deviceType> <ipAddr>172.23.244.135</ipAddr> </deviceID> <dnsrule xmlns=""> <dnsRuleName>dns1</dnsRuleName> <sourceAddress>Anywhere</sourceAddress> </dnsrule> <reason xmlns="">test</reason>




dnsRule DNS rule object, including the DNS rule name, source IP address, owner, and configuration state attributes.



None None.








OL-25355-03


</suspendDnsRule> </SOAP-ENV:Body></SOAP-ENV:Envelope>


<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:suspendDnsRuleResponse xmlns:ns2="http://anm.cisco.com"/> </S:Body></S:Envelope>


OL-25355-03


getVMMappingInfoThis request returns all the server farm real server mapping information for a given VM. This API is supported on CSS, CSM, and ACE devices (device type: CSS, CSM, and VIRTUAL_CONTEXT).

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the getVMMappingInfo action:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Header /> <S:Body> <getVMMappingInfo xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>1861222974238016825</sid> </sessionToken> <vmname xmlns="">/vcenter/Chennai/vm/anm-lnx-134</vmname> </getVMMappingInfo> </S:Body></S:Envelope>

Example Response The following example shows the XML response that contains the list of VMMappingInfo objects as the output parameter:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">



vmname Unique name of the VM. The format is “/<Vcenter Name given in ANM>/<full path for vmname as in the Vcenter>/<VM name>”.


VMMappingInfos Object attributes including the device ID, server farm name, server farm real server name, IP address, and port attributes.





String None of the vCenter is imported in ANM.

String Given VM VM_name does not exist.

String Unable to get DeviceId for device_id.

String Vmname should not be null.


OL-25355-03


<S:Body> <ns2:getVMMappingInfoResponse xmlns:ns2="http://anm.cisco.com"> <VMMappingInfos xmlns=""> <item> <deviceID> <deviceType>CSS</deviceType> <ipAddr>172.23.244.250</ipAddr> </deviceID> <sfname>myReal8</sfname> <sfrsname>myReal8</sfrsname> <port>0</port> <ipaddr>0.0.0.0</ipaddr> </item> <item> <deviceID> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <slot>4</slot> <chassisIPAddr>10.77.247.2</chassisIPAddr> </deviceID> <sfname>WEB-SF</sfname> <sfrsname>webservicesample</sfrsname> <port>0</port> <ipaddr>3.3.3.4</ipaddr> </item> <item> <deviceID> <deviceType>CSM</deviceType> <slot>4</slot> <chassisIPAddr>172.23.244.130</chassisIPAddr> </deviceID> <sfname>FOO2</sfname> <sfrsname>RS1</sfrsname> <port>0</port> <ipaddr/> </item> <item> <deviceID> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.241.46</ipAddr> </deviceID> <sfname>tst_sf_dup</sfname> <sfrsname>testing_dup</sfrsname> <port>0</port> </item> </VMMappingInfos> </ns2:getVMMappingInfoResponse> </S:Body></S:Envelope>


OL-25355-03


syncDeviceThis API synchronizes the configuration of a specified device with ANM when there have been changes to the device that ANM does not track.

This API is supported on the following device types: ACE, Catalyst 6500 Series Switches, CSM, CSS, GSS, and VMware vCenter.

Note While accessing syncDevice from the soapUI tool, you must configure the socket timeout value as 900000 millisecs. By default, the socket timeout value is not configured.

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the syncDevice action for an ACE:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Header /> <S:Body> <ns2:syncDevice xmlns:ns2="http://anm.cisco.com"> <sessionToken> <sid>5414670344217132208</sid> </sessionToken> <deviceId> <deviceType>ACE4710</deviceType> <ipAddr>10.77.247.20</ipAddr> </deviceId> </ns2:syncDevice> </S:Body></S:Envelope>



deviceID Virtual context name, devicetype, and IP address attributes. For the ACE module only, the device ID includes the host chassis slot and chassis IP address attributes.


None None.




String Invalid device type.

String Invalid device ID.

String Internal error: command parse error.


OL-25355-03

Chapter 2 ANM Web Services API ApplicationTemplateManager Web Service APIs


<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Header /> <S:Body> <ns2:syncDeviceResponse xmlns:ns2="http://anm.cisco.com" /> </S:Body></S:Envelope>

ApplicationTemplateManager Web Service APIsThis section describes the APIs associated with the ApplicationTemplateManager Web Service, which are as follows:

• listTemplateDefinitions

• getTemplateDefinitionMetadata

• createTemplateInstance

• listTemplateInstances

• deleteTemplateInstance

• listCheckpoints

• createCheckpoint

• deleteCheckpoint

• rollbackCheckpoint

• freeFormShow

listTemplateDefinitionsThis API lists all the available ANM templates, including both ANM-defined templates (or system templates) and user-defined templates. Template definitions include the template name, description, application, application version, and so forth.

Input Parameters

Output Parameters

Exceptions




templateDefinitionArray List of template definitions.





OL-25355-03


Example Request The following example shows an XML-formatted SOAP request to perform the listTemplateDefinitions action:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Header /> <S:Body> <ns2:listTemplateDefinitions xmlns:ns2="http://anm.cisco.com"> <sessionToken> <sid>-4754037077725100881</sid> </sessionToken> </ns2:listTemplateDefinitions> </S:Body></S:Envelope>

Example Response The following example shows the XML response that contains the list of templateDefinitions objects as the output parameter:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:listTemplateDefinitionsResponse xmlns:ns2="http://anm.cisco.com"> <templateDefinitions> <item> <id>1</id> <name>FTP</name> <description>FTP LB</description> <application>FTP</application> <appVersion>1.1</appVersion> <createTime>2012-02-08 15:06:51</createTime> <createUser>Management Task</createUser> <updateTime>2012-02-08 15:06:51</updateTime> <updateUser>Management Task</updateUser> </item> <item> <id>10</id> <name>Java Application Server</name> <description>HTTP server, Java Servlet and JSP technologies, ie Apache Tomcat</description> <application>Java Application Server</application> <appVersion>1.1</appVersion> <createTime>2012-02-08 15:06:51</createTime> <createUser>Management Task</createUser> <updateTime>2012-02-08 15:06:51</updateTime> <updateUser>Management Task</updateUser> </item> <item> <id>11</id> <name>Basic HTTP</name> <description>Basic L4 LB for HTTP</description> <application>Basic HTTP</application> <appVersion>1.1</appVersion> <createTime>2012-02-08 15:06:51</createTime> <createUser>Management Task</createUser> <updateTime>2012-02-08 15:06:51</updateTime> <updateUser>Management Task</updateUser> </item> <item> <id>2</id> <name>Layer 3 LB</name> <description>Simple L3 all ports no mapping</description>


OL-25355-03


<application>Layer 3 LB</application> <appVersion>1.1</appVersion> <createTime>2012-02-08 15:06:51</createTime> <createUser>Management Task</createUser> <updateTime>2012-02-08 15:06:51</updateTime> <updateUser>Management Task</updateUser> </item> <item> <id>3</id> <name>Secure Webserver</name> <description>Generic Secure Webserver with redirect</description> <application>Secure Webserver</application> <appVersion>1.1</appVersion> <createTime>2012-02-08 15:06:51</createTime> <createUser>Management Task</createUser> <updateTime>2012-02-08 15:06:51</updateTime> <updateUser>Management Task</updateUser> </item> <item> <id>4</id> <name>Microsoft Exchange 2010</name> <description>MS Exchange Template</description> <application>Microsoft Exchange 2010</application> <appVersion>1.1</appVersion> <createTime>2012-02-08 15:06:51</createTime> <createUser>Management Task</createUser> <updateTime>2012-02-08 15:06:51</updateTime> <updateUser>Management Task</updateUser> </item> <item> <id>5</id> <name>DWS with Nexus 7000 OTV</name> <description>Dynamic Workload Scaling with Nexus 7000 OTV for Basic LB with HTTP or Secure Webserver</description> <application>DWS with Nexus 7000 OTV</application> <appVersion>1.1</appVersion> <createTime>2012-02-08 15:06:51</createTime> <createUser>Management Task</createUser> <updateTime>2012-02-08 15:06:51</updateTime> <updateUser>Management Task</updateUser> </item> <item> <id>6</id> <name>RDP</name> <description>Remote Desktop Protocol</description> <application>RDP</application> <appVersion>1.1</appVersion> <createTime>2012-02-08 15:06:51</createTime> <createUser>Management Task</createUser> <updateTime>2012-02-08 15:06:51</updateTime> <updateUser>Management Task</updateUser> </item> <item> <id>7</id> <name>Microsoft SharePoint 2010</name> <description>Microsoft SharePoint Template</description> <application>Microsoft SharePoint 2010</application> <appVersion>1.1</appVersion> <createTime>2012-02-08 15:06:51</createTime> <createUser>Management Task</createUser> <updateTime>2012-02-08 15:06:51</updateTime> <updateUser>Management Task</updateUser> </item> <item>


OL-25355-03


<id>8</id> <name>Layer 4 LB</name> <description>Simple L4 LB</description> <application>Layer 4 LB</application> <appVersion>1.1</appVersion> <createTime>2012-02-08 15:06:51</createTime> <createUser>Management Task</createUser> <updateTime>2012-02-08 15:06:51</updateTime> <updateUser>Management Task</updateUser> </item> <item> <id>9</id> <name>DNS</name> <description>DNS LB</description> <application>DNS</application> <appVersion>1.1</appVersion> <createTime>2012-02-08 15:06:51</createTime> <createUser>Management Task</createUser> <updateTime>2012-02-08 15:06:51</updateTime> <updateUser>Management Task</updateUser> </item> </templateDefinitions> </ns2:listTemplateDefinitionsResponse> </S:Body></S:Envelope>


OL-25355-03


getTemplateDefinitionMetadataThis API takes an available ANM template definition and returns an array of template input objects, which contain the template name, default value, userData, hasChild, and the childElements details. The names are the variable names defined in the template definition file.

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the getTemplateDefinitionMetadata action:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Header /> <S:Body> <ns2:getTemplateDefinitionMetadata xmlns:ns2="http://anm.cisco.com"> <sessionToken> <sid>-986099040932183901</sid> </sessionToken> <templateDefinition> <id>7</id> <name>Microsoft SharePoint 2010</name> <description>Microsoft SharePoint Template</description> <application>Microsoft SharePoint 2010</application> <appVersion>1.1</appVersion> <createTime>2012-02-08 15:06:51</createTime> <createUser>Management Task</createUser> <updateTime>2012-02-08 15:06:51</updateTime> <updateUser>Management Task</updateUser> </templateDefinition> </ns2:getTemplateDefinitionMetadata> </S:Body></S:Envelope>

Example Response The following example shows the XML response that contains the list of TemplateDefinitionMetadata objects as the output parameter:



templateDefinition Template definition, which includes the template name, description, application, application version, and so forth. To retrieve a list of available template definitions, use the listTemplateDefinitions API.


templateInputArray Array of TemplateInput objects.




String Invalid template definition.


OL-25355-03


<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:getTemplateDefinitionMetadataResponse xmlns:ns2="http://anm.cisco.com"> <templateDefinitionMetadata> <item> <tagName>GROUP</tagName> <name>service</name> <type>group</type> <displayString>Application Configuration</displayString> <childElements> <tagName>VARIABLE</tagName> <name>name</name> <type>name</type> <displayString>Application Config Name:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>vip</name> <type>ipaddresswithprefix</type> <displayString>VIP Address:</displayString> </childElements> <childElements> <tagName>ARRAY</tagName> <name>reals</name> <displayString>SharePoint Application Servers:</displayString> <childElements> <tagName>VARIABLE</tagName> <name>ipAddr</name> <type>ipaddress</type> <displayString /> </childElements> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>realport</name> <type>port</type> <displayString>SSL Offload Port:</displayString> <defaultValue>80</defaultValue> </childElements> <childElements> <tagName>IMG</tagName> <name>img1</name> <type>img</type> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>pkcs12</name> <type>enum</type> <displayString>Key Type:</displayString> <defaultValue>PKCS12</defaultValue> </childElements> <childElements> <tagName>IF</tagName> <childElements> <tagName>VARIABLE</tagName> <name>url</name> <type>url</type> <displayString>SSL Key URL:</displayString> <defaultValue>sftp://1.2.3.4/dir/myfile.pkcs12</defaultValue> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>url.name</name>


OL-25355-03


<type>Hidden</type> <displayString>SSL Key URL:</displayString> <defaultValue>sftp://1.2.3.4/dir/myfile.pkcs12</defaultValue> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>username</name> <type>string</type> <displayString>Key Server Username:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>password</name> <type>password</type> <displayString>Key Server Password:</displayString> </childElements> </childElements> <childElements> <tagName>IF</tagName> <childElements> <tagName>VARIABLE</tagName> <name>der_key_url</name> <type>url</type> <displayString>SSL Key URL:</displayString> <defaultValue>sftp://1.2.3.4/dir/myfile.key</defaultValue> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>der_key_url.name</name> <type>Hidden</type> <displayString>SSL Key URL:</displayString> <defaultValue>sftp://1.2.3.4/dir/myfile.key</defaultValue> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>der_cer_url</name> <type>url</type> <displayString>SSL Cert URL:</displayString> <defaultValue>sftp://1.2.3.4/dir/myfile.der</defaultValue> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>der_cer_url.name</name> <type>Hidden</type> <displayString>SSL Cert URL:</displayString> <defaultValue>sftp://1.2.3.4/dir/myfile.der</defaultValue> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>der_username</name> <type>string</type> <displayString>Key Server Username:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>der_password</name> <type>password</type> <displayString>Key Server Password:</displayString> </childElements> </childElements> <childElements> <tagName>IF</tagName> <childElements> <tagName>VARIABLE</tagName>


OL-25355-03


<name>key</name> <type>ssl_key</type> <displayString>SSL Key:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>key.name</name> <type>Hidden</type> <displayString>SSL Key:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>key.contents</name> <type>Hidden</type> <displayString>SSL Key:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>cert</name> <type>certificate</type> <displayString>SSL Certificate:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>cert.name</name> <type>Hidden</type> <displayString>SSL Certificate:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>cert.contents</name> <type>Hidden</type> <displayString>SSL Certificate:</displayString> </childElements> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>passphrase</name> <type>password</type> <displayString>Cert/Key Passphrase:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>compress</name> <type>boolean</type> <displayString>Enable Compression:</displayString> <defaultValue>true</defaultValue> </childElements> </item> <item> <tagName>GROUP</tagName> <name>network</name> <type>group</type> <displayString>Network Configuration</displayString> <childElements> <tagName>VARIABLE</tagName> <name>device</name> <type>device</type> <displayString>Load Balancer (Device:VirtualContext):</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>vlans</name>


OL-25355-03


<type>vlans</type> <displayString>Client VLANs:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>autoNat</name> <type>boolean</type> <displayString>Enable Source NAT:</displayString> </childElements> </item> </templateDefinitionMetadata> </ns2:getTemplateDefinitionMetadataResponse> </S:Body></S:Envelope>


OL-25355-03


createTemplateInstanceThis API takes a TemplateDefinition and TemplateInputArray object, generates a configuration based on the TemplateDefinition, and then deploys the configuration to the device. The TemplateInput object contains the template name and an array of name and value pairs. The names are the variable names defined in the template definition file and the values are all empty.

This API is supported on ACE devices (device type: VIRTUAL_CONTEXT).

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the createTemplateInstance action:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Header /> <S:Body> <ns2:createTemplateInstance xmlns:ns2="http://anm.cisco.com"> <sessionToken> <sid>-8257363202654966035</sid> </sessionToken> <deviceID> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <slot>3</slot> <chassisIPAddr>10.77.247.2</chassisIPAddr> </deviceID> <templateDefinition>



deviceID Device name, deviceType, and IP address attributes. For the ACE module only, the device ID includes the host chassis slot and chassis IP address attributes.

templateDefinition Template definition, which includes the template name, description, application, application version, and so forth. To retrieve a list of available template definitions, use the listTemplateDefinitions API.

templateInputArray Array of TemplateInput objects, which includes the template name, default value, userData, hasChild, and the childElements details. The names are the variable names defined in the template definition file and the values are the values set to the variable names.


instanceId Unique integer value of the created template.




String Invalid template definition.

String Invalid template input.


OL-25355-03


<id>7</id> <name>Microsoft SharePoint 2010</name> <description>Microsoft SharePoint Template</description> <application>Microsoft SharePoint 2010</application> <appVersion>1.1</appVersion> <createTime>2012-02-08 15:06:51</createTime> <createUser>Management Task</createUser> <updateTime>2012-02-08 15:06:51</updateTime> <updateUser>Management Task</updateUser> </templateDefinition> <templateInputs> <item> <tagName>GROUP</tagName> <name>service</name> <type>group</type> <displayString>Application Configuration</displayString> <childElements> <tagName>VARIABLE</tagName> <name>name</name> <type>name</type> <displayString>Application Config Name:</displayString> <userData>sp_vs_01</userData> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>vip</name> <type>ipaddresswithprefix</type> <displayString>VIP Address:</displayString> <userData>210.2.3.2</userData> </childElements> <childElements> <tagName>ARRAY</tagName> <name>reals</name> <displayString>SharePoint Application Servers:</displayString> <childElements> <tagName>VARIABLE</tagName> <name>ipAddr</name> <type>ipaddress</type> <displayString /> <userDatas>210.2.3.4</userDatas> <userDatas>210.2.3.5</userDatas> <userDatas>210.2.3.6</userDatas> <userDatas>210.2.3.7</userDatas> </childElements> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>realport</name> <type>port</type> <displayString>SSL Offload Port:</displayString> <defaultValue>80</defaultValue> <userData>810</userData> </childElements> <childElements> <tagName>IMG</tagName> <name>img1</name> <type>img</type> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>pkcs12</name> <type>enum</type> <displayString>Key Type:</displayString> <defaultValue>PKCS12</defaultValue>


OL-25355-03


<userData>PKCS12</userData> </childElements> <childElements> <tagName>IF</tagName> <childElements> <tagName>VARIABLE</tagName> <name>url</name> <type>url</type> <displayString>SSL Key URL:</displayString> <defaultValue>sftp://1.2.3.4/dir/myfile.pkcs12</defaultValue> <userData>sftp://10.77.240.100/p12_rsa768.p12</userData> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>url.name</name> <type>Hidden</type> <displayString>SSL Key URL:</displayString> <defaultValue>sftp://1.2.3.4/dir/myfile.pkcs12</defaultValue> <userData>p12_rsa768.p12</userData> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>username</name> <type>string</type> <displayString>Key Server Username:</displayString> <userData>root</userData> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>password</name> <type>password</type> <displayString>Key Server Password:</displayString> <userData>roZes123</userData> </childElements> </childElements> <childElements> <tagName>IF</tagName> <childElements> <tagName>VARIABLE</tagName> <name>der_key_url</name> <type>url</type> <displayString>SSL Key URL:</displayString> <defaultValue>sftp://1.2.3.4/dir/myfile.key</defaultValue> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>der_key_url.name</name> <type>Hidden</type> <displayString>SSL Key URL:</displayString> <defaultValue>sftp://1.2.3.4/dir/myfile.key</defaultValue> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>der_cer_url</name> <type>url</type> <displayString>SSL Cert URL:</displayString> <defaultValue>sftp://1.2.3.4/dir/myfile.der</defaultValue> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>der_cer_url.name</name> <type>Hidden</type> <displayString>SSL Cert URL:</displayString> <defaultValue>sftp://1.2.3.4/dir/myfile.der</defaultValue>


OL-25355-03


</childElements> <childElements> <tagName>VARIABLE</tagName> <name>der_username</name> <type>string</type> <displayString>Key Server Username:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>der_password</name> <type>password</type> <displayString>Key Server Password:</displayString> </childElements> </childElements> <childElements> <tagName>IF</tagName> <childElements> <tagName>VARIABLE</tagName> <name>key</name> <type>ssl_key</type> <displayString>SSL Key:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>key.name</name> <type>Hidden</type> <displayString>SSL Key:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>key.contents</name> <type>Hidden</type> <displayString>SSL Key:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>cert</name> <type>certificate</type> <displayString>SSL Certificate:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>cert.name</name> <type>Hidden</type> <displayString>SSL Certificate:</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>cert.contents</name> <type>Hidden</type> <displayString>SSL Certificate:</displayString> </childElements> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>passphrase</name> <type>password</type> <displayString>Cert/Key Passphrase:</displayString> <userData /> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>compress</name> <type>boolean</type>


OL-25355-03


<displayString>Enable Compression:</displayString> <defaultValue>true</defaultValue> <userData>true</userData> </childElements> </item> <item> <tagName>GROUP</tagName> <name>network</name> <type>group</type> <displayString>Network Configuration</displayString> <childElements> <tagName>VARIABLE</tagName> <name>device</name> <type>device</type> <displayString>Load Balancer (Device:VirtualContext):</displayString> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>vlans</name> <type>vlans</type> <displayString>Client VLANs:</displayString> <userData>ALL_VLAN</userData> </childElements> <childElements> <tagName>VARIABLE</tagName> <name>autoNat</name> <type>boolean</type> <displayString>Enable Source NAT:</displayString> <userData>false</userData> </childElements> </item> </templateInputs> </ns2:createTemplateInstance> </S:Body></S:Envelope>

Example Response The following example shows the XML response that contains the instanceId object as the output parameter:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:createTemplateInstanceResponse xmlns:ns2="http://anm.cisco.com"> <instanceId>5</instanceId> </ns2:createTemplateInstanceResponse> </S:Body></S:Envelope>


OL-25355-03


listTemplateInstancesThis API lists all template instances, which includes the template name, description, application, application version, and so forth.

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the listTemplateInstances action:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Header /> <S:Body> <ns2:listTemplateInstances xmlns:ns2="http://anm.cisco.com"> <sessionToken> <sid>4918324415074336347</sid> </sessionToken> </ns2:listTemplateInstances> </S:Body></S:Envelope>

Example Response The following example shows the XML response that contains the list of templateInstances objects as the output parameter:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:listTemplateInstancesResponse xmlns:ns2="http://anm.cisco.com"> <TemplateInstances> <item> <instanceId>1</instanceId> <templateName>FTP1</templateName> <applicationType>FTP</applicationType> <type>Deployed</type> <status>Complete</status> <deviceId>10.77.247.20:new</deviceId> <lastUpdatedTime>2012-02-09 00:25:58</lastUpdatedTime> </item> </TemplateInstances> </ns2:listTemplateInstancesResponse> </S:Body>




templateInstanceArray List of template instances.





OL-25355-03


</S:Envelope>

deleteTemplateInstanceThis API takes an instance ID and deviceID and deletes the configuration based on the instance ID.


Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the deleteTemplateInstance action:

<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Header /> <S:Body> <ns2:deleteTemplateInstance xmlns:ns2="http://anm.cisco.com"> <sessionToken> <sid>4918324415074336347</sid> </sessionToken> <deviceID> <name>new</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>10.77.247.20</ipAddr> </deviceID> <instanceId>1</instanceId> </ns2:deleteTemplateInstance> </S:Body></S:Envelope>




instanceId Template instance ID. To retrieve a list of available template instances, use the listTemplateInstances API.


None None.





String Invalid template input.


OL-25355-03



<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:deleteTemplateInstanceResponse xmlns:ns2="http://anm.cisco.com"> <status>success</status> </ns2:deleteTemplateInstanceResponse> </S:Body></S:Envelope>


OL-25355-03


listCheckpointsThis API lists all the checkpoints in ANM inventory for a specified device.


Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the listCheckpoints action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <listCheckpoints xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>-8567831601320378522</sid> </sessionToken> <deviceID xmlns=""> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>172.16.244.214</ipAddr> </deviceID> </listCheckpoints> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Example Response The following example shows the XML response that contains the list of Checkpoints objects as the output parameter:

<?xml version="1.0"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:listCheckpointsResponse xmlns:ns2="http://anm.cisco.com">





Checkpoints List of checkpoints.







OL-25355-03


<Checkpoints xmlns=""> <item> <name>35Admin</name> <size>11128</size> <date>Sun May 1 15:10:04 2011</date> </item> <item> <name>allcontexts</name> <size>49294</size> <date>Sun May 1 15:10:04 2011</date> </item> <item> <name>app-tmpl-1314729175709</name> <size>3917</size> <date>Mon Sep 5 10:54:45 2011</date> </item> <item> <name>beforeupgrade</name> <size>8233</size> <date>Sun May 1 15:10:04 2011</date> </item>

</Checkpoints> </ns2:listCheckpointsResponse> </S:Body></S:Envelope>


OL-25355-03


createCheckpointThis API creates a checkpoint on a specified device.


Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the createCheckpoint action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <createCheckpoint xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>-5488932206595059144</sid> </sessionToken> <deviceID xmlns=""> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>172.23.244.214</ipAddr> </deviceID> <checkpointName xmlns="">test-checkpoint</checkpointName> </createCheckpoint> </SOAP-ENV:Body></SOAP-ENV:Envelope>


<?xml version="1.0"?>




checkpointName Name of the checkpoint to create.


None None.






String Checkpoint already exists: checkpoint_name.


OL-25355-03


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:createCheckpointResponse xmlns:ns2="http://anm.cisco.com"/> </S:Body></S:Envelope>


OL-25355-03


deleteCheckpointThis API deletes a checkpoint from a specified device.


Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the deleteCheckpoint action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <deleteCheckpoint xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>-5019678635804080238</sid> </sessionToken> <deviceID xmlns=""> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>172.16.244.214</ipAddr> </deviceID> <checkpointName xmlns="">test-checkpoint</checkpointName> </deleteCheckpoint> </SOAP-ENV:Body></SOAP-ENV:Envelope>




checkpointName Name of the checkpoint to delete. To retrieve a list of available checkpoints, use the listCheckpoints API.


None None.






String Invalid checkpoint name.

String Checkpoint doesn't exist: checkpoint_name


OL-25355-03



<?xml version="1.0"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:deleteCheckpointResponse xmlns:ns2="http://anm.cisco.com"/> </S:Body></S:Envelope>


OL-25355-03


rollbackCheckpointThis API rolls back a device’s running configuration to a specified checkpoint.


Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the rollbackCheckpoint action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <rollbackCheckpoint xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>4270884926038298576</sid> </sessionToken> <deviceID xmlns=""> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>172.16.244.214</ipAddr> </deviceID> <checkpointName xmlns="">test-checkpoint</checkpointName> </rollbackCheckpoint> </SOAP-ENV:Body></SOAP-ENV:Envelope>




checkpointName Checkpoint to which you want to roll back.


None None.






String Invalid checkpoint name.

String Checkpoint doesn't exist: checkpoint_name


OL-25355-03



<?xml version="1.0"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:rollbackCheckpointResponse xmlns:ns2="http://anm.cisco.com"/> </S:Body></S:Envelope>


OL-25355-03


freeFormShowThis API returns the output of a specified show command sent to a specified device. The API includes the xml-show command, which specifies that the show command output is either regular CLI display output or it is in XML format.


Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the freeFormShow action:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <freeFormShow xmlns="http://anm.cisco.com"> <sessionToken xmlns=""> <sid>-869899350867169519</sid> </sessionToken> <deviceID xmlns=""> <name>Admin</name> <deviceType>VIRTUAL_CONTEXT</deviceType> <ipAddr>172.16.244.214</ipAddr> </deviceID>




command Name of the show command. Specify the command without using the word show. For example, to specify the show version command output, just use the word version.

isXMLized Command output format:

• On (true)—XML format.

• Off (false)—CLI display format.


None None.






String Internal error: command parse error.


OL-25355-03


<command xmlns="">access-list ALL</command> <isXMLized xmlns="">false</isXMLized> </freeFormShow> </SOAP-ENV:Body></SOAP-ENV:Envelope>


<?xml version="1.0"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:freeFormShowResponse xmlns:ns2="http://anm.cisco.com"> <output xmlns="">access-list:ALL, elements: 3, status: ACTIVE remark : access-list ALL line 8 extended permit ip any any (hitcount=333800)access-list ALL line 18 extended permit ip any host 172.16.244.230 (hitcount=0)access-list ALL line 28 extended permit ip any host 10.10.10.1 (hitcount=0)</output> </ns2:freeFormShowResponse> </S:Body></S:Envelope>


OL-25355-03

Chapter 2 ANM Web Services API RBACManager Web Service APIs

RBACManager Web Service APIsThis section describes the APIs associated with the RBACManager Web Service, which are as follows:

• createUsers

• updateUsers

• listUsers

• deleteUsers

• listRoles

• listDomainNames

• listDomains

• listOrganizations

createUsersThis API creates a user account and returns the profile creation status, which includes the username and account creation status.

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the createUsers action:



organization Name of the organization to which the user belongs.

users Input parameter that contains the list of user elements, such as login name, password, and domains (see “User” section on page 2-7).


operationStatuses List of “operation status” elements for each object that was created. The status element contains name (name of object from request), status (failure or success), and message.



String Organization organization_name doesn't exist.

String Name is not valid.

String User name already exists.

String Role is null.

String Domains is null.

String Password is empty


OL-25355-03


<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:anm="http://anm.cisco.com"> <soapenv:Header /> <soapenv:Body> <anm:createUsers> <sessionToken> <sid>1861222974238016825</sid> </sessionToken> <organization>Default</organization> <users> <item> <loginName>I01d35951</loginName> <role>Network-Admin</role> <domains> <item>new</item> </domains> <name>Ali, Firasath</name> <password type="encrypted">4F57181DCAADE980555F2CE6755CA425F00658BE</password> <email>[email protected]</email> <telephone>312-900 1111</telephone> <allowedLoginIP /> <description /> </item> <item> <loginName>J92s36842</loginName> <role>Network-Admin</role> <domains> <item>new</item> </domains> <name>Alexander F Beckerman</name> <password type="encrypted">4F57181DCAADE980555F2CE6755CA425F00658BE</password> <email>[email protected]</email> <allowedLoginIP /> <description /> </item> </users> </anm:createUsers> </soapenv:Body></soapenv:Envelope>


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:createUsersResponse xmlns:ns2="http://anm.cisco.com"> <users> <item> <name>I0135951</name> <status>success</status> </item> <item> <name>J9236842</name> <status>success</status> </item> </users> </ns2:createUsersResponse> </S:Body></S:Envelope>


OL-25355-03


updateUsersThis API updates user accounts and returns the update status, which includes the username and account update status.

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the updateUsers action:

<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:anm="http://anm.cisco.com"> <soapenv:Header /> <soapenv:Body> <anm:updateUsers> <sessionToken> <sid>1861222974238016825</sid> </sessionToken> <organization>Default</organization> <users> <item> <loginName>J9236842</loginName> <role>Server-Appln-Maintenance</role> <domains> <item>All</item> </domains> <name>J9236842</name> <password type="encrypted">9B7C68A918B17EB053809B198D7C9ABFC142F30A</password> <email>[email protected]</email> <telephone>111111</telephone> <allowedLoginIP> <item>192.168.1.1</item> </allowedLoginIP> <description>some notes</description> </item>




users Input parameter that contains the list of user elements, such as login name, password, and domains (see the “User” section on page 2-7).


operationStatuses List of “operation status” elements for each object that was updated. This status element contains name (name of object from request), status (failure or success), and message.



String Internal error: cannot find full_name.



OL-25355-03


</users> </anm:updateUsers> </soapenv:Body></soapenv:Envelope>


<?xml version="1.0" encoding="UTF-8"?><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:updateUsersResponse xmlns:ns2="http://anm.cisco.com"> <operationStatuses> <item> <name>J9236842</name> <status>success</status> </item> </operationStatuses> </ns2:updateUsersResponse> </S:Body></S:Envelope>

listUsersThis API provides a list of requested users from the specified organization. If the organization does not contain any users, an empty list is returned.

Input Parameters

Output Parameters

Exceptions

Example Request The following example shows an XML-formatted SOAP request to perform the listUsers action:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:anm="http://anm.cisco.com"> <soapenv:Header/> <soapenv:Body>




showPassword (Optional) Input parameter that instructs ANM to include the response, the hashed user passwords. Set this parameter to true or false. By default, the parameter is set to false and ANM returns users list without their passwords.


users List of users.




String showPassword parameter must be set to true or false.


OL-25355-03


<anm:listUsers> <sessionToken> <sid>-5245583155697881618</sid> </sessionToken>

<organization>Default</organization><showPassword>true</showPassword>

</anm:listUsers> </soapenv:Body></soapenv:Envelope>


<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:listUsersResponse xmlns:ns2="http://anm.cisco.com"> <users> <item>  "

+ opStat.getName());output.append(" is " + opStat.getStatus());if (opStat.getStatus().equals("failure"))

output.append(" and the reason is "+ opStat.getMessage() + "\n");

System.out.println(output);}

} else if (operation != null&& ("create".equalsIgnoreCase(operation) || ("update"

.equalsIgnoreCase(operation)))) {if (args.length != 14) {


}organization = args[5];UserPassword userPW = null;XmlArray xmlarray = new XmlArray();

userOne = new User();if ("username".equalsIgnoreCase(args[6])) {

userOne.setLoginName(args[7]);userOne.setName(args[7]);

}if ("password".equalsIgnoreCase(args[8])) {

userPW = new UserPassword();userPW.setValue(args[9]);userPW.setType("plain");userOne.setPassword(userPW);

}if ("role".equalsIgnoreCase(args[10])) {

userOne.setRole(args[11]);}if ("domain".equalsIgnoreCase(args[12])) {

xmlarray.getItem().add(args[13]);userOne.setDomains(xmlarray);

}userArray = new UserArray();userArray.getItem().add(userOne);

if ("create".equalsIgnoreCase(operation)) {// Creates the user under the organization with the// given user attributesOperStatArray = rbacMgr.createUsers(st, organization,

userArray);} else if ("update".equalsIgnoreCase(operation)) {

// Updates the given user under the organization with// the given user attributesOperStatArray = rbacMgr.updateUsers(st, organization,

userArray);}OperationStatus opStat = OperStatArray.getItem().get(0);StringBuffer output = new StringBuffer();output.append(operation + " operation of the user --> "

+ opStat.getName());output.append(" is " + opStat.getStatus());if (opStat.getStatus().equals("failure"))


OL-25355-03


output.append(" and the reason is "+ opStat.getMessage() + "\n");

System.out.println(output);} else {


}


} finally {try {



}}


}}

}


OL-25355-03

Appendix A Use Case Examples Use Case 7: SyncDevice WS Client code

Use Case 7: SyncDevice WS Client codeThe following example shows a sample code to test the syncDevice API. After you import the device into ANM, you can call this syncDevice API to syncronize the configuration.

/** * Title: SyncDevice WS Client code * Description: This class is used to test syncDevice API. * Device that got imported in ANM can be synced using this class. * * Copyright: Copyright(C) 2012 Cisco Systems. All Rights Reserved. * Company: Cisco Systems * @version: 1.0 */


import java.io.IOException;import java.lang.reflect.Constructor;import java.lang.reflect.Method;import java.net.URL;import javax.xml.namespace.QName;import javax.xml.ws.BindingProvider;import javax.xml.ws.Service;

import com.cisco.anm.DeviceID;import com.cisco.anm.DeviceType;import com.cisco.anm.OperationManager;import com.cisco.anm.SessionToken;

/* * This class is used to test syncDevice API. * Device that got imported in ANM can be synced using this class. */public class SyncDevice {

static final String NAMESPACE = "http://anm.cisco.com";static String URL_TEMPLATE = "%s://%s:%s/anm/%s"; //


public static BindingProvider getPort(String ws, String protocol, String host, String port ) throws IOException {

String url = String.format(URL_TEMPLATE, ""+ protocol,port,host,ws);String ns = NAMESPACE;BindingProvider bp;Service svc;try {

QName qname = new QName(ns, ws + "Service");Class<Service> clazz = (Class<Service>) Class.forName("com.cisco.anm." + ws

+"Service");Constructor<Service> ctor = (Constructor<Service>) clazz.getConstructor(new

Class[]{URL.class, QName.class});svc = ctor.newInstance(new Object[]{new URL(url+"?wsdl"), qname});Method m = svc.getClass().getMethod("get"+ws+"Port", null);bp = (BindingProvider)m.invoke(svc, null);


}return bp;

}



OL-25355-03


String usage = "For CSS/VCENTER/Cat6k/GSS/ACE4710 Appliance, \n" + "Usage: java com.cisco.anm.client.SyncDevice (http|https) <ANM host name> <anm

username> <anm password> <devicetype> (css|vcenter|ace4710|cat6k|gss) " +"<Device Ip address>\n" + "Example: java com.cisco.anm.client.SyncDevice http

10.77.241.54 admin admin css 10.77.241.47 \n"+

"\nFor ACE Module/CSM, \n" + "Usage: java com.cisco.anm.client.SyncDevice (http|https) <ANM host name> <anm

username> <anm password> <devicetype> (acemodule|csm) " +"<cat6k Ip address> <Slot No>\n" + "Example: java com.cisco.anm.client.SyncDevice

http 10.77.241.54 admin admin csm 10.77.241.47 1 \n"+

"\nFor ACE Appliance VC, \n" + "Usage: java com.cisco.anm.client.SyncDevice (http|https) <ANM host name> <anm

username> <anm password> <devicetype> (ace4710vc) " +"<Device Ip address> <Context Name> \n" + "Example: java

com.cisco.anm.client.SyncDevice http 10.77.241.54 admin admin ace4710vc 10.77.241.47 Admin \n"+

"\nFor ACE Module VC, \n" + "Usage: java com.cisco.anm.client.SyncDevice (http|https) <ANM host name> <anm

username> <anm password> <devicetype> (acemodulevc)" +"<cat6k Ip address> <Context Name> <Slot No>\n" + "Example: java

com.cisco.anm.client.SyncDevice http 10.77.241.54 admin admin acemodulevc 10.77.241.47 Admin 1 \n";

String port="",protocol="",anmIPAddress="",anmUserName="",anmPwd="",deviceType="",deviceOrChassisIP="",ctxName="",slot="";

if( args.length == 6 || args.length == 7 || args.length == 8 ) {port = "";protocol = args[0]; // protocol , http or httpsanmIPAddress = args[1]; // anm IP Address or hostname of ANM serveranmUserName = args[2];// anm username,anmPwd = args[3]; // anm password.deviceType = args[4]; // device type

(cat6k/css/csm/gss/vcenter/ace4710/aceblade/vc)deviceOrChassisIP = args[5]; // <device IP Address/chassis IP address>if(args.length == 7){

if(deviceType.equalsIgnoreCase("csm") || deviceType.equalsIgnoreCase("acemodule")){

slot = args[6];}else if(deviceType.equalsIgnoreCase("ace4710vc")){

ctxName = args[6]; }

}if(args.length == 8){

if(deviceType.equalsIgnoreCase("acemodulevc")){ctxName = args[6];slot = args[7];

}}


}if(deviceType == null){

System.out.println("Please provide value for Device Type it cannot be empty");System.out.println(usage);System.exit(0);

}


OL-25355-03


if( protocol != null && protocol.equals("https")){port = "8443";

}else if( protocol.equals("http")){port = "8080";


}DeviceID deviceId = new DeviceID();OperationManager oprMgr = null;SessionToken st = null;try{

oprMgr = (OperationManager) getPort(WS_NAME, protocol, port, anmIPAddress);/** Invoke login() API to get session token.*/st = oprMgr.login(anmUserName, anmPwd);if(deviceType.equalsIgnoreCase("css")){

deviceId.setDeviceType(DeviceType.CSS);deviceId.setIpAddr(deviceOrChassisIP);oprMgr.syncDevice(st, deviceId); //Calling syncDevice API

}else if(deviceType.equalsIgnoreCase("vcenter")){deviceId.setDeviceType(DeviceType.VCENTER);deviceId.setIpAddr(deviceOrChassisIP);oprMgr.syncDevice(st, deviceId);

}else if(deviceType.equalsIgnoreCase("ace4710")){deviceId.setDeviceType(DeviceType.ACE_4710);deviceId.setIpAddr(deviceOrChassisIP);oprMgr.syncDevice(st, deviceId);

}else if(deviceType.equalsIgnoreCase("cat6k")){deviceId.setDeviceType(DeviceType.CAT_6_K);deviceId.setSlot("0");deviceId.setChassisIPAddr(deviceOrChassisIP);oprMgr.syncDevice(st, deviceId);

}else if(deviceType.equalsIgnoreCase("gss")){deviceId.setDeviceType(DeviceType.GSS);deviceId.setIpAddr(deviceOrChassisIP);oprMgr.syncDevice(st, deviceId);

}else if(deviceType.equalsIgnoreCase("csm")){deviceId.setDeviceType(DeviceType.CSM);deviceId.setChassisIPAddr(deviceOrChassisIP);deviceId.setSlot(slot);oprMgr.syncDevice(st, deviceId);

}else if(deviceType.equalsIgnoreCase("acemodule")){deviceId.setDeviceType(DeviceType.ACE_BLADE);deviceId.setSlot(slot);deviceId.setChassisIPAddr(deviceOrChassisIP);oprMgr.syncDevice(st, deviceId);

}else if(deviceType.equalsIgnoreCase("ace4710vc")){deviceId.setDeviceType(DeviceType.VIRTUAL_CONTEXT);deviceId.setName(ctxName);deviceId.setIpAddr(deviceOrChassisIP);oprMgr.syncDevice(st, deviceId);

}else if(deviceType.equalsIgnoreCase("acemodulevc")){deviceId.setDeviceType(DeviceType.VIRTUAL_CONTEXT);deviceId.setName(ctxName);deviceId.setChassisIPAddr(deviceOrChassisIP);deviceId.setSlot(slot);oprMgr.syncDevice(st, deviceId);

}System.exit(0);



OL-25355-03


}finally{try{

/** Close the ws session using logout() API.*/oprMgr.logout(st);


}}

}}


OL-25355-03



OL-25355-03


I N D E X

A

activateAnswer (GSS) 2-45

activateServerfarmRserver 2-36

activateVirtualServer 2-26

addRserverToServerfarm 2-30

Answer 2-2

C

changeServerfarmRserverWeight 2-42

Checkpoints 2-2

createCheckpoint 2-75

createTemplateInstance 2-65

Custom Application Errors 4-2

D

deleteCheckpoint 2-77

deleteTemplateInstance 2-71

Device Configuration service 2-1

DeviceID 2-2

DeviceType 2-3

DnsRule 2-3

Domain 2-10

F

freeFormShow 2-81

G

getTemplateDefinitionMetadata 2-60

getVMMappingInfo 2-53

L

listAnswers (GSS) 2-22

listCheckpoints 2-73

listDeviceids 2-8

listDNSRules (GSS) 2-24

listRservers 2-17

listServerfarmRservers 2-19

listServerFarms 2-15

listServerfarms 2-15

listTemplateDefinitions 2-56

listVirtualContexts 2-10

listVirtualServers 2-12

login 2-5

logout 2-7

M

MatchCondition 2-4

O

Organization 2-11

R

removeRserverFromServerfarm 2-33

Role 2-8

rollbackCheckpoint 2-79

Rserver 2-4

IN-1de for Cisco Application Networking Manager 5.2.2

Index

S

Serverfarm 2-4

SessionToken 2-4

SfRserver 2-5

SOAP Message Traffic 4-1

SOAP Message Traffic and Time Taken to Invoke an API 4-1

suspendAnswer (GSS) 2-47

suspendServerfarmRserver 2-39

suspendVirtualServer 2-28

syncDevice 2-55

T

TemplateDefinition 2-5

TemplateInput 2-6

TemplateInstance 2-6

U

User 2-7

V

VMMappingInfo 2-6

Vserver 2-7

W

webservices.log 4-1

Web Services Description Language 1-3

WSException 2-7

IN-2API Reference Guide for Cisco Application Networking Manager 5
.2.2
OL-27568-02

Documents

Web Service API Reference Guide for Cisco … · TemplateInstance 2-6 VMMappingInfo 2-6 Vserver ... † User Guide for the Cisco Application Networking Manager —Includes complete