[Index]

Model: relation/HcsLocalRouteGroupREL

CUCM DevicePool

How to Configure Device Pools

Introduction

Device pools define sets of common characteristics for devices. The device pool structure supports the separation of user and location information. The device pool contains system, device, and location-related information.

After adding a new device pool, you can use it to configure devices such as Cisco Unified IP Phones, gateways, conference bridges, transcoders, media termination points, voice-mail ports, CTI route points, and so on.

Procedure

  1. Log in as provider, reseller, or customer administrator.

  2. Perform one of these options:

    • If you logged in as provider or reseller administrator, choose Device Management > CUCM > Device Pools.
    • If you logged in as customer administrator, choose Device Management > Advanced > CUCM > Device Pools.
  3. Perform one of these options:

    • To add a new device pool, click Add, then go to step 5.
    • To edit an existing device pool, click the line item in the table. Go to step 5.
  4. In the popup, choose from the drop-down the network device list (NDL) to which you are adding the device pool, and click OK.

    Note:

    The NDL popup only appears when you add a new device pool instance. If you are updating an existing instance, go to Step 5.

    If you are adding the instance to a Site hierarchy node, the NDL popup does not appear. You go right to the Add Device Pool form using the NDL associated to the site.

  5. From the Device Pool Settings tab, complete at minimum, the mandatory Device Pool Settings Fields.

  6. From the Local Route Group Settings tab, complete at minimum, the mandatory Local Route Group Settings Fields.

  7. From the Roaming Sensitive Settings tab, complete at minimum, the mandatory Roaming Sensitive Settings Fields.

  8. From the Device Mobility Related Information tab, complete the required Device Mobility Related Information Fields.

  9. From the Geolocation Configuration tab, complete the required Geolocation Configuration Fields.

  10. From the Incoming Calling Party Settings tab, complete the required Incoming Calling Party Settings Fields.

  11. From the Incoming Called Party Settings tab, complete the required Incoming Called Party Settings Fields.

  12. From the Caller ID for Calls from This Phone tab, complete the required Caller ID For Calls From This Phone Fields.

  13. From the Connected Party Settings tab, complete the required Connected Party Settings Fields.

  14. From the Redirecting Party Settings tab, complete the required Redirecting Party Settings Fields.

  15. Click Save.

    The route partition appears in the device pool list.

    To modify any of these characteristics, make your changes and click Save.

    To delete a device pool, select the check box to the left of the Name column in the group list, and click Delete.

Device Pool Settings Fields

Option Description
Device Pool Name *

Enter the name of the new device pool that you are creating. You can enter up to 50 characters, which include alphanumeric characters, periods (.), hyphens (-), underscores (_), and blank spaces.

Default value: None

Cisco Unified CM Group * Choose the Cisco Unified Communications Manager group to assign to devices in this device pool. A Unified CM group specifies a prioritized list of up to three Unified CMs. The first Unified CM in the list serves as the primary one for that group. The other members of the group serve as backup Unified CMs for redundancy.
Calling Search Space for Auto-registration Choose the calling search space to assign to devices in this device pool that auto-register with Unified CM. The calling search space specifies partitions that devices can search when attempting to complete a call.
Adjunct CSS

From the drop-down list, choose an existing Calling Search Space (CSS) to use for the devices in this device profile as an adjunct CSS for the Extension Mobility Cross Cluster (EMCC) feature. To configure a new CSS or modify an existing CSS, choose Call Routing > Class of Control > Calling Search Space in Unified CM Administration.

When configuring the EMCC feature, the administrator must configure a device pool for each remote cluster. If the remote cluster is located in a different country, the adjunct CSS must embrace the partition with which the emergency patterns of that country associate. This configuration facilitates country-specific emergency call routing.

Default value: None

Reverted Call Focus Priority

Choose a clusterwide priority setting for reverted calls that the hold reversion feature invokes. This setting specifies which call type, incoming calls or reverted calls, have priority for user actions, such as going off hook.

  • Default-If you choose this option, incoming calls have priority.
  • Highest-If you choose this option, reverted calls have priority.

The Not Selected setting specifies the reverted call focus priority setting for the default device pool at installation. At installation, incoming calls have priority. You cannot choose this setting in Unified CM.

Note: This setting applies specifically to hold reverted calls; it does not apply to parked reverted calls.

Intercompany Media Services Enrolled Group Choose an Intercompany Media Services Enrolled Group from the drop-down list.

Local Route Group Settings Fields

Option Description
Local Route Group From the drop-down, choose the name of the local route group to associate with this device pool.
Route Group From the drop-down, choose the value for the local route group to associate with this device pool.

Roaming Sensitive Settings Fields

Option Description
Date/Time Group *

Choose the date/time group to assign to devices in this device pool. The date/time group specifies the time zone and the display formats for date and time.

Default value: None

Region *

Choose the Unified CM region to assign to devices in this device pool. The Unified CM region settings specify voice codec that can be used for calls within a region and between other regions.

Default value: None

Media Resource Group List

From the drop-down list, choose a media resource group list. A media resource group list specifies a prioritized list of media resource groups. An application selects the required media resource (for example, a music on hold server, transcoder, or conference bridge) from the available media resource groups according to the priority order defined in a media resource group list.

Default value: None

Location

Use locations to implement call admission control (CAC) in a centralized call-processing system. CAC enables you to regulate audio quality and video availability. It works by limiting the amount of bandwidth that is available for audio and video calls over links between locations. The location specifies the total bandwidth that is available for calls to and from this location.

From the drop-down list, choose the appropriate location for this device pool.

A location setting of None or Hub_None means that the locations feature does not track the bandwidth that the devices in this pool consume. A location setting of Phantom specifies a location that enables successful CAC across intercluster trunks that use H.323 protocol or SIP.

Default value: None

Network Locale

From the drop-down list, choose the locale that is associated with phones and gateways. The network locale contains a definition of the tones and cadences that the phones and gateways in the device pool in a specific geographic area use. Make sure that you select a network locale that all of the phones and gateways that use this device pool can support.

Note:

If the user does not choose a network locale, the locale that is specified in the Unified CM clusterwide parameters as Default Network Locale applies.

Note:

Choose only a network locale that is already installed and supported by the associated devices. The list contains all available network locales for this setting, but not all are necessarily installed. When a device is associated with a network locale that it does not support in the firmware, the device fails to come up.

Default value: None

Option Description
SRST Reference *

From the drop-down list, choose a survivable remote site telephony (SRST) reference to assign to devices in this device pool. Choose from these options:

  • Disable - When you choose this option, devices in this device pool do not have SRST reference gateways that are available to them.
  • Use Default Gateway - When you choose this option, devices in this device pool use the default gateway for SRST.
  • Existing SRST references - When you choose an SRST reference from the drop-down list, devices in this device pool use this SRST reference gateway.

Default value: None

Connection Monitor Duration

This setting defines the time that the Cisco Unified IP Phone monitors its connection to Unified CM before it unregisters from SRST and reregisters to Unified CM.

To use the configuration for the enterprise parameter, you can enter "1" or leave the field blank. The default value for the enterprise parameter equals 120 seconds.

Tip:

When you change the value of the connection monitor duration, it applies only to the device pool that is being updated. All other device pools use the value in their own connection monitor duration fields or use the value that is configured in the enterprise parameter.

Single Button Barge

This setting determines whether the devices or phone users in this device pool have single-button access for barge and cBarge. From the drop-down list, choose from these options:

  • Off - When you choose this option, the devices in this device pool have the Single Button Barge/cBarge feature disabled.
  • Barge - When you choose this option, the devices in this device pool have the Single Button Barge feature enabled.
  • CBarge - When you choose this option, the devices in this device pool have the Single Button cBarge feature enabled.
  • Default - When you choose this option, the devices in this device pool use the service parameter setting for the Single Button Barge/cBarge feature.

Default value: Default

Join Access Lines

This setting determines whether the Join Access Lines feature is enabled for the devices or phone users in this device pool. From the drop-down list, choose from these options:

  • Off - When you choose this option, the devices in this device pool have the Join Access Lines feature disabled.
  • On - When you choose this option, the devices in this device pool have the Join Access Lines feature enabled.
  • Default - When you choose this option, the devices in this device pool use the service parameter setting for the Join Access Lines feature.

Default value: Default

Physical Location

Select the physical location for this device pool. The system uses physical location with the device mobility feature to identify the parameters that relate to a specific geographical location.

Default value: None

Option Description
Device Mobility Group

Device mobility groups represent the highest level geographic entities in your network and are used to support the device mobility feature.

Default value: None

Wireless LAN Profile Group

Choose a wireless LAN profile group from the drop-down list.

Note:

You can specify the Wireless LAN Profile Group at the Device Pool level or the individual phone level.

Geolocation Configuration Fields

Option Description
Geolocation

From the drop-down list, choose a geolocation.

You can choose the Unspecified geolocation, which designates that the devices in this device pool do not associate with a geolocation.

Default value: None

Geolocation Filter

From the drop-down list, choose a geolocation filter.

If you leave the <None> setting, no geolocation filter gets applied for the devices in this device pool.

Default value: None

Incoming Calling Party Settings Fields

Option Description
National Prefix

Unified CM applies the prefix that you enter in this field to calling party numbers that use National for the Calling Party Numbering Type.

You can enter up to eight characters, which include digits, the international escape character (+), asterisk (*), or the pound sign (#). You can enter the word "Default" instead of entering a prefix. If the word "Default" displays in the Prefix field, Unified CM applies the service parameter configuration for the incoming calling party prefix, which supports both the prefix and strip digit functionality.

National Strip Digits Enter the number of digits, up to the number 24, that you want Unified CM to strip from the calling party number of National type before it applies the prefixes.
National Calling Search Space This setting allows you to globalize the calling party number of National calling party number type on the device. Make sure that the calling search space that you choose contains the calling party transformation pattern that you want to assign to this device. Before the call occurs, the device must apply the transformation by using digit analysis. If you configure the CSS as None, the transformation does not match and does not get applied. Make sure that you configure the calling party transformation pattern in a non-null partition that is not used for routing.
International Prefix Unified CM applies the prefix that you enter in this field to calling party numbers that use International for the Calling Party Numbering Type. You can enter up to eight characters, which include digits, the international escape character (+), asterisk (*), or the pound sign (#). You can enter the word "Default" instead of entering a prefix. If the word "Default" displays in the Prefix field in the Device Pool Configuration window, Unified CM applies the service parameter configuration for the incoming calling party prefix, which supports both the prefix and strip digit functionality.
International Strip Digits Enter the number of digits, up to the number 24, that you want Unified CM to strip from the calling party number of International type before it applies the prefixes.
International Calling Search Space This setting allows you to globalize the calling party number of International calling party number type on the device. Make sure that the calling party transformation CSS that you choose contains the calling party transformation pattern that you want to assign to this device. Before the call occurs, the device must apply the transformation by using digit analysis. If you configure the CSS as None, the transformation does not match and does not get applied. Ensure that you configure the calling party transformation pattern in a non-null partition that is not used for routing.
Option Description
Unknown Prefix Unified CM applies the prefix that you enter in this field to calling party numbers that use Unknown for the Calling Party Numbering Type. You can enter up to eight characters, which include digits, the international escape character (+), asterisk (*), or the pound sign (#). If the word "Default" displays in the Prefix field in the Device Pool Configuration window, Unified CM applies the service parameter configuration for the incoming calling party prefix, which supports both the prefix and strip digit functionality.
Unknown Strip Digits Enter the number of digits, up to the number 24, that you want Unified CM to strip from the calling party number of Unknown type before it applies the prefixes.
Unknown Calling Search Space This setting allows you to globalize the calling party number of "Unknown" calling party number type on the device. Make sure that the calling party transformation CSS that you choose contains the calling party transformation pattern that you want to assign to this device. Before the call occurs, the device must apply the transformation by using digit analysis. If you configure the CSS as None, the transformation does not match and does not get applied. Ensure that you configure the calling party transformation pattern in a non-null partition that is not used for routing.
Subscriber Prefix Unified CM applies the prefix that you enter in this field to calling party numbers that use Subscriber for the Calling Party Numbering Type. You can enter up to eight characters, which include digits, the international escape character (+), asterisk (*), or the pound sign (#). If the word "Default" displays in the Prefix field in the Device Pool Configuration window, Unified CM applies the service parameter configuration for the incoming calling party prefix, which supports both the prefix and strip digit functionality.
Subscriber Strip Digits Enter the number of digits, up to the number 24, that you want Unified CM to strip from the calling party number of Subscriber type before it applies the prefixes.
Subscriber Calling Search Space This setting allows you to globalize the calling party number of Subscriber calling party number type on the device. Make sure that the CSS that you choose contains the calling party transformation pattern that you want to assign to this device. Before the call occurs, the device must apply the transformation by using digit analysis. If you configure the CSS as None, the transformation does not match and does not get applied. Ensure that you configure the calling party transformation pattern in a non-null partition that is not used for routing.

Incoming Called Party Settings Fields

Option Description
National Prefix

Unified CM applies the prefix that you enter in this field to calling party numbers that use National for the Called Party Numbering Type.

You can enter up to sixteen (16) characters, which include digits, the international escape character (+), asterisk (*), or the pound sign (#). You can enter the word "Default" instead of entering a prefix.

Tip:

If the word "Default" displays in the Gateway or Trunk Configuration window, you cannot configure the Strip Digits field in the Gateway or Trunk Configuration window. In this case, Unified CM takes the configuration for the Prefix and Strip Digits fields from the device pool that is applied to the device. If the word "Default" displays in the Prefix field in the Device Pool Configuration window, Unified CM applies the service parameter configuration for the incoming called party prefix, which supports both the prefix and strip digit functionality.

Tip:

To configure the Strip Digits field, leave the Prefix field blank or enter a valid configuration in the Prefix field. To configure the Strip Digits fields, do not enter the word "Default" in the Prefix field.

National Strip Digits Enter the number of digits, that you want Unified CM to strip from the called party number of "Unknown" type before it applies the prefixes.
National Calling Search Space This setting allows you to transform the called party number of "Unknown" called party number type on the device. If you choose None, no transformation occurs for the incoming called party number. Make sure that the calling search space that you choose contains the called party transformation pattern that you want to assign to this device.
International Prefix

Unified CM applies the prefix that you enter in this field to called party numbers that use National for the Called Party Numbering Type. You can enter up to 16 characters, which include digits, the international escape character (+), asterisk (*), or the pound sign (#). You can enter the word "Default" instead of entering a prefix.

Tip:

If the word "Default" displays in the Prefix field in the Gateway or Trunk Configuration window, you cannot configure the Strip Digits field in the Gateway or Trunk Configuration window. In this case, Unified CM takes the configuration for the Prefix and Strip Digits fields from the device pool that is applied to the device. If the word "Default" displays in the Prefix field in the Device Pool Configuration window, Unified CM applies the service parameter configuration for the incoming called party prefix, which supports both the prefix and strip digit functionality.

Tip:

To configure the Strip Digits field, leave the Prefix field blank or enter a valid configuration in the Prefix field. To configure the Strip Digits fields, do not enter the word "Default" in the Prefix field.

International Strip Digits Enter the number of digits that you want Unified CM to strip from the called party number of International type before it applies the prefixes.
International Calling Search Space This setting allows you to transform the called party number of International called party number type on the device. If you choose None, no transformation occurs for the incoming called party number. Make sure that the calling search space that you choose contains the called party transformation pattern that you want to assign to this device.
Option Description
Unknown Prefix

Unified CM applies the prefix that you enter in this field to called numbers that use Unknown for the Called Party Numbering Type. You can enter up to sixteen characters, which include digits, the international escape character (+), asterisk (*), or the pound sign (#). You can enter the word "Default" instead of entering a prefix.

Tip:

If the word "Default" displays in the Prefix in the Gateway or Trunk window, you cannot configure the Strip Digits in the Gateway or Trunk Configuration window. In this case, Unified CM takes the configuration for the Prefix and Strip Digits fields from the device pool that is applied to the device. If the word "Default" displays in the Prefix field in the Device Pool Configuration window, Unified CM applies the service parameter configuration for the incoming called party prefix, which supports both the prefix and strip digit functionality.

Tip:

To configure the Strip Digits field, leave the Prefix field blank or enter a valid configuration in the Prefix field. To configure the Strip Digits fields, do not enter the word "Default" in the Prefix field.

Unknown Strip Digits Enter the number of digits, that you want Unified CM to strip from the called party number of "Unknown" type before it applies the prefixes.
Unknown Calling Search Space This setting allows you to transform the called party number of "Unknown" called party number type on the device. If you choose None no transformation occurs for the incoming called party number. Make sure that the calling search space that you choose contains the called party transformation pattern that you want to assign to this device.
Subscriber Prefix

Unified CM applies the prefix that you enter in this field to called numbers that use Subscriber for the Called Party Numbering Type. You can enter up to sixteen characters, which include digits, the international escape character (+), asterisk (*), or the pound sign (#). You can enter the word "Default" instead of entering a prefix.

Tip:

If the word "Default" displays in the Prefix field in the Gateway or Trunk Configuration window, you cannot configure the Strip Digits field in the Gateway or Trunk Configuration window. In this case, Unified CM takes the configuration for the Prefix and Strip Digits fields from the device pool that is applied to the device. If the word "Default" displays in the Prefix field in the Device Pool Configuration window, Unified CM applies the service parameter configuration for the incoming called party prefix, which supports both the prefix and strip digit functionality.

Tip:

To configure the Strip Digits field, leave the Prefix field blank or enter a valid configuration in the Prefix field. To configure the Strip Digits fields, do not enter the word "Default" in the Prefix field.

Subscriber Strip Digits Enter the number of digits, that you want Unified CM to strip from the called party number of Subscriber type before it applies the prefixes.
Subscriber Calling Search Space This setting allows you to transform the called party number of Subscriber called party number type on the device. If you choose None, no transformation occurs for the incoming called party number. Make sure that the calling search space that you choose contains the called party transformation pattern that you want to assign to this device.

Caller ID For Calls From This Phone Fields

Option Description
Calling Party Transformation CSS

From the drop-down list, choose the CSS that contains the Calling Party Transformation Pattern that you want to apply to devices in this device pool.

When Unified CM receives a call from a device in this device pool on an inbound line, Unified CM immediately applies the calling party transformation patterns in this CSS to the digits in the calling party number before it routes the call. This setting allows you to apply digit transformations to the calling party number before Unified CM routes the call. For example, a transformation pattern can change a phone extension to appear as an E.164 number.

Connected Party Settings Fields

Option Description
Connected Party Transformation CSS

This setting is applicable for inbound calls only. This setting allows you to transform the connected party number on the device to display the connected number in another format, such as a DID or E164 number. Unified CM includes the transformed number in the headers of various SIP messages, including 200 OK and mid-call update/reinvite messages for SIP calls and in the Connected Number Information Element of CONNECT and NOTIFY messages for H.323 and MGCP calls. Make sure that the Connected Party Transformation CSS that you choose contains the called party transformation pattern that you want to assign to this device pool.

Note:

If you configure the Connected Party Transformation CSS as None, the transformation does not match and does not get applied. Ensure that you configure the Calling Party Transformation pattern used for Connected Party Transformation in a non-null partition that is not used for routing.

Redirecting Party Settings Fields

Option Description
Redirecting Party Transformation CSS

This setting allows you to transform the redirecting party number on the device to E164 format. Unified CM includes the transformed number in the diversion header of invite messages for SIP trunks and in the Redirecting Number Information Element of setup message (for H.323 and MGCP) sent out of Unified CM. Make sure that the Redirecting Party Transformation CSS that you choose contains the called party transformation pattern that you want to assign to this device pool. that the Connected Party Transformation CSS that you choose contains the called party transformation pattern that you want to assign to this device pool.

Note:

If you configure the Redirecting Party Transformation CSS as None, the transformation does not match and does not get applied. Ensure that you configure the Redirecting Party Transformation CSS in a non-null partition that is not used for routing.

This relation wraps the default CUCM device pool element.

Model Details: relation/HcsLocalRouteGroupREL

Title Description Details
Called Party Subscriber Transformation Css Name
  • Field Name: calledPartySubscriberTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Device Mobility Group Device mobility groups represent the highest level geographic entities in your network and are used to support the device mobility feature.
  • Field Name: deviceMobilityGroupName
  • Type: ["String", "Null"]
  • Target: device/cucm/DeviceMobilityGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Intercompany Media Services Enrolled Group Select an Intercompany Media Services Enrolled Group from the drop-down list. For more information, see the Cisco Intercompany Media Engine Installation and Configuration Guide.
  • Field Name: imeEnrolledPatternGroupName
  • Type: ["String", "Null"]
  • Target: device/cucm/ImeEnrolledPatternGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Called Party Unknown Transformation Css Name
  • Field Name: calledPartyUnknownTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Calling Party Unknown Transformation Css Name
  • Field Name: callingPartyUnknownTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Called Party International Transformation Css Name
  • Field Name: calledPartyInternationalTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Calling Party National Transformation Css Name
  • Field Name: callingPartyNationalTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Adjunct CSS From the drop-down list box, choose an existing Calling Search Space (CSS) to use for the devices in this device profile as an adjunct CSS for the Extension Mobility Cross Cluster (EMCC) feature. (To configure a new CSS or modify an existing CSS, choose Call Routing > Class of Control > Calling Search Space in Cisco Unified Communications Manager Administration.) Default value specifies None. When configuring the EMCC feature, the administrator must configure a device pool for each remote cluster. If the remote cluster is located in a different country, the adjunct CSS must embrace the partition with which the emergency patterns of that country associate. This configuration facilitates country-specific emergency call routing. For more information about the adjunct CSS, see topics related to EMCC call routing in the Cisco Unified Communications Manager Features and Services Guide.
  • Field Name: adjunctCallingSearchSpace
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Called Party Unknown Strip Digits
  • Field Name: calledPartyUnknownStripDigits
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Calling Search Space for Auto-registration Choose the calling search space to assign to devices in this device pool that auto-register with Cisco Unified Communications Manager. The calling search space specifies partitions that devices can search when attempting to complete a call.
  • Field Name: autoSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Date/Time Group * Choose the date/time group to assign to devices in this device pool. The date/time group specifies the time zone and the display formats for date and time.
  • Field Name: dateTimeSettingName
  • Type: String
  • Target: device/cucm/DateTimeGroup
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Region * Choose the Cisco Unified Communications Manager region to assign to devices in this device pool. The Cisco Unified Communications Manager region settings specify voice codec that can be used for calls within a region and between other regions.
  • Field Name: regionName
  • Type: String
  • Target: device/cucm/Region
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Called Party Subscriber Prefix
  • Field Name: calledPartySubscriberPrefix
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 16
Local Route Group Name The Local Route Group Settings enables you to associate the route groups that you add under Call Routing > Route/Hunt > Route Group with the local route groups that you configure on the Local Route Group Names window for any particular device pool.
  • Field Name: localRouteGroupName
  • Type: String
  • Target: device/cucm/RouteGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Called Party Unknown Prefix
  • Field Name: calledPartyUnknownPrefix
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 16
Single Button Barge This setting determines whether the devices or phone users in this device pool have single-button access for barge and cBarge. From the drop-down list box, choose from the following options: Off—If you choose this option, the devices in this device pool will have the Single Button Barge/cBarge feature disabled. Barge—If you choose this option, the devices in this device pool will have the Single Button Barge feature enabled. CBarge—If you choose this option, the devices in this device pool will have the Single Button cBarge feature enabled. Default—If you choose this option, the devices in this device pool will use the service parameter setting for the Single Button Barge/cBarge feature. Default: Default
  • Field Name: singleButtonBarge
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "Barge", "CBarge", "Default"]
Local Route Group
  • Field Name: localRouteGroup.[n]
  • Type: Array
Name
  • Field Name: localRouteGroup.[n].name
  • Type: String
  • Target: device/cucm/LocalRouteGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Value
  • Field Name: localRouteGroup.[n].value
  • Type: String
  • Target: device/cucm/RouteGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Calling Party Transformation CSS This setting allows you to localize the calling party number on the device. Make sure that the Calling Party Transformation CSS that you choose contains the calling party transformation pattern that you want to assign to this device pool. Tip    Before the call occurs, the device must apply the transformation by using digit analysis. If you configure the Calling Party Transformation CSS as None for the device pool and you check the Use Device Pool Calling Party Transformation CSS check box in the device configuration window, the transformation does not match and does not get applied. Ensure that you configure the Calling Party Transformation Pattern in a non-null partition that is not used for routing.
  • Field Name: callingPartyTransformationCSS
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Called Party National Prefix
  • Field Name: calledPartyNationalPrefix
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 16
Calling Party Unknown Strip Digits
  • Field Name: callingPartyUnknownStripDigits
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Calling Party International Transformation Css Name
  • Field Name: callingPartyInternationalTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Network Locale From the drop-down list box, choose the locale that is associated with phones and gateways. The network locale contains a definition of the tones and cadences that the phones and gateways in the device pool in a specific geographic area use. Make sure that you select a network locale that is supported by all of the phones and gateways that use this device pool. Note    If the user does not choose a network locale, the locale that is specified in the Cisco Unified Communications Manager clusterwide parameters as Default Network Locale applies. Note    Choose only a network locale that is already installed and supported by the associated devices. The list contains all available network locales for this setting, but not all are necessarily installed. If a device is associated with a network locale that it does not support in the firmware, the device will fail to come up.
  • Field Name: networkLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/Country
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["Argentina", "Australia", "Austria", "Belgium", "Brazil", "Canada", "China", "Colombia", "Cyprus", "Czech Republic", "Denmark", "Egypt", "Finland", "France", "Germany", "Ghana", "Greece", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Ireland", "Israel", "Italy", "Japan", "Jordan", "Kenya", "Korea Republic", "Lebanon", "Luxembourg", "Malaysia", "Mexico", "Nepal", "Netherlands", "New Zealand", "Nigeria", "Norway", "Pakistan", "Panama", "Peru", "Philippines", "Poland", "Portugal", "Russian Federation", "Saudi Arabia", "Singapore", "Slovakia", "Slovenia", "South Africa", "Spain", "Sweden", "Switzerland", "Taiwan", "Thailand", "Turkey", "United Kingdom", "United States", "Venezuela", "Zimbabwe", "Itu", "Chile", "Bulgaria", "Croatia", "Romania", "Serbia and Montenegro", "United Arab Emirates", "Oman", "Kuwait", "Algeria", "Bahrain", "Iraq", "Mauritania", "Republic of Montenegro", "Morocco", "Qatar", "Republic of Serbia", "Sudan", "Tunisia", "Vietnam", "Yemen", "Lithuania", "Latvia", "Estonia", "Ukraine"]
Calling Party Subscriber Prefix
  • Field Name: callingPartySubscriberPrefix
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 16
Called Party National Transformation Css Name
  • Field Name: calledPartyNationalTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Media Resource Group List From the drop-down list box, choose a media resource group list. A media resource group list specifies a prioritized list of media resource groups. An application selects the required media resource (for example, a music on hold server, transcoder, or conference bridge) from the available media resource groups according to the priority order that is defined in a media resource group list.
  • Field Name: mediaResourceListName
  • Type: ["String", "Null"]
  • Target: device/cucm/MediaResourceList
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Mra Service Domain
  • Field Name: mraServiceDomain
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Connection Monitor Duration This setting defines the time that the Cisco Unified IP Phone monitors its connection to Cisco Unified Communications Manager before it unregisters from SRST and reregisters to Cisco Unified Communications Manager. To use the configuration for the enterprise parameter, you can enter -1 or leave the field blank. The default value for the enterprise parameter equals 120 seconds. Change this setting if you need to disable the connection monitor or if you want to extend the connection monitor time. The maximum number of seconds that you can enter in the field equals 2592000. Tip    When you change the value of the connection monitor duration, it applies only to the device pool that is being updated. All other device pools use the value in their own connection monitor duration fields or use the value that is configured in the enterprise parameter. For more information, see topics related to survivable remote site telephony in the Cisco Unified Communications Manager System Guide. Default: -1
  • Field Name: connectionMonitorDuration
  • Type: Integer
  • Cardinality: [0..1]
  • Default: -1
Device Mobility Calling Search Space Choose the appropriate calling search space to be used as the device calling search space when the device is roaming and in same device mobility group.
  • Field Name: mobilityCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Called Party International Strip Digits
  • Field Name: calledPartyInternationalStripDigits
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Reverted Call Focus Priority Choose a clusterwide priority setting for reverted calls that are invoked by the hold reversion feature. This setting specifies which call type, incoming calls or reverted calls, have priority for user actions, such as going off hook. Default—If you choose this option, incoming calls have priority. Highest—If you choose this option, reverted calls have priority. The Not Selected setting specifies the reverted call focus priority setting for the default device pool at installation. At installation, incoming calls have priority. You cannot choose this setting in Cisco Unified Communications Manager Administration. Note    This setting applies specifically to hold reverted calls; it does not apply to parked reverted calls. For more information, see topics related to hold reversion in the Cisco Unified Communications Manager Features and Services Guide. Default: Default
  • Field Name: revertPriority
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Default", "Highest"]
Redirecting Party Transformation CSS This setting allows you to transform the redirecting party number on the device to E164 format. Cisco Unified Communications Manager includes the transformed number in the diversion header of invite messages for SIP trunks and in the Redirecting Number Information Element of setup message (for H.323 and MGCP) sent out of Cisco Unified Communications Manager. Make sure that the Redirecting Party Transformation CSS that you choose contains the called party transformation pattern that you want to assign to this device pool. Note    If you configure the Redirecting Party Transformation CSS as None, the transformation does not match and does not get applied. Ensure that you configure the Redirecting Party Transformation CSS in a non-null partition that is not used for routing.
  • Field Name: redirectingPartyTransformationCSS
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Geolocation From the drop-down list box, choose a geolocation. You can choose the Unspecified geolocation, which designates that the devices in this device pool do not associate with a geolocation. You can also choose a geolocation that has been configured with the System > Geolocation Configuration menu option. For an explanation of geolocations, including configuration details, see topics related to geolocations and location conveyance in the Cisco Unified Communications Manager Features and Services Guide. For an overview and details of how logical partitioning uses geolocations, see topics related to geolocations and location conveyance in the Cisco Unified Communications Manager Features and Services Guide.
  • Field Name: geoLocationName
  • Type: ["String", "Null"]
  • Target: device/cucm/GeoLocation
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Called Party International Prefix
  • Field Name: calledPartyInternationalPrefix
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 16
Cisco Unified Communications Manager Group * Choose the Cisco Unified Communications Manager group to assign to devices in this device pool. A Cisco Unified Communications Manager group specifies a prioritized list of up to three Cisco Unified Communications Managers. The first Cisco Unified Communications Manager in the list serves as the primary Cisco Unified Communications Manager for that group, and the other members of the group serve as backup Cisco Unified Communications Managers for redundancy.
  • Field Name: callManagerGroupName
  • Type: String
  • Target: device/cucm/CallManagerGroup
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Calling Party National Strip Digits
  • Field Name: callingPartyNationalStripDigits
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Elin Group Select a Wi-Fi Hotspot Profile from the drop-down list box. You may also click View Details to display details about the Wi-Fi Hotspot Profile that you select.
  • Field Name: elinGroup
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Join Across Lines This setting determines whether the Join Across Lines feature is enabled for the devices or phone users in this device pool. From the drop-down list box, choose from the following options: Off—If you choose this option, the devices in this device pool will have the Join Across Lines feature disabled. On—If you choose this option, the devices in this device pool will have the Join Across Lines feature enabled. Default—If you choose this option, the devices in this device pool will use the service parameter setting for the Join Across Lines feature. Default: Default
  • Field Name: joinAcrossLines
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Called Party Transformation CSS This setting allows you to localize the called party number on the device. Make sure that the Called Party Transformation CSS that you choose contains the called party transformation pattern that you want to assign to this device pool. Note    If you configure the Called Party Transformation CSS as None, the transformation does not match and does not get applied. Ensure that you configure the Called Party Transformation pattern in a non-null partition that is not used for routing.
  • Field Name: cdpnTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Calling Party Subscriber Strip Digits
  • Field Name: callingPartySubscriberStripDigits
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Calling Party Unknown Prefix
  • Field Name: callingPartyUnknownPrefix
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 16
SRST Reference * From the drop-down list box, choose a survivable remote site telephony (SRST) reference to assign to devices in this device pool. Choose from the following options: Disable—If you choose this option, devices in this device pool will not have SRST reference gateways that are available to them. Use Default Gateway—If you choose this option, devices in this device pool use the default gateway for SRST. Existing SRST references—If you choose an SRST reference from the drop-down list, devices in this device pool will use this SRST reference gateway.
  • Field Name: srstName
  • Type: String
  • Target: device/cucm/Srst
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Calling Party National Prefix
  • Field Name: callingPartyNationalPrefix
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 16
Calling Party International Strip Digits
  • Field Name: callingPartyInternationalStripDigits
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Device Pool Name * Enter the name of the new device pool that you are creating. You can enter up to 50 characters, which include alphanumeric characters, periods (.), hyphens (-), underscores (_), and blank spaces.
  • Field Name: name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 50
Connected Party Transformation CSS This setting is applicable for inbound calls only. This setting allows you to transform the connected party number on the device to display the connected number in another format, such as a DID or E164 number. Cisco Unified Communications Manager includes the transformed number in the headers of various SIP messages, including 200 OK and mid-call update/reinvite messages for SIP calls and in the Connected Number Information Element of CONNECT and NOTIFY messages for H.323 and MGCP calls. Make sure that the Connected Party Transformation CSS that you choose contains the called party transformation pattern that you want to assign to this device pool. Note    If you configure the Connected Party Transformation CSS as None, the transformation does not match and does not get applied. Ensure that you configure the Calling Party Transformation pattern used for Connected Party Transformation in a non-null partition that is not used for routing.
  • Field Name: cntdPnTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Calling Party Subscriber Transformation Css Name
  • Field Name: callingPartySubscriberTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Wireless Lan Profile Group Select a wireless LAN profile group from the drop-down list box. You may also click View Details to display the settings for this wireless LAN profile group. Note    You can specify the Wireless LAN Profile Group at the Device Pool level or the individual phone level.
  • Field Name: wirelessLanProfileGroup
  • Type: ["String", "Null"]
  • Target: device/cucm/WlanProfileGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Geolocation Filter From the drop-down list box, choose a geolocation filter. If you leave the <None> setting, no geolocation filter gets applied for the devices in this device pool. You can also choose a geolocation filter that has been configured with the System > Geolocation Filter menu option. For an explanation of geolocation filters, including configuration details, see the Cisco Unified Communications Manager Features and Services Guide. For an overview and details of how logical partitioning uses geolocation filters, see the Cisco Unified Communications Manager Features and Services Guide.
  • Field Name: geoLocationFilterName
  • Type: ["String", "Null"]
  • Target: device/cucm/GeoLocationFilter
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
AAR Group * Choose the automated alternate routing (AAR) group for this device. The AAR group provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth. An AAR group setting of None specifies that no rerouting of blocked calls will be attempted.
  • Field Name: aarNeighborhoodName
  • Type: ["String", "Null"]
  • Target: device/cucm/AarGroup
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Location Use locations to implement call admission control (CAC) in a centralized call-processing system. CAC enables you to regulate audio quality and video availability by limiting the amount of bandwidth that is available for audio and video calls over links between locations. The location specifies the total bandwidth that is available for calls to and from this location. From the drop-down list box, choose the appropriate location for this device pool. A location setting of None or Hub_None means that the locations feature does not keep track of the bandwidth that the devices in this device pool consume. A location setting of Phantom specifies a location that enables successful CAC across intercluster trunks that use H.323 protocol or SIP. To configure a new location, use the System > Location menu option. For an explanation of location-based CAC across intercluster trunks, see topics related to location-based CAC in the Cisco Unified Communications Manager System Guide.
  • Field Name: locationName
  • Type: ["String", "Null"]
  • Target: device/cucm/Location
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Physical Location Select the physical location for this device pool. The system uses physical location with the device mobility feature to identify the parameters that relate to a specific geographical location.
  • Field Name: physicalLocationName
  • Type: ["String", "Null"]
  • Target: device/cucm/PhysicalLocation
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Calling Party Transformation CSS This setting allows you to localize the calling party number on the device. Make sure that the Calling Party Transformation CSS that you choose contains the calling party transformation pattern that you want to assign to this device pool. Tip    Before the call occurs, the device must apply the transformation by using digit analysis. If you configure the Calling Party Transformation CSS as None for the device pool and you check the Use Device Pool Calling Party Transformation CSS check box in the device configuration window, the transformation does not match and does not get applied. Ensure that you configure the Calling Party Transformation Pattern in a non-null partition that is not used for routing.
  • Field Name: cgpnTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Called Party National Strip Digits
  • Field Name: calledPartyNationalStripDigits
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
AAR Calling Search Space Choose the appropriate calling search space for the device to use when automated alternate routing (AAR) is performed. The AAR calling search space specifies the collection of route partitions that are searched to determine how to route a collected (originating) number that is otherwise blocked due to insufficient bandwidth.
  • Field Name: automatedAlternateRoutingCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Called Party Subscriber Strip Digits
  • Field Name: calledPartySubscriberStripDigits
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Calling Party International Prefix
  • Field Name: callingPartyInternationalPrefix
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 16
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024