This field is editable only if earlyOfferSupportForVoiceCall is set to true.
This field will be enabled only when SIP Normalization Script is present.
This field will be enabled only when SIP Normalization Script is present.
Equivalent field on the SIP Profile Configuration page in Cisco Unified CM Administration is renamed from Allow Passthrough of Configured Line Device Caller Information to Enable External Presentation Name and Number
SDP Transparency Profile for SIP Profile
This field is editable only if earlyOfferSupportForVoiceCall is set to true.
This field will be enabled only when SIP Normalization Script is present.
This field will be enabled only when SIP Normalization Script is present.
Equivalent field on the SIP Profile Configuration page in Cisco Unified CM Administration is renamed from Allow Passthrough of Configured Line Device Caller Information to Enable External Presentation Name and Number
SDP Transparency Profile for SIP Profile
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Only if digestAuthentication is enabled this value can be changed.
Only if digestAuthentication is enabled this value can be changed.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
TimePeriod cannot be published if it has a todOwnerId assigned to it. Only Administrative Time Period can be published.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
TimeSchedule cannot be published if it has a todOwnerId assigned to it. Only Administrative Time Schedule can be published.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
In Update setting isDefault tag as false would not disable this VoiceMailPilot as Default. Instead, the corresponding tag of another VoiceMailPilot should be set to true.
In Update setting isDefault tag as false would not disable this VoiceMailPilot as Default. Instead, the corresponding tag of another VoiceMailPilot should be set to true.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
The primary hostname of the process node.
The mac address of the host.
The primary hostname of the process node.
The mac address of the host.
At least one element under searchCriteria has to be mentioned
The primary hostname of the process node.
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Only Applicable if TimeSchedule is selected. If OriginatingDevice is selected then this tag is not applicable.
Only Applicable if TimeSchedule is selected. If OriginatingDevice is selected then this tag is not applicable.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
This tag is mandatory if autoRegistrationEnabled is true
This tag is mandatory if autoRegistrationEnabled is true
UDP port for MGCP communication.
TCP port for backhaul for Q.931 messages.
This tag is mandatory if autoRegistrationEnabled is true
This tag is mandatory if autoRegistrationEnabled is true
UDP port for MGCP communication.
TCP port for backhaul for Q.931 messages.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Not valid for get and list
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
This API should only be used by Hosted Collaboration Solution Shared Architecture deployments.
This API should only be used by Hosted Collaboration Solution Shared Architecture deployments.
At least one element under searchCriteria has to be mentioned
This API should only be used by Hosted Collaboration Solution Shared Architecture deployments.
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Not nullable.
Nullable. The value accepted and retrieved from the database for this field will be of type XCountry in AXLEnums.xsd
-1 means using system default
The calling search space used by Automated Alternate Routing. Nullable.
For IP Phones and Gateways. Nullable.
The calling search space used by Device Mobility. Nullable.
The value accepted and retrieved from the database for this field will be of type XRevertPriority in AXLEnums.xsd.
Not nullable.
Nullable. The value accepted and retrieved from the database for this field will be of type XCountry in AXLEnums.xsd
-1 means using system default
The calling search space used by Automated Alternate Routing. Nullable.
For IP Phones and Gateways. Nullable.
The calling search space used by Device Mobility. Nullable.
The value accepted and retrieved from the database for this field will be of type XRevertPriority in AXLEnums.xsd.
At least one element under searchCriteria has to be mentioned
Not nullable.
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Should not be modified for Cisco Media Termination Point (WS-SVC-CMM).
This tag is used only by Cisco Media Termination Point (WS-SVC-CMM) and is a mandatory tag for Cisco Media Termination Point (WS-SVC-CMM) Transcoder. Valid values range from 1 to 4.
For devices with load information, if any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product.
This tag is used only by Cisco Media Termination Point (WS-SVC-CMM)
This tag is mandatory only for Cisco Media Termination Point (WS-SVC-CMM). Valid values for this tag are 32,64,96,128.
Should not be modified for Cisco Media Termination Point (WS-SVC-CMM).
For devices with load information, if any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product.
This tag is used only by Cisco Media Termination Point (WS-SVC-CMM)
This tag is mandatory only for Cisco Media Termination Point (WS-SVC-CMM). Valid values for this tag are 32,64,96,128.
At least one element under searchCriteria has to be mentioned
Should not be modified for Cisco Media Termination Point (WS-SVC-CMM).
It will be used only when first tag is specified.
Nullable. The value accepted and retrieved from the database for this field will be of type XUserLocale in AXLEnums.xsd.
Nullable
Nullable
This setting only affect devices that support MLPP. Use -1 to set to null
This setting only affect devices that support MLPP
Default is not applicable for CommonDeviceConfig API
This setting only affect devices that support MLPP
Nullable. The value accepted and retrieved from the database for this field will be of type XUserLocale in AXLEnums.xsd.
Nullable
Nullable
This setting only affect devices that support MLPP. Use -1 to set to null
This setting only affect devices that support MLPP
Default is not applicable for CommonDeviceConfig API
This setting only affect devices that support MLPP
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
This tag has been deprecated in 12.0. Use ipv4/ipv6 subnetdetails instead.
This tag has been deprecated in 12.0. Use ipv4/ipv6 subnetdetails instead.
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Failed logon must be a number in the range 0 to 100. If 0 is entered, NoLimitForFailedLogon is true
Reset Failed logon attempts must be a number in the range 1 to 120. (minutes)
Lockout duration must be a number in the range 0 to 1440. (minutes), If 0 is entered then Administrator Must Unlock is true.
Credential change duration must be a number in the range 0 to 129600. (minutes)
Credential expires after must be a number in the range 0 to 365. (Days). If 0 is entered, then neverExpires is true
Minimum credential length must be a number in the range 0 to 64.
Stored number of previous credentials must be a number in the range 0 to 25.
Inactive days allowed must be a number in the range 0 to 5000.
Expiry warning days must be a number in the range 0 to 90.
Minimum Character Change difference between the old and new password.
Failed logon must be a number in the range 0 to 100. If 0 is entered, NoLimitForFailedLogon is true
Reset Failed logon attempts must be a number in the range 1 to 120. (minutes)
Lockout duration must be a number in the range 0 to 1440. (minutes), If 0 is entered then Administrator Must Unlock is true.
Credential change duration must be a number in the range 0 to 129600. (minutes)
Credential expires after must be a number in the range 0 to 365. (Days). If 0 is entered, then neverExpires is true
Minimum credential length must be a number in the range 0 to 64.
Stored number of previous credentials must be a number in the range 0 to 25.
Inactive days allowed must be a number in the range 0 to 5000.
Expiry warning days must be a number in the range 0 to 90.
Minimum Character Change difference between the old and new password.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
From Device table.
From Device table.
From Device table.
From Device table.
From Device table.
From Device table.
From Device table.
From Device table.
From Device table.
From Device table.
At least one element under searchCriteria has to be mentioned
From Device table.
From Device table.
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Only use when setting TFTP Default to true. Setting to true will result in setting all other CallManager groups to false.
Only use when setting TFTP Default to true. Setting to true will result in setting all other CallManager groups to false.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Actually called "tag" in database.
Actually called "tag" in database.
At least one element under searchCriteria has to be mentioned
Actually called "tag" in database.
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
The valid values ranges from 0 to 1073741824.
The valid values ranges from 0 to 1073741824.
The valid values ranges from 0 to 1073741824.
The valid values ranges from 0 to 1073741824.
The valid values ranges from 0 to 1073741824.
The valid values ranges from 0 to 1073741824.
The valid values ranges from 0 to 1073741824.
The valid values ranges from 0 to 1073741824.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Value between 0 to 1073741824.
Value between 0 to 1073741824.
Value between 0 to 1073741824.
Value between 0 to 1073741824.
Value between 0 to 1073741824.
Value between 0 to 1073741824.
Value between 0 to 1073741824.
Value between 0 to 1073741824.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
The prefix used for park-code retrieval. User will dial prefix plus park code to retrieve a parked call.
The pattern used to revert the call when the parked call is not retrieved within retrieval timer.
The prefix used for park-code retrieval. User will dial prefix plus park code to retrieve a parked call.
The pattern used to revert the call when the parked call is not retrieved within retrieval timer.
At least one element under searchCriteria has to be mentioned
The pattern used to revert the call when the parked call is not retrieved within retrieval timer.
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Nullable
Nullable
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Also known as controlled devices.
Name of device.
Only DNs associated with the associatedDevices of the User can be used as primary extension.
DN or Pattern
Route Partition to which the DN is associated.
Name of User Group
READ ONLY: Name of the User Role associated with the user group will be taken.
Maximum wait time for Desk Pickup must be a number in the range 0 to 30000.Not Nullable.
Remote Destination Limit must be a number in the range 1 to 10. Not Nullable.
Not Applicable for Add. Credential configuration for password.
The tag will be ignored in add, while update you can reset the hack count.
Not Applicable for add. These groups get automatically added once an user is added.
The tag will be ignored in add, while update you can reset the hack count.
This Tag is valid only for GetUser
Applicable for Controlled Devices
This field also corresponds to the field 'Number Displayed in Directory' for the Quick User/phone Add page.
These tags are for Quick User/Phone Add page
These tags are for Quick User/Phone Add page
Value should be of of the format user@domain
Applicable for Controlled Devices so this tag is appropriate for Get/UpdateUser APIs only.
Applicable for Controlled Devices so this tag is appropriate for Get/UpdateUser APIs with ipccExtension tag only.
These tags are for Get/UpdateUser APIs only.
If zeroHop value is false pin will be synchronized with UCxN, if synchronization is enabled for Unity Connection server and if zeroHop is true pin will not be synchronized with UCxN. This tage is supported only for updateUser api
This tag should only be used by Hosted Collaboration Solution Shared Architecture deployments.
Contains headset that are associated to user.
Name of headset.
Also known as controlled devices.
Name of device.
Only DNs associated with the associatedDevices of the User can be used as primary extension.
DN or Pattern
Route Partition to which the DN is associated.
Name of User Group
READ ONLY: Name of the User Role associated with the user group will be taken.
Maximum wait time for Desk Pickup must be a number in the range 0 to 30000.Not Nullable.
Remote Destination Limit must be a number in the range 1 to 10. Not Nullable.
Not Applicable for Add. Credential configuration for password.
The tag will be ignored in add, while update you can reset the hack count.
Not Applicable for add. These groups get automatically added once an user is added.
The tag will be ignored in add, while update you can reset the hack count.
This Tag is valid only for GetUser
Applicable for Controlled Devices
This field also corresponds to the field 'Number Displayed in Directory' for the Quick User/phone Add page.
These tags are for Quick User/Phone Add page
These tags are for Quick User/Phone Add page
These tags are for Quick User/Phone Add page
These tags are for Quick User/Phone Add page
Value should be of of the format user@domain
Applicable for Controlled Devices so this tag is appropriate for Get/UpdateUser APIs only.
Applicable for Controlled Devices so this tag is appropriate for Get/UpdateUser APIs with ipccExtension tag only.
These tags are for Get/UpdateUser APIs only.
If zeroHop value is false pin will be synchronized with UCxN, if synchronization is enabled for Unity Connection server and if zeroHop is true pin will not be synchronized with UCxN. This tage is supported only for updateUser api
This tag should only be used by Hosted Collaboration Solution Shared Architecture deployments.
Name of headset.
Name of headset.
Contains headset that are associated to user.
Name of headset.
At least one element under searchCriteria has to be mentioned
This tag should only be used by Hosted Collaboration Solution Shared Architecture deployments.
It will be used only when first tag is specified.
Valid range is 1-127 characters.
Not Applicable for Add. Credential configuration for password
Read Only
Read Only
The tag will be ignored in add, while update you can reset the hack count.
Valid range is 1-42 characters.
Also known as controlled devices.
Name of device.
Name of User Group
READ ONLY: Name of the User role associated with the user group will be taken
Valid range is 1-127 characters.
Not Applicable for Add. Credential configuration for password
Read Only
Read Only
The tag will be ignored in add, while update you can reset the hack count.
Valid range is 1-42 characters.
Also known as controlled devices.
Name of device.
Name of User Group
READ ONLY: Name of the User role associated with the user group will be taken
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Either ipAddress or ipv6Address need to be present and both cannot be blank.
Either ipAddress or ipv6Address need to be present and both cannot be blank.
Either ipAddress or ipv6Address need to be present and both cannot be blank.
Either ipAddress or ipv6Address need to be present and both cannot be blank.
Either ipAddress or ipv6Address need to be present and both cannot be blank.
Either ipAddress or ipv6Address need to be present and both cannot be blank.
Either ipAddress or ipv6Address need to be present and both cannot be blank.
Either ipAddress or ipv6Address need to be present and both cannot be blank.
Either ipAddress or ipv6Address need to be present and both cannot be blank.
Either ipAddress or ipv6Address need to be present and both cannot be blank.
At least one element under searchCriteria has to be mentioned
Either ipAddress or ipv6Address need to be present and both cannot be blank.
Either ipAddress or ipv6Address need to be present and both cannot be blank.
It will be used only when first tag is specified.
It can be one among / (slash), . (dot), - (dash)
It can be one among D/M/Y,M/D/Y,Y/M/D
It can be one among 12-hour,24-hour
It can be one among / (slash), . (dot), - (dash)
It can be one among D/M/Y,M/D/Y,Y/M/D
It can be one among 12-hour,24-hour
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Applicable for Cisco Unity Voice Mail 4.x or later, Cisco Unity Connection and Cisco Web Dialer
Applicable for Cisco Unity Voice Mail 4.x or later, Cisco Unity Connection and Cisco Web Dialer
Applicable only for Presence Server, CUMA Provisioning Server
Applicable only for Presence Server, CUMA Provisioning Server, CER Location Management
Applicable Only for Cisco Web dialer
Applicable for Cisco Unity Voice Mail 4.x or later, Cisco Unity Connection and Cisco Web Dialer
Applicable for Cisco Unity Voice Mail 4.x or later, Cisco Unity Connection and Cisco Web Dialer
Applicable for Cisco Unity Voice Mail 4.x or later, Cisco Unity Connection and Cisco Web Dialer
Applicable only for Presence Server, CUMA Provisioning Server
Applicable only for Presence Server, CUMA Provisioning Server, CER Location Management
Applicable Only for Cisco Web dialer
Applicable for Cisco Unity Voice Mail 4.x or later, Cisco Unity Connection and Cisco Web Dialer
At least one element under searchCriteria has to be mentioned
Applicable for Cisco Unity Voice Mail 4.x or later, Cisco Unity Connection and Cisco Web Dialer
It will be used only when first tag is specified.
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Required format is YYYY:MM:DD:HH:SS. Read Only when certificateOperation is 'No Pending Operation'. Please provide the above format while adding a new device
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Required format is YYYY:MM:DD:HH:SS. Read Only when certificateOperation is 'No Pending Operation'. Please provide the above format while adding a new device
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Format is YYYY:MM:DD:HH
Format is YYYY:MM:DD:HH
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
The process Node that this the service parameter belongs to. Not nullable.
Name of the service parameter. Not nullable.
The service that this service parameter belongs to.
The process Node that this the service parameter belongs to. Not nullable.
Name of the service parameter. Not nullable.
The service that this service parameter belongs to.
The process Node that this the service parameter belongs to. Not nullable.
Name of the service parameter. Not nullable.
The service that this service parameter belongs to.
At least one element under searchCriteria has to be mentioned
The process Node that this the service parameter belongs to. Not nullable.
The service that this service parameter belongs to.
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
In Update setting isDefault tag as false would not disable this VoiceMailProfile as Default. Instead, the corresponding tag of another VoiceMailProfile should be set to true.
In Update setting isDefault tag as false would not disable this VoiceMailProfile as Default. Instead, the corresponding tag of another VoiceMailProfile should be set to true.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This setting only affects devices that support MLPP.
The device name,using only URL-friendly characters
Optional description of the device
At least one element under searchCriteria has to be mentioned
The device name,using only URL-friendly characters
Optional description of the device
It will be used only when first tag is specified.
From Device Table
From Device Table
Value should be numbers in range of 30 to 300
Value should be numbers in range of 30 to 600
From Device Table
From Device Table
Value should be numbers in range of 30 to 300
Value should be numbers in range of 30 to 600
At least one element under searchCriteria has to be mentioned
From Device Table
From Device Table
It will be used only when first tag is specified.
The template's name
The list of buttons on this model of Phone.The feature and label of first button cannot be modified.
The template's name
The list of buttons on this model of Phone.The feature and label of first button cannot be modified.
At least one element under searchCriteria has to be mentioned
The template's name
It will be used only when first tag is specified.
This tag is valid only for RT Phones.
This tag is valid only for RT Phones.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This tag is not valid for H323Phone,H323trunk and SIPTrunk
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
The device name,using only URL-friendly characters
Optional description of the device
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This tag is not valid for H323Phone,H323trunk and SIPTrunk
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
At least one element under searchCriteria has to be mentioned
The device name,using only URL-friendly characters
Optional description of the device
It will be used only when first tag is specified.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Value "-1" in the response means no value has been assigned and internally the CM will use default setting i.e., 1800s.
Value "-1" in the response means no value has been assigned and internally the CM will use default setting i.e., 1800s.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
dialPlan is mandatory for patterns with @ in it.
This tag is not valid for a translation pattern.
If not specified then a default value of '0' is set. This tag is not applicable to networkServiceProtocol PRI NI2.
It is a mandatory tag if anychild tag of isdnNSFInfoElement is specified.
If not specified then the first record based on the protocol in NSFProtocolServiceMap table will be set as the default value.
This parameter will take effect only if the selected network service has a valid parameterName in TypeNSFService.
This tag is only valid when value of enabledccenforcement is true
dialPlan is mandatory for patterns with @ in it.
dialPlan is mandatory for patterns with @ in it.
This tag is not valid for a translation pattern.
If not specified then a default value of '0' is set. This tag is not applicable to networkServiceProtocol PRI NI2.
It is a mandatory tag if anychild tag of isdnNSFInfoElement is specified.
If not specified then the first record based on the protocol in NSFProtocolServiceMap table will be set as the default value.
This parameter will take effect only if the selected network service has a valid parameterName in TypeNSFService.
This tag is only valid when value of enabledccenforcement is true
dialPlan is mandatory for patterns with @ in it.
dialPlan is mandatory for patterns with @ in it.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for SIP phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for SIP phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Plars details cannot be added for dial pattern of type 7905_7912
Plars details cannot be added for dial pattern of type 7905_7912
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Applicable for Cisco Conference Bridge (WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS). Valid values range from 1 to 4.The value should be given as per the formula. Cisco Media Server : subunit = ((Extract two digits after 'A' from the name)-2)/3 + 1. Cisco Conference Bridge: subunit = ((Extract two digits after 'C' from the name)-1)/3 + 1
This tag is used only by Cisco Conference Bridge Hardware.For devices with load information, if any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product.
This tag is used only by Cisco Video Conference Bridge(IPVC-35xx),Cisco Conference Bridge (WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS).
This tag is mandatory for Cisco Conference Bridge(WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS). Valid values for this tag are 32,64,96,128.
Valid only for Cisco IOS Enhanced Conference Bridge
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Adding parameters for normalization script Info
Valid for Cisco TelePresence MCU/Conductor/CMS and max length is 31
Valid for Cisco TelePresence MCU/Conductor/CMS and max length is 31
Valid for Cisco TelePresence MCU and Conductor
Valid for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence Conference bridges
Valid only for Cisco TelePresence Conference bridges
Valid only for Cisco TelePresence Conference bridges
This option is available for Conference types MCU,Conductor and CMS
Valid only for Cisco TelePresence Conference bridges
Valid only for Cisco TelePresence Conference bridges
This tag is used only by Cisco Conference Bridge Hardware.For devices with load information, if any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product.
This tag is used only by Cisco Video Conference Bridge(IPVC-35xx),Cisco Conference Bridge (WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS).
This tag is mandatory for Cisco Conference Bridge(WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS). Valid values for this tag are 32,64,96,128.
Valid only for Cisco IOS Enhanced Conference Bridge
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Adding parameters for normalization script Info
Valid for Cisco TelePresence MCU/Conductor/CMS and max length is 31
Valid for Cisco TelePresence MCU/Conductor/CMS and max length is 31
Valid for Cisco TelePresence MCU and Conductor
Valid for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence Conference bridges
Valid only for Cisco TelePresence Conference bridges
Valid only for Cisco TelePresence Conference bridges
This option is available for Conference types MCU,Conductor and CMS
Valid only for Cisco TelePresence Conference bridges
Valid only for Cisco TelePresence Conference bridges
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
The new prefixDigit value for this particular AARGroup relationship.
The new prefixDigit value for this particular AARGroup relationship.
Optional description of the device
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
Optional description of the device
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
For an intercom line this tag should be treated as a mandatory tag and the valid values are Auto Answer with Headset and Auto Answer with Speakerphone.
A value of 0 means 'none selected'.
A value of 0 means 'none selected'.
This tag is applicable for only intercom lines and if not set, intercom lines will not be active.
While updating, send all the URIs
Applicable only for Update and Get Request
Applicable only for Update and Get Request
While UPDATE set it to false if you want to delete enterpriseAltNumber.Use only while update
While UPDATE set it to false if you want to delete e164AltNumber
For an intercom line this tag should be treated as a mandatory tag and the valid values are Auto Answer with Headset and Auto Answer with Speakerphone.
A value of 0 means 'none selected'.
A value of 0 means 'none selected'.
This tag is applicable for only intercom lines and if not set, intercom lines will not be active.
While updating, send all the URIs
Applicable only for Update and Get Request
Applicable only for Update and Get Request
While UPDATE set it to false if you want to delete enterpriseAltNumber.Use only while update
While UPDATE set it to false if you want to delete e164AltNumber
At least one element under searchCriteria has to be mentioned
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
It will be used only when first tag is specified.
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
Use -1 to set to null
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
Use -1 to set to null
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
Use -1 to set to null
Applicable only for H323Phones and H323Trunks.Not for Gateways.
Applicable only for H323Phones
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
The device name,using only URL-friendly characters
Optional description of the device
Use -1 to set to null
Applicable only for H323Phones and H323Trunks.Not for Gateways.
Applicable only for H323Phones
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
At least one element under searchCriteria has to be mentioned
The device name,using only URL-friendly characters
Optional description of the device
It will be used only when first tag is specified.
Maximum Half Duplex Streams must be a number in the range 0 to 500.
Maximum Multicast Connections must be a number in the range 0 to 999999.
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. Multicast Base Port number must be an even number in the range 16384 to 32766.
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. Multicast Base Port number must be an even number in the range 16384 to 32766. baseMulticastIPAddress and baseMulticastPort must be a unique pair. All Multicast IP Addresses must be in the range 239.1.1.1 to 239.255.255.255
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. Multicast Base Port number must be an even number in the range 16384 to 32766
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty.
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty.
Maximum Half Duplex Streams must be a number in the range 0 to 500.
Maximum Multicast Connections must be a number in the range 0 to 999999.
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. Multicast Base Port number must be an even number in the range 16384 to 32766.
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. Multicast Base Port number must be an even number in the range 16384 to 32766. baseMulticastIPAddress and baseMulticastPort must be a unique pair. All Multicast IP Addresses must be in the range 239.1.1.1 to 239.255.255.255
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. Multicast Base Port number must be an even number in the range 16384 to 32766
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty.
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
This setting only affects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
Applicable only for H323Phones and H323Trunks.Not for Gateways.
If set to True,mediaResourceList must be mentioned and mtpRequired must be set to True.
enableOutboundFaststart must be set to true for it to be read.Not Nillable.
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
Applicable only for H323Gateways and trunks
Applicable only for H323Gateways and trunks
Applicable only for H323Gateways and trunks
Applicable only for H323Gateways and trunks
The value of significantDigits must either from 0 to 32 or 99,Here 99 means ALL.enable attribute is Read-Only.If significantDigits is 0-32 then enable is true,if significantDigits is 99 then enable is false.
Applicable only for Non-Gatekeeper controlled ICT trunk's.
Applicable only for Non-Gatekeeper controlled ICT trunk's. Should be set only when ictPassingPrecendenceLevelThroughUUIE is set to true.
If set to false its mandatory to specify a value for the tag server1(remoteServerInfo is its parent tag)
The calling search space used by Automated Alternate Routing. Nullable.
The device name,using only URL-friendly characters
Optional description of the device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
This setting only affects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
Applicable only for H323Phones and H323Trunks.Not for Gateways.
If set to True,mediaResourceList must be mentioned and mtpRequired must be set to True.
enableOutboundFaststart must be set to true for it to be read.Not Nillable.
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
Applicable only for H323Gateways and trunks
Applicable only for H323Gateways and trunks
Applicable only for H323Gateways and trunks
Applicable only for H323Gateways and trunks
The value of significantDigits must either from 0 to 32 or 99,Here 99 means ALL.enable attribute is Read-Only.If significantDigits is 0-32 then enable is true,if significantDigits is 99 then enable is false.
Applicable only for Non-Gatekeeper controlled ICT trunk's.
Applicable only for Non-Gatekeeper controlled ICT trunk's. Should be set only when ictPassingPrecendenceLevelThroughUUIE is set to true.
If set to false its mandatory to specify a value for the tag server1(remoteServerInfo is its parent tag)
The calling search space used by Automated Alternate Routing. Nullable.
At least one element under searchCriteria has to be mentioned
The device name,using only URL-friendly characters
Optional description of the device
It will be used only when first tag is specified.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This tag is not valid for H323Phone,H323trunk and SIPTrunk
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
UUID changed each time device is updated
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
This Tag is valid only for SIP Phones and SIP Trunks
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier cannot be used with AddLines and RemoveLines.This tag is valid only for lines tag
Additional modules attached to the Phone.There can be 0,1, 2 or 3.
The name of the default profile for this device.Not Nullable.
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
Read-only for IP Phones.
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
Support for this tag has been removed for IMS phones from 9.0
Applicable only for H323Phones and H323Trunks.Not for Gateways.
authenticationMode can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
keySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
keyOrder can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
ecKeySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
authenticationString can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
Specifies if the phone is configured for device mobility or not.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag determines if the newly added phone is active to determine consumption of license.If set to false the license units will not be consumed.
Read-only tag.
The userid of the mobility user for this phone.Nullable.
If a blank tag is passed ,the value of the default is inserted into the database.
This tag is valid only for devices that support Secure Tone.
This field is applicable only to SIP phones.
This field is applicable only to SIP phones.
This tag is applicable only to thosedevices that support ssh feature.
This tag is applicable only to thosedevices that support ssh feature.
This field is applicable only to SIP phones.
This tag is valid only for devices that Automatic Outbound Callrollover
This tag is applicable for PLAR-supporting SIP/SCCP phones only
This tag is valid only for RT Phones.
This tag is valid only for TIP endpoints
This field is applicable only for Third-party AS-SIP Endpoint.
This tag is only valid when value of blockIncomingCallsWhenRoaming is true
This field is applicable only for Third-party AS-SIP Endpoint.
This field is applicable only for Third-party AS-SIP Endpoint.
Mobile Subscriber ISDN
The new enableCallRoutingToRdWhenNoneIsActive flag for Remote Destination Call Forwarding feature is required for CTI Remote Device. Not Nullable.
This boolean setting, when set to true, indicates that the phone should use activation code based registration
The device name,using only URL-friendly characters
Optional description of the device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This tag is not valid for H323Phone,H323trunk and SIPTrunk
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
UUID changed each time device is updated
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
This Tag is valid only for SIP Phones and SIP Trunks
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier cannot be used with AddLines and RemoveLines.This tag is valid only for lines tag
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier cannot be used with AddLines and RemoveLines.This tag is valid only for lines tag
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier cannot be used with AddLines and RemoveLines.This tag is valid only for lines tag
Additional modules attached to the Phone.There can be 0,1, 2 or 3.
The name of the default profile for this device.Not Nullable.
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
Read-only for IP Phones.
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
Support for this tag has been removed for IMS phones from 9.0
Applicable only for H323Phones and H323Trunks.Not for Gateways.
authenticationMode can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
keySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
keyOrder can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
ecKeySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
authenticationString can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
Specifies if the phone is configured for device mobility or not.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag determines if the newly added phone is active to determine consumption of license.If set to false the license units will not be consumed.
The userid of the mobility user for this phone.Nullable.
If a blank tag is passed ,the value of the default is inserted into the database.
This tag is valid only for devices that support Secure Tone.
This field is applicable only to SIP phones.
This field is applicable only to SIP phones.
This tag is applicable only to thosedevices that support ssh feature.
This tag is applicable only to thosedevices that support ssh feature.
This field is applicable only to SIP phones.
This tag is valid only for devices that Automatic Outbound Callrollover
This tag is applicable for PLAR-supporting SIP/SCCP phones only
This tag is valid only for RT Phones.
This tag is valid only for TIP endpoints
This field is applicable only for Third-party AS-SIP Endpoint.
This tag is only valid when value of blockIncomingCallsWhenRoaming is true
This field is applicable only for Third-party AS-SIP Endpoint.
This field is applicable only for Third-party AS-SIP Endpoint.
Mobile Subscriber ISDN
The new enableCallRoutingToRdWhenNoneIsActive flag for Remote Destination Call Forwarding feature is required for CTI Remote Device. Not Nullable.
This boolean setting, when set to true, indicates that the phone should use activation code based registration
At least one element under searchCriteria has to be mentioned
The device name,using only URL-friendly characters
Optional description of the device
Protocol option is read-only,except when creating a device.
It will be used only when first tag is specified.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
This setting only affects devices that support MLPP. Use -1 to set to null
When this flag is checked, IPSec needs to be configured in the network to provide end to end security. Failure to do so will expose keys and other information
If set to True,mediaResourceList must be mentioned and mtpRequired must be set to True.
enableOutboundFaststart must be set to true for it to be read.Not Nillable.
The value of significantDigits must either from 0 to 32 or 99,Here 99 means ALL.enable attribute is Read-Only.If significantDigits is 0-32 then enable is true,if significantDigits is 99 then enable is false.
The device name,using only URL-friendly characters
Optional description of the device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
This setting only affects devices that support MLPP. Use -1 to set to null
When this flag is checked, IPSec needs to be configured in the network to provide end to end security. Failure to do so will expose keys and other information
If set to True,mediaResourceList must be mentioned and mtpRequired must be set to True.
enableOutboundFaststart must be set to true for it to be read.Not Nillable.
The value of significantDigits must either from 0 to 32 or 99,Here 99 means ALL.enable attribute is Read-Only.If significantDigits is 0-32 then enable is true,if significantDigits is 99 then enable is false.
At least one element under searchCriteria has to be mentioned
The device name,using only URL-friendly characters
Optional description of the device
Protocol option is read-only,except when creating a device.
It will be used only when first tag is specified.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
Additional modules attached to the Phone.There can be 0,1 or 2.
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag is valid only for RT Phones.
The device name,using only URL-friendly characters
Optional description of the device
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
Additional modules attached to the Phone.There can be 0,1 or 2.
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag is valid only for RT Phones.
At least one element under searchCriteria has to be mentioned
The device name,using only URL-friendly characters
Optional description of the device
It will be used only when first tag is specified.
From 10.5, to get proper value of this tag in get handler's response it is required to have value of todaccess, in case if user does not give any value in todaccesss tag, axl will insert a random row so that get handler response can return proper value of Owner User id
While UPDATE set it to false if you want to delete enable Unified Mobility feature.Use only while update
If you are giving value to dualModeDeviceName then you can't give value to remoteDestinationProfileName,viceversa
While UPDATE set it to false if you want to delete Enable Extend and Connect.Use only while update
ctiRemoteDeviceName tag will be used to associate either CTI Remote Device or a Cisco Spark Remote Device with a Remote Destination
The line association for this remote destination. The line to be associated must already be added to the remote destination profile. All directory numbers specified must already exist in the database.
From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag
This tag is not applicable for dualmode phones
This tag is applicable only to CUMC devices.
This tag is for Mobility Identity
This tag must be used for configuring RingSchedule of RD, this tag will get precendence over todaccess and accesslist tag
From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag
From 10.5, to get proper value of this tag in get handler's response it is required to have value of todaccess, in case if user does not give any value in todaccesss tag, axl will insert a random row so that get handler response can return proper value of Owner User id
While UPDATE set it to false if you want to delete enable Unified Mobility feature.Use only while update
If you are giving value to dualModeDeviceName then you can't give value to remoteDestinationProfileName,viceversa
While UPDATE set it to false if you want to delete Enable Extend and Connect.Use only while update
ctiRemoteDeviceName tag will be used to associate either CTI Remote Device or a Cisco Spark Remote Device with a Remote Destination
The line association for this remote destination. The line to be associated must already be added to the remote destination profile. All directory numbers specified must already exist in the database.
From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag
This tag is not applicable for dualmode phones
This tag is applicable only to CUMC devices.
This tag is for Mobility Identity
This tag must be used for configuring RingSchedule of RD, this tag will get precendence over todaccess and accesslist tag
From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag
At least one element under searchCriteria has to be mentioned
If you are giving value to dualModeDeviceName then you can't give value to remoteDestinationProfileName,viceversa
ctiRemoteDeviceName tag will be used to associate either CTI Remote Device or a Cisco Spark Remote Device with a Remote Destination
It will be used only when first tag is specified.
The units element is optional when a newVG224 is being added and can be added using updateVG224Gateway.
In the IOS model unit corresponds to a SLOT(Slot Module)
It contains Product Specific Configuration Information like Fax mode, Modem Passthorugh, etc.
Read only. UUID that is changed each time the VG224 is updated.
It contains Product Specific Configuration Information like Fax mode, Modem Passthorugh, etc.
For SCCP mention MAC Address
For SCCP mention MAC Address
For SCCP mention MAC Address
For SCCP mention MAC Address
For SCCP mention MAC Address
At least one element under searchCriteria has to be mentioned
For SCCP mention MAC Address
It will be used only when first tag is specified.
For SCCP mention MAC Address
For SCCP mention MAC Address
For SCCP mention MAC Address
pkid of the Gateway whose endpoint is to be added
pkid of the Gateway whose endpoint is to be added
pkid of the Gateway whose endpoint is to be added
pkid of the Gateway whose endpoint is to be added
The device name,using only URL-friendly characters
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
UUID changed each time device is updated
Not valid for CTI route points and VoiceMail ports
This setting only effects devices that support MLPP. Use -1 to set to null
The device name,using only URL-friendly characters
UUID changed each time device is updated
Not valid for CTI route points and VoiceMail ports
This setting only effects devices that support MLPP. Use -1 to set to null
At least one element under searchCriteria has to be mentioned
The device name,using only URL-friendly characters
UUID changed each time device is updated
It will be used only when first tag is specified.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
The value for sigDigits must be between 0 to 32. enable attribute is read only
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
The device name,using only URL-friendly characters
Optional description of the device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
The value for sigDigits must be between 0 to 32. enable attribute is read only
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
At least one element under searchCriteria has to be mentioned
The device name,using only URL-friendly characters
Optional description of the device
It will be used only when first tag is specified.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
The value for sigDigits must be between 0 to 32. enable attribute is read only
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
The device name,using only URL-friendly characters
Optional description of the device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
The value for sigDigits must be between 0 to 32. enable attribute is read only
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
At least one element under searchCriteria has to be mentioned
The device name,using only URL-friendly characters
Optional description of the device
It will be used only when first tag is specified.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
The device name,using only URL-friendly characters
Optional description of the device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
At least one element under searchCriteria has to be mentioned
The device name,using only URL-friendly characters
Optional description of the device
It will be used only when first tag is specified.
On Addition always the first member added is itself. Do not specify the first member as itself in an Add request . Also make sure that the priority always starts with 1. It will internally be taken care of during Addition and Updation.
This tag is applicable when Pickup Notification Policy is "Visual Alert" or "Visual or Audio Alert".
On Addition always the first member added is itself. Do not specify the first member as itself in an Add request . Also make sure that the priority always starts with 1. It will internally be taken care of during Addition and Updation.
This tag is applicable when Pickup Notification Policy is "Visual Alert" or "Visual or Audio Alert".
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This tag is not valid for H323Phone,H323trunk and SIPTrunk
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
Applicable only for H323Phones and H323Trunks.Not for Gateways.
This tag is ignored and destAddrIsSRV is set to false if destinationaddress is an IP address and destinationport is mentioned correctly.This tag will not be returned by list.
The value of sigDigits must be either from 0 to 32 or 99. Here 99 means All. enable attribute is Read-Only. If sigDigits is 0-32 then enable is true, if sigDigits is 99 then enable is false.
This tag is valid only if srtpAllowed is set to false.
This tag is not supported in the Update method.
This tag when enabled will prevent external presentation name and external presentation number to be populated in SIP headers like P-Asserted ID and RPID.
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
This field can have values 0,1 or 2
The device name,using only URL-friendly characters
Optional description of the device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This tag is not valid for H323Phone,H323trunk and SIPTrunk
Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
Applicable only for H323Phones and H323Trunks.Not for Gateways.
This tag is ignored and destAddrIsSRV is set to false if destinationaddress is an IP address and destinationport is mentioned correctly.This tag will not be returned by list.
The value of sigDigits must be either from 0 to 32 or 99. Here 99 means All. enable attribute is Read-Only. If sigDigits is 0-32 then enable is true, if sigDigits is 99 then enable is false.
This tag is valid only if srtpAllowed is set to false.
This tag is not supported in the Update method.
This tag when enabled will prevent external presentation name and external presentation number to be populated in SIP headers like P-Asserted ID and RPID.
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
This field can have values 0,1 or 2
At least one element under searchCriteria has to be mentioned
The device name,using only URL-friendly characters
Optional description of the device
It will be used only when first tag is specified.
The new bandwidth value for this particular region relationship.
The new bandwidth value for this particular region relationship.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Applicable only for PSTN Access and RSVP Agent
Applicable only for PSTN Access and RSVP Agent
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Either safSipTrunk, safH323Trunk or both should be configured while adding
Either safSipTrunk, safH323Trunk or both should be configured while adding
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
For SCCP mention MAC Address
pkid of the Gateway
For SCCP mention MAC Address
pkid of the Gateway
valid only for Active Directory
valid only for Active Directory
valid only for Active Directory
valid only for Active Directory
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Name of the Emcc Parameter
Name of the Emcc Parameter
Name of the Emcc Parameter
Either learnedPattern or learnedPatternPrefix has to be set
Either learnedPattern or learnedPatternPrefix has to be set
Either learnedPattern or learnedPatternPrefix has to be set
Either learnedPattern or learnedPatternPrefix has to be set
Either learnedPattern or learnedPatternPrefix has to be set
At least one element under searchCriteria has to be mentioned
Either learnedPattern or learnedPatternPrefix has to be set
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Value shpuld be between 1024 and 65535
Value should be between 60 and 600
Value shpuld be between 1024 and 65535
Value should be between 60 and 600
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
The Fallback QOS Sensitivity should be in range 0 to 5
The Fallback Call Answer Timer should be in range 1 to 10
The number of digits for Caller ID partial match should be in range 4 to 15
The Fallback QOS Sensitivity should be in range 0 to 5
The Fallback Call Answer Timer should be in range 1 to 10
The number of digits for Caller ID partial match should be in range 4 to 15
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
If the value of isStandard is t (true), the fields are not editable.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
pkid of the Gateway whose endpoint is to be added
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Not applicable for Unified CM (IM and Presence) and AppStore ProductType
Not applicable for Unified CM (IM and Presence),CTI and AppStore ProductType
Not applicable for Unified CM (IM and Presence) and AppStore ProductType
Not applicable for Unified CM (IM and Presence),CTI and AppStore ProductType
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
SIP Trunk for Video On Hold Server
SIP Trunk for Video On Hold Server
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
This tag corresponds to Proxy Auto-Config (PAC) Location when proxy setting is set to Auto
This tag is used for validation and does not correspond to any field in database.
This tag corresponds to Proxy Auto-Config (PAC) Location when proxy setting is set to Auto
This tag is used for validation and does not correspond to any field in database.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Not nullable.
Not nullable.
At least one element under searchCriteria has to be mentioned
Not nullable.
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
if version is 3 then it will be snmpUserId and if version is 2 then it will be treated as snmpCommuintyString
if version is 3 then it will be snmpUserId and if version is 2 then it will be treated as snmpCommuintyString
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
Desired expiry time (in seconds) of activation code. Able to specify on AddPhoneActivationCode request. read-only
Device name of self onboardable phone, doesn't have to be a valid MAC. read-only
Activation code for a valid phone that supports Secure Self Onboarding
At least one element under searchCriteria has to be mentioned
Device name of self onboardable phone, doesn't have to be a valid MAC. read-only
User associated (if applicable) to onboardable phone
It will be used only when first tag is specified.
The filename of the firmware load that is used with a particular type of hardware device model. The file is fed to the phones via TFTP. This can be overridden at the device level. If not overridden, then all devices of this model will use this firmware load file.
The filename of the inactive firmware load that is used with phone models that support dual-bank firmware (background download). The file is fed to the phones via TFTP but is not active. This can be overridden at the device level. If not overridden, then all devices of this model will download this firmware load file as the inactive load.
The name of the Device Pool, (which defines common Device / Phone characteristics), to be assigned, by default, to Devices / Phones with this Model and Protocol. This can, of course, be overridden at the device level. If not overridden, then all devices of this model and protocol will be assigned to this same Device Pool.
The name of the Phone Button Template, (which defines the line and feature button related characteristics of a Device or Phone ), which may be shared by multiple phones and which will be assigned, by default, to Devices / Phones with this Model and Protocol. This can, of course, be overridden at the device level. If not overridden, then all devices of this model and protocol will be associated with this same Phone Button Template.
UUID changed each time device is updated
This boolean setting, when TRUE and unless overridden for specific Phones / Devices of this Model and Protocol, indicates a preferred use of activation code based registrations rather than basic auto-registration. This can, of course, be overridden at the device level. If not overridden, then all devices of this model and protocol will, when created be initially marked to use this registratin mode.
String indicating the Device / Phone Model to which these default settings apply. Read Only.
String indicating the Device / Phone Protocol for which these default settings for this Model apply. Read Only.
The filename of the firmware load that is used with a particular type of hardware device model. The file is fed to the phones via TFTP. This can be overridden at the device level. If not overridden, then all devices of this model will use this firmware load file.
The filename of the inactive firmware load that is used with phone models that support dual-bank firmware (background download). The file is fed to the phones via TFTP but is not active. This can be overridden at the device level. If not overridden, then all devices of this model will download this firmware load file as the inactive load.
The name of the Device Pool, (which defines common Device / Phone characteristics), to be assigned, by default, to Devices / Phones with this Model and Protocol. This can, of course, be overridden at the device level. If not overridden, then all devices of this model and protocol will be assigned to this same Device Pool.
The name of the Phone Button Template, (which defines the line and feature button related characteristics of a Device or Phone ), which may be shared by multiple phones and which will be assigned, by default, to Devices / Phones with this Model and Protocol. This can, of course, be overridden at the device level. If not overridden, then all devices of this model and protocol will be associated with this same Phone Button Template.
UUID changed each time device is updated
This boolean setting, when TRUE and unless overridden for specific Phones / Devices of this Model and Protocol, indicates a preferred use of activation code based registrations rather than basic auto-registration. This can, of course, be overridden at the device level. If not overridden, then all devices of this model and protocol will, when created be initially marked to use this registratin mode.
String indicating the Device / Phone Model to which these default settings apply. Read Only.
String indicating the Device / Phone Protocol for which these default settings for this Model apply. Read Only.
At least one element under searchCriteria has to be mentioned
String indicating the Device / Phone Model to which these default settings apply. Read Only.
String indicating the Device / Phone Protocol for which these default settings for this Model apply. Read Only.
It will be used only when first tag is specified.
In Update setting isDefault tag as false would not disable this MraServiceDomain as Default. Instead, the corresponding tag of another MraServiceDomain should be set to true.
In Update setting isDefault tag as false would not disable this MraServiceDomain as Default. Instead, the corresponding tag of another MraServiceDomain should be set to true.
At least one element under searchCriteria has to be mentioned
In Update setting isDefault tag as false would not disable this MraServiceDomain as Default. Instead, the corresponding tag of another MraServiceDomain should be set to true.
It will be used only when first tag is specified.
This value does not exist in the database. This field is used to generate / remove. During update, if the value in the database goes from false to true, then voucher is generated. Conversely, if value goes from true to false, the voucher is removed. During generation of voucher, the population of other fields happens after the voucher creation. Note that this simulates clicking the Create Voucher button. During removal of voucher, the fields will be populated then the voucher will be removed. Voucher removal will only happen in the Cisco Cloud un-boarded state.
Successfully setting the values of one or both of enableGdsCommunication and enablePushNotifications to true finishes the Cisco Cloud Onboarding process. Setting them both to false moves Cisco Cloud Onboarding to un-boarded state.
During updates, the value of this field is ignored and the value of enableTroubleShooting is used instead, if any.
Successfully setting the values of one or both of enableGdsCommunication and enablePushNotifications to true finishes the Cisco Cloud Onboarding process. Setting them both to false moves Cisco Cloud Onboarding to un-boarded state.
This value does not exist in the database. This field is used to generate / remove. During update, if the value in the database goes from false to true, then voucher is generated. Conversely, if value goes from true to false, the voucher is removed. During generation of voucher, the population of other fields happens after the voucher creation. Note that this simulates clicking the Create Voucher button. During removal of voucher, the fields will be populated then the voucher will be removed. Voucher removal will only happen in the Cisco Cloud un-boarded state.
Successfully setting the values of one or both of enableGdsCommunication and enablePushNotifications to true finishes the Cisco Cloud Onboarding process. Setting them both to false moves Cisco Cloud Onboarding to un-boarded state.
During updates, the value of this field is ignored and the value of enableTroubleShooting is used instead, if any.
Successfully setting the values of one or both of enableGdsCommunication and enablePushNotifications to true finishes the Cisco Cloud Onboarding process. Setting them both to false moves Cisco Cloud Onboarding to un-boarded state.
At least one element under searchCriteria has to be mentioned
It will be used only when first tag is specified.
This field is editable only if earlyOfferSupportForVoiceCall is set to true.
This field will be enabled only when SIP Normalization Script is present.
This field will be enabled only when SIP Normalization Script is present.
Equivalent field on the SIP Profile Configuration page in Cisco Unified CM Administration is renamed from Allow Passthrough of Configured Line Device Caller Information to Enable External Presentation Name and Number
SDP Transparency Profile for SIP Profile
Only if digestAuthentication is enabled this value can be changed.
TimePeriod cannot be published if it has a todOwnerId assigned to it. Only Administrative Time Period can be published.
TimeSchedule cannot be published if it has a todOwnerId assigned to it. Only Administrative Time Schedule can be published.
In Update setting isDefault tag as false would not disable this VoiceMailPilot as Default. Instead, the corresponding tag of another VoiceMailPilot should be set to true.
The primary hostname of the process node.
The mac address of the host.
Read-only.
Only Applicable if TimeSchedule is selected. If OriginatingDevice is selected then this tag is not applicable.
Read-only.
Read-only.
This tag is mandatory if autoRegistrationEnabled is true
This tag is mandatory if autoRegistrationEnabled is true
Read only
Not valid for get and list
This API should only be used by Hosted Collaboration Solution Shared Architecture deployments.
This API should only be used by Hosted Collaboration Solution Shared Architecture deployments. Read-only: Time customer was created
This API should only be used by Hosted Collaboration Solution Shared Architecture deployments. Read-only: Time last customer audit occurred
Read-only.
Not nullable.
Nullable. The value accepted and retrieved from the database for this field will be of type XCountry in AXLEnums.xsd
-1 means using system default
The calling search space used by Automated Alternate Routing. Nullable.
For IP Phones and Gateways. Nullable.
The calling search space used by Device Mobility. Nullable.
The value accepted and retrieved from the database for this field will be of type XRevertPriority in AXLEnums.xsd.
Read only
Should not be modified for Cisco Media Termination Point (WS-SVC-CMM).
This tag is used only by Cisco Media Termination Point (WS-SVC-CMM) and is a mandatory tag for Cisco Media Termination Point (WS-SVC-CMM) Transcoder. Valid values range from 1 to 4.
For devices with load information, if any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product.
This tag is mandatory only for Cisco Media Termination Point (WS-SVC-CMM). Valid values for this tag are 32,64,96,128.
Nullable. The value accepted and retrieved from the database for this field will be of type XUserLocale in AXLEnums.xsd.
Nullable
Nullable
This setting only affect devices that support MLPP
Default is not applicable for CommonDeviceConfig API
This setting only affect devices that support MLPP
Failed logon must be a number in the range 0 to 100. If 0 is entered, NoLimitForFailedLogon is true
Reset Failed logon attempts must be a number in the range 1 to 120. (minutes)
Lockout duration must be a number in the range 0 to 1440. (minutes), If 0 is entered then Administrator Must Unlock is true.
Credential change duration must be a number in the range 0 to 129600. (minutes)
Credential expires after must be a number in the range 0 to 365. (Days). If 0 is entered, then neverExpires is true
Minimum credential length must be a number in the range 0 to 64.
Stored number of previous credentials must be a number in the range 0 to 25.
Inactive days allowed must be a number in the range 0 to 5000.
Expiry warning days must be a number in the range 0 to 90.
Minimum Character Change difference between the old and new password.
From Device table.
From Device table.
From Device table.
From Device table.
From Device table.
Read only.
Read only.
Only use when setting TFTP Default to true. Setting to true will result in setting all other CallManager groups to false.
Actually called "tag" in database.
Read-only.
The valid values ranges from 0 to 1073741824.
The valid values ranges from 0 to 1073741824.
The valid values ranges from 0 to 1073741824.
The valid values ranges from 0 to 1073741824.
Value between 0 to 1073741824.
Value between 0 to 1073741824.
Value between 0 to 1073741824.
Value between 0 to 1073741824.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
The prefix used for park-code retrieval. User will dial prefix plus park code to retrieve a parked call.
The pattern used to revert the call when the parked call is not retrieved within retrieval timer.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
Nullable
Only DNs associated with the associatedDevices of the User can be used as primary extension.
DN or Pattern
Route Partition to which the DN is associated.
Maximum wait time for Desk Pickup must be a number in the range 0 to 30000.Not Nullable.
Remote Destination Limit must be a number in the range 1 to 10. Not Nullable.
Read Only
This field also corresponds to the field 'Number Displayed in Directory' for the Quick User/phone Add page.
Value should be of of the format user@domain
This tag should only be used by Hosted Collaboration Solution Shared Architecture deployments.
Either ipAddress or ipv6Address need to be present and both cannot be blank.
Either ipAddress or ipv6Address need to be present and both cannot be blank.
It can be one among D/M/Y,M/D/Y,Y/M/D
Read-Only
Applicable for Cisco Unity Voice Mail 4.x or later, Cisco Unity Connection and Cisco Web Dialer
Applicable only for Presence Server, CUMA Provisioning Server
Applicable only for Presence Server, CUMA Provisioning Server, CER Location Management
Applicable Only for Cisco Web dialer
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Required format is YYYY:MM:DD:HH:SS. Read Only when certificateOperation is 'No Pending Operation'. Please provide the above format while adding a new device
Read-Only
Format is YYYY:MM:DD:HH
Read-Only
The process Node that this the service parameter belongs to. Not nullable.
Name of the service parameter. Not nullable.
The service that this service parameter belongs to.
In Update setting isDefault tag as false would not disable this VoiceMailProfile as Default. Instead, the corresponding tag of another VoiceMailProfile should be set to true.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This setting only affects devices that support MLPP.
From Device Table
From Device Table
Value should be numbers in range of 30 to 300
Value should be numbers in range of 30 to 600
The template's name
Read-only
This tag is valid only for RT Phones.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This tag is not valid for H323Phone,H323trunk and SIPTrunk
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
Always set as true
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
Value "-1" in the response means no value has been assigned and internally the CM will use default setting i.e., 1800s.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
dialPlan is mandatory for patterns with @ in it.
This tag is not valid for a translation pattern.
Read Only
Read Only
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for SIP phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable for Cisco Conference Bridge (WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS). Valid values range from 1 to 4.The value should be given as per the formula. Cisco Media Server : subunit = ((Extract two digits after 'A' from the name)-2)/3 + 1. Cisco Conference Bridge: subunit = ((Extract two digits after 'C' from the name)-1)/3 + 1
This tag is used only by Cisco Conference Bridge Hardware.For devices with load information, if any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product.
This tag is mandatory for Cisco Conference Bridge(WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS). Valid values for this tag are 32,64,96,128.
Valid only for Cisco IOS Enhanced Conference Bridge
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid for Cisco TelePresence MCU/Conductor/CMS and max length is 31
Valid for Cisco TelePresence MCU/Conductor/CMS and max length is 31
Valid for Cisco TelePresence MCU and Conductor
Valid for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence Conference bridges
This option is available for Conference types MCU,Conductor and CMS
Valid only for Cisco TelePresence Conference bridges
Valid only for Cisco TelePresence Conference bridges
The new prefixDigit value for this particular AARGroup relationship.
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
For an intercom line this tag should be treated as a mandatory tag and the valid values are Auto Answer with Headset and Auto Answer with Speakerphone.
A value of 0 means 'none selected'.
A value of 0 means 'none selected'.
This tag is applicable for only intercom lines and if not set, intercom lines will not be active.
Applicable only for Update and Get Request
Applicable only for Update and Get Request
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
Applicable only for H323Phones and H323Trunks.Not for Gateways.
Applicable only for H323Phones
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
Maximum Half Duplex Streams must be a number in the range 0 to 500.
Maximum Multicast Connections must be a number in the range 0 to 999999.
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. Multicast Base Port number must be an even number in the range 16384 to 32766.
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. Multicast Base Port number must be an even number in the range 16384 to 32766. baseMulticastIPAddress and baseMulticastPort must be a unique pair. All Multicast IP Addresses must be in the range 239.1.1.1 to 239.255.255.255
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. Multicast Base Port number must be an even number in the range 16384 to 32766
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
Applicable only for H323Phones and H323Trunks.Not for Gateways.
If set to True,mediaResourceList must be mentioned and mtpRequired must be set to True.
enableOutboundFaststart must be set to true for it to be read.Not Nillable.
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
Applicable only for H323Gateways and trunks
Applicable only for H323Gateways and trunks
Applicable only for H323Gateways and trunks
Applicable only for H323Gateways and trunks
The value of significantDigits must either from 0 to 32 or 99,Here 99 means ALL.enable attribute is Read-Only.If significantDigits is 0-32 then enable is true,if significantDigits is 99 then enable is false.
Applicable only for Non-Gatekeeper controlled ICT trunk's.
Applicable only for Non-Gatekeeper controlled ICT trunk's. Should be set only when ictPassingPrecendenceLevelThroughUUIE is set to true.
If set to false its mandatory to specify a value for the tag server1(remoteServerInfo is its parent tag)
The calling search space used by Automated Alternate Routing. Nullable.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This tag is not valid for H323Phone,H323trunk and SIPTrunk
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
This Tag is valid only for SIP Phones and SIP Trunks
Read-only for IP Phones.
The name of the default profile for this device.Not Nullable.
Read-only
Read-only
This tag is valid only for a get phone response.It contains Extension Mobility related parameters for a device when a user is logged in using a user defined device profile.If no user is logged in,the original device information for these parameters is returned.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
Read-only for IP Phones.
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
Support for this tag has been removed for IMS phones from 9.0
Applicable only for H323Phones and H323Trunks.Not for Gateways.
authenticationMode can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
keySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
keyOrder can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
ecKeySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
authenticationString can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
Specifies if the phone is configured for device mobility or not.
Read-only.Specifies the device pool being used if the device is roaming and the deviceMobility feature is enabled for it.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag determines if the newly added phone is active to determine consumption of license.If set to false the license units will not be consumed.
Read-only tag.
The userid of the mobility user for this phone.Nullable.
If a blank tag is passed ,the value of the default is inserted into the database.
This tag is valid only for devices that support Secure Tone.
This field is applicable only to SIP phones.
This field is applicable only to SIP phones.
This tag is applicable only to thosedevices that support ssh feature.
This field is applicable only to SIP phones.
This tag is valid only for devices that Automatic Outbound Callrollover
This tag is applicable for PLAR-supporting SIP/SCCP phones only
This tag is valid only for RT Phones.
This tag is valid only for TIP endpoints
This field is applicable only for Third-party AS-SIP Endpoint.
This tag is only valid when value of blockIncomingCallsWhenRoaming is true
This field is applicable only for Third-party AS-SIP Endpoint.
This field is applicable only for Third-party AS-SIP Endpoint.
The new enableCallRoutingToRdWhenNoneIsActive flag for Remote Destination Call Forwarding feature is required for CTI Remote Device. Not Nullable.
This boolean setting, when set to true, indicates that the phone should use activation code based registration
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
When this flag is checked, IPSec needs to be configured in the network to provide end to end security. Failure to do so will expose keys and other information
If set to True,mediaResourceList must be mentioned and mtpRequired must be set to True.
enableOutboundFaststart must be set to true for it to be read.Not Nillable.
The value of significantDigits must either from 0 to 32 or 99,Here 99 means ALL.enable attribute is Read-Only.If significantDigits is 0-32 then enable is true,if significantDigits is 99 then enable is false.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
The name of the default profile for this device.Not Nullable.
Read-only
Read-only
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag is valid only for a get deviceprofile response.It contains Extension Mobility related parameters for a device when a user is logged in using a user defined device profile.If no user is logged in,the original device information for these parameters is returned.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
This tag is valid only for RT Phones.
If you are giving value to dualModeDeviceName then you can't give value to remoteDestinationProfileName,viceversa
ctiRemoteDeviceName tag will be used to associate either CTI Remote Device or a Cisco Spark Remote Device with a Remote Destination
From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag
This tag is not applicable for dualmode phones
This tag is applicable only to CUMC devices.
This tag is for Mobility Identity
The units element is optional when a newVG224 is being added and can be added using updateVG224Gateway.
In the IOS model unit corresponds to a SLOT(Slot Module)
For SCCP mention MAC Address
pkid of the Gateway whose endpoint is to be added
pkid of the Gateway whose endpoint is to be added
pkid of the Gateway whose endpoint is to be added
pkid of the Gateway whose endpoint is to be added
The device name,using only URL-friendly characters
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
UUID changed each time device is updated
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
The value for sigDigits must be between 0 to 32. enable attribute is read only
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
The value for sigDigits must be between 0 to 32. enable attribute is read only
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
This tag is applicable when Pickup Notification Policy is "Visual Alert" or "Visual or Audio Alert".
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This tag is not valid for H323Phone,H323trunk and SIPTrunk
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
Applicable only for H323Phones and H323Trunks.Not for Gateways.
This tag is ignored and destAddrIsSRV is set to false if destinationaddress is an IP address and destinationport is mentioned correctly.This tag will not be returned by list.
The value of sigDigits must be either from 0 to 32 or 99. Here 99 means All. enable attribute is Read-Only. If sigDigits is 0-32 then enable is true, if sigDigits is 99 then enable is false.
This tag is valid only if srtpAllowed is set to false.
This tag is not supported in the Update method.
This tag when enabled will prevent external presentation name and external presentation number to be populated in SIP headers like P-Asserted ID and RPID.
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
The new bandwidth value for this particular region relationship.
Always set as true
Applicable only for PSTN Access and RSVP Agent
For SCCP mention MAC Address
pkid of the Gateway
For SCCP mention MAC Address
pkid of the Gateway
Name of the Emcc Parameter
Either learnedPattern or learnedPatternPrefix has to be set
Value shpuld be between 1024 and 65535
Value should be between 60 and 600
The Fallback QOS Sensitivity should be in range 0 to 5
The Fallback Call Answer Timer should be in range 1 to 10
The number of digits for Caller ID partial match should be in range 4 to 15
If the value of isStandard is t (true), the fields are not editable.
pkid of the Gateway whose endpoint is to be added
Not applicable for Unified CM (IM and Presence) and AppStore ProductType
Not applicable for Unified CM (IM and Presence),CTI and AppStore ProductType
SIP Trunk for Video On Hold Server
Not nullable.
if version is 3 then it will be snmpUserId and if version is 2 then it will be treated as snmpCommuintyString
Activation code for a valid phone that supports Secure Self Onboarding
Desired expiry time (in seconds) of activation code. Able to specify on AddPhoneActivationCode request. read-only
Device name of self onboardable phone, doesn't have to be a valid MAC. read-only
User associated (if applicable) to onboardable phone
String indicating the Device / Phone Model to which these default settings apply. Read Only.
String indicating the Device / Phone Protocol for which these default settings for this Model apply. Read Only.
The filename of the firmware load that is used with a particular type of hardware device model. The file is fed to the phones via TFTP. This can be overridden at the device level. If not overridden, then all devices of this model will use this firmware load file.
The filename of the inactive firmware load that is used with phone models that support dual-bank firmware (background download). The file is fed to the phones via TFTP but is not active. This can be overridden at the device level. If not overridden, then all devices of this model will download this firmware load file as the inactive load.
The name of the Device Pool, (which defines common Device / Phone characteristics), to be assigned, by default, to Devices / Phones with this Model and Protocol. This can, of course, be overridden at the device level. If not overridden, then all devices of this model and protocol will be assigned to this same Device Pool.
The name of the Phone Button Template, (which defines the line and feature button related characteristics of a Device or Phone ), which may be shared by multiple phones and which will be assigned, by default, to Devices / Phones with this Model and Protocol. This can, of course, be overridden at the device level. If not overridden, then all devices of this model and protocol will be associated with this same Phone Button Template.
This boolean setting, when TRUE and unless overridden for specific Phones / Devices of this Model and Protocol, indicates a preferred use of activation code based registrations rather than basic auto-registration. This can, of course, be overridden at the device level. If not overridden, then all devices of this model and protocol will, when created be initially marked to use this registratin mode.
In Update setting isDefault tag as false would not disable this MraServiceDomain as Default. Instead, the corresponding tag of another MraServiceDomain should be set to true.
This value does not exist in the database. This field is used to generate / remove. During update, if the value in the database goes from false to true, then voucher is generated. Conversely, if value goes from true to false, the voucher is removed. During generation of voucher, the population of other fields happens after the voucher creation. Note that this simulates clicking the Create Voucher button. During removal of voucher, the fields will be populated then the voucher will be removed. Voucher removal will only happen in the Cisco Cloud un-boarded state.
Successfully setting the values of one or both of enableGdsCommunication and enablePushNotifications to true finishes the Cisco Cloud Onboarding process. Setting them both to false moves Cisco Cloud Onboarding to un-boarded state.
During updates, the value of this field is ignored and the value of enableTroubleShooting is used instead, if any.
Currently read-only. For possible future use.
This is a readonly field. During update, the value of this field is internally generated when the value of alarmSendEncryptedData in database changes from false to true ; or deleted when the value changes from true to false.
This is a readonly field. It is set during update automatically to the correct value that reflects the status of the system.
Currently read-only. For possible future use.
Currently read-only. For possible future use.
Currently read-only. For possible future use.
Currently read-only. For possible future use.
Currently read-only. For possible future use.
Successfully setting the values of one or both of enableGdsCommunication and enablePushNotifications to true finishes the Cisco Cloud Onboarding process. Setting them both to false moves Cisco Cloud Onboarding to un-boarded state.
Read-only listing of any statuses that may affect onboarding configuration. Some of these statuses are common with GUI screens.
Mandatory when "callerFilterMask" has value as Directory Number
Mandatory when value is a directory number
The feature invoked by this button.
The label invoked by this button.
Use original Called DN forward no-coverage settings
Value "-1" in the response means no value has been assigned and internally the CM will use default setting i.e., 1800s.
Use original Called DN forward no-coverage settings
Value "-1" in the response means no value has been assigned and internally the CM will use default setting i.e., 1800s.
The uuid attribute is read here
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
Applicable only for callForwardNoAnswer and callForwardAlternateParty,Value "-1" in the response indicates that the CM will use the default setting
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
Applicable only for callForwardNoAnswer and callForwardAlternateParty,Value "-1" in the response indicates that the CM will use the default setting
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
Applicable only for callForwardNoAnswer and callForwardAlternateParty,Value "-1" in the response indicates that the CM will use the default setting
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
Only uuid attribute is returned in response
Consecutive Rings Setting. Replaces the consective ring setting on IPPhone.
Applicable only for IP Phones
Applicable only for IP Phones
Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway
This tag cannot be modified. It can only be specified in the add request.
Only uuid attribute is returned in response
Consecutive Rings Setting. Replaces the consective ring setting on IPPhone.
Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway
Applicable only for IP Phones
Applicable only for IP Phones
Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
Load Information is either the module's specific load information or the default load information.If any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product.
Model ID string.
Read-only.
Read-only.
Read-only.
Read-only.
Read Only. Value should be between 1 and 100
Only the uuid attribute is read
The directory number to be associated. This directory number must be already associated to remote destination profile.
The directory number to be associated. This directory number must be already associated to cti remote device.
Mandatory for ground start and loop start
The value for sigDigits must be between 0 to 32. enable attribute is read only.
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element. Not applicable to FXO ports
The lineIdentifier is a shorthand method that refers to a particular directory number.
Not used by T1 Ports
Arbitrary XML defined by 3rd party vendors.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This setting only effects devices that support MLPP. Use -1 to set to null
This tag is applicable for MGCP FXS ports,which supports PLAR.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
The value for sigDigits must be between 0 to 32. enable attribute is read only
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
This tag is applicable for the following PRI protocols : : PRI NI2, PRI DMS-250, PRI DMS-100, PRI 4ESS, PRI 5E8, PRI 5E8 TELEOS, PRI 5E8 INTECOME, PRI 5E8 CUSTOM, PRI 5E9.
This tag is applicable for the following PRI protocols : PRI DMS-100, PRI DMS-250, PRI ISO QSIG T1, PRI ISO QSIG E1.
This tag is applicable for the following PRI protocols : PRI DMS-100, PRI DMS-250, PRI ISO QSIG T1, PRI ISO QSIG E1.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
The value for sigDigits must be between 0 to 32. enable attribute is read only
The value for sigDigits must be between 0 to 32. enable attribute is read only
Arbitrary XML defined by 3rd party vendors.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
This is a read only tag. The value will be the currently added GeoLocationPolicy pkid.
Only uuid attribute is returned in response
Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway
This tag cannot be modified. It can only be specified in the add request.
This tag will be taken to consideration only when 'overrideDefault' tag is set to True.This will be handled in the code.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This setting only effects devices that support MLPP. Use -1 to set to null
This tag is applicable for MGCP FXS ports,which supports PLAR.
Applicable only for SCCP
Applicable only for SCCP
Applicable only for SCCP
Applicable only for SCCP
Applicable only for SCCP
Applicable only for SCCP
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Applicable only for SCCP
Applicable only for SCCP
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element. Not applicable to FXO ports
The lineIdentifier is a shorthand method that refers to a particular directory number.
Applicable only for Conferencing Profile
StartDay and EndDay value should be same
This field is editable only if earlyOfferSupportForVoiceCall is set to true.
This field will be enabled only when SIP Normalization Script is present.
This field will be enabled only when SIP Normalization Script is present.
Equivalent field on the SIP Profile Configuration page in Cisco Unified CM Administration is renamed from Allow Passthrough of Configured Line Device Caller Information to Enable External Presentation Name and Number
SDP Transparency Profile for SIP Profile
Only if digestAuthentication is enabled this value can be changed.
TimePeriod cannot be published if it has a todOwnerId assigned to it. Only Administrative Time Period can be published.
TimeSchedule cannot be published if it has a todOwnerId assigned to it. Only Administrative Time Schedule can be published.
Read-Only. List of the remoteDestination entries associated with this TodAccess.
Name of the remoteDestination
In Update setting isDefault tag as false would not disable this VoiceMailPilot as Default. Instead, the corresponding tag of another VoiceMailPilot should be set to true.
The primary hostname of the process node.
The mac address of the host.
Read-only.
Only Applicable if TimeSchedule is selected. If OriginatingDevice is selected then this tag is not applicable.
Read-only.
Read-only.
This tag is mandatory if autoRegistrationEnabled is true
This tag is mandatory if autoRegistrationEnabled is true
UDP port for MGCP communication.
TCP port for backhaul for Q.931 messages.
Read only
Not valid for get and list
Read-only. AXL API automatically adds the required entries in the AARDialPrefixMatrix table.
This API should only be used by Hosted Collaboration Solution Shared Architecture deployments.
This API should only be used by Hosted Collaboration Solution Shared Architecture deployments. Read-only: Time customer was created
This API should only be used by Hosted Collaboration Solution Shared Architecture deployments. Read-only: Time last customer audit occurred
Read-only.
Not nullable.
Nullable. The value accepted and retrieved from the database for this field will be of type XCountry in AXLEnums.xsd
-1 means using system default
The calling search space used by Automated Alternate Routing. Nullable.
For IP Phones and Gateways. Nullable.
The calling search space used by Device Mobility. Nullable.
The value accepted and retrieved from the database for this field will be of type XRevertPriority in AXLEnums.xsd.
Read only
Read only
Should not be modified for Cisco Media Termination Point (WS-SVC-CMM).
This tag is used only by Cisco Media Termination Point (WS-SVC-CMM) and is a mandatory tag for Cisco Media Termination Point (WS-SVC-CMM) Transcoder. Valid values range from 1 to 4.
For devices with load information, if any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product.
This tag is used only by Cisco Media Termination Point (WS-SVC-CMM)
This tag is mandatory only for Cisco Media Termination Point (WS-SVC-CMM). Valid values for this tag are 32,64,96,128.
Nullable. The value accepted and retrieved from the database for this field will be of type XUserLocale in AXLEnums.xsd.
Nullable
Nullable
This setting only affect devices that support MLPP. Use -1 to set to null
This setting only affect devices that support MLPP
Default is not applicable for CommonDeviceConfig API
This setting only affect devices that support MLPP
Failed logon must be a number in the range 0 to 100. If 0 is entered, NoLimitForFailedLogon is true
Reset Failed logon attempts must be a number in the range 1 to 120. (minutes)
Lockout duration must be a number in the range 0 to 1440. (minutes), If 0 is entered then Administrator Must Unlock is true.
Credential change duration must be a number in the range 0 to 129600. (minutes)
Credential expires after must be a number in the range 0 to 365. (Days). If 0 is entered, then neverExpires is true
Minimum credential length must be a number in the range 0 to 64.
Stored number of previous credentials must be a number in the range 0 to 25.
Inactive days allowed must be a number in the range 0 to 5000.
Expiry warning days must be a number in the range 0 to 90.
Minimum Character Change difference between the old and new password.
From Device table.
From Device table.
From Device table.
From Device table.
From Device table.
Read only.
Read only.
Only use when setting TFTP Default to true. Setting to true will result in setting all other CallManager groups to false.
Actually called "tag" in database.
Read-only.
The valid values ranges from 0 to 1073741824.
The valid values ranges from 0 to 1073741824.
The valid values ranges from 0 to 1073741824.
The valid values ranges from 0 to 1073741824.
Value between 0 to 1073741824.
Value between 0 to 1073741824.
Value between 0 to 1073741824.
Value between 0 to 1073741824.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
The prefix used for park-code retrieval. User will dial prefix plus park code to retrieve a parked call.
The pattern used to revert the call when the parked call is not retrieved within retrieval timer.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
Nullable
Also known as controlled devices.
Name of device.
Only DNs associated with the associatedDevices of the User can be used as primary extension.
DN or Pattern
Route Partition to which the DN is associated.
Name of User Group
READ ONLY: Name of the User Role associated with the user group will be taken.
Maximum wait time for Desk Pickup must be a number in the range 0 to 30000.Not Nullable.
Remote Destination Limit must be a number in the range 1 to 10. Not Nullable.
Read-Only. These groups automatically get added once the user is associated with a Remote Destination Profile.
Name of the remoteDestinationProfile
Not Applicable for Add. Credential configuration for password.
The tag will be ignored in add, while update you can reset the hack count.
Not Applicable for add. These groups get automatically added once an user is added.
The tag will be ignored in add, while update you can reset the hack count.
Read-Only. List of the todAccess entries associated with this EndUser.
Name of the todAccess.
Read Only
Read Only. The Certification Authority Proxy Function Profiles to which the application user is associated with.
This Tag is valid only for GetUser
Applicable for Controlled Devices
This field also corresponds to the field 'Number Displayed in Directory' for the Quick User/phone Add page.
These tags are for Quick User/Phone Add page
These tags are for Quick User/Phone Add page
Value should be of of the format user@domain
Applicable for Controlled Devices so this tag is appropriate for Get/UpdateUser APIs only.
Applicable for Controlled Devices so this tag is appropriate for Get/UpdateUser APIs with ipccExtension tag only.
These tags are for Get/UpdateUser APIs only.
If zeroHop value is false pin will be synchronized with UCxN, if synchronization is enabled for Unity Connection server and if zeroHop is true pin will not be synchronized with UCxN. This tage is supported only for updateUser api
This tag should only be used by Hosted Collaboration Solution Shared Architecture deployments.
Contains headset that are associated to user.
Name of headset.
Valid range is 1-127 characters.
Not Applicable for Add. Credential configuration for password
Read Only
Read Only
The tag will be ignored in add, while update you can reset the hack count.
Valid range is 1-42 characters.
Also known as controlled devices.
Name of device.
Name of User Group
READ ONLY: Name of the User role associated with the user group will be taken
Read Only. The Certification Authority Proxy Function Profiles to which the application user is associated with.
Either ipAddress or ipv6Address need to be present and both cannot be blank.
Either ipAddress or ipv6Address need to be present and both cannot be blank.
It can be one among / (slash), . (dot), - (dash)
It can be one among D/M/Y,M/D/Y,Y/M/D
It can be one among 12-hour,24-hour
Read-Only
Applicable for Cisco Unity Voice Mail 4.x or later, Cisco Unity Connection and Cisco Web Dialer
Applicable for Cisco Unity Voice Mail 4.x or later, Cisco Unity Connection and Cisco Web Dialer
Applicable only for Presence Server, CUMA Provisioning Server
Applicable only for Presence Server, CUMA Provisioning Server, CER Location Management
Applicable Only for Cisco Web dialer
Applicable for Cisco Unity Voice Mail 4.x or later, Cisco Unity Connection and Cisco Web Dialer
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Read Only when certificateOperation is 'No Pending Operation'
Required format is YYYY:MM:DD:HH:SS. Read Only when certificateOperation is 'No Pending Operation'. Please provide the above format while adding a new device
Read-Only
Format is YYYY:MM:DD:HH
Read-Only
The process Node that this the service parameter belongs to. Not nullable.
Name of the service parameter. Not nullable.
The service that this service parameter belongs to.
In Update setting isDefault tag as false would not disable this VoiceMailProfile as Default. Instead, the corresponding tag of another VoiceMailProfile should be set to true.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This setting only affects devices that support MLPP.
From Device Table
From Device Table
Value should be numbers in range of 30 to 300
Value should be numbers in range of 30 to 600
The template's name
Read-only
The list of buttons on this model of Phone.The feature and label of first button cannot be modified.
This tag is valid only for RT Phones.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This tag is not valid for H323Phone,H323trunk and SIPTrunk
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
Always set as true
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
Value "-1" in the response means no value has been assigned and internally the CM will use default setting i.e., 1800s.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
dialPlan is mandatory for patterns with @ in it.
This tag is not valid for a translation pattern.
Read Only
Read Only
If not specified then a default value of '0' is set. This tag is not applicable to networkServiceProtocol PRI NI2.
It is a mandatory tag if anychild tag of isdnNSFInfoElement is specified.
If not specified then the first record based on the protocol in NSFProtocolServiceMap table will be set as the default value.
This parameter will take effect only if the selected network service has a valid parameterName in TypeNSFService.
This tag is only valid when value of enabledccenforcement is true
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for SIP phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Applicable only for sip phones
Plars details cannot be added for dial pattern of type 7905_7912
Applicable for Cisco Conference Bridge (WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS). Valid values range from 1 to 4.The value should be given as per the formula. Cisco Media Server : subunit = ((Extract two digits after 'A' from the name)-2)/3 + 1. Cisco Conference Bridge: subunit = ((Extract two digits after 'C' from the name)-1)/3 + 1
This tag is used only by Cisco Conference Bridge Hardware.For devices with load information, if any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product.
This tag is used only by Cisco Video Conference Bridge(IPVC-35xx),Cisco Conference Bridge (WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS).
This tag is mandatory for Cisco Conference Bridge(WS-SVC-CMM) and Cisco Media Server(WS-SVC-CMM-MS). Valid values for this tag are 32,64,96,128.
Valid only for Cisco IOS Enhanced Conference Bridge
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence MCU/Conductor/CMS
Adding parameters for normalization script Info
Valid for Cisco TelePresence MCU/Conductor/CMS and max length is 31
Valid for Cisco TelePresence MCU/Conductor/CMS and max length is 31
Valid for Cisco TelePresence MCU and Conductor
Valid for Cisco TelePresence MCU/Conductor/CMS
Valid only for Cisco TelePresence Conference bridges
Valid only for Cisco TelePresence Conference bridges
Valid only for Cisco TelePresence Conference bridges
This option is available for Conference types MCU,Conductor and CMS
Valid only for Cisco TelePresence Conference bridges
Valid only for Cisco TelePresence Conference bridges
The new prefixDigit value for this particular AARGroup relationship.
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
For an intercom line this tag should be treated as a mandatory tag and the valid values are Auto Answer with Headset and Auto Answer with Speakerphone.
A value of 0 means 'none selected'.
A value of 0 means 'none selected'.
This tag is applicable for only intercom lines and if not set, intercom lines will not be active.
While updating, send all the URIs
Applicable only for Update and Get Request
Applicable only for Update and Get Request
Read only
While UPDATE set it to false if you want to delete enterpriseAltNumber.Use only while update
While UPDATE set it to false if you want to delete e164AltNumber
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
Use -1 to set to null
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
Use -1 to set to null
Applicable only for H323Phones and H323Trunks.Not for Gateways.
Applicable only for H323Phones
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
Maximum Half Duplex Streams must be a number in the range 0 to 500.
Maximum Multicast Connections must be a number in the range 0 to 999999.
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. Multicast Base Port number must be an even number in the range 16384 to 32766.
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. Multicast Base Port number must be an even number in the range 16384 to 32766. baseMulticastIPAddress and baseMulticastPort must be a unique pair. All Multicast IP Addresses must be in the range 239.1.1.1 to 239.255.255.255
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. Multicast Base Port number must be an even number in the range 16384 to 32766
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty.
If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
This setting only affects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
Applicable only for H323Phones and H323Trunks.Not for Gateways.
If set to True,mediaResourceList must be mentioned and mtpRequired must be set to True.
enableOutboundFaststart must be set to true for it to be read.Not Nillable.
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
Applicable only for H323Gateways and trunks
Applicable only for H323Gateways and trunks
Applicable only for H323Gateways and trunks
Applicable only for H323Gateways and trunks
The value of significantDigits must either from 0 to 32 or 99,Here 99 means ALL.enable attribute is Read-Only.If significantDigits is 0-32 then enable is true,if significantDigits is 99 then enable is false.
Applicable only for Non-Gatekeeper controlled ICT trunk's.
Applicable only for Non-Gatekeeper controlled ICT trunk's. Should be set only when ictPassingPrecendenceLevelThroughUUIE is set to true.
If set to false its mandatory to specify a value for the tag server1(remoteServerInfo is its parent tag)
The calling search space used by Automated Alternate Routing. Nullable.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This tag is not valid for H323Phone,H323trunk and SIPTrunk
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
UUID changed each time device is updated
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
This Tag is valid only for SIP Phones and SIP Trunks
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier cannot be used with AddLines and RemoveLines.This tag is valid only for lines tag
Additional modules attached to the Phone.There can be 0,1, 2 or 3.
Read-only for IP Phones.
The name of the default profile for this device.Not Nullable.
Read-only
Read-only
This tag is valid only for a get phone response.It contains Extension Mobility related parameters for a device when a user is logged in using a user defined device profile.If no user is logged in,the original device information for these parameters is returned.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
Read-only for IP Phones.
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
Support for this tag has been removed for IMS phones from 9.0
Applicable only for H323Phones and H323Trunks.Not for Gateways.
authenticationMode can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
keySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
keyOrder can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
ecKeySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
authenticationString can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
Specifies if the phone is configured for device mobility or not.
Read-only.Specifies the device pool being used if the device is roaming and the deviceMobility feature is enabled for it.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag determines if the newly added phone is active to determine consumption of license.If set to false the license units will not be consumed.
Read-only tag.
The userid of the mobility user for this phone.Nullable.
If a blank tag is passed ,the value of the default is inserted into the database.
This tag is valid only for devices that support Secure Tone.
This field is applicable only to SIP phones.
This field is applicable only to SIP phones.
This tag is applicable only to thosedevices that support ssh feature.
This tag is applicable only to thosedevices that support ssh feature.
This field is applicable only to SIP phones.
This tag is valid only for devices that Automatic Outbound Callrollover
This tag is applicable for PLAR-supporting SIP/SCCP phones only
This tag is valid only for RT Phones.
This tag is valid only for TIP endpoints
This field is applicable only for Third-party AS-SIP Endpoint.
This tag is only valid when value of blockIncomingCallsWhenRoaming is true
This field is applicable only for Third-party AS-SIP Endpoint.
This field is applicable only for Third-party AS-SIP Endpoint.
Mobile Subscriber ISDN
The new enableCallRoutingToRdWhenNoneIsActive flag for Remote Destination Call Forwarding feature is required for CTI Remote Device. Not Nullable.
This boolean setting, when set to true, indicates that the phone should use activation code based registration
This read only string returns any relevant device onboarding status errors or messages
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
This setting only affects devices that support MLPP. Use -1 to set to null
When this flag is checked, IPSec needs to be configured in the network to provide end to end security. Failure to do so will expose keys and other information
If set to True,mediaResourceList must be mentioned and mtpRequired must be set to True.
enableOutboundFaststart must be set to true for it to be read.Not Nillable.
The value of significantDigits must either from 0 to 32 or 99,Here 99 means ALL.enable attribute is Read-Only.If significantDigits is 0-32 then enable is true,if significantDigits is 99 then enable is false.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
Device profile Type string. Read Only
This tag is not valid for H323Phone,H323trunk and SIPTrunk
UUID changed each time device is updated
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
Additional modules attached to the Phone.There can be 0,1 or 2.
The name of the default profile for this device.Not Nullable.
Read-only
Read-only
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag is valid only for a get deviceprofile response.It contains Extension Mobility related parameters for a device when a user is logged in using a user defined device profile.If no user is logged in,the original device information for these parameters is returned.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
The new Ignore Presentation Indicators flag for Hospitality feature is required for most phones andand device profiles. Not Nullable.
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
This tag is valid only for RT Phones.
From 10.5, to get proper value of this tag in get handler's response it is required to have value of todaccess, in case if user does not give any value in todaccesss tag, axl will insert a random row so that get handler response can return proper value of Owner User id
If you are giving value to dualModeDeviceName then you can't give value to remoteDestinationProfileName,viceversa
ctiRemoteDeviceName tag will be used to associate either CTI Remote Device or a Cisco Spark Remote Device with a Remote Destination
The line association for this remote destination. The line to be associated must already be added to the remote destination profile. All directory numbers specified must already exist in the database.
The line association for this remote destination. The line to be associated must already be added to the remote destination profile. All directory numbers specified must already exist in the database.This is read only tag
From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag
This tag is not applicable for dualmode phones
This tag is applicable only to CUMC devices.
This tag is for Mobility Identity
This tag must be used for configuring RingSchedule of RD, this tag will get precendence over todaccess and accesslist tag
From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag
The units element is optional when a newVG224 is being added and can be added using updateVG224Gateway.
In the IOS model unit corresponds to a SLOT(Slot Module)
It contains Product Specific Configuration Information like Fax mode, Modem Passthorugh, etc.
Read only. UUID that is changed each time the VG224 is updated.
For SCCP mention MAC Address
pkid of the Gateway whose endpoint is to be added
pkid of the Gateway whose endpoint is to be added
pkid of the Gateway whose endpoint is to be added
pkid of the Gateway whose endpoint is to be added
The device name,using only URL-friendly characters
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
UUID changed each time device is updated
Not valid for CTI route points and VoiceMail ports
This setting only effects devices that support MLPP. Use -1 to set to null
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
The value for sigDigits must be between 0 to 32. enable attribute is read only
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
The value for sigDigits must be between 0 to 32. enable attribute is read only
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
On Addition always the first member added is itself. Do not specify the first member as itself in an Add request . Also make sure that the priority always starts with 1. It will internally be taken care of during Addition and Updation.
This tag is applicable when Pickup Notification Policy is "Visual Alert" or "Visual or Audio Alert".
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This tag is not valid for H323Phone,H323trunk and SIPTrunk
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
UUID changed each time device is updated
Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
Applicable only for H323Phones and H323Trunks.Not for Gateways.
This tag is ignored and destAddrIsSRV is set to false if destinationaddress is an IP address and destinationport is mentioned correctly.This tag will not be returned by list.
The value of sigDigits must be either from 0 to 32 or 99. Here 99 means All. enable attribute is Read-Only. If sigDigits is 0-32 then enable is true, if sigDigits is 99 then enable is false.
This tag is valid only if srtpAllowed is set to false.
This tag is not supported in the Update method.
This tag when enabled will prevent external presentation name and external presentation number to be populated in SIP headers like P-Asserted ID and RPID.
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
Valid only for IP Multimedia Subsystem Service Control (ISC) Sip trunk
This field can have values 0,1 or 2
The new bandwidth value for this particular region relationship.
Always set as true
Applicable only for PSTN Access and RSVP Agent
Either safSipTrunk, safH323Trunk or both should be configured while adding
For SCCP mention MAC Address
pkid of the Gateway
For SCCP mention MAC Address
pkid of the Gateway
valid only for Active Directory
valid only for Active Directory
valid only for Active Directory
valid only for Active Directory
Name of the Emcc Parameter
Either learnedPattern or learnedPatternPrefix has to be set
Value shpuld be between 1024 and 65535
Value should be between 60 and 600
The Fallback QOS Sensitivity should be in range 0 to 5
The Fallback Call Answer Timer should be in range 1 to 10
The number of digits for Caller ID partial match should be in range 4 to 15
If the value of isStandard is t (true), the fields are not editable.
pkid of the Gateway whose endpoint is to be added
Not applicable for Unified CM (IM and Presence) and AppStore ProductType
Not applicable for Unified CM (IM and Presence),CTI and AppStore ProductType
SIP Trunk for Video On Hold Server
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
This tag corresponds to Proxy Auto-Config (PAC) Location when proxy setting is set to Auto
This tag is used for validation and does not correspond to any field in database.
Not nullable.
if version is 3 then it will be snmpUserId and if version is 2 then it will be treated as snmpCommuintyString
Activation code for a valid phone that supports Secure Self Onboarding
Desired expiry time (in seconds) of activation code. Able to specify on AddPhoneActivationCode request. read-only
Device name of self onboardable phone, doesn't have to be a valid MAC. read-only
User associated (if applicable) to onboardable phone
String indicating the Device / Phone Model to which these default settings apply. Read Only.
String indicating the Device / Phone Protocol for which these default settings for this Model apply. Read Only.
The filename of the firmware load that is used with a particular type of hardware device model. The file is fed to the phones via TFTP. This can be overridden at the device level. If not overridden, then all devices of this model will use this firmware load file.
The filename of the inactive firmware load that is used with phone models that support dual-bank firmware (background download). The file is fed to the phones via TFTP but is not active. This can be overridden at the device level. If not overridden, then all devices of this model will download this firmware load file as the inactive load.
The name of the Device Pool, (which defines common Device / Phone characteristics), to be assigned, by default, to Devices / Phones with this Model and Protocol. This can, of course, be overridden at the device level. If not overridden, then all devices of this model and protocol will be assigned to this same Device Pool.
The name of the Phone Button Template, (which defines the line and feature button related characteristics of a Device or Phone ), which may be shared by multiple phones and which will be assigned, by default, to Devices / Phones with this Model and Protocol. This can, of course, be overridden at the device level. If not overridden, then all devices of this model and protocol will be associated with this same Phone Button Template.
UUID changed each time device is updated
This boolean setting, when TRUE and unless overridden for specific Phones / Devices of this Model and Protocol, indicates a preferred use of activation code based registrations rather than basic auto-registration. This can, of course, be overridden at the device level. If not overridden, then all devices of this model and protocol will, when created be initially marked to use this registratin mode.
In Update setting isDefault tag as false would not disable this MraServiceDomain as Default. Instead, the corresponding tag of another MraServiceDomain should be set to true.
This value does not exist in the database. This field is used to generate / remove. During update, if the value in the database goes from false to true, then voucher is generated. Conversely, if value goes from true to false, the voucher is removed. During generation of voucher, the population of other fields happens after the voucher creation. Note that this simulates clicking the Create Voucher button. During removal of voucher, the fields will be populated then the voucher will be removed. Voucher removal will only happen in the Cisco Cloud un-boarded state.
Successfully setting the values of one or both of enableGdsCommunication and enablePushNotifications to true finishes the Cisco Cloud Onboarding process. Setting them both to false moves Cisco Cloud Onboarding to un-boarded state.
During updates, the value of this field is ignored and the value of enableTroubleShooting is used instead, if any.
Currently read-only. For possible future use.
This is a readonly field. During update, the value of this field is internally generated when the value of alarmSendEncryptedData in database changes from false to true ; or deleted when the value changes from true to false.
This is a readonly field. It is set during update automatically to the correct value that reflects the status of the system.
Currently read-only. For possible future use.
Currently read-only. For possible future use.
Currently read-only. For possible future use.
Currently read-only. For possible future use.
Currently read-only. For possible future use.
Successfully setting the values of one or both of enableGdsCommunication and enablePushNotifications to true finishes the Cisco Cloud Onboarding process. Setting them both to false moves Cisco Cloud Onboarding to un-boarded state.
Read-only listing of any statuses that may affect onboarding configuration. Some of these statuses are common with GUI screens.
SDP Transparency Profile for SIP Profile
SDP Transparency Profile for SIP Profile
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
For an intercom line this tag should be treated as a mandatory tag and the valid values are Auto Answer with Headset and Auto Answer with Speakerphone.
A value of 0 means 'none selected'.
A value of 0 means 'none selected'.
This tag is applicable for only intercom lines and if not set, intercom lines will not be active.
While updating, send all the URIs
Applicable only for Update and Get Request
Applicable only for Update and Get Request
For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.
For an intercom line this tag should be treated as a mandatory tag and the valid values are Auto Answer with Headset and Auto Answer with Speakerphone.
A value of 0 means 'none selected'.
A value of 0 means 'none selected'.
This tag is applicable for only intercom lines and if not set, intercom lines will not be active.
While updating, send all the URIs
Applicable only for Update and Get Request
Applicable only for Update and Get Request
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
This Tag is valid only for SIP Phones and SIP Trunks
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier cannot be used with AddLines and RemoveLines.This tag is valid only for lines tag
Additional modules attached to the Phone.There can be 0,1, 2 or 3.
The name of the default profile for this device.Not Nullable.
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
Read-only for IP Phones.
Support for this tag has been removed for IMS phones from 9.0
authenticationMode can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
keySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
keyOrder can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
ecKeySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
Specifies if the phone is configured for device mobility or not.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
The userid of the mobility user for this phone.Nullable.
If a blank tag is passed ,the value of the default is inserted into the database.
This field is applicable only to SIP phones.
This tag is valid only for devices that Automatic Outbound Callrollover
This tag is valid only for RT Phones.
This tag is valid only for TIP endpoints
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
This Tag is valid only for SIP Phones and SIP Trunks
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier cannot be used with AddLines and RemoveLines.This tag is valid only for lines tag
Additional modules attached to the Phone.There can be 0,1, 2 or 3.
The name of the default profile for this device.Not Nullable.
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
Read-only for IP Phones.
Support for this tag has been removed for IMS phones from 9.0
authenticationMode can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
keySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
keyOrder can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
ecKeySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.
Specifies if the phone is configured for device mobility or not.
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
The userid of the mobility user for this phone.Nullable.
If a blank tag is passed ,the value of the default is inserted into the database.
This field is applicable only to SIP phones.
This tag is valid only for devices that Automatic Outbound Callrollover
This tag is valid only for RT Phones.
This tag is valid only for TIP endpoints
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
Additional modules attached to the Phone.There can be 0,1 or 2.
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag is valid only for RT Phones.
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This tag is not valid for H323Phone,H323trunk and SIPTrunk
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
The lineIdentifier is a shorthand method that refers to a particular directory number.
Additional modules attached to the Phone.There can be 0,1 or 2.
This tag is valid only for devices that support SBB.
This tag is valid only for devices that support JAL..
This tag is valid only for devices that support DND.
This tag is valid only for devices that support DND.
This tag is valid only for RT Phones.
Only uuid attribute is returned in response
Consecutive Rings Setting. Replaces the consective ring setting on IPPhone.
Applicable only for IP Phones
Applicable only for IP Phones
Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway
This tag cannot be modified. It can only be specified in the add request.
Only uuid attribute is returned in response
Consecutive Rings Setting. Replaces the consective ring setting on IPPhone.
Applicable only for IP Phones
Applicable only for IP Phones
Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway
This tag cannot be modified. It can only be specified in the add request.
Only the uuid attribute is read
Only the uuid attribute is read
Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
Model ID string.
Model ID string.
Mandatory when "callerFilterMask" has value as Directory Number
Mandatory when value is a directory number
The feature invoked by this button.
The label invoked by this button.
Use original Called DN forward no-coverage settings
Value "-1" in the response means no value has been assigned and internally the CM will use default setting i.e., 1800s.
Use original Called DN forward no-coverage settings
Value "-1" in the response means no value has been assigned and internally the CM will use default setting i.e., 1800s.
The uuid attribute is read here
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
Applicable only for callForwardNoAnswer and callForwardAlternateParty,Value "-1" in the response indicates that the CM will use the default setting
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
Applicable only for callForwardNoAnswer and callForwardAlternateParty,Value "-1" in the response indicates that the CM will use the default setting
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
Applicable only for callForwardNoAnswer and callForwardAlternateParty,Value "-1" in the response indicates that the CM will use the default setting
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
Only uuid attribute is returned in response
Consecutive Rings Setting. Replaces the consective ring setting on IPPhone.
Applicable only for IP Phones
Applicable only for IP Phones
Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway
This tag cannot be modified. It can only be specified in the add request.
Only uuid attribute is returned in response
Consecutive Rings Setting. Replaces the consective ring setting on IPPhone.
Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway
Applicable only for IP Phones
Applicable only for IP Phones
Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
Load Information is either the module's specific load information or the default load information.If any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product.
Model ID string.
Read-only.
Read-only.
Read-only.
Read-only.
Read Only. Value should be between 1 and 100
Only the uuid attribute is read
The directory number to be associated. This directory number must be already associated to remote destination profile.
The directory number to be associated. This directory number must be already associated to cti remote device.
Mandatory for ground start and loop start
The value for sigDigits must be between 0 to 32. enable attribute is read only.
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element. Not applicable to FXO ports
The lineIdentifier is a shorthand method that refers to a particular directory number.
Not used by T1 Ports
Arbitrary XML defined by 3rd party vendors.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This setting only effects devices that support MLPP. Use -1 to set to null
This tag is applicable for MGCP FXS ports,which supports PLAR.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
The value for sigDigits must be between 0 to 32. enable attribute is read only
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
This tag is applicable for the following PRI protocols : : PRI NI2, PRI DMS-250, PRI DMS-100, PRI 4ESS, PRI 5E8, PRI 5E8 TELEOS, PRI 5E8 INTECOME, PRI 5E8 CUSTOM, PRI 5E9.
This tag is applicable for the following PRI protocols : PRI DMS-100, PRI DMS-250, PRI ISO QSIG T1, PRI ISO QSIG E1.
This tag is applicable for the following PRI protocols : PRI DMS-100, PRI DMS-250, PRI ISO QSIG T1, PRI ISO QSIG E1.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
The value for sigDigits must be between 0 to 32. enable attribute is read only
The value for sigDigits must be between 0 to 32. enable attribute is read only
Arbitrary XML defined by 3rd party vendors.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
This is a read only tag. The value will be the currently added GeoLocationPolicy pkid.
Only uuid attribute is returned in response
Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway
This tag cannot be modified. It can only be specified in the add request.
This tag will be taken to consideration only when 'overrideDefault' tag is set to True.This will be handled in the code.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This setting only effects devices that support MLPP. Use -1 to set to null
This tag is applicable for MGCP FXS ports,which supports PLAR.
Applicable only for SCCP
Applicable only for SCCP
Applicable only for SCCP
Applicable only for SCCP
Applicable only for SCCP
Applicable only for SCCP
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Applicable only for SCCP
Applicable only for SCCP
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element. Not applicable to FXO ports
The lineIdentifier is a shorthand method that refers to a particular directory number.
Applicable only for Conferencing Profile
StartDay and EndDay value should be same
The value for sigDigits must be between 0 to 32. enable attribute is read only
Arbitrary XML defined by 3rd party vendors.
Optional description of the device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
Mandatory when "callerFilterMask" has value as Directory Number
Mandatory when value is a directory number
The feature invoked by this button.
The label invoked by this button.
Use original Called DN forward no-coverage settings
Value "-1" in the response means no value has been assigned and internally the CM will use default setting i.e., 1800s.
Use original Called DN forward no-coverage settings
Value "-1" in the response means no value has been assigned and internally the CM will use default setting i.e., 1800s.
The uuid attribute is read here
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
Applicable only for callForwardNoAnswer and callForwardAlternateParty,Value "-1" in the response indicates that the CM will use the default setting
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
Applicable only for callForwardNoAnswer and callForwardAlternateParty,Value "-1" in the response indicates that the CM will use the default setting
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
Applicable only for callForwardNoAnswer and callForwardAlternateParty,Value "-1" in the response indicates that the CM will use the default setting
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
DB: Derived from CF*VoiceMailEnabled fields. This tag has been marked as ReadOnly for callForwardAlternateParty as it is not applicable for callForwardAlternateParty setting.
Only uuid attribute is returned in response
Consecutive Rings Setting. Replaces the consective ring setting on IPPhone.
Applicable only for IP Phones
Applicable only for IP Phones
Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway
This tag cannot be modified. It can only be specified in the add request.
Only uuid attribute is returned in response
Consecutive Rings Setting. Replaces the consective ring setting on IPPhone.
Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway
Applicable only for IP Phones
Applicable only for IP Phones
Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.
Load Information is either the module's specific load information or the default load information.If any special load information is specified, the special attribute is set to TRUE. Otherwise, the load information is the default for the product.
Model ID string.
Only the uuid attribute is read
The directory number to be associated. This directory number must be already associated to remote destination profile.
The directory number to be associated. This directory number must be already associated to cti remote device.
Mandatory for ground start and loop start
The value for sigDigits must be between 0 to 32. enable attribute is read only.
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element. Not applicable to FXO ports
The lineIdentifier is a shorthand method that refers to a particular directory number.
Not used by T1 Ports
Arbitrary XML defined by 3rd party vendors.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This setting only effects devices that support MLPP. Use -1 to set to null
This tag is applicable for MGCP FXS ports,which supports PLAR.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
The value for sigDigits must be between 0 to 32. enable attribute is read only
Applicable for only if PRI variant is QSIG
Applicable for only PRI variant is QSIG
This tag is applicable for the following PRI protocols : : PRI NI2, PRI DMS-250, PRI DMS-100, PRI 4ESS, PRI 5E8, PRI 5E8 TELEOS, PRI 5E8 INTECOME, PRI 5E8 CUSTOM, PRI 5E9.
This tag is applicable for the following PRI protocols : PRI DMS-100, PRI DMS-250, PRI ISO QSIG T1, PRI ISO QSIG E1.
This tag is applicable for the following PRI protocols : PRI DMS-100, PRI DMS-250, PRI ISO QSIG T1, PRI ISO QSIG E1.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
The value for sigDigits must be between 0 to 32. enable attribute is read only
The value for sigDigits must be between 0 to 32. enable attribute is read only
Arbitrary XML defined by 3rd party vendors.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.
For devices with load information, if any special load information is specified the special attribute is set to TRUE.Otherwise,the load information is default for the product.
This setting only effects devices that support MLPP. Use -1 to set to null
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Not valid for CTI route points and VoiceMail ports
This is a read only tag. The value will be the currently added GeoLocationPolicy pkid.
Only uuid attribute is returned in response
Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway
This tag cannot be modified. It can only be specified in the add request.
This tag will be taken to consideration only when 'overrideDefault' tag is set to True.This will be handled in the code.
The device name,using only URL-friendly characters
Optional description of the device
Product ID string. read-only except when creating a device.
Model ID string. Read Only
Class ID string. Class information is read-only except when creating a device.
Protocol option is read-only,except when creating a device.
Side information is read-only except when creating a device
This setting only effects devices that support MLPP. Use -1 to set to null
This tag is applicable for MGCP FXS ports,which supports PLAR.
Applicable only for SCCP
Applicable only for SCCP
Applicable only for SCCP
Applicable only for SCCP
Applicable only for SCCP
Applicable only for SCCP
This setting only affects devices that support MLPP.
This setting only affects devices that support MLPP.
Applicable only for SCCP
Applicable only for SCCP
An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element. Not applicable to FXO ports
The lineIdentifier is a shorthand method that refers to a particular directory number.
Applicable only for Conferencing Profile
StartDay and EndDay value should be same
Returns either the GUID of the object that was altered, or returns true if the operation was successful. Whichever is appropriate for the corresponding request.
This is a utility object that created because many of the Get, Remove, and Update methods allow the user to specify either the name or the uuid.
Not nullable.
Not nullable.
All requests must extend abstractRequest.
All responses must extend abstractResponse.
The UNIQUE restrictions are simply flags to the user that in the database this value is unique.
This API call is used to execute a Structured Query Language query against the database. The sql element would contain the SQL statement. If special characters are required, wrap the SQL command inside a CDATA element.
The response message to executeSQLQuery. The return element represents the result set, which can contain 0 or more rows of data. Each row can have any number of elements as defined by columns specified in the SQL Query. The name of each sub-element of the row element represents the column name, the value of each sub-element of the row element is the corresponding value of that column in the database.
WARNING: SQL Large Text and BLOB columns cannot be fetched along with other columns. A Large Text or BLOB column must be selected in its own SQL query.
Each row element can contain any number of sub-elements, each sub-element is a column from that row in the result set.
This API call is used to execute a Structured Query Language query against the partB database. The sql element would contain the SQL statement. If special characters are required, wrap the SQL command inside a CDATA element. This API is for internal use only and not meant for use by Customers.
The response message to executeSQLQueryInactive. The return element represents the result set, which can contain 0 or more rows of data. Each row can have any number of elements as defined by columns specified in the SQL Query. The name of each sub-element of the row element represents the column name, the value of each sub-element of the row element is the corresponding value of that column in the database.
WARNING: SQL Large Text and BLOB columns cannot be fetched along with other columns. A Large Text or BLOB column must be selected in its own SQL query.
Each row element can contain any number of sub-elements, each sub-element is a column from that row in the result set.
Request to execute an SQL update.
This API call is used to execute a Structured Query Language Update against the database. The sql element would contain the SQL statement
Rows updated indicates the number of rows updated by the SQL update.
The response message to executeSQLUpdate.
Authenticates the user on the basis of pin or password.
Applicable for end users only.
true indicates that user was authenticated and false indicates that user was not authenticated.
This is the IMS result code that will be returned.
This is the number of days remaining for the credential to expire
This gives warning about change of credentials before expiry date
Logs-in the specified user to the specified phone.
The name or uuid of the phone that is being logged-into. Not nullable.
The duration of the login. Not nullable.
The name or uuid of the Device Profile to be used. Not nullable.
The LDAP RN of the user that is to be logged-into the phone. Not nullable.
Returns "true" if the login was performed successfully.
This method logs-out whichever user is logged-into the device.
The name or uuid of the device to perform the log-out on.
Returns "true" if the log-out was performed successfully.
Performs either a hard or soft reset on the specified device. If resetting an MGCP box, then set isMGCP attribute to true.
The name or UUID of the device to performs a reset on. Not nullable.
True performs a hard reset. False performs a soft reset. Not nullable.
Not nullable
Performs either a hard or soft reset on the specified device. If resetting an MGCP box, then set isMGCP attribute to true.
Returns "true" if the reset was performed successfully.
This method returns the number of devices found. The caller specifies what class of device they want counted.
The class of device that is to be counted. Cannot be null.
Response to GetNumDevices. Returns an integer value which is the number of devices found. The class of device counted is represented by the "class" attribute.
It is mandatory to give either handoffNumber or DTMFNumber tag in the request. Both can't be null.
Retrieves mobility configuration information.
It is mandatory to give either handoffNumber or DTMFNumber tag in the request. Both can't be null.
Default Partition would be Null in case not specified.
Default Partition would be Null in case not specified.
This template should not be a standard template
This template should not be a standard template
This application should not be Cisco CallManager.
For SCCP mention MAC Address
For SCCP mention MAC Address
Valid Values are from 0 to 5
Valid Values are 0 and 1
Initiates the sync
The Config Name of the Ldap Directory.
True means start sync, false means cancel the sync which is currently under process
Returns "true" in case of success.
Cancels the sync which is currently under process.
The config name of the Ldap Directory.
Returns "true" if the sync is currently under process.
List of mandatory keys for each callstate ::
On Hook - NewCall
Connected - End Call
On Hold - Resume
Off Hook - End Call
Connected Transfer - Transfer
Digits After First - Backward
Connected Conference - Conference
Ring Out - End Call
Off Hook With Feature - End Call
List of mandatory keys for each callstate ::
On Hook - NewCall
Connected - End Call
On Hold - Resume
Off Hook - End Call
Connected Transfer - Transfer
Digits After First - Backward
Connected Conference - Conference
Ring Out - End Call
Off Hook With Feature - End Call
Read-Only.The positionId has values starting with 0 and get incremented by 1 for each call state.
Read-Only.The positionId has values starting with 0 and get incremented by 1 for each call state.
Specify Search Criterion
This tag should be passed for some gateway endpoint/port.Eg Ground Start for Analog Access in Cisco 3745
The tag is still not supported from AXL side.It is just a dummy tag.
The tag is still not supported from AXL side.It is just a dummy tag.
The tag is still not supported from AXL side.It is just a dummy tag.
gets change notifications
For the first request to this API exclude this element. For each subsequent request send the nextStartChangeId and the queueId returned in the prior response.
The response message to listChange.
True means set dndStatus for device as true, false means set dndStatus for device as false
Returns "true" if the update was performed successfully.
This will set Service Parameters to default value.
The process Node that this the service parameter belongs to.Not nullable.
The service that this service parameter belongs to.
This will set Service Parameters to default value.
This will set Service Parameters to default value.
This will set Enterprise Parameters to default value.
This will apply configuration to the Enterprise Parameters.
This will reset the value of Enterprise Parameters.
This will restart the Enterprise Parameters.
This allows to register the system with Cisco Smart Software Manager or satellite
Returns Success or Failure message that indicates status of the operation
This allows to force register the system with Cisco Smart Software Manager or satellite if already registered
Returns Success or Failure message that indicates status of the operation
This allows to de-register the system with Cisco Smart Software Manager or satellite
Returns Success or Failure message that indicates status of the operation
This allows to renew license authorization
Returns Success or Failure message that indicates status of the operation
This allows to renew license registration
Returns Success or Failure message that indicates status of the operation
Allows to get the licensing status
Returns overall licensing status
This allows to send an entitlement request to CSSM or Satellite
Returns Success or Failure message that indicates status of the operation
This allows to change or modify the transport settings
This tag is required to be set to true for authentication based proxy server configuration
This tag is required to be set when enableProxyAuthentication tag is true
This tag is required to be set when enableProxyAuthentication tag is true
Returns Success or Failure message that indicates status of the operation
Allows to get the transport settings details
Returns overall transport settings details