FourteenIP Failover Gateway

Gateway Configuration, BroadWorks Provisioning, CX-GWSAK Local Calling, and EV Lite User Onboarding

Version 4 | Internal Technical Guide

Purpose: A structured technician reference for configuring supported FourteenIP gateways to use the local CX-GWSAK Failover Box during an Internet or primary SIP outage and return automatically to the FourteenIP service when connectivity is restored.

Guide Map

Select a section below to jump directly to the required task.

Presentation rule: Values inside braces are site-specific placeholders. Preserve capitalization, separators, percent signs, port numbers, and spacing when copying configuration values. Screenshots contain lab examples and must not be copied unchanged into production.

01 Solution Overview and Compatibility

1.1 Supported Devices

Use this procedure only with the currently onboarded devices below. Firmware approval and site-specific configuration remain separate deployment requirements.

IMPORTANT — COMPATIBILITY RESTRICTION: ANY DEVICE NOT INCLUDED IN THIS COMPATIBILITY LIST HAS NOT YET BEEN ONBOARDED OR VALIDATED FOR USE WITH THE CX-GWSAK FAILOVER BOX AND MUST NOT BE USED WITH IT UNLESS IT IS SUBSEQUENTLY ADDED TO THIS LIST.

1.2 How Failover Works

During an Internet or primary SIP outage, the FourteenIP gateway changes its SIP signaling target to the local CX-GWSAK. This keeps configured on-site extension-to-extension calling available. When the primary FourteenIP SIP service is reachable and stable again, the gateway returns automatically.

What This Guide Covers

• Local extension-to-extension calling while the WAN or primary SIP service is unavailable.

• BroadWorks tags named to match the High Availability settings in the gateway GUI.

• Standard per-user deployments and the EV Lite single-pilot registration model.

• Automatic return to the primary FourteenIP SIP service after connectivity is restored.

This configuration does not provide PSTN or off-site calling during an outage unless the site has a separately configured local carrier, FXO, PRI, or equivalent path.

1.3 Prerequisites

• Install the currently approved firmware for the FourteenIP gateway and CX-GWSAK.

• Assign static LAN addresses to the gateway and failover box and verify two-way IP reachability.

• Permit the approved local SIP port between the gateway and CX-GWSAK. Examples in this guide use UDP 5060.

• Collect the site Group ID, user identity format, extension list, gateway IP, site network, subnet mask, and regional SIP server ID.

• Confirm that the failover box has sufficient capacity. The supplied configuration supports up to 200 IP extension records per box.

• Export or record the current gateway and CX-GWSAK configurations before making changes.

1.4 Site Values to Collect

02 Configure the FourteenIP Gateway

2.1 Primary/Standby SIP Settings

1. Sign in to the FourteenIP gateway and navigate to Basic > SIP. Preserve the existing primary registrar, proxy, credentials, and server profile.

2. Set Mode to Primary-Standby.

3. Select Primary and backup servers.

4. Enter {FAILOVER_IP}:5060 as the Backup SIP proxy.

5. Enable Primary server heartbeat detection.

6. Set OPTIONS request period to 60 seconds.

7. Enable Primary server priority.

8. Select Save, reopen the page, and confirm that every setting remains applied.

Figure 2-1. Basic > SIP: tested primary/standby settings with the CX-GWSAK local backup address.

SITE-SPECIFIC VALUE: The screenshot uses 192.168.50.26:5060 as a lab example. Replace it with the actual CX-GWSAK LAN address for the site.

2.2 Final Gateway Parameter State

The diagnostic change log contains temporary 0-second and 30-second edits. Those entries show the UI being changed and are not the final configuration.

US lab example:

IP_FAIL_FALLBACK_METHOD = 1
BACKUP_CA_1 = 192.168.50.26:5060
P2P_FLAG = on
P2P_SIP_SERVER_ID = us-sbc-secure
IP_FAILOVER_TIME = 60
IP_FAIL_FALLBACK_TIME = 60

DO NOT COPY TRANSITIONAL VALUES: Ignore earlier log entries showing IP_FAIL_FALLBACK_METHOD = 0, IP_FAIL_FALLBACK_TIME = 0, or 30-second timers. The final target is method 1 with both timers set to 60 seconds.

2.3 Configuring GWs for Failover

Use the following tags in the FourteenIP gateway device template. The tag names intentionally match the labels technicians see under Basic > SIP.

FAILOVER AND FAILBACK: When Internet access or the primary SIP path is unavailable, the gateway fails over to the local CX-GWSAK Failover Box. When primary service becomes reachable and stable again, Primary server priority causes the gateway to fail back automatically to the normal FourteenIP SIP server.

Paste-ready device-template substitutions:

BACKUP_CA_1 = %BACKUP-SIP-PROXY%
IP_FAILOVER_TIME = %OPTIONS-REQUEST-PERIOD%
IP_FAIL_FALLBACK_TIME = %OPTIONS-REQUEST-PERIOD%
IP_FAIL_FALLBACK_METHOD = %PRIMARY-SERVER-PRIORITY%
P2P_FLAG = %OPTIONS-PRIMARY-AND-BACKUP-SERVERS%
P2P_SIP_SERVER_ID = %OPTIONS-PRIMARY-SERVER-ID%

Assign Backup SIP proxy at the site or device level and assign the primary server ID for the correct region. Keep OPTIONS request period at 60, Primary server priority at 1, and Primary and backup servers set to on. The deployment profile must also retain Mode = Primary-Standby and Primary server heartbeat detection = enabled.

03 Configure CX-GWSAK Outbound Routing

1. Sign in to the CX-GWSAK and open Outbound call routing.

2. Retain the site-approved Cloud PBX, transport, call restriction, and emergency-call values.

3. Select Allow call from IP segment(s).

4. Enter the site network under IP segment 1 and enter the correct subnet mask explicitly.

5. Add a second approved segment only when the deployment requires it.

6. Set the local signaling port to the approved site value. The supplied configuration uses 5060.

7. Save the page and confirm that the fields remain applied.

Figure 3-1. CX-GWSAK Outbound call routing: authorize the gateway’s site network.

SECURITY NOTE: Do not leave the subnet mask blank when that would trust a broader network than intended. Enter the actual site mask and never copy the lab Cloud PBX or UA domain name into another deployment.

04 Configure Registrar Options and Local Users

4.1 Extension > IP Records

Open Extension > IP. Every identity that must receive or place a local failover call needs a matching IP extension record on the CX-GWSAK. The trusted IP must point to the FourteenIP gateway address and port used for local signaling.

Figure 4-1. Extension > IP: example local user records routed to the FourteenIP gateway.

CAPACITY: The supplied design supports up to 200 IP extension records per CX-GWSAK. Confirm the remaining capacity before adding a new site or user batch.

4.2 Registrar OPTIONS

From Extension > IP, select Registrar OPTIONS. Use the site Group ID as the Group name; the supplied example uses TGDMS.

Figure 4-2. Registrar OPTIONS: example local registrar and Group name settings.

05 EV Lite Bulk User Onboarding

EV LITE REGISTRATION MODEL: EV Lite uses one SIP registration for the pilot user. Seeing only the pilot registration is correct and expected.

Every EV Lite user must still be added under Extension > IP on the CX-GWSAK. These entries give the failover box the local identities it needs to route calls between EV Lite users; they do not create separate SIP registrations.

Key Notes

• One pilot registration represents the EV Lite service.

• Add every EV Lite user as an individual local routing record.

• Use the FourteenIP gateway’s local IP address and SIP port as the trusted IP for each record.

• During testing, place calls in both directions between two users from the imported list.

5.1 Excel Template Supplied by the Gateway

The Quick Addition window includes an Excel template button. Selecting it downloads a blank .xlsx workbook with the required column headings. Complete one row for each EV Lite user, then copy only the data rows back into Quick Addition. Do not copy the header row.

Excel Template Example

Use the Excel template button in the gateway’s Quick Addition window to download the blank workbook. The populated example below shows how the technician should complete it. Replace the sample identities, credential, call restriction, and gateway address with the approved values from the current site worksheet.

Example of the EV Lite bulk user template completed for technician reference.

Copy-Ready Excel Sample

Copy the tab-separated rows below and paste them directly into cell A2 of the Excel template. Excel will place the data into columns A through F. The blank PIN and Display as columns are intentionally preserved. Do not paste these rows over the workbook’s header row.

TGDMS4080  {SITE-APPROVED-PASSWORD}      International  192.168.50.105:5060
TGDMS4081  {SITE-APPROVED-PASSWORD}      International  192.168.50.105:5060
TGDMS4082  {SITE-APPROVED-PASSWORD}      International  192.168.50.105:5060
TGDMS4083  {SITE-APPROVED-PASSWORD}      International  192.168.50.105:5060
TGDMS4084  {SITE-APPROVED-PASSWORD}      International  192.168.50.105:5060

REPLACE THE SAMPLE VALUES: Before importing, change the Group ID/extension, password, call restriction, and trusted gateway IP address for the site.

The identities and IP address shown above are examples. Production values must come from the current site worksheet.

5.2 Import Users with Quick Addition

1. On the CX-GWSAK, navigate to Extension > IP and select Quick Addition.

2. Set Starting line to the first unused record. Do not overwrite existing users.

Figure 5-1. Start the EV Lite bulk build from Extension > IP > Quick Addition.

3. Select Excel template. The gateway downloads an .xlsx spreadsheet.

4. Open the workbook in Microsoft Excel and enter one user per row.

5. Preserve the six-column order: Extension number, Password, PIN, Display as, Call restriction, and IP address for IP trusted authentication.

Figure 5-2. EV Lite Excel template. The displayed identities, password, policy, and IP address are examples only.

CREDENTIAL HANDLING: Replace the example password with the approved deployment value. Do not reuse the screenshot password at another site.

6. Copy only the completed data rows from Excel and paste them into the Quick Addition text area.

7. Exclude the header row and preserve blank PIN and Display as cells so the tab-delimited columns remain aligned.

Figure 5-3. Paste the Excel data rows into Quick Addition, excluding the title row.

EXAMPLE RANGES: The supplied screenshots show different lab batches. Compare the pasted identities with the current site worksheet before selecting Preview.

8. Select Preview.

9. Verify the Number, password source, blank optional fields, Call restriction, trusted gateway IP, starting line, and total record count before applying the batch.

Figure 5-4. Quick Addition preview: validate every parsed column before applying the batch.

10. Select Apply, then Close.

11. On Extension > IP, confirm the new records, select Save, and reopen the page to verify that the records remain present and enabled.

EV LITE VERIFICATION: The expected EV Lite registration state is one pilot registration. Confirm that all EV Lite user identities are present as local routing records, then place calls between two EV Lite users in both directions during the outage test.

06 Failover and Automatic Return Validation

6.1 Pre-Test Checks

• Confirm that the primary SIP registration is stable and save a baseline screenshot or log.

• Confirm that the CX-GWSAK backup address is reachable from the FourteenIP gateway over the approved local SIP port.

• Confirm that every test user has an enabled Extension > IP record and the Group name matches the site Group ID.

• For EV Lite, select two users and confirm that both appear in the local routing records.

• Begin logging before changing network state so the complete transition is captured.

6.2 Controlled Outage Test

1. Place a local user-to-user call and an approved external call while the primary SIP service is available.

2. Remove only upstream Internet access. Keep both devices powered and keep the site LAN intact.

3. Do not unplug the local link between the FourteenIP gateway and CX-GWSAK.

4. Allow the 60-second failover interval and confirm that signaling changes to the CX-GWSAK.

5. Place calls in both directions between at least two configured users. For EV Lite, use two users from the imported local routing records.

6. Restore upstream Internet access.

7. Wait until the primary registrar/proxy is reachable and allow the configured 60-second fallback interval.

8. Verify that the gateway returns to the primary SIP service without a reboot and repeat the baseline calls.

9. Export the relevant logs and record caller/callee pairs, transition times, expected results, and actual results.

6.3 Acceptance Criteria

07 Troubleshooting and Handoff

7.1 Troubleshooting Matrix

7.2 Technician Handoff Checklist

• Site-value worksheet completed and stored with the deployment record.

• Primary and backup SIP settings saved and verified after reopening the page.

• Final 60-second failover and fallback values confirmed in configuration or logs.

• CX-GWSAK site network and explicit subnet mask confirmed.

• Registrar Group name and all standard/EV Lite extension records confirmed.

• Normal, outage, EV Lite user-pair, and restoration tests completed in both directions.

• Caller/callee pairs, expected behavior, actual behavior, screenshots, and logs attached to the handoff.

• Current gateway and CX-GWSAK configuration backups retained.

COMPLETION STANDARD: Do not mark the site failover-ready until the gateway returns to the primary SIP service automatically and the selected EV Lite user pair passes in both directions.