.. _setup-CUCM-for-PBR:

Configure Cisco UCM for AutoRegistration and PBR
--------------------------------------------------

.. index:: Flowchart;Set up Phone Based Registration


.. tip:: 

   :ref:`use-action-search-to-navigate-automate`


Overview 
..........

This section describes phone-based registration (PBR) setup. 


.. rubric:: Related Topics

* :ref:`intro-PBR`


.. _pbr-voss-setup:



The flowchart provides the steps for this task: 


.. include:: pbr-install-workflow.uml






.. _Using_PBR_Setup_feature_to_configure_a_CUCM:

Using PBR setup to configure a UCM
......................................

Use the **PBR Setup** menu to automates the configuration of Cisco Unified Communications Manager (UCM) for 
AutoRegistration and Phone Based Registration.

1. In the Automate Admin portal, go to **PBR Setup**. 
2. Configure the following: 

.. tabularcolumns:: |p{4cm}|p{11cm}|

+------------------------------------------------------+--------------------------------------------+
| Setting                                              | Description                                |
+======================================================+============================================+
| CUCM IP Address                                      | IP Address of the publisher for the UCM    |
|                                                      | cluster.                                   |
+------------------------------------------------------+--------------------------------------------+
| Call Manager Group for Auto Reg                      | Name of UCM group for AutoReg.             |
+------------------------------------------------------+--------------------------------------------+
| Call Manager for Auto Reg                            | Name of the Call Manager for AutoReg (as   |
|                                                      | specified under **CUCM Call Managers**).   |
+------------------------------------------------------+--------------------------------------------+
| First and Last Directory Number for Autoreg          | A valid range of DNs to be used for Auto   |
|                                                      | Registration.                              |
+------------------------------------------------------+--------------------------------------------+
| PBR Portal Address                                   | The IP Address of Automate cluster UN1     |
+------------------------------------------------------+--------------------------------------------+
| PBR Portal Port                                      | 8412                                       |
+------------------------------------------------------+--------------------------------------------+


.. image:: /src/images/PBR-CUCM-PBRSetup.png


It is recommended that initial configuration of the UCM is performed using
the PBR setup workflow described above. In cases where there is existing 
auto-registration config on the UCM, it may be required to do this manually.

.. important::

   Set the **Services Provisioning** value (under **Enterprise Parameters Configuration
   - Parameter Name** on the associated UCM) to **Both**.



Configuration on Cisco UCM
............................

Automate Phone Based Registration (PBR) requires the following functionality
to be configured on UCMs that manage phones which may be registered
by this feature:

1. Configure the UCM to allow AutoRegistration of new phones. 

   This is standard auto registration config for UCM. The PBR Setup in Automate carries out
   this configuration.
#. When a phone Auto Registers the ``phonereg`` phone service should be configured for
   the phone. This is achieved by specifying a Universal Device Template for Auto
   Reg that user to the ``phonereg`` phone service.

Screenshots of the relevant configuration on UCM are provided to assist with
understanding how the service is implemented and as background for a Cisco expert
that may need to fine tune the Unified CM config.

3. Setup the ``phonereg`` Phone Service:

   Browse to **Device > Device Settings > Phone Services**.

   172.30.11.126
 
   |PBR-PhoneReg_PhoneService.png|

   Service URL:

   Depending on whether HTTPS or HTTP is used the service URL may be different:

  
   * HTTP (Service URL):
    
     ::
  
        http://{VOSS_IP}:{PBR_PORT}/phoneservices/{UnifiedCM_IP}/phonereg/menu?device=#DEVICENAME#


   * HTTPS (Secure-Service URL): 
    
     ::
  
        https://{VOSS_IP}:443/phoneservices/{UnifiedCM_IP}/phonereg/menu?device=#DEVICENAME#
 
     For HTTPS-only, both Secure Services URL and Service URL must be populated with the HTTPS URL.
    
   .. note::
  
      The port must always be specified explicitly.
   

#. Configure ``phonereg`` Universal Device Template:

   a. Browse to **User Management > User/Phone Add > Universal Device** Template.
   #. Note the subscription to the ``phonereg`` Phone Service.

      |PBR-PhoneReg_UDT.png|
      
#. UCM for Auto Registration:

   a. Browse to **System > Cisco Unified CM**.
   b. Note the ``phonereg`` Universal device template.

      .. image:: /src/images/CUCM-AutoRegistrationConfig.png



.. |PBR-PhoneReg_UDT.png| image:: /src/images/PBR-PhoneReg_UDT.png
.. |PBR-PhoneReg_PhoneService.png| image:: /src/images/PBR-PhoneReg_PhoneService.png