.. _setup-CUCM-for-PBR:

Configure a Cisco Unified CM for Phone Based Registration
---------------------------------------------------------


.. rubric:: Related Topics

* :ref:`intro-PBR`


.. _Using_PBR_Setup_feature_to_configure_a_CUCM:

Using PBR Setup to configure a Cisco Unified CM
.......................................................

The PBR Setup feature automates the configuration of Unified CM for AutoRegistration
and Phone Based Registration.

In VOSS Automate, browse to **Services > Phone Based Registration > PBR Setup**. The
following input is required:

* **CUCM IP Address**: IP Address of the publisher for the Unified CM Cluster.
* **Call Manager Group for Auto Reg**: Name of Unified CM Group for AutoReg.
* **Call Manager for Auto Reg**: Name of the Call Manager for AutoReg (as specified
  under **Services > Phone Based Registration > 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 VOSS cluster UN1 .
* **PBR Portal Port**: 8412.

  |PBR-CUCM-PBRSetup.png|


VOSS recommends that initial configuration of the Unified CM is performed using
the PBR Setup workflow described above. In cases where there is existing auto
registration config on the Unified CM, it may be required to do this manually.

.. important::

   The **Services Provisioning** value under **Enterprise Parameters Configuration
   - Parameter Name** on the associated Unified CM **must** be set to **Both**.



Configuration on Cisco Unified CM
.....................................

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

1. Configure the Unified CM to allow AutoRegistration of new phones. This is standard
   auto registration config for Unified CM. The PBR Setup in VOSS 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 subscribes to the ``phonereg`` phone service.

Screenshots of the relevant configuration on Unified CM 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|
      
#. Unified CM for Auto Registration:

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

      |CUCM-AutoRegistrationConfig.png|



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