.. _phones: 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: Add a Phone (CUCM) ...................... 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 :ref:`smart_add_phone_overview` and :ref:`quick-add-subscriber-cucm-users`. .. rubric:: 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: * Softkey templates (Softkey templates can be set up on CUCM or in VOSS Automate) * Phone button templates * Service parameters and enterprise parameters for subscriber services * Custom SIP profiles * Service profiles for Jabber * Phone services .. rubric:: To add a phone (CUCM 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. Choose the hierarchy. 3. Go to (default menus) **Subscriber Management > Phones**. 4. On the **Phones** summary list view, view 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: * **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 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 5. Click **Add** to open the phone configuration screen, then fill out phone details on the following tabs: .. tabularcolumns:: |p{3cm}|p{12cm}| +-------------------+-------------------------------------------------------+ | Tab | Description | +===================+=======================================================+ | | At **Device Name**, fill out a device name, and add | | | SEP before the mac address. For example, if the mac | | | address is 000000000AB1, the device name must be | | | SEP000000000AB1. | | | | | | Choose a product (for example, Cisco 7941), a device | | | protocol (for example, SIP), and a device pool name | | | (for example, **RSMSimPhone_DP**). | | | | | | If the **Product** type list doesn't contain the | | | phone or endpoint you want, then, in CUCM, you'll | | | need to install a COP file for the endpoint you want. | | Phone | Install | | | the COP file only once for the CUCM | | | instance where the endpoint is added. Then in | | | VOSS Automate, import the phone button template | | | from CUCM. | | | | | | .. 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 subscriber, or when adding a | | | phone to an existing subscriber. | | | | | | 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. | | | | | | Displayed fields 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 CUCM. | | | | | | To override the default **Phone Button Template**, | | | either choose another template, or enter a custom | | | value. The new value is applied on the CUCM 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 CUCM, and then sync the template into | | | VOSS Automate to have it appear in the drop-down. | | | | | | To enable Extend and Connect in VOSS 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. | +-------------------+-------------------------------------------------------+ | | This tab serves two purposes. | | | | | | 1. To show all the lines that are associated | | | with the device | | | 2. To associate lines with the device. | | Lines | | | | The Lines sections reflect the Lines object | | | in CUCM. 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. | | | | | | * From the **Pattern** drop-down, choose a directory | | | number. | | | * At the **Monitoring CSS Name** drop-down, set the | | | Monitoring Calling Search Space as the CSS that is | | | configured in the Calling Search Space field in | | | the **Lines** page. | | | * At the **Busy Trigger** field, enter a busy trigger | | | value, for example, **1**. | | | * At the **Max Num Calls** field, enter the maximum | | | number of calls value, for example, **2**. | +-------------------+-------------------------------------------------------+ | | Allows you to configure speed dials for the | | | device. Available speed dials depend on the | | Speed Dials | 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. | +-------------------+-------------------------------------------------------+ | | Allows you to configure busy lamps for the | | Busy Lamp Fields | device. Available busy lamp fields depend on | | | the device's **Phone Button Template**. | +-------------------+-------------------------------------------------------+ | | Allows you to configure Busy Lamp Field | | | directed call parks for the device. Available | | | BLF-directed call parks depend on the | | Blf Directed Call | device's **Phone Button Template**. Create | | Parks | 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. | +-------------------+-------------------------------------------------------+ .. tabularcolumns:: |p{3cm}|p{12cm}| +---------------------------------+---------------------------------------------------------------------+ | Tab | Description | +=================================+=====================================================================+ | | 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 | | Dual Mode Settings | 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. | +---------------------------------+---------------------------------------------------------------------+ | | 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 | | Certificate Authority Functions | 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`. 6. Save your changes to add the phone. Update a Phone ............... Note the following for updating a phone: * The system checks that a line exists when you add it. If it doesn't exist, the line is added. * The line edit form contains a hyperlink to the line settings that opens the Line relation details. Once you save your changes, the Phone page re-opens. Alternatively, you can use the browser Back button to return to the Phone editing page. * If your menu layout has more than one entry for line management (``relation/LineRelation``) and associated Field Display Policy, then the form opened by the Link to Line hyperlink applies the first one (searching from top to bottom) found in the menu layout. * The phone and User Remote Destination are updated. .. note:: If the required CUCM setting "Customer Support upload URL" is configured at the Enterprise, Profile, or Device level, you can use **Action > Generate Prt Phone** to send a Problem Report Tool (PRT) file to the upload URL. .. _delete_phones: Delete Phones ------------- This procedure deletes one or more phones, or phone settings. When phones are deleted: * The Remote Destination is removed first, so that the VOSS Automate cache remains in sync with the Cisco Unified Communications Manager (CUCM). * The phone is deleted. .. note:: Lines are not affected. 1. Log in as a customer or site level administrator. If you are logged on as the customer administrator for a specific site, you can see all the fields described in this procedure. If you are logged on as the site administrator, you can see a subset of the fields that are available on the interface. 2. Choose a site from the hierarchy breadcrumb. 3. Choose **Subscriber Management > Phones**. 4. Choose one of the following methods to delete phones or phone settings: * Choose an individual phone to be deleted by selecting its check box in the far left column, then clicking **Delete**. From the popup window, click **Yes** to confirm the deleted phone. * Delete multiple phones at once by selecting the relevant check boxes, then clicking **Delete**. From the popup window, click **Yes** to confirm the deleted phones. * Remove phone settings as required by removing them from the relevant tab of a selected phone. Click **Save**. When the delete action is complete, the phone disappears from the list. .. _certificate-authority-functions-fields: Certificate Authority Functions ................................... This 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 | +----------------+-----------------------------------------------+ | | 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 | | Authentication | MIC. Before you choose this | | Mode | 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 | +----------------+-----------------------------------------------+ .. 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 Cisco Unified | | | Communications 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 ............................................... 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: 1. In the Admin Portal, go to (default menus) **Subscriber Management > Phones**. 2. 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: * 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 **Phones** list view (default menu **Subscriber Management > Phones**): 2. Click the **Generate Prt Phone** action to generate PRT log collection. Phone Type Management --------------------- 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: * ``device/cucm/PhoneType`` - should always be included. .. note:: This includes the expansion modules as well as the phone types. * ``device/cucm/PhoneButtonTemplate`` - if button templates were changed * ``device/cucm/PhoneSecurityProfile`` - if phone security profiles were modified 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 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-reg-activation-code: Phone Onboarding with Cisco Activation Codes ............................................... .. index:: Feature;Feature Phone Registration Activation Code .. index:: Phone Registration Activation Code (Feature) 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: * Phones * Subscribers * Quick Add Subscriber * Smart Add Phone .. note:: The selected phone type must also be included in the Subscriber's entitlement profile. .. _phone-reg-activation-code-workflow: Setup and Onboarding Workflow '''''''''''''''''''''''''''''''' The high-level setup steps in VOSS Automate for phone onboarding with Cisco Activation Codes are as follows: 1. Initial setup - enabling Phone types for activation code. #. Per Subscriber/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. To 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 (default menus) **Apps Management > CUCM > 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** check box. #. Click **Save**. To complete the per Subscriber/Device setup to prepare the phone for onboarding: 1. 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).