Nyquist System Controller Setup Guide

E7000 Release 8.0

C4000 Release 5.0

© 2023 Bogen Communications LLC

All rights reserved
740-00206A
230629
Contents

Setup Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Nyquist Network Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Understanding System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
Whitelisted Web Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
Network Application Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Network Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Installing and Configuring the Nyquist System Controller. . . . . . . . . . . . . . . . . . . . . . .9
Install the System Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Using the Setup Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Network Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Reset Network Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
License Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Restarting the Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
Customer Information Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Dialing Length Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
Station Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
User Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Time Zone Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
Network Time Server Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
Zone Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24
Setup Wizards Complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
Adjusting Final Network Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
Logging into the Nyquist server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
Update Server Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26

Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Updating Nyquist Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
Assigning Permissions for New Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
Updating Appliance Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
Installing the Bogen Digital Certification Authority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32
Installing Certification Authority on Windows System . . . . . . . . . . . . . . . . . . . . . . . . .32
Installing Certification Authority on Mac System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33
Installing Certification Authority on an Android Device . . . . . . . . . . . . . . . . . . . . . . . .34
Installing Certification Authority on an iOS Device . . . . . . . . . . . . . . . . . . . . . . . . . . . .34
Viewing the Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34

i
List of Figures

Figure 1. Port A-Only Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2

Figure 2. Port A and B Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
Figure 3. Setup Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Figure 4. Network Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Figure 5. Example of Completed Network Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Figure 6. Enter Serial Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Figure 7. Configured Network Interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Figure 8. License Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Figure 9. C4000 Feature/Option License Activation Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Figure 10. End User License Agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Figure 11. Product Activation (C4000 and E7000) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Figure 12. Customer Information Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Figure 13. Dialing Length Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Figure 14. Station Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Figure 15. User Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Figure 16. Time Zone Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Figure 17. Network Time Server Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Figure 18. Zone Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Figure 19. Setup Wizards Complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Figure 20. Nyquist System Controller Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

ii
Setup Introduction
This guide is intended for system engineers, system integrators, and IT personnel who are
responsible for installing and setting up a Nyquist System Controller (NQ-SYSCTRL). It
assumes that users of this guide understand basic networking concepts.
Two options are available for installing and deploying a Nyquist system:
1 Using a Nyquist System Controller, a purpose-built appliance computer with the
Nyquist application software preinstalled.

2 Using your own server platform to install the Debian OS and Nyquist server applica-
tion software.
Option 1 is the quickest and easiest approach, but option 2 may be better suited for situ-
ations where high-availability server features like Redundant Array of Independent Disks
(RAID) or hot-swappable power supplies are desired.
This guide describes the Nyquist installation and setup process when using the Nyquist
System Controller (i.e., option 1). If you are using your own server platform, see the
Nyquist Server Installation and Setup Guide.

Nyquist Network Organization

The System Controller is a multi-homed computer with two Ethernet ports, A and B. (See
Figure 1, “Port A-Only Configuration,” on page 2 and Figure 2, “Port A and B Configura-
tion,” on page 2.)
The System Controller always communicates with Nyquist devices on Port A. Port B is
optional: It is used to communicate with the Internet when the network connected to Port
A is a private “Nyquist” network that is not connected to the Internet.
The System Controller only requires access to the Internet for system activation, software
upgrades, and when adding new or additional license activation keys. Normal operation
does not require an Internet connection unless one of the available embedded Internet
radio or music streaming services is going to be used for audio distribution, or if Routine
API invocations from Internet-based systems, Routine Webhook-Post actions to Inter-
net-based systems, weather alerts, or weather conditions will be used.
As shipped from the factory, Port A is configured to use static Internet Protocol (IP)
address 192.168.1.10, and Port B is set to obtain an IP address through Dynamic Host
Configuration Protocol (DHCP).
If the network to be connected to Port A cannot accommodate the default static IP
address 192.168.1.10, the default address must be changed during installation, as
described in “Install the System Controller” on page 10.

1
 Figure 1. Port A-Only Configuration

Figure 2. Port A and B Configuration

Understanding System Requirements

The Nyquist controller web-based UI requires a secure Hypertext Transfer Protocol
Secure (https) network connection to the Nyquist controller. Users can log in to the
Nyquist controller using the Google Chrome or Microsoft Edge web browser from a com-
puter or tablet running either the Windows 8.1 (or later) or Mac OS X 10.12.x (or later)
operating system (OS), or using the Safari browser from an iPhone or iPad device running

2
iOS 14 (or later). The UI can also be accessed via a Chrome or Edge browser-enabled
Android-based tablet or mobile device.
To access the server, type your server’s IP address (for example, 10.10.20.12) in your
browser’s address bar.

Whitelisted Web Addresses

The Nyquist controller requires access to specific Uniform Resource Locators (URLs),
commonly referred to as web addresses. Access to many of these web addresses is
required during installation; access to other web addresses, such as the address for the
Network Time Server (NTS) are required during runtime. The Information Technology (IT)
department for the site must whitelist the web addresses so that they can be easily
accessed as needed.
Nyquist controller access to these URLs can be checked via the Check Internet Site
Access feature on the System Parameters page or by pressing the Check Internet Site
Access button on the Network Wizard page during product activation.
The following table lists the URLs that must be whitelisted.

Table 1. Whitelisted Web Sites

URL Description
http://hostedactivation.com (specifically, Required for Nyquist controller License
http://hostedactivation.com/bogen) support
http://downloads.digium.com Required for downloads from Digium
Phone Module for Asterisk (DPMA)
http://downloads.asterisk.org/ (specifi- Required for sounds download
cally, http://downloads.asterisk.org/pub/
telephony/sounds/releases)
http://www.pjsip.org/ Required for PJSIP download
http://ftp.us.debian.org (specifically: http:/ Required during Linux package installa-
/ftp.us.debian.org/debian/) tion
http://deb.debian.org/debian/
https://deb.debian.org/debian/
http://security.debian.org (specifically: Required during Linux package installa-
http://security.debian.org/) tion

3
 Table 1. Whitelisted Web Sites (Continued)

URL Description
stun01.sipphone.com Required for STUN based IP address reso-
lution (This is used by the Nyquist control-
stun:stun01.sipphone.com
ler Web UI and should be enabled on the
computer that runs the web UI.)
https://raw.githubusercontent.com/ Serves unprocessed versions of files
stored in the GitHub repositories.
http://2431612419.airable.io The airable URL for Internet-based-radio
Audio Distributions
https://2431612419.airable.io
http://api.sound-machine.com The SoundMachine URL for Inter-
net-based-radio Audio Distributions
https://api.sound-machine.com
http://api.bogenedu.com/api/customers Required for Nyquist controller warranty
support
http://bogen-ssu.bogen.com/ Bogen System Software Update server.
Required for automatic Nyquist server
software and Nyquist firmware software
update notifications and downloads.
https://www.weather.gov/alerts Required for displaying weather alerts.
https://ipapi.co Required for automatically finding county
code for alerts.
https://api.weather.gov Required for obtaining alerts from the
National Weather Service.
http://openweathermap.org Required for obtaining current weather
conditions.
http://api.openweathermap.org
ns1.google.com Required for obtaining the Nyquist
server’s public IP address for Audio Distri-
resolver1.opendns.com
bution streams and for automatically find-
ing the county code for alerts.
dl-ssl.google.com Required for Nyquist installation and
updates to download and install Google
Chrome browser.
linux.teamviewer.com Required for Nyquist installation and
updates to download and install Team-
Viewer software.

4
URLs that are entered on the Nyquist controller System Parameters page are used
during runtime and include the URLs for the NTS, the Session Traversal Utilities for Net-
work Address Translation (NAT) (STUN) server, and the Traversal Using Relays around
NAT (TURN) server.
The default URLs for the STUN and TURN servers are not set. The default URL for NTS is
pool.ntp.org.

Network Application Services

Required application services will be installed automatically on the Nyquist controller as
part of the Nyquist software installation. All other network services must be already pres-

5
ent or installed manually on the associated network. The following table lists the services
and their locations:

Table 2. Network Application Services

Service Description Required Location
Apache Used as the web server to drive the Mandatory Nyquist con-
Nyquist controller web interface. troller
DHCP Supplies dynamic IP addresses to Optional Network and/
the Nyquist controller system or Nyquist
server and associated devices. controller
(DHCP is the acronym for Dynamic
Host Configuration Protocol.) It
also supplies the Trivial File Transfer
Protocol (TFTP) server IP address or
host name to devices on the net-
work via option_66.
DNS Resolves host names to IP Mandatorya Network
addresses. DNS is an acronym for
Domain Name System, a hierarchi-
cal naming system for computers,
servers, or other resources con-
nected to either the Internet or to a
private network.
ICE Resolves IP addresses behind Net- Optional Nyquist con-
work Address Translation (NAT)/ troller
firewall. Network
• Interactive Connectivity Establish-
ment
STUN • Session Traversal Utilities for NAT
TURN • Traversal Using Relays around
NAT
LDAP LDAP is used by the Nyquist con- Optional Network
troller to import users into the
Nyquist system.
NTP Provides date/time synchronization Mandatory Network
for the Nyquist controller and the
associated devices (IP Phones,
appliances). (NTP is an acronym for
Network Time Protocol.)

6
 Table 2. Network Application Services (Continued)
Service Description Required Location
SNMP Provides the Nyquist controller Optional Nyquist con-
Linux server statistics via Simple troller
Network Management Protocol
(SNMP) v1 through Port 161.
TFTP TFTP is used by IP phone and Mandatory Nyquist con-
Nyquist controller device provi- troller
sioning. A TFTP server runs on the
Nyquist controller on port 69 (the
standard TFTP port #).
Device provisioning files are stored
on the Nyquist controller in direc-
tory: /srv/tftp.
This is the only directory exposed
by the TFTP server.
a. Required for Nyquist software upgrades, updating license keys, adding new feature license keys,
using Internet-based features, e.g., Internet Radio service, weather alerts, weather conditions,
Routines API, Routine Webhook-Post action.

Network Ports
The following table lists the network ports required by the Nyquist System Controller and
the associated devices.

7
 Table 3. Network Ports Used by Nyquist

Service Description Port

Automatic Failover Local ports used for Automatic Failover support. 5405,2224,3121
These only need to be available between the two
servers.
DHCP Dynamic Host Configuration Protocol (Optional) 67, 68
DNS Domain Name System (Optional) 53
HTTP Phone provisioning (HTTP is an acronym for 8088
Hypertext Transfer Protocol)
HTTP Provide access to Bogen product information. 80
HTTPS Secure HTTP 8089
HTTPS Secure HTTP (HTTP over TLS/SSL); used to 443
provide access to Bogen product information.
IAX Inter-Facility Communications 4569
LDAP Lightweight Directory Access Protocol 389
LDAP over TLS Lightweight Directory Access Protocol over 389
Transport Layer Security (configurable)
NTP Network Time Protocol 123
ODBC Database connection (ODBC is an acronym for 3306
Open Database Connectivity.)
RLM Nyquist license activation via 5053
hostedactivation.com
RSYNC Used to synchronize files (Automatic Failover 873
Only)
RTP Audio Streams (RTP is an acronym for Real-Time 10000–20000
Transport Protocol.) (configurable)
secure-mqtt Nyquist control messages between Nyquist server 8883
and Nyquist appliances
Server Local port used for server management 5038
Management
DO NOT allow outside access to this port. During
system controller installation, an IP filter rule is
installed to block outside access to this port.
SFTP Provide access to Bogen product information. 22
SIP Session Initiation Protocol (SIP) Transfer Control 5060, 5061
Protocol (TCP)/User Datagram Protocol (UDP)
connections

8
 Table 3. Network Ports Used by Nyquist

Service Description Port

SIP over Web SIP WS/WSS connections 8088
Services
SNMP Simple Network Management Protocol (Optional) 161
TFTP TFTP connections 69

Installing and Configuring the Nyquist System Controller

The System Controller always uses Port A to communicate with Nyquist devices and,
optionally, to communicate with Internet-based services. See Figure 1, “Port A-Only Con-
figuration,” on page 2 and Figure 2, “Port A and B Configuration,” on page 2.
The System Controller must have a known IP address on the Port A network so that its
Web-based UI can be accessed via a supported browser. The System Controller ships with
Port A configured with static IP address 192.168.1.10. Before proceeding with the installa-
tion, verify that your Port A network can accommodate this static address.
Be sure to check the following:
• IP address 192.168.1.10 must be compatible with your network number. (Usually, this
requires a 192.168.1.x/24 or 192.168.1 class C network.)
• IP address 192.168.1.10 must not already be in use on your network.
• If your network has a DHCP server, it must be prevented from assigning IP address
192.168.1.10.
If your Port A network cannot accommodate IP address 192.168.1.10, determine an IP
address to use for the System Controller. During installation and setup, you will reconfig-
ure Port A to use that address. This will require temporarily connecting Port B to a net-
work with a DHCP server.
Alternatively, you can connect Port A directly to a computer that has an adapter tempo-
rarily configured with a subnet mask of 255.255.255.0 and an IP address in the
192.168.1.0/24 subnet, such as 192.168.1.1, and begin the System Controller installation
process. During the Network Wizard, configure the System Controller to use an IP
address appropriate for your Nyquist network. When the wizard prompts you to change
cables, connect the Port A network cable to the Nyquist network and continue the wiz-
ards using a computer on the Nyquist network (or a DHCP address from Port B).

9
Install the System Controller
Before installing your System Controller, ensure that you have your Nyquist License Acti-
vation Key(s).
To install the System Controller:
1 Unpack the System Controller and power cord.
2 Obtain an Ethernet cable (customer-supplied). If your network can accommodate IP
address 192.168.1.10, use the cable to connect Port A to your network. If you cannot
accommodate 192.168.1.10, use the cable to temporarily connect Port B to a network
with a DHCP server. (This could be your Port A network if it has a DHCP server.) If you
are connecting Port B to your office network, ensure that your DHCP server is not
assigning IP addresses on the 192.168.1.x subnet.
3 Connect the power cord to the back of the System Controller.
4 Toggle the power switch, located above the power cord, to the on (—) position. A
green light displays next to POWER at the front of the device.
5 Perform one of the following steps:
• If you connected to Port A in step 2 and are able to use the default static IP
address, 192.168.1.10, use the browser to access 192.168.1.10 and go to “Using the
Setup Assistant” on page 11.
• If you connected to Port B in step 2, determine the IP address that was assigned to
the System Controller by your DHCP server. (This can usually be determined by
interrogating your DHCP server. Look for a hostname of debian or
nq-sysctrl-003018xxxxxx or for the System Controller’s MAC address, which is
available on the chassis of the System Controller.) Use the browser to access this IP
address and go to “Using the Setup Assistant” on page 11.
• If you don't have access to the network switch or the facility DHCP server, it might
be necessary to download and install an IP scanner, such as Advanced IP Scanner
or similar, on your client computer to scan the network and identify the IP address
that was assigned to Port B. Look for the MAC address associated with Port B or a
hostname of "JET" in the scan results.

Note: These installation instructions also are available in NQ-SYSCTRL System Controller
Installation and Use provided with the shipment.

10
Using the Setup Assistant
After you enter the System Controller IP address in the browser, the following Welcome to
the Setup Assistant screen appears (Figure 3). If this screen does not display, check your
network cables and IP addresses and try again.

Figure 3. Setup Assistant

The Setup Assistant presents a series of wizards to guide you through the setup process.

Network Wizard
1 Click Continue on the Welcome to the Setup Assistant screen to launch the Network
Wizard screen. The Network Wizard, as shown in Figure 4, "Network Wizard",” allows
you to configure the IP address settings on Ethernet ports A and B.

11
 Figure 4. Network Wizard

2 In the Is Port A a Static IP Address or provided via a DHCP Server? field, select
Static IP Address.1
3 In the What is the IP Address for Port A? field, type 192.168.1.10 if you are using
the default static IP address for Port A; otherwise, type the static IP address that you
want to use for the System Controller on the Port A network.
4 In the What is the Subnet Mask for Port A? field, type the subnet mask, usually
255.255.255.0.
5 In the What is the Gateway for Port A? field, type the gateway address of your Port
A network.
6 Port B can provide access to the Internet if the Internet is not available through the
Port A network. If Port B will not be used, select DHCP Server from the Is Port B a
Static IP Address, provided via a DHCP Server, or Not Used? drop-down field and
go to step 8. This provides a fallback mechanism to access the Nyquist System Con-
troller in the event that access via Port A fails. Otherwise, continue with step 7.
7 If Port B will be used, indicate whether it will have a static or DHCP-assigned IP

1. Advanced installers will note that DHCP may be used to configure Port A, provided that the
dynamically assigned IP address is reserved in the DHCP server.

12
 address. If it will be static, specify the gateway address and network mask, as was
done previously for Port A.

Note: If Port B is set to DHCP to facilitate Internet connectivity, do not specify DNS or a
Gateway for Port A.

8 If either Port A or Port B uses a static IP address, enter one or more space-separated
IP address(es) of the Domain Name System (DNS) server(s) to be used.

Note: When using DHCP servers to assign IP addresses to both Port A and Port B, you do
not need to enter a DNS Server. Doing so could result in an invalid network configuration
that causes the Setup Assistant, the Network Wizard, or both, to become unresponsive
during the Reset Network Interfaces action described later.

Figure 5. Example of Completed Network Wizard

9 After completing the Network Wizard screen, click the Save and Reset Network
Interfaces button. Before doing so, however, be prepared to make any necessary
changes to the network cables, as you will only have two minutes to make these
changes (e.g., if you were unable to use 192.168.1.10 on Port A and were temporarily
using Port B to reconfigure Port A, you would need to connect Port A). When you are
ready, click Save and Reset Network Interfaces to display the Reset Network Inter-

13
 faces screen. If prompted, enter the Nyquist System Controller’s serial number, which
can be found on the bottom of the System Controller (see Figure 6, “Enter Serial
Number,” on page 14), then make any required cable changes, as needed.

Figure 6. Enter Serial Number

Reset Network Interfaces

The Network Wizard displays two countdown timers, as shown in Figure , Reset Network
Interfaces. The first timer represents the two minutes provided to make any required net-
work cable changes. The second timer represents the total time needed by the Network
Wizard's reset operation. Note the Total time left and wait at least that long for the reset
operation to complete and display the configurations (see Figure 7, "Configured Network
Interfaces").

Figure 7. Configured Network Interfaces

10 Once the reset finishes, use the browser to visit the IP address assigned to the System

14
 Controller from the Port A network.

Tip: To revisit the Network Wizard at a later time (e.g., when changing the Nyquist server’s IP
address), navigate to:
http://<syscontroller-ip-address>/setup/network

License Wizard
The Nyquist system launches the License Wizard screen, which shows the network config-
uration for Port A and (if used) Port B. See Figure 8, “License Wizard,” on page 15.

Figure 8. License Wizard

11 Verify that the network setup is correct before continuing. If the displayed IP
addresses are incorrect, click Network Wizard at the bottom of the page to go back
and make any required changes before proceeding with the License Wizard.
12 Click the Check Internet Site Access button and verify that all listed sites have a
SUCCESS status. If one or more sites failed, work with your IT department to verify
that the Nyquist system has an Internet connection; there are no firewall, DNS, or
gateway settings preventing connectivity; and all white-listed web addresses are
accessible from the Nyquist system’s network port.

15
13 Enter the product License Activation Key (LAK) for your system into the Enter a
Valid License Activation Key to Install field and press Activate Key.
For the E7000, the key format is xxxx-xxxx-xxxx-xxxx. For the C4000, the key format is
PCxx-xxxx-xxxx-xxxx-xxxx. Letters must be entered in uppercase. (All “0” characters in
the license string are the digit, zero.)

Important: If the LAK is already in use on a System Controller that is being replaced,
the LAK must first be released from the previous System Controller. If the
LAK was not released, contact Bogen Technical Support to request that the
LAK be released before using it on the replacement System Controller.

14 If you are replacing an existing System Controller running Nyquist C4000 software
with a new one, you can use the Import Keys button to import any license keys that
were exported from the previously configured System Controller.

16
15 For the C4000, repeat the previous step(s) to install any additional feature or option
License Activation Keys (format FCxx-xxxx-xxxx-xxxx-xxxx) that you may have pur-
chased. You can add as many feature or option License Activation Keys as needed.
Each one appears in the installed window following its activation (Figure 9).

Figure 9. C4000 Feature/Option License Activation Keys

You also can enter C4000 License Activation Keys for features or options through the
Admin Web UI after the initial installation. For more information about entering keys
through the Admin Web UI at any time after the initial system setup process is com-
plete and for feature License Activation Keys descriptions, see the C4000 Nyquist Sys-
tem Administrator Guide.

Note: For each License Activation Key, wait until the activation process completes. Do not
close the browser or the License Wizard screen.

16 Once all licenses have been imported and/or activated, press the Done button to pro-
ceed.
17 The End User License Agreement (EULA) appears next in a pop-up window (Figure 10,
“End User License Agreement,” on page 18).

17
 Figure 10. End User License Agreement

After reading the EULA, check the box to indicate that you have read and agree to the
license, then click Continue to complete the License Wizard.
The product key(s) are now listed under Installed License Activation Keys. For the
C4000, this includes a Node-Locked License Activation Key, which is preinstalled at
the factory on all C4000 System Controllers.
18 After entering all License Activation Keys, select Done. The Product Activation screen
appears (Figure 11, "Product Activation (C4000 and E7000)").

18
 Figure 11. Product Activation (C4000 and E7000)

This screen provides information about the software and features that are being acti-
vated.

Note: Do not interrupt or close the Product Activation screen.

Restarting the Server

After activation has been completed, the System Controller will restart.

19
Customer Information Wizard
After the product activation process finishes, the Customer Information Wizard screen
launches to collect product registration information for warranty purposes and to activate
the system's Software Update Subscription (SUS). (See Figure 12, “Customer Information
Wizard,” on page 20.)

Figure 12. Customer Information Wizard

19 Complete the form and click Continue.

20
Dialing Length Wizard

Figure 13. Dialing Length Wizard

If you already know how to configure a Nyquist system and want to skip the wizards,
click Expert Setup, which takes you directly to the Nyquist system's Login screen and
will not redirect you back to any of the wizards.
Note: If you select Expert Setup and have not set a new password, you will need to
enter the default username, admin, and the default password, bogen, to log into the
system. Login credentials are case sensitive.
After completing Expert Setup, you must manually complete system configuration
using the Admin Web UI (see the Nyquist System Administrator Guide).

20 On the Dialing Length Wizard screen, set the dialing length (number of digits) used by
stations in your system. Click Continue to advance to the next wizard.

Station Wizard

Figure 14. Station Wizard

21
21 On the Station Wizard screen, create the Admin Web UI station by entering the Exten-
sion and Name for this station. You can enter any value that does not start with a nine
(9). Click Continue to advance to the next wizard.

User Wizard

Important: The User Wizard specifies the administrative password for the System Con-
troller. We recommend that you create a strong password, click Show to
verify the entered password, and store the password in a secure location
(e.g., a trusted password manager application).

Figure 15. User Wizard

22 On the User Wizard screen, type an updated password for the Admin Web user. Click
Continue to advance to the next wizard.

Time Zone Wizard

Figure 16. Time Zone Wizard

23 On the Time Zone Wizard screen, set the time zone to be used by your system. Click

22
 Continue to advance to the next wizard.

Network Time Server Wizard

Figure 17. Network Time Server Wizard

24 On the Network Time Server Wizard screen, specify the Network Time Server—also
known as a Network Time Protocol (NTP) server—to be used by the Nyquist server.
Click Continue to advance to the next wizard.

Note: Keep in mind that your Nyquist server must be able to reach the Network Time
Server that you specify. If you specify an Internet-based server (e.g., pool.ntp.org,
time.google.com), you may need to update your network routers’ whitelist tables to allow
the network traffic.

If you are not keeping your Nyquist system connected to the Internet, you should
attempt to use a Network Time Server that is available on your private network; your net-
work router may provide a Network Time Service. Consult your local Information Technol-
ogy (IT) team for advice.

23
Zone Wizard

Figure 18. Zone Wizard

For the C4000, the number of zones that you can create depends upon your product
license. However, regardless of what size system license was purchased, the Zone Wizard
will only assist in creating a maximum of 20 zones. (Additional zones, if desired and
licensed, can be added via the Admin Web UI after the initial setup is complete.) If you
have purchased 20 or fewer zones, the system will automatically generate the zones.
You can delete an automatically generated zone by selecting the red X next to the zone
you want to delete.
You also can make edits to a zone by selecting the hyperlink of any zone parameter
(except for the Zone Number).

Name Identifies the zone by the user-created name. The name can
be alphanumeric (such as “Bldg 1”) and contain up to 30
characters.
Type Identifies the zone as being able to receive paging, time,
audio, or a combination of paging, time, or audio.

24
 Cut Level (dB) Sets the volume cut level for announcements. The volume
cut level can range from 0 to −42 dB. The default level is
−6 dB.
Audio Distribution Cut Sets the volume cut level for audio distribution playing to
Level (dB) stations in the zone. The cut level can range from 0 to
−42 dB. The default value is −24 dB.
Pre-Announce Tone Identifies what, if any, tone should play before an
announcement.
Multicast IP Address Identifies the IP address for multicast calls to the zone.
Multicast Port Number Identifies the port number for multicast calls to the zone.

For some parameters (Type and Pre-Announce Tone), you can select from the drop-down
menu that appears; for others, select the value, enter a new value, and select the check
box when done.

Or, you can select Skip Wizard and create your zones later through the Admin Web UI.
25 After all zones are created, click Save to advance to the Setup Wizards Complete
screen.

Setup Wizards Complete

Figure 19. Setup Wizards Complete

26 With all setup wizards completed, click Continue to go to the Nyquist Login screen.

Adjusting Final Network Configuration Settings

If you used a temporary network configuration for the setup of the Nyquist server, you
should now configure the server to use the permanent configuration.

25
Open the Network Wizard by entering the following URL in the browser's address bar:
http://<syscontroller-ip-address>/setup/network
Configure the permanent DHCP server, IP address, network ports, DNS setting, and/or
other settings.

Note: Remember that you may need to re-enter a new IP address into your browser’s
address bar to reconnect to the Nyquist server once the settings have been applied.

Logging into the Nyquist server

Before you can log into the Nyquist server, you must first install the Bogen Certificate
Authority (CA), which will allow your browser to recognize the Nyquist server as a trusted
server.
For details on how to install the Bogen CA, see “Installing the Bogen Digital Certification
Authority” on page 32
Once the Bogen CA has been installed, navigate to:
https://<syscontroller-ip-address>

Figure 20. Nyquist System Controller Login

The first time you log in to the server, enter a username of admin and the administrative
password specified in the User Wizard. If you skipped the User Wizard, the default pass-
word is bogen.

Update Server Software

Although not required, it is strongly recommended to check for software updates for the
Nyquist server.

26
To check the current version number of the Nyquist server, select About from the ham-
burger menu in the top-right corner of the admin page. The version will be shown at the
top of the page.
For detailed instructions on how to update the Nyquist server software, see “Updating
Nyquist Software” on page 28.

Note: Updating Nyquist server software will also install the latest firmware for the Nyquist
appliances.

27
Best Practices
This section details recommendations and best practices to use when:
• Updating the Nyquist system server software to a new software release
• Updating Nyquist appliance firmware (software stored on the appliance)
• Using System Backups

Tip: Whenever configuration changes are made, we recommend performing a System Backup
and using Export to save a copy of the backup on your local computer.

Note: Before configuring or using any Nyquist appliances, you must ensure that the appli-
ance firmware is updated to the latest release. The latest Nyquist firmware release can
also be downloaded directly (as a .tar.gz file) from the appropriate Bogen website:
E7000: https://www.bogen.com/dealers
C4000: https://www.bogen.com/c4000-resources

Updating Nyquist Software

Note: Before beginning the install process, make sure that your Nyquist system server can
access the required URLs or web sites (see “Whitelisted Web Addresses” on page 1) from a
supported browser.

New Nyquist server software may include patches to address known issues or new
releases that provide additional features.
When updating to a new Nyquist server software release, use the Admin Web UI to per-
form a system update unless directed by technical support. Performing a system update
ensures that all configuration data, call detail records, recordings, voice mail, and all
upload announcements, alarms, tones, and songs are retained and are available after the
system software update.
To check the current version number of the Nyquist server, select About from the ham-
burger menu in the top-right corner of the admin page. The version will be shown at the
top of the page.
To perform a system update:

1 On the navigation bar, select System Backup/Restore.

28
2 Select Create Backup to perform a System backup and use the Export feature to
save a copy of the system backup to your local computer. You may also want to create
backups of Recordings and Voicemail and export them.
3 From the navigation bar, select System Parameters.

4 From the System Parameters page, select System Update.

5 If the System Controller is connected to the Internet, click the Check for System
Updates button to search for and download the latest system update. (This may take
some time, depending on your internet connection speed.)

Some Nyquist system updates are only available by downloading them directly
from a Bogen website:
E7000: https://www.bogen.com/dealers
C4000: https://www.bogen.com/c4000-resources.

The system update file will typically be named nyquist-c4000-<version>.tar.gz

or nyquist-e7000-<version>.tar.gz. After downloading the file to your local
computer via a browser, the file can be uploaded to the Nyquist server via the
Upload button of the System Update page.

6 It is very important to read the Release Notes, which can be displayed by clicking the
blue button. They often contain critical information regarding the upgrade process.

Tip: Copying the notes to a word processor allows you to view the notes during the installa-
tion process and may be easier to read.

7 Install the latest version available for the Nyquist server, carefully following relevant
instructions from the Release Notes.

Warning Be aware that a system update can sometimes take several minutes, during which
time the device should never be powered down or interrupted.

8 Once the update has completed, we recommend regenerating the System Control-
ler’s server certificate. From the System Parameters page, select the Edit button,
then select the Generate Server Certificate button.

For a more detailed explanation, see Performing a System Update in the Nyquist System
Administrator Guide.
Perform the server system update process before updating Nyquist appliance software.

29
Assigning Permissions for New Features
After you have finished updating the Nyquist software, permissions for features intro-
duced by this new release must be set for the roles that will use these features.
To assign permissions for these new features:

1 On the navigation bar, select Roles.

2 On the Roles page, select the Permissions icon next to the role for which you want to
edit permissions.
3 On the Edit Permissions page, make desired changes.
4 Select Save.
For more information, refer to the Nyquist System Administrator Guide.

Updating Appliance Firmware

Note: Before beginning the install process, make sure that your Nyquist system server can
access the required URLs or web sites (see “Whitelisted Web Addresses” on page 1) using
the Nyquist Admin Web UI.

The firmware for all devices used with the Nyquist system must be compatible with the
software installed on the Nyquist System Controller, and all Nyquist appliances in a given
installation should be configured to run the same firmware version.
The latest Nyquist appliance firmware release can also be downloaded directly (as a
.tar.gz file) from the appropriate Bogen website:

E7000: https://www.bogen.com/dealers
C4000: https://www.bogen.com/c4000-resources.

The Nyquist appliance firmware will be named NyqUpdate-<version>.tar.gz.

Firmware can be updated for Nyquist appliances and Analog Station Bridge (ASB) devices
through the Admin Web UI or through the appliance’s web UI. For information about the
appliance’s web UI, refer to the device’s configuration guide.
Using the Nyquist Admin Web UI via the Firmware page, you can upload a firmware file
to the Nyquist system server, download firmware to an appliance or ASB, view a list of
appliances and stations and ASBs that are linked to a firmware name, set default firmware
for any stations and bridge devices to be added, and delete firmware entries.

30
To perform an appliance firmware update:

1 On the navigation bar, select Firmware.

2 Click the Check for Updates button to search for and download the latest device firm-
ware update.

Some Nyquist firmware updates are only available by downloading them directly
from a Bogen website:
E7000: https://www.bogen.com/dealers
C4000: https://www.bogen.com/c4000-resources.

The firmware update file will typically be named NyqUpdate-<version>.tar.gz.

After downloading the file to your local computer via a browser, the file can be
uploaded to the Nyquist server via the Upload button of the Firmware page.

3 It is very important to read the Release Notes, which can be displayed by clicking the
blue button. They often contain critical information regarding the upgrade process.

Tip: Copying the notes to a word processor allows you to view the notes during the installa-
tion process and may be easier to read.

4 To define this update as the default for all Nyquist appliances, select the Set as
Default Firmware button for this update.
5 To add or edit a custom note for this update, select the Edit button for this update,
modify the Notes field, and click Save.
6 To apply the update to one or more appliances, select the Device Selection button,
select one or more devices, and select the Update button.

Warning Be aware that a firmware update can sometimes take several minutes, during which
time the device should never be powered down or interrupted.

For a more detailed explanation, see Configuring Appliance Firmware in the Nyquist
System Administrator Guide.

31
Appendix A: Bogen Digital Certification
Authority

Installing the Bogen Digital Certification Authority

When your client (e.g., a web browser) connects to the Bogen device’s web application, the device’s
digital certificate is sent to the client to authenticate the identity of the device’s web application. The
client uses the Bogen Certification Authority (CA) certificate to authenticate the device’s digital certif-
icate, which verifies that the client is connecting to a valid server. If you do not install the Bogen CA
certificate, the browser will display a warning that it was unable to authenticate the server, displaying
a red Not secure warning immediately to the left of the browser’s address bar when you attempt to
access the Bogen device.

Installing Certification Authority on Windows System

To download and install the Certification Authority on a Windows device:

1 From your Chrome or Edge browser, type http://<device>/ssl/bogenCA.crt in the address bar,
where <device> is the Nyquist device’s IP address or DNS name (for example, http://
192.168.1.0/ssl/bogenCA.crt).

2 Select the downloaded file and select Open.

3 Select Open when prompted with “Do you want to open this file?”
4 Select the Install Certificate... button. The Certificate Import Wizard starts.
5 Select Current User, and then select Next.

Note: To allow all users on this Windows client to access the Nyquist device, select Local Machine
instead of Current User. You may be prompted for administrator credentials.

6 Select “Place all certificates in the following store”, then select Browse.
7 Select Trusted Root Certification Authorities, and then select OK.
8 Select Next.
9 Select Finish.
10 Restart the browser and log in to the device’s web application.

32
 You can also download and install the Certification Authority using a PowerShell command prompt
or script, which involves fewer steps.
To download the certificate to a CRT file, execute the following PowerShell command, replacing
<device> with the IP address or DNS name of the Nyquist device:
Invoke-WebRequest -Uri http://<device>/ssl/bogenCA.crt -OutFile
$env:TEMP\bogenCA.crt

If you wish to validate the certificate before importing it, execute the following command after
retrieving the CRT file:
(New-Object -TypeName Security.Cryptography.X509Certificates.X509Certificate2 -Argu-
mentList "$env:temp\bogenCA.crt").GetCertHashString()

The output will be the hash value (i.e., thumbprint) of the downloaded certificate, which should
match the following (as of the current release):
0A8248F69D970F8DD855D0E0592972DA64B1A845

To install the certificate for the current user, execute the following command:
Import-Certificate -CertStoreLocation cert:\CurrentUser\Root -FilePath
$env:TEMP\bogenCA.crt

That command installs the CA certificate into the CurrentUser certificate store, which only applies to
the current user. To install the certificate for all users on this machine, which requires administrator
privileges to execute, execute the following command:
Import-Certificate -CertStoreLocation cert:\LocalMachine\Root -FilePath
$env:TEMP\bogenCA.crt
Note: These commands can also be executed remotely using PowerShell Remoting, which may be helpful if the certifi-
cate needs to be installed on many client machines.

Installing Certification Authority on Mac System

To download and install the Certification Authority on a Mac:

1 From your Chrome or Edge browser, type http://<device>/ssl/bogenCA.crt in the address bar,
where <device> is the Nyquist system device’s IP address or DNS name (for example, http://
192.168.1.0/ssl/bogenCA.crt).

2 Save the downloaded bogenCA.crt file to the desktop.

3 Double-click the certificate file on the desktop.
The Keychain Access App opens.
4 Double-click the certificate to reveal the trust settings.
5 Change the top trust setting to Always Trust.
6 Close the Trust Setting window and enter the computer administrative password to save.
7 Restart the browser and log in to the Nyquist web application.

33
Installing Certification Authority on an Android Device

Note: The Android device WiFi must be connected to the same network as the Nyquist Server.

To download and install the Certification Authority on an Android device:

1 From your Chrome or Edge browser, type http://<device>/ssl/bogenCA.crt in the address bar,
where <device> is the Nyquist device’s IP address or DNS name (for example,
http://192.168.1.0/ssl/bogenCA.crt).

2 If prompted, verify your identity (e.g., enter your PIN or fingerprint).

3 Type a certificate name (e.g., “Bogen CA”), specify “VPN and apps” under “Used for”, and select OK
to install the certificate.

Installing Certification Authority on an iOS Device

Note: The iOS device WiFi must be connected to the same network as the Nyquist Server.

To download and install the Certification Authority on an iPhone Operating System (iOS) device:

1 From your Safari browser, type http://<device>/ssl/bogenCA.crt in the address bar, where
<device> is the Nyquist device’s IP address (for example, http://192.168.1.0/ssl/bogenCA.crt).
2 Select Go.
3 Select Allow when prompted to allow the download.
4 Select Close after the notification that a profile was downloaded.
5 Select Settings > General > VPN & Device Management.
6 Select the Bogen CA certificate under DOWNLOADED PROFILE.
7 Select Install.
8 If prompted, enter your passcode.
9 On the Warning page, select Install.
10 Select Done.
11 Select Settings > General > About > Certificate Trust Settings.
12 Under ENABLE FULL TRUST FOR ROOT CERTIFICATES, Enable the switch next to Bogen CA.

Viewing the Certificate

The following steps outline how to view and verify the TLS/SSL certificate that was provided by the
Nyquist device.

34
Important: The user interfaces for browsers change not infrequently, so the exact details may vary
from what is described in the following instructions. Some security packages can also
affect the information available, such as antivirus software that injects its own CA certif-
icate in lieu of the website’s actual certificate, which has the effect of hiding the actual
certificate from the user.

1 Browse to the Bogen device’s web application in your browser (using Safari on iOS, Chrome or
Edge on all other platforms).
2 Select the lock icon on the address bar of the browser (to the left of the URL).
3 Display the CA certificate by following one of the following steps:
a) On the Chrome or Edge browser, select Connection is secure, then select either Certificate is
valid, the certificate icon, or Certificate information to display the Certificate Viewer dialog.
Select the Details tab, then Bogen CA in the Certificate Hierarchy section.
b) On the Safari browser [MacOS or iOS only], select Show Certificate in the window that
appears.
c) As an alternative on Android devices, select the Android system’s Settings > Biometrics and
security > Other security settings >View security certificates, select the USER tab, and
select the Bogen certificate.
4 Verify that the Bogen CA certificate is selected and not the server certificate (the server certifi-
cate’s name will be an IP address). To verify that the certificate is valid, verify that the displayed
fingerprint values match the following:
SHA-1: 0A 82 48 F6 9D 97 0F 8D D8 55 D0 E0 59 29 72 DA 64 B1 A8 45
SHA-256: 6B D0 D5 8D C8 F7 E8 03 9E A3 F1 52 32 1D 9C 5C 58 8B 4E FA DF 03 43 64 34 C2 6C 63 C5 4A AC 46

35