.. _quick-add-sip-gateway:


Quick Add SIP Gateway
---------------------


.. _20.1.1|VOSS-519:


Overview
........

Quick Add SIP Gateway allows you to configure a new SIP gateway at the site level, with minimum details. Saving 
the form triggers a background process that uses the information you provide, along with configuration 
templates, and automatically creates the required elements at the correct hierarchies: 

==================== ================================================================================
At customer level    Saving a Quick Add SIP Gateway configuration creates and adds the following 
                     elements at the customer level:

                     * The IOS device
                     * The SIP trunk 
                     * The SIP LBO gateway

At site level        Saving a Quick Add SIP Gateway configuration performs these actions at the 
                     site level: 

                     * The gateway is associated to the site
                     * The E1/T1 Ports are added (optional)
==================== ================================================================================


.. note:: 

   * Quick Add SIP Gateway does not support incremental configuration of the gateway. Activities 
     such as adding additional ports must be done via the appropriate menus.

   * While the Quick Add SIP Gateway tool automates the creation and configuration of elements 
     required for the SIP gateway at the customer and site level, you can manually create these 
     elements, if required. For example, to associate an unused or old gateway that was previously associated 
     with a site, to a new site. 
     
     In this case, you would need to add these elements at customer and 
     site hierarchies, as follows: 

     * At customer level: 

       * Add the IOS device
       * Add the SIP trunk
       * Add the SIP LBO gateway

     * At the site level: 

       * Associate the gateway to the site
       * Add the E1/T1 ports (optional)




Add the SIP Gateway and Associated Components
................................................

1. In the Admin Portal, choose the site. 
2. Go to (default menus) **Apps Management > IOS > Quick Add 
   SIP Gateway** to open the **Quick Add SIP Gateway** form.

3. On the **IOS Device** tab, configure IOS gateway details:

   * Mandatory. Enter a **IOS Device Name** or select an existing IOS device from the drop-down. 
   * Optional. Add a description for the IOS device. 
   * Optional. Configure **Prime Collaboration**, if required.
   * At **Network Addresses** you must create two network addresses: 
   
     * To create the first network address, at **Address Space**, choose **SERVICE_PROVIDER_SPACE**, 
       then enter the associated **IPv4 Address**.

       .. note:: 

          This is used to specify the IP address of the IOS device, if one is created. 

     * Create the second network address (as seen from the Unified CM) for the 
       SIP Trunk to use. In this case, at **Address Space**, choose **APPLICATION_SPACE**. 

       .. important:: 

          The second network is address is critical as it is used to specify the IP address of the 
          SIP trunk.

   * If you're using HCMF and Prime Collaboration, fill out the **Credentials**.   
   
     .. note:: 
       
        Credentials are required only if you're using HCMF and Prime Collaboration and you need 
        to pass data to these components. In other scenarios, you can ignore this step since 
        VOSS does not directly communicate with the IOS device or the gateway. 

#. On the **SIP Trunk** tab, choose a SIP trunk template. 

   .. note:: 

      * The SIP trunk templates assembles data (such as IPv4) from the details you specified in 
        the **Network Addresses** section of the **IOS Device** tab in the previous step.

      * The **Configuration Templates** list displays available templates. Type *siptrunk* in the 
        **Name** column to filter the list. Existing sample SIP trunk templates can be 
        cloned, modified, and saved under a new name.
   
#. On the **SIP Gateway** tab, complete the relevant fields, for example:  
     
   =========================== ===================================================================== 
   **SIP Gateway Name**        Mandatory.
   
   **Run On Every Node**       Enabled by default. Defines whether the Unified CM hosts the trunk 
                               everywhere.
   
   **Enable Command Builder**  Enabled by default. 
   =========================== =====================================================================

   .. note:: 

      **Country** is a read-only field that displays the location of the SIP gateway. The value 
      in this field (the country) is the same as the site to which the SIP gateway will be associated. 

#. Optional. On the **Ports** tab, add an E1 or T1 port to the gateway:
   
   * Enter the required T1 or E1 **Port Number**, and a description.

     .. note:: 

        Port numbers should be formatted as follows: ``x/x/x`` (unit/subunit/port)
   
   * Choose a **Port Template**. The template drives the values defined for E1 and T1.
      
     .. note:: 
       
        Existing sample port templates can be cloned, modified, and saved under a new name.

#. Click **Save**. 

   Once the transaction completes: 
   
   * The IOS Device, SIP Trunk, SIP LBO Gateway are created at the customer level
   * The SIP LBO Gateway is associated to the site
   * The optional E1 and T1 ports are created at the site level



.. rubric:: Related Topics

* :ref:`set_up_an_ios_device`