Vidyo VidyoGateway Service manual

Product Version 3.2
Document Version E
October, 2015
VidyoGateway™
Administrator Guide

TABLE OF CONTENTS
© 2015 Vidyo, Inc. all rights reserved. Vidyo’s technology is covered by one or more issued or pending United States patents, as more fully
detailed on the Patent Notice page of Vidyo's website http://www.vidyo.com/about/patent-notices/, as well as issued and pending
international patents. The VIDYO logotype is a registered trademark of Vidyo, Inc. in the United States and certain other countries, and is a
trademark of Vidyo, Inc. throughout the world. VIDYO and the Vidyo family of marks are trademarks of Vidyo, Inc. in the United States and
throughout the world.
Overview ...........................................................................................................................................1
Conventions Used in This Guide.......................................................................................................1
1. VidyoGateway Server Models and Capacities...............................................................................2
Identifying Your VidyoGateway Model ..............................................................................................2
Capacity of the VidyoGateway Models .............................................................................................3
Maximum Number Concurrent Calls of the Same Type...............................................................3
Maximum Number Concurrent Calls of Different Types...............................................................4
Maximum Number Concurrent Calls of Different Types and Resolutions ...................................4
Discontinued VidyoGateway Model Capacities................................................................................4
VidyoGateway Physical Setup Guidelines ........................................................................................5
2. Understanding the VidyoGateway Configuration Procedure .........................................................6
Making Configurations on Your VidyoGateway ................................................................................6
Making Configurations on Your VidyoPortal for Your VidyoGateway...............................................6
Making Additional VidyoGateway Configurations.............................................................................7
3. Configuring Your Server................................................................................................................8
Logging in to the System Console of Your Server and Changing the Default Password ...............9
Configuring Network Settings at the System Console ...................................................................10
Supporting Multiple System Console Accounts .............................................................................14
Understanding System Administrator Console Menu Options ......................................................15
Understanding the More Options System Administrator Console Menu...................................18
Configuring FIPS on Your VidyoGateway Server ............................................................................19
Managing Network Routes ..............................................................................................................20
Adding a Network Route..............................................................................................................21
Removing a Network Route.........................................................................................................22
Removing all of Your Network Routes.........................................................................................23
Navigating Your Network Routes.................................................................................................23
Configuring SNMP ...........................................................................................................................24
Enabling SNMP............................................................................................................................25
Configuring an SNMPv2 Community String................................................................................26
Configuring Local SNMPv3 User (User-based Security Model).................................................27
Configuring an SNMP Notification...............................................................................................29

TABLE OF CONTENTS
iii
Managing Hostnames .....................................................................................................................32
Adding a Hostname.....................................................................................................................33
Removing a Hostname ................................................................................................................34
Removing all of Your Hostnames ................................................................................................35
Navigating Your Hostnames........................................................................................................35
Configuring Your SSH Port ..............................................................................................................35
Maintaining Pre-shared Keys ..........................................................................................................36
Generating a Pre-shared Key ......................................................................................................37
Exporting a Pre-shared Key.........................................................................................................38
Importing a Pre-shared Key.........................................................................................................39
Selecting the Default Pre-shared Key .........................................................................................40
Logging in to the Admin Portal........................................................................................................41
Setting the Language for the VidyoGateway Admin Pages ...........................................................43
4. Configuring RADIUS ...................................................................................................................45
Disabling FIPS Mode .......................................................................................................................45
Enabling RADIUS.............................................................................................................................46
Viewing the Current RADIUS Configuration ....................................................................................47
Modifying the RADIUS Configuration..............................................................................................48
Creating a RADIUS-Enabled Account.............................................................................................49
Viewing a RADIUS-Enabled Account ..............................................................................................50
Removing a RADIUS-Enabled Account ..........................................................................................51
Disabling RADIUS Authentication ...................................................................................................51
Creating a Local System Console Account ....................................................................................52
5. Configuring Your System ............................................................................................................55
Configuring the General Settings....................................................................................................55
Configuring the VidyoPortal Settings...........................................................................................55
Configuring SIP Settings..............................................................................................................57
Configuring H.323 Settings..........................................................................................................60
Configuring Audio Settings..........................................................................................................62
Configuring Video Loopback Settings ........................................................................................64
Configuring Quality of Service (QoS) Settings............................................................................65
Configuring the Waiting Room Prompts......................................................................................67

TABLE OF CONTENTS
iv
Configuring Advanced Settings...................................................................................................69
Understanding VidyoGateway Clusters ..........................................................................................71
Clustering Benefits.......................................................................................................................72
Cluster Configuration with a Legacy Gatekeeper Interface........................................................72
Deploying Multiple VidyoGateway Clusters ................................................................................73
Configuring Clusters ........................................................................................................................74
Understanding the Clustering Procedure....................................................................................75
Returning a Repaired Controller to Your System Setup .............................................................76
Replacing an Irreparable Controller to Your System Setup........................................................76
Configuring Your Standalone VidyoGateway..............................................................................76
Configuring Controller 1...............................................................................................................77
Configuring Controller 2...............................................................................................................79
Configuring Your Cluster Node ...................................................................................................80
Managing Services ..........................................................................................................................81
Adding a Service..........................................................................................................................82
Activating and Deactivating Services ..........................................................................................86
Deleting a Service ........................................................................................................................87
Editing a Service ..........................................................................................................................88
Understanding Call Types and Service Examples .........................................................................90
H.323 Outgoing Call Examples ...................................................................................................90
H.323 Incoming Call Examples ...................................................................................................90
SIP Incoming Call Using a Prefix Example..................................................................................91
SIP Incoming URI Dialing Example .............................................................................................91
Dialing From a Legacy H.323 Endpoint into a Vidyo PIN Protected Room ...............................92
TCS4 Delimiters............................................................................................................................93
Configuring Integrated Voice Response (IVR) Settings..................................................................93
Enabling Your IVR Settings ..........................................................................................................94
Configuring General IVR Settings................................................................................................94
Configuring Appearance IVR Settings.........................................................................................96
Configuring VidyoGateway IVR Screen Instruction Settings.....................................................100
Configuring VidyoGateway IVR Screen Prompt Settings..........................................................103
VidyoGateway IVR Screen Prompt Types .................................................................................105

TABLE OF CONTENTS
v
Importing and Exporting VidyoGateway IVR Media and Prompt Settings ...............................107
Enabling and Disabling VidyoGateway IVR Settings ................................................................108
Checking the Status of Your VidyoGateway .................................................................................108
Capturing and Downloading Single Application Logs..............................................................108
Viewing Single Application Logs ...............................................................................................110
Viewing Call Statistics ................................................................................................................112
Configuring a Public IP Address and Viewing Your VidyoGateway Network Settings ................114
Configuring a Public IP Address................................................................................................114
Viewing Your VidyoGateway Network Settings .........................................................................115
Understanding VidyoGateway Security.........................................................................................116
Securing Your VidyoGateway System with SSL and HTTPS........................................................117
Importing, Exporting, and Regenerating an SSL Private Key...................................................117
Generating and Viewing an SSL CSR .......................................................................................121
Certificates Received from Your Certificate Authority ...............................................................123
Uploading or Editing Your Server Certificate ............................................................................125
Deploying Your Server CA Certificates (Intermediates)............................................................129
Configuring HTTPS Port Settings for Your Admin Pages .........................................................131
Importing Client Root CA Certificates from the Advanced Tab................................................132
Enabling HTTPS on Your Vidyo Server......................................................................................139
Configuring Your Vidyo Server’s Management Interface and Port...........................................141
Configuring OCSP .........................................................................................................................143
Enabling OCSP in the VidyoGateway........................................................................................143
Disabling OCSP from the System Console...............................................................................145
Upgrading Your VidyoGateway .....................................................................................................146
Shutting Down or Rebooting Your VidyoGateway ........................................................................147
Logging Out of Your VidyoGateway..............................................................................................149
6. Auditing.....................................................................................................................................150
Downloading Audit Logs from Your VidyoGateway......................................................................150
Understanding Audit Log Content ................................................................................................151
Content Captured in the Audit Log............................................................................................151
Sample Audit Log Content ........................................................................................................151
7. Integrating VoIP Phones and IP PBXs .......................................................................................152

TABLE OF CONTENTS
vi
Network Topology..........................................................................................................................153
Connecting to VidyoConferences from VoIP Phones...................................................................153
Connecting to VidyoConferences Via an IP PBX ..........................................................................154
8. Integrating Direct Phone Calls with IVR Functionality ................................................................155
Phone Setups Using the IVR Functionality....................................................................................155
9. Using VidyoGateway Virtual Edition (VE)...................................................................................156
Understanding VidyoGateway VE Requirements .........................................................................156
Virtual Machine Provisioning Requirements .................................................................................157
Example Configurations.............................................................................................................158
Understanding VidyoGateway VE Support of VMware Features .................................................158
Installing VidyoGateway VE ...........................................................................................................159
Appendix A. Definitions.................................................................................................................167
Appendix B. Legacy TCS4 Delimiters ...........................................................................................169
Appendix C. Deployment Examples .............................................................................................170
Appendix D. NAT/Firewall Traversal..............................................................................................173
Appendix E. Reliability...................................................................................................................178
Limitations of Reliability Prediction Models...................................................................................178
General Prediction Methodology...................................................................................................178
Electronic Equipment Procedure...............................................................................................179
Component Parameters and Assumptions...............................................................................179
Supplier MTBF Data...................................................................................................................179
Subsystem MTBF Data Release Policy.....................................................................................179
MTBF Reliability .............................................................................................................................179

Overview
1
Overview
The VidyoGateway is a 1U rack-mountable server that connects VidyoPortal™ users with users on
systems using the SIP and H.323 videoconferencing protocols. The systems that use these
protocols are referred to as Legacy systems.
This document describes how to use the VidyoGateway to connect with a VidyoConferencing™
system that includes Legacy systems. It is written for system administrators who must set up and
maintain a VidyoConferencing system.
The VidyoGateway is also available as the VidyoGateway Virtual Edition, and can be run as a virtual
appliance. For more information, see Using VidyoGateway Virtual Edition (VE).
Note
To perform the setup and configuration described in this manual, you must have Admin
access to your VidyoGateway and Super Admin access to your VidyoPortal.
Terms used in this guide are defined in a separate section. For more information, see
Appendix A. Definitions. For more standard VidyoConferencing definitions, refer to the
VidyoConferencing Administrator Guide .
Conventions Used in This Guide
Items marked with
Tip
indicate that the information is useful and practical.
Items marked with
Note
indicate that the information deserves special attention.
Items marked with
Caution
indicate that not following the information provided may result in
unwanted or undesirable outcomes.
Text you type into an on-screen field or a browser address bar displays in a bold Consolas
font. Variables are shown in blue, surrounded by brackets:
http://[IP or FQDN address]
Cross-references to pages are shown in blue.
Navigational paths are delimited with greater-than symbols: Click Settings > Options.

2
1. VidyoGateway Server Models and
Capacities
Identifying Your VidyoGateway Model
VidyoGateway is available in Standard and XL platforms. The previously offered VidyoGateway
MKII has been discontinued and replaced with the VidyoGateway XL model. The XL model is a
higher capacity, more powerful system for more demanding applications.
For more information, refer to the
Vidyo Server Installation Guide .
The current VidyoGateway looks like the following:
The discontinued VidyoGateway MKII looks like the following:
You can identify your VidyoGateway model by checking the hardware:
Current VidyoGateway hardware version numbers contain 31230 or 5645 combinations
Current VidyoGateway hardware labels contain an 02-0A combination
Previous VidyoGateway hardware labels contain 00-0A, 01-0B or 01-0A combinations
Starting with software version 2.1.3.22, you can also identify your model by looking at the top of the
VidyoGateway Configuration Page . The model information is shown as follows:
Model: VidyoGateway, VidyoGateway XL, or VidyoGateway MKII
Software version: 2.x.x.xx
Hardware Version: xxxxxxx

1. VidyoGateway Server Models and Capacities
3
Capacity of the VidyoGateway Models
The following tables show the maximum number of concurrent calls allowable for different
scenarios including: calls of the same type, different types, and different types and resolutions. All
capacity data is based on software version 2.1.3.22 and later.
Maximum Number Concurrent Calls of the Same Type
Capacity
VidyoGateway
VidyoGateway
VidyoGateway
MKII
VidyoGateway
VidyoGateway
XL
Hardware
Label
xxxx-00-0A
xxxx-01-0A
xxxx-01-0B
xxxx-00-0A
xxxx-01-0A
xxxx-01-0B
xxxx-MKII 00-
0A
xxxx-MKII-01-
0A
xxxx-02-0A xxxx-02-0A
Status Previous
model
Previous
model
Previous
model Current model Current model
H.235
Encryption Off On On/Off On/Off On/Off
HD 1080P
Calls,
30 fps
N/A N/A N/A N/A 2
HD 720P
Calls,
30 fps @
1 Mbps
1 1 3 1 5
SD Calls
@ 512
Kbps
4 3 12 4 15
CIF Calls
@ 384
Kbps
12 9 24 12 25
Voice
Calls 50 50 50 50 50

1. VidyoGateway Server Models and Capacities
4
Maximum Number Concurrent Calls of Different Types
The following list shows the maximum number of concurrent calls of different types and resolutions
that the VidyoGateway models can handle with software version 2.1.3.22 and later.
SD & CIF
1 SD + 9 CIF
2 SD + 6 CIF
3 SD + 3 CIF
Maximum Number Concurrent Calls of Different Types and
Resolutions
The following table shows the maximum number of concurrent calls of different types and
resolutions that the VidyoGateway XL can handle with software version 2.1.3.22 and later.
HD & SD
HD/SD/CIF
SD & CIF
HD & CIF
1 HD + 12 SD 1 HD + 6 SD + 6 CIF 3 SD + 18 CIF 3 HD + 6 CIF
2 HD + 9 SD 2 HD + 3 SD + 6 CIF 7 SD + 10 CIF
3 HD + 6 SD 3 HD + 1 SD + 4 CIF
4 HD + 3 SD
Note
When a Legacy device attempts to join a conference whose VidyoGateway is operating at
full capacity, the call fails to connect.
Discontinued VidyoGateway Model Capacities
These tables show the maximum number of calls the previous VidyoGateway models running
2.1.3.20 or later software version can handle simultaneously when all calls are of the same type
and resolution with and without H.235 encryption.
VidyoGateway (previous model)
1 x HD 720p30fps @ 1 Mbps
4 x SD @ 512 Kbps
12 x CIF @ 384 Kbps
50 x voice-only calls

1. VidyoGateway Server Models and Capacities
5
VidyoGateway (previous model) using H.235 Encryption
1 x HD 720p30fps @ 1 Mbps
3 x SD @ 512 Kbps
9 x CIF @ 384 Kbps
50 x voice-only calls
VidyoGateway MK II with or without H.235 Encryption
1 x HD 720p30fps @ 1 Mbps
12 x SD @ 512 Kbps
24 x CIF @ 384 Kbps
50 x voice-only calls
VidyoGateway Physical Setup Guidelines
When physically setting up your VidyoGateway, Vidyo recommends the following guidelines:
Locate the VidyoGateway as close as possible to your Legacy system(s), preferably on the
same LAN.
If the Legacy systems are in dispersed locations, install the VidyoGateway on the same LAN as
your VidyoRouter™.
If the VidyoGateway is on a QoS network, give high priority to the traffic between the
VidyoGateway and the Legacy system(s). Specify lower QoS for traffic between the
VidyoGateway and your VidyoRouter.

6
2. Understanding the VidyoGateway
Configuration Procedure
The overall procedure for configuring your VidyoGateway requires cumulative steps performed on
both the VidyoPortal and the VidyoGateway as described in the following procedures. Complete all
of the following steps on your VidyoGateway and VidyoPortal in the order they appear.
Note
If you are clustering VidyoGateways, perform the entire procedure for each VidyoGateway in
your cluster.
Making Configurations on Your VidyoGateway
To make configurations on your VidyoGateway:
1.
Configure your network interface settings in the VidyoReplay System Console. The
following criteria should be met:
a.
Set your production and management interfaces with IP addresses.
b.
Rack your machine properly.
c.
Successfully Ping your server before proceeding.
For more information, see Configuring Network Settings at the System Console.
2.
Secure your VidyoGateway server (if applicable).
For more information, see Securing Your VidyoGateway System with SSL and HTTPS.
3.
Register your VidyoGateway to your VidyoPortal by entering your VidyoPortal address in
your VidyoGateway.
For more information, see Configuring the VidyoPortal Settings.
Making Configurations on Your VidyoPortal for Your
VidyoGateway
To make configurations on your VidyoPortal for your VidyoGateway:
1.
Add the VidyoGateway as a component to the VidyoConferencing system.

2. Understanding the VidyoGateway Configuration Procedure
7
Note
If you performing an initial VidyoGateway setup, you must add the VidyoGateway as a
component in your VidyoConferencing system.
For more information, refer to the “Adding a VidyoGateway to Your VidyoPortal” section in
the
VidyoConferencing Administrator Guide .
2.
Assign the VidyoGateway to a tenant. If you are running a multi‑tenant system, assign it to
the appropriate tenant.
For more information, refer to “Making the VidyoGateway Components Available” in the
VidyoConferencing Administrator Guide .
Making Additional VidyoGateway Configurations
Now you can configure additional VidyoGateway features as needed, such as:
If desired, set up unique service prefixes, or use any of the predefined services.
For more information, see Managing Services and Understanding Call Types and Service
Examples.
Perform the following configurations as needed:
To connect to an NTP server, see Configuring Network Settings at the System Console.
To upload image files for video loopback, see Configuring Video Loopback Settings.
To view the network settings, see Viewing Your VidyoGateway Network Settings.
To check the status of your VidyoGateway, see Checking the Status of Your VidyoGateway.
To upload a new security certificate, see Uploading or Editing Your Server Certificate.
To upgrade your VidyoGateway, see Upgrading Your VidyoGateway.
To restart the VidyoGateway, see Shutting Down or Rebooting Your VidyoGateway.
Create VidyoGateway clusters, if desired.
For information, see Configuring Clusters.
Integrate VoIP phones and IP PBXs as needed.
For more information, see Integrating VoIP Phones and IP PBXs, and refer to the Integrating
VoIP Phones and IP PBX’s with VidyoGateway Vidyo Technical Note.
For convenient access to Legacy systems (if you have them), add your video device in your
directory using
Users > Add Legacy Device in your VidyoPortal Super Admin portal.
For more information, refer to the
VidyoConferencing Administrator Guide .

8
3. Configuring Your Server
Immediately after you have physically installed your Vidyo server as described in the Vidyo Server
Installation Guide, you must configure your VidyoGateway as described in this chapter.
For more information about installing the Vidyo server and for Vidyo server specifications, refer to
the
Vidyo Server Installation Guide . You can access this document and other Vidyo product
documentation by registering at https://selfservice.vidyo.com/register/.
As you begin the configuration, keep the following deployment guidelines in mind:
Vidyo utilizes SSH to provide remote access to the System Administrator Console on your
Vidyo server over port 22 or 2222. In addition, Vidyo Customer Support may request access to
your Vidyo server over this same port in order to assist in troubleshooting any of your customer
issues.
When setting up your Vidyo server, always be sure to configure your firewall to only permit SSH
access from authorized networks and users. You can restrict Vidyo Customer Support SSH
access by configuring your firewall or contact Vidyo Customer Support for other options.
Restrict access to your VidyoGateway Admin portal by performing one of the following:
Block HTTP/HTTPS access from untrusted networks including the Internet.
Move the VidyoGateway Admin portal to the Management Interface (if you have not yet
configured your Management Interface, it must be configured at this time).
For more information, see Configuring Your Vidyo Server’s Management Interface and Port.
Change your VidyoGateway System Administrator Console default password. This must be
changed after the first log in. For more information, see the following procedure.
Configure the network settings at the System Console. You can view the settings (read-only) in
the VidyoGateway Admin pages.
Note
The screenshots in this section show the System Admin Console (also known as the Shell
menu) as seen after logging in via the terminal. The menu may look slightly different
depending on how you connect and what tool you use for your connection.

3. Configuring Your Server
9
Logging in to the System Console of Your Server and
Changing the Default Password
The very first time you log into your VidyoGateway server, you are required to change the default
System Console password to one that is more secure. This System Console account is also the
same one used when accessing the VidyoGateway Admin Portal.
To log in to the System Console (also referred to as the Admin Console) and change the default
password:
1.
Connect a keyboard and a VGA display directly to your server.
2.
Log in using the default Administrator account:
User Name: admin
Password: password (case sensitive)
3.
At the “login” prompt, enter admin.
4.
At the “(current) UNIX Password” prompt, enter password.
The password is case sensitive. You’ll be prompted to enter a new password and asked to
enter it again.
5.
At the “Password” prompt, type a new password.
When selecting a new password, follow these guidelines:
The password should not be too similar to the old password.
The default setting is at least three characters should be different from the old
password.
The password should not be too simple or too short.
The algorithm here is a point system to satisfy the min password length (the default is
length eight characters). The password gets extra points if it contains number, upper
case, lower case, or special character. Each point is equivalent to one character.
The password should not be a case change only of the old password or should not be
the reverse of the old password.

3. Configuring Your Server
10
6.
At the “Retype new UNIX password” prompt, type your new password again.
If the passwords don’t match, you’ll be prompted to try again. If the passwords match, the
System Console menu opens immediately.
7.
When you need to reset the password, use 13. Set 'admin' password.
Configuring Network Settings at the System Console
Your Vidyo server default IP is
192.168.1.110
and should be changed to align with your local area
network.
A network setup must be performed for each of your Vidyo servers.
To configure the network settings at the System Console:
1.
Log in to the System Console.
For more information, see Logging in to the System Console of Your Server and Changing
the Default Password.
The following illustrations show the System Console after you have logged in using a
keyboard and VGA monitor plugged directly into a VidyoPortal server.

3. Configuring Your Server
11
2.
Enter 1to configure IP Address.
3.
Enter 1for PRODUCTION INTERFACE or 2for MANAGEMENT INTERFACE depending on
which one contains the IP you want to configure.
Note
The Management Interface should not be used to transfer any media.
For more information, see Configuring Your Vidyo Server’s Management Interface and Port.

3. Configuring Your Server
12
4.
Enter 1 to select IPv4 (Static) as the address format.
The VidyoGateway system supports IPv4 only or IPv6 only mode. Dual stack mode is not
supported.
5.
Enter the server IP address, subnet mask, default gateway, MAC addresses, hostname,
domain name, and FQDN.
Press
Enter
after entering each setting.

3. Configuring Your Server
13
6.
Once you have entered the required information, enter yand press
Enter
.
7.
Enter 2to configure the DNS Nameserver to set the fully qualified domain name (if it exists)
for the VidyoPortal and the IP addresses of the DNS servers:
a.
Enter two DNS server IP addresses. If you have only one DNS server, use the same
one twice.
b.
Once you have entered the required information, enter yand press
Enter.
The System Console main menu appears.
8.
Enter the remaining network settings for the server as needed, confirming by entering y
and pressing
Enter
after entering each setting:
a.
Enter 3to configure NTP Time Servers to set the NTP (Network Time Protocol) time
server.

3. Configuring Your Server
14
b.
Enter 4to configure Time Zone to specify the time zone you are working in.
c.
If necessary, enter 5to Configure Ethernet Options to set the MTU (Maximum
Transmission Unit) size.
9.
Enter 14 to restart the server.
When the server restarts, it will have the new network settings. Be sure to record your
network settings, as you will need them for further configuration of your system.
Supporting Multiple System Console Accounts
System Console accounts can be used on the VidyoPortal, the VidyoRouter, and the
VidyoGateway.
The System Console menu allows for the creation of up to ten System Console accounts. These
accounts are created from the System Console.
To create System Console accounts:
1.
Log in to the System Console.
For more information, see Logging in to the System Console of Your Server and Changing
the Default Password.
2.
Enter mfor more options.
3.
Enter 19 for User Administration.
The User Maintenance screen provides the following options:
Enter Ato add a user.
Enter Bto remove a user.
Enter Cto show all user accounts.