API Reference Guide for Cisco Application Networking Manager 5.2 and 5.1
Web Service Objects
Downloads: This chapterpdf (PDF - 127.0KB) The complete bookPDF (PDF - 1.26MB) | Feedback

Web Service Objects

Table Of Contents

Web Service Objects

Answer

Checkpoints

DeviceID

DeviceType

DnsRule

MatchCondition

Rserver

Serverfarm

SessionToken

SfRserver

TemplateDefinition

TemplateInput

TemplateInstance

VMMappingInfo

Vserver

WSException


Web Service Objects


This chapter describes the data types that are defined structures or objects in the ANM Web Services API. Web Service objects perform the following functions:

Parse input parameters and validate their values

Invoke the appropriate ANM function

Assemble the returned result and pass it to the SOAP endpoint

Handle exceptions from the ANM by reporting the error to the client

This chapter describes the following Web Service objects:

Answer

Checkpoints

DeviceID

DeviceType

DnsRule

MatchCondition

Rserver

Serverfarm

SessionToken

SfRserver

TemplateDefinition

TemplateInput

TemplateInstance

VMMappingInfo

Vserver

WSException

Answer

This section lists and describes the Answer object attributes.

Attribute
Description

ipAddr

Answer IP address.

answerName

Answer name.

type

Answer type.

configState

Answer configuration state: Suspended or Active.

answerGroups

Assocciated answer group names.

location

Answer location.

device

Associated device.

operState

Answer operating state: OperationalSuspended, Suspended, Active, Failed, Unknown, or N/A.

pGssmTime

Date and time associated with the primary GGSM.


Checkpoints

This section lists and describes the Checkpoints object attributes.

Attribute
Description

name

Checkpoint file name.

size

Checkpoint file size.

date

Checkpoint file date.


DeviceID

This section lists and describes the DeviceID object attributes.

Attribute
Description

name

Virtual context name.

deviceType

Device type (see DeviceType).

ipAddress

Device IP address.

slot

Host chassis slot number.

chassisIPAddr

Host chassis IP address.


DeviceType

Table 3-1 lists the possible device types along with mandatory attributes for each type.

Table 3-1 Device Types and Mandatory Attributes 

 
DeviceType
name
chassisIpaddr
Ipadddr
slot

ACE Appliance

ACE4710

Appliance IP address

ACE Appliance Virtual Context

VIRTUAL_
CONTEXT

VC Name

Appliance IP address

ACE Module

ACE_BLADE

Chassis IP address

ACE Module slot

ACE Module Virtual Context

VIRTUAL_
CONTEXT

VC Name

Chassis IP address

ACE Module slot

CSS

CSS

CSS IP address

CSM

CSM

Chassis IP address

CSM Module slot

Chassis

CAT_6_K

Chassis IP address



Note The optional attributes are indicated by the dash (—).


DnsRule

This section lists and describes the DnsRule object attributes.

Attribute
Description

dnsRuleName

DNS rule name.

sourceAddress

DNS rule source IP address.

domains

Domains associate with the DNS rule.

dnsConfigState

DNS configuration state: Suspended or Active.

answerGroups

Answer group names to which the DNS rule belongs.

owner

DNS rule owner name.


MatchCondition

This section lists and describes the MatchCondition object attributes.

Attribute
Description

ipAddress

Server load balancing (SLB) is based on IP address.

protocol

SLB is based on protocol.

port

SLB is based on port number.


Rserver

This section lists and describes the Rserver object attributes.

Attribute
Description

name

Real server name.

type

Real server type: redirect or host.

ipAddress

Real server IP address.

state

Real server state: ISS, OOS, or IS.

weight

Real server weight.


Serverfarm

This section lists and describes the Serverfarm object attributes.

Attribute
Description

name

Server farm name.

serverFarmType

Server farm type: redirect or host.


SessionToken

This section lists and describes the SessionToken object attribute.

Attribute
Description

sid

Session ID.


SfRserver

This section lists and describes the SfRserver object attributes.

Attribute
Description

serverfarmName

Server farm name.

realserverName

Name of real server associated with the server farm.

adminState

Real server administrative state: ISS, OOS, or IS.

operationState

Real server operating state: STATUSFAILED, MAXLOAD, INACTIVE, STBY, ARPFAILED, RETURNCODEFAILED, INBANDPROBEFAILED, TESTWAIT, OPERWAIT, PROBETESTING, PROBEFAILED, THROTTLEDFP, THROTTLEMAXCLIENTS, THROTTLEMAXCONNECTIONS, TESTING, READYTOTEST, FAILED, UP, DOWN, or NA.

weight

Real server weight.

port

Real server port.

ipAddress

Real server IP address.

lastPolledTime

Date and time when the real server was last polled.


TemplateDefinition

This section lists and describes the TemplateDefinition object attributes.

Attribute
Description

id

Application template ID.

name

Application template name.

description

Application template description.

application

Application template application type: User Defined or System (Cisco defined)

appVersion

Application template version number.

createTime

Date and time that the application template was created.

createUser

Name of the user that created the application template.

updateTime

Date and time that the application template was modified.

updateUser

Name of the user who modified the application template.


TemplateInput

This section lists and describes the TemplateInput object attributes.

Attribute
Description

tagName

Name of the XML element: INPUT, LABEL, IMG, GROUP, VARIABLE, ARRAY, IF, ELSE, or ENUM.

name

Input element name.

type

Input element data type.

displayString

GUI variable field description.

defaultValue

Variable default setting.

userData

User input data.

userDatas

User input data array.

hasChild

Input element contains child elements.

childElements

Child element details.


TemplateInstance

This section lists and describes the TemplateInstance object attributes.

Attribute
Description

instanceID

Application template instance name.

templateName

Name of application template used to create the template instance.

applicationType

Type of application.

type

Template instance type: Deployed or Staged.

status

Template instance status: Complete or Incomplete.

deviceID

Virtual context associated with the template instance.

lastUpdatedTime

Last time that ANM retrieved the status information.


VMMappingInfo

This section lists and describes the VMMappingInfo object attributes.

Attribute
Description

deviceID

Device ID (see DeviceID).

sfname

Associated server farm name.

sfrsname

Associated server farm real server name.

port

Server farm real server port number.

ipaddr

Server farm real server IP address.


Vserver

This section lists and describes the Vserver object attribute.

Attribute
Description

virtualserverName

Virtual server name.

policyMapName

Policy map name.

matchConditions

SLB match conditions (see MatchCondition).

serverfarms

Server farms that the virtual server is associated with.

vlans

VLANs associated withe the virtual server.

adminState

Virtual server administrative state: Down, Up, or N/A.

operState

Virtual server operating state: OUTOFMEMORY, TESTREAL, STBINOPRREAL, INOPRREAL, STANDBY, UP, DOWN, or N/A.

lastPolledTime

Date and time when the virtual server was last polled.


WSException

This section lists and describes the WSException object attribute.

Attribute
Description

message

Web Services exception.