.. _set-up-sip-local-gateway:
SIP local gateway
------------------
.. _24.1|EKB-18884:
.. tip::
:ref:`use-action-search-to-navigate-automate`
Add a SIP local gateway
...........................
This procedure adds a SIP local gateway.
**Pre-requisites**
* Configure an IOS Device at the customer hierarchy node.
* Configure an NDL containing the CUCM for the customer.
* Configure a SIP trunk at the customer hierarchy node.
A SIP Local Gateway is a logical gateway running on a physical IOS device.
.. rubric:: Add SIP local gateway
1. Log in as provider, reseller, or customer administrator.
#. Set the hierarchy path to the customer for which you are setting up
the SIP Local Gateway.
#. Go to **SIP Local Gateways**, then click the Plus icon (+) to add a new record.
#. Configure settings for at least the mandatory fields. See :ref:`sip-local-gateways-fields`.
#. Click **Save**.
View transaction progress and details in the Transaction Logs.
* The SIP Local Gateway appears in the **SIP Local Gateway** list view.
* The HcsAddSipLocalGwEVT event is generated. If enabled, the IOS
Command Builder generates the default IOS commands associated with the
event.
* The HcsAddSipLocalGwDialPeerEVT event is generated. If enabled, the
IOS Command Builder generates the default IOS commands associated with
the event for each dial peer.
.. rubric:: Related topics
*
.. raw:: latex
Transaction Logging and Audit in the Core Feature Guide.
.. raw:: html
Transaction Logging and Audit
.. _sip-local-gateways-fields:
SIP local gateway settings
''''''''''''''''''''''''''''
.. tabularcolumns:: |p{3.5cm}|p{12cm}|
+-------------------------+-------------------------------------------+
| Field | Description |
+=========================+===========================================+
| Name \* | Mandatory. Fill out a name for the SIP |
| | Local Gateway. |
+-------------------------+-------------------------------------------+
| Description | Enter a description for the SIP Local |
| | Gateway. |
+-------------------------+-------------------------------------------+
| | Mandatory. Choose the IOS Device on which |
| | the SIP Local Gateway is located. |
| | |
| | Note: |
| IOS Device \* | |
| | An IOS Device can have only one SIP Local |
| | Gateway. |
| | |
| | Once selected, the IOS Device cannot be |
| | changed. |
+-------------------------+-------------------------------------------+
| | Mandatory. Choose the country where the |
| | SIP Local Gateway is. |
| Country \* | |
| | The country selected must be the same |
| | country as the Site to which the SIP |
| | local gateway will be associated. |
+-------------------------+-------------------------------------------+
| | Mandatory. Choose the CUCM Publisher. |
| | All CUCM Publishers that are in the |
| | customer's NDL are displayed. |
| CUCM Publisher \* | |
| | The chosen CUCM Publisher must be the |
| | same as the CUCM Publisher in the NDL for |
| | the Site to which the SIP local gateway |
| | will be associated. |
+-------------------------+-------------------------------------------+
| | Mandatory. Choose the SIP Trunk from |
| | those available on the CUCM Publisher. |
| | |
| | Note: |
| | |
| SIP Trunk \* | Only SIP Trunks configured at the |
| | customer hierarchy are available. If the |
| | customer uses a shared CUCM, then SIP |
| | Trunks must be manually configured at the |
| | customer level in VOSS Automate to be |
| | selectable here. |
+-------------------------+-------------------------------------------+
| | Read-only. The Gateway Address, |
| | derived from the selected SIP |
| | Trunk. |
| Gateway Address | |
| | Note: |
| | |
| | If a SIP Trunk has multiple destination |
| | addresses, only the first one is used. |
+-------------------------+-------------------------------------------+
| Gateway Port | Read-only. Gateway Port, |
| | is derived from the selected SIP Trunk. |
+-------------------------+-------------------------------------------+
| | Read-only. Defines whether call |
| Run on Every Node | processing is distributed across all CUCM |
| | subscriber nodes. The value comes from |
| | the selected SIP Trunk. |
+-------------------------+-------------------------------------------+
| | If the **Run on Every Node** is cleared |
| | then the Call Manager Group members are |
| | displayed in priority order. |
| Dial Peer Info | |
| | If the **Run on Every Node** checkbox is |
| | selected, then all CUCM nodes in the |
| | cluster are displayed, but without |
| | priority. |
+-------------------------+-------------------------------------------+
| | Select this check box to have Command |
| Enable Command | Builder generate commands when SIP Local |
| Builder \* | Gateway is added, deleted, or modified. |
| | Default = Selected. |
| | |
| | If this is checked and the Override |
| | below is also checked, then |
| | E164-to-DN disassociation will fail if it |
| | exceeds the default limit. This setting |
| | should therefore be un-selected for |
| | disassociation to succeed in this case. |
+-------------------------+-------------------------------------------+
| Override Voice | Select this checkbox to override Voice |
| Translation Limit | Translation Limit if E164 associations |
| ** Warning may | exceed 80. Default = Cleared. |
| invalidate Command | Note that once checked and saved, then |
| Builder Configuration** | un-checking will not reset the limit |
| | to 80. Contact VOSS support or a high |
| | level admin to reset it to 80. |
+-------------------------+-------------------------------------------+
Update SIP local gateway
..........................
This procedure updates a SIP local gateway. You can also perform this task if you have updated the SIP Trunk associated with the SIP Local Gateway.
1. Log in as provider, reseller, or customer administrator.
2. Set the hierarchy path to the customer whose SIP Local Gateway you are updating.
3. Go to **SIP Local Gateways**.
4. Click the SIP Local Gateway to update.
5. On the **SIP Local Gateways** page, only the following values can be modified:
.. note::
The SIP trunk can be updated on the CUCM **SIP Trunks** page.
+------------------------+-------------------------------------------+
| Field | Description |
+========================+===========================================+
| Name | Enter a name for the SIP Local Gateway. |
| | This field is mandatory. |
+------------------------+-------------------------------------------+
| Description | Enter a description for the SIP Local |
| | Gateway. |
+------------------------+-------------------------------------------+
| Enable Command Builder | Select this check box to have Command |
| | Builder generate commands when SIP Local |
| | Gateway is added, deleted, or modified. |
+------------------------+-------------------------------------------+
6. Click **Save**.
View transaction progress and details in the Transaction Logs.
* If you changed the SIP Local Gateway name, the Gateway Name for generated
commands is updated in the IOS Commands log.
* If the **Run on Every Node** checkbox is selected for SIP Trunk, the
HcsUpdateSipLocalGw1EVT and HcsUpdateSipLocalGw1EVT events are generated.
If the **Enable Command Builder** checkbox is selected, the IOS Command
Builder generates the default IOS commands associated with the events.
.. rubric:: Related topics
*
.. raw:: latex
Transaction Logging and Audit in the Core Feature Guide.
.. raw:: html
Transaction Logging and Audit
Delete SIP local gateway
.............................
1. Log in as provider, reseller, or customer administrator.
2. Go to IOS **SIP Local Gateways**.
3. Select the SIP Local Gateway that you want to delete, then click the **Delete** icon on the details page.
View transaction progress and details in the Transaction Logs. See :ref:`transaction-logging-and-audit`
* The SIP Local Gateway is removed from the **SIP Local Gateway** list view.
* The HcsDeleteSipLocalGwEVT event is generated. If enabled, the IOS
Command Builder generates the default IOS commands associated with the
event.
* The HcsDeleteSipLocalGwDialPeerEVT event is generated. If enabled, the
IOS Command Builder generates the default IOS commands associated with
the event for each dial peer.
* If the SIP Local Gateway is associated with any sites, the events for
disassociating a SIP Local Gateway from a Site are generated for each
associated site. See "Disassociate a SIP Local Gateway from a Site" for
details.
.. rubric:: Related topics
*
.. raw:: latex
Transaction Logging and Audit in the Core Feature Guide.
.. raw:: html
Transaction Logging and Audit