.. _phones: Cisco phones -------------- .. _19.1.1|EKB-792: .. _19.1.1|VOSS-349: .. _19.1.1|VOSS-370: .. _19.1.2|EKB-2288: .. _20.1.1|EKB-4666: .. _19.3.4|EKB-7364: .. _21.2|EKB-10481: .. _21.3-PB1|EKB-12904: .. _21.4-PB4|EKB-17315: .. _25.1|VOSS-1210: .. _25.2|EKB-23460: .. _25.2|EKB-25127: .. tip:: :ref:`use-action-search-to-navigate-automate` Overview ........... This topic describes how to manage Cisco phones in the Automate Admin portal. View phones ................. This procedure displays existing phones. 1. Log in to the Admin portal as a Provider, Customer, or Site admin. .. note:: Only a subset of fields are available to Site admins. 2. Go to the **Cisco Phones** list view. 4. View existing phones. .. image:: /src/images/cisco-phones-list.png .. note:: An administrator with the required access profile can click **Fetch real-time phone status** on the toolbar to fetch the Cisco UCM phone IP address and status *directly* from the Cisco UCM. Data is fetched in real-time and displays read-only values in the following columns: .. image:: /src/images/fetch-realtime-phone-status.png * **Registration Status** column (for example, "None", "UnRegistered with CUCM-11-5-IP2", "Registered with CUCM-11-5-IP2") * **IP Address** column Fetched data is not cached or stored in the database, and can't 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 via the **Cisco Phones** page. .. note:: It is recommended that you use *Smart Add phone* to add standalone phones (not associated to any user) and use Quick User to add phones to users. See :ref:`smart-add-phone-overview` and :ref:`cisco-quick-user`. .. rubric:: Before you start Before adding Cisco phones in Automate, add and configure the following items on Cisco UCM, and then import these items into Automate: * Softkey templates (Softkey templates can be set up on Cisco UCM or in Automate) * Phone button templates * Service parameters and enterprise parameters for user services * Custom SIP profiles * Service profiles for Jabber * Phone services .. rubric:: To add a phone (Cisco UCM users): 1. Log in to the Admin portal as a Provider, Customer, or Site admin. .. note:: Only a subset of fields are available to Site admins. 2. Go to the **Cisco Phones** list view. 3. Click the toolbar **Plus (+)** icon, then choose the hierarchy where you want to add the phone. 4. On the **Cisco Phones > New Record** page, fill out details for the phone you're adding: .. image:: /src/images/cisco-add-phone.png * On the **Phone** panel/tab: * Fill out the device name, including a prefix, for example, *SEP0C0011010003*, choose the product, for example, *Cisco 8865*, and (optionally), fill out a description. .. 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 Cisco UCM. Install the COP file only once for the Cisco UCM instance where the endpoint is added. In Automate you will need to import the phone button template from Cisco UCM. When adding a device name, add a prefix, such as SEP, before the mac address. For example, if the mac address is *000000000AB1*, the device name must be *SEP000000000AB1*. If the Global Setting **Prevent Duplicate MAC Addresses for Cisco Phones** is enabled for the current hierarchy, a check will also be carried out for duplicates in all clusters. See :ref:`global-settings`. * Choose a device protocol. .. note:: 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 user, or when adding a phone to an existing user. * Choose a phone button template for automatic configuration of settings, and a device pool name. * If this is a standalone phone, leave **Owner User ID** blank, else, choose a user to associate with this phone. .. note:: If you're adding the phone at a site, the user (Owner User ID) may exist at a higher level in the hierarchy, such as customer level. * In the **Lines** panel, click the Plus (+) icon to add a line, then configure line settings: * Choose a line template. * Choose an inventory filter. Find out more about number inventory filters at :ref:`manage-number-filters`. * Choose a directory number (mandatory). .. note:: An inventory number filter can be applied to this field to limit the directory numbers, including a filter that will only show numbers reserved for or belonging to a user you're working with. You may only see numbers reserved for or belonging to this user. See :ref:`ini-reserve-for`. To find out more about enabling or managing number inventory filters, see :ref:`manage-number-filters`. * Specify a label for the line. * Specify a display. 5. Click **Save** to add the phone. .. rubric:: Related topics * :ref:`manage-number-filters` Update a phone ................. This procedure updates an existing phone. 1. Log in to the Admin portal as a Provider, Customer, or Site admin. .. note:: Only a subset of fields are available to Site admins. 2. Go to the **Cisco Phones** summary list view. 3. Click on the phone you wish to update to open its settings. .. image:: /src/images/cisco-phones.png 4. View existing settings, and update as required. Note the following: * Displayed fields are based on the device type and device protocol (for example, SIP or SCCP). * Supported features available for each phone type are retrieved from the related Cisco UCM. .. tabularcolumns:: |p{3cm}|p{12cm}| +---------------------------------+---------------------------------------------------------------------+ | 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 | * Default values are applied for some fields (such as Device | | | Protocol, BAT Phone Template, and Device Security Profile), based | | | on the device (product) type. | | | * **Vendor Config** settings are related to the phone type. | | | * To override the default **Phone Button Template**, either choose | | | another template, or enter a custom value. The new value is | | | applied on the UCM if it allows that phone type. If you don't | | | see a template that you're looking for in the drop-down (for | | | example, for **Phone Button Template**, **Device Security | | | Profile** or **SIP Profile**), edit the template on UCM, and | | | then sync the template into Automate to have it appear in | | | the drop-down. | | | * It is possible to choose an Owner User ID at a higher | | | hierarchy, for example, if the phone is at the site, you can | | | choose an Owner User ID at the customer level and save your | | | changes. | +---------------------------------+---------------------------------------------------------------------+ | 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. | | | | | | 1. At **Pattern**, select a directory number. | | | Line patterns are filtered based on the partition type. | | | 2. At **Monitoring CSS Name**, set the Monitoring Calling Search | | | Space as the CSS that is configured in the Calling Search Space | | | field on the **Lines** page. | | | 3. At the **Busy Trigger** field, enter a busy trigger value, for | | | example, **1**. | | | 4. At the **Max Num Calls** field, enter the maximum number of | | | calls value, for example, **2**. | +---------------------------------+---------------------------------------------------------------------+ | 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 Cisco UCM. | +---------------------------------+---------------------------------------------------------------------+ | 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/Cisco UCM/IpPhoneService, and populates the URL field. | +---------------------------------+---------------------------------------------------------------------+ | | In this panel you can configure busy lamps for the device. | | Busy Lamp Fields | Available busy lamp fields depend on the device's | | | **Phone Button Template**. | +---------------------------------+---------------------------------------------------------------------+ .. tabularcolumns:: |p{3cm}|p{12cm}| +---------------------------------+---------------------------------------------------------------------+ | 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 via **Directed Call Parks** on Cisco UCM 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:: * For more information about Certificate Authority Functions, see :ref:`certificate-authority-functions-fields`. * When updating the phone, the phone and user remote destination are updated. * Where a phone activation code has expired and needs to be generated, the user's dummy phone must be deleted and a new dummy phone re-added, following activation steps: :ref:`phone-reg-activation-code`. * For phones supporting the activation codes and the MRA feature will have the ``allowMraMode`` and ``mraServiceDomain`` fields available provided a sync has been run that updates the phone types in Automate with the supported feature set. * If you need to enable Extend and Connect in Automate, perform these steps while creating a CTI Remote Device: 1. Fill out the **Device Name**. For example, CTIRD. 2. Choose the product as **CTI Remote Device**. 3. Choose the **Owner User ID** from the drop-down. 4. Choose the **SUBSCRIBE Calling Search Space** name from the drop-down. 5. Choose the **Rerouting Calling Search Space** name from the drop-down. 5. Save your changes. .. _delete-phones: Delete a phone ................ This procedure deletes one or more Cisco phones or phone settings. 1. 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. 2. Choose a site. 3. Go to **Cisco Phones**. 4. Choose one of the following methods to delete phones or phone settings: * Select the checkbox for the phone you want to delete (one or more), then confirm the deletion. * Open the settings for a specific phone and remove its settings. Save your changes. .. note:: Deleting a phone removes the remote destination first so that the Automate cache remains in sync with Cisco UCM. Lines are not affected when a phone is deleted. .. _certificate-authority-functions-fields: Certificate authority functions ................................... The table provides details on the available fields for Certificate Authority Functions when adding or configuring phones. .. tabularcolumns:: |p{4cm}|p{11cm}| +----------------+-----------------------------------------------+ | Title | Description | +================+===============================================+ | Certificate | Shows the current security certificate status | | Status | of the phone. The field is read-only. | +----------------+-----------------------------------------------+ | | 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 | | Certificate | (LSC) or the manufacture | | Operation * | 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 | +----------------+-----------------------------------------------+ .. tabularcolumns:: |p{4cm}|p{11cm}| +----------------+-----------------------------------------------+ | Title | Description | +================+===============================================+ | | Defines the | | | 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 you fill out the | | | CAPF authentication string on the phone. | | | | | | * By Null String: Installs, upgrades, | | | deletes, or troubleshoots a locally | | | 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 or 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 of 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. | | Authentication | Before choosing this option, verify that a | | Mode | 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 of whether a LSC exists in the | | | 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. The CAPF settings | | | configured in the Phone Security Profile | | | window interact with the CAPF parameters | | | that are configured in the Phone | | | Configuration window. | | | | | | Default: By Null String | +----------------+-----------------------------------------------+ .. tabularcolumns:: |p{4cm}|p{11cm}| +-----------------+----------------------------------------+ | Title | Description | +=================+========================================+ | | 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 | | Authentication | Generate String button. Ensure | | String | 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. | +-----------------+----------------------------------------+ | | 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 | | Authentication | Phone that require authentication | | Server | will not function. By default, | | | this URL accesses a UCM | | | Self Care Portal | | | window that was configured during | | | installation. Leave this field | | | blank to accept the default | | | setting. | +-----------------+----------------------------------------+ | | ``keyOrder`` can be updated only if | | | ``certificateOperation`` field is | | Key Order | Install/Upgrade,Delete or | | | Troubleshoot. Default: RSA Only | | | | +-----------------+----------------------------------------+ | | 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 | | Key Size (Bits) | 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 | +-----------------+----------------------------------------+ | | ``ecKeySize`` can be updated only if | | EC Key Size | ``certificateOperation`` field is | | (Bits) | Install/Upgrade,Delete or | | | Troubleshoot. Default: 384 | | | | +-----------------+----------------------------------------+ | | | | Operation | The completion deadline for the | | Completes By | operation (CCYY:MM:DD:HH:MM) | | | | +-----------------+----------------------------------------+ View and update phone vendor config settings ............................................... **Vendor Config** settings display on the **Phone** tab/panel if the Field Display Policy (FDP) allows it. The available settings depend on the phone type. .. note:: Where admin password credentials may be required in any phone type's vendor config settings, these are masked. 1. In the Admin portal, go to the **Cisco Phones** list view. 2. Click on a phone to open its settings. #. On the **Phones** tab/panel 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 Cisco UCM, in some cases the value ``0`` is "Enabled" and in other cases ``0`` is "Disabled". * It is recommended that settings on Cisco UCM 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 CFTs. * The required value may change depending on the setting being applied, for example: To *enable* the "Web Access" for a phone, configure the following: * Key: ``webAccess`` * Value: ``0`` To *disable* "Web Access" for a phone, configure the following: * Key: ``webAccess`` * Value: ``1`` To *enable* "Settings Access", configure the following: * Key: ``settingsAccess`` * Value: ``1`` To *disable* "Settings Access", configure the following: * Key: ``settingsAccess`` * Value: ``0`` .. _generate-prt-phones: 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. 1. Select the phone from the **Cisco Phones** list view. 2. Click the **Generate Prt Phone** action to generate PRT log collection. Sync in Cisco phone updates from Cisco UCM ............................................ After you make changes to any phone model specific data in Cisco UCM, 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 Automate, you need to do a sync of the UCM. 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 modules 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 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 UCM 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-reg-activation-code: Phone onboarding with Cisco activation codes ............................................... .. index:: Feature;Feature Phone Registration Activation Code .. index:: Phone Registration Activation Code (Feature) Automate supports the Cisco UCM capability for device onboarding using activation codes. This provides a simplified method to register a new phone in the system. This is supported from Cisco UCM 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 is activated and registered, the correct phone association takes place in 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 user/phone management capabilities: * Phones * Users * Quick Add User * Smart Add Phone .. note:: * The selected phone type must also be included in the user's entitlement profile. * When a device is added which supports Activation Codes and the option is chosen, Cisco UCM may be slow to respond with relevant Activation Code. In this instance, Automate will retry fetching the activation code 3 times with a 2 second wait in between. Once the activation code has been received, the retries will stop. .. _phone-reg-activation-code-workflow: Phone setup and onboarding workflow '''''''''''''''''''''''''''''''''''''' The high-level setup steps in Automate for phone onboarding with Cisco activation codes are as follows: 1. Initial setup - enabling phone types for activation code. #. Per user/device - setup of the phone details and generation of the activation code. #. Provide the activation code to the user for use to onboard the device. .. rubric:: Complete the initial setup and enable the phone type(s) for activation code use 1. Login as Customer administrator or higher. #. Navigate to the hierarchy level of the cluster(s) you want to enable. #. Enable activation code based registration for a target phone type: a. Go to **Device Defaults**. #. Click the **Model**, e.g. Cisco 7821 on which you want to enable the phone registration activation code feature. Note the device column in the list view to ensure it is the device type on the right UCM cluster. #. Select the **Prefer Act Code Over Auto Reg** checkbox. #. Click **Save**. .. rubric:: Complete the per user/device setup to prepare the phone for onboarding: 1. Once enabled, you can add the phone, using any of the prescribed user Management methods (see above), making sure to select the **Use Activation Code Onboarding** checkbox. 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 **Cisco Phones** settings page. .. 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).