Media Gateway 1.4.1 User's Guide
Media Gateway 1.4.1 User's Guide
1
User’s Guide
HVS-ID-UG-MGW-1.4.1, Issue 01
Table of Contents
About This Content
About Haivision™. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Reliability of Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Obtaining Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Service Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Typographic Conventions and Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Alert Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Appendix A: Troubleshooting
Known Issues and Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Technical Support and Updates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Appendix C: Warranty
Haivision One (1) Year Limited Warranty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Haivision Software End-User License Agreement . . . . . . . . . . . . . . . . . . . . . . . . 126
Copyright
© 2016 Haivision. All rights reserved.
Title: Media Gateway User’s Guide
Document Number: HVS-ID-UG-MGW-1.4.1
Issue Number: 01
This publication and the product it describes contain proprietary and confidential informa-
tion. No part of this document may be copied, photocopied, reproduced, translated or
reduced to any electronic or machine-readable format without prior written permission of
Haivision. If this document is distributed with software that includes an end-user agree-
ment, this document and the software described in it, are furnished under license and may
be used or copied only in accordance with the terms of that license. Except as permitted by
any such license, no part of this guide may be reproduced, stored in a retrieval system, or
transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise,
without the prior written permission of Haivision Systems, Inc. Please note that the content
in this guide is protected under copyright law even if it is not distributed with software that
includes an end-user license agreement.
Trademarks
The Haivision logo, Haivision, and certain other marks used herein are trademarks of
Haivision. All other brand or product names identified in this document are trademarks or
registered trademarks of their respective companies or organizations.
Disclaimer
The information contained in this document is subject to change without notice. Haivision
assumes no responsibility for any damages arising from the use of this document, including
but not limited to, lost revenue, lost data, claims by third parties, or other damages.
If you have comments or suggestions, please contact:
Haivision
ATTN: Information Development
4445 Garand
Montréal, Québec, H4R 2H9 Canada
NOTE
A login is required to access the Haivision Download-Center.
Welcome to the Media Gateway Version 1.4.1 User’s Guide. This document describes how
to configure and manage the Haivision Media Gateway.
Topics Discussed
About Haivision™ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Reliability of Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Obtaining Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Service Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Typographic Conventions and Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Alert Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
About Haivision™
Haivision is a global leader in delivering advanced video networking, digital signage, and
IP video distribution solutions. Haivision offers complete end-to-end technology for video,
graphics, and metadata to help customers build, manage and distribute their media content
to users throughout an organization or across the Internet. Haivision has specific expertise
in the enterprise, education, medical/healthcare, and federal/military markets.
Haivision is based in Montreal and Chicago, with technical centers in Beaverton, Oregon;
Austin, Texas; and Hamburg, Germany.
Audience
This user’s guide is intended primarily for users and network administrators responsible for
managing streaming operations in their organization. The various procedures are divided
into the following categories and identified by the intended audience.
Reliability of Information
The information contained in this user’s guide has been carefully checked and is believed
to be entirely reliable. However, as Haivision improves the reliability, function, and design
of its products, the possibility exists that this user’s guide may not remain current.
If you require updated information, or any other Haivision product information, contact:
Haivision
4445 Garand
Montréal, Québec, H4R 2H9 Canada
Telephone: 1-514-334-5445
Email: infodev@haivision.com
Or visit our website at: http://www.haivision.com.
Obtaining Documentation
You can download product documentation through the Haivision Download Center at
http://www.haivision.com/download-center/.
NOTE
A login is required to access the Haivision Download Center.
Service Support
Haivision is committed to providing the service support and training needed to install,
manage, and use your Haivision software.
For more information regarding service programs, training courses, or for assistance with
your support requirements; contact Haivision Technical Support using our Support Portal
at: http://www.haivision.com/support-portal-home/.
Document Conventions
The following conventions are used throughout this document.
Italics Used for the introduction of new terminology or for words being
used in a different context, and for placeholder or variable text.
Alert Elements
The following Alert elements are used to advise and counsel that special actions should be
taken.
TIP
Indicates highlights, suggestions, or helpful hints.
NOTE
Indicates a note containing special instructions or information that
may apply only in special cases.
IMPORTANT
Indicates an emphasized note. It provides information that you
should be particularly aware of in order to complete a task and
that should not be disregarded. IMPORTANT is typically used to
prevent loss of data.
CAUTION
Indicates a potentially hazardous situation which, if not avoided,
may result in damage to data or equipment, or minor to moderate
injury. It may also be used to alert against unsafe practices.
WARNING
Indicates an imminently hazardous situation which, if not avoided,
could result in serious injury or death.
The following content provides a product overview as well as a tour of the Media Gateway
Web interface.
NOTE
To install and connect the appliance, please refer to the Quick Start Guide that
accompanied the hardware.
Topics Discussed
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Basic Layout and Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Persistent Screen Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Variable Screen Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Interface Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Log In Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Browse Routes Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Administration Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
About Media Gateway Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Overview
Haivision’s Media Gateway is a networking infrastructure product for configuring, moni-
toring, and managing streaming routes between encoding and decoding devices. It is
designed to allow network administrators to quickly and easily configure source-to-desti-
nation and source-to-multiple-destination streaming routes, which can then be monitored
and tuned for optimal performance.
Features
What’s New
Version 1.4 supports supports DELL iDRAC and third-party Simple Network Management
Protocol (SNMP) tools.
HLS Output
Media Gateway can be configured to convert an incoming stream to HLS (HTTP Live
Streaming) format for output. HLS encryption is also supported.
Certificates
SSL certificates can be managed via the Security option in the Web interface.
Stream Conversion
Media Gateway can convert (re-encapsulate) a given MPEG stream payload to and from
SRT and TS UDP protocols. It can also generate multiple output streams from a single
input. Supported sources for streams include: Makito X Encoder (SRT), Media Gateway
(SRT), and Makito Classic Encoder (TS UDP). Supported streaming destinations include:
Makito X Decoder (SRT or TS UDP), Media Gateway (SRT), CoolSign, Furnace,
InStream, Stingray, and Mantaray (TS UDP).
NOTE
Media Gateway does not support third-party devices.
Unicast/Multicast Streaming
Media Gateway supports any combination of unicast in/out (TS over UDP, TS over RTP,
or SRT) and multicast in/out (TS UDP only).
Firewall Friendliness
Media Gateway makes it easy to establish inbound/outbound streams between Haivision
products that are behind corporate firewalls, with minimal intervention from IT.
Encryption
Media Gateway allows you to leverage the end-to-end stream encryption (AES 128/256)
component of SRT-enabled devices (see “Glossary” on page 116) including Makito X
encoders and decoders as well as additional Media Gateway products.
Stream Management
Media Gateway allows you to establish, manage and monitor streaming routes based on
configured sources and destinations. You can:
• Set SRT-specific source parameters (e.g., latency and passphrase).
• View real-time graph-based statistics (e.g., buffer time, actual latency, round trip time,
retransmit rate, packet loss, etc.) to help with tuning SRT parameters.
• Download SRT statistics to a .cvs file.
• Enable FEC and configure traffic shaping on a destination.
Network Routing
Provisioned with two or more NICs, the Media Gateway lets you route unicast or multicast
traffic from one network segment (e.g., SRT over WAN) to another network segment (e.g.,
TS-UDP over LAN).
Appliance packaging
Media Gateway is available as a hardware appliance with pre-loaded operating system and
software. The appliance can be easily upgraded, and has a console user interface to facili-
tate troubleshooting and low-level configuration.
Current
User/Logout
Title Bar
Settings Menu
You access the SETTINGS menu by clicking the icon on the toolbar at the top right of
every screen. The SETTINGS menu provides access to:
Browse Routes screen Allows you create and manage routes and their
source/destination nodes.
Administration screen Provides access to system configuration tasks (e.g.,
status, licensing, updating, and network
configuration) and user administration.
About Media Gateway dialog Opens a dialog that displays the version number,
build number, and copyright statement.
TIP
When requesting assistance, be sure to provide the build number displayed in the About
Media Gateway dialog to the support representative.
Current User/Logout
Identifies the user who is currently logged into the system. The LOG OUT action link
allows you to exit out of the system and return to the LOG IN screen.
Title Bar
Identifies the name of the current screen.
Action Bar
View Pane
Action Bar
Depending upon the current screen, the action bar provides quick action buttons for the
tasks available. Tasks are performed on all items listed in the view pane.
Sidebar
Depending upon the current screen, the sidebar provides a means to navigate various
options. Related options are grouped under different panels.
Panel
Options
View Pane
The view pane, depending on the current screen, displays the appropriate items, fields, or
status information.
Interface Screens
There are several main screens that you use when working with Media Gateway.
Log In Screen
When you start the Media Gateway interface, a LOG IN screen appears prompting you to
log into the system (“Logging into the Media Gateway Interface” on page 24).
Pagination
Option
Add Route
Expand All/ Button
Collapse Apply Button
All Buttons
Action Menu
Expanded
Route Listing
Collapsed
Route Listing
Title Bar
The Title Bar includes a drop-down menu to select how many routes to show per page. If
the number of defined routes is greater than this setting, then page controls are available
below the route listing. For example:
Action Bar
The Action Bar contains the following buttons:
• Expand All / Collapse All — Expands/Collapses the details of all routes, including:
node, name, protocol, address, type, and status.
• +Route — Click to add a new route. See “Creating a Route” on page 45.
• Apply — Used to apply multiple routes’ drop-down menu selections at one time.
View Pane
The view pane includes a listing of all configured routes. It includes the following for each
route when the routes are either expanded or collapsed:
• — Inactive
NOTE
Hovering over the indicator in the STATUS column opens a tooltip with more details (for
example, recent connection information, various thresholds being met, or errors, such as
“stream stops” and “video feed gets disconnected”).
Related Topics
• “Working with Media Gateway” on page 28
Administration Screen
The ADMINISTRATION screen allows you to connect to, manage, or add new devices.
The sidebar at the left lists the available actions. The currently selected action is indicated
with a blue hover highlight on the left side of the button. The view pane displays the appro-
priate fields or items for your chosen selection. Likewise, selections made in the view pane
may also alter the available fields or options in the view pane.
To navigate to the ADMINISTRATION screen, click the icon on the toolbar and click
Administration from the drop-down menu.
Sidebar
The sidebar groups the options into various panels:
• DASHBOARDS PANEL
• System Activity — Provides quick statistics on the system (CPU/memory usage
and system uptime), the current version of the software, Video-on-Demand (VOD)
bandwidth graph, and disk space statistics.
• Reports — Offers access to a number of different logs providing system, applica-
tion, and diagnostic messages.
• CONFIGURATION PANEL
• Media Platform — Provides the status and settings pane for pairing the Media
Gateway with a Media Platform.
• Licensing — Allows you to add Media Gateway licenses and view their band-
width limits and status.
• Network — Provides access to the network configuration settings as well as infor-
mation on the interfaces.
• Presets — Allows you to export the current configuration as a preset file and im-
port a preset file and apply it to the device.
View Pane
Displays the appropriate content based on the current selection in the sidebar.
Related Topics
• “Performing Admin Tasks” on page 61
The following content explains how to access and log into the Media Gateway.
NOTE
Before proceeding, make sure that the system is set up correctly and a network
connection is established as detailed in the Quick Start Guide. Contact your system
administrator for assistance with network configuration.
Topics Discussed
Accessing Media Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Logging into the Media Gateway Interface . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Media Gateway SSL Encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Logging Out of the Media Gateway Interface . . . . . . . . . . . . . . . . . . . . . . . . 27
Changing Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
NOTE
Reference the Important Notice document or contact your system administrator for login
credentials.
NOTE
To log into Media Gateway, ensure that your browser has cookies enabled.
2. When the browser accesses the Media Gateway website, it requests the security
certificate to confirm that the site is trusted. If a security certificate is not available or
is self-signed, a message similar to the following appears. See “Media Gateway SSL
Encryption” on page 25 for more details.
NOTE
Responses may vary depending upon the browser used.
IMPORTANT
Before proceeding or adding an exception for the site, check with your administrator
on the correct response.
3. At the LOG IN screen, enter your Media Gateway username and password. See the
Important Notice document for these credentials and more information.
4. Click the Log In button. The Web interface opens to the BROWSE ROUTES screen.
Related Topics
• “Log In Screen” on page 18
• “Logging Out of the Media Gateway Interface” on page 27
• “Media Gateway SSL Encryption” on page 25
• “Changing an Account’s Password” on page 95
using port 443. When a browser accesses the website, it requests the security certificate to
confirm that the site is trusted.
NOTE
The security certificate is stored at /opt/haivision/madra/conf/nginx/server.crt
Media Gateway ships with a self-signed SSL certificate key set which works with any
configured server hostname. However, web browsers do not consider self-signed certifi-
cates to be trusted, because they are not signed by a Certificate Authority. Consequently,
when accessing the website with a self-signed certificate, users see a security warning and
are prompted for authorization as shown below.
Supplying the Media Gateway with an SSL security certificate eliminates the security
warning, provides a means for users to verify a website, and ensures that the connection is
secure. See “Certificates” on page 86 for more details.
Related Topics
• “Certificates” on page 86
Log out
action link
NOTE
If there is no activity over a period of ~2 minutes, the system automatically logs you out of
the session.
Related Topics
• “Persistent Screen Elements” on page 15
• “Logging into the Media Gateway Interface” on page 24
Changing Passwords
IMPORTANT
For security purposes, change the password for each of the available accounts.
Information regarding user/password credentials should be safe-guarded. See
“Changing an Account’s Password” on page 95 for details of changing passwords.
The following content provides a Media Gateway overview and discusses how to work with
routes.
Topics Discussed
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Multi-site Live Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Multicast Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Run-Through Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Run-Through Example Recap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Working with Routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Creating a Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Editing a Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Starting/Stopping/Deleting a Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Viewing a Route’s Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Working with Destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Adding a Route’s Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Editing the Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Starting/Stopping/Deleting a Destination Node . . . . . . . . . . . . . . . . . . . . . . 60
Overview
Media Gateway enhances your Haivision ecosystem’s infrastructure to simplify the distri-
bution of live video/audio across multiple facilities, while maintaining bandwidth effi-
ciency at each of the locations.
Once in place, Media Gateway allows network administrators to quickly and easily
configure source-to-multiple-destination streaming routes, which can then be monitored
and tuned for optimal performance.
One of the most popular uses for Media Gateway is to distribute a live video/audio stream
across multiple facilities to a variety of devices. This might be done to stream a quarterly
all-hands meeting to remote sites, a class to remote campuses, and so forth.
While MPEG-based streams typically do not fare well traveling across the internet, the
latest Haivision SRT protocol easily optimizes streaming over unpredictable networks,
ensures end-to-end security, and traverses firewalls. Plus, Media Gateway allows stream
conversion to TS over UDP or TS over RTP, so you can utilize SRT technology with your
existing/older devices (even those not inherently SRT-capable).
In Media Platform, you also need to establish a connection between the video source (for
example, a Makito X Encoder) and one of the paired Media Gateways.
NOTE
The video source can be connected to the Media Gateway at any of the locations. It does
not have to be co-located with the Media Platform. The Media Gateway to which the
source is connected must, however, be identified as such on the Media Platform.
of the locations. The respective Media Gateways poll the Media Platform at intervals of
approximately 30 seconds, and download the routing configuration files.
NOTE
If you modify a multi-site live route on any of the associated Media Gateways, it is
eventually overwritten by the original configuration from Media Platform.
Source Forwarder
For the Media Gateway to which the video source is connected (the forwarder), Media
Platform creates a route consisting of one source and multiple destinations. The route is
identified by a name with the following syntax:
calypso-source-forwarder:sourceId-[ID]
A route with this name indicates that the Media Gateway is receiving traffic from a source
(e.g., a Makito X Encoder) and forwarding it to Media Platform. The source ID corresponds
to the ID of the source.
In the following sample screenshot, the route shows the Media Gateway (forwarder) prop-
agates the source to four destinations: one corresponding to an HLS stream for the local
audience, two for “forwarding” the live video to remote Media Gateways via SRT, and one
SRT Listener. The SRT Listener destination allows Media Platform to connect as an SRT
Caller to access the video for recording:
NOTE
The status of the SRT Listener destination may intermittently change from green to yellow
and back, because the Media Platform only establishes a connection as needed.
Source Receivers
For each Media Gateway (receiver) to which the live video is being sent, Media Platform
creates a route consisting of one source and one destination. The route is identified by a
name with the following syntax:
calypso-source-receiver:sourceId-[ID]
A route with this name indicates that the Media Gateway is receiving traffic from another
Media Gateway (the forwarder) for local output. The source ID corresponds to the ID of the
live video source.
In the following sample screenshot, the route shows the Media Gateway (receiver) propa-
gates the source to a single destination, corresponding to an HLS stream for the local
audience:
NOTE
If someone copies the HLS Destination URL and tries to view the video in a browser, they
get an authentication error. Viewers must be authorized through Media Platform.
2. After the live session is initiated, the video automatically streams to and is viewable
by the audience at all locations (as shown in the following diagram):
For more information, including complete instructions on how to configure a multi-site live
session, please refer to the Haivision Media Platform Administration Guide.
Multicast Workflow
The following workflow steps you through an encoder sending an SRT stream to a hosted
instance of Media Gateway on the cloud, which routes each destination segment. At the
remote sites, a Media Gateway (on the corporate LAN) converts the SRT protocol to a
format compatible with the local viewing devices.
A general overview of this workflow is provided in the following diagram:
In the above diagram, the cloud-based Media Gateway (located on the Public Internet or as
a Haivision Video Cloud (HVC) hosted option) is optional and only recommended for indi-
viduals who want to “own” the distribution or have concerns about low latency. A Media
Gateway can also be hosted on the LAN to allow multi-sites distribution.
NOTE
The various receivers are not always SRT-capable, but Media Gateway can accept
inbound SRT streams and flip these streams into a format compatible with internal
receivers.
Run-Through Example
TIP
You’ll find some helpful videos on our website that show you how this is done. Check out
http://www.haivision.com/ for more information.
Before stepping through this example, you need to have the Media Gateway installations
available in the cloud and on your local area network.
TIP
Use the tabs in one browser to point to the URL of each workflow element to create a
workspace. For example, access the Makito X web interface of your source on one tab,
the cloud Media Gateway on another, and so forth. This way, you can switch back and
forth between them.
3. The view pane lists the available streams. For this example, we are going to add a
stream that uses TS over SRT. Click the +Add button. If you have an existing SRT
stream, you can modify it instead.
NOTE
Refer to your Makito X documentation for more information on adding streams if you are
new to this process.
4. When the NEW STREAM screen opens, provide a stream name and specify the
TS Over SRT protocol. For video, select an active video encoder.
5. Under the Connection section, specify the mode as “Caller,” enter the address
for the Media Gateway (in the Cloud) and a Destination port.
TIP
If needed, switch to the appropriate browser tab or enter the URL for the cloud-hosted
Media Gateway to acquire this information.
6. Click Apply.
TIP
If needed, switch to the Makito X Encoder browser tab or enter the URL for the Makito X
Encoder to acquire this information.
• Enter the information for the LAN-based Media Gateway. Provide a name, the
address, and the port information.
NOTE
Protocols and types can have different configuration requirements. Data fields will appear
or disappear depending upon your choices. As just demonstrated, SRT protocols require
an address, in addition to a port, when they are running in Caller type.
TIP
If needed, switch to the LAN-based Media Gateway browser tab or enter the URL for the
LAN-based Media Gateway to acquire this information.
8. On the BROWSE ROUTES screen, expand the route to verify that the status lights
change to green.
TIP
If needed, switch to the appropriate browser tab or enter the URL for the LAN-based
Media Gateway to acquire this information.
4. Click +Destination.
5. In the NEW DESTINATION dialog:
• Enter the information for the Decoder. Provide a name and the protocol.
• In this example, we are using a protocol of TS over UDP so you also add the
Multicast address and port information.
• For this example, we are flipping the stream to multicast TS over UDP to accom-
modate older Makito X Decoders. So, you need to include the type address
and port information.
NOTE
Multicast addresses are in the range of 224.0.0.0 to 239.255.255.255.
4. Click Apply.
5. Repeat steps #2 and #3 as needed to define additional streams.
6. To ensure that everything is set up properly, verify that the stream(s) have green status
indicators.
Status Indicators
NOTE
Refer to your Makito X Decoder documentation for more information on displaying
streams.
NOTE
Be careful with running routes. Any of the following actions, when applied, override all the
destination states.
Creating a Route
To create a route:
Route Information
Enter the Route Name. If you want the route to be active as soon as it is created, click
the Start Route checkbox.
Source
A source is a live incoming transport stream. In this section you identify the encoding
device. After you have provided a Source Name, use the drop-down menu to select
the streaming Protocol. Depending upon your choice, additional fields appear:
• TS Over UDP and TS Over RTP — For these protocols, choose the stream type:
• For Unicast, supply the Port of the source.
• For Multicast, supply the Address and Port of the source. NOTE: Multicast
addresses are in the range 224.0.0.0 through 239.255.255.255.
• TS Over SRT — For this protocol, supply the port of the source. Selecting TS
Over SRT, opens an additional SRT Settings section.
SRT Settings
(Only for TS Over SRT protocols.) Specify the Mode:
• Caller — Actively initiates a connection the call request.
• Listener — Passively waits to receive a connection call request.
• Rendezvous — A special case where both source and destination try to initiate the
connection, while at the same time wait to receive a connection request from the
peer.
NOTE
If Caller or Rendezvous is chosen for Mode in the SRT Settings section, an Address field
is prefixed to the Port field in the Source section.
IMPORTANT
If Encryption is being used on the SRT stream, you must set the same passphrase as
is used in the encoder.
Destination
Each route can contain no or multiple destinations. This section allows you to add and
edit destinations, as well as perform actions, including start and stop destinations.
• Add Destination — Click the +Destination button to open a New Destination di-
alog; enter all required fields and click Apply. The destination is added to the list.
• Edit Destination — Click on a destination row to open the Edit Destination dialog
for the selected destination; make changes and click Apply. The changed value is
displayed in the list;
• Destination Actions — Click on a destination row, click on an action (such as
Start, Stop, or Delete).
IMPORTANT
Destination operations (add, edit, and actions), are not saved to the server until the
Apply or Create button is clicked on the ROUTE page.
4. To add the Destination, click the +Destination button at the bottom of the screen.
5. When the NEW DESTINATION dialog opens, provide appropriate settings for the
Destination. The required fields are identified with a blue asterisk. For information on
the various fields, see “Destinations” on page 49.
6. Checking the Traffic Shaping checkbox allows you to manually adjust the
maximum bitrate. Traffic Shaping controls the outgoing stream so that the inter-
packet time is constrained, in order to reduce the probability that TCP packets are
dropped in a session.
Enabling Traffic Shaping does not dynamically modify the video encoder bitrate.
Address / Port1,2 For TS only: Depending upon the type of SRT settings, this
field may require an IP address of transmission and the
listening port. NOTE: TS Over SRT only requires the Port
field.
Segment Duration For HLS only: Maximum media segment duration (in
seconds).
A target duration of 10 seconds is recommended, and is the
default if no target duration is specified.
Shorter segments may increase network overhead for the
client. Longer segments will increase broadcast latency and
initial startup time.
NOTE: Apple strongly recommends a 10 second target
duration. If you use a smaller target duration, you increase
the likelihood of a stall. If you've got live content being
delivered through a CDN, there will be propagation delays,
and for this content to make it all the way out to the edge
nodes on the CDN it will be variable. In addition, if the client
is fetching the data over a cellular network there will be
higher latencies. Both of these factors make it much more
likely you'll encounter a stall if you use a small target
duration.
1. Required field.
2. Field availability depends upon other selections made.
7. When you have finished entering the required data, click the Create button to specify
the destination. Note: The newly created destination is added locally (at this point, no
server call is made).
8. When finished entering all your destinations, click Apply. Now the configurations,
including route, source, and destination(s), are saved to the server.
The route listings should now be updated appropriately. Use the Expand All button
to view Source and Destination specifics.
Related Topics
• “Editing a Route” on page 52
• “Starting/Stopping/Deleting a Route” on page 52
• “Viewing a Route’s Statistics” on page 53
• “Adding a Route’s Destination” on page 58
Editing a Route
To edit a route:
1. On the BROWSE ROUTES screen, click the Route Name for the listing you want to
edit.
2. In the the EDIT ROUTE screen, adjust the settings as desired.
3. Click the Apply button to save the new settings.
Related Topics
• “Creating a Route” on page 45
• “Available Route Settings” on page 48
• “Adding a Route’s Destination” on page 58
• “Starting/Stopping/Deleting a Route” on page 52
• “Working with Routes” on page 45
• “Viewing a Route’s Statistics” on page 53
Starting/Stopping/Deleting a Route
NOTE
Starting a route also starts its source and destination(s).
To start a route:
1. On the BROWSE ROUTES screen, locate the desired route listing and select Start,
Stop, or Delete from the drop-down menu at the end of the listing.
Route drop-
down menu
2. Click Apply.
Related Topics
• “Creating a Route” on page 45
• “Available Route Settings” on page 48
• “Adding a Route’s Destination” on page 58
• “Editing a Route” on page 52
• “Viewing a Route’s Statistics” on page 53
Statistics
button
3. When the Statistics Overview page appears, you can view the pertinent data for the
routes’ source and destinations.
Typically, the Statistics fields order of appearance is consistent. However, a field is not
displayed if it has no value.
Refresh Rate
drop-down menu.
5. To view the data graphically, click the icon for the desired route.
When the Statistics Graph View window opens, it displays the data numerically and
graphically for that route. This window opens separately so that you can keep it open
for monitoring — even create a dashboard of one or more devices. This window re-
mains open until you manually close it.
Download .CSV
button
Timescale Interval
drop-down menu
Checkboxes to
filter data compo-
nents from graph
6. To save the data for use with another application (such as a spreadsheet), click the
Download CSV button. Typically, this downloads the data in a comma-separated
values text file. For Safari browsers, this displays the file in a new window. Right-
click the browser window and select “Save Page as...” to download the file.
7. You can adjust the real-time graph by:
• Setting the Refresh Rate with the drop-down menu in the title bar.
• Changing the scale interval using Timescale drop-down menu. This adjusts the x-
axis in the graphs. Options include: 5 minutes, 1 hour, and 24 hours.
• Checking/unchecking the checkboxes of each legend to display/hide data compo-
nents.
• Hover your mouse cursor over the graph to reveal the time and value of the select-
ed data point.
Related Topics
• “Creating a Route” on page 45
• “Available Route Settings” on page 48
• “Adding a Route’s Destination” on page 58
• “Starting/Stopping/Deleting a Route” on page 52
• “Reports (Logs)” on page 67
NOTE
Keep in mind that route actions, when applied, override all the Destination states. For
instance, performing a stop action on a route, once applied, stops any destinations for the
route as well.
To add a destination:
1. On the BROWSE ROUTES screen, click on a route that you want to add a destination to.
2. On the Edit Route page, click the +Destination button.
3. In the New Destination dialog, provide appropriate settings for the Destination. See
“Destinations” on page 49 for field specifics.
IMPORTANT
Destination operations (Add, Edit and Actions), are not saved to the server until the
Apply button is clicked on the EDIT ROUTE page.
1. On the BROWSE ROUTES screen, click the individual icon or the Expand All
button to reveal the destination specifics for the route.
2. Locate the destination you want to configure and click it to open the Edit Destination
dialog.
3. On the EDIT DESTINATION dialog, adjust the settings as desired. See “Destinations”
on page 49 for definitions of the fields.
The new settings appear in the Destination section for the route.
IMPORTANT
Destination operations (Add, Edit and Actions), are not saved to the server until the
Apply button is clicked on the BROWSE ROUTES screen.
NOTE
If the route is stopped, the Start/Stop options are not available.
The following content explains how to manage Media Gateway settings and status,
including system activity, network settings, and security.
NOTE
The intended audience for this content is system integrators and administrators with
administrative privileges.
For information on options and tasks available to non-administrative users, such as
browsing routes, please refer to “Working with Media Gateway” on page 28.
Topics Discussed
System Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Viewing the System Activity Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Clearing the Video Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Reports (Logs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Enabling Diagnostic Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Viewing Reports (Logs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Media Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Pairing Media Gateway with a Media Platform Server . . . . . . . . . . . . . . . . . 69
Creating your Ecosystem Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Acquiring a Pairing Passcode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Pairing the Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Viewing the Status of Media Gateway Connections . . . . . . . . . . . . . . . . . . . 72
Blocking New Media Gateway Connections . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Updating the Media Platform Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Clearing the Media Platform Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Disconnecting from a Media Platform Server . . . . . . . . . . . . . . . . . . . . . . . . . 74
Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Adding a Media Gateway License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Viewing the Status of a License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Viewing the Media Gateway Version Number . . . . . . . . . . . . . . . . . . . . . . . . 76
Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Configuring the Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Network Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Creating a Bonded Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Removing a Bonded Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Presets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Exporting and Importing Presets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Generating a Certificate Signing Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
System Activity
Media Gateway includes dashboards as a management tool to provide a quick view of the
overall system health:
• System Activity
• Reports (Logs)
The System Activity dashboard shows the current status snapshot of your system as a
whole, including disk space and Media Platform bandwidth.
System
Status pane
VOD
Bandwidth pane
The VOD Bandwidth pane charts usage in Mbps. The checkboxes below the graph allow
you to tailor the display to include information from Media Platform, the cache, or both.
Use the drop-down menu at the top of the chart to specify the display window for the graph
starting from now (that is, “0”). When the actual timeframe exceeds the specified display
window, only the most recent data of the specified length of time is displayed.
That is, if 5 Minutes is selected, only the last five minutes of data is displayed. Any data
older than five minutes is dropped from the graph.
Display window
duration
drop-down menu
Display window
duration along
X-axis
In the Disk Space pane, you see information regarding disk usage.
Operating System /
The bars are color-coded to alert you as designated space reaches usage thresholds:
Click Clear Video Cache to delete all of the locally-cached video previously downloaded
from Media Platform. When prompted to confirm, click Clear.
Related Topics
• “Viewing a Route’s Statistics” on page 53
• “Reports (Logs)” on page 67
• “Clearing the Video Cache” on page 66
• “Viewing the Status of a License” on page 76
• “Downloading System Updates” on page 93
• “Viewing the Media Gateway Version Number” on page 76
Related Topics
• “Viewing a Route’s Statistics” on page 53
Reports (Logs)
Media Gateway generates a number of different logs providing system, application, and
diagnostic messages. These logs are described in the following table:
All Logs All system and application logs. Includes the Media Gateway logs
and System messages.
Media Gateway Log data from the Media Gateway processes. Including:
• madra_log_query — logs from the past week.
• /opt/haivision/var/log/kulabyte — KB Encoder logs, if present.
To enable logging:
1. On the ADMINISTRATION screen, click Reports on the sidebar.
2. Toggle the Enable Diagnostic Logging button to On.
3. Click Save Settings.
IMPORTANT
Diagnostic logging impacts system performance and should be enabled only as a
temporary troubleshooting measure. Diagnostic files are not deleted automatically and
eventually consumes all available disk space if left enabled.
To view a log:
1. On the ADMINISTRATION screen, click Reports on the sidebar.
Logs pane
2. In the Logs pane, click the desired log’s icon to download a zip file of the log’s
text files.
3. If you select “All Logs,” open the zip file and browse the folder structure:
Media_Gateway > opt > haivision > var > log
The log folder is populated with text log files with descriptive filenames to assist you
in identifying the appropriate file for the information you seek.
Related Topics
• “Viewing a Route’s Statistics” on page 53
• “Viewing the Status of a License” on page 76
• “Downloading System Updates” on page 93
• “Viewing the Media Gateway Version Number” on page 76
Media Platform
Media Platform-Media Gateway integration is used to distribute video to distant site loca-
tions, typically pairing a single Media Platform server with Media Gateway appliances at
each location. The Media Gateways provide a network of caching for Media Platform on-
demand videos. Users at each location can watch video from their local gateway device
(although they do not interact directly with the gateway).
2. Open another browser tab and enter the URL to the Media Gateway.
TIP
Within the Media Platform ADMINISTRATION screen’s Media Gateways panel, you can
use the action links (blue) in the Paired Media Gateway listing to open a tab to a particular
Media Gateway web interface.
1. In your Media Platform browser tab, click the icon and click Administration.
2. Click Media Gateways in the sidebar.
3. If the Pairing Passcode field is empty or disabled, click Generate to create a new
pairing passcode.
4. Copy the pairing passcode to the clipboard.
5. Make note of the Media Platform address and ports. If there is a cross-domain
address, make a note of it as well.
• Identify As— a descriptive or more user-friendly name for indicating the Media
Gateway.
• Address — the URL for the Media Gateway.
• HTTP Port
• HTTPS Port
4. In the Media Platform section of the Settings pane, enter the Media Platform
information that you noted earlier into the appropriate data fields:
• Address — the URL that the Media Gateway uses to connect with the Media
Platform server; that is, the private (inside the firewall or VPN) IP/hostname for
the Media Platform.
• Cross-Domain Address — the address used to host the Media Platform to the end
users; that is, the public-facing IP/hostname for the Media Platform. Typically
only necessary when deploying.
• HTTP Port
• HTTPS Port
• Passcode — Paste the passcode from your clipboard into the Passcode field.
5. Click Pair.
When the connection is made, the status indicator in Pairing Status turns green.
TIP
While the pairing is in progress, you can switch to the browser’s Media Platform tab to see
the status indicator turn green when the connection is made.
If the Pairing Status on the (Media Gateway) MEDIA PLATFORM screen displays the
message “Pairing timeout”, this may be an indication the Media Platform server is un-
available. Try the following:
• Check your local network.
• Confirm the availability of the Media Platform with which you are attempting to
pair.
• Click the Clear button and enter settings for an alternate Media Platform.
• Red — Error (Last poll request failed due to authorization, 404, or pairing
timeout).
• Gray — Disconnected (Last poll response was received over 5 minutes ago).
2. The MEDIA PLATFORM screen also tracks the connection’s duration in the Last
Connection field.
1. In your Media Platform browser tab, click the icon and click Administration.
2. Click Media Gateways in the sidebar.
3. Click the Disable button under Pairing Passcode.
1. In your Media Gateway browser tab, click the icon and click Administration.
2. Click Media Platform in the sidebar.
3. Change one of the settings, such as update the “Identify As” name to something new.
4. Click Update so that the new information is updated on the Media Platform server.
1. In your Media Gateway browser tab, click the icon and click Administration.
2. Click Media Platform in the sidebar.
3. Click the Clear button.
4. Click Confirm to verify that you want to clear the cache of the entries.
1. In your Media Gateway browser tab, click the icon and click Administration.
2. Click Media Platform in the sidebar.
3. Click the Disconnect button.
4. Click Confirm to verify that you want to disconnect from Media Platform.
Licensing
This section provides instructions to update your Media Gateway license. Any update other
than a maintenance release (for example, v1.1.x), requires a new license.
IMPORTANT
Please contact Haivision Technical Support to obtain a valid license key if needed.
Without a valid license key, you can log in. However, you won’t be able to create or
edit routes until you have imported a license.
Adding a license to the Media Gateway server requires administrator privileges and a
license key.
When a system is not licensed, the BROWSE ROUTES page displays a LICENSE
REQUIRED warning dialog. If the user’s role is administrator, the dialog displays an Add
License button.
-or-
Click the icon, click Administration, and click Licensing in the sidebar.
The Licensing view pane shows status information for the installed Media Gateway li-
cense, including its expiration date, version limit, and bandwidth limit (see following
example)
2. To update your license, type or paste the new license string in the text box.
TIP
Related Topics
• “Viewing the Status of a License” on page 76
Related Topics
• “Adding a Media Gateway License” on page 75
Option 1:
The About Media Gateway dialog opens to display the version information for the cur-
rent installation.
Option 2:
Current version
installed on the
device
Option 3:
Current version
installed on the
device.
Related Topics
• “Downloading System Updates” on page 93
• “Installing/Updating a Package (HaiBundle)” on page 93
Network
The Network Configuration settings allow you to specify the server hostname, DNS
servers, NTP server, search domains, and the default interface. This is also the screen where
you configure advanced settings for multiple network interfaces, NIC bonding, and static
routes.
7. Click Add Route. The Static Route is added to the listings on the Network
Configuration screen.
8. Click the Save Settings button.
9. Click the Reboot button to have your network configuration changes take effect.
Network Settings
Table 1. Network Settings
General
SNMP Trap Servers IPv4 or FQDN of a server to send SNMP traps to.
Interfaces
eth0 | eth1 | eth2 | ... Allows for multiple interfaces. Select the appropriate tab to
view and configure.
Link Select the link negotiation settings for the interface, either
Auto or Manual.
If you select Manual, you can select the Speed (10, 100 or
1000) and Duplex setting (Full or Half).
Bonding Mode (Bond Interface only) Modes for the Linux bonding driver
determine the way in which traffic sent out of the bonded
interface is actually dispersed over the real interfaces.
Modes 0, 1, and 2 are by far the most commonly used
among them.
• Round Robin Sequential: Transmits packets in first
available network interface (NIC) slave through the last.
This mode provides load balancing and fault tolerance.
• Active Backup: Only one NIC slave in the bond is active at
a time. A different slave becomes active only when the
active slave fails. This mode provides fault tolerance.
• XOR Sequential: Transmits based on XOR formula.
(Source MAC address is XOR’d with destination MAC
address). This mode selects the same NIC slave for each
destination MAC address and provides load balancing
and fault tolerance.
Slave Interfaces (Bond Interface only) Check this checkbox to enslave the
primary interface (e.g., eth0) to the bond interface (e.g.,
BOND0).
Static Routes
Interface The interface associated with the static route.Use the drop-
down menu to make your selection.
Add bond
interface link
The Bond0 tab appears and the Bond Interface: Remove action link replaces the
Add action link.
5. Clink the Bond0 tab to reveal the bonding-specific fields (such as Bonding Mode
and Slave Interface). See “Network Settings” on page 80 for more information.
6. Click the Save Settings button.
7. Click Reboot to have your changes take effect.
Presets
The System Presets screen allows you to export the current configuration as a preset file
with .hmg extension. It also allows you to import an exported preset file and apply the
preset to the device.
To export a preset:
To import a preset:
1. Click Browse to select an .hmg preset file containing the route’s configuration that
you want to apply to the current system.
After a file is selected, you warning message appears in the view pane.
2. Click the Import button to start importing.
3. After the upload is complete, the file is validated for the following:
• correct file extension (.hmg)
• correct JSON format
• it must contain at least one route configuration
• a route must have a source
• route name, source name and destination name are required and route name must
be unique
4. If an error occurs, an error message is displayed. If validation passes, then it starts
applying the preset.
5. While the system is applying the preset, a message “Applying preset...” is displayed
with a progress bar.
6. When complete, a message of “# routes created” is displayed.
Certificates
From the Certificates page, you can generate an SSL private key and certificate signing
request (CSR). You can then import the signed certificate and trust chain returned by the
Certification Authority (CA).
The Certificates page lists the Identity Certificates available on Media Gateway. An
Identity Certificate identifies the device during the authentication process when trying to
establish a TLS connection in HTTPS session startup. Its Common Name or Alternate
Subject Names must match its IP address and/or its FQDN (Fully Qualified Domain Name)
if DNS is used.
The default certificate is localhost.crt (self-signed).
c. For the subject, type in information about the device that the Identity Certificate
represents. For more information, see “Subject” on page 92.
NOTE
The generated CSR file needs to be sent to a Certification Authority to be signed. A copy
of it is saved in the current administrator’s home directory, or it can be copied and pasted
from the CSR view. You can import the signed certificate back later by clicking on the
Import button (using the same name as the CSR file).
6. Returning to the Certificates list, click the link for the generated CSR to open the file
in another tab. Copy the contents (including both beginning and ending delimiters)
and paste it into your Certificate Authority (CA) application.
The CA returns an intermediate certificate (trust chain) and signed certificate (CRT).
TIP
Keep in mind that there is a difference between importing a new certificate (that was
generated externally) and importing a newly signed certificate whose request was
previously generated on the Media Gateway and exported for signing.
5. Click Import.
On the Certificates page, the newly imported certificate is added to the list and should
have a green status LED. Click in the Active column to activate the certificate.
6. Click Reboot if you have changed the active certificate.
5. Click Generate.
CAUTION
Clicking Generate overwrites the current private key and renders unusable any
certificates based on that key.
The new certificate is added to the Certificates list, and becomes the active certificate.
6. Click Reboot.
c. To update your security certificate, click Browse and select the new SSL
Certificate and SSL Certificate (Private) Key, and optionally an SSL Intermediate
Certificate Bundle file.
5. Click Import.
On the Certificates page, the newly imported files are added to the list.
6. Click Reboot.
Certificate Settings
The following table lists the configurable Media Gateway Certificate settings.
NOTE
Please contact your Network Administrator if you are unsure what to put in any of these
fields or if you are unsure whether the setting is required on your network.
Certificate Description
Setting
Name Type in a unique name under which the certificate will be stored
on the Media Gateway as well as listed on the Certificate page.
Subject The Subject identifies the device being secured, in this case, the
Media Gateway.
The special value “auto” used with Generate sets the Subject
Common Name to the device’s FQDN if DNS is set, or the IP
address otherwise. Also, for self-signed certificates, the Subject
Alternative Name extension is also set to FQDN, hostname, and
IP Address of the device (there is no other method to set the
Subject Alternative Name).
Type in the subject in the form:
"/C=US/ST=Maine..."
where the most common attributes are:
• /C Two Letter Country Name
• /ST State or Province Name
• /L Locality Name
• /O Organization Name
• /OU Organizational Unit Name
• /CN Common Name
TIP: For successful authentication, the Common Name in the
certificate should be the IP address (by default) or domain name
of the device.
Import Certificate
Format Select the file format for the Certificate (the formats differ in the
way the file is encrypted):
• Auto: detected from the file extension
• der: Distinguish Encoding Rules
• pkcs #7
• pkcs #12
Update
Before upgrading a device, the update package must first be uploaded to the Media
Gateway server. If you do not see the update package you want, check with your adminis-
trator and make sure that it is available.
IMPORTANT
Any update other than a maintenance release (for example, v1.1.x), requires a new
license.
Related Topics
• “Viewing the Media Gateway Version Number” on page 76
• “Viewing the Status of a License” on page 76
• “Installing/Updating a Package (HaiBundle)” on page 93
NOTE
Your system restarts after it installs the updates.
To install a HaiBundle:
2. Click Update in the sidebar. The Update screen appears showing the currently
installed version and build.
3. Click Browse.
4. Select the desired update bundle (.hai extension) and click Open.
5. Verify that the bundle listed is the one you want to install, and click Upload.
6. When the bundle has been uploaded, click Update.
7. When prompted, click OK to confirm. Your system restarts after it has installed the
updates.
Related Topics
• “Downloading System Updates” on page 93
Accounts
To simplify setup and security, there are three built-in user accounts available: haiadmin,
haioperator, and haiobserver.
Default credentials for each account are provided in the Important Notice document.
Field Value
Account Name The user name for the account. Built-in accounts set up at the
factory include:
• haiadmin — Built-in Administrator account.
• haioperator — Built-in Operator account.
• haiobserver — Built-in Observer account
Role The role assigned to the account. Roles for built-in accounts
are read-only. Available roles include:
• Administrator — All access rights and administrator
privileges.
• Operator — All rights to create and configure routes. Does
not include rights to the Administration page.
• Observer — Read-only access to the system. Does not
include the rights to the Administration page.
Related Topics
• “Changing an Account’s Password” on page 95
5. Click Apply.
NOTE
The haiadmin password can also be changed in the Console UI. See “Changing the
haiadmin Password” on page 107 for details.
The hvroot password can only be changed in the Console UI. See “Changing the Current
User’s Password” on page 106 for details.
Related Topics
• “Viewing the Available User Accounts” on page 95
• “Changing the haiadmin Password” on page 107
• “Changing the Current User’s Password” on page 106
The following content explains how to use the console user interface (UI) on a Media
Gateway appliance. The Console UI provides a non-Web interface to perform basic system
administration tasks and network tests.
NOTE
To connect to the Console UI directly, make sure the keyboard and monitor are correctly
connected to the Media Gateway appliance. You can also access the Console UI using a
secure shell connection (SSH).
Topics Discussed
Accessing the Console UI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Showing General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Editing Network Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Testing the Network Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Viewing System Logs Available through the Console UI . . . . . . . . . . . . . . 104
Changing the Current User’s Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Changing the haiadmin Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Opening a Console UI Terminal Window . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Setting the Clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Setting the Timezone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Rebooting or Shutting Down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Logging Out of the Console UI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
NOTE
Use the TAB or (up and down arrow) keys to navigate the Console UI. There is no
mouse support.
The navigation sidebar (left pane) provides the menu/action items. The right pane displays
a detailed view of the selected item. To control the Console UI:
• Use the TAB or (up and down arrow) keys to scroll through the navigation listings
and text.
• Press ENTER to select the current item.
• To modify content, scroll to the line to change and, if necessary, backspace to delete
the existing content and then type in your modifications.
• Press ENTER to save your changes or ESC to cancel and close the screen.
NOTE
This is a read-only screen.
3. When you are finished reviewing the information, press ENTER or ESC to exit to the
main screen.
Related Topics
• “Accessing the Console UI” on page 98
• “Logging Out of the Console UI” on page 112
NOTE
These settings can also be changed in the web interface. See “Configuring the Network”
on page 79 for details.
3. To change a setting:
• Use the TAB or (up and down arrow) keys to navigate to the field you want to
change.
• Use the DELETE/BACKSPACE key to delete the existing contents and then type in
your modifications.
4. When finished editing the information, press ENTER to save your changes and exit to
the main screen. Or, press the ESC key to exit without saving any changes.
Related Topics
• “Testing the Network Settings” on page 102
• “Configuring the Network” on page 79
TIP
For descriptions of the network settings, please see the documentation that accompanied
your appliance.
The Test Network screen provides four possible network setting tests:
Test Description
Ping Gateway Press ENTER to ping the defined gateway IP (that is, to
send echo request packets).
• In the text entry field for your selected test, use the DELETE/BACKSPACE key to
delete any existing contents, then type in your modifications, and press ENTER.
An example of the Ping Gateway test results is shown below.
Related Topics
• “Editing Network Settings” on page 100
TIP
System logs are also accessible via the Media Gateway web interface. See “Viewing
Reports (Logs)” on page 67 for details.
The System Logs screen provides five possible systems logs to review:
Log Description
Log Description
3. To review a particular log, use the TAB or (up and down arrow) keys to navigate
to the log you want to view.
Related Topics
• “Viewing Reports (Logs)” on page 67
4. Press TAB or the (down arrow) and type the password again in the Confirm new
password line.
5. Press ENTER. Upon success, the prompt confirms that the password has been changed
and then returns to the main screen.
Related Topics
• “Accessing the Console UI” on page 98
TIP
The haiadmin password can also be changed in the Media Gateway web interface. See
“Changing an Account’s Password” on page 95 for details.
4. Press TAB or the (down arrow) and type the password again in the Confirm new
password field.
5. Press ENTER. Upon success, the prompt confirms that the password has been changed
and then returns to the main screen.
Related Topics
• “Changing the Current User’s Password” on page 106
Related Topics
• “Accessing the Console UI” on page 98
• “Logging Out of the Console UI” on page 112
4. Enter the appropriate values. Press TAB or the (down arrow) to move between the
fields.
Related Topics
• “Setting the Timezone” on page 110
NOTE
If you choose the option to specify the time zone using the POSIX TZ format, the format is:
Related Topics
• “Setting the Clock” on page 109
3. Use the (up and down arrow) keys to highlight either Reboot or Shutdown as
appropriate.
4. Press ENTER.
5. When prompted to confirm, press either:
• Y for yes
• N to cancel
After confirming your selection, the system either shuts down or reboots (as appropri-
ate). You are then automatically logged off and your secure shell (ssh) connection is
closed.
NOTE
If you selected to reboot, you can reconnect the secure shell (ssh) and log into the device
once the system has restarted.
Related Topics
• “Accessing the Console UI” on page 98
Related Topics
• “Accessing the Console UI” on page 98
If you have recently updated your web-based interface software, it is possible that your
browser’s cache is pointing to an older file. Clear your browser’s cache to ensure
that the interface accesses the most recently installed files.
To start the web-based interface, in your browser enter the base URL. For example:
http://127.0.0.1
To view the current release number for your Media Gateway installation, click the
icon and select ABOUT MEDIA GATEWAY.
Hover your mouse cursor over the status indicator. A popup will appear to provide
some context as to why there is an error.
Verify that you have entered the cross-domain address correctly. See “Pairing the
Devices” on page 71.
Glossary
AES Advanced Encryption Standard. A specification for the encryption of
electronic data established by the U.S. National Institute of
Standards.
AAC Advanced Audio Coding (AAC). A standardized, lossy compression
and encoding scheme for digital audio. Designed to be the successor
of the MP3 format, AAC generally achieves better sound quality than
MP3 at similar bitrates.
AAC-LD AAC Low Delay. An audio compression standard designed to
combine the advantages of perceptual audio coding with the low
delay necessary for two-way communication. It is closely derived
from the MPEG-2 Advanced Audio Coding (AAC) standard.
API Application Programming Interface. For the purposes of this
document, API refers to the collection of entities, operations and
supporting materials provided with the API.
aspect ratio The proportion of width to height of an image or screen.
audio bitrate The number of bits used per unit of time to represent an audio
stream. Measured in kilobits per second (kbps).
audio gain Measures of the ability of a circuit (often an amplifier) to increase the
power or amplitude of a signal from the input to the output, by adding
energy to the signal converted from some power supply. Measured
in decibels (dB).
AVC Advanced Video Coding. A standard for video compression, used for
the recording, compression, and distribution of high definition video.
B-frame Contains difference information from the preceding and following I-
or P-Frame within a Group of Pictures (GOP). Backward prediction
enhances encoding decisions for moving objects, but requires
significant increase in buffer size. Typically, most broadcast-quality
applications use IBBP to optimize video quality with compression
efficiency.
baseline profile Targeted at light applications such as video conferencing or
playback on mobile devices with limited processing power.
data panel A data panel is a special grouping of data fields that can be used to
aid when creating content that displays multiple rows of data in a
table-like format.
DEB DEB is the extension of the Debian Software Package format and the
most often used name for such binary packages.
deinterlace The process to convert interlaced video back into its non-interlaced
form. Employs complex algorithms; however, results vary.
DVR Digital Video Recorder. A device or application software that records
video in a digital format to a disk drive, USB flash drive, SD memory
card, SSD or other local or networked mass storage device.
directory rollover For HLS Akamai HD network distribution. When this box is checked,
it limits the number of .ts segments to 2000 before rolling over to a
new directory.
encoder/transcoder A computer or appliance that takes video and audio input or digital
video and audio input and encodes or transcodes to a digital format.
endpoint A URI that points to a function or operation provided by the API, e.g.,
/apis/demos.
VBR Variable Bit Rate. VBR streams vary the amount of output data per
time segment. VBR allows a higher bitrate to be allocated to the more
complex segments of media streams while less space is allocated to
less complex segments.
video bitrate The number of bits used per unit of time to represent a video stream.
Measured in kilobits per second (kbps).
VoD Video on Demand. An interactive technology that allows users to
select and view programming in real time or download programs and
view them later.
XML entity An XML opening and closing tag in combination with its payload. For
example, the “demo” entity refers to:
<demo>
<id>myID</id>
<name>myName</name>
<value>myValue</value>
</demo>
APPLICABLE LAW
This Limited Warranty is governed by and construed under the laws of the Province of Quebec, Canada.
This Limited Hardware Warranty may be subject to Haivision’s change at any time without prior notice.
1. DEFINITIONS
1.1 Entitlement. The collective set of applicable documents authorized by Haivision Network Video or
its affiliate Haivision (collectively “Haivision) evidencing your obligation to pay associated fees (if any) for
the license, associated Services, and the authorized scope of use of Licensed Software under this Agreement.
1.2 You (or Your). The individual or legal entity specified in the Entitlement, or for evaluation
purposes, the entity performing the evaluation.
1.3 License Fee. License Fee shall mean the consideration paid to Haivision for use of the Licensed
Software. The License Fee is part of the price paid for the relevant Product.
1.4 Licensed Software. Licensed Software shall mean the executable version of Haivision’s computer
software, program or code, in object code format (specifically excluding source code), together with any
related material including, but not limited to the Reference Manuals or database schemas provided for use in
connection with the Licensed Software and including, without limitation, all Upgrades through the date of
installation.
1.5 Reference Manuals. Reference Manuals shall mean the most current version of the documentation
for use in connection with the Licensed Software provided by Haivision to You.
1.6 Updates. Updates shall mean any periodic software releases, additions, fixes, and enhancements
thereto, release notes for the Licensed Software and related Reference Manuals, (other than those defined
elsewhere in this section as Upgrades) which have no value apart from their operation as part of the Licensed
Software and which add minor new functions to the Licensed Software, but none so significant as to warrant
classification as an Upgrade, which may be provided by Haivision to fix critical or non-critical problems in
the Licensed Software on a scheduled, general release basis. Updates to the Licensed Software (“Version”)
are denoted by number changes to the right of the decimal point for a version and revision number (for
example going from 2.0.0 to 2.1.3).
1.7 Upgrades. Upgrades shall mean any modification to the Licensed Software made by Haivision,
which are so significant, in Haivision’s sole discretion, as to warrant their exclusion under the current
license grant for the Licensed Software. Upgrades of Licensed Software are denoted by number changes to
the left of the decimal point for a release number (for example going from 2.0 to 3.0).
or residential purposes, or any license for content whatsoever. The license and rights granted to You in this
Section (2.) do not include the right to sublicense to distributors, resellers and other third parties any of the
rights granted to You in this Section (2.). All rights not expressly granted You in this Agreement are reserved
to Haivision and no implied license results from this license.
2.2 Restrictions.
(a) Reproduction. You shall not copy, distribute, reproduce, use or allow access to any of the
Licensed Software, except as explicitly permitted under this Agreement. You shall not modify, adapt, trans-
late, export, prepare derivative works from, decompile, reverse engineer, disassemble or otherwise attempt to
derive source code from the Licensed Software or any internal data files generated by the Licensed Software,
or use the Licensed Software embedded in any third party hardware or software. You shall also not use the
Licensed Software in an attempt to, or in conjunction with, any device, program or service designed to
circumvent technological measures employed to control access to, or the rights in other work protected by
copyright laws. You shall not remove, modify, replace or obscure Haivision’s copyright and patent notices,
trademarks or other proprietary rights notices affixed to or contained within any Licensed Software. No right
is granted hereunder for any third party who obtains access to any Licensed Software through You to use the
Licensed Software to perform services for third parties.
(b) Ownership. The Licensed Software is conditionally licensed and not sold. As between the
parties, Haivision and/or its licensors owns and shall retain all right, title and interest in and to all of the
Licensed Software, including all copyrights, patents, trade secret rights, trademarks and other intellectual
property rights therein, and nothing in this Agreement shall be deemed to transfer to You any ownership or
title to the Licensed Software. You agree that it will not remove, alter or otherwise obscure any proprietary
rights notices appearing in the Licensed Software. All Haivision technical data and computer software is
commercial in nature and developed solely at private expense.
5. INDEMNIFICATION
5.1 Indemnification by Haivision.
(a) Haivision shall indemnify and hold You harmless against any and all actions, claims,
losses, damages, liabilities, awards, costs and expenses (including reasonable attorneys’ fees) (“Claims”)
arising out of i) any accusation or purported violation of any third person’s US and copyright, trademark,
patent rights or trade secrets, proprietary information on account of Your use of the Licensed Software when
used in accordance with the terms of this Agreement, or (ii) relating to or arising out of any negligence or
wilful misconduct on the part of Haivision or any breach by Haivision of the terms of this Agreement or any
Maintenance and Support Agreement, or applicable law. You shall promptly notify Haivision in writing of
any such Claim and promptly tender the control of the defense and settlement of any such Claim to Haivision.
Haivision shall thereafter undertake the defense of any such Claim using counsel of its choice. You shall
cooperate with Haivision, in defending or settling such Claim at the expense of Haivision; provided that
Haivision shall not settle any Claim against You which would require the payment of money by You without
the prior written consent of You, which consent shall not be unreasonably withheld. You shall have the right
to consult and provide input into the defense with counsel of its choice at its own expense. Haivision shall not
reimburse You for any expenses incurred by You without the prior written approval of Haivision, which
approval shall not be unreasonably withheld.
(b) If any Licensed Software is, or in the opinion of Haivision may become, the subject of any
Claim for infringement, then Haivision may, or if it is adjudicatively determined that any of the Licensed
Software infringes in the manner described above (except to the extent that any translation, modification,
addition or deletion or combination by You is the sole source of such Claim), then Haivision shall, at its
option, either (i) procure for You the right to continue use of the Licensed Software for the term hereof,
(ii) replace or modify the Licensed Software with other suitable and reasonably equivalent products so that
the Licensed Software becomes non-infringing, or (iii) terminate this Agreement and refund to You a portion
of the fee paid for the relevant Product.
(c) Haivision shall have no liability for: (i) the use of other than the then current release of the
Licensed Software; (ii) the use of the Licensed Software other than as set forth in its accompanying documen-
tation and as permitted herein; (iii) the modification of any of the Licensed Software by any party other than
Haivision; or (iv) any infringement arising from the use of any Licensed Software by You after Haivision has
issued a written notice to You requiring You to cease using such Licensed Software when Haivision exercises
its option to terminate the License pursuant to Section 3.2 (collectively, “Exclusions”). SECTION 5.1
STATES HAIVISION’S ENTIRE OBLIGATION WITH RESPECT TO ANY CLAIM REGARDING THE
INTELLECTUAL PROPERTY RIGHTS OF ANY THIRD PARTY.
5.2 Indemnification by You. You shall indemnify and hold Haivision harmless against any and all
Claims directly or indirectly arising out of, or in any manner whatsoever associated or connected with Your
performance, purported performance or non-performance of its rights and obligations under this Agreement,
and against any and all Claims incurred by or on behalf of any of the foregoing in the investigation or
defense of any and all such Claims.
6. OTHER PROVISIONS
6.1 Export and Other Restrictions. This Agreement, and all Your rights and Your obligations under this
Agreement, are subject to all applicable Canadian and U.S. Government laws and regulations relating to
exports including, but not limited to, the U.S. Department of Commerce Export Administration Regulations
and all administrative acts of the U.S. Government thereunder. In the event the Licensed Software or the
Hardware is exported from the United States or re-exported from a foreign destination, You shall ensure that
the distribution and export/re-export of the Licensed Software or the Hardware is in compliance with all
laws, regulations, orders, or other restrictions of the U.S. Export Administration Regulations. You agree that
neither it nor any of its Affiliates will export/re-export any Licensed Software, Hardware, technical data,
process, Products, or service, directly or indirectly, to any country for which the Canadian government or
United States government (or any agency thereof) requires an export license, other governmental approval,
or letter of assurance, without first obtaining such license, approval or letter.
6.2 Publicity. Neither party shall make or authorize or permit any other person to make any
announcement or other like statement concerning this Agreement or the subject matter, terms or conditions
hereof, without the other party’s prior written consent.
6.3 Transfer and Assignment. Haivision may assign, sublicense, or transfer this Agreement and/or any
or all of its rights or obligations hereunder. You may not assign, transfer or delegate any of its rights or
obligations hereunder (whether by operation of law or otherwise) without the prior written consent of
Haivision. Any unauthorized assignment, transfer or delegation by You shall be null and void. No other
Person shall have or acquire any right under or by virtue of this Agreement.
6.4 Waiver and Amendment. No modification, amendment or waiver of any provision of this
Agreement shall be effective. No failure or delay by either party in exercising any right, power or remedy
under this Agreement, except as specifically provided herein, shall operate as a waiver of any such right,
power or remedy. Without limiting the foregoing, any terms and conditions of the Entitlement or similar
materials submitted by either party to the other shall be of no force or effect.
6.5 Enforcement by Third Party. For any Licensed Software licensed by Haivision from other
suppliers, the applicable supplier is a third party beneficiary of this Agreement with the right to enforce
directly the obligations set forth in this Agreement against You.
6.6 Governing Law. This Agreement shall be governed by and construed in accordance with the laws
of the Province of Québec, Canada and the Laws of Canada applicable therein (excluding any conflict of
laws rule or principle, foreign or domestic).
6.7 Severability. If any provision of this Agreement is held by a court of competent jurisdiction to be
contrary to law, such provision shall be changed and interpreted so as to best accomplish the objectives of
the original provision to the fullest extent allowed by law and the remaining provisions of this Agreement
shall remain in full force and effect.
6.8 Force Majeure. Neither party shall be liable to the other party for any failure or delay in
performance to the extent that such delay or failure is caused by fire, flood, explosion, war, terrorism,
embargo, government requirement, labor problems, export controls, failure of utilities, civil or military
authority, act of God, act or omission of carriers or other similar causes beyond its control. If any such event
of force majeure occurs, the party delayed or unable to perform shall give immediate notice to the other
party, and the party affected by the other's delay or inability to perform may elect, at its sole discretion, to
terminate this Agreement or resume performance once the condition ceases, with an option in the affected
party to extend the period of this Agreement up to the length of time the condition endured. Unless written
notice is given within 30 calendar days after the affected party is notified of the condition, the latter option
shall be deemed selected. During an event of force majeure, the affected party shall exercise reasonable
effort to mitigate the effect of the event of force majeure.
If you have questions, please contact Haivision Network Video, 4445 Garand, Montréal, Québec, H4R 2H9
Canada.