[Index]

Model: view/GS_IOSGateway_QuickAdd_View

Quick Add SIP Gateway

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

Overview

The Quick Add SIP Gateway feature (default menu Device Management > IOS > Quick Add SIP Gateway) allows you to configure a new SIP Gateway with associated components.

The following five actions have been consolidated into one procedure, performed from a single form.

At customer level

  1. Add the IOS Device
  2. Add the SIP Trunk
  3. Add the SIP LBO Gateway

At site level

  1. Associate the Gateway to the Site
  2. Add the E1/T1 Ports (optional)

Adding the SIP Gateway and Associated Components

  1. Open the Quick Add SIP Gateway form.

  2. From the IOS Device tab, add the IOS Gateway:

    • Enter the mandatory IOS Device Name and optional IOS Device Description fields, or select an existing IOS Device from the drop-down list. Prime Collaboration can also be configured if required.
    • Complete the Network Addresses section, by selecting the SERVICE_PROVIDER_SPACE option from the Address Space drop-down and then entering the associated IPv4 Address.
    • Create another Network Address (as seen from the Unified CM) for use by the SIP Trunk, but this time selecting the APPLICATION_SPACE option.
    • Complete the Credentials section.

    Refer to Set up an IOS Device for more details.

  3. On the SIP Trunk tab:

    Select the required SIP trunk template from the drop-down list. The SIP trunk templates assemble data, e.g. IPv4, from the data configured in the Network Addresses section above.

    Available templates are shown on the Configuration Templates list. Filter on 'siptrunk' in the Name column. Existing sample SIP trunk templates can be cloned, modified and saved under a new name.

  4. On the SIP Gateway tab, complete the required fields such as:

    • SIP Gateway Name - this is a mandatory field.
    • Country - Read only field. The country where the SIP Gateway is, and the same country as the Site to which the SIP Gateway will be associated.
    • Run On Every Node - determines if the Unified CM hosts the trunk everywhere, default = Selected.
    • Enable Command Builder - default = Selected

  5. On the Ports tab (optional):

    Add an E1 or T1 port to the gateway:

    1. Enter the required T1 or E1 Port Number and Description.

    2. Select a Port Template from the drop-down, which drives the values defined for E1 and T1.

      Existing sample port templates can be cloned, modified and saved under a new name.

  6. Click Save. Upon completion, the IOS Device, SIP Trunk, SIP LBO Gateway are created, the SIP LBO Gateway is associated to the Site, and the optional E1 and T1 ports are created.

Caveats

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

Model Details: view/GS_IOSGateway_QuickAdd_View

Title Description Details
IOS Device Name *
  • Field Name: iosName
  • Type: String
IOS Device Description
  • Field Name: iosDescription
  • Type: String
Prime Collaboration
  • Field Name: iosPrimeCollab
  • Type: String
Network Addresses
  • Field Name: networkAddresses.[n]
  • Type: Array
Address Space *
  • Field Name: networkAddresses.[n].addressSpace
  • Type: String
  • Choices: ["APPLICATION_SPACE", "SERVICE_PROVIDER_SPACE", "CUSTOMER_SPACE"]
IPv4 Address *
  • Field Name: networkAddresses.[n].iPAddrV4
  • Type: String
  • Format: ip-address
Description
  • Field Name: networkAddresses.[n].description
  • Type: String
Domain
  • Field Name: networkAddresses.[n].domain
  • Type: String
Hostname
  • Field Name: networkAddresses.[n].hostname
  • Type: String
Credentials
  • Field Name: credentials.[n]
  • Type: Array
Credential Type *
  • Field Name: credentials.[n].credentialType
  • Type: String
  • Choices: ["SNMP_V2", "SNMP_V3", "CLI"]
UserId *
  • Field Name: credentials.[n].userid
  • Type: String
Password *
  • Field Name: credentials.[n].password
  • Type: String
  • Is Password: True
Access Type Default: RO
  • Field Name: credentials.[n].accessType
  • Type: String
  • Default: RO
  • Choices: ["RO", "RW"]
Description
  • Field Name: credentials.[n].description
  • Type: String
SIP trunk template *
  • Field Name: sipTrunkTemplate
  • Type: String
SIP Gateway name *
  • Field Name: sipGatewayName
  • Type: String
SIP Gateway Description
  • Field Name: sipGatewayDescription
  • Type: String
Country
  • Field Name: country
  • Type: String
Run On Every Node Default: true
  • Field Name: runOnEveryNode
  • Type: Boolean
  • Default: true
Enable Command Builder Default: true
  • Field Name: enableCommandBuilder
  • Type: Boolean
  • Default: true
Override Voice Translation Limit
  • Field Name: overrideVoiceTranslationLimit
  • Type: Boolean
T1/E1 Ports
  • Field Name: ports.[n]
  • Type: Array
Port Number * e.g. 1/0/0
  • Field Name: ports.[n].portNumber
  • Type: String
Description
  • Field Name: ports.[n].description
  • Type: String
Port Template *
  • Field Name: ports.[n].portTemplate
  • Type: String