[Index]
To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com
This procedure configures phones.
Preparation for Adding Phones (CUCM)
Before adding phones in VOSS Automate, you will need to add and configure the following items on Cisco Unified Communications Manager (Unified CM), and then import these items into VOSS Automate:
View and Update Sites Defaults for Phones
When setting up VOSS Automate, default values are created when adding Providers, Customers, and Sites. For example, the Site IDs. If the site dial plan specifies Device Pool, CSS, and Partition names, these can also be selected. To identify the site-related values, see the naming conventions used in Modify Site Defaults.
The Site Defaults also populates certain default values for phones.
To view and update site defaults for phones:
In the VOSS Automate Admin Portal, go to (default menus) Site Management > Defaults.
Click the relevant site defaults doc in the list.
View or update phone parameter defaults for the site on the following tabs:
General Defaults tab
Device Defaults tab
See Modify Site Defaults for details regarding the value to fill out for phone parameters such as partitions and CSSs.
Note
Add a Phone
This procedure adds a phone.
Note
It is recommended that you use Smart Add phone to add standalone phones and use Quick Add Subscriber to add phones to subscribers. See Smart Add Phone Overview and Quick Add Subscriber.
Log in to the Admin Portal as a Provider, Customer, or Site admin.
Note
Only a subset of fields are available to Site admins.
Choose the hierarchy.
Go to (default menus) Subscriber Management > Phones.
View the list of phones on the Phones list.
Note
An administrator with the required access profile can click Fetch real-time phone status on the toolbar to fetch the Unified CM phone IP address and status directly from the Unified CM. Data is fetched in real-time and displays read-only values in the following columns:
Fetched data is not cached or stored in the database, and cannot be exported or filtered. Real-time data displays the latest data for the current list of phones on the Admin Portal. Prior to fetching real-time status updates, existing column values display cached values from the RIS data collector (if enabled).
The Activate Phone Status Service setting is enabled by default and can be managed by system level administrators. See the Advanced Configuration Guide for details.
Click Add, then configure the phone and its associated settings on the following tabs.
Tab | Description |
---|---|
Phone | Default values are applied for some fields (such as Device Protocol, BAT Phone Template, and Device Security Profile), based on the selected product type. The Vendor Config settings are related to the selected phone type. Fields that display are based on the selected Product (device type) and the Device Protocol (such as SIP or SCCP). The supported features available for each phone type are retrieved from the related Unified CM. To override the default Phone Button Template, either choose another template, or enter a custom value. The new value is applied on the Unified CM if it allows that phone type. If you don't see a template that you are looking for in the drop-down list (for example, for Phone Button Template, Device Security Profile or SIP Profile), edit the template on Unified CM, and then sync the template into VOSS Automate to have it appear in the drop-down list. If the Product type list does not contain the phone or endpoint you want, take the following steps. In Unified CM, install a COP file for the endpoint you want. Install the COP file only once for the Unified CM instance where the endpoint is added. Then in VOSS Automate, import the phone button template from Unified CM. Follow these steps while creating a CTI Remote Device to enable Extend and Connect in VOSS Automate:
|
Lines | This tab serves two purposes.
The Lines sections reflect the Lines object in Unified CM. You can add lines to this group and associate lines with the device. You can add custom lines by entering a line in the drop-down list. If Number Inventory is enabled, you can select a number from the list of available numbers. |
Speed Dials | Allows you to configure speed dials for the device. Available speed dials depend on the device's Phone Button Template. The order in which Speed Dial entries are added matches the slots that are available in Unified CM. |
Services | Used to set IP Phone services. Once you choose the IP phone service, the system retrieves the URL and a custom parameter (if any, for example, ext1 and ext2) from device/cucm/IpPhoneService, and populates the URL field. |
Busy Lamp Fields | Allows you to configure busy lamps for the device. Available busy lamp fields depend on the device's Phone Button Template. |
Blf Directed Call Parks | Allows you to configure Busy Lamp Field directed call parks for the device. Available BLF-directed call parks depend on the device's Phone Button Template. Create BLF-directed call parks in Call Routing > Directed Call Parks on Unified CM before configuring them from this tab. The available BLF-directed call parks match those created for each specific Route Partition Name. |
Tab | Description |
---|---|
Dual Mode Settings | Only applies to a Dual Mode Phone, Spark Remote Device, or CTI Remote Device, and allows you to enter the relevant Mobile Identity and Remote Destination (or CTI Remote Destination) parameters for the device. These parameters include Name, Destination Number, Owner User ID, Dual Mode Device Name (or CTI Remote Device), and Answer Too Soon and Too Late Timers. |
Certificate Authority Functions | Only applies to a Dual Mode Phone, Spark Remote Device, or CTI Remote Device, and allows you to enter the relevant Mobile Identity and Remote Destination (or CTI Remote Destination) parameters for the device. These parameters include Name, Destination Number, Owner User ID, Dual Mode Device Name (or CTI Remote Device), and Answer Too Soon and Too Late Timers. The date-time value must be added manually as: CCYY:MM:DD:HH:MM |
For Certificate Authority Functions, see also Certificate Authority Functions Fields.
Update a Phone
Note the following for updating a phone:
Note
If the required Unified CM setting "Customer Support upload URL" is configured at the Enterprise, Profile, or Device level, then the Action menu option Generate Prt Phone can be used to send a Problem Report Tool (PRT) file to the upload URL.
View and Update Phone Vendor Config Settings
The Vendor Config settings will display if the Field Display Policy (FDP) allows it.
You can access the vendor configuration settings for a phone as follows:
In the Admin Portal, go to (default menus) Subscriber Management > Phones.
On the Phones list view, click on a phone to open its settings.
On the Phones tab, scroll down to the bottom of the page to locate the Vendor Config setting.
Click Vendor Config to open the configuration screen:
Settings can be enabled or disabled. Ensure you're setting values correctly for Bulk Loaders, the API, or in custom Configuration Templates, where values must be defined as key-value pairs:
On Unified CM, in some cases the value 0 is "Enabled" and in other cases 0 is "Disabled".
It is recommended that settings on the Unified CM are configured manually on a sample phone to the value you want, before exporting the phone. Then use the example settings as the basis for your Bulk Loaders, API, or custom Configuration Templates.
The required value may change depending on the setting being applied, for example:
To enable the "Web Access" for a phone, configure the following:
To disable "Web Access" for a phone, configure the following:
To enable "Settings Access", configure the following:
To disable "Settings Access", configure the following:
Overview
This topic describes how to manage Cisco Phones in the VOSS Automate Admin portal.
View Phones
This procedure displays existing phones.
Log in to the Admin Portal as a Provider, Customer, or Site admin.
Note
Only a subset of fields are available to Site admins.
Go to (default menus) Subscriber Management > Phones to open the Phones page summary list view.
View the list of existing phones.
Note
An administrator with the required access profile can click Fetch real-time phone status on the toolbar to fetch the CUCM phone IP address and status directly from the CUCM. Data is fetched in real-time and displays read-only values in the following columns:
Fetched data is not cached or stored in the database, and cannot be exported or filtered. Real-time data displays the latest data for the current list of phones on the Admin Portal. Prior to fetching real-time status updates, existing column values display cached values from the RIS data collector (if enabled).
The Activate Phone Status Service setting is enabled by default and can be managed by system level administrators. See the Advanced Configuration Guide for details.
If the Registration Status and IP Address columns are not visible at a hierarchy level, run the following command from the CLI:
voss migrate_summary_attributes device/cucm/Phone
Add a Phone
This procedure adds a new Cisco phone.
Note
It is recommended that you use Smart Add phone to add standalone phones and use Quick Add Subscriber to add phones to subscribers. See Smart Add Phone Overview and Quick Add Subscriber.
Before you start
Before adding phones in VOSS Automate, you will need to add and configure the following items on CUCM, and then import these items into VOSS Automate:
To add a phone (CUCM users):
Log in to the Admin Portal as a Provider, Customer, or Site admin.
Note
Only a subset of fields are available to Site admins.
Choose the hierarchy.
Go to (default menus) Subscriber Management > Phones to open the Phones page summary list view.
To add a phone, click the toolbar Plus (+) icon from the list view, then choose the relevant hierarchy.
On the Add Phone configuration page, fill out phone details:
In the Phone Details panel:
Choose Device Type, for example, Android or Cisco 7941.
Note
If you don't see the phone or endpoint you want, you'll need to install a COP file for the endpoint you want, in CUCM. Install the COP file only once for the CUCM instance where the endpoint is added. In VOSS Automate you will need to import the phone button template from CUCM.
The phone type you're adding must support the protocol you wish to use. A default protocol can be defined in the site defaults (Device Defaults tab). Some phone types support multiple protocols (for example, Cisco 7960 with SCCP and SIP), and some phone types support only one protocol (for example, Cisco 9971 with only SIP). If the phone type you're adding does not support a selected protocol, the protocol defaults to the one set up in the site defaults. You can choose or update the protocol (if allowed by the phone type), when adding a phone, when adding a subscriber, or when adding a phone to an existing subscriber.
Specify a phone name (mandatory) and description (optional).
Note
When adding a device (phone) name, add SEP before the mac address. For example, if the mac address is 000000000AB1, the device name must be SEP000000000AB1.
Choose a phone template for automatic configuration of settings.
If this is a standalone phone, select Standalone Phone, else, choose the username of the subscriber to associate with this phone.
In the Lines panel, click the Plus (+) icon to add a line, then configure line settings:
Click Save to add the phone.
Update a Phone
This procedure updates an existing phone.
Log in to the Admin Portal as a Provider, Customer, or Site admin.
Note
Only a subset of fields are available to Site admins.
Go to (default menus) Subscriber Management > Phones to open the Phones page summary list view.
Click on the phone you wish to update to open its settings.
View existing settings, and update as required. Note the following:
Note
Setting | Description |
---|---|
Quick Actions | Provides quick access to one or more predefined actions, such as restart, reset, or replace phone, or generate PRT. You can add also access some of these actions via the overflow toolbar menu (vertical ellipsis). |
Phone |
|
Lines | This panel displays all lines associated with the device and allows you to associate additional lines. When adding a line, the system checks that a line exists, and if it doesn't exist, the line is added. If Number Inventory is enabled, you can select a number from the list of available numbers.
|
Speed Dials | On this panel you can configure speed dials for the device. Available speed dials depend on the device's Phone Button Template. The order in which Speed Dial entries are added matches the slots that are available on CUCM. |
Services | On this panel you can set up IP Phone services. Once you choose the IP phone service, the system retrieves the URL and a custom parameter (if any, for example, ext1 and ext2) from device/cucm/IpPhoneService, and populates the URL field. |
Busy Lamp Fields | In this panel you can configure busy lamps for the device. Available busy lamp fields depend on the device's Phone Button Template. |
Setting | Description |
---|---|
Blf Directed Call Parks | This panel allows you to configure Busy Lamp Field directed call parks for the device. Available BLF-directed call parks depend on the device's Phone Button Template. Create BLF-directed call parks in Call Routing > Directed Call Parks on CUCM before configuring them in this panel. The available BLF-directed call parks match those created for each specific Route Partition Name. |
Dual Mode Settings | These settings display only for phones that support Dual Mode, and allow you to configure mobile identity and remote destinations. |
Certificate Authority Functions | The settings on this panel are only relevant to a Dual Mode Phone, Spark Remote Device, or CTI Remote Device, and allows you to enter enter the relevant Mobile Identity and Remote Destination (or CTI Remote Destination) parameters for the device. These parameters include Name, Destination Number, Owner User ID, Dual Mode Device Name (or CTI Remote Device), and Answer Too Soon and Too Late Timers. The date-time value must be added manually as: CCYY:MM:DD:HH:MM |
Note
Delete a Phone
This procedure deletes one or more phones or phone settings.
Log in as a Customer or Site administrator.
Note
If you're logged in as the Customer admin for a specific site, all fields described in this procedure are available to you. If you're logged in as the Site admin, only a subset of fields are available to you.
Choose a site.
Go to (default menus) Subscriber Management > Phones.
Choose one of the following methods to delete phones or phone settings:
Note
Deleting a phone removes the remote destination first so that the VOSS Automate cache remains in sync with CUCM.
Lines are not affected when a phone is deleted.
Certificate Authority Functions
This table provides details on the available fields for Certificate Authority Functions when adding or configuring phones.
Title | Description |
---|---|
Certificate Status | Shows the current security certificate status of the phone. The field is read-only. |
Certificate Operation * | From the drop-down list box, choose one of the following options: No Pending Operation: Displays when no certificate operation is occurring (default setting). Install/Upgrade: Installs a new or upgrades an existing locally significant certificate in the phone. Delete: Deletes the locally significant certificate that exists in the phone. Troubleshoot: Retrieves the locally significant certificate (LSC) or the manufacture installed certificate (MIC), so you can view the certificate credentials in the CAPF trace file. If both certificate types exist in the phone, Cisco Unified CM creates two trace files, one for each certificate type. By choosing the Troubleshooting option, you can verify that an LSC or MIC exists in the phone. For more information on CAPF operations, see the Cisco Unified Communications Manager Security Guide. Default: No Pending Operation |
Authentication Mode | This field allows you to choose the authentication method that the phone uses during the CAPF certificate operation. From the drop-down list box, choose one of the following options: By Authentication String: Installs/upgrades, deletes, or troubleshoots a locally significant certificate only when the user enters the CAPF authentication string on the phone. By Null String: Installs/upgrades, deletes, or troubleshoots a locally significant certificate without user intervention. This option provides no security; Cisco strongly recommends that you choose this option only for closed, secure environments. By Existing Certificate (Precedence to LSC): Installs/upgrades, deletes, or troubleshoots a locally significant certificate if a manufacture-installed certificate (MIC) or locally significant certificate (LSC) exists in the phone. If a LSC exists in the phone, authentication occurs via the LSC, regardless whether a MIC exists in the phone. If a MIC and LSC exist in the phone, authentication occurs via the LSC. If a LSC does not exist in the phone, but a MIC does exist, authentication occurs via the MIC. Before you choose this option, verify that a certificate exists in the phone. If you choose this option and no certificate exists in the phone, the operation fails. At any time, the phone uses only one certificate to authenticate to CAPF even though a MIC and LSC can exist in the phone at the same time. If the primary certificate, which takes precedence, becomes compromised for any reason, or, if you want to authenticate via the other certificate, you must update the authentication mode. By Existing Certificate (Precedence to MIC): Installs, upgrades, deletes, or troubleshoots a locally significant certificate if a LSC or MIC exists in the phone. If a MIC exists in the phone, authentication occurs via the MIC, regardless whether a LSC exists in the phone. If a LSC exists in the phone, but a MIC does not exist, authentication occurs via the LSC. Before you choose this option, verify that a certificate exists in the phone. If you choose this option and no certificate exists in the phone, the operation fails. Note The CAPF settings that are configured in the Phone Security Profile window interact with the CAPF parameters that are configured in the Phone Configuration window. Default: By Null String |
Title | Description |
---|---|
Authentication String | If you chose the By Authentication String option in the Authentication Mode drop-down list box, this field applies. Manually enter a string or generate a string by clicking the Generate String button. Ensure that the string contains 4 to 10 digits. To install, upgrade, delete, or troubleshoot a locally significant certificate, the phone user or administrator must enter the authentication string on the phone. |
Authentication Server | Enter the URL that the phone uses to validate requests that are made to the phone web server. If you do not provide an authentication URL, the advanced features on the Cisco Unified IP Phone that require authentication will not function. By default, this URL accesses a Cisco Unified Communications Self Care Portal window that was configured during installation. Leave this field blank to accept the default setting. |
Key Order | keyOrder can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot. Default: RSA Only |
Key Size (Bits) | For this setting that is used for CAPF, choose the key size for the certificate from the drop-down list box. The default setting equals 1024. Other options include 512 and 2048. If you choose a higher key size than the default setting, the phones take longer to generate the entropy that is required to generate the keys. Key generation, which is set at low priority, allows the phone to function while the action occurs. Depending on the phone model, you may notice that key generation takes up to 30 or more minutes to complete. Note The CAPF settings that are configured in the Phone Security Profile window interact with the CAPF parameters that are configured in the Phone Configuration window. Default: 1024 |
EC Key Size (Bits) | ecKeySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot. Default: 384 |
Operation Completes By | The completion deadline for the operation (CCYY:MM:DD:HH:MM) |
View and Update Phone Vendor Config Settings
The Vendor Config settings will display if the Field Display Policy (FDP) allows it.
You can access the vendor configuration settings for a phone as follows:
In the Admin Portal, go to (default menus) Subscriber Management > Phones.
On the Phones list view, click on a phone to open its settings.
On the Phones page, locate and then click on Vendor Config to open the configuration screen:
Enable or disable settings, as required. Ensure you're setting values correctly for Bulk Loaders, the API, or in custom Configuration Templates, where values must be defined as key-value pairs:
On CUCM, in some cases the value 0 is "Enabled" and in other cases 0 is "Disabled".
It is recommended that settings on CUCM are configured manually on a sample phone to the value you want, before exporting the phone. Then use the example settings as the basis for your Bulk Loaders, API, or custom Configuration Templates.
The required value may change depending on the setting being applied, for example:
To enable the "Web Access" for a phone, configure the following:
To disable "Web Access" for a phone, configure the following:
To enable "Settings Access", configure the following:
To disable "Settings Access", configure the following:
Generate Problem Reporting Tool (PRT)
Individual phones can have the Problem Reporting Tool (PRT) triggered to generate PRT log collection on the phone and upload it to the log server configured on the Unified CM in the "Customer support upload URL" parameter at the Enterprise, Profile, or Device level.
Sync in Phone Updates from CUCM
After you make changes to any phone model specific data in CUCM, for example by loading a new BAT file, editing phone button templates, security profiles, and so on, then in order to utilize that data in VOSS Automate, you need to do a sync of the CUCM.
Include the following models in the data sync (depending on what you changed):
Models | Notes |
---|---|
device/cucm/PhoneType | Should always be included. This includes the expansion models as well as the phone types. |
device/cucm/PhoneButtonTemplate | Include if button templates were changed. |
device/cucm/PhoneSecurityProfile | Include if phone security profiles were modified |
Perform a full sync or full import to make the changes available in VOSS Automate. However, between full syncs, it is best practice to create a sync setup with a model type list that includes the above model types. This allows you to run an ad-hoc sync with a very limited scope as needed - if changes are made in the CUCM that require a sync.
If adding new phone types to the system, you may also need to edit your device groups and entitlement profiles (if used) to have them show as options to the correct users.
Phone Onboarding with Cisco Activation Codes
VOSS Automate supports the Cisco Unified CM (CUCM) capability for device onboarding using Activation Codes. This provides a simplified method to register a new phone in the system. This is supported from CUCM version 12.5 and later.
This feature allows administrators to create phones without MAC addresses and then share automatically generated activation codes with end users via Self Service or email. The end user can then enter the activation code into the physical device to initiate auto registration.
Once the phone has been activated and registered, the correct phone association takes place in VOSS Automate.
For more information on the detailed functionality of the Cisco Activation Code Device Onboarding capability, including supported devices, refer to the Cisco documentation.
The setup of the feature has been incorporated into our various Subscriber/Phone Management capabilities:
Note
The selected phone type must also be included in the Subscriber's entitlement profile.
The high-level setup steps in VOSS Automate for phone onboarding with Cisco Activation Codes are as follows:
Complete the initial setup and enable the phone type(s) for activation code use
Complete the per Subscriber/Device setup to prepare the phone for onboarding:
Once enabled, you can add the phone, using any of the prescribed Subscriber Management methods (see above), making sure to select the Use Activation Code Onboarding check box. This will remove the device name as a BATXXXXXXXXXXXX device name will be generated when adding the phone.
Once the phone is successfully added, an activation code is generated and displayed along with the code expiry time on the relevant Phones form (Subscriber Management > Phones).
Note
The phone activation code must be used to register the phone before the specified expiry date.
The activation code is available in the end user's self service if the device was associated to a user. Alternatively email the activation code to the end user.
The end user registers the phone by entering the activation code into the physical device.
To see the list of phones that have been setup for activation codes but not yet activated, you can filter the phones list view for device names starting with, BAT, as once they register they have the appropriate device name prefix (e.g. SEP).
If the Enhanced INI Filtering feature is enabled, administrators have access to the Inventory Filter dropdown list menu for lines on the following forms:
The filter would typically be used to show a filtered, shorter dropdown list of directory numbers.
Note
If the Internal Number Inventory (INI) feature is not enabled, Enhanced INI Filtering will not be applied and all the list of numbers are obtained from the device.
The following options are available in the Inventory Filter list:
Default
This filter - enabled by default - corresponds with the standard filter of Directory Numbers:
Show Unused Numbers with Associated E164's (Site Only)
Show Unused Numbers with Associated E164's
Show Used Numbers (Site Only)
Show Used Numbers
Show Numbers belonging to this Subscriber
After you make changes to any phone model specific data in Unified CM, for example by loading a new BAT file, editing phone button templates, security profiles, and so on, then in order to utilize that data in VOSS Automate, you need to do a sync of the Unified CM.
Include the following models in the data sync - depending on what you changed:
If you do a full sync or full import this will make the changes available in VOSS Automate. However, between full syncs, it is best practice to create a sync setup with a model type list that includes the above model types. This allows you to run an ad-hoc sync with a very limited scope as needed - if changes are made in the Unified CM that require a sync.
If adding new phone types to the system, you may also need to edit your device groups and entitlement profiles (if used) to have them show as options to the correct users.
Phone based relation.
Title | Description | Details | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Phone | Group Assigned by FDP |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Registration Status | Registration status of the phone |
|
|||||||||||||||||||||||||||||||||||||||||||||||
IP Address | IP address of the phone |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Device Name * | Enter a name to identify software-based telephones, H.323 clients, and CTI ports. For device names that are not based on a MAC address, as a general rule, you can enter 1 to 15 characters comprised of alphanumeric characters (a-z, A-D, 0-9). In most cases you can use dot (.), dash (-), and underscore (_) as well. Tip Because the rules for the device name field depend on the device type, Cisco recommends that you see the product documentation to determine which character set is valid for your device, as well as the number of characters allowed. For example, when you configure the device name for the Cisco Unified Personal Communicator, make sure that the name starts with UPC. Note Ensure that the device name of a Cisco Unified Mobile Communicator does not exceed 15 characters. If the device name of a Cisco Unified Mobile Communicator exceeds 15 characters, migration of this device will fail upon upgrade to a different release of Cisco Unified Communications Manager. If an existing Cisco Unified Mobile Communicator device name specifies a longer name, shorten the device name to 15 or fewer characters. Cisco Unified Mobile Communicator supports dual mode phones. The preceding limit of 15 characters also applies to Cisco Unified Mobile Communicator dual mode. When the MI for a dual mode phone is longer than 15 characters, the cellular network rejects the phone registration. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Product * | Product ID string. read-only except when creating a device. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Description | Identify the purpose of the device. You can enter the user name (such as John Smith) or the phone location (such as Lobby) in this field. For Cisco VG248 gateways, begin the description with VGC<mac address>. The description can include up to 128 characters in any language, but it cannot include double-quotes ("), percentage sign (%), ampersand (&), back-slash (\), or angle brackets (<>). |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Device Protocol * | Protocol option is read-only,except when creating a device. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Phone Button Template * | Choose the appropriate phone button template. The phone button template determines the configuration of buttons on a phone and identifies which feature (line, speed dial, and so on) is used for each button. Cisco Unified CM does not make this field available for H.323 clients or CTI ports. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Device Security Profile | Choose the security profile to apply to the device. You must apply a security profile to all phones that are configured in Cisco Unified Communications Manager Administration. Installing Cisco Unified Communications Manager provides a set of predefined, nonsecure security profiles for auto-registration. To enable security features for a phone, you must configure a new security profile for the device type and protocol and apply it to the phone. If the phone does not support security, choose a nonsecure profile. To identify the settings that the profile contains, choose System > Security Profile > Phone Security Profile. Note The CAPF settings that are configured in the profile relate to the Certificate Authority Proxy Function settings that display in the Phone Configuration window. You must configure CAPF settings for certificate operations that involve manufacturer-installed certificates (MICs) or locally significant certificates (LSC). See the Cisco Unified Communications Manager Security Guide for more information about how CAPF settings that you update in the phone configuration window affect security profile CAPF settings. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Softkey Template | Choose the appropriate softkey template. The softkey template determines the configuration of the softkeys on Cisco Unified IP Phones. Leave this field blank if the common device configuration contains the assigned softkey template. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Common Phone Profile * | From the drop-down list box, choose a common phone profile from the list of available common phone profiles. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Calling Search Space | From the drop-down list box, choose the appropriate calling search space (CSS). A calling search space comprises a collection of partitions that are searched to determine how a dialed number should be routed. The calling search space for the device and the calling search space for the directory number get used together. The directory number CSS takes precedence over the device CSS. Note When set to <none>, Unified CM uses the device mobility calling search space, which is configured on the device pool. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Device Pool Name * | Choose the device pool to which you want this phone assigned. The device pool defines sets of common characteristics for devices, such as region, date/time group, and softkey template. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
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 Cisco Unified IP Phone. A location setting of Hub_None means that the locations feature does not keep track of the bandwidth that this Cisco Unified IP Phone consumes. 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. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
BLF Presence Group |
|
||||||||||||||||||||||||||||||||||||||||||||||||
SIP Profile | Choose the default SIP profile or a specific profile that was previously created. SIP profiles provide specific SIP information for the phone such as registration and keepalive timers, media ports, and do not disturb control. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Digest User | This field is applicable only to SIP phones. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Device Mobility Mode * | From the drop-down list box, turn the device mobility feature on or off for this device or choose Default to use the default device mobility mode. Default setting uses the value for the Device Mobility Mode service parameter for the device. Click View Current Device Mobility Settings to display the current values of these device mobility parameters: Cisco Unified Communications Manager Group Roaming Device Pool Location Region Network Locale AAR Group AAR Calling Search Space Device Calling Search Space Media Resource Group List SRST Default: Default |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Rerouting Calling Search Space | From the drop-down list box, choose a calling search space to use for rerouting. The rerouting calling search space of the referrer gets used to find the route to the refer-to target. When the Refer fails due to the rerouting calling search space, the Refer Primitive rejects the request with the "405 Method Not Allowed" message. The redirection (3xx) primitive and transfer feature also uses the rerouting calling search space to find the redirect-to or transfer-to target. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
SUBSCRIBE Calling Search Space | Supported with the Presence feature, the SUBSCRIBE calling search space determines how Cisco Unified CM routes presence requests that come from the phone. This setting allows you to apply a calling search space separate from the call-processing search space for presence (SUBSCRIBE) requests for the phone. From the drop-down list box, choose the SUBSCRIBE calling search space to use for presence requests for the phone. All calling search spaces that you configure in Cisco Unified Communications Manager Administration display in the SUBSCRIBE Calling Search Space drop-down list box. If you do not select a different calling search space for the end user from the drop-down list, the SUBSCRIBE calling search space defaults to None. To configure a SUBSCRIBE calling search space specifically for this purpose, you configure a calling search space as you do all calling search spaces. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
DND Option | When you enable DND on the phone, this parameter allows you to specify how the DND features handle incoming calls: Call Reject—This option specifies that no incoming call information gets presented to the user. Depending on how you configure the DND Incoming Call Alert parameter, the phone may play a beep or display a flash notification of the call. Ringer Off—This option turns off the ringer, but incoming call information gets presented to the device, so the user can accept the call. Use Common Phone Profile Setting—This option specifies that the DND Option setting from the Common Phone Profile window will get used for this device. Note For 7940/7960 phones that are running SCCP, you can only choose the Ringer Off option. For mobile devices and dual-mode phones, you can only choose the Call Reject option. When you activate DND Call Reject on a mobile device or dual-mode phone, no call information gets presented to the device. Default: Ringer Off |
|
|||||||||||||||||||||||||||||||||||||||||||||||
DND Incoming Call Alert | When you enable the DND Ringer Off or Call Reject option, this parameter specifies how a call displays on a phone. From the drop-down list, choose one of the following options: None—This option specifies that the DND Incoming Call Alert setting from the Common Phone Profile window gets used for this device. Disable—This option disables both beep and flash notification of a call, but, for the DND Ringer Off option, incoming call information still gets displayed. For the DND Call Reject option, no call alerts display, and no information gets sent to the device. Beep Only—For an incoming call, this option causes the phone to play a beep tone only. Flash Only—For an incoming call, this option causes the phone to display a flash alert. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Do Not Disturb | Check this check box to enable Do Not Disturb on the phone. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Enable Extension Mobility | Check this check box if this phone supports extension mobility. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Is Dual Mode | Read-only tag. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Allow CTI Control Flag | Check this check box to allow CTI to control and monitor this device. If the associated directory number specifies a shared line, the check box should be enabled as long as at least one associated device specifies a combination of device type and protocol that CTI supports. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Hot line Device | This tag is applicable for PLAR-supporting SIP/SCCP phones only |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Mobility User ID | From the drop-down list box, choose the user ID of the person to whom this dual-mode phone is assigned. Note The Mobility User ID configuration gets used for the Cisco Unified Mobility and Mobile Voice Access features for dual-mode phones. The Owner User ID and Mobility User ID can differ. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Primary Phone * | Choose the physical phone that will be associated with the application, such as IP communicator or Cisco Unified Personal Communicator. When you choose a primary phone, the application consumes fewer device license units and is considered an "adjunct" license (to the primary phone). |
|
|||||||||||||||||||||||||||||||||||||||||||||||
User Locale | From the drop-down list box, choose the locale that is associated with the phone user interface. The user locale identifies a set of detailed information to support users, including language and font. Cisco Unified CM makes this field available only for phone models that support localization. Note If no user locale is specified, Cisco Unified Communications Manager uses the user locale that is associated with the common device configurations. If the users require that information be displayed (on the phone) in any language other than English, verify that the locale installer is installed before configuring user locale. See the Cisco Unified Communications Manager Locale Installer documentation. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Network Locale | From the drop-down list box, choose the locale that is associated with the phone. The network locale contains a definition of the tones and cadences that the phone in a specific geographic area uses. Cisco Unified CM makes this field available only for phone models that support localization. Note If no network locale is specified, Cisco Unified CM uses the network locale that is associated with the device pool. If users require that country-specific tones be played (on the phone), verify that the locale is installed before configuring the network locale. See the Cisco Unified Communications Manager Locale Installer documentation. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Owner User ID | From the drop-down list box, choose the user ID of the assigned phone user. The user ID gets recorded in the call detail record (CDR) for all calls made from this device. Assigning a user ID to the device also moves the device from "Unassigned Devices" to "Users" in the License Usage Report. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Vendor Config |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Key |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Value |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Lines |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Line | 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. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Link To Line | Link to the line resource |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Dirn | Only uuid attribute is returned in response |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Pattern * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Route Partition Name * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Position |
|
||||||||||||||||||||||||||||||||||||||||||||||||
E164Mask |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Label |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Display |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Display Ascii |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Associated Endusers |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Enduser |
|
||||||||||||||||||||||||||||||||||||||||||||||||
User Id * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Speeddials |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Speeddial |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Dirn * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Position |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Label |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Services |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Service |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Service Name Ascii |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Url |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Url Button Index |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Url Label |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Busy Lamp Fields |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Busy Lamp Field |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Blf Dest | 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. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Blf Dirn | 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. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Position |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Label |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Route Partition |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Blf Directed Call Parks |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Blf Directed Call Park |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Label |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Position |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Directed Call Park Id | Only the uuid attribute is read |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Directed Call Park Dn And Partition |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Dn Pattern * |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Route Partition Name |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Remote Destinations | Group Assigned by FDP |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Remote Destination |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Name | Enter a name that identifies the remote destination or mobile identity. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Destination Number * | Enter the PSTN telephone number for the destination. Include the area code and any additional digits that are required to obtain an outside line. Maximum field length equals 24 characters; individual characters can take the values 0-9, *, #, and +. Cisco recommends that you configure the caller ID of the remote destination. If the administrator configures the Incoming Calling Party settings in the Cisco Unified Communications Manager gateway, trunk, or device pool to globalize the incoming calling party number, configure the Destination Number of the remote destination in the E.164 format. Example: For a remote destination with US area code 408 and destination number 5552222, configure the Destination Number as +14085552222. Additionally, if globalized destination numbers are in use, set the Matching Caller ID with Remote Destination service parameter to Complete Match. Note Add the necessary translation pattern or route patterns to route the destination number. You can also enter a directory URI in this field. Keep in mind that if you enter a directory URI in this field, you must also configure a domain-based SIP route pattern. Note When you place a call from a remote destination, the caller ID of the destination phone displays the directory number that is associated with the calling directory URI rather than the directory URI. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Dual Mode Device Name |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Answer Too Soon Timer * | Enter the minimum time in milliseconds that Cisco Unified Communications Manager requires the mobile phone to ring before answering the call. This setting accounts for situations where the mobile phone is switched off or is not reachable, in which case the network may immediately divert the call to the mobile phone voice mail. If the mobile phone is answered before this timer expires, Cisco Unified Communications Manager pulls the call back to the enterprise. Range: 0 - 10,000 milliseconds Default: 1,500 milliseconds Default: 1500 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Answer Too Late Timer * | Enter the maximum time in milliseconds that Cisco Unified Communications Manager allows for the mobile phone to answer. If this value is reached, Cisco Unified Communications Manager stops ringing the mobile phone and pulls the call back to the enterprise. Range: 0 and 10,000 - 300,000 milliseconds Default: 19,000 milliseconds If the value is set to zero, the timer is not started. Default: 19000 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Delay Before Ringing Timer * | Enter the time that elapses before the mobile phone rings when a call is extended to the remote destination. Range: 0 - 30,000 milliseconds Default: 4,000 milliseconds Tip When a hunt group is in use, the lines ring only for a short period of time. You may need to manipulate the Delay Before Ringing Timer setting and make it zero to allow a remote destination call to be established, ring, and answer, before the hunt list timer expires and pulls the call back. Default: 4000 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Time Zone | From the drop-down list box, choose a time zone to use for this remote destination or mobile identity. Note The time-of-day access feature uses the time zone that you choose for this remote destination or mobile identity to allow or to block calls to this remote destination or mobile identity. Default: Etc/GMT |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Mobile Smart Client Name | This tag is not applicable for dualmode phones |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Mobility Profile | From the drop-down list box, choose the mobility profile that you want to use for this remote destination. To configure a mobility profile, use the Call Routing > Mobility > Mobility Profile menu option. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Single Number Reach Voicemail Policy | Configures how mobile device users answer calls that terminate on a remote destination (RD). This feature provides users with a single enterprise voice mail box for their enterprise mobility if the RD call reaches an external voice mail system. Available options are as follows: Use System Default Timer Control User Control Note For User Control to work, you must set the Enable Enterprise Feature Access service parameter to TRUE. Default: Use System Default |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Dial Via Office Reverse Voicemail | Configures how dual mode device users answer Dial-via-Office Reverse (DVO-R) calls that terminate on the Mobile Identity (MI). This feature provides users with a single enterprise voicemail box for their enterprise mobility if the RD call reaches an external voice mail system. Available options are as follows: Use System Default Timer Control User Control Default: Use System Default |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Enable Mobile Connect | Check the check box to allow an incoming call to ring your desk phone and remote destination at the same time. For detailed task information about Cisco Unified Mobility and Extend and Connect, see the Feature Configuration Guide for Cisco Unified Communications Manager. Default: True |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Mobile Phone | Check the check box if you want calls that the desk phone answers to be sent to your mobile phone as the remote destination. Checking this check box ensures that, if Send Call to Mobile Phone is specified (by using the Mobility softkey for remote destination pickup), the call gets extended to this remote destination. Note This check box does not apply to dual-mode phones that are running SIP nor to dual-mode phones that are running SCCP, such as the Nokia S60. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Line Associations | 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. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Line Association |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Pattern | The directory number to be associated. This directory number must be already associated to remote destination profile. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Route Partition Name |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Enable Extend And Connect | While UPDATE set it to false if you want to delete Enable Extend and Connect.Use only while update |
|
|||||||||||||||||||||||||||||||||||||||||||||||
CTI Remote Device | ctiRemoteDeviceName tag will be used to associate either CTI Remote Device or a Cisco Spark Remote Device with a Remote Destination |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Owner User Id | 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 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Enable Unified Mobility | While UPDATE set it to false if you want to delete enable Unified Mobility feature.Use only while update |
|