[Index]

Model: relation/HcsSipGwREL

SIP Local Gateways

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

This topic outlines a possible workflow for setting up Local Break Out using a SIP Local Gateway. This workflow copies IOS commands to the IOS device CLI after each step. Alternatively, you can use the consolidate commands tool to create one set of IOS commands to run all at once.

Perform these steps:

  1. Create customized Command Builders for events. Either add new ones, or clone the default ones and update the clones. See Set up a Command Builder or Clone a Command Builder.
  2. Add an IOS device at customer hierarchy level. See Set up an IOS Device.
  3. View the IOS Commands log and copy commands to the IOS device CLI. See View IOS Commands Log.
  4. Add SIP Local Gateways at customer hierarchy level. See Set up SIP Local Gateway.
  5. View the IOS Commands log and copy commands to the IOS device CLI. See View IOS Commands Log.
  6. Perform manual configuration on the SIP Local Gateway. See IOS Gateway Manual Configuration.
  7. Associate SIP Local Gateways to sites. See Associate a SIP Local Gateway to a Site.
  8. View the IOS Commands log and copy commands to the IOS device CLI. See View IOS Commands Log.
  9. Create E.164 Associations. See Associate a Set of E.164 Numbers to One Directory Number or Associate a Range of E.164 Numbers to a Range of Directory Numbers.
  10. View the IOS Commands log and copy commands to the IOS device CLI. See View IOS Commands Log.

IOS Devices

Full HTML Help

In VOSS Automate, you can set up IOS devices such as SIP Local Gateways and Analog Gateways. And you can set up Command Builders to generate the appropriate IOS commands, which allow you to copy to the IOS device CLI.

Related Topics

Command Builders in the Core Feature Guide

IOS Device Management Workflow

This section outlines a possible workflow for setting up Local Break Out (LBO) using a SIP Local Gateway. This workflow copies IOS commands to the IOS device CLI after each step. Alternatively, you can use the consolidate commands tool to create one set of IOS commands to run all at once.

Perform these steps:

  1. Create customized Command Builders for events. Either add new ones, or clone the default ones and update the clones. See Set up a Command Builder or Clone a Command Builder.
  2. Add an IOS device at customer hierarchy level. See Set up an IOS Device.
  3. View the IOS Commands log and copy commands to the IOS device CLI. See View IOS Commands Log.
  4. Add SIP Local Gateways at customer hierarchy level. See:

Set up SIP Local Gateway in the Core Feature Guide

  1. View the IOS Commands log and copy commands to the IOS device CLI. See View IOS Commands Log.
  2. Perform manual configuration on the SIP Local Gateway. See IOS Gateway Manual Configuration.
  3. Associate SIP Local Gateways to sites. See:

Associate / Disassociate SIP Local Gateway to a Site in the Core Feature Guide

  1. View the IOS Commands log and copy commands to the IOS device CLI. See View IOS Commands Log.
  2. Create E.164 Associations. See:

Associate a Set of E164 Numbers to One Internal Number in the Core Feature Guide

Associate a Range of E164 Numbers to a Range of Internal Numbers in the Core Feature Guide

  1. View the IOS Commands log and copy commands to the IOS device CLI. See View IOS Commands Log.

Set up SIP Local Gateway

Full HTML Help

Before You Begin

A SIP Local Gateway is a logical gateway running on a physical IOS device.

Procedure

  1. Log in as provider, reseller, or customer administrator.
  2. Set the hierarchy path to the customer for which you are setting up the SIP Local Gateway.
  3. Choose Device Management > IOS > SIP Local Gateways.
  4. Click Add.
  5. On the SIP Local Gateways screen, complete at minimum, the mandatory SIP Local Gateways Fields.
  6. Click Save.

SIP Local Gateways Fields

Field Description
Name * Enter a name for the SIP Local Gateway. This field is mandatory.
Description Enter a description for the SIP Local Gateway.
IOS Device *

Choose the IOS Device on which the SIP Local Gateway is located. This field is mandatory. Note:

An IOS Device can have only one SIP Local Gateway.

Once selected, the IOS Device cannot be changed.
Country *

Choose the country where the SIP Local Gateway is. This field is mandatory.

The country selected must be the same country as the Site to which the SIP local gateway will be associated.
CUCM Publisher *

Choose the CUCM Publisher. All CUCM Publishers that are in the customer's NDL are displayed. This field is mandatory.

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.
SIP Trunk *

Choose the SIP Trunk from the ones available on the CUCM Publisher. This field is mandatory. Note:

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.
Gateway Address

Gateway Address. This field is read-only and is derived from the selected SIP Trunk.

Note:

If a SIP Trunk has multiple destination addresses, only the first one is used.
Gateway Port Gateway Port. This field is read-only and is derived from the selected SIP Trunk.
Run on Every Node Indicates whether call processing is distributed across all CUCM subscriber nodes. This field is read-only and is derived from the selected SIP Trunk.
Dial Peer Info

If the Run on Every Node is cleared then the Call Manager Group members are displayed in priority order.

If the Run on Every Node check box is selected, then all CUCM nodes in the cluster are displayed, but without priority.
Enable Command Builder *

Select this check box to have Command Builder generate commands when SIP Local 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 Translation Limit ** Warning may invalidate Command Builder Configuration** Select this check box to override Voice Translation Limit if E164 associations exceed 80. Default = Cleared. Note that once checked and saved, then un-checking will not reset the limit to 80. Contact VOSS support or a high level admin to reset it to 80.

Delete a SIP Local Gateway

Full HTML Help

Perform these steps:

  1. Log in as provider, reseller, or customer administrator.
  2. Choose Apps Management > IOS > SIP Local Gateways.
  3. Select the check box next to the SIP Local Gateway that you want to delete, and then click Delete.

Update a SIP Local Gateway

Full HTML Help

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.

Perform these steps:

  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. Choose Apps Managment > IOS > SIP Local Gateways.

  4. Click the SIP Local Gateway to update.

  5. On the SIP Local Gateways screen you can update only the following fields:

    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.

    However, you can update the SIP Trunk in Apps Management > CUCM > SIP Trunks.

  6. Click Save.

Allow an admin to manage a SIP Local GW instance.

Model Details: relation/HcsSipGwREL

Title Description Details
Name * The name of the SIP local gateway
  • Field Name: name
  • Type: String
  • MaxLength: 1024
Description Description for the SIP local gateway
  • Field Name: description
  • Type: String
  • MaxLength: 1024
IOS Device * IOS Device the gateway runs on
  • Field Name: iosDevice
  • Type: String
  • Target: /api/data/HcsIOSDeviceDAT/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24VvkDxBwpw9Vb3e7H%245s6wnrIu3sc4T%2BtJdo5c5mP6Zr6UQPU2AgjEzMmpeCQhgEgWfvnW7KakUlLaIIlCdbfC3Sfj5i6reEsYqjn2hHTuXNuCJfm3O8bfTo/un3C/EobQyR2EdpIzJsSrm1ffJU69X7FyZc1prh8NDZnBeOXkT77uXHMWu9Z66PdgfnBlqKIzlpeMIjQTxv9OA74UU0KxcNZZzYEZnW8ZHze2ynu1qDVTnhiPt2CKLNSCnlXLhHp7Ou3i/pTqdO68XvTqFAiN3a8N0IyS2FHM059pPwqTPTQpDROXCdpVwwAKa/srYv6gzV7WsZ7RiWxry%2B%2BF7g7HwYRTrlDjJTa8X48XGtJ2T0KSqgZA0LbUVI5otkBXkCkifX0c8gcE3ubu6A%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/HcsIOSDeviceDAT
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Country * Country where the gateway is
  • Field Name: country
  • Type: String
  • Target: /api/data/Countries/choices/?field=country_name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24Gaum4dU1eiE5hmBc%240mEV/xoJ5v2wP5Ewf5%2BYSVbMTeZ8s0lms23z2sfFGs5ZEXYa57A5qPmDPEd/53%2BQDnpKrDWeKJ1sODgKIriKRPoSC0NOz7vmfnlGY7Rpe31kuopQDa8nr7LfyYXUI5l5%2BRFCpZCUzsaFUryTnhpXnvKZCnfObhAX5MXzFTM2ojoYT4co2qRbQkHdcqfVwvVfbpLAbnjK7K9P%2Bc7aaNk8lO60DrP9Bbwk3Xl/xLPgiJs337djL9bu3QmsbUYCfnGby4wPQrVRt07mmphNVz27aKMz6D62xZa0WdpKQ%2BDSL3LxDtpJmpUsJx9vMGK/hbZXHmvIfIq2I0D86AX4J0YmkrtQ3apl79kgKE2/qRugNCYBeFKn25tNxmQIxKvHeOWW%24%3D%3D
  • Target attr: country_name
  • Target Model Type: data/Countries
  • MaxLength: 256
  • Format: uri
  • Choices: []
CUCM Publisher * Select CUCM from the customer's NDLs
  • Field Name: cucmPublisher
  • Type: String
  • Target: /api/data/CallManager/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24rED1DkkWOMedHHtk%247TUU68x5vdG50FJ%2BU1/dBAhYS0TK/X9iEhYshtEXJNvTpKQl4OH6TCWZj8KQJxTdCYWO3Ec1ZmWk4tRekVvegFA/1z1nbuKLO2ZrRLg1hu6Fug1DwgG5kTT8B6j%2BkmzUSVCh7IqZKbrlLyo8STNr8Y6WykqgTcVQhEwqYr8d/aI9xUwa%2BbDby0aEQrgsSrWtZJbsE%2BJD8PJveXCntCIzktEmWrmT1rxDAoYTy64QNec0BNZCkUFiV%2BeYEe%2BCMJ9gAGjd67GVKX9zRFOv%2Bs8/WTFGfi3Jo7yODzn/Yy7yhpiQEu4nMSi66Iqm3AfdbGBb2QlDSV5zxVodyNl588gl%2BSEX8b9X6w/GbMHCFDgtNQ%3D%3D%24%3D%3D
  • Target Model Type: data/CallManager
  • MaxLength: 1024
  • Format: uri
  • Choices: []
Sip Trunk * Sip Trunk destined to the gateway
  • Field Name: sipTrunkName
  • Type: String
  • MaxLength: 1024
Gateway Address IP address of the gateway
  • Field Name: gatewayAddressIpv4
  • Type: String
  • MaxLength: 1024
Gateway Port Port of the gateway
  • Field Name: gatewayPort
  • Type: Integer
Run On Every Node Indicate whether call processing is distributed across all CUCM nodes
  • Field Name: runOnEveryNode
  • Type: Boolean
Dial Peer Info Dial peer info used for gateway configuration. If Run on Every Node is not enabled, then the Call Manager Group members are displayed in priority order. If Run on Every Node is enabled, then all CUCM nodes are displayed, but without priority
  • Field Name: dialPeerInfo
  • Type: String
  • MaxLength: 1024
Enable Command Builder Whether or not to generate IOS commands for the gateway Default: true
  • Field Name: enableCommandBuilder
  • Type: Boolean
  • Default: true
Override Voice Translation Limit - ** Warning may invalidate Command Builder Configuration ** Override Voice Translation Limit if E164 associations exceed 80 Default: false
  • Field Name: overrideVTGWLimit
  • Type: Boolean
  • Default: false
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024