Template Wizard field descriptions

Last Updated : Jun 02, 2021 |

Name

Description

Device Select

The device that the Template Wizard should be run against. Select an Avaya SBC device.

Warning:

Do not select a working device (especially if it is in production). Template Wizard is designed for a new configuration and can potentially break an existing configuration, requiring manual steps to restore the previous configuration.

Deployment Type

The deployment type the Template Wizard should create:

  • Trunk

  • Remote Worker

Trunk deployment field descriptions

Name

Description

Call Server Details: OR Trunk Server Details:

Use Call Server or Use Trunk Server

A box to select an existing call or trunk server or define a new call or trunk server.

If an existing call or trunk server is selected, the server must contain exactly one server address. No additional information is needed. If a new call or trunk server is to be added, select <Create New Call/Trunk Server…> and fill out the fields.

Address or FQDN

The IP address or FQDN of the SIP call or trunk server.

Port

The SIP port of the SIP call or trunk server.

Transport

The transport type of the SIP call or trunk server. Select one of the following: TCP, UDP, or TLS.

If TLS is selected, you must enter the certificate details.

Use Network

A box to select an existing network or define a new network.

If an existing network is selected, only an IP address is prompted. If a new network is to be added, select <Create New Network…> and fill out the fields.

IP Address

The listen IP address to use when setting up the signaling and media interface.

If an existing network is selected, this field enables selecting an existing IP address or entering a new IP address.

Gateway

The gateway for the network.

Subnet Mask/Prefix

The subnet mask or network prefix for the network.

Interface

The Avaya SBC interface to attach the network to.

Signaling Port

The Signaling Port to use on for SIP signaling.

Port Range Start

The Media Port Range to use for SIP media.

Port Range End

The Media Port Range to use for SIP media.

TLS:

This section is visible only if TLS is selected as the Call or Trunk Server transport.

Upload New Certificate / Use Existing Certificate

The certificate selection mode:

  • Upload New Certificate

  • Use Existing Certificate

Certificate

The TLS certificate.

If Upload New Certificate is selected, upload a valid PEM-encoded X.509 certificate file.

If Use Existing Certificate is selected, a field is available to select a certificate already installed on Avaya SBC.

Private Key

The private key file.

If Upload New Certificate is selected, you must upload a valid PEM-encoded RSA private key file.

If Use Existing Certificate is selected, this field is not required.

Private Key Passphrase

The passphrase for the Private Key file.

If Upload New Certificate is selected, provide the passphrase for the Private Key file. Leave the field blank if the private key does not have encryption.

If Use Existing Certificate is selected, this field is not required.

Upload New Certificate Authorities / Use Existing Certificate Authorities

Select the CA selection mode.

Peer Certificate Authorities

If Upload New Certificate Authorities is selected, you must upload one or more PEM-encoded X.509 certificate files to provide CA trust anchors.

If Use Existing Certificate Authorities is selected, a field is available to select one or more CA certificates already installed on Avaya SBC.

Remote Worker deployment field descriptions

A Remote Worker Deployment is used to allow remote users access to the internal voice network, typically using secured communications. The fields under these sections are used to define the configuration including Networks, Signaling and Media Interfaces, Server Flows, Subscriber Flows, Routing Rules, and TLS profiles if necessary.

Name

Description

Use Call Server

A box to select an existing call server or define a new call server.

If an existing call server is selected, the server must contain one server address. No additional information is needed. If a new call server is to be added, select <Create New Call Server…> and fill out the fields.

Address or FQDN

The IP address or FQDN of the SIP call server.

Port

The SIP port of the SIP call server.

Transport

The transport type of the SIP call server. Select one of the following: TCP, UDP, or TLS.

If TLS is selected, you must enter the certificate details.

Use Network

A box to select an existing network or define a new network.

If an existing network is selected, only an IP address is prompted. If a new network is to be added, select <Create New Network…> and fill out the fields.

IP Address

The listen IP address to use when setting up the signaling interface and media interface.

If an existing network is selected, this field enables selecting an existing IP address or entering a new IP address.

Gateway

The gateway for the network.

Subnet Mask/Prefix

The subnet mask or network prefix for the network.

Interface

The Avaya SBC interface to attach the network to.

Signaling Port

The Signaling Port to use on for SIP signaling.

Port Range Start

The Media Port Range to use for SIP media.

Port Range End

The Media Port Range to use for SIP media.

TLS:

This section is visible only if TLS is selected as the Call Server transport.

Upload New Certificate / Use Existing Certificate

The certificate selection mode:

  • Upload New Certificate

  • Use Existing Certificate

Certificate

The TLS certificate.

If Upload New Certificate is selected, upload a valid PEM-encoded X.509 certificate file.

If Use Existing Certificate is selected, a field is available to select a certificate already installed on Avaya SBC.

Private Key

The private key file.

If Upload New Certificate is selected, you must upload a valid PEM-encoded RSA private key file.

If Use Existing Certificate is selected, this field is not required.

Private Key Passphrase

The passphrase for the Private Key file.

If Upload New Certificate is selected, provide the passphrase for the Private Key file. Leave the field blank if the private key does not have encryption.

If Use Existing Certificate is selected, this field is not required.

Upload New Certificate Authorities / Use Existing Certificate Authorities

Select the CA selection mode.

Peer Certificate Authorities

If Upload New Certificate Authorities is selected, you must upload one or more PEM-encoded X.509 certificate files to provide CA trust anchors.

If Use Existing Certificate Authorities is selected, a field is available to select one or more CA certificates already installed on Avaya SBC.

Secondary Session Manager Details (Optional)

The fields in this section are identical to those in the Primary Session Manager Details fields except the following field:

Name

Description

Use Secondary Session Manager

A checkbox to determine if a secondary Session Manager should be configured. If the checkbox is cleared, only one Session Manager configuration is provisioned.