Cisco Unified Communications Manager XML Developers Guide, Release 8.5(1)
Administrative XML API
Downloads: This chapterpdf (PDF - 2.36MB) The complete bookPDF (PDF - 12.87MB) | Feedback

Administrative XML Programming

Table Of Contents

Administrative XML Programming

Overview

New and Changed Information

New and Changed Information in Unified CM Release 8.5(1)

New APIs

Changed APIs

Update to AXL Schema Versioning

New and Changed Information in Previous Releases of Unified CM

New Information for Unified CM 8.0(1)

New Information for Unified CM 7.1(2)

New APIs

Changed Operations

New Information for Unified CM 7.0(1)

New Information for Unified CM 6.1 (1)

New Information for Unified CM 6.0(1)

New Information for Unified CM 5.1(1)

New Information for Unified CM 5.0(1)

New Information for Unified CM 4.2(2)

New Information for Unified CM 4.1(2)

AXL Schema Documentation

AXL Versioning Support

Authentication

Data Encryption

Dynamic Throttling of Requests

AXL Data Throttling

Interaction

Integration Considerations and Interoperability

Post-Installation Steps and Troubleshooting on the Linux Platform

Post-Installation Steps

Starting the AXL Service

Setting AXL API Access Permissions

Post-Installation Troubleshooting Checklist

AXL Trace Logs

Using the AXL API with AXIS

Using the AXL API in a .NET Environment

Required Changes to the Generated Code

Backward Compatibility Issues

Tag Serialization Issues

Names Containing Special Characters

Returned Namespace for AXIS and .NET Applications

Example AXL Requests

C or C++ Example

Java Example

Using executeSQLUpdate

Using executeSQLQuery

AXL Error Codes


Administrative XML Programming


This chapter describes the Administrative XML Layer (AXL) Application Programming Interface (API). It contains the following sections:

Overview

New and Changed Information

AXL Schema Documentation

AXL Versioning Support

Data Encryption

Dynamic Throttling of Requests

Integration Considerations and Interoperability

Post-Installation Steps and Troubleshooting on the Linux Platform

Using the AXL API with AXIS

Using the AXL API in a .NET Environment

Returned Namespace for AXIS and .NET Applications

Example AXL Requests

AXL Error Codes

Overview

The AXL API provides a mechanism for inserting, retrieving, updating, and removing data from the Unified CM database by using an eXtensible Markup Language (XML) Simple Object Access Protocol (SOAP) interface. This approach allows a programmer to access the database by using XML and receive the data in XML form, instead of by using a binary library or DLL.

The AXL API methods, known as requests, use a combination of HTTPS and SOAP. SOAP is an XML remote procedure call (RPC) protocol. The server receives the XML structures and executes the request. If the request completes successfully, the system returns the appropriate AXL response. All responses are named identically to the associated requests, except that the word "Response" is appended.

For example, the XML response that is returned from an addPhone request is named addPhoneResponse.

If an error occurs, an XML error structure is returned, wrapped inside a SOAP Fault structure (see the "AXL Error Codes" section).

The AXL-SOAP web service is disabled by default on all Cisco Unified Communications Manager (Unified CM) servers that are running version 5.x or later. You should start the service before using the AXL APIs.

This chapter assumes that the developer has knowledge of a high-level programming language such as C++, Java, or an equivalent language, and has knowledge of SOAP.

Developers must also have knowledge or experience in the following areas:

TCP/IP Protocol

Hypertext Transport Protocol (specifically HTTPS)

Socket programming

XML

Users of the AXL API must have a firm grasp of XML syntax and Schema, which is used to define the AXL requests, responses, and errors. For more information about XML Schema, refer to http://www.w3.org/TR/xmlschema-0/. For more information about XML syntax/grammar, refer to http://www.w3.org/TR/rdf-syntax-grammar/.


Caution The AXL API allows you to modify the Unified CM system database. Use caution when using AXL because each API call affects the system. Misuse of the API can lead to dropped calls and slower performance. AXL should act as a provisioning and configuration API, not as a real-time API.

AXL Compliance

The Unified CM AXL implementation complies with XML Schema 1.0, which was tested for XML Schema compliance with a third-party application that is called XML Spy version 4.x. Early versions of the MSXML schema validator did not support enough of the XML Schema 1.0 recommendation to be used.

The Unified CM AXL implementation also complies with SOAP 1.1 as defined by the World Wide Web Consortium as well as HTTPS 1.1. The AXL API runs as an independent service that can be accessed only via HTTPS.

New and Changed Information

The following sections provide information on the changes in the AXL APIs in Unified CM release 8.5(1) and the previous releases:

New and Changed Information in Unified CM Release 8.5(1)

New and Changed Information in Previous Releases of Unified CM

For information on the new, changed, or deprecated AXL API methods from the interface library, see the Chapter 3 "Administrative XML Operations by Release".

New and Changed Information in Unified CM Release 8.5(1)

The AXL APIs in Unified CM release 8.5(1) are compatible with all previous releases of Unified CM. For additional details about the Unified CM database schema changes, refer to the Unified CM Data Dictionary for Release 8.5(1).

The following sections describe API changes in Unified CM release 8.5(1):

New APIs

Changed APIs

Update to AXL Schema Versioning

New APIs

Table 2-1 provides information on the new APIs in Unified CM release 8.5(1).

Table 2-1 New Operations in Unified CM 8.5(1) 

API
Operation
Added Tags

EnterpriseFeatureAccessCofiguration

addEnterpriseFeatureAccessCofiguration

getEnterpriseFeatureAccessCofiguration

listEnterpriseFeatureAccessCofiguration

removeEnterpriseFeatureAccessCofiguration

updateEnterpriseFeatureAccessCofiguration

pattern

routePartitionName

description

isDefaultEafNumber

HandOffConfiguration

addHandOffConfiguration

getHandOffConfiguration

removeHandOffConfiguration

updateHandOffConfiguration

pattern

routePartitionName

ImeLearnedRoutes

getImeLearnedRoutes

removeImeLearnedRoutes

updateImeLearnedRoutes

adminEnabled

domain

e164Did

expiresOn

learnedOn

signaling

LdapSync

doLdapSync

name

sync

LdapSyncStatus

getLdapSyncStatus

name

uuid

MobilityProfile

addMobilityProfile

getMobilityProfile

listMobilityProfile

removeMobilityProfile

updateMobilityProfile

description

dirn - pattern

dvofServiceAccessNumber

dvorCallerId

mobileClientCallingOption

name

routePartitionName

SoftkeySet

getSoftkeySet

updateSoftkeySet

name

callStates - callState - callStateName,softkeys

softkeys - softkey - potitionId, softkeyName

UpdateRemoteCluster

doUpdateRemoteCluster

server

clusterId


Changed APIs

Table 2-2 provides information on the modified APIs in Unified CM release 8.5(1).

Table 2-2 Changed Operations in Unified CM 8.5(1)

API
New tags
Deprecated tags

CommonPhoneConfig

featureControlPolicy

DeviceProfile

featureControlPolicy

doAuthenticateUser

daysToExpiry

FallbackFeatureConfig

clearImeCallDelayTimer

dtmfInterDigitDelayTimer

postConnectFallbackDelayTimer

fallbackSplitDelayTimer

H323Trunk

runOnEveryNode

destinations - destination - addressIpv4, sortOrder

ImeClient

ccmExternalIpMaps - ccmExternalIpMap - callManagerName, ipAddressHost, port

Phone

featureControlPolicy

RemoteDestination

mobilityProfileName

RouteList

runOnEveryNode

SipProfile

deliverConferenceBridgeIdentifier

earlyOfferSupportForVoiceCall

enableOutboundOptionsPing

optionsPingIntervalWhenStatusNotOK

optionsPingIntervalWhenStatusOK

sendRecvSDPInMidCallInvite

sipOptionsRetryCount

sipOptionsRetryTimer

SipTrunk

asn1RoseOidEncoding

destinations - destination - addressIpv4, addressIpv6, port, sortOrder

enableQsigUtf8

pathReplacementSupport

qsigVariant

runOnEveryNode

scriptParameters

scriptTraceEnabled

sipNormalizationScriptName

trunkTrafficSecure

tunneledProtocol

destinationAddress

destAddrIsSrv

destinationport

destinationAddressIpv6

sipTrunkType(unsupported only in update method)


Update to AXL Schema Versioning

The following changes are made in the version support matrix in Unified CM release 8.5(1):

The 8.5 schema is added.

The default schema when a SOAPAction header is not specified is now 7.0 (formerly 6.1).

For more information, see the AXL Versioning Support.

New and Changed Information in Previous Releases of Unified CM

The following sections provide the new and changed information in the older releases of Unified CM:

New Information for Unified CM 8.0(1)

New Information for Unified CM 7.1(2)

New Information for Unified CM 7.0(1)

New Information for Unified CM 6.1 (1)

New Information for Unified CM 6.0(1)

New Information for Unified CM 5.1(1)

New Information for Unified CM 5.0(1)

New Information for Unified CM 4.2(2)

New Information for Unified CM 4.1(2)

For information about new, changed, or deprecated AXL API methods from the interface library, see Chapter 3 "Administrative XML Operations by Release".

New Information for Unified CM 8.0(1)

Unified CM (Unified CM) 8.0(1) APIs are compatible with all previous releases of Unified CM. For additional details about the Unified CM database schema changes, refer to the Unified CM Data Dictionary for Release 8.0(1).

The following sections describe API updates in Unified CM 8.0(1):

New APIs

Changed APIs

Schema and Other Changes

New APIs

Table 2-3 describes new operations in Unified CM 8.0(1).

Table 2-3 New Operations in Unified CM 8.0(1) 

Operation
Purpose
Added Tags

addSafSecurityProfile
updateSafSecurityProfile
getSafSecurityProfile
removeSafSecurityProfile

To support Call Control Discovery feature

name (mandatory)

description

userid (mandatory)

password (mandatory)

addSafForwarder
updateSafForwarder
getSafForwarder
removeSafForwarder

To support Call Control Discovery feature

name(mandatory)

description

clientLabel (mandatory)

safSecurityProfile(mandatory)

ipAddress(mandatory)

port

safReconnectInterval

safNotificationsWindowSize

associatedCucms

associatedCucm (mandatory)

callManagerName (mandatory)

addCcdAdvertisingService

updateCcdAdvertisingService

getCcdAdvertisingService

removeCcdAdvertisingService

To support Call Control Discovery feature

name(mandatory)

description

isActivated

hostDnGroup(mandatory)

safSipTrunk(mandatory)

safH323Trunk(mandatory)

addCcdRequestingService

updateCcdRequestingService

getCcdRequestingService

removeCcdRequestingService

To support Call Control Discovery feature

name(mandatory)

description

isActivated

routePartitionName

learnedPatternPrefix

pstnPrefix

associatedTrunks

associatedTrunk(mandatory)

trunkName (mandatory)

addCcdHostedDN

updateCcdHostedDN

getCcdHostedDN

removeCcdHostedDN

To support Call Control Discovery feature

hostedPattern(mandatory)

description

CcdHostedDNGroup(mandatory)

pstnFailoverStripDigits

pstnFailoverPrependDigits

usePstnFailover

addCcdHostedDNGroup

updateCcdHostedDNGroup

getCcdHostedDNGroup

removeCcdHostedDNGroup

To support Call Control Discovery feature

name(mandatory)

description

pstnFailoverStripDigits

pstnFailoverPrependDigits

usePstnFailover

addSafCcdPurgeBlockLearnedRoutes

updateSafCcdPurgeBlockLearnedRoutes

getSafCcdPurgeBlockLearnedRoutes

removeSafCcdPurgeBlockLearnedRoutes

To support Call Control Discovery feature

learnedPattern

learnedPatternPrefix

callControlIdentity

ipAddress.

updateInterClusterServiceProfile

getInterClusterServiceProfile

To support Extension Mobility Cross Clusters feature

interClusterService (mandatory)

isActivated

sipTrunkName

addRemoteCluster

updateRemoteCluster

getRemoteCluster

removeRemoteCluster

To support Extension Mobility Cross Clusters feature

clusterId(mandatory)

description

fullyQualifiedName(mandatory)

iemcc

enabled(mandatory)

pstnAccess

enabled(mandatory)

rsvpAgent

   

enabled(mandatory)

addExternalCallControlProfile

updateExternalCallControlProfile

getExternalCallControlProfile

removeExternalCallControlProfile

To support Call Intercept feature

name (mandatory)

primaryUri(mandatory)

secondaryURI

enableDigestAuthSecondary

appUserDigestUserSecondary

enableLoadBalancing

routingRequestTimer

diversionReroutingCssName

callTreatmentOnFailure (mandatory)

addCumaServerSecurityProfile

updateCumaServerSecurityProfile

getCumaServerSecurityProfile

removeCumaServerSecurityProfile

To support Mobility SIP Extension feature

name (mandatory)

description

securityMode

transportType(mandatory)

x509SubjectName

serverIpHostName (mandatory)

addImeClient

updateImeClient

getImeClient

removeImeClient

To support Unified B2B Link feature

name(mandatory)

description

domain(mandatory)

isActivated

sipTrunkName(mandatory)

primaryImeServerName(mandatory)

secondaryImeServerName

learnedRouteFilterGroupName

exclusionNumberGroupName

firewallName

members

member

enrolledPatternGroupName

addImeE164Transformation

updateImeE164Transformation

getImeE164Transformation

removeImeE164Transformation

To support Unified B2B Link feature

name(mandatory)

description

cgpnTransformationCssName

isCgpnPreTransformation

cdpnTransformationCssName

isCdpnPreTransformation

   

isCdpnPreTransformation

incomingCgpnTransformationProfileName

incomingCdpnTransformationProfileName

addImeRouteFilterGroup

updateImeRouteFilterGroup

getImeRouteFilterGroup

removeImeRouteFilterGroup

To support Unified B2B Link feature

name(mandatory)

description

groupTrustSetting

addImeRouteFilterElement

updateImeRouteFilterElement

getImeRouteFilterElement

removeImeRouteFilterElement

To support Unified B2B Link feature

name(mandatory)

description

elementType

imeRouteFilterGroupName(mandatory)

addImeEnrolledPattern

updateImeEnrolledPattern

getImeEnrolledPattern

removeImeEnrolledPattern

To support Unified B2B Link feature

pattern

description

imeEnrolledPatternGroupName(mandatory)

addImeEnrolledPatternGroup

updateImeEnrolledPatternGroup

getImeEnrolledPatternGroup

removeImeEnrolledPatternGroup

To support Unified B2B Link feature

name(mandatory)

description

fallbackProfileName

isPatternAllAlias

addImeExclusionNumber

updateImeExclusionNumber

getImeExclusionNumber

removeImeExclusionNumber

To support Unified B2B Link feature

pattern(mandatory)

description

imeExclusionNumberGroupName(mandatory)

addImeExclusionNumberGroup

updateImeExclusionNumber

getImeExclusionNumber

removeImeExclusionNumber

To support Unified B2B Link feature

name(mandatory)

description

addImeFirewall

updateImeFirewall

getImeFirewall

removeImeFirewall

To support Unified B2B Link feature

name(mandatory)

description

ipAddress(mandatory)

port

addImeServer

updateImeServer

getImeServer

removeImeServer

To support Unified B2B Link feature

name(mandatory)

description

ipAddress(mandatory)

port

deviceSecurityMode

applicationUser(mandatory)

reconnectInterval

addFallbackProfile

updateFallbackProfile

getFallbackProfile

removeFallbackProfile

To support Unified B2B Link feature

name(mandatory)

description

advertisedFallbackDirectoryE164Number

QosSensistivityLevel

callCss(mandatory)

callAnswerTimer

directoryNumberPartition

directoryNumber

numberOfDigitsforCallerIDPartialMatch

addPhoneNTP

updatePhoneNTP

getPhoneNTP

removePhoneNTP

To add, update, get, and remove PhoneNTP

ipAddress

description

mode(mandatory)

addDateTimeGroup

getDateTimeGroup

removeDateTimeGroup

To add, get, and remove DateTimeGroup

name(mandatory)

timeZone(mandatory)

separator(mandatory)

dateformat(mandatory)

timeformat(mandatory)

phoneNtpReferences

selectedPhoneNtpReference

phoneNtpName(mandatory)

selectionOrder(mandatory)

updateDateTimeGroup

To update DateTimeGroup

newName

timeZone

separator

dateformat

timeFormat

removePhoneNtpReferences

selectedPhoneNtpReference(mandatory)

phoneNtpName(mandatory)

selectionOrder(mandatory)

addPhoneNtpReferences

selectedPhoneNtpReference(mandatory)

phoneNtpName(mandatory)

selectionOrder(mandatory)

phoneNtpReferences

selectedPhoneNtpReference(mandatory)

phoneNtpName(mandatory)

selectionOrder(mandatory)

addPresenceGroup

updatePresenceGroup

getPresenceGroup

removePresenceGroup

To add, update, get, and remove PresenceGroup

name(mandatory)

description

presenceGroups

presenceGroup

presenceGroupName(mandatory)

subscriptionPermission(mandatory)

addMlppDomain

updateMlppDomain

getMlppDomain

removeMlppDomain

To add, update, get and remove MlppDomain

domainName(mandatory)

domainId(mandatory)

addPhoneSecurityProfile

updatePhoneSecurityProfile

getPhoneSecurityProfile

removePhoneSecurityProfile

To add, update, get, and remove PhoneSecurityProfile

phoneType(mandatory)

protocol(mandatory)

name(mandatory)

description

deviceSecurityMode

authenticationMode

keySize

tftpEncryptedConfig

   

nonceValidityTime

transportType

sipPhonePort

enableDigestAuthentication

excludeDigestCredentials

addApplicationServer

getApplicationServer

removeApplicationServer

To add, get, and remove ApplicationServer

appServerType(mandatory)

name(mandatory)

ipAddress

appUsers

selectedAppUser(mandatory)

appUserName(mandatory)

content

url

endUserUrl

processNodeName

endUsers

selectedEndUser(mandatory)

endUserName(mandatory)

content

updateApplicationServer

To update ApplicationServer

newName

ipAddress

removeAppUsers

selectedAppUser(mandatory)

appUserName(mandatory)

content

addAppUsers

selectedAppUser(mandatory)

appUserName(mandatory)

content

appUsers

selectedAppUser(mandatory)

appUserName(mandatory)

content

addAppDialRules

getAppDialRules

updateAppDialRules

removeAppDialRules

To add, update, get, and remove appDialRules

name (Mandatory)

description

numberBeginWith

numberOfDigits (Mandatory)

digitsToBeRemoved (Mandatory)

prefixPattern

priority (Mandatory)

addDirectoryLookupDialRules

getDirectoryLookupDialRules

updateDirectoryLookupDialRules

removeDirectoryLookupDialRules

To add, update, get, and remove DirectoryLookupDialRules

name (Mandatory)

description

numberBeginWith

numberOfDigits (Mandatory)

digitsToBeRemoved (Mandatory)

prefixPattern

priority (Mandatory)

addSipDialRules

getSipDialRules

updateSipDialRules

removeSipDialRules

To add, update, get, and remove SipDialRules

dialPattern (Mandatory)

name (Mandatory)

description

patterns

plars

updateAnnunciator

getAnnunciator

To update, and get Annunciator

name (Mandatory)

description

devicePoolName

locationName

useTrustedRelayPoint

addMtp

getMtp

updateMtp

removeMtp

To add, update, get, and remove Mtp

mtpType (Mandatory)

name (Mandatory)

description

devicePoolName (Mandatory)

useTrustedRelayPoint

getMohAudioSource

updateMohAudioSource

removeMohAudioSource

To update, get, and remove MohAudioSource

sourceId (Mandatory)

newName

sourceFile

multicast

repeat

updateFixedMohAudioSource

To update FixedMohAudioSource

name (Mandatory)

multicast

enable

getFixedMohAudioSource

To get FixedMohAudioSource

sourceId

name

multicast

enable

addMessageWaiting

getMessageWaiting

updateMessageWaiting

removeMessageWaiting

To add, update, get, and remove MessageWaiting

pattern (Mandatory)

routePartitionName (Mandatory)

description

messageWaitingIndicator (Mandatory)

callingSearchSpaceName

addDefaultDeviceProfile

getDefaultDeviceProfile

updateDefaultDeviceProfile

removeDefaultDeviceProfile

To add, update, get, and remove DefaultDeviceProfile

name (Mandatory)

description

product (Mandatory)

class (Mandatory)

protocol (Mandatory)

protocolSide (Mandatory)

userHoldMOHAudioSourceId

userLocale

phoneButtonTemplate (Mandatory)

softkeyTemplate (Mandatory)

privacy (Mandatory)

singleButtonBarge

joinAcrossLines

ignorePi

dndStatus

dndRingSetting

dndOption

mlppDomainId

mlppIndication (Mandatory)

preemption (Mandatory)

alwaysUsePrimeLine

alwaysUsePrimeLineForVoiceMessage

emccCallingSearchSpace

addIpPhoneServices

getIpPhoneServices

updateIpPhoneServices

removeIpPhoneServices

To add, update, get, and remove IpPhoneServices

serviceName (Mandatory)

asciiServiceName (Mandatory)

serviceDescription

serviceUrl (Mandatory)

secureServiceUrl

serviceCategory (Mandatory)

serviceType (Mandatory)

serviceVendor

serviceVersion

enabled

enterpriseSubscription

parameters

parameter (Mandatory)

name (Mandatory)

displayName (Mandatory)

default

description (Mandatory)

paramRequired

paramPassword

addCiscoCatalyst600024PortFXSGateway

getCiscoCatalyst600024PortFXSGateway

updateCiscoCatalyst600024PortFXSGateway

removeCiscoCatalyst600024PortFXSGateway

To add, update, get, and remove CiscoCatalyst600024PortFXSGateway

name(mandatory)

description

product(mandatory)

class(mandatory)

protocol(mandatory)

protocolSide(mandatory)

callingSearchSpaceName

devicePoolName(mandatory)

commonDeviceConfigName

networkLocale

locationName(mandatory)

mediaResourceListName

automatedAlternateRoutingCssName

aarNeighborhoodName

loadInformation

vendorConfig

   

traceFlag

mlppDomainId

useTrustedRelayPoint

cgpnTransformationCssName

useDevicePoolCgpnTransformCss

geoLocationName

ports

port(mandatory)

portNumber(mandatory)

attendantDn

unattendedPort

callerIdDn

callerIdEnable(mandatory)

callingPartySelection

digitSending

expectedDigits(mandatory)

sigDigits(mandatory)

lines

prefixDn

presentationBit

silenceSuppressionThreshold

smdiPortNumber(mandatory)

startDialProtocol

trunk

trunkDirection(mandatory)

trunkLevel

trunkPadRx

trunkPadTx

vendorConfig

timer1(mandatory)

timer2(mandatory)

timer3(mandatory)

timer4(mandatory)

timer5(mandatory)

timer6(mandatory)

   

portSelectionOrder(mandatory)

transmitUtf8

geoLocationFilterName

addCiscoCatalyst6000T1VoIPGatewayT1

getCiscoCatalyst6000T1VoIPGatewayT1

updateCiscoCatalyst6000T1VoIPGatewayT1

removeCiscoCatalyst6000T1VoIPGatewayT1

To add, update, get, and remove CiscoCatalyst6000T1VoIPGatewayT1

name(mandatory)

description

product(mandatory)

class(mandatory)

protocol(mandatory)

protocolSide(mandatory)

callingSearchSpaceName(mandatory)

devicePoolName(mandatory)

commonDeviceConfigName(mandatory)

networkLocation

locationName(mandatory)

mediaResourceListName(mandatory)

automatedAlternateRoutingCSSName(mandatory)

aarNeighborhoodName(mandatory)

loadInformation

vendorConfig

traceFlag

mlppDomainId

mlppIndicationStatus

preemption

useTrustedRelayPoint

retryVideoCallAsAudio

cgpnTransformationCSSName(mandatory)

useDevicePoolCgpnTransformCSS

geoLocationName(mandatory)

sendGeoLocation(mandatory)

ports

port(mandatory)

portNumber(mandatory)

attendantDn

unattendedPort

   

callerIdDn

callerIdEnable(mandatory)

callingPartySelection(mandatory)

digitSending(mandatory)

expectedDigits(mandatory)

sigDigits(mandatory)

prefixDn(mandatory)

presentationBit(mandatory)

silenceSuppressionThreshold(mandatory)

startDialProtocol

trunk(mandatory)

trunkDirection(mandatory)

trunkLevel(mandatory)

trunkPadRx(mandatory)

trunkPadTx(mandatory)

vendorConfig

callerId(mandatory)

endpointId

timer1

timer2

timer3

timer4

timer5

timer6

trunkSelectionOrder(mandatory)

clockReference(mandatory)

csuParam(mandatory)

digitSending(mandatory)

pcmType(mandatory)

fdlChannel(mandatory)

yellowAlarm(mandatory)

zeroSuppression(mandatory)

smdiBasePort(mandatory)

handlerDtmfPrecedenceSignals

cdpnTransformationCssName(mandatory)

   

useDevicePoolCdpnTransformCss

geoLocationFilterName(mandatory)

pstnAccess

imeE164TransformationName

addSrst

updateSrst

removeSrst

To add, update, and remove Srst

name(mandatory)

port(mandatory)

ipAddress(mandatory)

SipNetwork

SipPort(mandatory)

isSecure

getSrst

To get Srst

name

port

ipAddress

SipNetwork

SipPort

srstCertificatePort

isSecure

addApplicationUserCapfProfile

updateApplicationUserCapfProfile

removeApplicationUserCapfProfile

To add, update, and remove ApplicationUserCapfProfile

applicationUser(mandatory)

instanceId(mandatory)

certificateOperation(mandatory)

authenticationMode(mandatory)

authenticationString

keySize(mandatory)

operationCompletion

getApplicationUserCapfProfile

To get ApplicationUserCapfProfile

applicationUser

instanceId

certificateOperation

authenticationMode

authenticationString

keySize

operationCompletion

certificateOperationStatus

addEndUserCapfProfile

updateEndUserCapfProfile

removeEndUserCapfProfile

To add, update, and remove EndUserCapfProfile

endUserId(mandatory)
instanceId(mandatory)
certificateOperation(mandatory)
authenticationMode(mandatory)

   

authenticationString

keySize(mandatory)
operationCompletion

getEndUserCapfProfile

To get EndUserCapfProfile

endUserId

instanceId

certificateOperation

authenticationMode

authenticationString

keySize

operationCompletion

certificateOperationStatus

addUserPhoneAssociation

To add UserPhoneAssociation

userId(mandatory)

password

pin

lastName(mandatory)

middleName

firstName

productType(mandatory)

name(mandatory)

dnCssName

phoneCssName

e164Mask(mandatory)

extension(mandatory)

routePartitionName

voiceMailProfileName

enableExtensionMobility

addGateway

getGateway

removeGateway

updateGateway

To add, update, get, and remove Gateway

domainName(mandatory)

description

product(mandatory)

protocol(mandatory)

callManagerGroupName(mandatory)

units

unit

index(mandatory)

product(mandatory)

   

subunits

subunit

index(mandatory)

product(mandatory)

beginPort

vendorConfig

addGatewayEndpointAnalogAccess

getGatewayEndpointAnalogAccess

updateGatewayEndpointAnalogAccess

removeGatewayEndpointAnalogAccess

To add, update, get, and remove GatewayEndpointAnalogAccess

domainName(mandatory)

gatewayUuid(mandatory)

unit(mandatory)

subunit(mandatory)

endpoint(mandatory)

index(mandatory)

name(mandatory)

description

product(mandatory)

model

class(mandatory)

protocol(mandatory)

protocolSide(mandatory)

callingSearchSpaceName

devicePoolName(mandatory)

commonDeviceConfigName

networkLocale

locationName(mandatory)

mediaResourceListName

automatedAlternateRoutingCssName

aarNeighborhoodName

vendorConfig

mlppDomainId

useTrustedRelayPoint

retryVideoCallAsAudio

useDevicePoolCgpnTransformCss

geoLocationName

geoLocationFilterName

port(mandatory)

   

portNumber(mandatory)

attendantDn

unattendedPort

callerIdDn

callerIdEnable(mandatory)

callingPartySelection

digitSending

expectedDigits(mandatory)

sigDigits(mandatory)

lines

prefixDn

presentationBit

silenceSuppressionThreshold

smdiPortNumber(mandatory)

startDialProtocol

trunk

trunkDirection(mandatory)

trunkLevel

trunkPadRx

trunkPadTx

vendorConfig

timer1(mandatory)

timer2(mandatory)

timer3(mandatory)

timer4(mandatory)

timer5(mandatory)

timer6(mandatory)

trunkSelectionOrder(mandatory)

transmitUtf8

cdpnTransformationCssName

useDevicePoolCdpnTransformCss

callingPartyNumberPrefix

callingPartyStripDigits

callingPartyTransformationCssName

hotlineDevice

   

packetCaptureMode

packetCaptureDuration

pstnAccess

imeE164TransformationName

imeE164DirectoryNumber

addGatewayEndpointDigitalAccessPri

getGatewayEndpointDigitalAccessPri

updateGatewayEndpointDigitalAccessPri

removeGatewayEndpointDigitalAccessPri

To add, update, get, and remove GatewayEndpointDigitalAccessPri

domainName (Mandatory)

gatewayUuid (Mandatory)

unit (Mandatory)

subunit (Mandatory)

endpoint (Mandatory)

index (Mandatory)

name (Mandatory)

description

product(Mandatory)

class(Mandatory)

protocol(Mandatory)

protocolSide(Mandatory)

callingSearchSpaceName(Mandatory)

devicePoolName(Mandatory)

commonDeviceConfigName(Mandatory)

networkLocation

locationName(Mandatory)

networkLocale

mediaResourceListName(Mandatory)

automatedAlternateRoutingCssName(Mandatory)

aarNeighborhoodName(Mandatory)

loadInformation

vendorConfig

mlppDomainId

mlppIndicationStatus

mlppPreemption

useTrustedRelayPoint

cgpnTransformationCssName(Mandatory)

useDevicePoolCgpnTransformCss

   

geoLocationName(Mandatory)

redirectInboundNumberIe(Mandatory)

calledPlan(Mandatory)

calledPri(Mandatory)

callerIdDn(Mandatory)

callingPartySelection(Mandatory)

callingPlan(Mandatory)

callingPri(Mandatory)

chanIE(Mandatory)

clockReference(Mandatory)

dChannelEnable(Mandatory)

channelSelectionOrder(Mandatory)

displayIe(Mandatory)

pcmType(Mandatory)

csuParam(Mandatory)

firstDelay(Mandatory)

interfaceIdPresent(Mandatory)

interfaceId(Mandatory)

intraDelay(Mandatory)

mcdnEnable(Mandatory)

redirectOutboundNumberIe(Mandatory)

numDigitsToStrip(Mandatory)

passingPrecedenceLevelThrough(Mandatory)

prefix(Mandatory)

callingLinePresentationBit(Mandatory)

connectedLineIdPresentation(Mandatory)

priProtocol(Mandatory)

securityAccessLevel(Mandatory)

sendCallingNameInFacilityIe(Mandatory)

sendExLeadingCharInDispIe(Mandatory)

sendRestart(Mandatory)

setupNonIsdnPi(Mandatory)

sigDigits(Mandatory)

span(Mandatory)

   

statusPoll(Mandatory)

smdiBasePort(Mandatory)

GClearEnable(Mandatory)

packetCaptureMode

packetCaptureDuration

transmitUtf8

v150

asn1RoseOidEncoding

qsigVariant

unattendedPort

cdpnTransformationCssName

useDevicePoolCdpnTransformCss

nationalPrefix

internationalPrefix

unknownPrefix

subscriberPrefix

geoLocationFilterName

routeClassSignalling

nationalStripDigits

internationalStripDigits

unknownStripDigits

subscriberStripDigits

nationalTransformationCssName

internationalTransformationCssName

unknownTransformationCssName

subscriberTransformationCssName

pstnAccess

imeE164TransformationName

addGatewayEndpointDigitalAccessBri

getGatewayEndpointDigitalAccessBri

updateGatewayEndpointDigitalAccessBri

remoevGatewayEndpointDigitalAccessBri

To add, update, get, and remove GatewayEndpointDigitalAccessBri

domainName(Mandatory)

gatewayUuid(Mandatory)

unit(Mandatory)

subunit(Mandatory)

endpoint(Mandatory)

index(Mandatory)

name(Mandatory)

   

description

product(Mandatory)

class(Mandatory)

protocol(Mandatory)

protocolSide(Mandatory)

callingSearchSpaceName(Mandatory)

devicePoolName(Mandatory)

commonDeviceConfigName(Mandatory)

networkLocation

locationName(Mandatory)

mediaResourceListName(Mandatory)

networkLocale

automatedAlternateRoutingCssName(Mandatory)

aarNeighborhoodName(Mandatory)

vendorConfig

cgpnTransformationCssName(Mandatory)

useDevicePoolCgpnTransformCss

geoLocationName(Mandatory)

redirectInboundNumberIe(Mandatory)

briProtocol(Mandatory)

calledPlan(Mandatory)

calledPri(Mandatory)

callerIdDn(Mandatory)

callingPartySelection(Mandatory)

callingPlan(Mandatory)

callingPri(Mandatory)

clockReference(Mandatory)

csuParam(Mandatory)

dChannelEnable(Mandatory)

channelSelectionOrder(Mandatory)

pcmType(Mandatory)

firstDelay(Mandatory)

intraDelay(Mandatory)

redirectOutboundNumberIe(Mandatory)

   

numDigitsToStrip(Mandatory)

prefix(Mandatory)

presentationBit(Mandatory)

sendRestart(Mandatory)

setupNonIsdnPi(Mandatory)

sigDigits(Mandatory)

statusPoll(Mandatory)

packetCaptureMode

packetCaptureDuration

cdpnTransformationCssName

useDevicePoolCdpnTransformCss

geoLocationFilterName

nationalPrefix

internationalPrefix

unknownPrefix

subscriberPrefix

nationalStripDigits

internationalStripDigits

unknownStripDigits

subscriberStripDigits

nationalTransformationCssName

internationalTransformationCssName

unknownTransformationCssName

subscriberTransformationCssName

pstnAccess

imeE164TransformationName

addGatewayEndpointDigitalAccessT1

getGatewayEndpointDigitalAccessT1

removeGatewayEndpointDigitalAccessT1

updateGatewayEndpointDigitalAccessT1

To add, update, get, and remove GatewayEndpointDigitalAccessT1

domainName(mandatory)

gatewayUuid(mandatory)

unit(mandatory)

subUnit(mandatory)

endpoint(mandatory)

index(mandatory)

name(mandatory)

description

product(mandatory)

   

class(mandatory)

protocol(mandatory)

protocolSide(mandatory)

callingSearchSpaceName(mandatory)

devicePoolName(mandatory)

commonDeviceConfigName(mandatory)

networkLocation

locationName(mandatory)

mediaResourceListName(mandatory)

automatedAlternateRoutingCssName(mandatory)

aarNeighborhoodName(mandatory)

loadInformation

vendorConfig

traceFlag

mlppDomainId

mlppIndicationStatus

preemption

useTrustedRelayPoint

retryVideoCallAsAudio

cgpnTransformationCssName(mandatory)

useDevicePoolCgpnTransformCss

geoLocationName(mandatory)

sendGeoLocation(mandatory)

cdpnTransformationCssName(mandatory)

useDevicePoolCdpnTransformCss

v150

geoLocationFilterName

ports

port

portNumber(mandatory)

attendantDn

unattendedPort

callerIdDn

callerIdEnable(mandatory)

   

callingPartySelection(mandatory)

digitSending(mandatory)

expectedDigits(mandatory)

sigDigits(mandatory)

prefixDn(mandatory)

presentationBit(mandatory)

silenceSuppressionThreshold(mandatory)

startDialProtocol(mandatory)

trunk(mandatory)

trunkDirection(mandatory)

trunkLevel(mandatory)

trunkPadRx(mandatory)

trunkPadTx(mandatory)

vendorConfig

callerId

endPointId

timer1

timer2

timer3

timer4

timer5

timer6

trunkSelectionOrder(mandatory)

clockReference(mandatory)

csuParam(mandatory)

digitSending(mandatory)

pcmType(mandatory)
fdlChannel(mandatory)
yellowAlarm(mandatory)
zeroSuppresion(mandatory)
smdiBasePort(mandatory)
handleDtmfPrecedenceSignals
encodeOutboundVoiceRouteClass

routeClassSignalling(mandatory)

pstnAccess

imeE164TransformationName

addCiscoCatalyst6000E1VoIPGateway

getCiscoCatalyst6000E1VoIPGateway

updateCiscoCatalyst6000E1VoIPGateway

removeCiscoCatalyst6000E1VoIPGateway

To add, update, get, and remove CiscoCatalyst6000E1VoIPGateway

name(mandatory)

description

product(mandatory)

class(mandatory)

protocol(mandatory)

protocolSide(mandatory)

callingSearchSpaceName(mandatory)

devicePoolName(mandatory)

commonDeviceConfigName(mandatory)

networkLocation

locationName(mandatory)

networkLocale

mediaResourceListName(mandatory)

automatedAlternateRoutingCssName(mandatory)

aarNeighborhoodName(mandatory)

loadInformation

vendorConfig

mlppDomainId

useTrustedRelayPoint

cgpnTransformationCssName(mandatory)

useDevicePoolCgpnTransformCss

geoLocationName(mandatory)

redirectInboundNumberIe(mandatory)

calledPlan(mandatory)

calledPri(mandatory)

callerIdDn(mandatory)

callingPartySelection(mandatory)

callingPlan(mandatory)

callingPri(mandatory)

chanIe(mandatory)

clockReference(mandatory)

dChannelEnable(mandatory)

channelSelectionOrder(mandatory)

displayIE(mandatory)

pcmType(mandatory)

   

csuParam(mandatory)

firstDelay(mandatory)

interfaceIdPresent(mandatory)

interfaceId(mandatory)

intraDelay(mandatory)

mcdnEnable(mandatory)

redirectOutboundNumberIe(mandatory)

numDigitsToStrip(mandatory)

passingPrecedenceLevelThrough(mandatory)

prefix(mandatory)

callingLinePresentationBit(mandatory)

connectedLineIdPresentation(mandatory)

priProtocol(mandatory)

securityAccessLevel(mandatory)

sendCallingNameInFacilityIe(mandatory)

sendExLeadingCharInDispIe(mandatory)

sendRestart(mandatory)

setupNonIsdnPi(mandatory)

sigDigits(mandatory)

span(mandatory)

statusPoll(mandatory)

smdiBasePort(mandatory)

packetCaptureMode

packetCaptureDuration

transmitUtf8

v150

asn1RoseOidEncoding

QSIGVariant

unattendedPort

cdpnTransformationCssName

useDevicePoolCdpnTransformCss

nationalPrefix

internationalPrefix

unknownPrefix

   

subscriberPrefix

geoLocationFilterName

nationalStripDigits

internationalStripDigits

unknownStripDigits

subscriberStripDigits

nationalTransformationCssName

internationalTransformationCssName

unknownTransformationCssName

subscriberTransformationCssName

useDevicePoolCgpnTransformCssNatl

useDevicePoolCgpnTransformCssIntl

useDevicePoolCgpnTransformCssUnkn

useDevicePoolCgpnTransformCssSubs

pstnAccess

imeE164TransformationName

addCiscoCatalyst6000T1VoIPGatewayPri

getCiscoCatalyst6000T1VoIPGatewayPri

updateCiscoCatalyst6000T1VoIPGatewayPri

removeCiscoCatalyst6000T1VoIPGatewayPri

To add, update, get, and remove CiscoCatalyst6000T1VoIPGatewayPri

name(Mandatory)

description

product(Mandatory)

class(Mandatory)

protocol(Mandatory)

protocolSide(Mandatory)

callingSearchSpaceName(Mandatory)

devicePoolName(Mandatory)

commonDeviceConfigName(Mandatory)
networkLocation
locationName(Mandatory)
networkLocale
mediaResourceListName(Mandatory)
automatedAlternateRoutingCssName(Mandatory)
aarNeighborhoodName(Mandatory)

loadInformation

vendorConfig

mlppDomainId

mlppIndicationStatus

   

mlppPreemption

useTrustedRelayPoint

cgpnTransformationCssName(Mandatory)

useDevicePoolCgpnTransformCss

geoLocationName(Mandatory)

redirectInboundNumberIe(Mandatory)

calledPlan(Mandatory)

calledPri(Mandatory)

callerIdDn(Mandatory)

callingPartySelection(Mandatory)

callingPlan(Mandatory)

callingPri(Mandatory)

chanIe(Mandatory)

clockReference(Mandatory)

dChannelEnable(Mandatory)

channelSelectionOrder(Mandatory)

displayIE(Mandatory)

pcmType (Mandatory)

csuParam(Mandatory)

firstDelay(Mandatory)

interfaceIdPresent(Mandatory)

interfaceId(Mandatory)

intraDelay(Mandatory)

mcdnEnable(Mandatory)

redirectOutboundNumberIe(Mandatory)

numDigitsToStrip(Mandatory)

passingPrecedenceLevelThrough(Mandatory)

prefix(Mandatory)

callingLinePresentationBit(Mandatory)

connectedLineIdPresentation(Mandatory)

priProtocol(Mandatory)

securityAccessLevel(Mandatory)

sendCallingNameInFacilityIe(Mandatory)

sendExLeadingCharInDispIe(Mandatory)

   

sendRestart(Mandatory)

setupNonIsdnPi(Mandatory)

sigDigits(Mandatory)

span(Mandatory)

statusPoll(Mandatory)

smdiBasePort(Mandatory)

packetCaptureMode

packetCaptureDuration

transmitUtf8

v150

asn1RoseOidEncoding

QSIGVariant

unattendedPort

cdpnTransformationCssName

useDevicePoolCdpnTransformCss

nationalPrefix

internationalPrefix

unknownPrefix

subscriberPrefix

geoLocationFilterName

nationalStripDigits

internationalStripDigits

unknownStripDigits

subscriberStripDigits

nationalTransformationCssName

internationalTransformationCssName

unknownTransformationCssName

subscriberTransformationCssName

useDevicePoolCgpnTransformCssNatl

useDevicePoolCgpnTransformCssIntl

useDevicePoolCgpnTransformCssUnkn

useDevicePoolCgpnTransformCssSubs

pstnAccess

imeE164TransformationName

addCiscoCatalyst6000T1VoIPGatewayT1

getCiscoCatalyst6000T1VoIPGatewayT1

updateCiscoCatalyst6000T1VoIPGatewayT1

removeCiscoCatalyst6000T1VoIPGatewayT1

To add, update, get, and remove CiscoCatalyst6000T1VoIPGatewayT1

name(Mandatory)

description

product(Mandatory)

class(Mandatory)

protocol(Mandatory)

protocolSide(Mandatory)

callingSearchSpaceName(Mandatory)

devicePoolName(Mandatory)

commonDeviceConfigName(Mandatory)

networkLocation

locationName(Mandatory)

mediaResourceListName(Mandatory)

automatedAlternateRoutingCssName(Mandatory)

aarNeighborhoodName(Mandatory)

loadInformation

vendorConfig

traceFlag

mlppDomainIdmlppIndicationStatus

preemption

useTrustedRelayPoint

retryVideoCallAsAudio

cgpnTransformationCssName(Mandatory)

useDevicePoolCgpnTransformCss

geoLocationName(Mandatory)

sendGeoLocation(Mandatory)

ports

port(Mandatory)

portNumber(Mandatory)

attendantDn

unattendedPort

callerIdDn

callerIdEnable(Mandatory)

callingPartySelection(Mandatory)

   

digitSending(Mandatory)

expectedDigits(Mandatory)

sigDigits(Mandatory)

prefixDn(Mandatory)

presentationBit(Mandatory)

silenceSuppressionThreshold(Mandatory)

startDialProtocol(Mandatory)

trunk(Mandatory)

trunkDirection(Mandatory)

trunkLevel(Mandatory)

trunkPadRx(Mandatory)

trunkPadTx(Mandatory)

vendorConfig

callerId(Mandatory)

endpointId

timer1

timer2

timer3

timer4

timer5

timer6

trunkSelectionOrder(Mandatory)

clockReference(Mandatory)

csuParam(Mandatory)

digitSending(Mandatory)

pcmType(Mandatory)

fdlChannel(Mandatory)

yellowAlarm(Mandatory)

zeroSupression(Mandatory)

smdiBasePort(Mandatory)

handleDtmfPrecedenceSignals

cdpnTransformationCssName(Mandatory)

useDevicePoolCdpnTransformCss

geoLocationFilterName(Mandatory)

   

pstnAccess

imeE164TransformationName

listRoutePlan

To list RoutePlan

dnOrPattern

partition

type

routeDetail

addCallingPartyTransformationPattern

updateCallingPartyTransformationPattern

removeCallingPartyTransformationPattern

To add, update, and remove CallingPartyTransformationPattern

pattern(mandatory)

description

routePartitionName(mandatory)

callingPartyTransformationMask

useCallingPartyPhoneMask

dialPlanName

digitDiscardInstructionName

callingPartyPrefixDigits

routeFilterName

callingLinePresentationBit

callingPartyNumberingPlan

callingPartyNumberType

getCallingPartyTransformationPattern

To get CallingPartyTransformationPattern

pattern

description

usage

routePartitionName

callingPartyTransformationMask

useCallingPartyPhoneMask

dialPlanName

digitDiscardInstructionName

patternUrgency

callingPartyPrefixDigits

routeFilterName

callingLinePresentationBit

callingPartyNumberingPlan

callingPartyNumberType

addUnitsToGateway

removeUnitsToGateway

To add, and removeUnitsToGateway

domainName(mandatory)

gatewayUuid(mandatory)

units(mandatory)

unit(mandatory)

index(mandatory)

product(mandatory)

subunits

subunit(mandatory)

index(mandatory)

product(mandatory)

beginPort

addGatewaySubunits

removeGatewaySubunits

To add, and remove GatewaySubunits

domainName(mandatory)

gatewayUuid(mandatory)

unit(mandatory)

subunits(mandatory)

subunit(mandatory)

index(mandatory)

product(mandatory)

beginPort

addLdapDirectory

getLdapDirectory

updateLdapDirectory

removeLdapDirectory

To add, update, get, and remove LdapDirectory

name(mandatory)

ldapDn(mandatory)

ldapPassword(mandatory)

userSearchBase(mandatory)

repeatable

intervalValue(mandatory)

scheduleUnit

nextExecTime(mandatory)

servers(mandatory)

server(mandatory)

hostName(mandatory)

ldapPortNumber(mandatory)

sslEnabled

middleName

phoneNumber

mailId

   

ldapFilter

addSafCcdPurgeBlockLearnedRoutes

getSafCcdPurgeBlockLearnedRoutes

updateSafCcdPurgeBlockLearnedRoutes

removeSafCcdPurgeBlockLearnedRoutes

To add, update, get, and remove SafCcdPurgeBlockLearnedRoutes

learnedPattern

learnedPatternPrefix

callControlIdentity

ipAddress

addVpnGateway

getVpnGateway

updateVpnGateway

removeVpnGateway

To add, update, get, and remove VpnGateway

name(mandatory)

description

url(mandatory)

certificates(mandatory)

certificate(mandatory)

issuerName(mandatory)

serialNumber(mandatory)

addVpnGroup

getVpnGroup

updateVpnGroup

removeVpnGroup

To add, update, get, and remove VpnGroup

name(mandatory)

description

vpnGateways

vpnGateway

vpnGatewayName(mandatory)

priority(mandatory)

addVpnProfile

getVpnProfile

updateVpnProfile

removeVpnProfile

To add, update, get, and remove VpnProfile

name(mandatory)

description

autoNetworkDetection

mtu

failToConnect

clientAuthentication

pwdPersistant

enableHostIdCheck

addTransformationProfile

getTransformationProfile

updateTransformationProfile

removeTransformationProfile

To add, update, get, and remove TransformationProfile

name(mandatory)

description

nationalStripDigits

internationalStripDigits

unknowmStripDigits

subscriberStripDigits

nationalPrefix

internationalPrefix

unknownPrefix

subscriberPrefix

nationalCssName

internationalCssName

unknownCssName

subscriberCssName

addLdapFilter

getLdapFilter

updateLdapFilter

removeLdapFilter

To add, update, get, and remove LdapFilter

name(mandatory)

filter(mandatory)

addAppServerInfo

getAppserverInfo

updateAppserverInfo

removeAppServerInfo

To add, update, get, and remove AppServerInfo

appServerName(mandatory)

appServerContent(mandatory)

content


Changed APIs

Table 2-4 describes changed operations in Unified CM 8.0(1).

Table 2-4 Changed Operations in Unified CM 8.0

API in 7.1
Tags in 7.1
API in 8.0(1)
Tags in 8.0(1)

AARGroup

AarGroup

 

 

aarGroupFromName

 

 

aarGroupToName

 

name

 

name

 

 

prefixDigit

 

 

relatedGroup

 

 

relatedGroups

       

AARGroupMatrix

AarGroupMatrix

 

 

aarGroupFromName

 

 

aarGroupToName

 

prefixDigit

 

prefixDigit

AppUser

 

AppUser

 
 

acceptOutOfDialogRefer

 

acceptOutOfDialogRefer

 

acceptPresenceSubscription

 

acceptPresenceSubscription

 

acceptUnsolicitedNotification

 

acceptUnsolicitedNotification

 

allowReplaceHeader

 

allowReplaceHeader

 

 

associatedCapfProfiles

 

 

associatedCapfProfiles

 

associatedDevices

 

associatedDevices

 

associatedUserGroups

 

associatedGroups

 

 

capfProfileInstanceId

 

 

ctiControlledDeviceProfiles

 

device

 

device

 

 

deviceProfile

 

digestCredentials

 

digestCredentials

 

 

isStandard

 

name

 

name

 

password

 

password

 

 

passwordCredentials

 

presenceGroupName

 

presenceGroupName

 

 

pwdCredDoesNotExpire

 

 

pwdCredLockedByAdministrator

 

 

pwdCredPolicyName

 

 

pwdCredTimeAdminLockout

 

 

pwdCredTimeChanged

 

 

pwdCredUserCantChange

 

 

pwdCredUserMustChange

 

userGroup

 

userGroup

 

userid

 

userid

 

 

userRole

 

 

userRoles

CalledPartyTransformationPattern

 

CalledPartyTransformationPattern

 
 

calledPartyNumberingPlan

 

calledPartyNumberingPlan

 

calledPartyNumberType

 

calledPartyNumberType

 

calledPartyPrefixDigits

 

calledPartyPrefixDigits

 

calledPartyTransformationMask

 

calledPartyTransformationMask

 

description

 

description

 

dialPlanName

 

dialPlanName

 

digitDiscardInstructionName

 

digitDiscardInstructionName

 

pattern

 

pattern

 

patternUrgency

 

patternUrgency

 

routeFilterName

 

routeFilterName

 

routePartitionName

 

routePartitionName

 

usage

 

usage

CallerFilterList

 

CallerFilterList

 
 

callerFilterMask

 

callerFilterMask

 

description

 

description

 

dnMask

 

DnMask

 

endUserIdName

 

endUserIdName

 

isAllowedType

 

isAllowedType

 

member

 

member

 

members

 

members

 

name

 

name

CallManager

 

CallManager

 
 

 

autoRegistration

 

 

e164Mask

 

 

endDn

 

 

ethernetPhonePort

 

description

 

description

 

 

keepAlive

 

 

listen

 

 

mgcpPorts

 

name

 

name

 

 

nextDn

 

 

ports

 

 

processNodeName

 

 

routePartitionName

 

 

sipPhonePort

 

 

sipPhoneSecurePort

 

 

sipPorts

 

 

startDn

 

 

autoRegistration

CallManagerGroup

 

CallManagerGroup

 
 

callManagerName

 

callManagerName

 

member

 

member

 

members

 

members

 

name

 

name

 

 

priority

 

 

tftpDefault

CallPark

 

CallPark

 
 

callManagerName

 

callManagerName

 

description

 

description

 

pattern

 

pattern

 

routePartitionName

 

routePartitionName

 

usage

 

usage

CallPickupGroup

 

CallPickupGroup

 
 

calledPartyInfo

 

calledPartyInfo

 

callInfoForPickupNotification

 

callInfoForPickupNotification

 

callingPartyInfo

 

callingPartyInfo

 

description

 

description

 

 

dnPattern

 

 

members

 

 

member

 

name

 

name

 

pattern

 

pattern

 

 

pickupDnAndPartition

 

 

pickupGroupName

 

pickupNotification

 

pickupNotification

 

pickupNotificationTimer

 

pickupNotificationTimer

 

 

priority

 

routePartitionName

 

routePartitionName

 

 

routePartitionName

 

usage

 

usage

CMCInfo

 

CmcInfo

 
 

code

 

code

 

description

 

description

CommonDeviceConfig

 

CommonDeviceConfig

 
 

allowAutoConfigurationForPhones

 

allowAutoConfigurationForPhones

 

IPAddressingMode

 

ipAddressingMode

 

IPAddressingModePreferenceControl

 

ipAddressingModePreferenceControl

 

mlppDomainId

 

mlppDomainId

 

mlppIndicationStatus

 

mlppIndicationStatus

 

name

 

name

 

networkHoldMOHAudioSourceId

 

networkHoldMohAudioSourceId

 

preemption

 

preemption

 

softkeyTemplateName

 

softkeyTemplateName

 

 

useImeForOutboundCalls

 

userHoldMOHAudioSourceId

 

userHoldMohAudioSourceId

 

userLocale

 

userLocale

 

useTrustedRelayPoint

 

useTrustedRelayPoint

CommonPhoneConfig

 

CommonPhoneConfig

 
 

alwaysUsePrimeLine

 

alwaysUsePrimeLine

 

alwaysUsePrimeLineforVoiceMessage

 

alwaysUsePrimeLineForVoiceMessage

 

backgroundImage

 

backgroundImage

 

ciscoCamera

 

 

description

 

description

 

dndAlertingType

 

dndAlertingType

 

dndOption

 

dndOption

 

name

 

name

 

phonePersonalization

 

phonePersonalization

 

phoneServiceDisplay

 

phoneServiceDisplay

 

sdio

 

 

sshPwd

 

sshPwd

 

sshUserId

 

sshUserId

 

unlockPwd

 

unlockPwd

 

usb1

 

 

usb2

 

 

usbClasses

 

 

vendorConfig

 

vendorConfig

 

 

vpnGroupName

 

 

vpnProfileName

ConferenceBridge

 

ConferenceBridge

 
 

 

commonDeviceConfigName

 

description

 

description

 

devicePoolName

 

devicePoolName

 

loadInformation

 

loadInformation

 

locationName

 

locationName

 

maximumCapacity

 

maximumCapacity

 

name

 

name

 

product

 

product

 

 

securityProfileName

 

subUnit

 

subUnit

 

useTrustedRelayPoint

 

useTrustedRelayPoint

 

vendorConfig

 

vendorConfig

CredentialPolicy

 

CredentialPolicy

 
 

administratorMustUnlock

 

 

credChangeDuration

 

credChangeDuration

 

credExpiresAfter

 

credExpiresAfter

 

expiryWarningDays

 

expiryWarningDays

 

failedLogon

 

failedLogon

 

inactiveDaysAllowed

 

inactiveDaysAllowed

 

lockoutDuration

 

lockoutDuration

 

minCredLength

 

minCredLength

 

name

 

name

 

neverExpires

 

 

noLimitForFailedLogon

 

 

prevCredStoredNum

 

prevCredStoredNum

 

resetFailedLogonAttempts

 

resetFailedLogonAttempts

 

trivialCredCheck

 

trivialCredCheck

CSS

 

Css

 
 

clause

 

clause

 

description

 

description

 

dialPlanWizardGenId

 

dialPlanWizardGenId

 

 

index

 

member

 

member

 

members

 

members

 

name

 

name

 

partitionUsage

 

partitionUsage

 

routePartitionName

 

routePartitionName

CTIRoutePoint

 

CtiRoutePoint

 
 

aarNeighborhoodName

 

 

 

asciiLabel

 

 

associatedEndusers

 

 

audibleMwi

 

automatedAlternateRoutingCSSName

 

 

 

busyTrigger

 

 

callerName

 

 

callerNumber

 

 

callInfoDisplay

 

callingSearchSpaceName

 

callingSearchSpaceName

 

cgpnTransformationCSSName

 

cgpnTransformationCssName

 

class

 

class

 

commonDeviceConfigName

 

commonDeviceConfigName

 

 

consecutiveRingSetting

 

description

 

description

 

devicePoolName

 

devicePoolName

 

 

dialedNumber

 

 

dialPlanWizardId

 

 

directoryNumber

 

 

dirn

 

 

display

 

 

displayAscii

 

 

e164Mask

 

 

enduser

 

 

geoLocationName

 

 

index

 

 

label

 

 

line

 

 

lineIdentifier

 

 

lines

 

loadInformation

 

 

locationName

 

locationName

 

 

maxNumCalls

 

mediaResourceListName

 

mediaResourceListName

 

mlppDomainId

 

 

mlppIndicationStatus

 

 

model

 

model

 

 

monitoringCssName

 

 

mwlPolicy

 

name

 

name

 

networkHoldMOHAudioSourceId

 

networkHoldMohAudioSourceId

 

networkLocation

 

 

 

partitionUsage

 

preemption

 

 

product

 

product

 

protocol

 

protocol

 

protocolSide

 

protocolSide

 

 

recordingFlag

 

 

recordingProfileName

 

 

redirectedNumber

 

retryVideoCallAsAudio

 

 

 

ringSetting

 

 

ringSettingActivePickupAlert

 

 

ringSettingIdlePickupAlert

 

 

routePartitionName

 

 

speedDial

 

traceFlag

 

 

useDevicePoolCgpnTransformCSS

 

useDevicePoolCgpnTransformCss

 

userHoldMOHAudioSourceId

 

userHoldMohAudioSourceId

 

 

userLocale

 

useTrustedRelayPoint

 

useTrustedRelayPoint

 

vendorConfig

 

 

versionStamp

 

DDI

 

Ddi

 
 

clause

 

clause

 

dialPlanName

 

dialPlanName

 

dialPlanTagName

 

dialPlanTagName

 

digitAnalysisId

 

digitAnalysisId

 

member

 

member

 

members

 

members

 

name

 

name

DeviceMobility

 

DeviceMobility

 
 

devicePoolName

 

devicePoolName

 

member

 

member

 

members

 

members

 

name

 

name

 

subNet

 

subNet

 

subNetMaskSz

 

subNetMaskSz

DeviceMobilityGroup

 

DeviceMobilityGroup

 
 

 

description

 

name

 

name

DevicePool

 

DevicePool

 
 

aarNeighborhoodName

 

aarNeighborhoodName

 

automatedAlternateRoutingCSSName

 

automatedAlternateRoutingCssName

 

autoSearchSpaceName

 

autoSearchSpaceName

 

 

calledPartyUnknownTransformationCssName

 

 

callingPartyInternationalPrefix

 

 

callingPartyInternationalStripDigits

 

 

callingPartyInternationalTransformationCssName

 

 

callingPartyNationalPrefix

 

 

callingPartyNationalStripDigits

 

 

callingPartyNationalTransformationCssName

 

 

callingPartySubscriberPrefix

 

 

callingPartySubscriberStripDigits

 

 

callingPartySubscriberTransformationCssName

 

 

callingPartyUnknownPrefix

 

 

callingPartyUnknownStripDigits

 

 

callingPartyUnknownTransformationCssName

 

callManagerGroupName

 

callManagerGroupName

 

cdpnTransformCSSName

 

cdpnTransformationCssName

 

cgpnTransformationUnknownCSSName

 

 

cgpnTransformationUnknownCSSName

 

 

cgpnTransformationUnknownCSSName

 

 

cgpnTransformationUnknownCSSName

 

 

cgpnTransformCSSName

 

cgpnTransformationCssName

 

 

cntdPnTransformationCssName

 

connectionMonitorDuration

 

connectionMonitorDuration

 

dateTimeSettingName

 

dateTimeSettingName

 

deviceMobilityGroupName

 

deviceMobilityGroupName

 

 

geoLocationFilterName

 

 

geoLocationName

 

 

imeEnrolledPatternGroupName

 

internationalPrefix

 

 

internationalStripDigits

 

 

joinAcrossLines

 

joinAcrossLines

 

localRouteGroupName

 

localRouteGroupName

 

locationName

 

locationName

 

mediaResourceListName

 

mediaResourceListName

 

mobilityCSSName

 

mobilityCssName

 

name

 

name

 

nationalPrefix

 

 

nationalStripDigits

 

 

networkLocale

 

networkLocale

 

physicalLocation

 

physicalLocationName

 

regionName

 

regionName

 

revertPriority

 

revertPriority

 

singleButtonBarge

 

singleButtonBarge

 

srstName

 

srstName

 

subscriberPrefix

 

 

subscriberStripDigits

 

 

unknownPrefix

 

 

unknownStripDigits

 

DeviceProfile

 

DeviceProfile

 
 

aarDestinationMask

 

 

aarKeepCallHistory

 

 

aarNeighborhoodName

 

 

aarNeighborhoodName

 

 

aarVoiceMailEnabled

 

 

addOnModule

 

addOnModule

 

addOnModules

 

addOnModules

 

 

addressMode

 

alertingName

 

     

allowAutoConfig

 

allowCtiControlFlag

 

 

alwaysUsePrimeLine

 

alwaysUsePrimeLine

     

alwaysUsePrimeLine

 

alwaysUsePrimeLineforVoiceMessage

 

alwaysUsePrimeLineForVoiceMessage

 

 

alwaysUsePrimeLineForVoiceMessage

 

 

asciiLabel

 

 

asciiLabel

 

 

asciiLabel

 

 

associatedBlfSdFeatures

 

 

associatedEndusers

 

associatedPC

 

 

 

audibleMwi

 

authenticationString

 

 

authenticationURL

 

 

autoAnswer

 

 

blfDest

 

blfDest

 

 

blfDirectedCallPark

 

 

blfDirectedCallParks

 

blfDirn

 

blfDirn

 

builtInBridgeStatus

 

 

busyLampField

 

busyLampField

 

busyLampFields

 

busyLampFields

 

busyTrigger

 

busyTrigger

 

callerName

 

callerName

 

callerNumber

 

callerNumber

 

callForwardAll

 

 

callForwardAlternateParty

 

 

callForwardBusy

 

 

callForwardBusyInt

 

 

callForwardNoAnswer

 

 

callForwardNoAnswerInt

 

 

callForwardNoCoverage

 

 

callForwardNoCoverageInt

 

 

callForwardNotRegistered

 

 

callForwardNotRegisteredInt

 

 

callForwardOnFailure

 

 

callInfoDisplay

 

callInfoDisplay

 

callInfoPrivacyStatus

 

callInfoPrivacyStatus

 

 

callInfoPrivacyStatus

 

callPickupGroupName

 

 

certificateOperation

 

 

certificateStatus

 

 

cfaCSSClause

 

 

cfaCSSPolicy

 

 

class

 

class

 

 

class

 

commonDeviceConfig

   
 

consecutiveRingSetting

 

consecutiveRingSetting

 

 

currentConfig

 

 

currentProfileName

 

 

defaultProfileName

 

description

 

description

 

deviceMobilityMode

 

 

 

deviceName

 

devicePoolName

 

 

 

deviceProtocol

 

dialedNumber

 

dialedNumber

 

dialPlanWizardId

 

dialPlanWizardId

 

 

directedCallParkDnAndPartition

 

 

directedCallParkId

 

 

directoryNumber

 

directoryURL

 

 

dirn

 

dirn

 

dirn

 

dirn

 

display

 

display

 

 

displayAscii

 

dndOption

 

dndOption

 

 

dndOption

 

dndRingSetting

 

dndRingSetting

 

 

dndRingSetting

 

 

dndStatus

 

 

dndStatus

 

 

dnPattern

 

e164Mask

 

e164Mask

 

 

emccCallingSearchSpace

 

 

emccCallingSearchSpaceName

 

 

enduser

 

 

feature

 

 

geolocationInfo

 

hlogStatus

 

 

hrDuration

 

 

hrInterval

 

 

idleTimeout

 

 

idleURL

 

 

ignorePresentationIndicators

 

ignorePresentationIndicators

 

 

ignorePresentationIndicators

 

 

index

 

 

index

 

 

index

 

 

index

 

 

index

 

informationURL

 

 

isActive

 

 

 

joinAcrossLines

 

 

joinAcrossLines

 

label

 

label

 

label

 

label

 

label

 

label

 

 

label

 

 

labelAscii

 

line

 

line

 

 

lineIdentifier

 

lines

 

lines

 

loadInformation

 

loadInformation

 

loadInformation

 

 

locationName

 

 

 

loginDuration

 

 

loginTime

 

 

loginUserId

 

maxNumCalls

 

maxNumCalls

 

messagesURL

 

 

mlppDomainId

 

mlppDomainId

 

 

mlppDomainId

 

mlppIndicationStatus

 

mlppIndicationStatus

 

 

mlppIndicationStatus

 

model

 

model

 

model

 

model

 

 

model

 

 

monitoringCssName

 

mwlPolicy

 

mwlPolicy

 

name

 

name

 

 

name

 

networkHoldMOHAudioSourceId

 

 

networkHoldMOHAudioSourceId

 

 

networkLocale

 

 

networkLocation

 

 

numberOfButtons

 

numberOfButtons

 

ownerUserId

 

 

packetCaptureDuration

 

 

packetCaptureMode

 

 

 

partitionUsage

 

pattern

 

 

patternPrecedence

 

 

 

phoneService

 

 

phoneServiceCategory

 

phoneSuite

 

 

phoneTemplateName

 

phoneTemplateName

 

 

phoneTemplateName

 

preemption

 

preemption

 

 

preemption

 

presenceGroupName

 

 

presenceGroupName

 

 

 

priority

 

product

 

product

 

 

product

 

protocol

 

protocol

 

protocolSide

 

protocolSide

 

proxyServerURL

 

 

 

recordingFlag

 

 

recordingProfileName

 

redirectedNumber

 

redirectedNumber

 

releaseCause

 

 

remoteDevice

 

 

 

remoteSipSrstIp

 

 

remoteSipSrstPort

 

 

remoteSrstIp

 

 

remoteSrstOption

 

 

remoteSrstPort

 

retryVideoCallAsAudio

 

 

ringSetting

 

ringSetting

 

 

ringSettingActivePickupAlert

 

 

ringSettingIdlePickupAlert

 

 

routePartition

 

routePartitionName

 

routePartitionName

 

 

routePartitionName

 

 

service

 

 

serviceNameAscii

 

 

services

 

servicesURL

 

 

shareLineAppearanceCSSName

 

 

 

singleButtonBarge

 

 

singleButtonBarge

 

softkeyTemplateName

 

softkeyTemplateName

 

 

softkeyTemplateName

 

speeddial

 

speeddial

 

 

speedDial

 

speeddials

 

speeddials

 

 

telecasterServiceName

 

traceFlag

 

traceFlag

 

upgradeFinishTime

 

 

 

url

 

 

urlButtonIndex

 

 

urlLabel

 

 

urlLabelAscii

 

usage

 

 

userHoldMOHAudioSourceId

 

userHoldMohAudioSourceId

 

userHoldMOHAudioSourceId

 

userHoldMohAudioSourceId

 

userLocale

 

userlocale

 

 

vendor

 

vendorConfig

 

vendorConfig

 

 

version

 

versionStamp

 

versionStamp

 

voiceMailProfileName

 

DHCPServer

 

DhcpServer

 
 

arpCacheTimeout

 

arpCacheTimeout

 

bootstrapServeripAddress

 

bootstrapServerIpAddress

 

domainName

 

domainName

 

ipAddressLeaseTime

 

ipAddressLeaseTime

 

primaryDNSipAddress

 

primaryDnsIpAddress

 

primaryTFTPServeripAddress

 

primaryTftpServerIpAddress

 

processNodeName

 

processNodeName

 

rebindingTime

 

rebindingTime

 

renewalTime

 

renewalTime

 

secondaryDNSipAddress

 

secondaryDnsIpAddress

 

secondaryTFTPServeripAddress

 

secondaryTftpServerIpAddress

 

tftpServerName

 

tftpServerName

DHCPSubnet

 

DhcpSubnet

 
 

arpCacheTimeout

 

arpCacheTimeout

 

bootstrapServerIPAddress

 

bootstrapServerIpAddress

 

dhcpServerName

 

dhcpServerName

 

domainName

 

domainName

 

ipAddressLeaseTime

 

ipAddressLeaseTime

 

primaryDNSIpAddress

 

primaryDnsIpAddress

 

primaryEndIPAddress

 

primaryEndIpAddress

 

primaryRouterIPAddress

 

primaryRouterIpAddress

 

primaryStartIPAddress

 

primaryStartIpAddress

 

primaryTFTPServerIPAddress

 

primaryTftpServerIpAddress

 

rebindingTime

 

rebindingTime

 

renewalTime

 

renewalTime

 

secondaryDNSIpAddress

 

secondaryDnsIpAddress

 

secondaryEndIPAddress

 

secondaryEndIpAddress

 

secondaryRouterIPAddress

 

secondaryRouterIpAddress

 

secondaryStartIPAddress

 

secondaryStartIpAddress

 

secondaryTFTPServerIPAddress

 

secondaryTftpServerIpAddress

 

subnetIPAddress

 

subnetIpAddress

 

subnetMask

 

subnetMask

 

tftpServerName

 

tftpServerName

DialPlan

 

DialPlan

 
 

description

 

description

 

name

 

name

DialPlanTag

 

DialPlanTag

 
 

dialPlanName

 

dialPlanName

 

name

 

name

 

operator

 

operator

 

suppressFromRouteFilter

 

suppressFromRouteFilter

DirectedCallPark

 

DirectedCallPark

 
 

description

 

description

 

pattern

 

pattern

 

retrievalPrefix

 

retrievalPrefix

 

reversionPattern

 

reversionPattern

 

revertCSSName

 

revertCssName

 

routePartitionName

 

routePartitionName

 

usage

 

usage

FACInfo

 

FacInfo

 
 

authorizationLevel

 

authorizationLevel

 

code

 

code

 

name

 

name

Gatekeeper

 

Gatekeeper

 
 

description

 

description

 

enableDevice

 

enableDevice

 

name

 

name

 

retryTimeout

 

retryTimeout

 

rrqTimeToLive

 

rrqTimeToLive

GeoLocation

 

GeoLocation

 
 

cityDivision

 

cityDivision

 

communityName

 

communityName

 

country

 

country

 

description

 

description

 

district

 

district

 

floor

 

floor

 

houseNumber

 

houseNumber

 

houseNumberSuffix

 

houseNumberSuffix

 

landmark

 

landmark

 

leadingStreetDirection

 

leadingStreetDirection

 

location

 

location

 

name

 

name

 

nationalSubDivision

 

nationalSubDivision

 

neighbourhood

 

neighbourhood

 

occupantName

 

occupantName

 

postalCode

 

postalCode

 

street

 

street

 

streetSuffix

 

streetSuffix

 

trailingStreetSuffix

 

trailingStreetSuffix

GeoLocationFilter

 

GeoLocationFilter

 
 

description

 

description

 

name

 

name

 

useCityDivision

 

useCityDivision

 

useCommunityName

 

useCommunityName

 

useCountry

 

useCountry

 

useDistrict

 

useDistrict

 

 

useFloor

 

useHouseNumber

 

useHouseNumber

 

useHouseNumberSuffix

 

useHouseNumberSuffix

 

useLandmark

 

useLandmark

 

useLeadingStreetDirection

 

useLeadingStreetDirection

 

 

useLocation

 

useNationalSubDivision

 

useNationalSubDivision

 

useNeighbourhood

 

useNeighbourhood

 

 

useOccupantName

 

 

usePostalCode

 

useStreet

 

useStreet

 

useStreetSuffix

 

useStreetSuffix

 

useTrailingStreetSuffix

 

useTrailingStreetSuffix

GeoLocationPolicy

 

GeoLocationPolicy

 
 

cityDivision

 

cityDivision

 

communityName

 

communityName

 

country

 

country

 

description

 

description

 

district

 

district

 

floor

 

floor

 

 

geoLocationDeviceA

 

 

geoLocationDeviceB

 

 

geoLocationPolicyAName

 

 

geoLocationPolicyBName

 

houseNumber

 

houseNumber

 

houseNumberSuffix

 

houseNumberSuffix

 

landmark

 

landmark

 

leadingStreetDirection

 

leadingStreetDirection

 

location

 

location

 

 

logicalPartitionPolicy

 

name

 

name

 

nationalSubDivision

 

nationalSubDivision

 

neighbourhood

 

neighbourhood

 

occupantName

 

occupantName

 

postalCode

 

postalCode

 

 

relatedPolicies

 

 

relatedPolicy

 

street

 

street

 

streetSuffix

 

streetSuffix

 

trailingStreetSuffix

 

trailingStreetSuffix

H323Gateway

 

H323Gateway

 
 

aarNeighborhoodName

 

aarNeighborhoodName

 

AllowH235PassThrough

 

allowH235PassThrough

 

ASN1ROSEOIDEncoding

 

asn1RoseOidEncoding

 

automatedAlternateRoutingCSSName

 

automatedAlternateRoutingCssName

 

calledNumberingPlan

 

calledNumberingPlan

 

calledPartyIENumberType

 

calledPartyIeNumberType

 

 

calledPartyInternationalPrefix

 

 

calledPartyInternationalStripDigits

 

 

calledPartyInternationalTransformationCssName

 

 

calledPartyNationalPrefix

 

 

calledPartyNationalStripDigits

 

 

calledPartyNationalTransformationCssName

 

 

calledPartySubscriberPrefix

 

 

calledPartySubscriberStripDigits

 

 

calledPartySubscriberTransformationCssName

 

 

calledPartyUnknownStripDigits

 

 

calledPartyUnknownTransformationCssName

 

callerIdDN

 

callerIdDn

 

callingLineIdPresentation

 

callingLineIdPresentation

 

callingNumberingPlan

 

callingNumberingPlan

 

callingPartyIENumberType

 

callingPartyIeNumberType

 

 

callingPartyInternationalPrefix

 

 

callingPartyInternationalStripDigits

 

 

callingPartyInternationalTransformationCssName

 

 

callingPartyNationalPrefix

 

 

callingPartyNationalStripDigits

 

 

callingPartyNationalTransformationCssName

 

callingPartySelection

 

callingPartySelection

 

 

callingPartySubscribercalledPartyUnknownPrefix

 

 

callingPartySubscriberPrefix

 

 

callingPartySubscriberStripDigits

 

 

callingPartyUnknownPrefix

 

 

callingPartyUnknownStripDigits

 

 

callingPartyUnknownTransformationCssName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

cdpnTransformationCSSName

 

cdpnTransformationCssName

 

cgpnTransformationCSSName

 

cgpnTransformationCssName

 

cgpnTransformationUnknownCSSName

 

 

cgpnTransformationUnknownCSSName

 

 

cgpnTransformationUnknownCSSName

 

 

cgpnTransformationUnknownCSSName

 

 

class

 

class

 

 

codecForOutboundFaststart

 

commonDeviceConfigName

 

commonDeviceConfigName

 

description

 

description

 

devicePoolName

 

devicePoolName

 

displayIEDelivery

 

displayIeDelivery

 

enableInboundFaststart

 

enableInboundFaststart

 

enableOutboundFaststart

 

enableOutboundFaststart

 

 

geoLocationFilterName

 

 

geoLocationName

 

 

imeE164TransformationName

 

 

inalSet

 

internationalPrefix

 

 

internationalStripDigits

 

 

licensedCapacity

 

 

loadInformation

 

loadInformation

 

locationName

 

locationName

 

mediaResourceListName

 

mediaResourceListName

 

mlppDomainId

 

mlppDomainId

 

mlppIndicationStatus

 

 

model

 

model

 

mtpRequired

 

mtpRequired

 

name

 

name

 

nationalPrefix

 

 

nationalStripDigits

 

 

networkLocation

 

networkLocation

 

packetCaptureDuration

 

packetCaptureDuration

 

packetCaptureMode

 

packetCaptureMode

 

 

pathReplacementSupport

 

preemption

 

 

prefixDN

 

prefixDn

 

product

 

product

 

protocol

 

protocol

 

protocolSide

 

protocolSide

 

 

pstnAccess

 

QSIGVariant

 

qsigVariant

 

redirectInboundNumberIE

 

redirectInboundNumberIe

 

redirectOutboundNumberIE

 

redirectOutboundNumberIe

 

retryVideoCallAsAudio

 

retryVideoCallAsAudio

 

significantDigits

 

sigDigits

 

 

signalingPort

 

srtpAllowed

 

srtpAllowed

 

subscriberPrefix

 

 

subscriberStripDigits

 

 

traceFlag

 

traceFlag

 

 

TransformationCssName

 

 

transmitUtf8

 

tunneledProtocol

 

tunneledProtocol

 

unknownPrefix

 

 

unknownStripDigits

 

 

useDevicePoolCdpnTransformCSS

 

useDevicePoolCdpnTransformCss

 

useDevicePoolCgpnTransformCSS

 

useDevicePoolCgpnTransformCss

 

useTrustedRelayPoint

 

useTrustedRelayPoint

 

vendorConfig

 

vendorConfig

 

versionStamp

 

 

waitForFarEndH245TerminalSet

 

waitForFarEndH245Term

H323Phone

 

H323Phone

 
 

aarNeighborhoodName

 

aarNeighborhoodName

 

 

alwaysUsePrimeLine

 

 

alwaysUsePrimeLineForVoiceMessage

 

 

asciiLabel

 

 

associatedEndusers

 

 

audibleMwi

 

automatedAlternateRoutingCSSName

 

automatedAlternateRoutingCssName

 

 

busyTrigger

 

callerIdDN

 

callerIdDn

 

 

callerName

 

 

callerNumber

 

 

callInfoDisplay

 

callingLineIdPresentation

 

callingLineIdPresentation

 

callingPartySelection

 

callingPartySelection

 

callingSearchSpaceName

 

callingSearchSpaceName

 

 

cgpnTransformationCssName

 

class

 

class

 

codecForOutboundFaststart

 

 

commonDeviceConfigName

 

commonDeviceConfigName

 

 

commonPhoneConfigName

 

description

 

description

 

devicePoolName

 

devicePoolName

 

 

dialedNumber

 

 

dialPlanWizardId

 

 

directoryNumber

 

 

dirn

 

 

display

 

 

displayAscii

 

displayIEDelivery

 

displayIEDelivery

 

e164

 

e164

 

 

e164Mask

 

enableInboundFaststart

 

 

enableOutboundFaststart

 

 

 

enduser

 

gatekeeperInfo

 

gateKeeperInfo

 

gatekeeperName

 

gateKeeperName

 

 

geoLocationName

 

 

hlogStatus

 

ignorePresentationIndicators

 

ignorePresentationIndicators

 

 

index

 

 

label

 

 

line

 

 

lineIdentifier

 

 

lines

 

loadInformation

 

 

locationName

 

locationName

 

 

maxNumCalls

 

mediaResourceListName

 

mediaResourceListName

 

mlppDomainId

 

mlppDomainId

 

mlppIndicationStatus

 

 

model

 

model

 

 

monitoringCssName

 

 

mtpPreferredCodec

 

mtpRequired

 

mtpRequired

 

name

 

name

 

networkLocation

 

 

ownerUserId

 

 

 

ownerUserName

 

packetCaptureDuration

 

 

packetCaptureMode

 

 

 

partitionUsage

 

 

presenceGroupName

 

preemption

 

 

product

 

product

 

protocol

 

protocol

 

protocolSide

 

protocolSide

 

 

recordingFlag

 

 

recordingProfileName

 

 

redirectedNumber

 

redirectInboundNumberIE

 

redirectInboundNumberIe

 

redirectOutboundNumberIE

 

redirectOutboundNumberIe

 

 

remoteDevice

 

retryVideoCallAsAudio

 

retryVideoCallAsAudio

 

 

routePartitionName

 

signalingPort

 

signalingPort

 

 

speedDial

 

srtpAllowed

 

srtpAllowed

 

subscribeCallingSearchSpaceName

 

subscribeCallingSearchSpaceName

 

technologyPrefix

 

technologyPrefix

 

traceFlag

 

traceFlag

 

unattendedPort

 

unattendedPort

 

 

useDevicePoolCgpnTransformCss

 

useTrustedRelayPoint

 

useTrustedRelayPoint

 

vendorConfig

 

 

versionStamp

 

 

waitForFarEndH245TerminalSet

 

waitForFarEndH245TerminalSet

 

zone

 

zone

H323Trunk

 

H323Trunk

 
 

aarNeighborhoodName

 

aarNeighborhoodName

 

AllowH235PassThrough

 

allowH235PassThrough

 

ASN1ROSEOIDEncoding

 

asn1RoseOidEncoding

 

automatedAlternateRoutingCSSName

 

automatedAlternateRoutingCssName

 

calledNumberingPlan

 

calledNumberingPlan

 

calledPartyIENumberType

 

calledPartyIeNumberType

 

 

calledPartyInternationalPrefix

 

 

calledPartyInternationalStripDigits

 

 

calledPartyInternationalTransformationCssName

 

 

calledPartyNationalPrefix

 

 

calledPartyNationalStripDigits

 

 

calledPartyNationalTransformationCssName

 

 

calledPartySubscriberPrefix

 

 

calledPartySubscriberStripDigits

 

 

calledPartySubscriberTransformationCssName

 

 

calledPartyUnknownPrefix

 

 

calledPartyUnknownStripDigits

 

 

calledPartyUnknownTransformationCssName

 

callerIdDN

 

callerIdDn

 

callingLineIdPresentation

 

callingLineIdPresentation

 

callingNumberingPlan

 

callingNumberingPlan

 

callingPartyIENumberType

 

callingPartyIeNumberType

 

 

callingPartyInternationalStripDigits

 

 

callingPartyInternationalTransformationCssName

 

 

callingPartyNationalStripDigits

 

 

callingPartyNationalTransformationCssName

 

callingPartySelection

 

callingPartySelection

 

 

callingPartySubscriberStripDigits

 

 

callingPartySubscriberTransformationCssName

 

 

callingPartyUnknownStripDigits

 

 

callingPartyUnknownTransformationCssName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

cdpnTransformationCSSName

 

cdpnTransformationCssName

 

cgpnTransformationCSSName

 

cgpnTransformationCssName

 

cgpnTransformationUnknownCSSName

 

 

cgpnTransformationUnknownCSSName

 

 

cgpnTransformationUnknownCSSName

 

 

cgpnTransformationUnknownCSSName

 

 

class

 

class

 

codecForOutboundFaststart

 

codecForOutboundFaststart

 

commonDeviceConfigName

 

commonDeviceConfigName

 

description

 

description

 

devicePoolName

 

devicePoolName

 

displayIEDelivery

 

displayIEDelivery

 

enableInboundFaststart

 

enableInboundFaststart

 

enableOutboundFaststart

 

enableOutboundFaststart

 

 

gateKeeper

 

gatekeeperInfo

 

gateKeeperInfo

 

gatekeeperName

 

 

 

geoLocationFilterName

 

 

geoLocationName

 

 

ictPassingPrecedenceLevelThroughUuie

 

 

ictSecurityAccessLevel

 

 

imeE164TransformationName

 

internationalPrefix

 

internationalPrefix

 

internationalStripDigits

 

 

 

isSafEnabled

 

licensedCapacity

 

 

loadInformation

 

 

locationName

 

locationName

 

mediaResourceListName

 

mediaResourceListName

 

mlppDomainId

 

mlppDomainId

 

mlppIndicationStatus

 

mlppIndicationStatus

 

model

 

model

 

mtpRequired

 

mtpRequired

 

name

 

name

 

nationalPrefix

 

nationalPrefix

 

nationalStripDigits

 

 

networkLocation

 

networkLocation

 

packetCaptureDuration

 

packetCaptureDuration

 

packetCaptureMode

 

packetCaptureMode

 

pathReplacementSupport

 

pathReplacementSupport

 

preemption

 

preemption

 

prefixDN

 

prefixDn

 

product

 

product

 

protocol

 

protocol

 

protocolSide

 

protocolSide

 

 

pstnAccess

 

QSIGVariant

 

qsigVariant

 

redirectInboundNumberIE

 

redirectInboundNumberIe

 

redirectOutboundNumberIE

 

redirectOutboundNumberIe

 

 

remoteServerinfo

 

retryVideoCallAsAudio

 

retryVideoCallAsAudio

 

 

sendGeoLocation

 

 

server1

 

 

server2

 

 

server3

 

 

sigDigits

 

 

signalingPort

 

significantDigits

 

 

srtpAllowed

 

srtpAllowed

 

subscriberPrefix

 

subscriberPrefix

 

subscriberStripDigits

 

 

technologyPrefix

 

technologyPrefix

 

terminal

 

 

 

terminalType

 

traceFlag

 

traceFlag

 

 

transmitUtf8

 

tunneledProtocol

 

tunneledProtocol

 

tunneledProtocol

 

 

unattendedPort

 

unattendedPort

 

unknownPrefix

 

unknownPrefix

 

unknownStripDigits

 

 

 

useDevicePoolCalledCssIntl

 

 

useDevicePoolCalledCssNatl

 

 

useDevicePoolCalledCssSubs

 

 

useDevicePoolCalledCssUnkn

 

useDevicePoolCdpnTransformCSS

 

useDevicePoolCdpnTransformCss

 

useDevicePoolCgpnTransformCSS

 

useDevicePoolCgpnTransformCss

 

useDevicePoolCgpnTransformInternationalCSS

 

useDevicePoolCgpnTransformCssIntl

 

useDevicePoolCgpnTransformNationalCSS

 

useDevicePoolCgpnTransformCssNatl

 

useDevicePoolCgpnTransformSubscriberCSS

 

useDevicePoolCgpnTransformCssSubs

 

useDevicePoolCgpnTransformUnknownCSS

 

useDevicePoolCgpnTransformCssUnkn

 

useTrustedRelayPoint

 

useTrustedRelayPoint

 

vendorConfig

 

 

versionStamp

 

 

waitForFarEndH245TerminalSet

 

waitForFarEndH245TerminalSet

 

zone

 

zone

HuntList

 

HuntList

 
 

calledPartyTransformationMask

 

 

callingPartyPrefixDigits

 

 

callingPartyTransformationMask

 

 

callingSearchSpaceName

 

 

callManagerGroupName

 

callManagerGroupName

 

description

 

description

 

dialPlanWizardGenId

 

 

digitDiscardInstructionName

 

 

lineGroupName

 

lineGroupName

 

member

 

member

 

members

 

members

 

name

 

name

 

prefixDigitsOut

 

 

routeListEnabled

 

routeListEnabled

 

selectionOrder

 

selectionOrder

 

 

voiceMailUsage

HuntPilot

 

HuntPilot

 
 

 

aarNeighborhoodName

 

 

alertingName

 

allowDeviceOverride

 

 

 

asciiAlertingName

 

blockEnable

 

blockEnable

 

calledPartyNumberingPlan

 

calledPartyNumberingPlan

 

calledPartyNumberType

 

calledPartyNumberType

 

calledPartyTransformationMask

 

calledPartyTransformationMask

 

callingLinePresentationBit

 

callingLinePresentationBit

 

callingNamePresentationBit

 

callingNamePresentationBit

 

callingPartyNumberingPlan

 

callingPartyNumberingPlan

 

callingPartyNumberType

 

callingPartyNumberType

 

callingPartyPrefixDigits

 

callingPartyPrefixDigits

 

callingPartyTransformationMask

 

callingPartyTransformationMask

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

 

callingSearchSpaceName

 

 

callPickupGroupName

 

connectedLinePresentationBit

 

connectedLinePresentationBit

 

connectedNamePresentationBit

 

connectedNamePresentationBit

 

description

 

description

 

destination

 

destination

 

destination

 

destination

 

destination

 

destination

 

dialPlanName

 

dialPlanName

 

dialPlanWizardGenId

 

 

digitDiscardInstructionName

 

digitDiscardInstructionName

 

 

e164Mask

 

ForwardHuntBusy

 

forwardHuntBusy

 

ForwardHuntNoAnswer

 

forwardHuntNoAnswer

 

huntListName

 

huntListName

 

maxHuntduration

 

maxHuntduration

 

maxHuntduration

 

 

messageWaiting

 

 

networkLocation

 

 

ParkMonForwardNoRetrieveCSSName

 

 

ParkMonForwardNoRetrieveDN

 

 

 

parkMonForwardNoRetrieve

 

pattern

 

pattern

 

patternPrecedence

 

patternPrecedence

 

patternUrgency

 

patternUrgency

 

prefixDigitsOut

 

prefixDigitsOut

 

provideOutsideDialTone

 

provideOutsideDialtone

 

releaseCause

 

releaseClause

 

routeFilterName

 

routeFilterName

 

routePartitionName

 

routePartitionName

 

supportOverlapSending

 

 

usage

 

usage

 

useCallingPartyPhoneMask

 

useCallingPartyPhoneMask

 

usePersonalPreferences

 

usePersonalPreferences

 

usePersonalPreferences

 

usePersonalPreferences

 

 

usePersonalPreferences

IVRUserLocale

 

IvrUserLocale

 
 

orderIndex

 

orderIndex

 

userLocale

 

userLocale

LicenseCapabilities

 

LicenseCapabilities

 
 

enableUPC

 

enableUpc

 

 

enableUps

 

userid

 

userid

Line

 

Line

 
 

aarDestinationMask

 

aarDestinationMask

 

aarKeepCallHistory

 

aarKeepCallHistory

 

aarNeighborhoodName

 

aarNeighborhoodName

 

aarVoiceMailEnabled

 

aarVoiceMailEnabled

 

alertingName

 

alertingName

 

asciiAlertingName

 

asciiAlertingName

 

autoAnswer

 

autoAnswer

 

callForwardAll

 

callForwardAll

 

callForwardAlternateParty

 

callForwardAlternateParty

 

callForwardBusy

 

callForwardBusy

 

callForwardBusyInt

 

callForwardBusyInt

 

callForwardNoAnswer

 

callForwardNoAnswer

 

callForwardNoAnswerInt

 

callForwardNoAnswerInt

 

callForwardNoCoverage

 

callForwardNoCoverage

 

callForwardNoCoverageInt

 

callForwardNoCoverageInt

 

callForwardNotRegistered

 

 

callForwardNotRegisteredInt

 

callForwardNotRegisteredInt

 

callForwardOnFailure

 

callForwardOnFailure

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callingSearchSpaceName

 

 

callPickupGroupName

 

callPickupGroupName

 

cfaCSSClause

 

 

cfaCSSPolicy

 

cfaCssPolicy

 

 

defaultActivatedDeviceName

 

description

 

description

 

destination

 

destination

 

destination

 

destination

 

destination

 

destination

 

destination

 

destination

 

destination

 

destination

 

destination

 

destination

 

destination

 

destination

 

destination

 

destination

 

destination

 

destination

 

destination

 

 

destination

 

 

duration

 

duration

 

duration

 

duration

 

duration

 

 

duration

 

 

duration

 

 

duration

 

 

duration

 

 

duration

 

 

duration

 

 

duration

 

 

duration

 

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

forwardToVoiceMail

 

 

hrDuration

 

hrDuration

 

hrInterval

 

hrInterval

 

networkHoldMOHAudioSourceId

 

networkHoldMohAudioSourceId

 

ParkMonForwardNoRetrieveCSSName

 

parkMonForwardNoRetrieveCssName

 

ParkMonForwardNoRetrieveDN

 

parkMonForwardNoRetrieveDn

 

ParkMonForwardNoRetrieveIntCSSName

 

parkMonForwardNoRetrieveIntCssName

 

ParkMonForwardNoRetrieveIntDN

 

parkMonForwardNoRetrieveIntDn

 

ParkMonForwardNoRetrieveIntVMEnabled

 

parkMonForwardNoRetrieveIntVmEnabled

 

ParkMonForwardNoRetrieveVMEnabled

 

parkMonForwardNoRetrieveVmEnabled

 

ParkMonReversionTimer

 

parkMonReversionTimer

 

partyEntranceTone

 

partyEntranceTone

 

pattern

 

pattern

 

patternPrecedence

 

patternPrecedence

 

presenceGroupName

 

presenceGroupName

 

releaseCause

 

releaseClause

 

routePartitionName

 

routePartitionName

 

 

secondaryCallingSearchSpaceName

 

shareLineAppearanceCSSName

 

shareLineAppearanceCssName

 

usage

 

usage

 

userHoldMOHAudioSourceId

 

userHoldMohAudioSourceId

 

voiceMailProfileName

 

voiceMailProfileName

LineGroup

 

LineGroup

 
 

 

directoryNumber

 

distributionAlgorithm

 

distributionAlgorithm

 

dnPattern

 

 

dnPatternAndPartition

 

 

huntAlgorithmBusy

 

huntAlgorithmBusy

 

huntAlgorithmNoAnswer

 

huntAlgorithmNoAnswer

 

huntAlgorithmNotAvailable

 

huntAlgorithmNotAvailable

 

lineSelectionOrder

 

lineSelectionOrder

 

member

 

member

 

members

 

members

 

name

 

name

 

rnaReversionTimeOut

 

rnaReversionTimeOut

 

routePartitionName

 

Location

 

Location

 
 

id

 

id

 

kbits

 

kbits

 

 

locationName

 

name

 

name

 

 

relatedLocation

 

 

relatedLocations

 

 

rsvpSetting

 

videoKbits

 

videoKbits

MediaResourceGroup

 

MediaResourceGroup

 
 

description

 

description

 

deviceName

 

deviceName

 

deviceName

 

 

deviceName

 

 

member

 

member

 

member

 

 

member

 

 

members

 

members

 

multicast

 

multicast

 

name

 

name

MediaResourceList

 

MediaResourceList

 
 

clause

 

clause

 

mediaResourceGroupName

 

mediaResourceGroupName

 

mediaResourceGroupName

 

 

member

 

 

member

 

member

 

members

 

members

 

name

 

name

 

 

order

MeetMe

 

MeetMe

 
 

description

 

description

 

minimumSecurityLevel

 

minimumSecurityLevel

 

pattern

 

pattern

 

routePartitionName

 

routePartitionName

 

usage

 

usage

MobileSmartClientProfile

 

MobileSmartClientProfile

 
 

enableCFAUri

 

enableCFAUri

 

enableSNRUri

 

enableSnrUri

 

handOffUri

 

handOffUri

 

mobileSmartClient

 

mobileSmartClient

 

name

 

name

MobileVoiceAccess

 

MobileVoiceAccess

 
 

 

locale

 

 

locales

 

 

orderIndex

 

pattern

 

pattern

 

routePartitionName

 

routePartitionName

 

 

userLocale

MOHServer

 

MohServer

 
 

 

audioSource

 

 

audioSources

 

 

baseMulticastIpaddress

 

 

baseMulticastPort

 

 

description

 

devicePoolName

 

devicePoolName

 

fixedAudioSourceDevice

 

fixedAudioSourceDevice

 

isMultiCastEnabled

 

isMultiCastEnabled

 

locationName

 

locationName

 

 

maxHops

 

maxMulticastConnections

 

maxMulticastConnections

 

maxUnicastConnections

 

maxUnicastConnections

 

 

multicastIncrementOnIp

 

name

 

name

 

 

processNodeName

 

runFlag

 

runFlag

 

 

sourceId

 

 

useTrustedRelayPoint

Phone

 

Phone

 
 

aarDestinationMask

 

 

aarKeepCallHistory

 

 

aarNeighborhoodName

 

 

aarNeighborhoodName

 

aarNeighborhoodName

 

aarVoiceMailEnabled

 

 

addOnModule

 

addOnModule

 

addOnModules

 

addOnModules

 

 

addressMode

 

alertingName

 

 

 

allowAutoConfig

 

allowCtiControlFlag

 

allowCtiControlFlag

 

alwaysUsePrimeLine

 

alwaysUsePrimeLine

 

 

alwaysUsePrimeLine

 

alwaysUsePrimeLineforVoiceMessage

 

alwaysUsePrimeLineForVoiceMessage

 

 

alwaysUsePrimeLineForVoiceMessage

 

asciiLabel

 

asciiLabel

 

 

asciiLabel

 

 

asciiLabel

 

 

asciiLabel

 

 

associatedBlfSdFeatures

 

 

associatedEndusers

 

associatedPC

 

 

 

audibleMwi

 

authenticationMode

 

authenticationMode

 

authenticationString

 

authenticationString

 

authenticationURL

 

authenticationUrl

 

autoAnswer

   
 

automatedAlternateRoutingCSSName

 

automatedAlternateRoutingCssName

 

automatedAlternateRoutingCSSName

 

 

blfDest

 

blfDest

 

 

blfDest

 

 

blfDirectedCallPark

 

 

blfDirectedCallParks

 

blfDirn

 

blfDirn

 

 

blfDirn

 

builtInBridgeStatus

 

builtInBridgeStatus

 

busyLampField

 

busyLampField

 

 

busyLampField

 

busyLampFields

 

busyLampFields

 

 

busyLampFields

 

busyTrigger

 

busyTrigger

 

callerName

 

callerName

 

callerNumber

 

callerNumber

 

callForwardAll

 

 

callForwardAlternateParty

 

 

callForwardBusy

 

 

callForwardBusyInt

 

 

callForwardNoAnswer

 

 

callForwardNoAnswerInt

 

 

callForwardNoCoverage

 

 

callForwardNoCoverageInt

 

 

callForwardNotRegistered

 

 

callForwardNotRegisteredInt

 

 

callForwardOnFailure

 

 

callInfoDisplay

 

callInfoDisplay

 

callInfoPrivacyStatus

 

callInfoPrivacyStatus

 

 

callInfoPrivacyStatus

 

callingSearchSpaceName

 

callingSearchSpaceName

 

callPickupGroupName

 

 

certificateOperation

 

certificateOperation

 

certificateStatus

 

certificateStatus

 

cfaCSSClause

 

 

cfaCSSPolicy

 

 

cgpnTransformationCSSName

 

cgpnTransformationCssName

 

class

 

class

 

 

class

 

commonDeviceConfigName

 

commonDeviceConfigName

 

 

commonPhoneConfigName

 

consecutiveRingSetting

 

consecutiveRingSetting

 

 

currentConfig

 

 

currentProfileName

 

 

defaultProfileName

 

description

 

description

 

description

 

 

deviceMobilityMode

 

deviceMobilityMode

 

 

deviceName

 

devicePoolName

 

devicePoolName

 

 

deviceProtocol

 

dialedNumber

 

dialedNumber

 

dialPlanWizardId

 

dialPlanWizardId

 

 

dialRulesName

 

 

digestUser

 

 

directedCallParkDnAndPartition

 

 

directedCallParkId

 

 

directoryNumber

 

directoryURL

 

directoryUrl

 

dirn

 

dirn

 

dirn

 

dirn

 

display

 

display

 

 

displayAscii

 

dndOption

 

dndOption

 

 

dndOption

 

dndRingSetting

 

dndRingSetting

 

 

dndRingSetting

 

 

dndStatus

 

 

dndStatus

 

 

dnPattern

 

e164Mask

 

e164Mask

 

 

emccCallingSearchSpaceName

 

enableExtensionMobility

 

enableExtensionMobility

 

 

enduser

 

 

feature

 

 

geoLocationFilterName

 

 

geolocationInfo

 

 

geoLocationName

 

hlogStatus

 

hlogStatus

 

 

hotlineDevice

 

hrDuration

 

 

hrInterval

 

 

idleTimeout

 

idleTimeout

 

idleURL

 

idleUrl

 

ignorePresentationIndicators

 

ignorePresentationIndicators

 

 

ignorePresentationIndicators

 

 

index

 

 

index

 

 

index

 

 

index

 

 

index

 

 

index

 

informationURL

 

informationUrl

 

isActive

 

isActive

 

 

isDualMode

 

isProtected

 

isProtected

 

joinAcrossLines

 

joinAcrossLines

 

 

joinAcrossLines

 

keySize

 

keySize

 

label

 

label

 

label

 

label

 

label

 

label

 

 

label

 

 

label

 

 

labelAscii

 

line

 

line

 

 

lineIdentifier

 

lines

 

lines

 

loadInformation

 

loadInformation

 

loadInformation

 

loadInformation

 

locationName

 

locationName

 

 

loginDuration

 

 

loginTime

 

 

loginUserId

 

maxNumCalls

 

maxNumCalls

 

mediaResourceListName

 

mediaResourceListName

 

messagesURL

 

messagesUrl

 

mlppDomainId

 

mlppDomainId

 

 

mlppDomainId

 

mlppIndicationStatus

 

mlppIndicationStatus

 

 

mlppIndicationStatus

 

mobileSmartClientProfileName

 

mobileSmartClientProfileName

 

 

mobilityUserIdName

 

model

 

model

 

model

 

model

 

 

model

 

 

monitoringCssName

 

 

mtpPreferedCodec

 

 

mtpRequired

 

mwlPolicy

 

mwlPolicy

 

name

 

name

 

 

name

 

networkHoldMOHAudioSourceId

 

networkHoldMohAudioSourceId

 

networkHoldMOHAudioSourceId

 

 

networkLocale

 

networkLocale

 

networkLocation

 

networkLocation

 

numberOfButtons

 

numberOfButtons

 

 

outboundCallRollover

 

ownerUserId

 

 

 

ownerUserName

 

packetCaptureDuration

 

packetCaptureDuration

 

packetCaptureMode

 

packetCaptureMode

 

 

partitionUsage

 

pattern

 

 

patternPrecedence

 

 

phoneLoadName

 

 

 

phoneService

 

 

phoneServiceCategory

 

phoneServiceDisplay

 

phoneServiceDisplay

 

phoneSuite

 

phoneSuite

 

phoneTemplateName

 

phoneTemplateName

 

 

phoneTemplateName

 

preemption

 

preemption

 

 

preemption

 

presenceGroupName

 

presenceGroupName

 

presenceGroupName

 

 

 

primaryPhoneName

 

 

priority

 

product

 

product

 

 

product

 

protocol

 

protocol

 

protocolSide

 

protocolSide

 

proxyServerURL

 

proxyServerUrl

 

 

recordingFlag

 

 

recordingProfileName

 

redirectedNumber

 

redirectedNumber

 

releaseCause

 

 

remoteDevice

 

remoteDevice

 

 

remoteSipSrstIp

 

 

remoteSipSrstPort

 

 

remoteSrstIp

 

 

remoteSrstOption

 

 

remoteSrstPort

 

requireDTMFReception

 

requireDtmfReception

 

rerouteCallingSearchSpace

 

rerouteCallingSearchSpaceName

 

retryVideoCallAsAudio

 

retryVideoCallAsAudio

 

RFC2833Disabled

 

rfc2833Disabled

 

ringSetting

 

ringSetting

 

 

ringSettingActivePickupAlert

 

ringSettingBusyBLFAudibleAlert

 

ringSettingBusyBlfAudibleAlert

 

ringSettingIdleBLFAudibleAlert

 

ringSettingIdleBlfAudibleAlert

 

 

ringSettingIdlePickupAlert

 

 

roamingDevicePoolName

 

 

routePartition

 

 

routePartition

 

routePartitionName

 

routePartitionName

 

 

routePartitionName

 

 

secureAuthenticationUrl

 

 

secureDirectoryUrl

 

 

secureIdleUrl

 

 

secureInformationUrl

 

 

secureMessageUrl

 

 

secureServicesUrl

 

 

securityProfileName

 

 

sendGeoLocation

 

 

serviceNameAscii

 

 

services

 

servicesURL

 

servicesUrl

 

shareLineAppearanceCSSName

 

 

singleButtonBarge

 

singleButtonBarge

 

 

singleButtonBarge

 

 

sipProfileName

 

softkeyTemplateName

 

softkeyTemplateName

 

 

softkeyTemplateName

 

speeddial

 

speeddial

 

 

speedDial

 

speeddials

 

speeddials

 

 

sshPwd

 

 

sshUserId

 

subscribeCallingSearchSpace

 

 

 

subscribeCallingSearchSpaceName

 

 

telecasterServiceName

 

traceFlag

 

traceFlag

 

unattendedPort

 

unattendedPort

 

upgradeFinishTime

 

upgradeFinishTime

 

 

url

 

 

urlButtonIndex

 

 

urlLabel

 

 

urlLabelAscii

 

usage

 

 

useDevicePoolCgpnTransformCSS

 

useDevicePoolCgpnTransformCss

 

userHoldMOHAudioSourceId

 

userHoldMohAudioSourceId

 

userHoldMOHAudioSourceId

 

userHoldMohAudioSourceId

 

userLocale

 

userlocale

 

 

useTrustedRelayPoint

 

 

vendor

 

vendorConfig

 

vendorConfig

 

 

version

 

versionStamp

 

versionStamp

 

voiceMailProfileName

   

PhoneTemplate

 

PhoneButtonTemplate

 
 

basePhoneTemplateName

 

basePhoneTemplateName

 

button

 

button

 

 

buttonNumber

 

buttons

 

buttons

 

feature

 

feature

 

isUserModifiable

 

isUserModifiable

 

label

 

label

 

name

 

name

PhysicalLocation

 

PhysicalLocation

 
 

 

description

 

name

 

name

ProcessNode

 

ProcessNode

 
 

description

 

description

 

IPv6Name

 

ipv6Name

 

mac

 

mac

 

name

 

name

     

nodeUsage

ProcessNodeService

 

ProcessNodeService

 
 

deviceNameMonitorFlag

 

 

deviceTypeMonitorFlag

 

 

enable

 

enable

 

fileTraceFlag

 

 

includeNonDeviceTraces

 

 

 

isActive

 

 

maxFileSize

 

numFiles

 

numFiles

 

numLines

 

 

numMinutes

 

 

outputDebugStringFlag

 

 

 

processNodeName

 

serverName

 

 

service

 

service

 

traceLevel

 

traceLevel

 

userCategories

 

userCategories

 

useXML

 

 

deviceNameMonitorFlag

 

RecordingProfile

 

RecordingProfile

 
 

name

 

name

 

recordingCSSName

 

recordingCssName

 

recorderDestination

 

recorderDestination

Region

 

Region

 
 

defaultCodec

 

defaultCodec

 

name

 

name

 

 

bandwidth

 

 

lossyNetwork

 

 

regionName

 

 

relatedRegion

 

 

relatedRegions

 

 

videoBandwidth

RegionMatrix

 

RegionMatrix

 
 

bandwidth

 

bandwidth

 

lossyNetwork

 

lossyNetwork

 

 

regionAName

 

 

regionBName

 

videoBandwidth

 

videoBandwidth

RemoteDestination

 

RemoteDestination

 
 

answerTooLateTimer

 

answerTooLateTimer

 

answerTooSoonTimer

 

answerTooSoonTimer

 

delayBeforeRingingCell

 

delayBeforeRingingCell

 

destination

 

destination

 

 

dualModeDeviceName

 

enableMobileConnect

 

enableMobileConnect

 

 

index

 

isMobilePhone

 

isMobilePhone

 

 

lineAssociation

 

 

lineAssociations

 

mobileSmartClientName

 

mobileSmartClientName

 

name

 

name

 

 

pattern

 

remoteDestinationProfileName

 

remoteDestinationProfileName

 

 

routePartitionName

 

timeZone

 

timeZone

 

todAccessName

 

todAccessName

 

 

uuid

RemoteDestinationProfile

 

RemoteDestinationProfile

 
 

 

asciiLabel

 

 

associatedEndusers

 

 

audibleMwi

 

 

busyTrigger

 

 

callerName

 

 

callerNumber

 

 

callInfoDisplay

 

callInfoPrivacyStatus

 

callInfoPrivacyStatus

 

callingSearchSpaceName

 

callingSearchSpaceName

 

cgpnTransformationCSSName

 

cgpnTransformationCssName

 

class

 

class

 

 

consecutiveRingSetting

 

description

 

description

 

devicePoolName

 

devicePoolName

 

 

dialedNumber

 

 

dialPlanWizardId

 

 

directoryNumber

 

 

dirn

 

 

display

 

 

displayAscii

 

dndOption

 

dndOption

 

dndRingSetting

 

 

dndStatus

 

dndStatus

 

 

e164Mask

 

 

enduser

 

ignorePresentationIndicators

 

ignorePresentationIndicators

 

 

index

 

 

label

 

 

line

 

 

lineIdentifier

 

 

lines

 

 

maxNumCalls

 

mobileSmartClientProfileName

 

mobileSmartClientProfileName

 

model

 

model

 

 

monitoringCssName

 

 

mwlPolicy

 

name

 

name

 

networkHoldMOHAudioSourceId

 

networkHoldMohAudioSourceId

 

 

partitionUsage

 

 

primaryPhoneName

 

product

 

product

 

protocol

 

protocol

 

protocolSide

 

protocolSide

 

 

recordingFlag

 

 

recordingProfileName

 

 

redirectedNumber

 

rerouteCallingSearchSpace

 

 

 

rerouteCallingSearchSpaceName

 

 

ringSetting

 

 

ringSettingActivePickupAlert

 

 

ringSettingIdlePickupAlert

 

 

routePartitionName

 

 

speedDial

 

useDevicePoolCgpnTransformCSS

 

useDevicePoolCgpnTransformCss

 

userHoldMOHAudioSourceId

 

userHoldMohAudioSourceId

 

userId

 

userId

     

userLocale

ResourcePriorityNamespace

 

ResourcePriorityNamespace

 
 

 

description

 

 

isDefault

 

namespace

 

namespace

ResourcePriorityNamespaceList

 

ResourcePriorityNamespaceList

 
 

 

description

 

 

index

 

member

 

member

 

member

 

 

members

 

members

 

name

 

name

 

resourcePriorityNamespaceName

 

resourcePriorityNamespaceName

 

resourcePriorityNamespaceName

 

RouteFilter

 

RouteFilter

 
 

clause

 

clause

 

dialPlanName

 

dialPlanName

 

dialPlanTagName

 

dialPlanTagName

 

dialPlanTagName

 

 

dialPlanWizardGenId

 

dialPlanWizardGenId

 

digits

 

digits

 

digits

 

 

member

 

member

 

member

 

 

members

 

members

 

name

 

name

 

operator

 

operator

 

operator

 

 

 

priority

RouteGroup

 

RouteGroup

 
 

deviceName

 

deviceName

 

deviceName

   
 

deviceSelectionOrder

 

deviceSelectionOrder

 

deviceSelectionOrder

   
 

dialPlanWizardGenId

 

dialPlanWizardGenId

 

dialPlanWizardGenId

 

dialPlanWizardGenld

 

dialPlanWizardGenId

 

 

 

distributionAlgorithm

 

member

 

member

 

member

 

 

members

 

members

 

name

 

name

 

 

port

RouteList

 

RouteList

 
 

calledPartyNumberingPlan

 

calledPartyNumberingPlan

 

calledPartyNumberType

 

calledPartyNumberType

 

calledPartyTransformationMask

 

calledPartyTransformationMask

 

callingPartyNumberingPlan

 

callingPartyNumberingPlan

 

callingPartyNumberType

 

callingPartyNumberType

 

callingPartyPrefixDigits

 

callingPartyPrefixDigits

 

callingPartyTransformationMask

 

callingPartyTransformationMask

 

callingSearchSpaceName

 

 

callManagerGroupName

 

callManagerGroupName

 

description

 

description

 

dialPlanWizardGenId

 

dialPlanWizardGenId

 

digitDiscardInstructionName

 

digitDiscardInstructionName

 

member

 

member

 

members

 

members

 

name

 

name

 

prefixDigitsOut

 

prefixDigitsOut

 

routeGroupName

 

routeGroupName

 

routeListEnabled

 

routeListEnabled

 

selectionOrder

 

selectionOrder

 

useFullyQualifiedCallingPartyNumber

 

useFullyQualifiedCallingPartyNumber

RoutePartition

 

RoutePattern

 
 

allowDeviceOverride

 

allowDeviceOverride

 

authorizationCodeRequired

 

authorizationCodeRequired

 

authorizationLevelRequired

 

authorizationLevelRequired

 

blockEnable

 

blockEnable

 

calledPartyNumberingPlan

 

calledPartyNumberingPlan

 

calledPartyNumberType

 

calledPartyNumberType

 

calledPartyTransformationMask

 

calledPartyTransformationMask

 

callingLinePresentationBit

 

callingLinePresentationBit

 

callingNamePresentationBit

 

callingNamePresentationBit

 

callingPartyNumberingPlan

 

callingPartyNumberingPlan

 

callingPartyNumberType

 

callingPartyNumberType

 

callingPartyPrefixDigits

 

callingPartyPrefixDigits

 

callingPartyTransformationMask

 

callingPartyTransformationMask

 

cic

 

cic

 

clientCodeRequired

 

clientCodeRequired

 

connectedLinePresentationBit

 

connectedLinePresentationBit

 

 

connectedLinePresentationBit

 

connectedNamePresentationBit

 

connectedNamePresentationBit

 

 

connectedNamePresentationBit

 

description

 

description

 

destination

 

destination

 

dialPlanName

 

dialPlanName

 

dialPlanWizardGenId

 

dialPlanWizardGenId

 

digitDiscardInstructionName

 

digitDiscardInstructionName

 

 

gatewayName

 

isdnNFSInfoElement

 

isdnNsfInfoElement

 

messageWaiting

 

 

networkLocation

 

networkLocation

 

 

networkService

 

networkServiceProtocol

 

networkServiceProtocol

 

 

paramValue

 

pattern

 

pattern

 

patternPrecedence

 

patternPrecedence

 

patternUrgency

 

patternUrgency

 

prefixDigitsOut

 

prefixDigitsOut

 

provideOutsideDialtone

 

provideOutsideDialtone

 

releaseCause

 

releaseClause

 

resourcePriorityNameSpaceName

 

resourcePriorityNamespaceName

 

 

routeClass

 

routeFilterName

 

routeFilterName

 

routeListName

 

routeListName

 

routePartitionName

 

routePartitionName

 

supportOverlapSending

 

supportOverlapSending

 

usage

 

usage

 

useCallingPartyPhoneMask

 

useCallingPartyPhoneMask

 

withTag

 

withTag

 

withValueClause

 

withValueClause

RoutePattern

 

RoutePartition

 
 

description

 

description

 

dialPlanWizardGenId

 

dialPlanWizardGenId

 

name

 

name

 

partitionUsage

 

partitionUsage

 

timeScheduleName

 

timeScheduleIdName

 

timeZone

 

timeZone

 

useOriginatingDeviceTimeZone

 

useOriginatingDeviceTimeZone

ServiceParameter

 

ServiceParameter

 
 

name

 

name

 

newValue

   
 

processNodeName

 

processNodeName

 

service

 

service

 

 

value

 

 

valueType

SIPProfile

 

SipProfile

 
 

abbreviatedDialURI

 

abbreviatedDialUri

 

anonymousCallBlock

 

anonymousCallBlock

 

callerIdBlock

 

callerIdBlock

 

callForwardURI

 

callForwardUri

 

callHoldRingback

 

callHoldRingback

 

callpickupGroupURI

 

callpickupGroupUri

 

callpickupListURI

 

callpickupListUri

 

callpickupURI

 

callpickupUri

 

callStats

 

callStats

 

confJoinEnable

 

confJointEnable

 

defaultTelephonyEventPayloadType

 

defaultTelephonyEventPayloadType

 

description

 

description

 

dndControl

 

dndControl

 

dtmfDbLevel

 

dtmfDbLevel

 

enableVAD

 

enableVad

 

maxRedirects

 

maxRedirects

 

meetmeServiceURI

 

meetmeServiceUrl

 

name

 

name

 

redirectByApplication

 

redirectByApplication

 

rerouteIncomingRequest

 

rerouteIncomingRequest

 

resourcePriorityNamespaceListName

 

resourcePriorityNamespaceListName

 

retryInvite

 

retryInvite

 

retryNotInvite

 

retryNotInvite

 

rfc2543Hold

 

rfc2543Hold

 

ringing180

 

ringing180

 

semiAttendedTransfer

 

semiAttendedTransfer

 

startMediaPort

 

startMediaPort

 

stopMediaPort

 

stopMediaPort

 

stutterMsgWaiting

 

stutterMsgWaiting

 

t38Invite

 

t38Invite

 

telnetLevel

 

telnetLevel

 

timerInvite

 

timerInvite

 

timerKeepAlive

 

timerKeepAlive

 

timerOffhookToFirstDigit

 

timerOffHookToFirstDigit

 

timerRegister

 

timerRegister

 

timerRegisterDelta

 

timerRegisterDelta

 

timerSubscribe

 

timerSubscribe

 

timerSubscribeDelta

 

timerSubscribeDelta

 

timerT1

 

timerT1

 

timerT2

 

timerT2

 

userInfo

 

userInfo

 

 

enableAnatForEarlyOfferCalls

 

 

fallbackToLocalRsvp

 

 

gClear

 

 

rsvpOverSip

 

 

sipRe11XxEnabled

SIPRealm

 

SipRealm

 
 

digestCredentials

 

digestCredentials

 

realm

 

realm

 

userid

 

userid

SIPRoutePattern

 

SipRoutePattern

 
 

blockEnable

 

blockEnable

 

callingLinePresentationBit

 

callingLinePresentationBit

 

callingNamePresentationBit

 

callingNamePresentationBit

 

callingPartyPrefixDigits

 

callingPartyPrefixDigits

 

callingPartyTransformationMask

 

callingPartyTransformationMask

 

connectedLinePresentationBit

 

connectedLinePresentationBit

 

connectedNamePresentationBit

 

connectedNamePresentationBit

 

description

 

description

 

destination

 

 

dnOrPatternIPv6

 

dnOrPatternIpv6

 

 

domainRoutingCssName

 

pattern

 

pattern

 

 

routeOnUserPart

 

routePartitionName

 

routePartitionName

 

sipTrunkName

 

sipTrunkName

 

usage

 

usage

 

 

useCallerCss

 

useCallingPartyPhoneMask

 

useCallingPartyPhoneMask

SIPTrunk

 

SipTrunk

 
 

 

aarNeighborhoodName

 

acceptInboundRDNIS

 

acceptInboundRdnis

 

acceptOutboundRDNIS

 

acceptOutboundRdnis

 

automatedAlternateRoutingCSS

 

automatedAlternateRoutingCssName

 

callerIdDN

 

callerIdDn

 

callerName

 

callerName

 

callingLineIdPresentation

 

callingLineIdPresentation

 

callingname

 

callingname

 

callingPartySelection

 

callingPartySelection

 

callingSearchSpaceName

 

callingSearchSpaceName

 

cdpnTransformationCSSName

 

cdpnTransformationCssName

 

cgpnTransformationCSSName

 

cgpnTransformationCssName

 

cgpnTransformationUnknownCSSName

 

 

class

 

class

 

 

cntdPnTransformationCssName

 

 

commonDeviceConfigName

 

connectedNamePresentation

 

connectedNamePresentation

 

connectedPartyIdPresentation

 

connectedPartyIdPresentation

 

description

 

description

 

destAddrIsSRV

 

destAddrIsSrv

 

destinationaddress

 

destinationAddress

 

destinationAddressIPv6

 

destinationAddressIpv6

 

destinationport

 

destinationport

 

devicePoolName

 

devicePoolName

 

 

dtmfSignalingMethod

 

 

geoLocationFilterName

 

 

geoLocationName

 

 

imeE164TransformationName

 

incomingport

 

 

isPaiEnabled

 

isPaiEnabled

 

isRpidEnabled

 

isRpidEnabled

 

licensedCapacity

 

 

loadInformation

 

loadInformation

 

locationName

 

locationName

 

mediaResourceListName

 

mediaResourceListName

 

mlppDomainId

 

mlppDomainId

 

mlppIndicationStatus

 

mlppIndicationStatus

 

model

 

model

 

mtpRequired

 

mtpRequired

 

name

 

name

 

Name

 

 

 

networkHoldMohAudioSourceId

 

networkLocation

 

networkLocation

 

OutgoingTransportType

 

 

 

packetCaptureDuration

 

 

packetCaptureMode

 

preemption

 

preemption

 

prefixDN

 

prefixDn

 

 

presenceGroupName

 

product

 

product

 

protocol

 

protocol

 

protocolSide

 

protocolSide

 

 

pstnAccess

 

referCallingSearchSpaceName

 

referCallingSearchSpaceName

 

rerouteCallingSearchSpaceName

 

rerouteCallingSearchSpaceName

 

retryVideoCallAsAudio

 

retryVideoCallAsAudio

 

 

routeClassSignalling

 

securityProfileName

 

securityProfileName

 

 

sendGeoLocation

 

sigDigits

 

sigDigits

 

sipAssertedType

 

sipAssertedType

 

sipPrivacy

 

sipPrivacy

 

sipProfileName

 

sipProfileName

 

 

sipTrunkType

 

srtpAllowed

 

srtpAllowed

 

srtpFallbackAllowed

 

srtpFallbackAllowed

 

subscribeCallingSearchSpaceName

 

subscribeCallingSearchSpaceName

 

tkSipCodec

 

tkSipCodec

 

traceFlag

 

traceFlag

 

 

transmitUtf8

 

 

unattendedPort

 

 

unknownPrefix

 

useDevicePoolCdpnTransformCSS

 

useDevicePoolCdpnTransformCss

 

useDevicePoolCgpnTransformCSS

 

useDevicePoolCgpnTransformCss

 

useDevicePoolCgpnTransformUnknownCSS

 

 

 

useDevicePoolCntdPnTransformationCss

 

 

useImePublicIpPort

 

 

userHoldMohAudioSourceId

 

useTrustedRelayPoint

 

useTrustedRelayPoint

 

vendorConfig

   
 

versionStamp

 

versionStamp

SIPTrunkSecurityProfile

 

SipTrunkSecurityProfile

 
 

acceptOutOfDialogRefer

 

acceptOutOfDialogRefer

 

acceptPresenceSubscription

 

acceptPresenceSubscription

 

acceptUnsolicitedNotification

 

acceptUnsolicitedNotification

 

allowReplaceHeader

 

allowReplaceHeader

 

applLevelAuthentication

 

applLevelAuthentication

 

description

 

description

 

digestAuthentication

 

digestAuthentication

 

incomingPort

 

incomingPort

 

incomingTransport

 

incomingTransport

 

name

 

name

 

noncePolicyTime

 

noncePolicyTime

 

outgoingTransport

 

outgoingTransport

 

securityMode

 

securityMode

 

transmitSecurityStatus

 

transmitSecurityStatus

 

x509SubjectName

 

x509SubjectName

SoftKeyTemplate

 

SoftKeyTemplate

 
 

application

 

application

 

applications

 

applications

 

baseSoftkeyTemplateName

 

baseSoftkeyTemplateName

 

description

 

description

 

isDefault

 

isDefault

 

name

 

name

TimePeriod

 

TimePeriod

 
 

dayOfMonth

 

dayOfMonth

 

dayOfMonthEnd

 

dayOfMonthEnd

 

description

 

description

 

endDay

 

endDay

 

endTime

 

endTime

 

isPublished

 

isPublished

 

monthOfYear

 

monthOfYear

 

monthOfYearEnd

 

monthOfYearEnd

 

name

 

name

 

startDay

 

startDay

 

startTime

 

startTime

     

todOwnerIdName

TimeSchedule

 

TimeSchedule

 
 

isPublished

 

description

 

member

 

isPublished

 

members

 

member

 

name

 

members

 

timePeriodName

 

name

 

timeScheduleCategory

 

timeScheduleCategory

 

 

todOwnerIdName

TODAccess

 

TodAccess

 
 

name

 

name

 

ownerIdName

 

ownerIdName

 

 

associatedRemoteDestination

 

 

description

 

 

member

 

 

members

 

 

remoteDestination

Transcoder

 

Transcoder

 
 

commonDeviceConfigName

 

commonDeviceConfigName

 

description

 

description

 

devicePoolName

 

devicePoolName

 

isTrustedRelayPoint

 

isTrustedRelayPoint

 

loadInformation

 

loadInformation

 

maximumCapacity

 

maximumCapacity

 

name

 

name

 

product

 

product

 

subUnit

 

subUnit

 

vendorConfig

 

vendorConfig

TransPattern

 

TransPattern

 
 

allowDeviceOverride

 

 

blockEnable

 

blockEnable

 

calledPartyNumberingPlan

 

calledPartyNumberingPlan

 

calledPartyNumberType

 

calledPartyNumberType

 

calledPartyTransformationMask

 

calledPartyTransformationMask

 

callingLinePresentationBit

 

callingLinePresentationBit

 

callingNamePresentationBit

 

callingNamePresentationBit

 

callingPartyNumberingPlan

 

callingPartyNumberingPlan

 

callingPartyNumberType

 

callingPartyNumberType

 

callingPartyPrefixDigits

 

callingPartyPrefixDigits

 

callingPartyTransformationMask

 

callingPartyTransformationMask

 

callingSearchSpaceName

 

callingSearchSpaceName

 

connectedLinePresentationBit

 

callInterceptProfileName

 

connectedNamePresentationBit

 

connectedLinePresentationBit

 

description

 

connectedNamePresentationBit

 

dialPlanName

 

description

 

dialPlanWizardGenId

 

 

digitDiscardInstructionName

 

digitDiscardInstructionName

 

messageWaiting

 

 

networkLocation

 

 

pattern

 

pattern

 

patternPrecedence

 

patternPrecedence

 

patternUrgency

 

patternUrgency

 

prefixDigitsOut

 

prefixDigitsOut

 

provideOutsideDialtone

 

provideOutsideDialtone

 

releaseCause

 

releaseClause

 

resourcePriorityNameSpaceName

 

resourcePriorityNamespaceName

 

 

routeClass

 

routeFilterName

 

routeFilterName

 

 

routeNextHopByCgpn

 

routePartitionName

 

routePartitionName

 

usage

 

usage

 

useCallingPartyPhoneMask

 

useCallingPartyPhoneMask

User

 

User

 
 

 

associatedCapfProfiles

 

associatedDevices

 

associatedDevices

 

 

associatedGroups

 

associatedPC

 

associatedPc

 

 

associatedTodAccess

 

 

capfProfileInstanceId

 

 

ctiControlledDeviceProfiles

 

 

defaultProfile

 

department

 

department

 

device

 

device

 

digestCredentials

 

digestCredentials

 

enableCTI

 

enableCti

 

 

enableEmcc

 

enableMobileVoiceAccess

 

enableMobileVoiceAccess

 

enableMobility

 

enableMobility

 

extension

 

 

firstname

 

firstName

 

lastname

 

lastName

 

 

mailid

 

manager

 

manager

 

MaxDeskPickupWaitTime

 

maxDeskPickupWaitTime

 

 

middleName

 

 

name

 

password

 

password

 

pattern

 

pattern

 

phoneProfiles

 

phoneProfiles

 

pin

 

pin

 

 

pinCredDoesNotExpire

 

 

pinCredentials

 

 

pinCredLockedByAdministrator

 

 

pinCredPolicyName

 

 

pinCredTimeAdminLockout

 

 

pinCredTimeChanged

 

 

pinCredUserCantChange

 

 

pinCredUserMustChange

 

 

presenceGroupName

 

 

primaryDevice

 

primaryExtension

 

primaryExtension

 

profileName

 

profileName

 

 

profileName

 

 

pwdCredDoesNotExpire

 

 

pwdCredLockedByAdministrator

 

 

pwdCredTimeAdminLockout

 

 

pwdCredTimeChanged

 

 

pwdCredUserCantChange

 

 

pwdCredUserMustChange

 

remoteDestinationLimit

 

 

routePartitionName

 

routePartitionName

 

 

status

 

 

subscribeCallingSearchSpaceName

 

telephoneNumber

 

telephoneNumber

 

 

todAccess

 

 

userGroup

 

userid

 

userid

 

userLocale

 

userLocale

 

 

userRole

 

 

userRoles

UserGroup

 

UserGroup

 
 

member

 

member

 

members

 

members

 

name

 

name

 

userId

 

userId

VG224

 

Vg224

 
     

beginPort

 

callManagerGroupName

 

callManagerGroupName

 

description

 

description

 

domainName

 

domainName

 

 

index

 

 

index

 

product

 

product

 

product

 

product

 

 

product

 

protocol

 

protocol

 

subunit

 

subunit

 

subunits

 

subunits

 

unit

 

unit

 

units

 

units

 

 

vendorConfig

 

 

versionStamp

VoiceMailPilot

 

VoiceMailPilot

 
 

CSSName

 

cssName

 

description

 

description

 

dirn

 

dirn

 

isDefault

 

isDefault

VoiceMailPort

 

VoiceMailPort

 
 

 

aarNeighborhoodName

 

automatedAlternateRoutingCSSName

 

automatedAlternateRoutingCssName

 

 

callerIdDisplay

 

 

callerIdDisplayAscii

 

callingSearchSpaceName

 

callingSearchSpaceName

 

 

class

 

commonDeviceConfigName

 

commonDeviceConfigName

 

description

 

description

 

devicePoolName

 

devicePoolName

 

 

dnCallingSearchSpace

 

 

dnPattern

 

 

externalMask

 

 

geoLocationName

 

loadInformation

 

 

locationName

 

locationName

 

 

model

 

name

 

name

 

 

preemption

 

 

product

 

 

protocol

 

 

protocolSide

 

 

routePartition

 

 

securityProfileName

 

traceFlag

   
 

useTrustedRelayPoint

 

useTrustedRelayPoint

VoiceMailProfile

 

VoiceMailProfile

 
 

 

cssName

 

description

 

description

 

 

dirn

 

isDefault

 

isDefault

 

name

 

name

 

voiceMailboxMask

 

voiceMailboxMask

 

 

voiceMailPilot


Schema and Other Changes

The following changes are made in the AXL schema in release 8.0(1):

Single file for schema called AXLSoap.xsd and it is a combination of axl.xsd and axlsoap.xsd.

Changes in API and tag names in several APIs. These changes ensures consistency in naming APIs and their tags across all the AXL APIs. The following examples ilustrates the changes made:

In addAARGroup handler, AARGroup element is changed to aarGroup. See Figure 2-1 and Figure 2-2.

Figure 2-1 addAARGroup element in Unified CM Release 7.1(2)

Figure 2-2 addAarGroup element in Unified CM Release 8.0(1)

In addAppUser handler the newApplicationUser element is replaced with appUser. See Figure 2-3 and Figure 2-4.

Figure 2-3 newAppicationUser element in Unified CM 7.1(2)

Figure 2-4 appUser element in Unified CM 8.0(1)

In addCalledPartyTransformationPattern handler the newPattern element is replaced with calledPartyTransformationPattern. See Figure 2-5 and Figure 2-6.

Figure 2-5 newPattern element in Unified CM 7.1(2)

Figure 2-6 calledPartyTransformationPattern element in Unified CM 8.0(1)

In addRecordingProfile handler the recordingCSSName element is replaced with recordingCssName. See Figure 2-7 and Figure 2-8.

Figure 2-7 recordingCSSName element in Unified CM 7.1(2)

Figure 2-8 recordingCssName element in Unified CM 8.0(1)

The Get and List requests have a new optional tag called returnedTags. This tag has all the tags of that API as optional subtags. If any of the tags are sent in the request, only those tags are returned in the response. Also, there is a new searchCriteria tag in which you can specify the parameters for the search. The searchCriteria tag is present only for List APIs and is not available in Get APIs. Figure 2-9 illustrates the implementation for Get and List methods in AXL from Unified CM 8.0.

Figure 2-9 Optional Tags—returnedTags in Get Operation

Figure 2-10 Optional Tags—searchCriteria and returnedTags in List Operation

There are no attributes listed in any tag. The only exception is the uuid attribute. The attributes found in various tags, in earlier Unified CM releases, have been replaced with tags. For example, index attributes present in line, gateway, and member tags are removed and index tags have been added.

A uuid attribute added to the name tag. There is no uuid tag in any of the operations.

In Unified CM 8.0(1) the AXL returns 500 Internal Server Error response status code for indicating internal server error. Earlier releases of Unified CM returned the 200 code for indicating internal server errors.

List API added for every Handler. Specific List APIs like listPhoneByName, listPhoneByDescription, and so on are removed. A listPhone API with a search criteria that can be specified by the user is introduced.

New Information for Unified CM 7.1(2)

Unified CM (Unified CM) 7.1(2) APIs are compatible with all previous releases of Unified CM. For additional details about the Unified CM database schema changes, refer to the Unified CM Data Dictionary for Release 7.1(2).

The following sections describe API updates that were made in Unified CM 7.1(2):

New APIs

Changed Operations

New APIs

Table 2-5 describes new operations in Unified CM 7.1(2).

Table 2-5 New Operations in Unified CM 7.1(2) 

Operation
Purpose
Added Tags

addGeoLocation

updateGeoLocation

getGeoLocation

removeGeoLocation

Added for logical partitioning feature.

name(mandatory)
country
description
nationalSubdivision
district
communityName
cityDivision
neighbourhood
street
leadingStreetDirection
trailingStreetSuffix
streetSuffix
houseNumber
houseNumberSuffix
landmark
location
floor
occupantName
postalCode

addGeoLocationPolicy

updateGeoLocationPolicy

getGeoLocationPolicy

removeGeoLocationPolicy

Added for logical partitioning feature.

name(mandatory)
country
description
nationalSubdivision
district
communityName
cityDivision
neighbourhood
street
leadingStreetDirection
trailingStreetSuffix
streetSuffix
houseNumber
houseNumberSuffix
landmark
location
floor
occupantName
postalCode
relatedPolicies, relatedPolicy,
geoLocationPolicyA
geoLocationPolicyAName
geoLocationDeviceA
geoLocationPolicyB
geoLocationPolicyBName
geoLocationDeviceB
logicalPartitionPolicy

addGeoLocationFilter

updateGeoLocationFilter

getGeoLocationFilter

removeGeoLocationFilter

Added for logical partitioning feature.

name
description
useCountry
useNationalSubDivision
useDistrict
useCommunityName
useCityDivision
useNeighbourhood
useStreet
useLeadingStreetDirection
useTrailingStreetSuffix
useStreetSuffix
useHouseNumber
useHouseNumberSuffix
useLandmark
useLocation
useFloor
useOccupantName
usePostalCode

addCommonPhoneConfig

updateCommonPhoneConfig

getCommonPhoneConfig

removeCommonPhoneConfig

Added for phone support feature.

name
description
unlockPwd
dndOption
dndAlertingType
backgroundImage
phonePersonalization
phoneServiceDisplay
sshUserId
sshPwd
alwaysUsePrimeLine
alwaysUsePrimeLineforVoiceMessage
vendorConfig


Changed Operations

Table 2-6 describes changed operations in Unified CM 7.1(2).

Table 2-6 Changed Operations in Unified CM 7.1(2) 

Operation
Change
Tags

addLine

updateLine

getLine

Added optional tags for park monitoring feature.

ParkMonForwardNoRetrieveDN
ParkMonForwardNoRetrieveIntDN
ParkMonForwardNoRetrieveIntVMEnabled
ParkMonForwardNoRetrieveVMEnabled
ParkMonForwardNoRetrieveCSS
ParkMonForwardNoRetrieveIntCSS
ParkMonReversionTimer

addLine

updateLine

getLine

Added optional tag for barge enchancement feature.

partyEntranceTone

addHuntPilot

updateHuntPilot

getHuntPilot

Added optional tags for park monitoring feature.

ParkMonForwardNoRetrieveDN
ParkMonForwardNoRetrieveCSS

addH323Gateway

updateH323Gateway

getH323Gateway

Added optional tags for H.235 - H.323 security: voice encryption profile with native H.235/H.245 key management feature.

AllowH235PassThrough

Added optional tags for logical partitioning feature.

geoLocationName
geoLocationFilterName
sendGeoLocation

Added optional tags for QSIG variant Per Trunk or Gateway feature.

ASN1ROSEOIDEncoding
QSIGVariant
tunneledProtocol

 

Added optional tags for more enhancements to CPN transformations.

nationalStripDigits
internationalStripDigits
unknownStripDigits
subscriberStripDigits
cgpnTransformationNationalCSS
cgpnTransformationInternationalCSS
cgpnTransformationUnknownCSS
cgpnTransformationSubscriberCSS
useDevicePoolCgpnTransformNationalCSS
useDevicePoolCgpnTransformInternationalCSS
useDevicePoolCgpnTransformUnknownCSS
useDevicePoolCgpnTransformSubscriberCSS

addH323Trunk

updateH323Trunk

getH323Trunk

Added optional tag for H.235 - H.323 security: voice encryption profile with native H.235/H.245 key management feature.

AllowH235PassThrough

Added optional tags for logical partitioning feature.

geoLocationName
geoLocationFilterName
sendGeoLocation

Added optional tags for QSIG variant per trunk or gateway feature.

ASN1ROSEOIDEncoding
QSIGVariant

Added optional tags for more enhancements to CPN transformations.

nationalStripDigits
internationalStripDigits
unknownStripDigits
subscriberStripDigits
cgpnTransformationNationalCSS
cgpnTransformationInternationalCSS
cgpnTransformationUnknownCSS
cgpnTransformationSubscriberCSS
useDevicePoolCgpnTransformNationalCSS
useDevicePoolCgpnTransformInternationalCSS
useDevicePoolCgpnTransformUnknownCSS
useDevicePoolCgpnTransformSubscriberCSS

addCommonDeviceConfig

updateCommonDeviceConfig

getCommonDeviceConfig

Added optional tags for IPv6 feature.

IPAddressingMode
IPAddressingModePreferenceControl allowAutoConfigurationForPhones

addSIPProfile

updateSIPProfile

getSIPProfile

Added optional tag for IPv6 feature.

enableAnatForEarlyOfferCalls

Added optional tag called to enhance Clear Channel (G.clear) support feature.

gClear

addProcessNode

updateProcessNode

getProcessNode

Added optional tag for IPv6 feature.

IPv6Name

addSIPRoutePattern

updateSIPRoutePattern

getSIPRoutePattern

Added optional tag for IPv6 feature.

dnOrPatternIPv6

addPhone

updatePhone

getPhone

Added optional tags for logical partitioning feature.

geoLocationName
geoLocationFilterName
sendGeoLocation

Added optional tags for always-use- primeline feature.

alwaysUsePrimeLine alwaysUsePrimeLineforVoiceMessage

addH323Phone

updateH323Phone

getH323Phone

Added optional tags for logical partitioning feature.

geoLocationName
geoLocationFilterName
sendGeoLocation

addGatewayEndpoint

updateGatewayEndpoint

getGatewayEndpoint

Added optional tags for logical partitioning feature.

geoLocationName
geoLocationFilterName
sendGeoLocation

Added optional tags for QSIG variant per trunk or gateway feature.

ASN1ROSEOIDEncoding
QSIGVariant

Added optional tags to enhance the CPN transformations feature.

nationalStripDigits
internationalStripDigits
unknownStripDigits
subscriberStripDigits
cgpnTransformationNationalCSS
cgpnTransformationInternationalCSS
cgpnTransformationUnknownCSS
cgpnTransformationSubscriberCSS
useDevicePoolCgpnTransformNationalCSS
useDevicePoolCgpnTransformInternationalCSS
useDevicePoolCgpnTransformUnknownCSS
useDevicePoolCgpnTransformSubscriberCSS

addMGCP

updateMGCP

getMGCP

Added optional tags for logical partitioning feature.

geoLocationName
geoLocationFilterName
sendGeoLocation

addMGCPEndpoint

updateMGCPEndpoint

getMGCPEndpoint

Added optional tags for logical partitioning feature.

geoLocationName
geoLocationFilterName
sendGeoLocation

Added optional tags for QSIG variant per trunk or gateway feature.

ASN1ROSEOIDEncoding
QSIGVariant

Added optional tags for enhancements to CPN transformations.

nationalStripDigits
internationalStripDigits
unknownStripDigits
subscriberStripDigits
cgpnTransformationNationalCSS
cgpnTransformationInternationalCSS
cgpnTransformationUnknownCSS
cgpnTransformationSubscriberCSS
useDevicePoolCgpnTransformNationalCSS
useDevicePoolCgpnTransformInternationalCSS
useDevicePoolCgpnTransformUnknownCSS
useDevicePoolCgpnTransformSubscriberCSS

addSIPTrunk

updateSIPTrunk

getSIPTrunk

Added optional tags for logical partitioning feature.

geoLocationName
geoLocationFilterName
sendGeoLocation

Added optional tag for IPv6 feature.

destinationAddressIPv6

Added optional tags for enhancements to CPN transformations.

unknownStripDigits cgpnTransformationUnknownCSS
useDevicePoolCgpnTransformUnknownCSS

addVG224

updateVG224

getVG224

Added optional tags for logical partitioning feature.

geoLocationName
geoLocationFilterName
sendGeoLocation

addDevicePool

updateDevicePool

getDevicePool

Added optional tags for logical partitioning feature.

geoLocationName
geoLocationFilterName

Added optional tags for enhancements to CPN transformations.

nationalStripDigits
internationalStripDigits
unknownStripDigits
subscriberStripDigits
cgpnTransformationNationalCSS
cgpnTransformationInternationalCSS
cgpnTransformationUnknownCSS
cgpnTransformationSubscriberCSS

addCommonPhoneConfig

updateCommonPhoneConfig

getCommonPhoneConfig

Added optional tags for always-use- primeline feature.

alwaysUsePrimeLine
alwaysUsePrimeLineforVoiceMessage

addDeviceProfile

updateDeviceProfile

getDeviceProfile

Added optional tags for always-use- primeline feature.

alwaysUsePrimeLine
alwaysUsePrimeLineforVoiceMessage


New Information for Unified CM 7.0(1)

Unified CM 7.0(1) APIs are compatible with all previous releases of Unified CM. For additional details about the Unified CM database schema changes, refer to the Unified CM Data Dictionary for Release 7.0(1).

The following sections describe API updates that were made in Unified CM 7.0(1):

New APIs

Changed Operations

New APIs

Table 2-7 describes new operations in Unified CM 7.0(1).

Table 2-7 New Operations in Unified CM 7.0(1) 

Operation
Purpose
Added Tags

addCalledPartyTransformationPattern

removeCalledPartyTransformationPattern

updateCalledPartyTransformationPattern

getCalledPartyTransformationPattern

Added for Local Route Group feature

pattern (mandatory)
usage (mandatory)
routePartition
description
numberingPlan
routeFilter
patternUrgency (read only)
discardDigits
calledPartyTransformationMask
prefixDigitsOut
calledPartyNumberType
calledPartyNumberingPlan

addSIPTrunkSecurityProfile

updateSIPTrunkSecurityProfile

removeSIPTrunkSecurityProfile

getSIPTrunkSecurityProfile

Added for SRTP support for SIP Trunk feature

name (mandatory)
description
securityMode
incomingTransport
outgoingTransport
digestAuthentication
noncePolicyTime
x509SubjectName
incomingPort
applLevelAuthentication
acceptPresenceSubscription
acceptOutOfDialogRefer
allowReplaceHeader
acceptUnsolicitedNotification
transmitSecurityStatus

addResourcePriorityNamespace

updateResourcePriorityNamespace

removeResourcePriorityNamespace

getResourcePriorityNamespace

Added for AS-SIP feature

namespace

addResourcePriorityNamespaceList

updateResourcePriorityNamespaceList

getResourcePriorityNamespaceList

removeResourcePriorityNamespaceList

Added for AS-SIP feature

name (mandatory)
members (mandatory)
resourcePriorityNamespace / resourcePriorityNamespaceName

addResourcePriorityDefaultNamespace

updateResourcePriorityDefaultNamespace

getResourcePriorityDefaultNamespace

removeResourcePriorityDefaultNamespace

Added for AS-SIP feature

resourcePriorityNamespace

addSIPProfile

updateSIPProfile

getSIPProfile

removeSIPProfile

Added for AS-SIP feature

resourcePriorityNamespaceList

addTODAccess

updateTODAccess

getTODAccess

removeTODAccess

Added for Mobility - TOD Access List feature

name (mandatory)
description
ownerId (mandatory)
members > member > timeSchedule (mandatory)
isActionAllowed (mandatory),
accessList (mandatory)
associatedRemoteDestination (read only)

getMobileSmartClientProfile

Added for Unified CM new device type

MobileSmartClient
Name
EnableSNRUri
EnableCFAUri
HandoffUri

addVG224

updateVG224

removeVG224

getVG224

Added for adding VG224 gateway

domainName
description
product
protocol
model
callManagerGroup
callManagerGroupName
units
unit
product

 

subunits
subunit
endpoints
endpoint
name
description
product
productInfo
model
modelInfo
class
protocol
protocolSide
callingSearchSpace
callingSearchSpaceName
devicePool
devicePoolName
commonDeviceConfig
commonDeviceConfigName
commonPhoneConfig
commonPhoneConfigName
networkLocation
location, locationName
mediaResourceList
mediaResourceListName networkHoldMOHAudioSourceId
userHoldMOHAudioSourceId
automatedAlternateRoutingCSS
automatedAlternateRoutingCSSName
aarNeighborhood
aarNeighborhoodName
loadInformation
vendorConfig
versionStamp
traceFlag
mlppDomainId
mlppIndicationStatus
preemption
useTrustedRelayPoint
retryVideoCallAsAudio
securityProfile
securityProfileName
sipProfile
sipProfileName
cgpnTransformationCSS
cgpnTransformationCSSName

   

useDevicePoolCgpnTransformCSS
lines
packetCaptureMode
packetCaptureDuration
transmitUTF8
ports
userLocale
networkLocale
isActive
unattendedPort
subscribeCallingSearchSpace
subscribeCallingSearchSpaceName
allowCtiControlFlag
remoteDevice
phoneTemplate
phoneTemplateName
presenceGroup
presenceGroupName
ignorePresentationIndicators
deviceMobilityMode
hlogStatus
ownerUserId
vendorConfig
versionStamp

addApplicationUser

Added for creating new application users

userid
password
passwordCredentials
digestCredentials
presenceGroup
presenceGroupName
acceptPresenceSubscription
acceptOutOfDialogRefer
acceptUnsolicitedNotification
allowReplaceHeader
isStandard
associatedDevices
associatedGroups
associatedCAPFProfiles

updateApplicationUser

Added for updating application users

userid
password
passwordCredentials
digestCredentials
presenceGroup
presenceGroupName
acceptPresenceSubscription
acceptOutOfDialogRefer
acceptUnsolicitedNotification
allowReplaceHeader
associatedDevices
associatedGroups

removeApplicationUser

Added for removing existing application users

userid

getApplicationUser

Added for obtaining details about application users

userid


Changed Operations

Table 2-8 describes changed operations in Unified CM 7.0(1).

Table 2-8 Changed Operations in Unified CM 7.0(1) 

Operation
Change
Tags

addDevicePool

updateDevicePool

getDevicePool

Added tags for CPN and E.164 Dialing feature

cgpnTransformationCSS
nationalPrefix
internationalPrefix
unknownPrefix
subscriberPrefix

Added tags for Local Route Group feature

cdpnTransformationCSS
useDevicePoolCdpnTransformCSS

addMGCPEndPoint

Added tags for Local Route Group feature

cdpnTransformationCSS
useDevicePoolCdpnTransformCSS

Added tags for CPN and E.164 Dialing feature

cgpnTransformationCSS
useDevicePoolCgpnTransformCSS

Added tag for Network Virtualization feature

useTrustedRelayPoint

Added tag for Secure-Indication Tone feature

enableProtectedFacilityIE

addSIPTrunk

updateSIPTrunk

getSIPTrunk

Added tags for CPN and E.164 Dialing feature

cgpnTransformationCSS
useDevicePoolCgpnTransformCSS
unknownPrefix

Added tags for Local Route Group feature

cdpnTransformationCSS
useDevicePoolCdpnTransformCSS

Added tags for Network Virtualization feature

useTrustedRelayPoint

Added tags for SRTP support feature

srtpAllowed
srtpFallbackAllowed

Added tags for SIP PAI feature

isPaiEnabled
sipPrivacy
isRpidEnabled
sipAssertedType

Added tag for Trunk Licensing feature

licensedCapacity

addH323Phone

updateH323Phone

getH323Phone

Added tag for Network Virtualization feature

useTrustedRelayPoint

addH323Trunk

updateH23Trunk

getH323Trunk

Added tags for CPN and E.164 Dialing feature

cgpnTransformationCSS
useDevicePoolCgpnTransformCSS
nationalPrefix
internationalPrefix
unknownPrefix
subscriberPrefix

Added tags for Local Route Group feature

cdpnTransformationCSS
useDevicePoolCdpnTransformCSS

Added tags for Network Virtualization feature

useTrustedRelayPoint

Added tags for Trunk Licensing feature

licensedCapacity

addH323Gateway

updateH323Gateway

getH323Gateway

Added tags for CPN and E.164 Dialing feature

cgpnTransformationCSS
useDevicePoolCgpnTransformCSS
nationalPrefix
internationalPrefix
unknownPrefix
subscriberPrefix

Added tags for Local Route Group feature

cdpnTransformationCSS
useDevicePoolCdpnTransformCSS

Added tag for Network Virtualization feature

useTrustedRelayPoint

Added tag for Trunk Licensing feature

licensedCapacity

addRoutePattern

updateRoutePattern

getRoutePattern

Added tags for CPN and E.164 Dialing feature

callingPartyNumberingPlan
allingPartyNumberType

Added tags for Local Route Group feature

calledPartyNumberingPlan
calledPartyNumberType

Added tag for AS-SIP feature

resourcePriorityNamespace

addHuntPilot

updateHuntPilot

getHuntPilot

Added tags for CPN and E.164 Dialing feature.

callingPartyNumberingPlan callingPartyNumberType

Added tags for Local Route Group feature

calledPartyNumberingPlan
calledPartyNumberTyp

addTransPattern

updateTransPattern

getTransPattern

Added tags for CPN and E.164 Dialing feature

callingPartyNumberingPlan
callingPartyNumberType

Added tags for Local Route Group feature

calledPartyNumberingPlan
calledPartyNumberType

Added tag for AS-SIP feature

resourcePriorityNamespace

addConferenceBridge

updateConferenceBridge

getConferenceBridge

Added tag for Network Virtualization feature

useTrustedRelayPoint

addCTIRoutePoint

updateCTIRoutePoint

getCTIRoutePoint

Added tagsAdded tag for CPN and E.164 Dialing feature

cgpnTransformationCSS
useDevicePoolCgpnTransformCSS

Added tag for Network Virtualization feature

useTrustedRelayPoint

addPhone

updatePhone

getPhone

Added tags for CPN and E.164 Dialing feature

cgpnTransformationCSS
useDevicePoolCgpnTransformCSS

Added tags for BLF CallPickup feature

associatedBLFSDFeatures
ringSettingIdleBLFAudibleAlert
ringSettingBusyBLFAudibleAlert

Added tags for Enhanced IP Phone Services Provisioning feature

phoneService
vendor
version
priority
phoneServiceDisplay
requirePKIAuthForHTTPS

Added tag for Secure-Indication Tone feature

isProtected

Added tag for new CUCM Device type feature

MobileSmartClientProfile

Added tags for complete phone API support

requireDTMFReception
RFC2833Disabled
phoneLoadName
authenticationMode
keySize

addGatewayEndpoint

updateGatewayEndpoint

getGatewayEndpoint

Added tags for CPN and E.164 Dialing feature

gpnTransformationCSS
useDevicePoolCgpnTransformCSS
nationalPrefix
internationalPrefix
unknownPrefix
subscriberPrefix

Added tags for Local Route Group feature

cdpnTransformationCSS
useDevicePoolCdpnTransformCSS

Added tag for Network Virtualization feature

useTrustedRelayPoint

Added tag for VoSIP/DVX G.Clear feature

GClearEnable

addMOHServer

updateMOHServer

getMOHServer

Added tag for Network Virtualization feature

useTrustedRelayPoint

addVoiceMailPort

getVoiceMailPort

addCommonDeviceConfig

updateCommonDeviceConfig

getCommonDeviceConfig

addTranscoder

updateTranscoder

getTranscoder

Added tag for Network Virtualization feature

isTrustedRelayPoint

addRemoteDestinationProfile

updateRemoteDestinationProfile

getRemoteDestinationProfile

Added tags for DND Reject feature

dndStatus
dndOption

Added tag for new CUCM Device type feature

MobileSmartClientProfile

addTransformationPattern

updateTransformationPattern

getTransformationPattern

Added tags for CPN and E.164 Dialing feature

callingPartyNumberingPlan
digitDiscardInstruction
callingPartyNumberTyp

addTimePeriod

updateTimePeriod

getTimePeriod

Added tags for Mobility - TOD Access List feature

description
isPublished
todOwnerId
dayOfMonthEnd
monthOfYearEnd

addTimeSchedule

updateTimeSchedule

getTimeSchedule

Added tags for Mobility - TOD Access List feature

description
Published
timeScheduleCategory
todOwnerId

addRemoteDestination

Added tags for Mobility - TOD Access List feature

timeZone
clientApplicationModel
todAccess

Removed tags for Mobility - TOD Access List feature

allowedAccessList
blockedAccessList
smartClientInstalled

Added tag for new CUCM Device type feature

MobileSmartClient

Deprecated tag

clientAppModelxxx

updateRemoteDestination

getRemoteDestination

Added tags for Mobility - TOD Access List feature

timeZone
clientApplicationModel
todAccess

Removed tags for Mobility - TOD Access List feature

allowedAccessList
blockedAccessList
smartClientInstalled

Added tag for new CUCM Device type feature

MobileSmartClient

Added tag for new CUCM Device type feature

clientAppModelxxx

addUser

updateUser

getUser

Added tag for Mobility - TOD Access List feature

associatedTodAccess

Removed tag for addUser API for Mobility - TOD Access List feature

associatedAccessLists

addRouteList

updateRouteList

getRouteList

Added tags for CPN and E.164 Dialing feature

callingPartyNumberingPlan
callingPartyNumberType
calledPartyNumberingPlan
calledPartyNumberType


Dynamic Throttling of Requests

Unified CM 7.0 includes a new throttling mechanism called dynamic throttling of request. The MaxAXLWritesPerMinute service parameter, used in earlier releases, has been deprecated. For more information see, Dynamic Throttling of Requests.

New Information for Unified CM 6.1 (1)

Table 2-9 describes the API calls that changed in Unified CM 6.1(1). These changes may require updates to the existing user-code that uses these APIs.

Table 2-9 Changed API Calls in Unified CM 6.1(1) 

API Call
Change
Tags

addLine

Added tag for Intercom CTI Support feature

defaultActivatedDevice

updateLine

Added tag for Intercom CTI Support feature

defaultActivatedDevice

getLine

Added tag for Intercom CTI Support feature

defaultActivatedDevice

addUser

Added tag for Mobility user feature

primaryDevice

updateUser

Addedtag for Mobility user feature

primaryDevice

getUser

Added tag for Mobility user feature

primaryDevice

addDeviceProfile

Added tags for SingleButtonBarge and JoinAcrossLines features

singleButtonBarge
joinAcrossLines

updateDeviceProfile

Added tags SingleButtonBarge and JoinAcrossLines features

singleButtonBarge
joinAcrossLines

getDeviceProfile

Added tags for SingleButtonBarge and JoinAcrossLines features

singleButtonBarge
joinAcrossLines

addDevicePool

Added tags for SingleButtonBarge and JoinAcrossLines features

singleButtonBarge
joinAcrossLines

updateDevicePool

Added tags for SingleButtonBarge and JoinAcrossLines features

singleButtonBarge
joinAcrossLines

getDevicePool

Added tags for SingleButtonBarge and JoinAcrossLines features

singleButtonBarge
joinAcrossLines

addPhone

Added tags and joinAcrossLines for SingleButtonBarge and JoinAcrossLines features

singleButtonBarge
joinAcrossLines

Added tag for BAT/TAPS Licensing Allowance feature

isActive

updatePhone

Added tags and joinAcrossLines for SingleButtonBarge and JoinAcrossLines features

singleButtonBarge
joinAcrossLines

Added tag for BAT/TAPS Licensing Allowance feature

isActive

getPhone

Added tags and joinAcrossLines for SingleButtonBarge and JoinAcrossLines features

singleButtonBarge
joinAcrossLines

Added tag for BAT/TAPS Licensing Allowance feature

isActive



Note All Unified CM 6.0 AXL methods, with the exception of ExecuteSQLQuery and ExecuteSQLupdate, are backward compatible with Unified CM 6.1. By default, the interface automatically uses the 6.0 AXL schema. Developers should specify SOAPAction: "CUCM:DB ver=6.1" in the HTTP header to use any new 6.1 methods.


New Information for Unified CM 6.0(1)

For Unified CM Release 6.0(1), be aware that the defined AXL APIs are backward compatible. However, the executeSQLQuery request, which lets the user run a database query directly on the Unified CM database, is not backward compatible.

Release 6.0(1) splits some of the tables in the Unified CM database. Feature-related information moved to the corresponding dynamic tables. If the direct SQL query to which the 'executeSQLQuery' API referred uses any of the changed tables, you may need to rewrite the query according to the new database schema.

The columns enduser.password and enduser.pin from the enduser table and the applicationuser.password column from the applicationUser table moved to the credential table as credential.credentials. A direct SQL query that refers to these columns will not work in Unified CM Release 6.0(1).


Note Be aware that Unified CM password and pin fields are encrypted. Applications should not write to those fields using <executeSQLUpdate>. Instead, update passwords and pins by using the appropriate <updateXXXUser> request.


The phone API for extension mobility-related parameters has the new tag CurrentConfig. This tag is valid only for the getPhone response. The tag lets AXL provide the original device configuration and the logged-in profile information:

If a user has logged in to a device by using a device profile, the CurrentConfig tag contains the values for the extension mobility-related parameters from that device profile.

If no user has logged in, the CurrentConfig tag contains the values of the extension mobility-related parameters for the actual device.

Schema changes for the CMCInfo and FACInfo APIs help maintain consistency with other AXL APIs.

For further details about the Unified CM database schema changes, refer to Unified CM Data Dictionary for Release 6.0(1).


Note The getCCMVersion API will return the Unified CM version based on the Node Name that is specified in the request. If no Node Name is specified, you will get the Unified CM Version of the lowest node ID Unified CM.

Cisco always advises running the AXL API on a completely upgraded cluster. When run on a cluster that is not upgraded completely, the response of the AXL API will be correct when executed on a server that already has been upgraded. However, if you execute the AXL API on a server that has not yet been upgraded, then it will return the Unified CM Version of the lowest node ID Unified CM per the server local database information.


The following AXL API calls changed in Unified CM Release 6.0(1). These changes may require changes to the existing user-code that uses these APIs:

updateAppUser

addCallPickupGroup

updateCallPickupGroup

getCallPickupGroup

addConferenceBridge

updateConferenceBridge

getConferenceBridge

addCSS

updateCSS

getCSS

addDevicePool

In axl.xsd, the tag name aarNeighborhood and the annotation for the revertPriority tag in XDevicePool changed to match the AXL response.

In axlsoap.xsd, the tag name aarNeighborhood and the annotation for the revertPriority tag in updateDevicePoolReq changed.

updateDevicePool

In axl.xsd, the tag name aarNeighborhood and the annotation for the revertPriority tag in XDevicePool changed to match the AXL response.

In axlsoap.xsd, the tag name aarNeighborhood and the annotation for the revertPriority tag in updateDevicePoolReq changed.

getDevicePool

In axl.xsd, the tag name aarNeighborhood and the annotation for the revertPriority tag in XDevicePool changed to match the AXL response.

In axlsoap.xsd, the tag name aarNeighborhood and the annotation for the revertPriority tag in updateDevicePoolReq changed.

addDeviceProfile

updateDeviceProfile

getDeviceProfile

addGatewayEndpoint

updateGatewayEndpoint

getGatewayEndpoint

addH323Phone

updateH323Phone

getH323Phone

addH323Trunk

updateH323Trunk

getH323Trunk

addLine

updateLine

getLine

addMGCP

getMGCP

addPhone

updatePhone

getPhone

addRegion

updateRegion

getRegion

updateRegionMatrix

addRoutePartition

updateRoutePartition

getRoutePartition

addSIPTrunk

updateSIPTrunk

getSIPTrunk

addUser

updateUser

getUser

addVoiceMailPort

updateVoiceMailPort

getVoiceMailPort

doAuthenticateUser

getCMCInfo, removeCMCInfo, and updateCMCInfo

In axlsoap.xsd

A new option tag "code" along with the "uuid" tag for these three requests exist. The user can send either the uuid or code tag.

This release renames the existing tag "code" to "newCode" in the updateCMCInfo request. Users can send the new code to be updated as the "newCode" tag instead of "code" in update CMCInfo requests.

This release removes the invalid authorizationLevel tag in the updateCMCInfo request.

addFACInfo, getFACInfo, updateFACInfo, and removeFACInfo

In axl.xsd

The existing tag "description" changed to "name." This makes the addFACInfo, getFACInfo, and updateFACInfo request match the database. In previous releases, the value that was supplied for the "description" tag updated "name" in the database.

In axlsoap.xsd

A new option tag "name" along with the "uuid" tag for getFACInfo, updateFACInfo, and removeFACInfo exist.

The existing tag "description" changed to "newName" in the updateFACInfo request.

Users can send either uuid or name in the getFACInfo, updateFACInfo, and removeFACInfo requests.

This release deprecated some of the fields that were removed from the Unified CM 6.0(1) database in AXL. This release adds annotation for such fields.

AXL Versioning Support

To improve backward compatibility, Unified CM introduced AXL schema versioning in Release 6.0(1). This feature is included in all subsequent Unified CM releases. Beginning with Release 6.0(1), the system duplicates the previous AXL 1.0 schema as the AXL 6.0(1) schema and numbers the AXL schema the same as the corresponding Unified CM release. This approach maintains AXL backward compatibility for one full release cycle.

Changed Service Parameter for Unified CM 6.0(1)

Unified CM 6.0(1) adds a new service parameter, EnableAXLEncodingInfo, to the Unified CM Administrator windows under the Cisco Database Layer Monitor service. This parameter allows the user to decide whether AXL responses should contain the encoding information. Consider encoding information as important if an AXL request has non-English characters in it.

Unified CM 5.1(1) added a new service parameter, Send Valid Namespace in the AXL response, under the Cisco Database Layer Monitor service. This parameter determines the namespace that is sent in the AXL response from the Unified CM. In the 6.0(1) release, the default value of this parameter changed from False to True.

When this parameter is True, Unified CM sends the valid namespace in the AXL response, so the namespace matches the AXL schema specification.

If the parameter is False, Unified CM sends an invalid namespace in the AXL response, which does not match the AXL schema specification.

To maintain backward compatibility with older applications, you might need to change the value to False. Cisco recommends that you set this parameter to True, so the Unified CM sends a valid namespace.

New Information for Unified CM 5.1(1)

The following list provides AXL API calls that are new in Unified CM 5.1(1):

addSIPRealm

updateSIPRealm

getSIPRealm

removeSIPRealm

These APIs add and update credentials (passwordreserve) in siprealm.

In addition, Unified CM Administration 5.1 release adds a new service parameter, "Send Valid Namespace in AXL Response," under the Cisco Database Layer Monitor service. This parameter determines the namespace that gets sent in the AXL response from Unified CM.

When this parameter specifies True, Unified CM sends the valid namespace in the AXL response so the namespace matches the AXL schema specification.

If the parameter specifies False, Unified CM sends an invalid namespace in the AXL response, which does not match the AXL schema specification.

The default service parameter value specifies False to maintain backward compatibility with the AXL response in the Unified CM 5.0 release. Cisco recommends that you set this parameter to True so Cisco Unified CallManager sends the valid namespace.

New Information for Unified CM 5.0(1)

The following AXL API calls are new in Unified CM 5.0(1):

executeSQLUpdate

doAuthenticateUser

updateAppUser

addUserGroup

updateUserGroup

removeUserGroup

getUserGroup

The following AXL API calls have been changed in Unified CM 5.0:

addPhone

updatePhone

getPhone

addGatewayEndpoint

updateGatewayEndpoint

getGatewayEndpoint

addMGCPEndpoint

updateMGCP

addSIPTrunk

updateSIPTrunk

getSIPTrunk

addCallManager

updateCallManager

getCallManager

addCallPark

addRoutePattern

updateRoutePattern

updateTransPattern

updateHuntPilot

addHuntList

updateHuntList

getHuntList

addPilotPoint

updatePilotPoint

getPilotPoint

addH323Gateway

updateH323Gateway

updateH323Phone

getH323Gateway

getH323Trunk

addUser

updateUser

getUser

updateProcessNodeService

getProcessNodeService

doDeviceLogout

listUserByName

updateServiceParameter

updateGatekeeper

updateConferenceBridge

updateAttendantConsoleHuntGroup

updateDeviceProfile

updateLine

updateLineGroup

addDevicePool

updateDevicePool

doDeviceReset

The following API calls that have been deprecated in Unified CM 5.0:

addDDI

updateDDI

removeDDI

addDialPlan

updateDialPlan

removeDialPlan

addDialPlanTag

updateDialPlanTag

removeDialPlanTag

New Information for Unified CM 4.2(2)

This section describes the new or changed API calls for Unified CM 4.2(2) and a new service parameter for Cisco Database Layer Monitor.

Changed API Calls

Changes to the following API calls in Unified CM 4.2(2) support the Hold Reversion feature:

addDevicePool (adds revertPriority to this request)

updateDevicePool (adds revertPriority to this request)

addLine (adds hrDuration and hrInterval to this request)

updateLine (adds hrDuration and hrInterval to this request)

Because these new tags are disabled by default, these changes are backward-compatible with existing user code.

New Service Parameter

A new service parameter, EnableAXLEncodingInfo, has been added to Unified CM Administration under the Cisco Database Layer Monitor service. This parameter enables the user to decide if AXL responses should contain encoding information. Encoding information is important if an AXL request has non-English characters in it.

New Information for Unified CM 4.1(2)

The following AXL API calls are new in Unified CM 4.1(2):

addTimePeriod

updateTimePeriod

removeTimePeriod

getTimePeriod

addTimeSchedule

updateTimeSchedule

removeTimeSchedule

getTimeSchedule

addCMCInfo

updateCMCInfo

removeCMCInfo

getCMCInfo

addFACInfo

updateFACInfo

removeFACInfo

getFACInfo

The following AXL API calls have been changed in Unified CM 4.1(2):

addPhone

updatePhone

getPhone

addLine

updateLine

addUser

removeUser

updateUser

getUser

addDeviceProfile

updateDeviceProfile

getDeviceProfile

addRoutePattern

updateRoutePattern

getRoutePattern

addRouteList

updateRouteList

getRouteList

addGatewayEndpoint

updateGatewayEndpoint

getGatewayEndpoint

addH323Trunk

updateH323Trunk

removeH323Trunk

getH323Trunk

addHuntPilot

updateHuntPilot

removeHuntPilot

getHuntPilot

addProcessNode

updateProcessNode

removeProcessNode

getProcessNode

listAllProcessNodes

listProcessNodesByService

addRoutePartition

updateRoutePartition

removeRoutePartition

getRoutePartition

addH323Gateway

updateH323Gateway

removeH323Gateway

getH323Gateway

addH323Phone

updateH323Phone

removeH323Phone

getH323Phone

addHuntList

updateHuntList

removeHuntList

getHuntList

AXL Schema Documentation

The axlsqltoolkit.zip plug-in contains the following five AXL schema files:

AXLAPI.wsdl

AXLEnums.xsd

axlmessage.xsd

axlsoap.xsd

axl.xsd

These files encapsulate the complete AXL schema, including details of all requests, responses, XML objects, and data types.

In addition to these schema files, two folders exist:

WSDL-AXIS

WSDL-NET

Each of these folders contains AXLAPI.wsdl and AXLSoap.xsd files to be used for application development in AXIS or .NET client environments, respectively.

You can obtain complete documentation of all available AXL messages from the Cisco Developer Services web site: http://developer.cisco.com. This website requires a Cisco.com login.

You can use the Application > Plugins > Unified CM AXL SQL Toolkit command from the Unified CM server administration interface to obtain:

AXL schema (.xsd) files

See also AXL Schema Documentation.

The WSDL file

AXL Versioning Support

To improve backward compatibility, Unified CM introduced AXL schema versioning in Release 6.0(1). This feature is included in all subsequent Unified CM releases. Beginning with Release 6.0(1), the system duplicates the previous AXL 1.0 schema as the AXL 6.0(1) schema and numbers the AXL schema the same as the corresponding Unified CM release. This approach maintains AXL backward compatibility for one full release cycle.

Cisco highly recommends that developers include the version of AXL schema on which an AXL request is based because support for unversioned requests might be removed in future releases of Unified CM.

For those developers who are using the AXL APIs executeSQLQuery and executeSQLUpdate, changes have occurred to the Unified CM database schema that affect the direct SQL query approach. Refer to the Unified CM Database Dictionary, at http://www.cisco.com/en/US/products/sw/voicesw/ps556/products_programming_reference_guides_list.html, for the release that you are using. That document describes the specific changes in the database schema.

To help developers plan for AXL versioning, Table 2-10 provides the approach that Cisco will follow in supporting upcoming releases.

Cisco will support AXL requests without version information for only three releases following the 6.0(1) release; after that, requests without version information will be rejected.

AXL requests with version information will have the corresponding schema applied for up to three subsequent releases; after that, the specified version may not be available.

AXL Policy Considerations

The following policies related to AXL versioning support is under consideration for future release:

AXL schema versioning will continue indefinitely.

AXL schemas will be available for two major Unified CM release cycles, such that AXL applications will require minor updates every two years.

Developers who do not request a specific AXL schema will always connect to the oldest schema available.

Developers can request other available AXL schemas by specifying the AXL schema version in the SOAP Action Header.

Table 2-10 AXL Versioning and Schema Plan

   
AXL Request no version specified
AXL Request with Version Specified
   

CUCM:DB ver=6.0(

CUCM:DB ver=6.1

CUCM:DB ver=7.0

CUCM:DB ver=7.1

CUCM:DB ver-8.0
CUCM:DB ver-8.5
Plus 1 release
Cisco Unified CM Release
Release 6.0(1)

6.0 schema applied

6.0 schema applied

   
Release 6.1(0)

6.0 schema applied

6.0 schema applied

6.1 schema applied

Not Applicable
 
Release 7.0(1)

6.0 schema applied

6.0 schema applied

6.1 schema applied

7.0 schema applied

     
Release 7.1(2)

6.0 schema applied

6.0 schema applied

6.1 schema applied

7.0 schema applied

7.1 schema applied

     
Release 8.0(1)

6.1 schema applied

 

6.1 schema applied

7.0 schema applied

7.1 schema applied

8.0 schema applied

   
Release 8.5(1)

7.0 schema applied

   

7.0 schema applied

7.1 schema applied

8.0 schema applied

8.5 schema applied

 

Plus 1
release

7.1 schema applied

Schema no longer available

 

7.1 schema applied

8.0 schema applied

8.5 schema applied

Plus 1 release schema applied


The following sample AXL request carries version information:

Host:10.77.31.194:8443
Authorization: Basic Q0NNQWRtaW5pc3RyYXRvcjpjaXNjb19jaXNjbw==
Accept: text/*
Content-type: text/xml
SOAPAction: "CUCM:DB ver=7.0"
Content-length: 427
SOAP-ENV:Envelope xmlns:SOAP-ENV=http://schemas.xmlsoap.org/soap/envelope/
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SOAP-ENV:Body>
    <axl:getUser xmlns:axl="http://www.cisco.com/AXL/7.0" 
si:schemaLocation="http://www.cisco.com/AXL/API/7.0 http://ccmserver/schema/axlsoap.xsd" 
sequence="1234">
      <userid>tttt</userid>
    </axl:getUser>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
 
   

Sample AXL response:

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONIDSSO=12E52A7F9B34107BA6147096878E00F9; Path=/
Set-Cookie: JSESSIONID=7B94F17D61C6A91B04C5C76A6E3F905E; Path=/axl; Secure
SOAPAction: "CUCM:DB ver=7.0"
Content-Type: text/xml;charset=utf-8
Content-Length: 1936
Date: Mon, 03 Mar 2008 10:17:38 GMT
Connection: close
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
SOAP-ENV:encodingStyle="
http://schemas.xmlsoap.org/soap/encoding/"><SOAP-ENV:Header/>
 
   
<SOAP-ENV:Body>
  <axl:getUserResponse xmlns:axl="http://www.cisco.com/AXL/API/7.0" 
xmlns:xsi="http://www.cisco.com/AXL/API/7.0" sequence="1234">
    <return>
      <user>
        <firstname/>
        <lastname>tttt</lastname>
        <userid>tttt</userid>
        <password/>
        <pin/>
        <telephoneNumber/>
        <department/>
        <manager/>
        <associatedDevices>
          <device>SEPA88888888888</device>
        </associatedDevices>
        <primaryExtension/>
        <associatedPC/>
        <associatedGroups>
          <userGroup uuid="{6B126A13-8F47-B78D-13D4-9555D664F634}">
     <name>test</name>
       <userRoles>
         <userRole uuid="{A6BAE213-AAB5-F794-B71C-98EE94129C9B}">Standard AXL API 
Access</userRole>
       </userRoles>
          </userGroup>
        </associatedGroups>
        <enableCTI>true</enableCTI>
        <digestCredentials/>
        <enableMobility>false</enableMobility>
        <enableMobileVoiceAccess>false</enableMobileVoiceAccess>
        <maxDeskPickupWaitTime>10000</maxDeskPickupWaitTime>
        <remoteDestinationLimit>4</remoteDestinationLimit>
        <passwordCredentials>
          <pwdCredPolicyName>Default Credential Policy</pwdCredPolicyName>
          <pwdCredUserCantChange>false</pwdCredUserCantChange>
          <pwdCredUserMustChange>false</pwdCredUserMustChange>
          <pwdCredDoesNotExpire>false</pwdCredDoesNotExpire>
          <pwdCredTimeChanged>February 14, 2008 16:10:12 IST</pwdCredTimeChanged>
          <pwdCredTimeAdminLockout/>
          <pwdCredLockedByAdministrator>false</pwdCredLockedByAdministrator>
        </passwordCredentials>
        <pinCredentials>
          <pinCredPolicyName>Default Credential Policy</pinCredPolicyName>
          <pinCredUserCantChange>false</pinCredUserCantChange>
          <pinCredUserMustChange>false</pinCredUserMustChange>
          <pinCredDoesNotExpire>false</pinCredDoesNotExpire>
          <pinCredTimeChanged>February 14, 2008 16:10:12 IST</pinCredTimeChanged>
          <pinCredTimeAdminLockout/>
          <pinCredLockedByAdministrator>false</pinCredLockedByAdministrator>
        </pinCredentials>
      </user>
    </return>
  </axl:getUserResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Authentication

The system controls user authentication via the HTTPS Basic Authentication scheme; therefore, you must include the Authorization header in the HTTPS header. Because Base64 encoding takes three 8-bit bytes and represents them as four printable ASCII characters, if the encoded header does not contain an even multiple of four ASCII characters (16, 20, 24, and so on), you must add padding characters (=) to complete the final group of four.

Ensure users are authorized to access AXL. For help with configuring authorization, see Post-Installation Steps and Troubleshooting on the Linux Platform.

If user authentication of the user fails, the system returns an HTTP 401 Access Denied error to the client.

For example, if the user agent wants to send the userid "larry" and password "curly and moe," it would use the following header field:

Authorization: Basic bGFycnk6Y3VybHkgYW5kIG1vZQ==
 
   

where the string "bGFycnk6Y3VybHkgYW5kIG1vZQ==" provides the Base64 encoding of "larry:curly and moe."


Note The two "equals" characters (=) at the end of the string act as padding characters for Base64 encoding.


Data Encryption

Encrypt AXL SOAP messages by using HTTP Secure Sockets Layer (SSL). SSL remains functional on the web server by default. Ensure AXL requests are made by using the "https" protocol.

Dynamic Throttling of Requests

Unified CM releases earlier than 7.0 included the AXL service parameter MaxAXLWritesPerMinute, which has a default value of 50 and maximum value of 999. This service parameter designates the maximum number of write requests that AXL can encounter and process in one minute. Unified CM 7.0 includes a new throttling mechanism. The MaxAXLWritesPerMinute service parameter has been deprecated.

The new throttling mechanism takes into account the dynamic state of Unified CM. It considers the number of outstanding change notifications across the Unified CM cluster at any given time. If a node has more than 1,500 outstanding change notifications, AXL stops processing write requests until the outstanding change notifications are below 1,500. During throttling, HTTPS Status-Code: 503 Service Unavailable response and sets AXL performance counters which can be viewed using RTMT. When a 503 Service Unavailable response is returned, Cisco recommends that the application sleep for a number of seconds or milliseconds (as determined by the developer) to allow pending write requests to be processed. The application should then continue submitting requests.

There are two AXL performance counters:

ThrottleCount—Determines number of times Administrative AXL throttling has been engaged.

ThrottleState—Determines the state of AXL throttling. That is, whether AXL throttling is currently active (throttling is engaged).

The AXL error message for throttling remains same as in earlier versions of Unified CM. There is no change required to AXL applications.

For example, consider an application that makes 1,000 phone insertions in 30 seconds. Assume that these insertions cause 2,000 change notifications to various applications such as Unified CM and Cisco TFTP, and that within 10 seconds all change notifications are consumed. In this situation, by the 40th second, the number of outstanding change notifications is zero and the throttling mechanism does not take effect. However, if these change notifications are not consumed, the throttling mechanism does take effect and write requests are throttled until the outstanding change notification value falls below 1,500.

The throttling mechanism considers the capacity of the Unified CM cluster to consume the change notifications that generated from all the write activities to the Unified CM database. In this way, it is dynamic. As long as all change notifications are consumed at a rate that is equal to or higher than the rate at which change notifications are generated, throttling does not take effect.

Table 2-11 AXL Query Limits

Writes Per Minute

Maximunm of 1500 Write requests

Reads Per Minute

No limit for Read requests.

Total Records

No limits for total number of records. But size of total recordes must be less than 8MB per request and 16MB is the maximum buffer allocated for parallel processing of requests.



NoteRead requests are never throttled and pass through even when write requests are throttled.

The MaxAXLWritesPerMinute service parameter has been deprecated and is no longer available.


AXL Data Throttling

The AXL interface now includes a throttling mechanism that limits the amount of data that client can return. The limit for data that gets returned in any single request specifies 8 MB. The limit for concurrent data requests specifies 16 MB, which can be split over any number of concurrent requests (for example, 8 concurrent requests with each requiring 2 MB of data to be returned; 4 concurrent requests with each requiring 4 MB of data to be returned; or any other combination not exceeding 8 MB per request or 16 MB concurrently).

This feature:

Prevents AXL request processing from making the Tomcat service unresponsive.

Allows critical applications such as the Cisco Unified Communications Manager Administration interface and logging in to and out of Cisco Extension Mobility to function even when heavy AXL queries are processed.

Allows client applications to obtain the information that is requested.

Maximizes interface throughput.

Minimizes required changes to existing applications.

The following AXL methods now include data throttling:

executeSQLQuery

listDeviceByNameAndClass

listDeviceByServiceName

listPhoneByDescription

listPhoneByName

listUserByName

In Unified CM 8.0(1) data throttling is included only in executeSQLQuery.

With data throttling, the AXL interface now returns the following message when the 8 MB limit is reached: "Query request too large. Total rows matched: <Matched Rows>. Suggested row fetch: less than <Number of Rows>."

In addition, new <skip> and <first> tags for the List X methods allow developers to fetch the data requested. Developers who use ExecuteSQLQuery should use standard SQL Skip and First tags in the request to retrieve the desired data set.

Interaction

This section describes how the interface responds in a variety of situations.

Example 1, Option 1: Client requests data that exceeds 8 MB

Server response: ProcessingConstraintException AXL error code 5011"Query request too large. Total rows matched: <Matched Rows>. Suggested row fetch: less than <Number of Rows>"

<Number of Rows> specifies the suggested number of rows that a single request can return to keep the data exchange under the 8-MB limit. Clients should use <Matched Rows> to determine the number of iterations that are required to retrieve the complete data set that a query tries to fetch.

Client response, Option 1:

1. Client logic analyzes the server response and obtains the value of <Row Fetch>.

2. Client stores the <Row Fetch> value in a constant that depicts Row Fetch Step Size. For this example, rowFetchStepSize represents the constant name.

3. Client logic generates the request in parts based on the <Row Fetch> value.

4. Client keeps track of the number of rows that were received in the previous request. For this example, this information exists in a variable that is named prevRows.

5. Client keeps track of the total number of rows that are fetched. For this example, this information exists in a variable that is named totalRowFetch.

6. Before sending the next request, client checks whether prevRows == <Row Fetch>.

7. If the check returns true, continue the request generation loop; otherwise, break from the loop.

Example 1, Option 2: Client requests data that exceeds 8 MB

Server response: ProcessingConstraintException AXL error code 5011 "Query request too large. Total rows matched: <Matched Rows>. Suggested row fetch: less than <Number of Rows>"

<Number of Rows> specifies the suggested number of rows that a single request can return to keep the data exchange under the 8-MB limit. Clients should use <Matched Rows> to determine the number of iterations that are required to retrieve the complete data set that a query tries to fetch.

Client response, Option 2:

1. Client logic analyzes the server response and obtains the value of <Row Fetch> and <totalRows>.

2. Client stores the <Row Fetch> and <totalRows> values in variables. For this example, the variable names comprise rowFetchStepSize and countOfRows.


Note Alternatively, the client can execute a query for count(*) to obtain the number of rows that can be fetched from the database.


3. Client logic calculates the number of iterations based on the values that are stored in rowFetchStepSize and countOfRows.

4. Client logic declares two variables: "skip" (with the initial value of 0) and "first" (with initial value set to rowFetchStepSize).

5. Client starts the iteration.

6. Client logic generates the request based on "skip" and "first" at every iteration.

7. Client modifies the value of "skip" and "first" at every iteration.

8. Client checks the response at every iteration.

9. If the response is a MemoryConstraintException, the client waits until the requests in progress completes, then continues the iteration.

If the response is not a MemoryConstraintException, the client continues the iteration.

10. Iterations continue until the <number Of Iterations> value is reached.

Example 2: Client sends single 8-MB request

Server responds with requested data.

Example 3: Client sends two 8-MB requests simultaneously

Server responds with requested data.

Example 4: Client sends more than two 8-MB requests simultaneously

The server processes the first two requests. Other concurrent requests that may be received generate this exception: MemoryConstraintException AXL error code 5009: "Maximum AXL Memory Allocation Consumed. Please retry once requests in progress have completed."

Client response:

1. Client waits for the requests that are being processed to complete and then sends the request again.

Cisco recommends that applications wait 2 to 3 minutes before resubmitting the request.

2. Client logic must track the requests that fail and send them again.

Example 5: Concurrent data requests reach 16-MB limit

This example applies to all AXL methods.

This situation returns MemoryConstraintException AXL error code 5009: "Maximum AXL Memory Allocation Consumed. Please retry once requests in progress have completed."

Cisco recommends that applications wait 2 to 3 minutes after receiving this message before resubmitting the request.

Using <skip> and <first> Tags in List APIs

The new <skip> and <first> tags provide additional functionality when data is retrieved by using the List methods. If a List Response exceeds 8 MB, the client can fetch data in sets of rows by using a combination of these tags. These tags provide navigation functionality. Be aware that they are not mandatory and have no default values.

In addition,

Negative values for the <skip> or <first> tags cause a SQL syntax error.

If the <skip> tag is not mentioned or is empty and the <first> tag is not mentioned or is empty, the default query or full query that pertains to the List API executes.

If the <skip> tag is not mentioned or is empty and the <first> tag has some positive value (for example, "m"), a query that skips the "zero" row and fetches the first "m" rows executes.

If the <skip> tag and <first> tag value are both positive (for example, "n" and "m," respectively), a query that skips "n" rows and fetches "m" rows executes.

The <skip> tag can only be used when the <first> tag is speficied and the <searchLimit> tag value is zero.

The <first> tag can be used when the <searchLimit> tag value is zero.

Suggested Use of <skip> and <first> Tags in List APIs

If a client request exceeds 8 MB of data, the server responds: "Total rows matched: <Matched Rows>. Suggested row fetch: less than <Number of Rows>."

<Number of Rows> specifies the suggested number of rows that a single request can return to keep the data exchange under the 8-MB limit. Clients should use <Matched Rows> to determine the number of iterations that are required to retrieve the complete data set that a query tries to fetch.

Client response:

1. Client logic analyzes the server response and obtains the value of <Row Fetch>.

2. Client stores the <Row Fetch> value in a constant that depicts Row Fetch Step Size. For this example, the constant name specifies rowFetchStepSize.

3. Client executes a query for count(*) to obtain the number of rows that can be fetched from database. (Consider this step as required only if you are not using the exception to exit the loop.)

a. Client modifies the tags <first> and <skip> in every iteration of the row fetch.

b. The first iteration starts with <skip>0<skip> and <first> rowFetchStepSize</first>.

c. Subsequent row fetch iteration have <skip>"first" tag value from previous iteration</skip> and <first>previous iteration "first" tag value + rowFetchStepSize</first>.

4. Before each iteration, client checks for the condition <skip> tag value < count(*) value. If <skip> tag value >= count(*) value, this indicates that the iteration is trying to fetch more rows than the existing number of rows in the database. In this case, break from the loop. Otherwise, the SQL Error (No Current Row) occurs, which you can use to break from loop.

Sample Code for Use of <skip> and <first> Tags in List APIs

Example 1

If the recommended RowFetch is X = 100 for ListPhoneByName, the client should use this logic:

StepSize = RowFetch (X = 9999)
//Two variables to store the skip and first values.
Int skip = 0;
Int first = StepSize;
//start the iteration 
While (1) 
{
 Try {
//A function to Modify the values of <first> and <skip> in the request with variables 
values defined above
modifyRequest(FilePath);
//Sending the modified request
Response = SendExecuteSQLQuery (select SKIP <SkipCount> First <StepSize> * from endusers;) 
//Modify the variables
Skip+ = StepSize;
First+= StepSize;
Check for fault_message from reply
//An SQL Exception from server while trying to fetch rows greater than that present in 
database 
If(fault_message .contains("No Current Row Found")){
Break;
}
Else{
Continue the loop;
}
} /* end of while*/

Example 2

#Declare variable for first and skip
long skip = 0;
long first = suggestiveRowFetch;
#Calculate number of iterations required
float precision = totalRowFetch/suggestiveRowFetch;
calculate the decimal point of variable precision
if decimal point == 0;
no. Of Iterations = totalRowFetch/suggestiveRowFetch;
if decimal point <5 
no. Of Iterations = Math.round(totalRowFetch/suggestiveRowFetch)+1;
if decimal point >5
no. Of Iterations = Math.round(totalRowFetch/suggestiveRowFetch);
****Here (no. Of Iterations = 15)********
#iterator
int iLoop = 1;
 
   
while( iLoop <=no. Of Iterations){
 
   
#modify the values of first and skip in the query
String mdSQLQuery = modifySQLQuery(skip,first); /* Its like select skip 0 first 2000 * 
from device for first loop*/
#send the request and get response
response = sendRequest(mdSQLQuery);
#update the skip and first variables
skip+=suggestiveRowFetch;
first+=suggestiveRowFetch;
#check for response
if(response contains MemoryConstraintException){
#undo the variable modification to get  attributes (i.e skip and first) of the query , 
that failed with an exception. 
skip - =suggestiveRowFetch;
first - =suggestiveRowFetch;
wait till the requests in Progress Gets Processed;
continue the loop;
 
   
}
else{
iLoop++;
}
}

Sample Code for ExecuteSQLQuery

Example 1

To obtain the first X rows and then next X rows, a client should send queries as described in this section. For example, the client should use the following logic if the recommended RowFetch is X = 9999 for the query "select * from endusers;":

StepSize = RowFetch (X = 9999)
SkipCount = 0
 While (1) 
{
 Try {
Response = SendExecuteSQLQuery (select SKIP <SkipCount> First <StepSize> * from endusers;) 
RowsReturned = Rowcount (Response);
If RowsReturned < StepSize
    Break;  /* All the rows have been fetched*/
Else
    SkipCount = SkipCount + StepSize /*Increase the SkipCount to get the next set of 
rows*/
} 
Catch for any exception 
{
    Take appropriate action based on Exception
    Break;
}
} /* end of while*/

Example 2

#sql query to be executed
sqlQuery = "select * from device";
#send the query to server
response = sendRequest(sqlQuery);
#what is in response?
processResponse();
**** Response contains an Exception: "Query request too large.Suggestive row fetch 2000 
rows.Total row fetch 30000" ****
#Declare two variables 
long suggestiveRowFetch = 0; /*contains Suggestive RowFetch Count*/
long totalRowFetch = 0;      /*contains Total RowFetch*/ 
#fetch the two values and store it into variables.
parseExceptionMessage();

Testing Suggestions

This section provides tests that you can run to check various operations.

Testing ListPhoneByDescription and ListPhoneByName Methods

To test the ListPhoneByDescription and ListPhoneByName AXL methods, follow these steps:


Step 1 Populate database fields (<name>, <tkproduct>, <tkmodel>) for devices/phones to the maximum field size, which is 15 characters each.

Step 2 Populate the database with more than 60,000 devices.

Step 3 Execute the ListPhoneByDescription and ListPhoneByName AXL methods. The resulting data set has a response that is greater than 8 MB.


Expected Results: The interface returns "<API name> API request exceeds Threshold Limit. Total rows matched: <Matched Rows>. Suggested row fetch: less than <Number of Rows>." <API name> specifies the name of the API method.

Testing listDeviceByNameAndClass and listDeviceByServiceName Methods

To test the listDeviceByNameAndClass and listDeviceByServiceName AXL methods, follow these steps:


Step 1 Populate database fields (<name>, <tkproduct>, <tkmodel>) for devices/phones to the maximum field size, which is 15 characters each.

Step 2 Populate the database with more than 75,000 devices.

Step 3 Execute the listDeviceByNameAndClass and listDeviceByServiceName AXL methods. The resulting data set has a response that is greater than 8 MB.


Expected Results: The interface returns "<API name> API request exceeds Threshold Limit. Total rows matched: <Matched Rows>. Suggested row fetch: less than <Number of Rows>." <API name> specifies the name of the API method.

Testing the ExecuteSQLQuery AXL Method

To test the ExecuteSQLQuery AXL method, follow these steps:


Step 1 Populate database fields (<name>, <tkproduct>, <tkmodel>) for devices/phones to the maximum field size, which is 15 characters each.

Step 2 Create a SQL Select statement that retrieves this data.

Step 3 When the exception occurs, pick up the recommended Row Fetch Count and send the modified executeSQLQuery (in loop) by using the recommended row fetch count.


Expected Results: Demonstrate that Row Fetch Count logic works and, at the end loop, client can retrieve the entire set of required data from Cisco Unified Communications Manager.

Verifying That Tomcat Resources Are Protected

To verify that Tomcat resources are protected (Publisher server continues to operate under heavy AXL load):


Step 1 Write a script that generates a load on the AXL interface. Run executeSQLQuery to generate a response slightly less than 8 MB.

Step 2 Client runs this executeSQLQuery in a loop as soon as the transaction completes (both passed and failed transactions) for 1 hour. The client also notes the time that the request was sent, time that the response was received, and whether the response passed or failed.

Step 3 Create four instances of this script and make them run simultaneously against the same Cisco Unified Communications Manager Publisher.

Step 4 During the 1-hour load test, monitor the Tomcat JVM-related RTMT counters. In addition, use the Cisco Unified Communications Manager Administration interface to check whether you can list the devices on the system.

Step 5 At the end of the test, document the request and response times of the four clients on a timescale and note whether they succeeded or failed.


This analysis indicates whether the total responses that are processed by the AXL interface are within 16 MB. Every third concurrent request should have been rejected. By looking at the JVM on the Tomcat server that was available during the test, you can determine whether enough JVM exits to allow other applications to function properly.

Integration Considerations and Interoperability

The AXL API gives much power to developers to modify the Unified CM system database. The developer must use caution when using AXL because each API call impacts the system. Abuse of the API can lead to dropped calls and slower system performance. AXL acts as a provisioning and configuration API, not as a real-time API.

The AXL interface provides Developers with direct access to the Unified CM database via the ExecuteSQLQuery and ExecuteSQLUpdate methods. While the Dynamic Throttling mechanism protects system resources when multiple update (write) requests are received, by returning a "503: Service Unavailable" error message, there is no mechanism to guard system resources when large read requests are received.

Queries issued using the ExecuteSQLQuery method that result in a data sets greater than 8 MB may place Unified CM resources at risk. Cisco recommends developers using ExecuteSQLQuery method to follow these guidelines:

Applications should break up all SQL queries so that the data returned is always less than 8 MB

Use the Unified CM Data Dictionary (http://www.cisco.com/en/US/products/sw/voicesw/ps556/products_programming_reference_guides_list.html) to help determine the maximum allowable size of any field in the database

ASCII characters are stored as 1-byte

i18n characters (UTF-8) are stored as 3-bytes

DB has a mix of ASCII and UTF-8 characters

While UCMgr is processing a large query, concurrent queries should not result in data sets larger than 2 MB

Applications should wait to receive a response before issuing subsequent queries

Applications should not submit duplicate queries.


Note Because AXL is not a real-time API, the autologout function of extension mobility does not work when the user is logged in/out of EM via the AXL interface.


Post-Installation Steps and Troubleshooting on the Linux Platform

The system implements AXL as a Java servlet. The Java implementation provides platform independence. AXL accesses the Unified CM database by using DBL2, which is a JDBC wrapper implementation. AXL gets packaged as a WAR file. Linux RPM installs the war file for AXL on Unified CM server.

Follow the procedures in Post-Installation Steps, to start the AXL service and set up user permissions. Next, follow the procedures in Post-Installation Troubleshooting Checklist, to check the installation.

Post-Installation Steps

You can start or stop the AXL web service from Unified CM Serviceability. The service is disabled by default. You should start the service before using the AXL APIs.

Starting the AXL Service


Step 1 From the Unified CM Administration window, choose Navigation > Unified CM Serviceability.

Step 2 Choose Tools > Service Activation.

Step 3 From the Server box, choose the server and click GO.

Step 4 From Database and Admin Services, select Cisco AXL Web Service and save the changes.

Upon starting the AXL service, AXL gets deployed as a web application within Apache Tomcat. The WAR file gets deployed to Tomcat under /usr/local/thirdparty/jakarta-tomcat/webapps/axl.


Setting AXL API Access Permissions


Step 1 From the Unified CM Administration window, choose User Management > UserGroup > Add New.

Step 2 To add AXP API access for the new UserGroup

a. Choose User Management > User Group.

b. Choose Role > Assign Role to Group.

c. Select Standard AXL API Access.

d. Click Add Selected.

e. On the main page, click Save.

Step 3 To add a user to the new UserGroup

a. Choose User Management > User Group.

b. Choose UserGroup > Add End Users to Group.

c. Select the user and click Add Selected.


Post-Installation Troubleshooting Checklist

Use the following checklist to avoid some common problems by fine-tuning your configuration before proceeding with the troubleshooting process:


Step 1 If the AXL client application cannot connect to the AXL service, check the following

Is the AXL application configured with the correct IP address for the AXL server?

Is the AXL application configured with the appropriate AXL user credentials?

Does the application server have HTTPS connectivity to the AXL server?

Use this URL for accessing AXL: https://server-name:port/axl/ (port is 8443).

Is HTTPS (secure) configured for AXL?

Step 2 Verify basic AXL functionality by performing the procedure that follows:

1. Go to the AXL API URL via a web browser.

For instance, enter https://server-name:8443/axl/ in the address text box.

2. When prompted for user name and password, use the standard administrator login, or use the user name that is associated with a user group that is assigned the AXL role.

3. Look for a plain page that states the AXL listener is working and accepting requests but only communicates via POST.

This procedure verifies functionality and user access.

Step 3 If the AXL functions or requests are failing with error as User Authorization error: "Access to the requested resource has been denied," check whether the user has the permission to the Standard AXL API Access. You can check this from the Permission Information section of the EndUser configuration window.

Step 4 If the AXL functions or requests are failing, check the following:

AXL logs for AXL or SOAP error responses. See the "AXL Error Codes" section.

For further debugging, you can view the AXL log files with the RTMT application.

Step 5 Check that applications in a cluster configuration are connected to the AXL service only on the Unified CM Publisher server if the application needs to modify the database.


AXL Trace Logs

AXL trace logs contain the text of every AXL request and response, along with user and origination IP information. Trace logs prove useful for identifying who is making AXL requests, inspecting the AXL XML request for format or syntax errors, and determining the actual AXL service response or errors.

The system writes the AXL trace logs to the /var/log/active/tomcat/logs/axl/log4j directory. You can view them with RTMT. File names are axl####.log, where # represents a number from 0000 (zero) to the maximum number of files allowed. The maximum file size is 1 MB by default. The maximum number of stored files defaults to 10. You can change these settings through the Serviceability windows .


Note If an AXL login request contains a <password> tag with an xmlns attribute value, versions of the AXL API prior to 6.0(1) or 5.1(2) log the password in clear text. In later versions of the API, the system replaces the password with an "*" character.

For .NET WSDL applications, including the xmlns attribute in the <password> tag would be typical behavior, and, in earlier releases, this could represent a security issue. If the SOAP message body contains a namespace tag, you do not need to specify the xmlns attribute for each individual tag.


While analyzing the log files:

Determine which log file is currently active by timestamp.

Look for Exception traces that indicate processing errors.

If no traces are being added, verify that Tomcat is running, AXL is currently activated, and a client application is attempting to communicate with the AXL API.

The following sample shows the AXL trace log output:

2007-03-17 05:32:26,512 INFO  [http-8443-Processor21] axl.AxlListener - Received request 
1173323669700 from CCMAdministrator at IP 10.77.31.203
2007-03-17 05:32:26,513 INFO  [http-8443-Processor21] axl.AxlListener - <!-- edited with 
XMLSPY v5 rel. 4 U (http://www.xmlspy.com) by Jerry Vander Voord (Cisco Systems) 
--><SOAP-ENV:Envelope 
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"><SOAP-ENV:Body>
<axlapi:addGatekeeper sequence="1" xmlns:axlapi="http://www.cisco.com/AXL/API/7.0" 
xmlns:axl="http://www.cisco.com/AXL/7.0" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:schemaLocation="http://www.cisco.com/AXL/API/7.0 axlsoap.xsd">
<gatekeeper>
	<name>AXL-Sample-GK1</name>
	<description>This is a sample gatekeeper</description>
	<rrqTimeToLive>30</rrqTimeToLive>
	<retryTimeout>30</retryTimeout>
	<enableDevice>false</enableDevice>
</gatekeeper>
</axlapi:addGatekeeper></SOAP-ENV:Body></SOAP-ENV:Envelope>
2007-03-17 05:32:26,668 INFO  [http-8443-Processor21] axl.Handler - Handler initializing
2007-03-17 05:32:26,788 INFO  [http-8443-Processor21] axl.AxlListener - <?xml 
version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope 
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"><SOAP-ENV:Header/><SOAP
-ENV:Body>
<axl:addGatekeeperResponse xmlns:axl=http://www.cisco.com/AXL/7.0 
xmlns:xsi="http://www.cisco.com/AXL/7.0" sequence="1">
<return>{7EB31958-C24A-3E63-3E4B-A8446365D35}</return>
</axl:addGatekeeperResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>
2007-03-17 05:32:26,789 INFO  [http-8443-Processor21] axl.AxlListener - Request 
1173323669700 was process in 356ms
 
   

The AXL trace log contains:

Time that the request was received - 05:32:26,512

Client IP address - IP 10.77.31.203

Client user ID - CCMAdministrator

Request ID number - 1173323669700

Request contents - addGatekeeper, <gatekeeper>, <name>, and so on

Response contents - <name>

Time taken for the response - 356 ms

Follow these steps to set the AXL trace level from the Serviceability window:


Step 1 From the Unified CM Administration window, choose Application > Unified CM Serviceability.

Step 2 Choose Trace > Configuration.

Step 3 From the Servers column, select the server and click GO.

Step 4 From the Service Group box, select Database And Admin Services and click GO.

Step 5 From the Services box, select the Cisco AXL Web Service and click GO.

Step 6 Check the Trace On check box.

Step 7 If you want the trace to apply to all Unified CM servers in the cluster, select the Apply to All Nodes check box.

Step 8 From the Debug Trace Level field, select Debug.

Step 9 You can set trace output options from the same window.



Note You should enable AXL logs only on request from Cisco TAC or Cisco Developer Services.


Using the AXL API with AXIS

This section explains how to use the AXLAPI.wsdl file in a Java programming environment.

Cisco has verified the AXLAPI.wsdl file in the WSDL-AXIS folder in the AXIS environment.

Cisco provides the associated schema file, AXLSoap.xsd, only for code generation. Cisco has modified this file to minimize the backwards compatibility impact of future changes in the database schema. Use the WSDL and the schema files in the parent directory for reference and for validation of responses.

The WSDL in Unified CM release 8.0(1) onwards is compatible with AXIS 2 and AXIS 1.4.

When you run the wsdl2Java utility to create the Java source code by using AXLAPI.wsdl, the utility throws two errors that are specific to AXIS_1_4. For further details on these errors, refer to http://issues.apache.org/jira/browse/AXIS-2545 and http://issues.apache.org/jira/browse/AXIS-1280.

The incorrect ordering of the parameters that are passed to the constructor causes the first AXIS jira error. A code example follows:

public class XNPDirectoryNumberShareLineAppearanceCSS  extends 
com.cisco.www.AXL.API._7_0.XCallingSearchSpace  implements java.io.Serializable {
>
>
super(
            uuid,
            name,
            description,
            clause,
            dialPlanWizardGenId,
            members);
 
   

However, the parent constructor is defined as:

public XCallingSearchSpace(
           org.apache.axis.types.Name name,
           java.lang.String description,
           java.lang.String clause,