Page 1
ADDERLink™ INFINITY Manager (3
Experts in
Connectivity
Solutions
KVM Extension
Solutions
User Guide
rd
gen)
Page 2
Contents
Introduction
Local feed through ...............................................................................................3
AIM basics .............................................................................................................. 4
Supplied items ....................................................................................................... 6
Optional extras .....................................................................................................7
Installation
Connections .......................................................................................................... 8
Model specic requirements ...........................................................................10
Tips for a successful implementation .............................................................10
Mounting the AIM server .................................................................................11
Conguration
Supported browsers ..........................................................................................12
Login for admin users ........................................................................................12
Important rst conguration steps ................................................................13
Adding ADDERLink INFINITY units .............................................................14
If an ALIF unit is not located ......................................................................14
ALIF manual factory reset ..........................................................................15
Front panel indications ......................................................................................16
The Dashboard tab ............................................................................................17
Upgrading ALIF rmware globally .............................................................29
Upgrading (or downgrading) AIM rmware ...........................................30
Enabling Remote Support .................................................................................32
Web Interface Access ..................................................................................33
Troubleshooting ............................................................................................33
The Channels tab ...............................................................................................34
The Receivers tab ..............................................................................................37
Auto Login feature .......................................................................................43
The Transmitters tab .........................................................................................44
The C-USB LAN tab .........................................................................................49
The Servers tab ..................................................................................................50
The Users tab .....................................................................................................51
The Presets tab ...................................................................................................55
The Statistics tab ................................................................................................57
Operation
Logging in .............................................................................................................58
The Local OSD screen ......................................................................................59
Listing C-USB LAN transmitters ..............................................................60
Accessing virtual machines .........................................................................60
Using the Remote OSD feature ................................................................61
Further information
Getting assistance ..............................................................................................62
Appendix A - Tips for success when networking ALIF units ...................63
Appendix B - Troubleshooting .........................................................................65
Appendix C - Redundant servers: Setting up and swapping out .............66
Appendix D - License upgrading .....................................................................68
Appendix E - Glossary ......................................................................................69
Appendix F - Copper/ber modules and cables .........................................72
Appendix G - AIM API .......................................................................................73
Appendix H - DHCP server requirements for ALIF support ..................91
Using DHCP Option 125 ...........................................................................92
Appendix I - AIM database schema ................................................................93
Appendix J - Technical specications ..............................................................94
Appendix K - Open source licenses ..............................................................95
Index
INSTALLATION
CONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
1
Page 3
Introduction
ADDERLink™ INFINITY transmitter and receiver units allow multiple remote users to
access host computers in a very exible manner. Such exibility requires management
and coordination – that is where AIM (ADDERLink INFINITY Manager) becomes vital.
AIM is designed to promote the most efcient use of ADDERLink INFINITY (ALIF) units
by allowing central control over any number of transmitters and receivers. Using the
intuitive AIM web-based interface, one or more administrators can manage potentially
thousands of users who are interacting with an almost unlimited number of devices.
AIM operates as a self-contained compact server (including its own DHCP server) unit
that can be situated anywhere within your network of ALIF devices:
™
ALinkDDER
ALIF TX
ALIF TX
ALIF TX
M ANAGER
1
2
Gigabit
Ethernet
ADMIN
ALIF RX
ALIF RX
ALIF RX
The AIM server is supplied pre-loaded and is straightforward to deploy, requiring only a
network connection and a power input to begin operation.
All conguration of your ADDERLink INFINITY transmitters (channels), receivers and
users are performed using the intuitive AIM browser interface via a network connected
computer.
AIM server front panel
™
ALinkDDER
AIM server rear panel - In normal use only the SFP network and power connectors are used (ringed in red)
12VDC
35
46
M ANAGER
1
2
1
OLED
screen
Control
button
and status
indicator
2
21
3
INSTALLATION
CONFIGURATIONOPERATION
control over the various ADDERLink INFINITY transmitters, receivers and their users.
The AIM server connects to your network and provides administrative
Note: Although the ADDERLink INFINITY units require Gigabit Ethernet connections, in its
administrative role, the connection to the AIM server is not as speed critical.
Power
in
Not
used
Secondary
SFP port
Primary
SFP port
Not
used
Please see the section Basic steps for a new conguration for assistance with
creating AIM installations.
FURTHER
INFORMATION
INDEX
2
Page 4
LOCAL FEED THROUGH
ALIF receivers which are equipped with dual IP network ports (ALIF1002, ALIF2000,
ALIF2020 and ALIF4000*) can be congured to support a local link to a host PC in
addition to the main link to the network. The locally linked PC remains completely
isolated from the main network.
To congure this arrangement, ensure that the IP port that is used for the local link is
not allocated an IP address.
ALinkDDER ™
MANAGER
1
2
ALIF TX
INSTALLATION
ALIF TX
ALIF TX
Gigabit
Ethernet
ADMIN
* ALIF4000 units require rmware version 4.0 or greater to
operate a local feed through link.
AdderLink
www.adder.com
NETSER AUDUSB DVIPWR
RECEIVER
Link local
In operation, the user of the console at the ALIF
receiver can use the following hotkey combination
to toggle between the network and local links:
To change from a network link to the local link:
enter CTRL+ALT+L
To change from the local link to a network link:
enter CTRL+ALT +C
to display the OSD and choose
the required connection.
Note: The L and C default hotkeys can be changed
within the AIM control panel.
ALIF TX
CONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
3
Page 5
AIM BASICS
Channels
Think of a channel as a ‘virtual transmitter’. It is virtual because the video, audio and
USB streams of a channel do not necessarily have to originate from the same physical
transmitter unit, although in most cases they will. For instance, you could arrange for
video and USB streams to be received from one host computer, while the audio stream
came from an alternative source. Alternatively, two channels could be congured for the
same host computer, each with different access rights to suit particular situations.
Groups
In order to accommodate potentially large numbers of users and devices, AIM uses
a system of groups: User Groups, Receiver Groups and Channel Groups. Groups
allow the administrator to apply collective settings to all members and also to take
full advantage of Inheritance. Inheritance allows members of a group to benet from
settings and permissions made within other groups to which their group is linked. This
saves administration time because members do not need to be individually altered. For
instance, if Sam is in User Group 1, all Channels accessible to User Group 1 will be
available to Sam.
User types
This guide refers to the two main categories of users involved with the AIM system:
• An Admin (administrator) user accesses the AIM system via a network-linked
computer running an Internet browser. Once the necessary username and password
have been entered, Admin users can make changes to the operation of the AIM system.
• A Regular user has a keyboard, video monitor and mouse (plus speakers where
appropriate) attached to an ADDERLink INFINITY receiver unit and can access
one or more computers that are linked to ADDERLink INFINITY transmitters. The
ADDERLink INFINITY receiver provides an On-Screen Display (OSD) that lists all
accessible computers and allows easy access to them.
Security
Security considerations form a major part of AIM operation, ensuring that users have
rapid access only to the systems for which they have permission. At its core, AIM
manages an important three-way relationship between the users, the ADDERLink
INFINITY receiver(s) and the channels from the host computers.
The diagram shows a representation of the three-way relationship which exists between
users, receivers and channels.
To successfully gain access to a channel:
• The user requires permission to use the receiver,
• The receiver requires permission to connect with the channel,
AND
• The user must have permission to access the channel.
In most cases, the need for three access permissions per connection is unnecessary and
raises administration overheads. Hence, by default, AIM grants open access for the user
to the receiver and the receiver to the channel while restricting the nal, most crucial
piece of the puzzle. For those who require it, the lock upon the user to receiver stage
can be applied individually or globally.
See Permissions on the next page for more details.
INSTALLATION
CONFIGURATIONOPERATION
FURTHER
INFORMATION
continued
INDEX
4
Page 6
Active Directory
To streamline administration even further, AIM supports Active Directory. By
synchronizing with an LDAP/Active Directory server, details of users (including their
usernames and group memberships) can be securely synchronised from existing
databases in order to both minimize the initial conguration as well as streamline
ongoing updates.
AIM interface
AIM appears in two main ways depending on whether you are an administrator or a
regular user.
• For administrators, full access to the ADDERLink INFINITY Manager Suite is granted.
This comprehensive application shows nine main tabbed areas: Dashboard, Channels,
Receivers, Transmitters, C-USB LAN, Servers, Users, Presets and Statistics, each of
which contains numerous related pages of settings and options. The Dashboard
provides a central location from which the administrator can view overall operation,
make various changes, database backups and also upgrade the rmware of any linked
ADDERLink INFINITY unit.
• For regular users, an efcient page layout provides a list of all channels for which you
have permission to visit. Against each selectable channel name and description, a series
of icons provide clear feedback about current availability.
Permissions
Permissions exist between Users, Receivers, and Channels.
By default, all users are granted permission to access ALL receivers.
By default, all receivers have permission to connect to ALL channels.
As shown in the introductory diagram, the missing part is the permission for a user to
access each channel.
Permissions between a user and a receiver can be applied in any of the following ways:
• User à Receiver
• User à User Group à Receiver
• User à User Group à Receiver Group à Receiver
• User à Receiver Group à Receiver
Thus, a very indirect way of granting permissions could be:
• User1 is in UserGroup1,
• UserGroup1 has access to ReceiverGroup1,
• ReceiverGroup1 contains Channel1,
• Therefore, User1 has access to Channel1 indirectly.
INSTALLATION
CONFIGURATIONOPERATION
FURTHER
INDEX
5
INFORMATION
Page 7
SUPPLIED ITEMS
A LinkDDER
™
AIM server unit
M A N A G E R
INSTALLATION
1
2
1GbE copper SFP module
CONFIGURATIONOPERATION
Replacement power adapter
with locking connector
Part number: PSU-IEC-12VDC-5A
Country-specic power cords
CAB-IEC-AUS (Australia)
CAB-IEC-EURO (Central Europe)
CAB-IEC-UK (United Kingdom)
CAB-IEC-USA (United States)
CAB-IEC-JAPAN (Japan)
12V, 5A Power supply plus
country-specic mains cable
FURTHER
INFORMATION
Information wallet
containing:
Four self-adhesive rubber feet
Safety document
INDEX
6
Page 8
OPTIONAL EXTRAS
1GbE copper SFP module
Part number: SFP-CATX-RJ45
1GbE single mode ber SFP module
Part number: SFP-SM-LC
1GbE multi mode ber SFP module
Part number: SFP-MM-LC
INSTALLATION
CONFIGURATIONOPERATION
Dual unit 19” (1U) rack-mount shelf
Part number: RMK12
Rack mount blanking plate
Part number: RMK12-BP
FURTHER
INFORMATION
INDEX
7
Page 9
2
1
3
1
2
Installation
2
3
1
2
CONNECTIONS
The AIM server unit is supplied fully pre-loaded and permits no local user interaction. All
conguration takes place remotely via the network connections and as a result only two
connections are required: Network and power.
Note: If an existing AIM server must be replaced, follow the important advice given within
Appendix C (Swapping out an AIM server).
Note: There is no need to connect a keyboard or mouse to the AIM server as conguration takes
place across the network connection.
Network connections
Tw o SFP ports are located on the rear panel to allow CATx (or ber) links to separate
networks, according to the type of modules that are inserted. The AIM server uses the
two ports as follows:
• Port 1 for connection to the internal ALIF network only.
• Port 2 for duplicate connection to the internal ALIF network or connection to
external networks to allow admin users to login when away from the internal network.
Note: Port 1 does not support DHCP and needs to be manually congured, whereas port 2 does
support DHCP. The precise operation of the two ports are determined within the AIM server
Management Suite, particularly the Dashboard > Settings > Network page.
To connect the network port(s)
1 Insert the supplied SFP module (SFP-CATX-
RJ45) into socket 1 located on the rear
panel of the unit:
Note: SFP modules that support
ber connections (SFP-MM-LC,
SFP-SM-LC) are available as
options.
Optional
secondary
CATx SFP
module
Supplied CATx SFP module
2 Run a CAT5e or 6 link cable from the SFP
module in port 1 to the appropriate AIM
network hub or router:
INSTALLATIONCONFIGURATIONOPERATION
Not used
SFP module types
SFP-CATX-RJ45 for use with CAT5e (and above) cable.
SFP-SM-LC modules require OS1 or OS2 single mode ber.
SFP-MM-LC modules require OM1, OM2, OM3 or OM4 multi-mode ber.
See Appendix F for details.
Optional link
for duplicate
connection or to
external network
Link to internal
AIM network
3 If a second SFP module was inserted into port 2, run an appropriate link from that to
the required hub, router or gateway.
FURTHER
INFORMATION
INDEX
8
Page 10
12VDC
12VDC
Power supply connection
IMPORTANT: Please read and adhere to the
electrical safety information given within the
Safety information provided with the AIM server.
In particular, do not use an unearthed power
socket or extension cable.
Note: The AIM server can also be powered from
the optional RED-PSU managed power supply
system using a VSC48 cable.
To connect the power adapter
1 Attach the output plug of the supplied
power adapter to the power input socket
on the left side of the rear panel. As you
insert the plug, pull back slightly on the
outer body to assist the locking mechanism
until the plug is fully inserted.
From the
power adapter
To disconnect the power adapter
1 Isolate the power adapter from the mains supply.
2 Grasp the outer body of the power adapter plug
where it connects with the node.
3 Gently pull the body of the outer plug away from
the node. As the body of the plug slides back, it will
release from the socket and you can fully withdraw
the whole plug.
INSTALLATIONCONFIGURATIONOPERATION
Gently pull back the plug outer
body to release the lock
2 Insert the IEC connector of the supplied country-specic power cord to the socket of
the power adapter.
3 Connect the power cord to a nearby mains supply socket.
IMPORTANT: Please read and adhere to the electrical safety information
given within the Safety information booklet provided with this product. In
particular, do not use an unearthed power socket or extension cable.
Note: The unit and the power adapter generate heat when in operation and will become
warm to the touch. Do not enclose them or place them in locations where air cannot circulate
to cool the equipment. Do not operate the equipment in ambient temperatures exceeding
40 degrees Centigrade. Do not place the products in contact with equipment whose surface
temperature exceeds 40 degrees Centigrade.
FURTHER
INFORMATION
INDEX
9
Page 11
MODEL SPECIFIC REQUIREMENTS
• ALIF100T transmitters require rmware version v4.07 (or greater)
• ALIF101T transmitters require rmware version v4.09 (or greater)
• ALIF1xxx endpoints require rmware version v4.9 (or greater)
• ALIF2xxx endpoints require rmware version v4.9 (or greater)
• ALIF3000 receivers require rmware version v1.1.0 (or greater)
• ALIF4000 endpoints require rmware version v2.0 (or greater)
TIPS FOR A SUCCESSFUL IMPLEMENTATION
Installations based upon the Adderlink INFINITY modules vary widely in their scope and
complexity. Each implementation is distinct, however, there are numerous tips and best
practice recommendations available on the Adder website. Many tips are concerned with
the correct selection and conguration of network switches plus the choice of network
topology.
Please go to:
https://support.adder.com/tiki/tiki-index.php?page=ALIF%3A%20Getting%20Started
Models running AIM software 4.13
Interim shipments have been made during 2021 of AIM server 3 hardware running AIM
software v4.13. The following details apply:
• Upgrades up to v5.x and beyond can be made as versions become available.
• It is possible to downgrade back to v4.0 if necessary.
• When running v4.13 on AIM server 3 hardware, the following behavior will be seen on
the front panel OLED screen and indicator:
• OLED The screen will remain blank and not display any details.
• Indicator The indicator will show only green when powered on, no other colors.
General requirements
• Portfast needs to be enabled on the network switch to ensure that the ALIF to AIM
communication happens in a timely manner. Note that Cisco uses the term ‘edge port’
rather than ‘port fast’. The option is enabled on each port to which an AIM unit is
connected. Where portfast is not enabled, if a second AIM is added for redundancy, this
could result in a mis-congured Backup server.
• If an existing AIM server must be replaced, follow the important advice given within
Appendix C (Swapping out an AIM server).
• When conguring the installation for multicasting (and to improve overall
performance), the network switch(es) being used must support a minimum of IGMP v2
snooping. For faster performance use switches that support IGMP v3.
• In order to display video resolutions that use a horizontal video resolution of 2048
pixels, the network switch must have support for Jumbo packets.
• Please also see Appendix A - Tips for success when networking ALIF units.
Compatibility matrix
For a full summary of ALIF models and their compatibility with AIM rmware versions,
please go to:
https://support.adder.com/tiki/tiki-index.php?page=ALIF%3A%20Compatibility%20Matrix
If the compatibility matrix is not found at the above address, please contact technical
support for assistance.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
10
INDEX
Page 12
MOUNTING THE AIM SERVER
The AIM unit is designed to be easy to mount within a standard 19” rack using the
optional rack-mount shelf (RMK12). The unit is also suitable for free standing use on the
desktop. The server chassis requires just a 1U space within the rack.
To mount the AIM server within a rack mount
1 Install the empty rack-mount shelf into your 19” rack frame and fully secure it.
2 Place the AIM unit into one side of the rack-mount shelf so that its rear panel
butts up against the small peg located on the side wall.
3 Place the optional blanking plate (RMK12-BP) onto the other side.
4 Locate the supplied thumbscrew and spacer.
5 Insert the thumbscrew through the spacer; then insert
into the small hole at the end of the center divider.
6 Gently tighten the thumbscrew so that the
spacer engages with the inner edge
of the AIM unit and the blanking
plate and holds them
in place.
7 Place the power
adapter in the rear
section of the rack-
mount shelf and
connect it to the AIM unit.
8 Make all other necessary connections to
the AIM unit.
A LinkDDER
™
M A N A G E R
1
2
IMPORTANT: When mounting the ALIF units (and their
power adapters), ensure that the vents are not obscured
and that there is sufcient airow. The operating
temperature range is 0 to 40ºC (0 to 104ºF) and must
not be exceeded. Each power adapter is rated at a
maximum of 68.24BTU/hr.
INSTALLATIONCONFIGURATIONOPERATION
An optional blanking plate (part number:
RMK12-BP) is available to seal the airow
if only one device is installed within the
rack-mount shelf.
FURTHER
INFORMATION
INDEX
11
Page 13
Conguration
This section covers conguration of the ADDERLink INFINITY Manager Suite for
administrators. For details about the regular user interface, please see the Operation section.
SUPPORTED BROWSERS
The AIM admin interface requires an A-grade browser with Javascript enabled.
For best results always use the latest version of any browser used.
• Google Chrome
• Firefox
• Edge*
• Safari for Mac OS*
* The most intensive testing has been carried out using Chrome and Firefox. MS Edge
and Safari are known to work but testing with these browsers has been limited by
comparison.
LOGIN FOR ADMIN USERS
1 Ensure that the AIM server is powered on (allow 3 minutes before accessing).
2 Using a computer located anywhere within the local network open a web browser
(see Supported browsers list opposite) and enter the default IP address for the AIM
server: 169.254.1.3
The Login page will be displayed:
3 Enter your Username and Password and click the Login button.
The default username is admin and the default password is password.
You are strongly recommended to change the default admin password as one of your
rst actions: Go to Dashboard>Users. Click on the furthest right icon in the admin row
(congure users) and change the password for the admin user.
If you check the Remember Me box, a cookie will be stored on the computer,
allowing you to access the admin section without having to log in each time. The
cookie will survive for up to the AIM Admin Timeout period. If you do not check the
Remember Me box, you will remain logged in only for the duration of your browser
session.
4 Continue to the section Important rst conguration steps on the next page.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
Forgotten password
If necessary, click the Forgotten password link to display an assistance page where a
secret code will be given. Provide the secret code to Adder support or your distributor
to obtain an unlock code which can then be entered to reset your password and gain
access.
INDEX
12
Page 14
IMPORTANT FIRST CONFIGURATION STEPS
There are several important conguration steps that must be carried out when starting a
new AIM server for the rst time.
To determine the AIM server’s rôle and main IP address
1 Switch on and log in to the AIM server; you will be presented with the Servers page.
2 Within the Server page, choose the Rôle of this new AIM server:
• Solo - This will be the only AIM server on the network (with no redundancy and
failover), or
• Primary - This server will be used as part of a redundant cluster of AIM servers,
where it will be the main server used to manage the ALIF units.
3 Click the Save button. You will next be presented with the Dashboard > Settings >
Network page.
4 See the warning below - do not carry out this step while the system is in operation.
Within the Ethernet Port 1 section at the top of the page, change the default AIM IP
Address (and Netmask) options to settings that suit your network conguration and
which will be used henceforth for this server.
IMPORTANT: The Ethernet Port 1 AIM IP Address and Netmask settings
must NOT be changed during operation of the system. Changing these will
invalidate the system’s security and require intervention from the Adder
technical support staff to restore to a working state.
5 You can now either:
• Continue with other settings on the same page (See To choose how IP addresses are
applied to ALIF units right), or
• Click the Save button. After a short delay the web browser will automatically
redirect itself to the new IP address so that you can continue administering the AIM
server.
Note: Ensure that your computer can view the new IP address, otherwise the AIM server will
appear to be ofine. Depending on your network conguration and that of the computer, you
may need to change the computer’s conguration to be able to see AIM server’s new network
address.
To choose how IP addresses are applied to ALIF devices
1 Login again to the AIM server and choose the Dashboard > Settings > Network page.
2 The Subnet Operation option may, or may not, be presented at the top of the page.
Note: If Subnet Operation is not present, the AIM server will operate as per the Off setting
described below.
When the Subnet Operation option is present, you have the following choices:
• Off - AIM can administer a single subnet and will use its own DHCP (Dynamic Host
Conguration Protocol) server to automatically assign IP addresses to new ALIF
devices, drawing upon a pool of spare addresses dened by you.
• On - AIM can administer devices across multiple subnets, but will rely upon an
external DHCP server to assign valid IP addresses to new ALIF devices.
3 If you chose the Off setting, you now need to dene the boundaries of the IP address
pool that will be used by the internal DHCP server. Enter valid start and end addresses
to the IP Pool Lower Limit and IP Pool Upper Limit options.
Note: If you chose the On setting, you will need to perform a similar operation within the
external DHCP server. For details about DHCP server requirements, see Appendix H.
For further details about other options within this page, see Dashboard > Settings >
Network.
4 When all options have been set, click the Save button.
5 If you need to change the operation of AIM from single subnet to multi-subnet (or
back again) this option only appears after a successful factory reset of AIM
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
IMPORTANT: To use subnet operation, you must have a DHCP server
within your network in order to assign IP addresses to the AIM and ALIF
endpoints. If subnet operation is used without a DHCP server, the ALIF
endpoints will not communicate with AIM As a result, the AIM will need
a factory reset in order to be able to revert it back to single subnet mode.
IMPORTANT
Note: If an existing AIM server must be replaced, follow the important advice given within
Appendix C (Swapping out an AIM server).
INDEX
13
Page 15
ADDING ADDERLINK INFINITY UNITS
When new ALIF transmitters and receivers are added to a network, they are designed
to automatically announce themselves* to the AIM server. Once the AIM server receives
their announcement(s), the ALIF units will be added to the administrator’s view of the
Dashboard. From here you can then begin to congure each new ALIF unit.
* ALIF units can be congured either from their own browser-based conguration utility or via
the AIM server. Once an ALIF unit has been congured in one way, it cannot be recongured
using the other method without undergoing a factory reset. This policy is in place to help prevent
accidental overwriting of congurations. It also means that once an ALIF unit has been locally
congured, it will not announce itself to the AIM server upon being added to a network.
How to perform a manual factory reset (see next page)
INSTALLATIONCONFIGURATIONOPERATION
When new ALIF devices announce themselves, depending upon how it was initially
congured (see Important rst conguration steps), the AIM server will either assign IP
addresses to new ALIF units automatically, or will rely upon an external DHCP server
to do the same. Either way, providing each ALIF device is not already congured and
announces itself to the AIM server (see right for potential issues that can prevent this),
they will be automatically provided with a suitable IP address so that they may operate
within the network. Once ALIF units have been added, you can use the AIM server
Dashboard to select and further congure any or all of them.
Further information
Please also see:
• Appendix A - Tips for success when networking ALIF units
• Appendix B - Troubleshooting
• Appendix C - Redundant servers: Setting up and swapping out
• Appendix D - Upgrade license
• Appendix E - Glossary
• Appendix F - Copper/ber modules and cables
• Appendix G - AIM API
• Appendix H - DHCP server requirements for ALIF support
• Appendix I - Technical specications
• Appendix J - Open source licenses
If an ALIF unit is not located
There are several reasons why an ALIF unit might not be located by AIM:
• The ALIF unit has been locally congured or is otherwise not using its factory default
setting. Try performing a factory reset on an ALIF that is not being located.
• The ALIF unit is not located in the same Ethernet segment as the AIM server. Double
check connections and move units where necessary, so that all reside within the same
Ethernet segment.
• There is a potential cabling problem between the ALIF and AIM units. Check and
where necessary, replace faulty cables.
FURTHER
INFORMATION
14
INDEX
Page 16
ALIF manual factory reset
www.adder.com
Where a previously congured ALIF unit is being added to a network for control by an
AIM server, you need to ensure that the unit is reset to its default conguration. The
procedures given here cover how to perform a reset on the various types of ALIF units.
ALIF 100/101T models
1 Power on the ALIF100/101T unit.
2 Use a narrow implement (e.g. a
straightened-out paper clip) to press-andhold the recessed reset button on the front
panel for roughly fteen seconds, until the
indicators turn blue (Note: alternating red/
green indications will occur during the fteen
second period while the button is still pressed).
3 Release the reset switch.
The indicators will remain blue for a
short while (less than ten seconds) while
ALIF100/101T unit congures itself
and should then change to green if all
connections are correct; or orange if one
or more of the video, USB and/or network
links are missing.
ALIF 1xxx and 2xxx models
1 Remove power from the ALIF unit.
2 Use a narrow implement (e.g. a straightened-out paper clip) to press-and-hold the
recessed reset button on the front panel. With the reset button still pressed, re-apply
power to the unit and then release the reset button.
After roughly eight seconds, when the factory reset has completed, ve of the front
panel indicators will ash for a period of three seconds to indicate a successful reset
operation.
Use a straightenedout paper clip to press
the reset button while
ALIF 1xxx
powering on the unit
Use a straightened-out paper
clip to press the reset button
for roughly 5 seconds
AdderLink
ALIF 2xxx
ALIF 3xxx models
1 Power on the ALIF3000 unit.
2 Press-and-hold the button located next to the
front panel OLED screen for 10 seconds until the
indicator turns blue and the OLED screen shows
the message: In factory reset mode
3 You can now either:
• Continue with the factory reset: Use a long
narrow implement (e.g. a straightened-out paper
clip) to press-and-release the recessed reset
button on the front panel.
• Return to normal operation without resetting:
Press the button next to the OLED screen again.
AdderLink
4 Once the factory reset has been carried out the
unit should now be ready for discovery by an AIM
server.
ALIF 4xxx models
1 Power on the ALIF4000 unit.
2 Use a long narrow implement (e.g. a straightened-out paper clip) to press-and-hold
the recessed reset button on the front panel for roughly ten seconds, until the
status indicator turns blue (Note:
alternating red/green indications will
occur during the ten second period
while the button is still pressed).
3 Release the reset switch. The
indicator will change to red
for a short while (less than ten
seconds) and then back to blue
while ALIF4000 unit performs the
reset and should then change to an
alternative color, usually orange
initially, signifying that the operation
is complete.
Note: If you are performing a factory reset and intend to disconnect the power immediately
after the reset, you must wait at least 30 seconds after you have released the reset button
for it to complete the process.
AdderLink
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
15
Page 17
FRONT PANEL INDICATIONS
AIM server
Port 1 address
10.0.0.1
Port 2 address
-
Online
primary
The front panel of the AIM server unit features an OLED information screen plus a single
indicator capable of producing numerous color and ash patterns to provide a useful
guide to operation.
OLED screen
Press and release the button to wake the OLED screen and begin showing information.
Press the button repeatedly to change between subjects:
AIM server
Online
primary
Port 1 address
10.0.0.1
Port 2 address
-
Server name
Server status
Network port 1
Network port 2
Indicator color and ash patterns
The single front panel indicator uses varying color and ashing patterns to signal key
status:
Off No power.
Green Powered on and network connection established.
Yellow Boot process complete or (during operation) network connection lost.
Blue Factory reset mode active.
Green/blue ash Upgrade mode active.
INSTALLATIONCONFIGURATIONOPERATION
IMPORTANT
Models running AIM software version 4.13 will exhibit the following front panel OLED
screen and indicator behavior:
• OLED The screen will remain blank and not display any details.
• Indicator The indicator will show only green when powered on, no other colors.
FURTHER
INFORMATION
INDEX
16
Page 18
THE DASHBOARD TAB
The Dashboard is your main point of contact for checking and changing the general
status of all AIM operations.
Click the DASHBOARD tab to view its initial home page.
The various other Dashboard pages (e.g. Settings, Backups, Updates, etc.) are selectable
within the blue section located just below the tabs.
Dashboard > Home
• Shutdown button - Allows the admin user to shut down the AIM server. The OSD
will no longer work on Receivers. The AIM server will need to be manually started
again when next required.
• Restart - The admin user can reboot the AIM server. The OSD and admin section
will be unavailable while the server is rebooting. The time for a reboot can vary
signicantly depending upon settings such as ETH1 obtaining an IP adress by DHCP, or
whether or not the clock is maintained by NTP.
Within the Home page*, the different sections provide a variety of information:
• Warning messages - Live alerts are displayed concerning any devices that are ofine,
rebooting, recently added or uncongured.
• Latest Active Connections - shows the ve most recent active sessions, detailing
for each: When the session started; which user/receiver/channel is involved; the
connection type (icons show audio, video, serial, USB, exclusive) and IP addresses
in use. The red unplug icon on the far right allows the admin user to disconnect a
connection.
• Event Log - shows all actions performed by the admin or end-users within the AIM
system. See also the Event Log page.
• Latest Channels Created - shows the last ve channels created within the
AIM system. A channel is created by default when a new transmitter is added and
congured. The edit icon next to a channel allows the admin user to congure the
channel.
INSTALLATIONCONFIGURATIONOPERATION
• Latest OSD Logins - shows the last ve users who logged in (either to the AIM
admin or at an ADDERLink INFINITY Receiver).
• Latest User Registrations - shows the last ve users added to the AIM system,
with a link to edit the user’s details/permissions.
• Latest Channel Changes - shows the last ve users who changed a channel, either
while using the on-screen display (OSD) at an ADDERLink INFINITY Receiver, or via
the AIM admin control panel.
• Latest Receivers Added - shows the last ve receivers to be added and congured
within the AIM network. Click to congure a receiver; click to connect to a
channel; or click to disconnect an existing connection.
• Latest Transmitters Added - shows the last ve transmitters to be added and
congured within the AIM network. Click to congure a transmitter.
* The Home page is auto-refreshed every thirty seconds to ensure that the latest
information is always available.
FURTHER
INFORMATION
17
INDEX
Page 19
Dashboard > Settings
Click the Settings option below the Dashboard tab.
The Settings section contains global conguration options for the AIM system and is
divided into eight pages, each accessible by clicking the relevant button located below the
blue options bar:
Dashboard > Settings > General
Receiver OSD Timeout
Determines the time period of inactivity within the OSD after which a standard user will
be automatically logged out.
General • Transmitters • Receivers • Servers • Network • Time • Mail • Active Directory
For conguration options that affect individual receivers, users channels, etc., see the
sections dealing with those tabs.
AIM Administrator Timeout
Determines the time period of inactivity within the AIM cong pages after which an
admin user will be automatically logged out.
Anonymous User
Determines which user is shown in the log when a receiver is set to ‘No login required’.
Disable Password Reset
This prevents the password reset button from appearing on the login page.
Hide Dormant Devices / Show Outdated Devices
These options: a) hide devices that have been ofine for more than 24 hours and b) show
devices that are outdated for the current AIM version (both exclude RDP servers).
Grant All Users Private Access
Determines whether a user can connect to a channel privately and thus prevent any other
users from simultaneously connecting to that channel. If not set, users can only connect in
Video-Only mode or Shared mode. Settings that are applied specically to a user will override
settings applied to user groups they’re in, which in turn override this global setting.
Note: If a user has Private Access mode granted or NOT granted at user level, then it doesn’t
matter what settings there are above (usergroups or global).
• If a user is set to inherit “Allow Private?” mode from their user groups, if any one of their user
groups has “Allow Private?” mode granted, then the user will have it granted, even if the rest
of the user’s usergroups have private mode not granted.
• If a user is set to inherit “Allow Private?” mode from their user groups, and one of the user
groups is set to inherit from the global setting - if that global setting is “Allow Private?” mode,
then effectively the user group is “Allow Private?” mode so the user will be allowed private mode.
Grant All Users Remote OSD Access
If enabled, allows receivers to be switched remotely from another receiver’s OSD menu.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
Grant All Users Force Disconnect
If enabled, permits any user logged in at a receiver to disconnect a channel or preset
established on that receiver by another user.
Show Disconnect All
If enabled, this provides the option to users to collectively disconnect all receivers.
INDEX
18
Page 20
Grant VDI Save & Connect
If enabled, allows users to save their VDI login details within the OSD to allow quicker
re-entry.
Grant Users Receiver Access By Default
If enabled, all new users will be granted permission to access all receivers as they are
added. If disabled, users will need to be manually given access permission at the bottom
of the Receivers conguration page.
Allowed Connection Modes
Determines the global setting that will be applied to all new channels concerning
connection modes. The setting made here is only applied as a default and can be
overridden at the channel level, where necessary. Options are:
• Video-Only: Allows users only to view the video output, the USB channel is denied.
• Shared:* Allows users to control a system in conjunction with other users.
• Exclusive: Grants exclusive control to one user while all others can simultaneously
view and hear, but not control, the output.
• Private: Allows a user to gain private access to a system, while locking out all others.
Note: By default, all new channels are set to inherit this global value. So it’s easy to change all
channel connection modes simply by changing the global setting. If a channel has its own setting,
the global setting has no effect on that channel.
* If USB is disabled, Shared mode will not be available as an option.
Rows per Page
The number of rows to display in all paginated tables in the admin section.
Locale
Determines the language shown on the OSD menus of the receivers; the admin
conguration web pages will remain in English.
Note: Occasionally, when changing the Locale setting it may be necessary to restart the
main Apache server underlying AIM. This is achieved using the ‘Restart Apache’ option on the
Dashboard > Updates page.
Debug Level
This allows information to be collected for diagnostic purposes. DO NOT change this
setting from normal unless advised by Adder Support.
API - Login Required
If enabled, the anonymous use of the AIM API will be disallowed.
API - Anonymous user
Determines the user permissions to be used when the API is accessed without logging in.
Licence - Supported Devices - Indicates the limits of the current license.
Upgrade License - (see Appendix D for details)
Displays information about the number of devices that can be connected to the AIM server.
Licensed Features - Displays the level of operation permitted under the current
license. Click view/change to see more detail and gain a unique identier that can be
declared to Adder when upgrading a license.
INSTALLATIONCONFIGURATIONOPERATION
19
FURTHER
INFORMATION
INDEX
Page 21
Dashboard > Settings > Transmitters
This page applies a standard global conguration to all transmitters.
Magic Eye
Determines whether the Magic Eye feature should be enabled on ALIF (100T, 101T,
1002T, 2002T, 2020T, 2112T or 4000T models only) transmitters. Magic Eye works to
overcome the issues with increased bandwidth usage caused by ‘dithering’ techniques
used on some computers, such as Apple Macs. See the ALIF dual user guide for more
details.
EDID
Determines how the video conguration details should be determined: Either harvested
from the connected display screens (USE CONNECTED MONITOR’S EDID) or by
selecting a static xed EDID setting from the list (e.g. GENERIC 16:9, 1920x1080
HD1080, 1600x1200 UXGA, etc.). Using a xed EDID setting can signicantly speed up
video switching times as EDIDs do not need to be checked, however, all of the installed
monitors need to support the chosen resolution. Where EDIDs are checked, enabling
EDID Optimisation (below) can help to regain some of the switching speed.
Note: Care must be taken when selecting a Dual Link Video resolution (e.g. 2560x1600)
as certain ALIF units do not support Dual Link Video resolutions. In the case of a Dual Link
EDID being set in the Global settings, no EDID will be set on Video port 2 of dual port ALIF
transmitters.
Dynamic Range EDID
For ALIF devices which support HDR (such as the ALIF4021T), this option can be used
to grant permission to go beyond the standard SDR8 setting and use SDR10 or HDR10
when the connected host and video displays support 10bpc color depths.
EDID Optimisation
When this option is ticked, the transmitters will compare the native resolution settings
of monitors when switching. If a monitor has the same native resolution as the previous
one, the new EDID is not sent to the graphics card. This speeds up switching as the
graphics card does not need to go through a hotplug detect routine when a new receiver
is switched to that channel. If the new receiver has a monitor with a different native
resolution, then the EDID will be updated to allow for a change in video mode.
Audio EDID
For transmitters which support digital audio via the DisplayPort connection(s),
this setting determines how the audio should be congured: (USE CONNECTED
MONITOR’S EDID) or a static setting: NONE, 2 CHANNEL (Stereo), 6 CHANNEL
(surround 5.1) or 8 CHANNEL (surround 7.1). Using a xed EDID setting can signicantly
speed up switching times as EDIDs do not need to be checked, however, all of the
installed audio devices need to support the chosen format. Where EDIDs are checked,
enabling Audio EDID Optimisation (below) can help to regain some of the switching
speed.
Audio EDID Optimisation
When this option is ticked, the transmitters will compare the digital audio settings when
switching. If a receiver’s digital audio settings are the same as the previous one, the new
EDID is not sent to the host system. This speeds up switching as the host system does
not need to go through a hotplug detect routine when a new receiver is switched to that
channel. If the new receiver uses a different audio setting, then the EDID will be updated
to allow for a change in audio mode.
Maximum VDI Resolution
This option provides the option to cap the resolution used for VDI connections to improve
performance when high resolution monitor settings are used.
Hot Plug Detect Control
Determines whether to enable hot plug detection for monitors. By default this is enabled.
Hot Plug Detect Signal Period
By default this is set at 100ms, which is sufcient for most graphics cards. Occasionally it
may be necessary to adjust this. An Adder FAE will advise if necessary.
Background Refresh
The number of frames between sending an entire frame of video data. Setting this to a
longer period or disabling this will reduce the bandwidth required.
Maximum Bits Per Colour
This option controls the dynamic range mode. When set to 8bpc, only SDR8 mode will
be supported. When set to 10bpc, the transmitter will allow SDR10 or HDR10 mode
providing the host computer and attached video displays support those modes. See the
user guide for ALIF devices that support 10bpc for a more detailed explanation.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
20
INDEX
Page 22
Compression Level
The newer AFZ+ codec complements the existing AFZ codec by providing greater
compression for increased speed where pixel perfect results are not the primary
focus. The transmitter video conguration page allows you to choose the required
compression mode. Choices are:
• ‘Pixel Perfect’ - only uses pixel perfect AFZ,
• ‘Adaptive’ - guarantees frame rate, builds to pixel perfect,
• ‘Smoothest Video’ - forces the maximum compression, or
• ‘Advanced’ - allows you to choose the minimum and maximum compression modes:
1 = ‘AFZ only (pixel perfect),
2 = ‘AFZ+ Minimum compression’,
3 = ‘AFZ+ Middle compression’, or
4 = ‘AFZ+ Maximum compression’.
USB Speed
Determines standard USB operation: USB1 Full speed or USB 2 Hi-speed.
USB Hub Size
Select either a 13 or 7 port USB hub. This determines the number of USB devices that
can be connected to a single Transmitter.
Note: In order to access the BIOS on some host machines it is necessary to change this setting
to 7 ports.
Enable Dummy Boot Keyboard
It is often necessary to have a keyboard reported at start up. This setting means that a
“Virtual Keyboard” is always reported to the USB host. It may be necessary to disable
this for use with some KVM switches.
Enable Audio
This option controls the standard analog audio feed, available via the 3.5mm audio jacks.
Enable Digital Audio
This option controls the (multi-channel) digital audio feed available via the HDMI
connection as supported by certain ALIF devices - at present only supported by the
ALIF101T.
Reserved USB ports
This setting lets you set aside a specic number of USB ports (up to 8) on the
transmitter that can be made available for certain USB devices which require a quirk
setting under advanced USB features, connected to a receiver.
Note: This setting can only be applied globally it is not found with individual transmitter
congurations because all receivers need to know how many USB ports are available for the
advanced USB features.
Serial port options
These allow you to match the serial conguration being used by the attached PC host.
INSTALLATIONCONFIGURATIONOPERATION
21
FURTHER
INFORMATION
INDEX
Page 23
Dashboard > Settings > Receivers
This page applies a standard global conguration to all receivers.
OSD Hotkeys
Determines whether the hotkeys that invoke the OSD are enabled or disabled.
Connection Hotkeys
Determines whether the hotkeys that switch channels are enabled or disabled. This
affects all of the hotkey settings below.
Disconnect Hotkeys
Determines the hotkey combination used to end the current connection.
Shortcut and Extended Hotkeys
Shortcut hotkeys allow quick connection to channels 0 to 9. Extended hotkeys also allow
quick connection to those same channels, but then offer a further set of connections
from channels 10 to 99. It is important to set a different combination of Extended
Hotkeys to those congured for the Shortcut Hotkeys setting.
Note: For all types of hotkeys, Left Ctrl and Left Alt are the default settings. It is not possible to
use a mixture of left and right Ctrl/Alt/Shift keys for any given function.
Other Hotkey Settings
The next six settings determine the Hotkeys that can be used to invoke certain functions,
such as last-used channel selection, connection mode and feedthrough selection.
For all of these hotkey settings it is possible to choose mouse buttons to perform the
functions, however, it is not possible to use a mixture of mouse buttons and keyboard
keys in combination, it must all one or the other type.
Show Multi-User Information
When set to Yes, the names of other users who are currently viewing the same channel
will be displayed within the OSD.
Login Required
Determines whether it is necessary to log into the receiver.
OSD Login Message
Text entered in this box will be displayed as a message to all users who access the OSD
login page.
Auto Login User
Allows you to authorize a user (or group) account to use the optional Auto Login
feature. This option will be grayed out if the Auto Login feature has not been installed).
See “Auto Login feature” on page 43 for more details.
Enable Receiver OSD Alerts
Determines whether pop up OSD alerts should be displayed for users.
Show Current Channel
When enabled, displays the channel name on the OSD banner (in the position
determined in the setting below).
OSD Banner Position
Determines the screen location of the OSD banner (when enabled in the above setting),
which will state the currently viewed channel name.
OSD Icon Launch Size
Determines the default size of the icons used in the OSD. Options include: Small,
Medium, Large and Extra Large.
Touch show OSD enable
Determines whether the OSD can be shown on a touch screen device when supported
by certain ALIF devices - at present supported by ALIF2000- and 4000- series receivers.
USB Connector to Monitor number mapping
Allows you to share the various emulated USB ports between the connected video
displays - at present only supported by ALIF4021R receivers.
Video Compatibility Check
When enabled, this option reads the EDID from the attached monitor and determines
whether it is capable of displaying the selected video mode before connecting a channel.
This prevents the receiver showing a black screen and the user being locked out because
a dual link resolution has been selected to display on a single link monitor.
Audio Compatibility Check
Applicable only to receivers (such as the ALIF4021R) which are capable of processing
multichannel digital audio via their DisplayPort connections. When enabled, this option
reads the EDID from the attached monitor/audio system and determines whether the
receiver’s current audio setting (e.g. 2 Channel, 6 Channel, 8 Channel) is capable of
correctly playing the selected audio (e.g. Stereo, 5.1 or 7.1) mode before connecting a
channel.
Force 60Hz
If enabled, the receiver frame rate is held at 60Hz regardless of the video input frame
rate. The Video Switching options (below) cannot be altered when this option is enabled.
Video Switching
Provides two options for video switching:
• Fast Switching (default state) - Retains the same frame rate (at either 50Hz or 60Hz)
depending upon which video resolution was displayed rst.
• Match Frame Rate - Follows the source frame rate and will change the frame rate every
time this changes even if the video resolution doesn’t change. If you have one receiver
switching between 1920x1080@60Hz and 1920x1080@50Hz then this setting will
change the frame rate from 60Hz to 50Hz every time that you switch.
Keyboard Country Code
Select the country code of the keyboard connected to the receiver.
Audio Input Type
Select the required audio input type: Mic or Mic Boost.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
22
Page 24
USB Settings
HID Only
This option allows you restrict USB devices to allow only HID (mice, keyboards, tablets,
touchscreens, etc.) devices to be connected to the receiver(s).
Disable Mass Storage
This option allows you to prevent the use of USB mass storage devices at the receiver(s).
Note: ALIF3000 receivers do not support the use of mass storage devices, so this setting has no
effect on them.
The HID Only and Disable Mass Storage options both affect how USB devices are
supported at the receiver(s). Their use in combination can produce the following results:
HID Only Disable Mass Storage Outcome
No No No USB restrictions
Ye s No
Allow only HID devices
(Mass storage devices are also blocked)
Exclude mass storage devices but
No Ye s
allow other USB peripherals (e.g. mice,
keyboards, tablets, touchscreens, etc.)
Ye s Ye s
Allow only HID devices
(Mass storage devices are blocked)
Disable Isochronous Endpoint OSD Alerts
When an isochronous USB device is connected to the receiver there will no longer be a
warning message. ALIF units do not support isochronous devices.
Advanced Port Features
This section allows you to determine USB port behaviour for use with certain USB
devices.
The default is no reserved ports, Merging enabled and no feature code (or Quirk) set.
It is recommended that these are left at the default settings and are only changed under
advice from an Adder FAE.
For each of the four USB ports on the receiver, certain rules can be applied depending
upon the USB device connected.
If you have reserved USB ports on the transmitter, you can select which USB port to use
for a particular device.
You can turn off USB merging for a particular port. This will slow down switching as the
USB device will be enumerated every time that you switch.
You can also enter an advanced feature if it is necessary for your USB device. The drop
down lists the feature codes for some known USB devices. Otherwise please contact
your local FAE for advice.
INSTALLATIONCONFIGURATIONOPERATION
Enable Isochronous Endpoint Attach
Some USB devices combine many USB devices behind a USB hub. e.g a keyboard with
audio support. By enabling this option, devices will be allowed to connect to ALIF
receivers, however, the isochronous part (e.g. the audio component) of the devices will
not work.
FURTHER
INFORMATION
INDEX
23
Page 25
Dashboard > Settings > Servers
Dashboard > Settings > Network
This page is used to congure redundant operation for the AIM servers.
Two or more servers can be added onto the same subnet or Vlan. One AIM box is the
Primary (or Master) the other is the Backup (or Slave). If the Primary server fails for
any particular reason then the Backup will take over until the Primary is repaired. This
functionality is only possible if the licenses of the both AIM units match. Both AIM units
need to be able to control the same number of endpoints.
When in Multi-subnet mode it is possible to place additional servers on a different
subnet or Vlan. These servers are referred to as satellites.
Primary Timeout
The time (in seconds) for the Primary server to be unavailable before the Backup takes
over.
Quiescent Timeout
The time after which an inactive (Quiescent) server is assumed to have disappeared.
Backup Check Interval
The interval between the Primary server querying its backups to determine if they are all
on-line.
Backup Timeout
The period of time that a backup server can be off line or uncontactable before it is
treated as a failed server.
Require Authentication?
If set to ‘Yes’, then a new, uncongured AIM server will be unable to join the cluster
automatically; it’s behaviour will be to report itself as uncongured and quiescent, and
request a password. Entering the cluster password will then allow it to join the cluster as
a Backup.
Cluster Password
This is the password that is used for AIM-to AIM https queries, if the Require
Authentication option is enabled.
This page applies global network parameters to the AIM network.
AIM Connectivity
Require SSL for Web
If set to yes, a certicate needs to be downloaded and all connections will then take
place using HTTPS:// connections rather than the default HTTP:// connection types.
Hostname
Enter a hostname for the installation. This eld must be populated.
DNS Domain Name
Enter a suitable domain name for the installation. This eld must be populated.
Classless Static Routing
This option allows you to dene one or more static routing paths to other sub-nets. A
sub-page will be opened when you click this option. Within the sub-page, click the Add
New option to include a new entry. For each entry you need to dene the Destination
and Router IP addresses plus a suitable classless sub-net Mask.
Gateway IP Address
Denes the IP address of an optional gateway device.
Note: Only a single gateway can be specied within an AIM server. If both Ethernet ports are to
be used in multi-subnet mode, it is important to specify a single gateway IP address that suits
both Ethernet ports. Communications between AIM and the ALIF endpoints on the different
subnets will be affected if using multi-subnet mode without a jointly valid gateway.
Ethernet Port 1
The primary AIM server Ethernet port can only be congured using a static IP address. Use
the three options provided to congure the IP address, netmask and DNS server address.
Ethernet Port 2
The Backup AIM server Ethernet port can be congured to either: gain its details via a
DHCP server; use a Static IP address, netmask and DNS server address, or alternatively be
set to Bonded operation, whereupon three further Bonding Mode options are displayed:
• Active-Backup - This can be used when both of the AIM server’s network
connections are linked to the same network switch. This option provides a fail-over
to cater for the possibility of hardware failure or connectivity failure between the AIM
server and the switch.
In this mode, one of the AIM server’s network ports will be active while the other
remains dormant. If the active port experiences a failure, such as a loss of connection,
its conguration is automatically transferred to the Backup port. Once the original
primary port resumes connectivity, this will become the backup and be placed into a
dormant mode.
continued
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
24
Page 26
• Broadcast - This option would be used when the twin ports of the AIM server and all
attached ALIF devices are split between duplicate networks:
Switch 1
Port 1
ALinkDDER ™
M ANAGER
Port 2
1
2
Switch 2
ALIF
The ‘Separate Device Networks’ option mentioned earlier would be enabled on the
AIM server and the respective network connections on the endpoints are connected
accordingly (e.g. copper to copper on only switch 1 and SFP to SFP only on switch 2).
In Broadcast mode, both of the AIM server network connections mirror each other,
i.e. duplicate network trafc is sent out on both connections. It is assumed that the
connected devices will only listen to the network trafc intended for themselves
and drop/ignore all other trafc intended for other devices. This mode is robust but
inefcient because half of the packets are discarded.
• 802.3ad - This mode uses a similar topology to Active-Backup, (i.e. both network ports
connected to the same switch) but has two important differences: Both of the AIM
server network ports are used simultaneously, and the network switch must support
LACP (Link Aggregation Control Protocol).
The AIM server will ‘merge’ (aggregate) the two connections and treat them as one.
The only exception to this would be on ‘multi-subnet racks’ where it would be
possible to have each network connection on different switches.
This mode provides the benet of increased bandwidth availability between the AIM
server and the network, but also provides a layer of redundancy. If one of the network
connections is lost, the remaining connection would take over until the link is restored.
The network trafc is not split on a packet by packet basis between the connections;
it operates on a connection basis. When a connection is established between the AIM
server and one of the ALIF endpoints, this would travel via one port. When a second
connection to another endpoint is established, this could use the same port or it may
use the other. There is no order to which network port is used for any connection.
Note: When changing between bonded and any other mode, a warning message will be
displayed and, when the Save button is clicked, will cause the AIM server to be rebooted.
Device Connectivity
IP Pool Lower/Upper Limits (not shown in multi-subnet mode)
When the AIM server is used in single subnet mode, these two elds are used to dene
the range (pool) of IP addresses that the AIM server can automatically assign to new ALIF
endpoint devices. The AIM server contains its own DHCP server with which it applies
the available IP addresses to ALIF endpoint devices.
When used in multi-subnet mode, the internal DHCP server with the AIM is disabled
and instead the AIM server will rely upon an external DHCP server to provide valid IP
address details.
Multicasting
Multicast IP Base
The start address for the multicast IP addresses to be used. Multicast IP addresses are
in the range 237.1.1.1 to 239.255.255.255. This setting lets you adjust this range of IP
Multicast addresses. It is important to allow sufcient addresses for your system. For
instance, if the multicast IP address base was set to 239.255.255.252 there would only be
4 multicast addresses available.
Always Multicast
Determines whether multicast addressing is always used for video and audio streams.
This should be used for most installations as it provides the most efcient way to deliver
video and audio to multiple destinations.
Use Global Multicast Addresses
Ordinarily, multicast addresses are set individually for each transmitter. However for
installations with many transmitters (particularly dual video port models, which require
six multicast addresses each), selecting this option allows you to congure just six
multicast IP addresses to use globally across the whole installation. Note: This option
requires full support for IGMP v3, which allows source-specic joins.
IGMP version
By default, force IGMPv2 is enabled. However, if your network supports IGMPv3 you can
take advantage of the IGMPv3 features by applying the Force v3 option.
Interfaces
Separate Device Networks
When this option is set to ‘Yes’, the ALIF devices within the network will be instructed to
promote a further level of network resilience by treating their copper and ber/teaming
connections as independent links via separate switches (in conjunction with dual independent
cabling schemes) see the diagram on next page. If one connection route is compromised, the
other will continue unaffected. During normal operation, when both connection routes are
operating, transfer speeds are boosted by the copper and ber links working in parallel.
The two Ethernet ports of the AIM server can be connected to the two separate
network switches to ensure that AIM control remains in place if one network switch
should become unavailable.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
25
Page 27
Route of Last Resort
This option is appropriate when the AIM server is used in multi-subnet mode. In such
cases, it is possible that the AIM server is not directly connected to the same subnetwork as some or all of the ALIF endpoints. Therefore, it will be necessary for the
ALIF unit(s) to communicate back to the AIM server via a gateway device (see Gateway
IP Address above). This option is used to indicate which interface has the gateway
congured.
Device Network Port
This lets the admin specify which port on AIM to use for ALIF control. This is either
the default ETH1 or Both ports if the AIM has ETH1 and ETH2 connected to the ALIF
network.
Monitoring
Packet loss monitoring is available if Statistics are enabled on one or more of the
receivers being monitored (see The Statistics Tab). You will need to set up an Simple
Network Management Protocol (SNMP) trap (see below) and/or declare a suitable email
account (see Dashboard > Settings > Mail) to receive notication when packet loss
drops below the chosen threshold/time frame:
Packet-Loss Alert Threshold
Determines when to issue a trap/alert based upon a threshold percentage of video
packets that have been dropped at the receiver.
Packet-Loss Alert Window
Determines the sampling period (in seconds) in determining the packet-loss threshold
(see above).
Syslog Enabled
Determines whether Syslog should be used to record log data to an external Syslog
server.
Syslog IP Address
The address of the external syslog server.
Note: Ensure that this is not set to the AIM’s IP adress as AIM cannot log its own syslog
messages.
SNMP
This option allows the AIM to connect to an external SNMP (Simple Network
Management Protocol) server. If SNMP is enabled, there are three connection modes:
• Authentication + Privacy
• Authentication Only
• No Authentication
There are two authentication types SHA or MD5 and two Privacy types AES or DES.
The MIB le can be downloaded from http://<IP>/AIM-MIB.txt
The response is split into three sections:
The rst reports status of each individual endpoint:
deviceIndex,
deviceType, (ALIF type i.e ALIF2002R)
deviceFirmware, (rmware revision)
deviceName,
deviceIdentier,
deviceIP1,
deviceMAC1,
deviceIP2,
deviceMAC2,
deviceSerialNum,
deviceStatus,
deviceLock,
deviceEth1Status,
deviceEth2Status,
The second part is returned from AIM:
numRx, (Number of RX units on system)
numTx, (number of Tx units on system)
numActiveConnexions,
serverCPULoad,
serverMemoryUsage,
serverSoftwareVersion,
serverDiskSpace,
The third part is the reporting of lost packets:
rxHead, (Which video head you are monitoring)
packetsSent,
packetsDropped
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
26
Page 28
Dashboard > Settings > Time
Dashboard > Settings > Active Directory
This page deals with all time related settings for the installation and allows up to three
external NTP servers to be dened.
NTP Enabled
Determines whether one or more external Network Time Protocol servers should be
used to provide timing for the installation.
Server 1/2/3 Address
Enter the IP address of the NTP server(s).
NTP Key Number(s)/NTP Key(s)
If you wish to use Symmetric key authentication for the server, enter an appropriate NTP
key number and key.
If you need to add more NTP servers, click the Set option next to the NTP Server 2 or
3 entries.
Time Zone Area and Time Zone Location
Use these entries to pinpoint the current location of the installation.
Dashboard > Settings > Mail
This page sets up the email functionality of the AIM server if required. An external Email
server is required to sit on the network if this functionality is to be used.
Mail Enabled?
Determines whether the mail features of AIM should be invoked.
This page sets up the active directory server, if there is one on your network, and to use
active directory to maintain the user database.
Note: Active Directory groups with more than 1500 members will be downloaded as empty.
AD Enabled?
Determines whether Active Directory features will be used.
Account Sufx
Enter the account sufx for your domain.
Base DN
Specify the base Distinguished Name for the top level of the directory service database
that you wish to access.
Domain Controller
Enter the IP address or name of the server that holds the required directory service.
Username, Password
Enter the username and password for the domain account.
Sync Schedule
Choose the most appropriate synchronization schedule, from hourly intervals to daily or
weekly.
INSTALLATIONCONFIGURATIONOPERATION
SMTP Domain name/IP
Enter the name or IP address of the external SMTP server that will be used to process
all outgoing mail.
SMTP Port
Enter the appropriate port on the SMTP server.
Username, Password
Enter the appropriate username and password for access to the SMTP server.
From Address
Enter the email address that will be listed as the sender of alert messages.
Email Address for Alerts
Enter the email address to which alert messages should be sent.
Suppress Similar Alerts
Allows you to optionally dene a time period within which similar alerts to one already
received will be suppressed.
FURTHER
INFORMATION
INDEX
27
Page 29
Dashboard > Backups
You can schedule backup copies of the AIM database (containing all devices, users,
channels and logs) to be made on a recurring basis and you can also perform backups on
demand, as required.
IMPORTANT: You are strongly recommended to arrange regular scheduled
backups of your AIM database. Adder cannot be held responsible for any loss
of data, however caused.
Backup Options
Download to your computer: If this option is checked, when you click the “Backup
Now” button, the backup le will be saved to the server and then will be presented as a
download in your browser, so that you may save a local copy of the backup le.
Email Backup: If this option is checked, a copy of the backup le will be sent to the
email address specied in the “Email Backup To” eld. The backup le will be emailed
either when you click “Backup Now” and/or according to the option selected in the
Schedule section.
Note: Use of the Email backup option requires a valid email address to be stored within the
Dashboard>Settings page.
Note: Emailed backups are encrypted, and these backup les are automatically decrypted by
the AIM server when they are used.
Schedule: Determines how often a backup should be created. There are set periods for
the various options:
• Hourly backups are executed on the hour (or quarter past).
• Daily backups are executed at 2am (or quarter past).
• Weekly backups are executed every Sunday at 3am (or quarter past).
Backups on the Server
All backups (whether initiated manually or by schedule) are saved on the server together
with a time-stamp of when the backup was run. If required, you can select a previous
backup and restore its contents. Alternatively, you can download the backup le to
another location.
IMPORTANT: It is advisable to make a backup of the current state of the AIM system before
restoring a previous backup. Restoring the contents of a backup le will overwrite ALL data in
the AIM system, with the data within the backup le. This includes congured devices, channels,
users, connection logs and action logs.
Downloaded Backups
Use this option to upload a backup le that you have previously downloaded or received
by email. This will overwrite the contents of the current AIM system therefore it is
advisable to make a backup of the current state of the AIM system before restoring a
previous backup.
Archive Log to CSV File
You can archive connection or log data to a CSV le and, at the same time, remove old
log data from the database.
Click “Archive” to save a CSV le to the server.
Download CSV Archive
You can download any CSV archive that was created in the archive step (described
above) by selecting from the archives saved on the server.
The CSV archive can be opened in Microsoft Excel (or similar) to perform detailed
analysis of actions and connections within the AIM system.
Download Debug File
The purpose of the “Download Debug File” is to prove support with a copy of the
internal log les for diagnostics. The le is encrypted and can only be open by Adder.
Schedule Auto Delete Logs
This section allows you to select a suitable time period for auto deleting the debug logs.
The choices are Daily, Weekly and Monthly. Optionally, logs can be auto archived to CSV
les prior to deletion.
Export User Conguration
This section allows you to store user conguration snapshots at various periods in time
and later compare the contents of any of those stored snapshots with the current AIM
database user conguration.
To store a snapshot: Click the ‘Download Latest’ button. A compressed XML le
containing the conguration details will be created and stored.
To make a comparison between a stored snapshot and the current conguration: Select
the required snapshot from the ‘Available congurations’ drop down list. Then click the
Compare Congurations button to open a comparison dialog.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
28
Page 30
Dashboard > Updates
Upgrade AIM Software
This option allows you to upgrade (or downgrade, if required) the AIM server rmware
while preserving all conguration data. Firmware les are encrypted and digitally-signed
for AIM-server integrity.
Please see Upgrading (or downgrading) AIM rmware on the next page
Reset AIM Conguration
This option can be used to reset AIM to its initial conguration or a previous upgrade.
When the AIM server is reset, all devices, channels, presets, users, groups and logs will be
removed. Note: You are recommended to take a backup onto an external device before starting
the upgrade process.
If one or more previous upgrades have been installed on this system, you will be given the
option to choose either the original factory image or the last upgrade image. They will be
listed by version number - click the appropriate radio button to select.
Two other options are available within this section:
• Also reset the server IP address - When ticked, the IP address will be reset to the default:
169.254.1.3 and you will be reminded to manually navigate to that address.
• Also delete security certicates and keys - When ticked, all certicates and keys held within
the server will be removed.
When the required options have been chosen, click the Reset AIM Conguration
button to commence.
Upload New TX/RX Firmware
Allows you to upload a rmware le to the AIM server, which can then be used to
upgrade ALIF TX and RX units.
Install Firmware onto Devices
Allows you to determine various upgrade settings and then commence the upgrade
process.
Please see Upgrading ALIF rmware globally >>
Restart Apache
Occasionally, when changing certain key settings, such as the Locale, it may be necessary
to restart the main Apache server underlying AIM. If functionality is lost after changing
the Locale setting use this Restart button to restore correct operation.
Upgrading ALIF rmware globally
This method allows the AIM admin user to upgrade rmware on receivers and
transmitters, wherever they are located.
1 Use the “Upload New TX/RX Firmware” section to place new transmitter and/or
receiver rmware le(s) onto the AIM server. Once uploaded, the stored rmware
les are listed within the relevant “Available rmware” drop-down boxes within the
sections below.
2 Within the “Install Firmware onto Devices” section, choose either the Device Type
(RX or TX) or Firmware Type (Main or Backup copies).
3 Click the Available rmware drop-down box and select the required new rmware
version.
4 Click the “Install” button to apply the chosen rmware to the devices.
5 On the right side of the list, you can:
• Individually select the devices to which the rmware upgrade will be applied by
checking the “Upgrade” boxes next to each device, or
• Use the “Upgrade All” option to apply rmware globally to all devices.
6 Click the “Upgrade Selected...” button to create a queue of devices to be upgraded. If
there are many devices to upgrade, this may take some time.
The status of devices during the upgrade process should be shown in near-real time
on the receivers/transmitters pages and on the device’s own page. The page will show
whether the device is still being upgraded or if it is in the process of rebooting with
the new rmware. Note that the process of applying rmware to a device and enacting
a reboot takes several minutes to complete.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
29
INDEX
Page 31
Upgrading (or downgrading) AIM rmware
In certain circumstances it may be necessary to upgrade or downgrade the rmware of
an AIM unit to take advantage of particular features. The Upgrade AIM Software option
changes the rmware without affecting conguration data such as devices, channels,
presets, users, groups and logs.
Notes:
• Although conguration details are not affected during the rmware upgrade process,
you are recommended to take a backup onto an external device before starting the
upgrade process.
• When changing the AIM rmware, it will be necessary to reboot the unit in order to
apply the changes.
• There is no longer any support for ALIF1000 units.
To upgrade/downgrade the AIM unit rmware
Note: If there are any Backup or Satellite servers then these must be upgraded or downgraded
to be on the same software version before applying any ALIF rmware updates.
1 Download the appropriate rmware le from the Adder website or technical support.
2 Visit the Dashboard > Updates page of the AIM unit and within the ‘Upgrade AIM
Software’ section, click the Browse... button to locate the downloaded rmware le.
3 When you are ready to proceed, click the Upload button. The le will be uploaded,
checked and applied to the secondary partition within the AIM unit. A conrmation
message will be displayed and you will also be prompted to reboot the AIM unit.
4 When it is appropriate to do so (dependent on the current activity of the AIM unit),
click OK and then click the Reboot Now button. The AIM unit will reboot using the
new rmware partition.
INSTALLATIONCONFIGURATIONOPERATION
30
FURTHER
INFORMATION
INDEX
Page 32
Dashboard > Active Connections
Shows only connections that are currently active within the AIM network. Please refer to
the Connection Log page section below.
Dashboard > Connection Log
Shows all connections that have occurred within the AIM network. The most recent
connections are shown at the top, and the log is paginated (the number of rows per
page can be set from the Dashboard > Settings page). The log can be ltered to show
all connections, or only currently active connections. Current connections have no “end
time” and a disconnect icon ( ).
The “Audio Broadcast IP” and “Video Broadcast IP” columns show whether the audio
and video are being sent directly from the transmitter to the receiver or broadcast to
a multicast group. Direct links are denoted by the receiver’s IP address only; whereas
multicast broadcasts are indicated by the multicast icon ( ) and the common multicast
IP address (the address will be in the range specied within the “Multicast IP Address”
option of the Dashboard > Settings page).
Actions that you can take within this page include:
• Hover the mouse over the receiver, user or channel names to show more information
about each item.
• Hover the mouse over the ve “Info” icons to see descriptions (audio on/off; video on/
off; USB on/off; shared/exclusive mode; serial on/off).
• Click to end a connection between a receiver and a channel.
Dashboard > Event Log
This page lists events that have occurred within the AIM system. A drop-down list box is
available at the top of the page which allows you to apply one or more lters to reduce
the listed events to show those of specic interest, as follows:
• Event Type
• Event Date/Time
• Recent Events
• Username
• Receiver Name
• Transmitter Name
• Channel Name
• Preset Name
As each lter type is selected, a new eld will be added to the page so that you may
enter your lter criteria.
You can archive Event Log data to a CSV le via the “Archive log data” link, which jumps
to the relevant section within the Dashboard > Backups page.
Dashboard > Remote Support
The remote support feature grants a member of the technical support team remote
access to the AIM unit. This page shows the current state of remote support, whether
currently enabled or disabled, plus a button to change the remote support state.
INSTALLATIONCONFIGURATIONOPERATION
For further details, please see Enabling Remote Support.
Note: Before enabling remote support contact Adder technical support.
FURTHER
INFORMATION
INDEX
31
Page 33
ENABLING REMOTE SUPPORT
F
The AIM manager has a remote support feature that allows technical support to connect
should the need arise. It works by establishing a secure SSL connection with a managed
secure server hosted on the internet. Using a reverse tunnel, technical support can
connect to the manager via the secure server. Each support representative has their own
unique SSL keys for full traceability when making a remote connection. To protect the
manager against unauthorised access, Remote Support is disabled by default. Access is
only granted by Enabling Support and giving the support representative a unique one-
time password which is automatically generated each time it is enabled.
Below is a diagram that shows how the feature works:
Router
• AIM must be connected to a network which has internet access using Ethernet Port 2.
• Navigate to Dashboard -> Settings -> Network. You will need to congure an IP
address, gateway and DNS for Ethernet Port 2.
• You will need to ensure that outbound port 22 is not blocked by the rewall or router
to the internet. You can choose other ports such as 80, 443, 53, 2222, 10222.
• Navigate to the Dashboard -> Remote Support tab on the AIM admin Web UI and
click on the Enable Remote Support button.
INSTALLATIONCONFIGURATIONOPERATION
• The AIM will show a port number and one-time password (OTP) which are required
to remotely access the manager.
irewall
Adder
ALinkDDER ™
MANAGER
1
2
Support
Note: There have been different versions of this Remote Support feature where the behaviour
varies slightly. We recommend that you have the latest rmware installed.
• If the port number changes after 1 minute, this means that either 1) The port is used
by another Remote session or 2) The manager has been unable to access the remote
server. If port number continues to change, please check your network and rewall
settings.
• Please contact support@adder.com, stating the port number and one-time password
that you have been given. If you have changed the admin password from the default,
then please could you create a temporary administrator account so that we can access
the web interface if required.
FURTHER
INFORMATION
INDEX
32
Page 34
Web Interface Access
During the Remote Support session, we may need access to the AIM’s web interface. So
that you do not need to reveal or change your Admin password, please could you create
a temporary user and set it as an AIM Administrator. Please let us know the user and
password that you have created.
Troubleshooting
In the event that you do not see a port number, check the following:
• You have outbound port enabled on your rewall, typically 22, 443, 53, 2222 or 10222.
• There is only one gateway on the AIM Manager, make sure that the gateway is correct.
If you set the Ethernet port 2 to DHCP, the gateway from the DHCP server is not
used.
• Try manually assigning an IP address, subnet mask, gateway and DNS Setting to
Ethernet Port 2.
INSTALLATIONCONFIGURATIONOPERATION
33
FURTHER
INFORMATION
INDEX
Page 35
THE CHANNELS TAB
The Channels tab provides access to all settings and options related directly to the video,
audio and USB streams, collectively known as channels, emanating from any number of
transmitters.
Click the CHANNELS tab to view the initial View Channels page.
The various other Channels pages (e.g. Add Channel, View Channel Groups, etc.) are
selectable within the blue section located just below the tabs.
Search lters
The key elds (Name, Description, Location and Type) all provide
a search lter to locate particular items within long lists. Enter a
full or partial search string into the appropriate lter box and then
click to start the search. Optionally use the buttons to
invert the order of the listing.
The page will reload with the same pagination/sort order, but with the added search
lter. It’s possible to lter by several columns at once (e.g. search for all entries with
“mac” in the name, and “mixed” in the description). Search terms are case-insensitive. You
can re-sort and paginate on ltered results without losing the lters.
To remove a lter, click the red cross next to the relevant lter, (you can also empty the
search box and click again).
The Type column will either state ALIF for connections which use an ALIF transmitter or
RDP for virtual machine connections, which do not require a physical transmitter.
Channels > View Channels
This page lists all channels that currently exist within the AIM system. A channel is
automatically created for every transmitter when it is added and congured within the
AIM network. The new default channel for each added transmitter will inherit the name
of the transmitter. Such default names can be altered at any time and additionally, you can
also create new channels manually, if necessary.
Within the list of channels, the Allowed Connections column indicates how each channel
may be accessed by users. By default, these settings are inherited from the global setting
(congurable within the Dashboard > Settings page), however, each channel can be
altered as required. The icons denote the following connection rules:
Connection details inherited from the global setting
Video-Only
Shared
Exclusive
Private
The Channel Groups column shows to how many channel groups each channel belongs.
The Users column indicates how many users have permission to view each channel.
Actions that you can take within this page include:
• Create a new channel: Click the “Add Channel” option.
• Create a new channel group: Click the “Add Channel Group” option.
• Congure an existing channel: Click for the required channel.
• Clone an existing channel: Click to use the settings for the current channel as
the basis for a new channel entry.
• Delete a channel: Click for the required channel.
• Delete multiple channels: Click the “Turn Batch Delete Mode On” button, the
icons for all channels are replaced with tick boxes. Tick the boxes of the channels
that need to be deleted and then click the “Delete selected channels” button which
appears at the bottom of the page. When you are nished, click the “Turn Batch Delete
Mode Off” button.
• View a channel group: Click the “View Channel Groups” button.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
34
INDEX
Page 36
Channels > Add or Congure a Channel
From the View Channels page, you can add a new channel or congure an existing
channel:
• To create a new channel: Click the “Add Channel” option.
• To congure an existing channel: Click for a channel.
The Add and Congure pages are similar in content.
Channel Name, Description and Location
These are all useful ways for you to identify the channel and its origins. A consistent
naming and description policy is particularly useful in large installations.
Video, Audio, USB, Serial and Digital Audio
These drop down boxes list all of the available streams from installed transmitters. When
creating a channel, you can choose to take all streams from the same transmitter or from
different ones, as required.
Notes:
• Where necessary, channels can be created without video, audio, USB and/or serial.
• Only one receiver can use a transmitter’s serial port at any time.
• Digital audio is the audio signal that is derived from video signals, such as DisplayPort
connections and is only available on certain dual port ALIF models.
• When specifying dual-head video channels, you are recommended to avoid choosing video
sources from two different transmitters. Highly active video from two sources can result in
video degradation and loss.
Sensitive
This will mark the channel as sensitive within the OSD channels list.
Override OSD Banner Position
Allows you to override the global setting for the positioning of the OSD banner for this
channel.
Allowed Connection Modes
This section allows you to dene the types of connection that you wish to permit users
to make. You can dene particular individual or combined connection types to suit
requirements.
Note: This setting for each channel acts as the nal arbiter of whether exclusive access can
actually be achieved. If you deny exclusive access rights within this setting, then exclusive access
for any user cannot take place for this channel, regardless of settings made elsewhere.
• Inherit from global - uses the setting of the “Allowed Connection Modes” option
within the Dashboard > Settings page.
• Set for this channel - permits you to choose modes manually:
• Video-Only: Allows users only to view the video output, the USB channel is
denied.
• Shared: Allows users to control a system in conjunction with other users.
• Exclusive: Grants exclusive control to one user while all others can
simultaneously view and hear, but not control, the output.
• Private: Allows a user to gain private access to a system, while locking out all
others.
Group Membership
Groups provide a quick and easy way to manage settings for channels. By making a
channel part of a particular group, the channel automatically inherits the key settings of
that group.
The group membership section displays existing channel groups in the left list (to which
the current channel does not belong) and the channel groups in the right list to which it
does belong.
To add the channel to groups: Highlight one or more (use the CTRL key if selecting
more than one) group names in the left list and then click to add the name(s) to the
right list.
Note: You can also include or exclude individual channels by double clicking on them.
To add the channel to all groups: Click to move all group names from the left to
the right list.
To remove the channel from groups: Highlight one or more (use the CTRL key if
selecting more than one) group names in the right list and then click to move the
name(s) back to the left list.
To remove the channel from all groups: Click to move all group names from the
right to the left list.
Permissions
This section allows you to determine which users and user groups should be given
access to this channel. Individual users and user groups are handled within separate subsections, but both use the same method for inclusion and exclusion.
To include one or more users (or groups): Highlight one or more (use the CTRL
key if selecting more than one) user/group names in the left list and then click to add
them to the right list.
To include all users (or groups): Click to move all user/group names from the left
to the right list.
To remove one or more users (or groups): Highlight one or more (use the CTRL
key if selecting more than one) user/group names in the right list and then click to
move them back to the left list.
To remove all users (or groups): Click to move all user/group names from the
right to the left list.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
35
Page 37
Channels > Add or Congure Channel Group
Channel groups allow easy permission-granting for several channels at once. Permissions
can be set to determine which users can access channels within a channel group.
From the View Channels page, you can add a new channel group or congure an existing
channel group:
• To create a new channel: Click the “Add Channel Group” option.
• To congure an existing channel: Click “the View Channel Groups” option and then
click for a group.
The Add and Congure Channel Group pages are similar in content.
Channel Group Name and Description
These are all useful ways for you to identify the channel and its origins. A consistent
naming and description policy is particularly useful in large installations.
Group Membership
Allows you to determine which channels should be members of the group. By making
a channel part of the group, each channel automatically inherits the key settings of the
group.
To add a channel to the group: Highlight one or more (use the CTRL key if selecting
more than one) channel names in the left list and then click to add the name(s) to the
right list.
Note: You can also include or exclude individual channels by double clicking on them.
To add all channels to the group: Click to move all channel names from the left
to the right list.
To remove a channel from the group: Highlight one or more (use the CTRL key if
selecting more than one) channel names in the right list and then click to move the
name(s) back to the left list.
To remove all channels from the group: Click to move all channel names from
the right to the left list.
INSTALLATIONCONFIGURATIONOPERATION
Permissions
This section allows you to determine which users and user groups should be given
access to channels within this group. Individual users and user groups are handled within
separate sub-sections, but both use the same method for inclusion and exclusion.
To include one or more users (or groups): Highlight one or more (use the CTRL
key if selecting more than one) user/group names in the left list and then click to add
them to the right list.
To include all users (or groups): Click to move all user/group names from the left
to the right list.
To remove one or more users (or groups): Highlight one or more (use the CTRL
key if selecting more than one) user/group names in the right list and then click to
move them back to the left list.
To remove all users (or groups): Click to move all user/group names from the
right to the left list.
36
FURTHER
INFORMATION
INDEX
Page 38
THE RECEIVERS TAB
The Receivers tab shows a paginated table of all receiver devices within the AIM
network.
Click the RECEIVERS tab to view the initial View Receivers page.
The other Receivers pages (e.g. View Receiver Groups, Add Receiver Group, etc.) are
selectable within the blue section located just below the tabs.
Search lters
The key elds (Name, Description and Location) all provide a
search lter to locate particular items within long lists. Enter a full
or partial search string into the appropriate lter box and then
click to start the search. Optionally use the buttons to
invert the order of the listing.
The page will reload with the same pagination/sort order, but with the added search
lter. It’s possible to lter by several columns at once (e.g. search for all entries with
“mac” in the name, and “mixed” in the description). Search terms are case-insensitive. You
can re-sort and paginate on ltered results without losing the lters.
To remove a lter, click the red cross next to the relevant lter, (you can also empty the
search box and click again).
Receivers > View Receivers
The table shows the following information for each receiver:
• Type and online status • Name
• IP address • Firmware revision
• Custom Settings (Inherited or Custom icons) • Receiver Groups
• Presets • Users
• Description & Location • Manage (admin options - see below)
The Manage icons are as follows:
(Note: You can hover your mouse pointer over any icons to reveal additional information):
Congure device: Displays the “Congure Receiver” page.
Reboot device: Allows you to reboot or reset a unit to its factory settings. A
popup will ask which task you wish to carry out. A reboot is useful if a device enters
an unknown state. A reset will return the unit to its factory default state and reset
its IP address (the unit will retain any rmware updates that have been applied).
Identify unit: Causes the LED lights to ash on the front of the selected unit. An
alert will be shown if the unit cannot be contacted (e.g. if it is ofine).
Delete device: Conrmation will be requested. You will need to factory-reset any
devices that you wish to re-congure to work with AIM.
Connect to a channel: A list of available channels is shown, along with connection
modes (Video-Only/Shared/Exclusive/Private). The admin user can thus remotely
change channel on any receiver.
Disconnect: If a receiver is currently connected to a channel, clicking the
disconnect icon will end the connection, regardless of who is connected. Hovering
over the icon will show which user is connected, which channel they are connected
to, and when the connection was created.
Disconnect All: In the title bar above all of the other Manage icons, a Disconnect
All control (if enabled within the main settings page) allows all receivers to be
collectively disconnected from their respective channels.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
37
INDEX
Page 39
Receivers > Congure Receiver
From the View Receivers page, you can congure details for a receiver:
• Click for a receiver.
Note: If the IP address of the receiver is changed, the device will need to reboot itself.
Device ID / Type - Identity of the receiver.
Device Name, Description and Location
These are all useful ways for you to identify the receiver and its origins. A consistent
naming and description policy is particularly useful in large installations.
If the adjacent DHCP allocated
option is ticked, the elds will be
grayed out and congured by a
DHCP server.
Main/Backup Firmware - The current rmware versions contained within the unit.
Online? - Current status of the receiver.
MAC Address / 2 - Lists the xed network identiers for the single or double ports.
IP Address / 2 - Lists the single or dual IP addresses for the unit. If the DHCP options
are ticked then the elds will be grayed out.
IP address 3 - (ALIF3000R only) Lists the third IP address, netmask and gateway (for the
RJ45 port) for the unit.
DHCP allocated - When ticked, the DHCP will assign the endpoint an available
IP address from the DHCP pool. When unticked, it allows you to manually specify
an address to give to the Receiver or Transmitter. However, this is NOT a static IP
address, but one that the AIM’s DHCP server will always issue to the endpoint on boot.
Technically its a ‘DHCP Reserved IP address’.
Allow Local Feedthrough - When selected, allows the receiver to connect directly to
a local source. Feedthrough is supported on the following models: ALIF1002, ALIF2000,
ALIF2020 and ALIF4000 (ALIF4000 units require rmware version 4.0 or greater and AIM
v4.12 or greater to operate a local feed through link).
Login Required
• No: When selected, anyone can use a receiver terminal and connect to a channel. The
channels/permissions displayed to this anonymous user are those that are set for the
“anonymous user” that is dened within the Dashboard > Settings page.
• Inherit from Receiver Groups: When selected, the requirement for user login will
be determined by the “Login Required” settings within the Receiver Groups to which
this unit belongs:
• If ANY of the receiver groups (to which this receiver belongs) are set as “Login
Required = Yes”, this receiver will require login.
• If ANY of the receiver groups (to which this receiver belongs) are set as “Login
Required = Inherit...” and the global setting is “login required = yes”, then this
receiver will require login.
• If ALL receiver groups (to which this receiver belongs) are set as “Login Required =
No”, then this receiver will NOT require login.
• Ye s : When selected, a user will need to login with the username and password dened
in the “Users” section. They will only be allowed to login if they have been granted
permission to access that particular receiver.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
38
Page 40
Auto Login User
Allows you to authorize a user (or group) account to use the optional Auto Login
feature. This option will be grayed out if the Auto Login feature has not been installed).
See “Auto Login feature” on page 43 for more details.
Receiver OSD Alerts
Determine the required setting for pop up OSD alerts: Inherit, No or Yes.
Show Current Channel
When selected, shows the currently connected channel as an overlay.
OSD Banner Position
Allows you to determine the position of the OSD banner on each user’s screen - or use
the global settings.
OSD Icon Launch Size
Determines the default size of the icons used in the OSD. Options include: Small,
Medium, Large and Extra Large.
Touch show OSD enable
Determines whether the OSD can be shown on a touch screen device when supported
by certain ALIF devices - at present supported by ALIF2000- and 4000- series receivers.
USB Connector to Monitor number mapping
Allows you to share the various emulated USB ports between the connected video
displays - at present only supported by ALIF4021R receivers. This option uses the global
setting by default.
Keyboard Country
Select the country code of the keyboard connected to the receiver.
Audio Input Type
Select the required audio input type.
USB settings - see next page for details.
Monitor 1 / 2 Settings
Video Compatibility Check
This reads the EDID from the attached monitor(s) and determines whether they are
capable of displaying the selected video mode before connecting a channel. This prevents
the receiver showing a black screen and the user being locked out, for instance because a
dual link resolution has been selected to display on a single link monitor.
Force 60Hz
If enabled, the receiver frame rate is held at 60Hz regardless of the video input frame
rate. The Video Switching options (below) cannot be altered when this option is enabled.
Video Switching
Provides two options for video switching:
• Fast Switching (default state) - Retains the same frame rate (at either 50Hz or 60Hz)
depending upon which video resolution was displayed rst.
• Match Frame Rate - Follows the source frame rate and will change the frame rate every
time this changes even if the video resolution doesn’t change. If you have one receiver
switching between 1920x1080@60Hz and 1920x1080@50Hz then this setting will
change the frame rate from 60Hz to 50 Hz every time that you switch.
Audio Compatibility Check
This reads the EDID from the attached monitor and determines whether the monitor is
capable of processing the selected digital audio mode before connecting a channel.
Group Membership
To facilitate collective permission-granting for numerous receivers, a receiver can
belong to one or more receiver groups. Any permissions applied to the receiver group
are inherited by all receivers that are included within the receiver group. For example,
multiple receivers can be made available to a user by placing them all in a receiver group
and then granting the user permission to use that receiver group.
Permissions
This is hidden by default as, by default, all users have access to all receivers. You can deny
access to particular receivers for a user in this section. However, be aware that users who
are included within user groups may have access to the same receivers via their groups.
USB Settings - see USB Settings.
Advanced Port Features
This section allows you to determine USB port behaviour for use with certain USB
devices.
The default is no reserved ports, Merging enabled and no feature code (or Quirk) set.
It is recommended that these are left at the default settings and are only changed under
advice from an Adder FAE.
For each of the four USB ports on the receiver, certain rules can be applied depending
upon the USB device connected.
If you have reserved USB ports on the transmitter, you can select which USB port to use
for a particular device.
You can turn off USB merging for a particular port. This will slow down switching as the
USB device will be enumerated every time that you switch.
You can also enter an advanced feature if it is necessary for your USB device. The drop
down lists the feature codes for some known USB devices. Otherwise please contact
your local FAE for advice.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
39
Page 41
USB Settings
Receiver ID / Name - Identity of the receiver.
HID Only
This option allows you restrict USB devices to allow only HID (mice, keyboards, tablets,
touchscreens, etc.) devices to be connected to the receiver(s).
Block Mass Storage
This option allows you to prevent the use of USB mass storage devices at the receiver(s).
Note: ALIF3000 receivers do not support the use of mass storage devices, so this setting has no
effect on them.
The HID Only and Block Mass Storage options both affect how USB devices are supported
at the receiver(s). Their use in combination can produce the following results:
HID Only Block Mass Storage Outcome
No No No USB restrictions
Ye s No
Allow only HID devices
(Mass storage devices are also blocked)
Exclude mass storage devices but
No Ye s
allow other USB peripherals (e.g. mice,
keyboards, tablets, touchscreens, etc.)
Ye s Ye s
Allow only HID devices
(Mass storage devices are blocked)
Disable Isochronous Endpoint OSD Alerts
When an isochronous USB device is connected to the receiver there will no longer be a
warning message. ALIF units do not support isochronous devices.
Receivers > Congure New Receiver
This page is displayed whenever a new receiver is added to the network.
The IP Address 1 eld, showing the IP address that has been assigned by DHCP. Before
AIM can add the device into its database, a new IP address must be added to IP Address
1. This is the system IP address and applies equally for all ALIF series.
ALIF 2xxx, 3xxx and 4xxx series units have a secondary link port which can be used for
bandwidth doubling and/or redundancy. The IP address 2 eld is for the second (Teaming)
port. In order to use the second port, IP address 2 eld must be given a valid IP address.
For ALIF 1xxx units, this eld will remain blank.
INSTALLATIONCONFIGURATIONOPERATION
Enable Isochronous Endpoint Attach
Some USB devices combine many USB devices behind a USB hub. e.g a keyboard with
audio support. By enabling this option, devices will be allowed to connect to ALIF
receivers, however, the isochronous part (e.g. the audio component) of the devices will
not work.
FURTHER
INFORMATION
INDEX
40
Page 42
Receivers > Add Receiver Group or Congure Group
From the View Receiver Groups page, you can create a new group or congure an
existing group:
• To create a new group: Click the “Add Receiver Group” option.
• To congure an existing group: Click for a group.
The Add and Congure pages are similar in content.
Receiver Group Name and Description
The group name must be populated with a name up to 45 characters. A consistent
naming and description policy is particularly useful in large installations.
Login Required
• No: When selected, anyone can use a receiver terminal and connect to a channel. The
channels/permissions displayed to this anonymous user are those that are set for the
“anonymous user” dened within the Dashboard > Settings page.
• Inherit from global setting: When selected, the requirement for user login will be
determined by the “Login Required” setting within the Dashboard > Settings page.
• Ye s : When selected, a user will need to login with the username and password dened
in the “Users” section. They will only be allowed to login if they have been granted
permission to access devices in the receiver group.
Auto Login User
Allows you to authorize a user (or group) account to use the optional Auto Login
feature. This option will be grayed out if the Auto Login feature has not been installed).
See “Auto Login feature” on page 43 for more details.
Enable Receiver OSD Alerts
Determine the required setting for pop up OSD alerts: Inherit, No or Yes.
The next elds are the USB settings.
Note: USB port reservation and advanced USB features will be added to future releases of the
AIM management system.
Show Current Channel
When enabled, the name of the channel currently being viewed will be shown on screen.
OSD Banner Position
Allows you to determine the position of the OSD banner on each user’s screen.
Touch show OSD enable
Determines whether the OSD can be shown on a touch screen device when supported
by certain ALIF devices - at present supported by ALIF2000- and 4000- series receivers.
USB Connector to Monitor number mapping
Allows you to share the various emulated USB ports between the connected video
displays - at present only supported by ALIF4021R receivers. This option uses the global
setting by default.
Enable Video Compatibility Check
When enabled, this option reads the EDID from the attached monitor and determines
whether it is capable of displaying the selected video mode before connecting a channel.
This prevents the receiver showing a black screen and the user being locked out because
a dual link resolution has been selected to display on a single link monitor.
Enable Audio Compatibility Check
Applicable only to receivers (such as the ALIF4021R) which are capable of processing
multichannel digital audio via their DisplayPort connections. When enabled, this option reads
the EDID from the attached monitor/audio system and determines whether the receiver’s
current audio setting (e.g. 2 Channel, 6 Channel, 8 Channel) is capable of correctly playing the
selected audio (e.g. Stereo, 5.1 or 7.1) mode before connecting a channel.
Force 60Hz
If enabled, the receiver frame rate is held at 60Hz regardless of the video input frame
rate. The Video Switching options (below) cannot be altered when this option is enabled.
Video Switching
Provides two options for video switching:
• Fast Switching (default state) - Retains the same frame rate (at either 50Hz or 60Hz)
depending upon which video resolution was displayed rst.
• Match Frame Rate - Follows the source frame rate and will change the frame rate every
time this changes even if the video resolution doesn’t change. If you have one receiver
switching between 1920x1080@60Hz and 1920x1080@50Hz then this setting will
change the frame rate from 60Hz to 50 Hz every time that you switch.
USB Settings - see USB Settings.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
41
INDEX
Page 43
Group Membership
This section allows you to easily include or exclude individual receivers for this group.
All relevant group permissions will be applied to all receivers that are included within
the group. Receivers that are not currently included in this group within the left list and
those receivers that are included within the right list.
To add a receiver to this group: Highlight one or more (use the CTRL key if selecting
more than one) receiver names in the left list and then click to add the name(s) to
the right list.
To add all receivers to the group: Click to move all receiver names from the left
to the right list.
To remove a receiver from the group: Highlight one or more (use the CTRL key if
selecting more than one) receiver names in the right list and then click to move the
name(s) back to the left list.
To remove all receivers from the group: Click to move all receiver names from
the right to the left list.
Permissions
This is hidden by default because all users have access to all receivers. You can deny
access to the receiver group, however, be aware that users who are included within user
groups may have been given access to the receiver group via their user groups.
Receivers > Update Firmware
Click this option to go straight to the Dashboard > Updates page.
See Dashboard > Updates for more details.
INSTALLATIONCONFIGURATIONOPERATION
42
FURTHER
INFORMATION
INDEX
Page 44
Auto Login feature
Auto Login is an optional service, available from AIM software release v5.2 onwards, that
can be added at any time to an AIM installation. Its purpose is to allow receivers/users
(dened individually, by receiver group or globally) to use hotkeys to switch channels
without the need to login to the OSD. This feature is useful for applications where a
range of transmitter outputs are available for selection and display, but where user
interaction is otherwise not required or appropriate.
Note: When conguring the Auto Login feature, bear in mind that any channels to which a
receiver/user has been granted access and which have been assigned hotkeys, can be accessed
by anyone who has physical access to the receiver and knowledge of the necessary hotkeys.
To add the Auto Login feature
• Purchase and install the necessary Auto Login license.
See “Appendix D - License upgrading” on page 68.
To authorize users for Auto Login
Once the Auto Login feature has been licensed, receivers/users can be authorized to use
it, either:
• individually, see page 22
• by receiver group, or see page 39
• globally see page 41
To set Auto Login hotkeys for a user
1 Login to the user’s local OSD (see “Logging in” on page 58).
2 Click the icon prexed to a channel or preset entry that requires auto login. The
screen will list the ten hotkey slots numbered 0 to 9. Any available slots will be listed as
EMPTY. Click the number prex (from 0 to 9) of an available slot. Optionally click one
of the page numbers listed along the foot of the page, to choose any prex from 10 to
99 (and then choose an available slot).
Note: To remove a previous channel from a slot, click the icon on the right side of the slot.
3 Click the Save icon on the right side of the slot.
4 You will now be asked to choose which mode should be used to access the channel
when using this shortcut. Select Video-Only, Shared, Exclusive or Private, as appropriate.
5 Repeat steps 2 to 4 for other channels that require hotkeys to be set.
6 Click the button at the top of the page. The user will now be able to
access the chosen channel without logging in by using the hotkeys (Left Ctrl + Left Alt,
as standard) plus the number assigned to it.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
43
INDEX
Page 45
THE TRANSMITTERS TAB
The Transmitters tab shows a paginated table of all transmitter devices within the AIM
network.
Click the TRANSMITTERS tab to view the transmitters page.
Search lters
The key elds (Name, Description and Location) all provide a
search lter to locate particular items within long lists. Enter a full
or partial search string into the appropriate lter box and then
click to start the search. Optionally use the buttons to
invert the order of the listing.
The page will reload with the same pagination/sort order, but with the added search
lter. It’s possible to lter by several columns at once (e.g. search for all entries with
“mac” in the name, and “mixed” in the description). Search terms are case-insensitive.
You can re-sort and paginate on ltered results without losing the lters.
To remove a lter, click the red cross next to the relevant lter, (you can also empty the
search box and click again).
Transmitters > View Transmitters
The table shows the following information for each transmitter:
• Type and online status • Name
• IP address • Firmware revision
• Custom Settings (Inherited or Custom icons) • Presets
• Channels (attributed to each transmitter) • Description & Location
• Manage (admin options - see below)
The Manage icons are as follows:
(Note: You can hover your mouse pointer over any icons to reveal additional information):
Congure device: Displays the “Congure Transmitter” page.
Reboot device: Allows you to reboot or reset a unit to its factory settings. A
popup will ask which task you wish to carry out. A reboot is useful if a device enters
an unknown state. A reset will return the unit to its factory default state and reset
its IP address (the unit will retain any rmware updates that have been applied).
Note: This icon is not present on virtual machine entries.
Identify unit: Causes the LED lights to ash on the front of the selected unit. An
alert will be shown if the unit cannot be contacted (e.g. if it is ofine).
Note: This icon is not present on virtual machine entries.
Delete device: Conrmation will be requested. You will need to factory-reset any
devices that you wish to re-congure to work with AIM.
INSTALLATIONCONFIGURATIONOPERATION
44
FURTHER
INFORMATION
INDEX
Page 46
Transmitters > Congure transmitter or Virtual Machine
In the list of transmitters, when you click for a particular entry, you will see one of
two pages of settings depending on whether the entry represents an ALIF transmitter or
a Virtual Machine (VM), also referred to as VDI (Virtual Device Infrastructure) of which
RDP (Remote Desktop Protocol) is one type.
• ALIF transmitter - see below
• Virtual Machine - see page 47
ALIF transmitter
Device ID / Type - Identity of the transmitter.
Device Name, Description and Location
These are useful identiers for the transmitter unit and its exact location. These become
even more valuable as the number of transmitters within the system increases.
Main/Backup Firmware
The current rmware versions contained within the unit.
Online?
Current status of the receiver.
MAC Address / 2
Lists the xed network identiers for the single or double ports.
IP Address / 2
Lists the single or dual IP addresses for the unit. If the DHCP options are ticked then the
elds will be grayed out.
Video 1/2 Multicast IPs
Lists the IP addresses that will be used for distributing video signals when multicasting.
Audio Multicast IPs
Lists the IP addresses that will be used for distributing audio signals when multicasting.
Enable Dummy Boot Keyboard
It is often necessary to have a keyboard reported at start up. This setting means that a
“Virtual Keyboard” is always reported to the USB host. It may be necessary to disable
this for use with some KVM switches.
Enable Audio
Determines the status of the audio feed from the transmitter.
USB Speed
If required, select USB 1 Full Speed or USB 2 Hi-Speed USB, otherwise leave as Global.
USB Hub Size
Select either a 13 or 7 port USB hub. This determines the number of USB devices that
can be connected to a single Transmitter.
Peak Bandwidth Limiter
The transmitter will use as much of the available network bandwidth as necessary to
achieve optimal data quality, although typically the transmitter will use considerably less
than the maximum available. In order to prevent the transmitter from ‘hogging’ too
much of the network capacity, you can reduce this setting to place a tighter limit on the
maximum bandwidth permissible to the transmitter. Range: 1 to 100%.
Transparent USB Bandwidth Limit
In order to prevent the transmitter from ‘hogging’ too much of the network capacity, you
can reduce this setting to place a limit on the maximum USB bandwidth permissible to
the transmitter. Range: 1 to 100% (which equates to 1 to 480Mbps).
Video Port 1/2 Settings
These two sections allow you to directly adjust various key video controls within
the transmitter in order to obtain the most efcient operation taking into account
connection speeds and the nature of the video images sent by that transmitter.
Magic Eye
Determines whether the Magic Eye feature should be enabled on certain ALIF transmitters
(e.g. 100T, 101T, 1002T, 2002T, 2020T, 2112T, 4000T models). Magic Eye works to
overcome the issues with increased bandwidth usage caused by ‘dithering’ techniques used
on some computers, such as Apple Macs. See the ALIF dual user guide for more details.
EDID
Determines how the video conguration details should be determined: Either harvested
from the connected display screens (USE CONNECTED MONITOR’S EDID) or by
selecting a static xed EDID setting from the list (e.g. GENERIC 16:9, 1920x1080
HD1080, 1600x1200 UXGA, etc.). Using a xed EDID setting can signicantly speed up
video switching times as EDIDs do not need to be checked, however, all of the installed
monitors need to support the chosen resolution. Where EDIDs are checked, enabling
EDID Optimisation (below) can help to regain some of the switching speed.
Note: Care must be taken when selecting a Dual Link Video resolution (e.g. 2560x1600) as certain
ALIF units do not support Dual Link Video resolutions. In the case of a Dual Link EDID being set in
the Global settings, no EDID will be set on Video port 2 of dual port ALIF transmitters.
Dynamic Range EDID
For ALIF devices which support HDR (such as the ALIF4021T), this option can be used
to grant permission to go beyond the standard SDR8 setting and use SDR10 or HDR10
when the connected host and video displays support 10bpc color depths.
EDID optimisation
When this option is enabled, the transmitter will compare the native resolution settings
of its monitor(s) when switching. If a monitor has the same native resolution as the
previous one, the new EDID is not sent to the graphics card. This speeds up switching
as the graphics card does not have to go through a hotplug detect routine when a new
receiver is switched to that channel. If the new receiver has a monitor with a different
native resolution, then the EDID will be updated to allow for a change in video mode.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
45
Page 47
Audio EDID
For transmitters which support digital audio via the DisplayPort connection(s),
this setting determines how the audio should be congured: (USE CONNECTED
MONITOR’S EDID) or a static setting: NONE, 2 CHANNEL (Stereo), 6 CHANNEL
(surround 5.1) or 8 CHANNEL (surround 7.1). Using a xed EDID setting can signicantly
speed up switching times as EDIDs do not need to be checked, however, all of the
installed audio devices need to support the chosen format. Where EDIDs are checked,
enabling Audio EDID Optimisation (below) can help to regain some of the switching
speed.
Audio EDID Optimisation
When enabled, transmitters will compare the digital audio settings when switching. If a
receiver’s digital audio settings are the same as the previous one, the new EDID is not
sent to the host system. This speeds up switching as the host system does not need to
go through a hotplug detect routine when a new receiver is switched to that channel. If
the new receiver uses a different audio setting, then the EDID will be updated to allow
for a change in audio mode.
Hot Plug Detect Control
Determines whether to enable hot plug detection for monitors. By default this is enabled.
Hot Plug Detect Signal Period
By default this is set at 100ms, which is sufcient for most graphics cards. Occasionally it
may be necessary to adjust this. An Adder engineer will advise if necessary.
Background Refresh
The transmitter sends portions of the video image only when they change. In order to
give the best user experience, the transmitter also sends the whole video image, at a
lower frame rate, in the background. The Background Refresh parameter controls the
rate at which this background image is sent. The default value is ‘every 32 frames’, meaning that a full frame is sent in the background every 32 frames. Reducing this to ‘every 64
frames’ or more will reduce the amount of bandwidth that the transmitter consumes. On
a high-trafc network this parameter should be reduced in this way to improve overall
system performance. Options: Every 32 frames, Every 64 frames, Every 128 frames, Every
256 frames or Disabled.
Maximum Bits Per Colour
This option controls the dynamic range mode. When set to 8bpc, only SDR8 mode will
be supported. When set to 10bpc, the transmitter will allow SDR10 or HDR10 mode
providing the host computer and attached video displays support those modes. See the
user guide for ALIF devices that support 10bpc for a more detailed explanation.
Compression Level
The newer AFZ+ codec complements the existing AFZ codec by providing greater
compression for increased speed where pixel perfect results are not the primary
focus. The transmitter video conguration page allows you to choose the required
compression mode. Choices are:
• ‘Pixel perfect’ - only uses pixel perfect AFZ,
• ‘Adaptive’ - guarantees frame rate, builds to pixel perfect,
• ‘Smoothest video’ - forces the maximum compression, or
• ‘Advanced’ - allows you to choose the minimum and maximum compression modes:
1 = ‘AFZ only (pixel perfect),
2 = ‘AFZ+ Minimum compression’,
3 = ‘AFZ+ Middle compression’, or
4 = ‘AFZ+ Maximum compression’.
Frame Skipping
Frame Skipping involves ‘missing out’ video frames between those captured by the
transmitter. For video sources that update only infrequently or for those that update
very frequently but where high delity is not required, frame skipping is a good strategy
for reducing the overall bandwidth consumed by the system. Range: 0 to 99%.
Serial Settings
Serial Parity, Serial Data Bits, Serial Stop Bits, Serial Speed
This group of settings allows you to dene the key parameters for the AUX port of the
transmitter so that it matches the operation of the device attached to it.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
46
INDEX
Page 48
Transmitters > Add VDI / Congure Virtual Machine
Virtual Machines are capable of connecting to the network and sharing their resources
directly, without the need for a distinct transmitter device; the common term for this is
VDI (Virtual Desktop Infrastructure). These virtual machines can be accessed across the
network directly by specially equipped receivers, such as the ALIF3000.
From the Transmitters page::
• To create a new virtual machine entry: Click the “Add VDI” option.
• To edit an existing virtual machine, click on a VM entry (marked with the icon).
The elds shown will depend on the selected VM access protocol VDI type:
INSTALLATIONCONFIGURATIONOPERATION
RDP
RDP Name
Enter a valid name for the virtual
machine.
IP Address/DNS Name
Enter either a distinct IP address or
DNS name for the virtual machine.
Port
The usual port address for RDP
connections is 3389.
Domain Name
Enter the domain name if the virtual
machine host is part of a Windows
domain, eg ‘Engineering Dept’,
‘Marketing’, etc. This will mean that
users do not need to enter the domain
name when they log in. Otherwise,
leave this eld blank.
Maximum Resolution
This option provides the option to cap
the resolution used for RDP connections
to improve performance when high
resolution monitor settings are used.
VNC
VNC Name
Enter a valid name for the virtual
machine.
IP Address/DNS Name
Enter either a distinct IP address or
DNS name for the virtual machine.
Port
The usual port address for VNC
connections is 5900.
HTML
HTML Name
Enter a valid name for the virtual
machine.
HTML URL
Enter the URL for the virtual machine.
Port
The usual port address for HTML
connections is 80.
SSL Required
Choose whether SSL encryption is
required for this link.
Terminal (SSH, Secure Shell)
Terminal Name
Enter a valid name for the virtual
machine.
IP Address/DNS Name
Enter either a distinct IP address or
DNS name for the virtual machine.
Port
The usual port address for SSH
connections is 22.
FURTHER
INFORMATION
In all cases, enter/edit the required settings and click the Save button.
INDEX
47
Page 49
Transmitters > Update Firmware
Click this option to go straight to the Dashboard > Updates page. See Dashboard >
Updates for more details.
Transmitters > Congure New Transmitter
This page is displayed whenever a new transmitter is added to the network.
The IP Address 1 eld, showing the IP address that has been assigned by DHCP. Before
AIM can add the device into its database, a new IP address must be added to IP Address
1. This is the system IP address and applies equally for ALIF (1000 series) and ALIF dual
(2000 series).
ALIF dual units have a Teaming port which provides a second 1Gigabyte link port which
can be used for bandwidth doubling and/or redundancy. The IP address 2 eld is for the
Teaming port. In order to use the Teaming port, IP address 2 eld must be given a valid IP
address. For ALIF (1000) units, this eld will remain blank.
INSTALLATIONCONFIGURATIONOPERATION
48
FURTHER
INFORMATION
INDEX
Page 50
THE C-USB LAN TAB
The C-USB LAN tab lists all Adder C-USB LAN extenders that have been declared
within the AIM network. Within this page you can manage the connections between
C-USB LAN receivers and transmitters. Only one receiver can connect to a single
transmitter at a time.
Click the C-USB LAN tab to view the page.
Search lters
The Name eld provides a search lter to locate particular
items within long lists. Enter a full or partial search string into
the appropriate lter box (Note: New C-USB LAN units are listed
in the Name eld using their MAC addresses by default - you are
recommended to change these to descriptive entries as early as possible)
and then click to start the search. Optionally use the buttons to invert the
order of the listing.
Where many devices are listed, you can also choose to lter by transmitters or receivers.
At the top of the Type column, click either: to display only C-USB LAN transmitters
or click to display only C-USB LAN receivers.
To remove all applied lters, click the button.
C-USB LAN
The table shows the following information for each transmitter:
• Type (transmitter or receiver)
• Name (each C-USB LAN device’s MAC address is shown, but can be edited)
• IP address
• Linked ALIF Receiver
• Manage (admin options - see below)
The Manage icons are as follows:
(Note: You can hover your mouse pointer over any icons to reveal additional information):
Reset device: Performs a ‘cold’ reset of the selected unit.
Delete device: Conrmation will be requested.
Permitted users: Allows you to view and alter the users and groups who are
permitted to access each C-USB device (see right).
Connect...: Click to show a list of available C-USB LAN devices. The admin user
can thus link transmitters and receivers.
Disconnect: Click to end a link between a C-USB LAN transmitter and receiver.
To edit the name for a C-USB LAN unit - Click against the required unit in the
Name column and edit/enter the name.
To link an ALIF receiver with a C-USB LAN unit
1 For the required C-USB LAN unit, in the Linked ALIF Receiver column, click the
icon to reveal a drop down box control (
).
2 Click the drop down box control to
show the list of available ALIF receivers:
3 Click the required receiver in the list.
To link with a C-USB LAN transmitter
1 For the required C-USB LAN unit, in the Manage column, click the icon to show a
page listing all available C-USB LAN transmitters.
2 Click the CONNECT button of the required C-USB LAN transmitter.
To congure access permissions
1 For the required C-USB LAN unit, in the Manage column, click the icon to show
a page listing all users and groups.
2 Make the required changes (as discussed below) and click the Save button.
Permissions
This section allows you to determine which users and user groups should be given
access to channels within this group. Individual users and user groups are handled within
separate sub-sections, but both use the same method for inclusion and exclusion.
To include one or more users (or groups): Highlight one or more (use the CTRL
key if selecting more than one) user/group names in the left list and then click to add
them to the right list.
To include all users (or groups): Click to move all user/group names from the left
to the right list.
To remove one or more users (or groups): Highlight one or more (use the CTRL
key if selecting more than one) user/group names in the right list and then click to
move them back to the left list.
To remove all users (or groups): Click to move all user/group names from the
right to the left list.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
49
Page 51
THE SERVERS TAB
The Servers tab shows a table of all servers within the AIM network.
Click the SERVERS tab to view the page.
For installations that require greater redundancy, it is possible to have two or more AIM
servers running on the same subnet. If used on multiple subnets it is possible to have two
or more servers on each subnet. If the primary server fails then alternative servers with
the same database can take over until the primary unit recovers.
Each server entry will have one of ve possible states within the Rôle column:
• Uncongured The server is a factory fresh device or has performed a full factory
reset. This does not yet have a proper role.
• Solo This is a server acting as a standalone AIM server. If there is only going to be
one AIM server on the subnet, this is the Rôle that should be used.
• Primary The server is congured as a fully functional AIM from which a back-up
server can be slaved.
• Backup If more than one server is on the same subnet this is a primary backup
conguration. If there are three servers on the same subnet you will have one primary
and two backups.
• Satellite This is the role of a server on a different subnet to the primary. If you have
multiple servers on the different subnet these would all be called satellite servers.
If you had a conguration with two servers on Vlan 1, two servers on Vlan 2 and
1 server on Vlan 3. AIM would report 1 primary on Vlan 1, 1 Backup on Vlan 1, 2
satellites on Vlan 2 and 1 satellite on Vlan3.
Each server entry will also show one of six entries within the Status column:
• Active This server is functioning as an AIM server and is administering ALIF devices.
Primary or Solo servers with this status are fully functional AIM servers that will
accept network conguration changes. A Backup server with this status is functioning
as an Active Primary. It will execute channel changes, but will not accept network
conguration changes.
• Standby This server is currently maintaining its database as a copy of the primary in
readiness to take over if necessary.
• Ofine This server should be maintaining a copy of the primary’s database, but is
not doing so. The ofine status of a satellite server means that it is ready to take over
ALIFs on its own subnet if necessary, but that it cannot communicate with the primary
server.
• Initialising This is the initial status upon start up. This should not persist beyond the
initial start up procedure.
• Quiescent This is an inactive server on the network. It will not function without
remedial action from its system administration. A typical reason for this is the presence
of another server on the network blocking its congured role. i.e. two servers are
congured as a primary on the same subnet.
• Failed This server has suffered a serious internal failure.
Servers > Congure Server
When you click for a particular server, this page lists information about the unit and
allows several basic settings to be congured.
Server ID - Identity number of the server.
Rôle
Allows you to change the server’s function between primary and solo (see descriptions
left).
Status
See above.
Name, Description and Location
These are useful identiers for the server unit and its exact location. These become even
more valuable as the number of servers within the system increases.
Ethernet Port 2
Where a second Ethernet port is available and the primary server has its second
interface congured, this option allows you to determine how the addressing for the
second port on this server should be derived. For further details, see the Ethernet port 2
explanation in the Dashboard > Settings > Network section.
For details about setting up server redundancy, please see
Appendix C - Redundant servers: Setting up and swapping out.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
50
Page 52
THE USERS TAB
The Users tab shows a paginated table of all users within the AIM network. Within the
list, the admin user is always present and cannot be deleted - in order to avoid being
locked out of the AIM system.
Click the USERS tab to view the initial View Users page.
The other user pages (e.g. Add User, View User Groups, etc.) are selectable within the
blue section located just below the tabs.
Search lters
The key elds (Username, First Name and Last Name) all provide
a search lter to locate particular items within long lists. Enter a
full or partial search string into the appropriate lter box and then
click to start the search. Optionally use the buttons to
invert the order of the listing.
The page will reload with the same pagination/sort order, but with the added search
lter. It’s possible to lter by several columns at once (e.g. search for all entries with “B”
in the Username, and “Smith” in the Last Name). Search terms are case-insensitive. You
can re-sort and paginate on ltered results without losing the lters.
To remove a lter, click the red cross next to the relevant lter, (you can also empty the
search box and click again).
Users > View Users page
The table shows the following information for each user:
• AD - indicates whether the user was imported from Active Directory
• Username • First Name • Last Name
• User Groups - the number of user groups to which the user belongs
• Channels - the number of channels to which the user has access
• Receivers - the number of receivers to which the user has access
• Allow Private? - indicates whether the user is permitted to access channels in private
mode ( - Yes, - No, - Inherited setting from user groups)
• Remote OSD? - indicates whether the user is permitted to gain OSD access to
remote receivers in order to change channels ( - Yes, - No, - Inherited setting
from user groups)
• Suspended - indicates the user account status ( - User is suspended,
- User account is active, i.e. not suspended)
• AIM Admin - indicates whether the user has admin privileges
The Manage icons are as follows:
Congure user: Displays the “Congure User” page.
Clone user: Create a complete copy of the currently selected user entry.
Delete user: Conrmation will be requested.
INSTALLATIONCONFIGURATIONOPERATION
51
FURTHER
INFORMATION
INDEX
Page 53
Users > Add User or Congure User page
From the View Users page, you can add a new user or congure an existing user:
• To add a user: Click the “Add User” option.
• To congure an existing user: Click for a user.
The Add and Congure pages are similar in content.
Username
The username is mandatory and must be unique within the AIM installation.
Note: If a user is synced with Active Directory, it is not possible to change the Username, First/
Last Name, Password, or User Group membership. These items must be edited on the Active
Directory server and the changes will lter through to AIM the next time a sync takes place with
Active Directory.
First Name, Last Name and Email
The First Name, Last Names and Email address entries are optional but are advisable
within an installation of any size or one that will be administered by more than one
person.
Require Password
Determines whether the chosen user must enter a password to gain access to channels
and/or AIM admin system.
Password
The password is required for logging into a channel and/or for logging into the AIM
admin system, if the user is to be granted admin privileges.
AIM Administrator?
When set to Yes, the user is granted privileges to login to the AIM admin system and
make changes.
Account Suspended?
Allows the admin user to temporarily prevent the user from logging in without the need
to delete the whole account.
Allow Private Mode?
Denes whether the user is able to connect to channels privately (locking out other
users during a session). When this is set to “Inherit from User Groups/Global Setting”, if
ANY user-group that a user is a member of is granted permission to connect privately,
then the user will have permission to connect privately. Note: It is an additional requirement
that the channel being accessed by the user, must also permit private access.
Enable Remote OSD?
This option determines whether the chosen user should be permitted to use the remote
OSD functionality which permits access to remote receivers in order to change channels
or presets even though a user has not logged into those receivers. Please see Using the
Remote OSD feature for details.
Group Membership
This section denes the user groups to which the user will be a member. Any
permissions applied to the user group are inherited by all users in the user group.
User groups to which the user is not currently a member are shown in the left list
and those to which the user is a member are shown within the right list. See Including
and excluding a user... on the next page for details about including and excluding group
membership.
Permissions
This section denes to which channels and/or channel groups the user should have
access. Note: Only the channels for which a user is given permission to access will appear within
their channel list.
See Including and excluding a user... on the next page for details about including and
excluding channels and/or channel groups.
Receiver and Receiver Group Permissions
Receiver and Receiver Group Permissions are hidden by default because all users are
initially granted permission to use all receivers. If desired, permission to use a receiver
and/or receiver group may be withdrawn from a user by revealing this section.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
52
INDEX
Page 54
Users > Add User Group or Congure Group page
From the View User Groups page, you can create a new group or congure an existing
group:
• To create a new group: Click the “Add User Group” option.
• To congure an existing group: Click for a group.
The Add and Congure pages are similar in content.
User Group Name
The User Group name must be unique within the AIM installation.
Allow Private Mode?
Denes whether the users within the group will be able to connect to channels privately
(locking out other users during the session). When this is set to “Inherit from global
setting”, the setting for the “Grant all users private access” option (within Dashboard >
Settings) will be applied. Note: The nal arbiter of whether any user can gain private access is
always whether the channel being accessed is also set to allow private connections.
Enable Remote OSD?
Determines whether members of the chosen user group should be permitted to gain
OSD access to remote receivers in order to change channels.
Group Membership
This section allows you to select which users should be members of the group. Any
permissions applied to the user group are inherited by all users in the user group. Users
who are not currently members are shown in the left list and those who are members
are shown within the right list. See Including and excluding a user... on the right for
details about including and excluding group membership.
Permissions
This section denes to which channels and/or channel groups the user within this
group should have access. Note: Only the channels/channel groups for which a user is given
permission to access will appear within their channel list.
See Including and excluding a user... right for details about including and excluding
channels and/or channel groups.
Receiver and Receiver Group Permissions
Receiver and Receiver Group Permissions are hidden by default because all users/user
groups are initially granted permission to use all receivers. If desired, permission to use a
receiver and/or receiver group may be withdrawn from members of this user group by
revealing this section.
Including and excluding a user within group or channels
The Group Membership and Permissions section use the same method to
determine inclusion and exclusion:
To add the user to a group or grant access to a channel: Highlight one or
more (use the CTRL key if selecting more than one) of the entries in the left list
and then click to add them to the right list (you can also double-click on an
entry to quickly add it).
To add the user to all groups or grant access to all channels: Click to
move all entries from the left to the right list.
To remove the user from a group or channel: Highlight one or more (use the
CTRL key if selecting more than one) entries in the right list and then click to
move them back to the left list (you can also double-click on an entry to quickly
remove it).
To remove the user from all groups or channels: Click to move all entries
from the right to the left list.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
53
INDEX
Page 55
Users > Active Directory
To simplify integration alongside existing systems within organisations, AIM can be
synchronized with an LDAP/Active Directory server. This allows a list of users (and user
groups), together with usernames and group memberships to be quickly imported and
kept up to date.
Initial conguration
The basic Active Directory (AD) server details are dened in the Dashboard > Settings
page. Once congured, the Users > Active Directory page (called “Import Users from
Active Directory”) will allow you to scan the AD server for a list of folders and users/
groups within those folders.
Choosing users and groups
Once scanned, the “Import Users from Active Directory” page shows all folders that are
available on the AD server.
1 Use the “Include Users” and “Include Groups” checkbox columns on the right hand
side of the folder lists to select which items to import (with optional additional LDAP
lters where necessary).
• If an AD user was not in the AIM user database, they will be imported.
• If an AD user is already in the AIM user database, they are kept.
• If an AD user is NOT marked for import/sync from the AD import page, and they
already exist in the AIM user database, they will be removed from the AIM user
database during the sync operation.
IMPORTANT: It is thus vital to ensure that all users you want in the AIM system are
always selected for import/sync, otherwise they will be removed.
2 Choose the required “Re-Synchronize” interval. Choices are Never, Hourly, Daily or
Weekly.
3 You can choose to synchronize immediately or to preview the results of your settings:
• Click the “Preview” button to view the list of users that will be added/updated/
removed on this synchronization. Once previewed, you can either go ahead with the
sync or return to the lter page and edit your settings.
• Click the “Save & Sync” button to synchronize the selected items into the AIM user
database.
Active Directory Tips
• A backup schedule is recommended so that any changes on the AD server are carried
across to the AIM server regularly. You can choose from hourly/daily or weekly syncs.
The settings/lters saved on this screen will be applied to each subsequent sync,
ensuring that your list of users is kept accurate.
• To temporarily remove a particular user from AIM access, without having to make
complicated LDAP lters, simply edit the AIM user to be suspended (see Users > Add
User or Congure User page). Even though they will continue to be imported/synced
from AD, they will be prevented from logging on.
• All LDAP lters should be self-contained, e.g: (!(cn=a*))
• Be sure to save any changes made to the sync settings before clicking the “sync-now”
option. Otherwise, the next scheduled sync operation will overwrite any user changes
you made in your “sync-now”.
• User groups are only imported from AD to AIM if they contain users that are set to
be imported too (i.e. a group will not be imported, even if it contains users, unless its
users match the sync lters).
Note: If a group contains more than 1499 users, then the group is returned as empty.
• Associations between users and user groups can only be made on the AD server - it
is not possible to edit user/user-group membership for AD users/groups on the AIM
server.
• Users and groups are technically “synchronized” rather than “imported” - each time
a sync takes place, details are updated and if a user no longer matches the sync lters,
they will be removed from the AIM user list.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
54
INDEX
Page 56
THE PRESETS TAB
Presets enable multiple actions to be pre-dened so that they can be initiated with a
single action. This feature is particularly useful when switching multiple ADDERLink
INFINITY units, such as in the example below where multiple video heads need to be
switched in unison between different server systems.
The preset allows
multiple ADDERLink
INFINITY receivers to
be switched between
transmitters using a
single action.
The Presets page is where the admin user can create and congure new and existing
presets.
Click the PRESETS tab to view the Presets page.
The nature of each preset, i.e. which receiver connects to which channel(s), is dened by
the admin. The permitted connection modes are worked out according to:
• The topology of the preset,
AND
• The current connections within the AIM network.
It will not be possible to connect in Private mode
The presets table shows the preset name, description, allowed connection modes, and
number of receiver-channel pairs in the preset.
If any preset-pairs are miscongured (e.g. a channel no longer exists), a warning triangle
will appear. The preset will NOT be usable if any receiver-channel pairs are miscongured.
The admin user can connect any presets using the standard Video-Only/Shared/Exclusive/
Private buttons.
Note: There are no permissions to set for a preset. Instead, a preset will only be available to
users who have permission to use ALL receivers and channels within the preset. In other words,
permissions on the preset are implied by the permissions on the preset’s contents.
INSTALLATIONCONFIGURATIONOPERATION
According to how a preset is congured, it is possible to have one or more receivers
connected to separate channels (i.e. unicast) or multiple receivers connected to a single
channel (i.e. multicast).
continued
FURTHER
INFORMATION
INDEX
55
Page 57
Presets > Add or Congure Presets page
From the Presets page, you can add a new preset or congure an existing preset:
• To create a new preset: Click the “Add Preset” option.
• To congure an existing preset: Click for a preset.
The Add and Congure pages are similar in content.
Preset Name and Description
The Preset Name is mandatory, whereas the Description is optional but recommended
when numerous presets will be used. A consistent naming and description policy is
particularly useful in large installations.
Receiver - Channel Pairs
Pair 1
From the two drop down lists, choose a receiver and a corresponding channel for it to
connect with. This base pair can be altered but cannot be deleted from the preset.
Add another pair
Click this link to dene another receiver/channel pairing.
Note: While channels can be assigned to multiple receivers, each receiver may only appear once
within a single preset.
Allowed Connection Modes
Choose one of the following connection rules to be applied to the preset:
• Inherit from global - uses the setting of the “Allowed Connection Modes” option within
the Dashboard > Settings page.
• Set for this channel - permits you to choose modes manually:
• Video-Only: Allows users only to view the video output, the USB channel is
denied.
• Shared: Allows users to control a system in conjunction with other users.
• Exclusive: Grants exclusive control to one user while all others can
simultaneously view and hear, but not control, the output.
• Private: Allows a user to gain private access to a system, while locking out all
others.
Note: If multicasting is present (e.g. two or more receivers connected to the same channel
or two channels containing the same audio/video end point), it will not be possible to
choose the ‘Private’ connection mode.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
56
INDEX
Page 58
THE STATISTICS TAB
The Statistics tab provides an opportunity to view a range of real-time data
measurements related to any links within the AIM network. This is particularly useful for
optimization and troubleshooting purposes.
Click the STATISTICS tab to view the page.
Search lters
The key elds (Name, Description and Location) all provide a search lter to locate
particular items within long lists. Enter a full or partial search string into the appropriate
lter box and then click to start the search. Optionally use the
buttons to invert the order of the listing.
The page will reload with the same pagination/sort order, but with
the added search lter. It’s possible to lter by several columns at
once (e.g. search for all entries with “B” in the Name and “Server”
in the Location). Search terms are case-insensitive. You can re-sort and paginate on
ltered results without losing the lters.
To remove a lter, click the red cross next to the relevant lter, (you can also empty the
search box and click again).
Where many devices are listed, you can also choose to lter by transmitters or receivers.
At the top of the Type column, click either: to display only transmitters or click to
display only receivers.
To remove all applied lters, click the button.
To view statistics
1 To the right of the unit for which you wish to view statistics, click the dark graph icon
( ) so that it gains a white background ( ) .
2 Click on the device name to display the available statistics.
A dynamic graph will be displayed showing the chosen data series for the selected
ALIF units.
Note: When statistics are enabled on a receiver, you can also monitor packet loss information, if
email or SNMP is enabled.
Identify unit: Causes the LED lights to ash on the front of the selected unit. An
alert will be shown if the unit cannot be contacted (e.g. if it is ofine).
INSTALLATIONCONFIGURATIONOPERATION
57
FURTHER
INFORMATION
INDEX
Page 59
Operation
For non-admin users, the On-Screen Display provides a clear way to choose and access
multiple channels.
LOGGING IN
1 On the keyboard connected to your ADDERLink INFINITY receiver, press the hotkey
combination Ctrl-Alt-C to display the On-Screen Display or OSD (this hotkey
combination can be altered on the Dashboard > Settings > Receivers page).
You will either see the list of channels for which you have permission or be presented
with the following login:
Hotkey shortcuts
The following standard shortcuts are available for use with the Local OSD (and Remote OSD).
These default shortcuts can be altered within the Dashboard > Settings > Receivers page.
Left Ctrl + Left Alt + C: Launch the OSD
Left Ctrl + Left Alt + X: Disconnect the current receiver
Left Ctrl + Left Alt + 3: Connect to the channel/preset saved in shortcut slot 3
Left Ctrl + Left Alt + A: Re-connect to the last channel
Left Ctrl + Left Alt + L: Switch between a locally linked TX and your regular channel
Left Ctrl + Left Alt + V: Change the current connection to the video-only mode
Left Ctrl + Left Alt + S: Change the current connection to the shared mode
Left Ctrl + Left Alt + E: Change the current connection to the exclusive mode
Left Ctrl + Left Alt + P: Change the current connection to the private mode
Creating/using favorites and shortcuts
When the OSD contains many possible channels and presets, it can be useful to mark
the most commonly visited ones as favorites. For those channels that you’d like to access
by keyboard shortcut, there are also ten assignable hotkeys.
To create a new favorite
1 Click the icon next to the required channel or preset.
2 Click the button at the top of the page.
INSTALLATIONCONFIGURATIONOPERATION
2 Enter your Username and Password and click the Login button to display the Local
OSD screen.
Once logged in, you will remain logged in until either you click the Logout link in the
top right of the OSD; or there is no activity for two days or until the ADDERLink
INFINITY unit is rebooted.
To display favorites
The star shown at the top of the channel list has three appearances to represent the
three display modes. Click the star to change the mode:
Currently showing all channels/presets.
Currently showing only favorites.
Currently showing only numbered shortcuts.
To create a new hotkey shortcut
1 Click the icon prexed to a channel or preset entry that requires auto login. The
screen will list the ten hotkey slots numbered 0 to 9. Any available slots will be listed as
EMPTY. Click the number prex (from 0 to 9) of an available slot. Optionally click one
of the page numbers listed along the foot of the page, to choose any prex from 10 to
99 (and then choose an available slot).
Note: To remove a previous channel from a slot, click the icon on the right side of the slot.
2 You will now be asked to choose which mode should be used to access the channel
when using this shortcut. Select Video-Only, Shared, Exclusive or Private, as appropriate.
3 Click the button at the top of the page. As mentioned above, you will
now be able to access the chosen channel by using the hotkeys (Left Ctrl + Left Alt, as
standard) plus the number that you assigned to it.
FURTHER
INFORMATION
INDEX
58
Page 60
THE LOCAL OSD SCREEN
Once logged in, the list of channels for which you
have permission are shown in the Local OSD (blue)
screen.
• To choose a channel/preset, click on one of the
blue connection icons (
) shown
to the right of the required channel/preset name
(see the Connection buttons box below right).
• Where many channels/presets are listed, use the
Channel Name and Description search boxes
and list arrows to lter the choices.
• To use the Remote OSD feature, click the
icon in the top right corner.
Favorites icons
Currently showing all channels/presets
Currently showing only favorites
Currently showing only numbered shortcuts
Click to add this channel as a favorite
Click to Logout
Top corner icons
Enter ‘Remote OSD’ mode
Exit ‘Remote OSD’ mode
Display the help pages
Refresh the current page
Close the OSD
INSTALLATIONCONFIGURATIONOPERATION
This channel is a numbered shortcut
Sorting icons
Currently showing channels and presets. Click to change
Currently showing only channels. Click to change
Currently showing only presets. Click to change
Currently showing only C-USB LAN. Click to change
Filter this column using the specied term
Remove the search lter
Click to sort the list in ascending order via this column
The list is sorted in ascending order via this column
Connection buttons
There are ve connection options:
Video-Only: Allows users only to view the video output, the USB channel is denied.
Shared: Allows users to control a system in conjunction with other users.
Exclusive: Grants exclusive control to one user while all others can simultaneously view
and hear, but not control, the output.
Private: Allows a user to gain private access to a system, while locking out all others.
VM credentials: Displays a login screen to allow users to enter their username and password
Connection buttons shown in blue are ready to select. Icons in green have been selected by another
user and those shown in gray are not available.
End this connection
for access to the corresponding virtual machine. See next page.
FURTHER
INFORMATION
INDEX
59
Page 61
Listing C-USB LAN transmitters
In addition to listing channels and presets, the OSD screen can also list the C-USB LAN
transmitters that are associated with the current receiver.
To list all associated C-USB LAN transmitters
1 Login to the OSD from the appropriate ALIF receiver and display the OSD:
CTRL + ALT + C
2 In the top left corner of the OSD screen, click the monitor icon ( , or )
repeatedly until it changes to the USB logo: .
The list of devices will be displayed:
C-USB LAN transmitters can only be accessed in Private mode, so the icon is
shown in various colors to indicate the connection status:
Available.
Not available.
Transmitter connected to another receiver.
Connected to the transmitter.
Click the icon to break an existing connection.
Accessing virtual machines
Before you can access a virtual machine you need to rst enter your login credentials.
To enter your credentials
1 Login to the OSD from the appropriate ALIF receiver and display the OSD:
CTRL + ALT + C
2 In the list of channels, to the right of the required virtual machine entry, click the
icon to display the following login page:
3 Enter your Username and Password and click the SAVE button. You will be returned
to the main OSD page. The icon will now be green to show that your details are
stored.
To access a virtual machine
1 Login to the OSD from the appropriate ALIF receiver and display the OSD:
CTRL + ALT + C
2 In the list of channels, to the right of the required virtual machine entry, click the
icon to display the video feed from the chosen system. Virtual machine links can only
accessed as private connections.
To clear your credentials
1 Login to the OSD from the appropriate ALIF receiver and display the OSD:
CTRL + ALT + C
2 In the list of channels, to the right of the required virtual machine entry, click the
icon to display the login credentials page.
3 Click the CLEAR CREDENTIALS button.
You will be returned to the main OSD page. The icon will now be blue to show
that no details are stored.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
60
Page 62
Using the Remote OSD feature
The Remote OSD feature allows authorized users to access and take control of ALIF
receivers other than the one to which they are connected. Once linked in, users can then
determine which channels the remote receivers should link with.
Remote OSD requires that a user must have been given specic authorization to access
one or more remote receivers.
To access the Remote OSD
1 On the keyboard connected to your ALIF receiver, press the hotkey combination Ctrl-
Alt-C to display the Local OSD login screen.
2 If required, enter your Username and Password and click the Login button.
3 In the top right corner, click the icon.
4 The screen will list all of the receivers to which you have access rights. Click on the
required receiver from the list:
5 The Remote OSD for the chosen ALIF receiver will be displayed. Remote OSDs always
have a yellow background to differentiate them from the standard local OSD:
INSTALLATIONCONFIGURATIONOPERATION
6 The behavior of the controls is generally the same as for the Local OSD screen with
the following exceptions:
• To avoid confusion, you cannot login or logout while in Remote OSD mode. Click
the icon to rst return to the Local OSD.
• Hotkeys will only affect the current receiver to which you are connected, not the
remotely-controlled receiver.
7 To exit from the Remote OSD, click the icon in the top right corner.
FURTHER
INFORMATION
INDEX
61
Page 63
Further information
This chapter contains a variety of information, including the following:
• Getting assistance - see right
• Appendix A - Tips for success when networking ALIF and AIM units
• Appendix B - Troubleshooting
• Appendix C - Redundant servers: Setting up and swapping out
• Appendix D - Upgrade license
• Appendix E - Glossary
• Appendix F - Copper/ber modules and cables
• Appendix G - AIM API
• Appendix H - DHCP server requirements for ALIF support
• Appendix I - AIM database schema
• Appendix J - Technical specications
• Appendix K - Open source licenses
GETTING ASSISTANCE
If you are still experiencing problems after checking the information contained within this
guide, then please refer to the Support section of our website:
www.adder.com
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
62
INFORMATION
INDEX
Page 64
APPENDIX A - Tips for success when networking ALIF units
ALIF units use multiple strategies to minimize the amount of data that they send
across networks. However, data overheads can be quite high, particularly when very
high resolution video is being transferred, so it is important to take steps to maximize
network efciency and help minimize data output. The tips given in this section have been
proven to produce very benecial results.
Summary of steps
• Choose the right kind of switch.
• Create an efcient network layout.
• Congure the switches and devices correctly.
Choosing the right switch
Layer 2 switches are what bind all of the hosts together in the subnet. However, they are
all not created equally, so choose carefully. In particular look for the following:
• Gigabit (1000Mbps) or faster Ethernet ports,
• Support for IGMP v2 (or v3) snooping,
• Support for Jumbo frames up to 9216-byte size,
• High bandwidth connections between switches, preferably Fibre Channel.
• Look for switches that perform their most onerous tasks (e.g. IGMP snooping) using
multiple dedicated processors (ASICS).
• Ensure the maximum number of concurrent ‘snoopable groups’ the switch can
handle meets or exceeds the number of ALIF transmitters that will be used to create
multicast groups.
• Check the throughput of the switch: Full duplex, 1Gbps up- and down- stream speeds
per port.
• Use the same switch make and model throughout a single subnet.
• You also need a Layer 3 switch. Ensure that it can operate efciently as an IGMP
Querier.
Creating an efcient network layout
Network layout is vital. The use of IGMP snooping also introduces certain constraints, so
take heed:
• Keep it at. Use a basic line-cascade structure rather than a pyramid or tree
arrangement (see note below).
• Keep the distances between the switches as short as possible.
• Ensure sufcient bandwidth between switches to eliminate bottlenecks.
• Where the AIM server is used to administer multiple ALIF transceivers, ensure the
AIM server and all ALIF units reside in the same subnet.
• Do not use VGA to DVI converters, instead replace VGA video cards in older systems
with suitable DVI replacements. Converters cause ALIF TX units to massively increase
data output.
• Stackable switches will allow you to create more ports at each cascade level.
• Wherever possible, create a private network.
The recommended layout
The layout shown below has been found to provide the most efcient network layout for
rapid throughput when using IGMP snooping:
INSTALLATIONCONFIGURATIONOPERATION
Layer 2 (and 3) switches known to work
• Cisco 2960
• Cisco 3750
• Cisco 4500
• Cisco 6500
• Extreme Networks X480
• HP Procurve 2810
• HP Procurve 2910
• H3C 5120
For the latest list of switches known to work with ALIF and
setup instructions for them, please go to www.adder.com
• HuaWei Quidway
s5328c-EI
(Layer 3 switch)
Note: From rmware version 3.0, tree and hierarchical structures of network switches are
also supported. The Transmitter now joins its own multicast group so there is always a route
from the querier to the transmitter which was previously missing in rmware versions 2.9 and
below.
• Use no more than two cascade levels.
• Ensure high bandwidth between the two L2 switches and very high bandwidth
between the top L2 and the L3. Typically 10GB and 20GB, respectively for 48 port L2
switches.
continued
FURTHER
INFORMATION
INDEX
63
Page 65
Conguring the switches and devices
The layout is vital but so too is the conguration:
• Enable IGMP Snooping on all L2 switches.
• Ensure that IGMP Fast-Leave is enabled on all switches with ALIF units connected
directly to them.
• Enable the L3 switch as an IGMP Querier.
• Enable Spanning Tree Protocol (STP) on all switches and importantly also enable
portfast (edge-port) only on all switch ports that have ALIF units connected.
• If any hosts will use any video resolutions using 2048 horizontal pixels (e.g. 2048 x
1152), ensure that Jumbo Frames are enabled on all switches.
• Choose an appropriate forwarding mode on all switches. Use Cut-through if available,
otherwise Store and forward.
• Optimize the settings on the ALIF transmitters:
• If moving video images are being shown frequently, then leave Frame Skipping at a
low percentage and instead reduce the Peak bandwidth limiter and Colour Depth.
• Where screens are quite static, try increasing the Background Refresh interval and/
or increasing the Frame skipping percentage setting.
Make changes to the ALIF transmitters one at a time, in small steps, and view typical
video images so that you can attribute positive or negative results to the appropriate
control.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
64
INFORMATION
INDEX
Page 66
APPENDIX B - Troubleshooting
Problem: AIM cannot locate working ALIF units.
There are a few possible causes:
• The ALIF units must be reset back to their zero cong IP addresses for AIM discovery.
If you have a working network of ALIF’s without AIM and then add AIM to the network
AIM will not discover the ALIFs until they are reset to the zero cong IP addresses.
• This could be caused by Layer 2 Cisco switches that have Spanning Tree Protocol
(STP) enabled but do not also have portfast enabled on the ports to which ALIF units
are connected. Without portfast enabled, ALIF units will all be assigned the same zero
cong IP address at reboot and AIM will only acquire them one at a time on a random
basis.
You can easily tell whether portfast is enabled on a switch that is running STP: When
you plug the link cable from a working ALIF unit into the switch port, check how long
it takes for the port indicator to change from orange to green. If it takes roughly one
second, portfast is on; if it takes roughly thirty seconds then portfast is disabled.
Remedies:
• Ensure that the ALIF units and the AIM server are located within the same subnet. AIM
cannot cross subnet boundaries.
• Manually reset the ALIF units to their zero cong IP addresses. Please refer to the ALIF
user guide for details.
• Enable portfast on all switch ports that have ALIF units attached to them or try
temporarily disabling STP on the switches while AIM is attempting to locate ALIF units.
• Change to ensure AIM and ALIFs can communicate with each other. If on different
subnets, conrm that the gateway is correctly congured and there is routing between
the subnets.
• Manually factory reset the ALIF endpoints so they can be seen by an AIM.
Problem: The mouse pointer of the ALIF receiver is slow or sluggish when
moved across the screen.
This issue is often related to either using dithering on the video output of one or more
transmitting computers or using VGA-to-DVI video converters.
Dithering is used to improve the perceived quality and color depth of images by diffusing
or altering the color of pixels between video frames. This practice is commonly used
on Apple Mac computers using ATI or Nvidia graphics cards. VGA-to-DVI converters
unwittingly produce a similar issue by creating high levels of pixel background noise.
ALIF units attempt to considerably reduce network trafc by transmitting only the pixels
that change between successive video frames. When dithering is enabled and/or VGA-toDVI converters are used, this can have the effect of changing almost every pixel between
each frame, thus forcing the ALIF transmitter to send the whole of every frame: resulting
in greatly increased network trafc and what’s perceived as sluggish performance.
Remedies:
• Linux PCs - Check the video settings on the PC. If the Dither video box option is
enabled, disable it.
• Apple Mac with ATI graphics - Use the ALIF 2000 series unit with Magic Eye dither
removal feature.
• Windows PCs - If you suspect these issues with PCs, contact technical support for
assistance.
Problem: The front panel OLED screen is blank.
AIM server 3 hardware running software version 4.13 will result in no details being
shown on the OLED screen. Upgrade the software to gain the expected screen behavior.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
65
INFORMATION
INDEX
Page 67
APPENDIX C - Redundant servers: Setting up and swapping out
This appendix contains two main sections related to the creation and repair of AIM
server installations that employ redundancy.
• Setting up AIM server redundancy - below
• Swapping out an AIM server - on next page
Setting up AIM server redundancy
This section details the steps required to successfully congure two AIM units as primary
and backup servers.
1 Set the Rôle entry to Primary on the primary server.
2 Congure its Ethernet port 1 Address.
3 Ensure that password requirements is set to NO.
4 Add the new Backup AIM server to the network. The Backup server must have the
same license as the primary. It is not possible to have two servers with different
licenses in a cluster. This unit must have its factory default settings in place. The new
server will appear within the main Servers tab and be identied as being Uncongured.
5 Wait ve minutes for automatic server replication to take place and the backup
database to be transferred from the primary unit. After this period, the new Backup
server will be added to the list on the main Servers tab. Its Rôle will be shown as
backup and its Status as standby.
6 The initial conguration of the Backup is done from the Primary. Click the icon to
view the conguration.
Operation of Redundancy
If the Primary server fails for any reason (for example, loss of power or a network
issue) then the Backup server will failover. This will happen automatically without any
user intervention, however it is not instantaneous. The failover time required is the
value entered in the primary timeout plus 30 seconds for the process to happen. The
ADDERLink INFINITY extenders will start communication with the second IP address
that is stored in their conguration and the redundant server will take control of the
ADDERLink Innities. When the redundant server is acting as the primary it is not
possible to add any new devices or change the conguration. If this is required then the
backup server can be promoted to be the primary.
When the primary server comes back online then it will resume its role as the primary.
If however the backup server has been promoted to primary, when the primary server
comes back its role will need to be factory reset back to the backup. After doing this the
ADDERLink INFINITY endpoints will need to be rebooted. It is not possible to have
two primary servers on the same network.
Both the primary and the backup server periodically synchronize their databases to
ensure that they are identical. If for any reason the backup server is powered down then
any changes to the system conguration will not be maintained by the backup server.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
66
INFORMATION
INDEX
Page 68
Swapping out an AIM server
Once ALIF devices have been congured to run with an AIM server, their default IP
addresses are automatically changed as part of the installation process. In this state the
ALIF devices become undetectable to any new AIM server that does not have access to
the database of devices. Therefore, if an existing AIM server needs to be replaced within
an installation, follow one of the basic procedures given here to smooth the transition.
For solo AIM servers (if the solo is still operating)
1 Before connecting the new AIM server to the main network, connect the new AIM
server to a network switch that is isolated from the main network.
2 Use a computer connected to the same switch to login to the new AIM server
management suite.
3 Set the Rôle entry from Solo to Primary.
4 Add in the new uncongured server as a Backup.
5 Remove the original solo server from the network.
6 Promote the Backup to Primary. Then change its Rôle to Solo.
7 All the devices will appear as ofine. Using a paperclip, perform a factory reset on
all the ALIF endpoints so as they acquire the new certicate and keys. All ALIF units
require a minimum of rmware version 3.3.
Starting from scratch
If none of the above procedures are used, then the following will be necessary. This will
require a certain amount of effort because each ALIF unit must be visited and reset, plus
the AIM database will need to be fully recongured.
1 Place a new AIM server into the network and then perform a factory reset on every
ALIF device. This will force the ALIF units back to their default states whereupon they
will announce themselves to the new AIM server.
2 Use a computer connected to the same network to login to the new AIM server
management suite and begin to recreate the database of devices and users.
For dual AIM installations using redundancy
The correct procedure depends on which AIM server has failed:
Primary server failure
1 Promote the Backup server to be the primary server.
2 Delete the failed server from the database.
3 Replace the faulty primary AIM server with a replacement unit that has the same
license version and has its default factory settings in place.
4 The replacement server will begin communicating with the primary server and
download the database so that it can operate as the Backup server. This process may
take ten minutes.
5 Reboot the Adderlink INFINITY endpoints at the earliest opportunity.
Backup server failure
1 Delete the failed server from the database.
2 Replace the failed backup server with a new unit that has the same license version and
has its default factory settings in place.
3 The replacement server will begin communicating with the primary server and
download the database so that it can operate as the backup server. This process may
take ten minutes.
4 Reboot the Adderlink INFINITY endpoints at the earliest opportunity.
Warning: If step 4, rebooting the Adderlink INFINITY endpoints, does not
happen then the Adderlink INFINITY endpoints will be ofine if a failover
occurs and will need to be factory reset with a paperclip.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
67
Page 69
APPENDIX D - License upgrading
Various features of AIM servers are extensible and are licensed accordingly, such as the
number of devices that can be managed or additional features, such as multi subnet
operation and auto-login. As your installation grows you can purchase an updated AIM
license at any time using the procedure outlined below. A range of licenses are available
for primary only and primary/failover bundles:
• AIMLIC-48 License for 48 endpoints
• AIMLIC-48-BCK Licenses for Primary and Failover units 48 endpoints
The subsequent le dialog will show a identier code that is unique to your AIM
server:
• AIMLIC-96 License for 96 endpoints
• AIMLIC-96-BCK Licenses for Primary and Failover units 96 endpoints
• AIMLIC-192 License for 192 endpoints
• AIMLIC-192-BCK Licenses for Primary and Failover units 192 endpoints
• AIMLIC-288 License for 288 endpoints
• AIMLIC-288-BCK Licenses for Primary and Failover units 288 endpoints
• AIMLIC-UNL License for unlimited endpoints
• AIMLIC-UNL-BCK Licenses for Primary and Failover units unlimited endpoints
To upgrade your AIM license
1 Visit the Dashboard > Settings > General page of the AIM unit to be upgraded. At the
foot of the page, next to the Licensed Features heading, click the ‘view/change’ link:
2 Contact your supplier and quote all of the following:
• The unique product code,
• The serial number of the AIM server (marked on a label on the base of the unit),
• The current number of supported devices, and
• The number of devices to which you wish to upgrade.
The supplier will provide a license le (*.asc), which is unique to your AIM server.
Note: It is important that you only enter the license key into the specic AIM server.
3 Click the Choose le link to display a le dialog. Direct the le dialog to the location of
the license le and click Open. Now the license le is selected, click the Upload button
to install it.
If the upgrade is successful, the new status of the chosen feature will be shown on the
Dashboard > Settings > General page:
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
68
INDEX
Page 70
APPENDIX E - Glossary
Internet Group Management Protocol
Where an ALIF transmitter is required to stream video to
two or more receivers, multicasting is the method used.
Multicasting involves the delivery of identical data to
multiple receivers simultaneously without the need to
maintain individual links. When multicast data packets enter
a subnet, the natural reaction of the switches that bind
all the hosts together within the subnet, is to spread the
multicast data to all of their ports. This is referred to as
Multicast ooding and means that the hosts (or at least
their network interfaces) are required to process plenty of
data that they didn’t request. IGMP offers a partial solution.
The Internet Group Management Protocol (IGMP) is
designed to prevent multicast ooding by allowing Layer
3 switches to check whether host computers within
their care are interested in receiving particular multicast
transmissions. They can then direct multicast data only to
those points that require it and can shut off a multicast
stream if the subnet has no recipients.
There are currently three IGMP versions: 1, 2 and 3, with
each version building upon the capabilities of the previous
one:
• IGMPv1 allows host computers to opt into a multicast
transmission using a Join Group message, it is then
incumbent on the router to discover when they no
longer wish to receive; this is achieved by polling them
(see IGMP Querier below) until they no longer respond.
• IGMPv2 includes the means for hosts to opt out as well
as in, using a Leave Group message.
• IGMPv3 encompasses the abilities of versions 1 and 2
but also adds the ability for hosts to specify particular
sources of multicast data.
ADDERLink INFINITY units make use of IGMPv2 when
performing multicasts to ensure that no unnecessary
congestion is caused.
IGMP Snooping
The IGMP messages are effective but only operate at
layer 2 - intended for routers to determine whether
multicast data should enter a subnet. A relatively recent
development has taken place within the switches that
glue together all of the hosts within each subnet: IGMP
Snooping. IGMP snooping means these layer 2 devices now
have the ability to take a peek at the IGMP messages. As a
result, the switches can then determine exactly which of
their own hosts have requested to receive a multicast –
and only pass on multicast data to those hosts.
IGMP Querier
When IGMP is used, each subnet requires one Layer 3
switch to act as a Querier. In this lead role, the switch
periodically sends out IGMP Query messages and in
response all hosts report which multicast streams they
wish to receive. The Querier device and all snooping Layer
2 switches, then update their lists accordingly (the lists are
also updated when Join Group and Leave Group (IGMPv2)
messages are received).
IGMP Fast-Leave (aka Immediate Leave)
When a device/host no longer wishes to receive a
multicast transmission, it can issue an IGMP Leave Group
message as mentioned above. This causes the switch to
issue an IGMP Group-Specic Query message on the port
(that the Leave Group was received on) to check no other
receivers exist on that connection that wish to remain a
part of the multicast. This process has a cost in terms of
switch processor activity and time.
Where ALIF units are connected directly to the switch
(with no other devices on the same port) then enabling
IGMP Fast-Leave mode means that switches can
immediately remove receivers without going through
a full checking procedure. Where multiple units are
regularly joining and leaving multicasts, this can speed up
performance considerably.
Jumbo frames (Jumbo packets)
Since its commercial introduction in 1980, the Ethernet
standard has been successfully extended and adapted to
keep pace with the ever improving capabilities of computer
systems. The achievable data rates, for instance, have risen
in ten-fold leaps from the original 10Mbit/s to a current
maximum of 100Gbit/s.
While data speeds have increased massively, the standard
dening the number of bytes (known as the Payload)
placed into each data packet has remained resolutely stuck
at its original level of 1500 bytes. This standard was set
during the original speed era (10Mbits/s) and offered the
best compromise at that speed between the time taken to
process each packet and the time required to resend faulty
packets due to transmission errors.
But now networks are much faster and les/data streams
are much larger; so time for a change? Unfortunately, a
wholesale change to the packet size is not straightforward
as it is a fundamental standard and changing it would mean
a loss of backward compatibility with older systems.
Larger payload options have been around for a while,
however, they have often been vendor specic and at
present they remain outside the ofcial standard. There
is, however, increased consensus on an optional ‘Jumbo’
payload size of 9000 bytes and this is fully supported by
the ADDERLink INFINITY (ALIF) units.
Jumbo frames (or Jumbo packets) offer advantages for
ALIF units when transmitting certain high resolution video
signals across a network. This is because the increased data
in each packet reduces the number of packets that need to
be transferred and dealt with - thus reducing latency times.
The main problem is that for jumbo frames to be possible
on a network, all of the devices on the network must
support them.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
69
Page 71
Spanning Tree Protocol (STP)
In order to build a robust network, it is necessary
to include certain levels of redundancy within the
interconnections between switches. This will help to
ensure that a failure of one link does not lead to a
complete failure of the whole network.
The danger of multiple links is that data packets, especially
multicast packets, become involved in continual loops as
neighbouring switches use the duplicated links to send and
resend them to each other.
To prevent such bridging loops from occurring, the
Spanning Tree Protocol (STP), operating at layer 2, is
used within each switch. STP encourages all switches
to communicate and learn about each other. It prevents
bridging loops by blocking newly discovered links until it
can discover the nature of the link: is it a new host or a
new switch?
The problem with this is that the discovery process can
take up to 50 seconds before the block is lifted, causing
problematic timeouts.
The answer to this issue is to enable the portfast/edge
port variable for all host links on a switch. This will cause
any new connection to go immediately into forwarding
mode. However, take particular care not to enable portfast
(edge port) on any switch to switch connections as this
will result in bridging loops.
Forwarding modes
In essence, the job of a layer 2 switch is to transfer as
fast as possible, data packets arriving at one port out to
another port as determined by the destination address.
This is known as data forwarding and most switches offer
a choice of methods to achieve this. Choosing the most
appropriate forwarding method can often have a sizeable
impact on the overall speed of switching:
• Store and forward is the original method and requires
the switch to save each entire data packet to buffer
memory, run an error check and then forward if no
error is found (or otherwise discard it).
• Cut-through was developed to address the latency
issues suffered by some store and forward switches.
The switch begins interpreting each data packet as it
arrives. Once the initial addressing information has been
read, the switch immediately begins forwarding the
data packet while the remainder is still arriving. Once
all of the packet has been received, an error check is
performed and, if necessary, the packet is tagged as
being in error. This checking ‘on-the-y’ means that
cut-through switches cannot discard faulty packets
themselves. However, on receipt of the marked packet, a
host will carry out the discard process.
• Fragment-free is a hybrid of the above two methods.
It waits until the rst 64 bits have been received before
beginning to forward each data packet. This way the
switch is more likely to locate and discard faulty packets
that are fragmented due to collisions with other data
packets.
• Adaptive switches automatically choose between the
above methods. Usually they start out as a cut-through
switches and change to store and forward or fragmentfree methods if large number of errors or collisions are
detected.
So which one to choose? The Cut-through method has the
least latency so is usually the best to use with ADDERLink
INFINITY units. However, if the network components and/
or cabling generate a lot of errors, the Store and forward
method should probably be used. On higher end store and
forward switches, latency is rarely an issue.
Layer 2 and Layer 3: The OSI model
When discussing network switches, the terms Layer 2 and
Layer 3 are very often used. These refer to parts of the
Open System Interconnection (OSI) model, a standardised
way to categorize the necessary functions of any standard
network.
There are seven layers in the OSI model and these dene
the steps needed to get the data created by you (imagine
that you are Layer 8) reliably down onto the transmission
medium (the cable, optical bre, radio wave, etc.) that
carries the data to another user; to complete the picture,
consider the transmission medium is Layer 0. In general,
think of the functions carried out by the layers at the top
as being complex, becoming less complex as you go lower
down.
As your data travel down from you towards the
transmission medium (the cable), they are successively
encapsulated at each layer within a new wrapper (along
with a few instructions), ready for transport. Once
transmission has been made to the intended destination,
the reverse occurs: Each wrapper is stripped away and the
instructions examined until nally only the original data are
left.
So why are Layer 2 and Layer 3 of particular importance
when discussing ADDERLink INFINITY? Because the
successful transmission of data relies upon fast and reliable
passage through network switches – and most of these
operate at either Layer 2 or Layer 3.
continued
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
70
Page 72
The job of any network switch is to receive each incoming
network packet, strip away only the rst few wrappers to
discover the intended destination then rewrap the packet
and send it in the correct direction.
In simplied terms, the wrapper that is added at Layer 2
(by the sending system) includes the physical address of
the intended recipient system, i.e. the unique MAC address
(for example, 09:f8:33:d7:66:12) that is assigned to every
networking device at manufacture. Deciphering recipients
at this level is more straightforward than at Layer 3, where
the address of the recipient is represented by a logical IP
address (e.g. 192.168.0.10) and requires greater knowledge
of the surrounding network structure. Due to their more
complex circuitry, Layer 3 switches are more expensive
than Layer 2 switches of a similar build quality and are
used more sparingly within installations.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
71
INFORMATION
INDEX
Page 73
APPENDIX F - Copper/ber modules and cables
To suit your installation layout, copper and ber modules are available for the AIM
server unit to support various CATx and ber optic cables. The specications for all are
summarized in this table:
Name Fiber size Type Coding Distance
at
Normal
applications
OM1 (62.5/125) Multimode
(TIA-492AAAA)
OM2 (50/125) Multimode
(TIA-492AAAB)
OM3 (50/125) Multimode
(850 nm Laser-optimized)
(TIA-492AAAC)
OM4 (50/125) Multimode
(850 nm Laser-optimized)
(TIA-492AAAC)
OS1 and OS2 (9/125) Single-mode
(TIA-492C000 / TIA-492E000)
C ATx n/a CAT5e and above n/a n/a 100m SFP-CATX-RJ45
Orange 62.5/125 220m SFP-MM-LC
Orange 50/125 550m “
Aqua 850 LO 50 /125 550m “
Aqua 850 LO 50 /125 550m “
Yellow SM/NZDS, SM 10Km SFP-SM-LC
Suggested print
nomenclature
1Gbps
Adder part
number for SFP
module
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
72
INFORMATION
INDEX
Page 74
APPENDIX G - AIM API
The AIM API provides access for external applications to key routines used within the
AIM server. This appendix provides a reference to the available methods. For an online
version, go to: https://support.adder.com/tiki/tiki-index.php?page=ALIF%3A+API
Note: The API is documented as an HTML le and is found by going to the following address:
http://<ip address>/api/
A windows application called the AIM Controller is available for download, whose
purpose is to demo and show you the API working in action. An example C# API class
has been written and published on Github. It is free to download (https://github.com/
AdderAPI/AIM-Manager), but comes with no support or warranty,
Best Practices
Do not login and generate a new token for every API request. When you rst connect
to the AIM, login and store a copy of the token that you are given, and use it for future
requests. Each token that you request, creates a stored session within the AIM Manager.
The duration of the session is dened by the AIM’s Admin timeout that is set on the
web interface under Dashboard -> Settings -> General. Creating a new token on every
request will result in hundreds if not thousands of stored sessions, each taking a small
amount of space on the AIM’s SSD drive. If a particularly long session duration is set, for
example 3 years then this could easily ll the drive over time since they don’t get deleted
until they expire.
Do not keep the HTTP port open. When making a request, simply send the api
command, wait for the response and then close the connection. A typical web browser
will fetch the html page and its associated les such as images, javascripts and ccs les
and then close the connection. The AIM runs a standard Apache web service. There is no
guarantee that the HTTP connection that you initially establish will always remain open.
The API is restful based, this means that you have to periodically request information
from the AIM and compare the previous and latest responses to see what has changed.
Be careful not to continuously send API requests as they consume resources on the AIM.
Requesting the Devices, Channels, Presets and C-USB information every 5-10 seconds
should usually sufce to monitor changes.
Session tokens are linked to the IP address of the host that connected to the AIM. If you
change the IP address of the host and use the same token then the API will throw an
error telling you that there is a mis-match.
On the AIM Controller API demo the procedure below has been used when sending
API requests. This ensures that you are working with a valid token, assuming your login
credentials are correct. The initial API request does not send a token, however the
procedure takes care of that.
Example Connection Procedure
1 Establish the HTTP connection.
2 Send the API request (with the stored token, if known)
3 Read the response.
• If the response is a Login error then
• Send a login request with the appropriate username and password.
• Read the response.
• If the login request is successful, extract and store the new token.
- Go back to step 2 and resend the original API request with the stored token.
• If the login request fails, then handle appropriately.
• If the response is different error then handle it appropriately.
4 Close the HTTP connection.
5 Process the response.
Repeat above procedure for the next API command.
Using a Web Browser to test the API
You can use a web browser to issue test API commands to the AIM Manager, however,
when you authenticate and receive a token, a web session is also created between the
browser and AIM. If you try to use the same web browser to also access the AIM’s admin
web interface, a different session will be created. This can cause the API token to become
invalid on the browser. To resolve this, it is recommended that you use two different
web browsers, for example, Google Chrome for the API and FireFox for the AIM’s admin
web interface. This will allow two different sessions to operate simultaneously. This only
affects web browsers.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
73
Page 75
API version: 11
Changelog
v11 (AIM v5.4) - updated get_channels.
v10 (AIM v5.4) - added identify_device.
v9 (AIM v5.2) - added replace_device, promote, get_servers.
v8 (AIM v5.0) - updated get_channels, get_devices.
v7 (AIM v4.8) - added reboot_devices.
v6 (AIM v4.5) - added get_all_c_usb, delete_c_usb, update_c_usb, connect_c_usb,
disconnect_c_usb.
v5 (AIM v4.3) - added update_device; updated get_devices, connect_channel, connect_
preset, create_channel, create_preset.
v4 (AIM v4.1) - added create_channel, delete_channel; updated get_channels.
v3 (AIM v3.2) - added create_preset, delete_preset.
v2 (AIM v2.3) - added get_devices, get_channels, connect_channel, disconnect_channel.
Updated version compatibility information.
v1 (AIM v1.3) - added login, logout, get_presets, connect_preset, disconnect_preset
Below mentioned APIs works on Primary setup only.
Methods
login
logout
get_devices
get_channels
get_presets
connect_channel
connect_preset
disconnect_channel
disconnect_preset
create_preset
delete_preset
create_channel
delete_channel
update_device
promote
get_all_c_usb
delete_c_usb
update_c_usb
connect_c_usb
disconnect_c_usb
reboot_devices
replace_device
get_servers
identify_device
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
74
INFORMATION
INDEX
Page 76
login
This method was last updated in API version 1, and is compatible with API requests from
version 1 onwards.
The API will require a valid AIM user’s login credentials to be presented in the rst
request. The API will return an authentication code, which must be passed in all future
requests. This authentication code can be re-used until a logout request is made, at which
point the authentication code will no longer be valid.
The concept of an ‘anonymous user’ can apply to the API. If no login username and
password are provided, the API will return an authentication token for the anonymous
user (either the same one as for the OSD, or else an ‘anonymous API user’ account can
be created).
Input parameters:
- username
- password
- v (the AIM API version this request is designed for)
Output values:
- timestamp - the current server time
- version - the current API version number
- token - an authentication code for future API requests
- success
Examples
Input:
/api/?v=1&method=login&username=xxxxx&password=xxxxx
Output:
<api_response>
<version>1</version>
<timestamp>2012-12-14 12:12:12</timestamp>
<success>1</success>
<token>5cf494a71c29e9465a57a81e0a2d602c</token>
</api_response>
or
<api_response>
<version>1</version>
<timestamp>2012-12-14 12:12:12</timestamp>
<success>0</success>
<errors>
<error>
<code>2</code>
<msg>Invalid username or password</msg>
</error>
</errors>
</api_response>
12/10/2018 217.196.235.249:8097/api/
http://217.196.235.249:8097/api/ 2/11
logout
This method was last updated in API version 1, and is compatible with API requests from
version 1 onwards. The authentication token provided by the ‘login’ method can be used
until the ‘logout’ method is called.
Input parameters:
- token
- v (the AIM API version this request is designed for)
Output values:
- timestamp - the current server time
- success - 0 = fail, 1 = success
Examples
Input:
/api/?method=logout&token=xxxxx&v=1
Output:
<api_response>
<version>1</version>
<timestamp>2011-02-04 15:24:15</time>
<success>1</success>
</api_response>
or
<api_response>
<version>1</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>0</success>
<errors>
<error>
<code>3</code>
<msg>Error logging out (you may already have logged out)</msg>
</error>
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
75
Page 77
</errors>
</api_response>
get_devices
This method was last updated in API version 5, and is compatible with API requests from
version 2 onwards.
This method returns a list of devices.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- device_type (‘rx’ = receivers, ‘tx’ = transmitters. Default = ‘rx’)
- lter_d_name (Optional. Device name search string)
- lter_d_description (Optional. Device description search string)
- lter_d_location (Optional. Device location search string)
- sort (Optional. Sort results by ‘name’/’description’/’location’. Default = ‘name’)
- sort_dir (Optional. Sort direction for results ‘asc’/’desc’. Default = ‘asc’)
- status (Optional. ‘’,’outdated_aim_ip’,’rebooting’,’ofine’,’outdated_rmware’,’invalid_
backup_rmware’,’rebooting’,’upgrading_rmware’,’backup_
- show_all (Optional. If set and not blank, shows all receivers, not just those the logged-in
user is permitted to use)
- page (page number to start showing results for, default = 1)
- results_per_page (number of results per page, default = 1000)
Output values:
- version - the current API version number
- timestamp - the current server time
- success
- page (page number)
- results_per_page (number of results per page, default = unlimited)
- total_devices - the total number of devices
- count_devices - the number of devices on this page
- for each device:
- attribute: item (e.g. 17th device)
- d_id (device ID)
- d_serial_number (the device’s serial number, if it is reported)
- d_mac_address (MAC address for interface 1)
- d_mac_address2 (MAC address for interface 2)
- d_name (device name)
- d_online (0 = interface 1 ofine, 1 = interface 1 online)
- d_online2 (0 = interface 2 ofine, 1 = interface 2 online)
- d_type (rx, tx)
- d_version (1 = ALIF1000R/ALIF1000T, 2 = ALIF2000R/ALIF2000T/ALIF2002T/
ALIF2112T/ALIF1002R/ALIF1002T/ALIF2020R/ALIF2020T/ALIF100T, 4 = ALIF8000R/A
- d_variant (‘b’ = ALIF2002T, ‘v’ = ALIF2112T, ‘s’ = ALIF1002R/ALIF1002T, ‘t’ = ALIF2020R/
ALIF2020T, ‘d’ = ALIF100T)
- d_ip_address (IP address for interface 1)
- d_ip_address2 (IP address for interface 2)
- d_description (device description)
- d_location (device location)
- d_congured (0 = no, 1 = yes)
- d_valid_rmware (0 = no, 1 = yes)
- d_valid_backup_rmware (0 = no, 1 = yes)
- d_rmware (rmware version, e.g. 2.5.17879)
- d_backup_rmware (backup rmware version)
- d_date_added (Date device added to AIM network e.g. 2012-07-13 22:17:22)
- d_status (0 = device ofine, 1 = device online, 2 = rebooting, 4 = rmware_upgrading, 6
= running backup rmware)
The following property is only returned for transmitters:
- count_transmitter_channels (the number of channels containing this transmitter)
- count_transmitter_presets (the number of presets containing this transmitter)
The following properties are only returned for receivers:
- con_exclusive (0/1 - if the last connection is/was in private mode)
- con_control (1/2/3 - 1 if the last connection is/was video-only, 2 if in exclusive mode, 3
if in shared mode)
- con_start_time (start time of last connection e.g. 2012-09-07 13:33:17)
- con_end_time (empty if connection still active, else date/time the connection was
ended e.g. 2012-09-07 13:33:17)
- u_username (username of the user who initiated the last connection)
- u_id (user ID of the user who initiated the last connection)
- c_name (name of the channel last connected)
- count_receiver_groups (the number of receiver groups this receiver is a part of)
- count_receiver_presets (the number of presets this receiver is a part of)
- count_users (the number of users who have access to this receiver)
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
76
Page 78
Examples
Input:
/api/?v=2&method=get_devices&token=xxxxx
/api/?v=2&method=get_devices&device_type=tx&page=2&results_per_
page=3&token=xxxxx
Output:
<api_response>
<version>2</version>
<timestamp>2012-09-12 14:56:11</timestamp>
<success>1</success>
<page>2</page>
<results_per_page>3</results_per_page>
<total_devices>12</total_devices>
<count_devices>3</count_devices>
<devices>
<device item=”4”>
<d_id>170</d_id>
<d_serial_number>1409A0000159</d_serial_number>
<d_mac_address>00:0F:58:01:6E:3D</d_mac_address>
<d_mac_address2>00:0F:58:5B:6E:3D</d_mac_address2>
<d_name>RX 123</d_name>
<d_online>1</d_online>
<d_online2>0</d_online2>
<d_type>rx</d_type>
<d_version>2</d_version>
<d_variant></d_variant>
<d_ip_address>10.10.10.66</d_ip_address>
<d_ip_address2>10.10.10.67</d_ip_address2>
<d_description></d_description>
<d_location>Server Rack 3</d_location>
<d_congured>1</d_congured>
<d_valid_rmware>1</d_valid_rmware>
<d_valid_backup_rmware>1</d_valid_backup_rmware>
<d_rmware>2.3.16682</d_rmware>
<d_backup_rmware>2.3.16682</d_backup_rmware>
<d_date_added>2012-07-14 01:37:07</d_date_added>
<d_status>1</d_status>
<con_exclusive>0</con_exclusive>
<con_control>1</con_control>
<con_start_time>2012-09-07 13:33:19</con_start_time>
<con_end_time/>
<u_username>admin</u_username>
<u_id>1</u_id>
<c_name>Channel 1</c_name>
<count_receiver_groups>1</count_receiver_groups>
<count_receiver_presets>2</count_receiver_presets>
<count_users>1</count_users>
</device>
</devices>
</api_response>
<api_response>
<version>2</version>
<timestamp>2012-09-12 14:56:11</timestamp>
<success>1</success>
<page>1</page>
<results_per_page>1</results_per_page>
<total_devices>1</total_devices>
<count_devices>1</count_devices>
<devices>
<device item=”1”>
<d_id>64</d_id>
<d_serial_number/>
<d_mac_address>00:0F:58:01:56:85</d_mac_address>
<d_mac_address2>00:0F:58:5B:56:85</d_mac_address2>
<d_name>TX 456</d_name>
<d_online>0</d_online>
<d_online2>0</d_online2>
<d_type>tx</d_type>
<d_version>1</d_version>
<d_variant></d_variant>
<d_ip_address>1.1.201.31</d_ip_address>
<d_ip_address2>1.1.201.32</d_ip_address2>
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
77
Page 79
<d_description></d_description>
<d_location></d_location>
<d_congured>1</d_congured>
<d_valid_rmware>1</d_valid_rmware>
<d_valid_backup_rmware>1</d_valid_backup_rmware>
<d_rmware>2.1.15747</d_rmware>
<d_backup_rmware>2.1.15747</d_backup_rmware>
<d_date_added>2012-07-13 17:50:04</d_date_added>
<d_status>0</d_status>
<count_transmitter_channels>3</count_transmitter_channels>
<count_transmitter_presets>1</count_transmitter_presets>
</device>
</devices>
</api_response>
get_channels
This method was last updated in API version 11, and is compatible with API requests
from version 2 onwards
This method returns a list of channels available to the authenticated user, for a specic
receiver.
It was updated in version 11 to include additional information.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- page (page number to start showing results for, default = 1)
- results_per_page (number of results per page, default = 1000)
- device_id (ID of the receiver that this channel will be connected to. Recommended to
ensure full checks for connection mode availability.
- lter_c_name (channel name search string)
- lter_c_description (channel description search string)
- lter_c_location (channel location search string)
- lter_favourites (set this non-empty to only show a user’s favourites)
Output values:
- version - the current API version number
- timestamp - the current server time
- success
- page (page number)
- results_per_page (number of results per page, default = unlimited)
- total_channels - total number of channels available
- count_channels - the number of channels on this page, available to the authenticated
user
- for each channel:
- attribute: item (e.g. 17th channel)
- c_id (channel id)
- c_name (channel name)
- c_description (channel description)
- c_location (channel location)
- c_channel_type (channel type)
- c_tx_id (device ID)
- channel_online (device status)
- c_favourite (true if this channel is in the user’s favourites, 0-9 if it’s a numbered
shortcut)
- view_button (disabled/enabled/hidden - whether the user can connect to the preset
in video-only mode.
disabled = no, because something is in use by someone else. hidden = never. enabled
= yes
If the device_id of the proposed receiver to be used in the connection is not
provided,
this will not necessarily be an accurate indication of whether other connections may
actually interfere)
- shared_button (disabled/enabled/hidden - as above, but in shared mode)
- control_button (disabled/enabled/hidden - as above, but in exclusive mode)
- exclusive_button (disabled/enabled/hidden - as above, but in private mode)
Additional channel output values in version 4:
- c_video1 (device ID)
- c_video1_head (1|2)
- c_video2 (device ID)
- c_video2_head (1|2)
- c_audio (device ID)
- c_usb (device ID)
- c_serial (device ID)
Additional channel output values in version 8:
- c_usb1 (device ID)
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
78
Page 80
- c_audio1 (device ID)
- c_audio2 (device ID)
- c_sensitive
- c_rdp_id (RDP ID) only for RDP devices.
Examples
Input:
/api/?v=2&method=get_channels&token=xxxxx
Version 2 output:
<api_response>
<version>2</version>
<timestamp>2012-12-14 12:12:12</timestamp>
<success>1</success>
<page>1</page>
<results_per_page>10</results_per_page>
<total_channels>2</total_channels>
<count_channels>2</count_channels>
<channel item=”1”>
<c_id>3</c_id>
<c_name>Channel 1</c_name>
<c_description>Description for Channel 1</c_description>
<c_location>Location of Channel 1</c_location>
<c_favourite>false</c_favourite>
<view_button>disabled</view_button>
<shared_button>disabled</shared_button>
<control_button>disabled</control_button>
<exclusive_button>disabled</exclusive_button>
</channel>
<channel item=”2”>
<c_id>5</c_id>
<c_name>Channel 2</c_name>
<c_description>Description for Channel 2</c_description>
<c_location>Location of Channel 2</c_location>
<c_favourite>2</c_favourite>
<view_button>enabled</view_button>
<shared_button>enabled</shared_button>
<control_button>enabled</control_button>
<exclusive_button>hidden</exclusive_button>
</channel>
</api_response>
get_presets
This method was last updated in API version 1, and is compatible with API requests
from version 1 onwards. This simple method returns a list of presets available to the
authenticated user.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- results_per_page (number of results per page, default = 1000)
- page (page number to start showing results for, default = 1)
Output values:
- version - the current API version number
- timestamp - the current server time
- success
- page (page number)
- results_per_page (number of results per page, default = unlimited)
- total_presets - the total number of presets available to the authenticaed user
- count_presets - the number of presets on this page, available to the authenticated user
- for each connection_preset:
- attribute: item (e.g. 17th preset)
- cp_id (preset id)
- cp_name (preset name)
- cp_description (preset description)
- cp_pairs (the number of channel-receiver pairs in this preset)
- problem_cp_pairs (the number of channel-receiver pairs that are mis-congured (e.g.
receiver ofine, receiver not dened)
- cp_active (whether all, any, or none of the channel-receiver pairs in this preset are
currently connected; values are ‘full’, ‘partial’, and ‘none’)
- connected_rx_count (the number of receivers in this preset that are already
connected)
- view_button (disabled/enabled/hidden - whether the user can connect to the preset in
video-only mode.
disabled = no, because something is in use by someone else. hidden = never. enabled =
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
79
Page 81
yes)
- shared_button (disabled/enabled/hidden - as above, but in shared mode)
- control_button (disabled/enabled/hidden - as above, but in exclusive mode)
- exclusive_button (disabled/enabled/hidden - as above, but in private mode)
Examples
Input:
/api/?v=1&method=get_presets&token=xxxxx
Output:
<api_response>
<version>1</version>
<timestamp>2012-12-14 12:12:12</timestamp>
<success>1</success>
<page>1</page>
<results_per_page>10</results_per_page>
<total_presets>2</total_presets>
<count_presets>2</count_presets>
<connection_preset item=”1”>
<cp_id>3</cp_id>
<cp_name>Preset 1</cp_name>
<cp_description>Description for Preset 1</cp_description>
<cp_pairs>1</cp_pairs>
<problem_cp_pairs/>
<cp_active>full</cp_active>
<connected_rx_count>1</connected_rx_count>
<view_button>disabled</view_button>
<shared_button>disabled</shared_button>
<control_button>disabled</control_button>
<exclusive_button>disabled</exclusive_button>
</connection_preset>
<connection_preset item=”2”>
<cp_id>4</cp_id>
<cp_name>Preset 2</cp_name>
<cp_description>Description for Preset 2</cp_description>
<cp_pairs>2</cp_pairs>
<problem_cp_pairs/>
<cp_active>none</cp_active>
<connected_rx_count/>
<view_button>enabled</view_button>
<shared_button>hidden</shared_button>
<control_button>hidden</control_button>
<exclusive_button>hidden</exclusive_button>
</connection_preset>
</api_response>
connect_channel
This method was last updated in API version 5, and is compatible with API requests from
version 2 onwards
This simple method connects a receiver to a channel.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- c_id - the ID of the channel (acquired from get_channels)
- rx_id - the ID of the receiver (acquired from get_devices)
- mode (optional, ‘v’, ‘s’, ‘e’, ‘p’ - defaults to ‘s’) - the mode in which to connect the channel
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (optional, if anything went wrong with connecting the channel)
Examples
Input:
/api/?v=5&method=connect_channel&token=xxxxx&c_id=1&rx_id=2&mode=e
Output:
<api_response>
<version>2</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
or
<api_response>
<version>2</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>0</success>
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
80
Page 82
<errors>
<error>
<code>231</code>
<msg>ERROR - private connection not available</msg>
</error>
</errors>
</api_response>
<errors>
<error>
<code>210</code>
<msg>”.$cong[‘error_codes’][210].”</msg>
</error>
</errors>
</api_response>
connect_preset
This method was last updated in API version 5, and is compatible with API requests from
version 1 onwards
This simple method connects all channel-receiver pairs in a preset.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- id - the ID of the preset (acquired from get_presets)
- mode (optional, ‘v’, ‘s’, ‘e’, ‘p’ - defaults to ‘s’) - the mode in which to connect the preset
- force (optional, 0/1 - defaults to 0) - whether to ignore errors with some of the preset’s
pairs or not
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (optional, if anything went wrong with connecting the presets)
Examples
Input:
/api/?v=5&method=connect_preset&token=xxxxx&id=1&force=1
Output:
<api_response>
<version>1</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
or
<api_response>
<version>1</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>0</success>
disconnect_channel
This method was last updated in API version 2, and is compatible with API requests from
version 2 onwards
This method disconnects a receiver, a number of receivers, or all connected receivers.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- rx_id (ID(s) of the receiver, as an integer, or comma-separated set of integers. Optional.
If not supplied, all connections will be ended)
- force - whether to disconnect existing connections by other users, or for ofine
receivers
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=2&method=disconnect_channel&token=xxxxx (disconnect all your online,
connected channels)
/api/?v=2&method=disconnect_channel&token=xxxxx&rx_id=1 (disconnect channel 1, if
you connected it and it’s online)
/api/?v=2&method=disconnect_channel&token=xxxxx&rx_id=1,2,3 (disconnect channels
1, 2, and 3, if you connected them and they’re online)
/api/?v=2&method=disconnect_channel&token=xxxxx&force=1 (force disconnect all
connected channels)
/api/?v=2&method=disconnect_channel&token=xxxxx&rx_id=1,3&force=1 (force
disconnect channels 1 and 3)
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
81
Page 83
Output:
<api_response>
<version>2</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
disconnect_preset
This method was last updated in API version 1, and is compatible with API requests from
version 1 onwards. This method disconnects all channel-receiver pairs in a preset, or
disconnects ALL connections in the whole AIM network.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- id (optional. If not supplied, all connections will be ended)
- force - whether to ignore errors with some of the preset’s pairs or not
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=1&method=disconnect_preset&token=xxxxx&id=1&force=1
Output:
<api_response>
<version>1</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
create_preset
This method was last updated in API version 5, and is compatible with API requests from
version 3 onwards. This method creates a new preset. The API user must have admin
privileges to call this method successfully.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- name (the display name for the new preset)
- pairs (a comma-separated list of the channel ID–receiver ID pairs for the preset, where
each ID in the pair is separated by a hyphen)
- allowed (the permitted connection modes for the preset. Optional; if omitted, the
global setting will be inherited.
Permitted values are any combination of the characters:
v - video-only
s - shared
e - exclusive
p - private
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
- id (the ID of the new preset, if it was created)
Examples
Input:
/api/?v=5&method=create_preset&token=xxxxx&name=my_preset&pairs=1-1,1-2,2-3,2-
4&allowed=vs
Output:
<api_response>
<version>3</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
<id>5</id>
</api_response>
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
82
Page 84
delete_preset
This method was last updated in API version 3, and is compatible with API requests from
version 3 onwards. This method deletes a preset. The API user must have admin privileges
to call this method successfully.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- id (the ID of the preset to be deleted)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=3&method=delete_preset&token=xxxxx&id=5
Output:
<api_response>
<version>3</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
create_channel
This method was last updated in API version 5, and is compatible with API requests from
version 4 onwards. This method creates a new channel. The API user must have admin
privileges to call this method successfully.
NB that, although the source device ID inputs are each optional, at least one is required.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- name (the display name for the new channel)
- desc (the display description for the new channel. Optional, default is empty.)
- loc (the display location for the new channel. Optional, default is empty.)
- allowed (the permitted connection modes for the channel. Optional; if omitted, the
global setting will be inherited.
Permitted values are any combination of the characters:
v - video-only
s - shared
e - exclusive
p - private
- video1 (device ID of video source 1. Optional, default is empty.)
- video1head (video head number for source 1. Optional, default is 1.)
- video2 (device ID of video source 2. Optional, default is empty.)
- video2head (video head number for source 2. Optional, default is 1.)
- audio (device ID of the audio source. Optional, default is empty.)
- usb (device ID of the usb source. Optional, default is empty.)
- serial (device ID of the serial source. Optional, default is empty.)
- groupname (the name of a channel group of which the created channel will be a
member. Optional, default is empty.)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
- id (the ID of the new channel, if it was created)
Examples
Input:
/api/?v=5&method=create_channel&token=xxxxx&name=my_channel&video1=21&audio
=81&groupname=my_channel_group
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
83
Page 85
Output:
<api_response>
<version>3</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
<id>91</success>
</api_response>
delete_channel
This method was last updated in API version 4, and is compatible with API requests
from version 4 onwards. This method deletes a channel. The API user must have admin
privileges to call this method successfully.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- id (the ID of the channel to be deleted)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=4&method=delete_channel&token=xxxxx&id=5
Output:
<api_response>
<version>4</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
update_device
This method was last updated in API version 5, and is compatible with API requests from
version 5 onwards. This method updates the description and location elds for a device.
The API user must have admin privileges to call this method successfully.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- id (the ID of the device to be updated)
- desc (the display description for the device. Optional, if not supplied, the description
will not be changed. To delete an existing value, set it to
- loc (the display location for the new channel. Optional, if not supplied, the location will
not be changed. To delete an existing value, set it to t
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=5&method=update_device&token=xxxxx&id=1501&desc=John’s Desk&loc=room
5
Output:
<api_response>
<version>5</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
84
INDEX
Page 86
promote
This method was last updated in API version 9, and is compatible with API requests from
version 9 onwards
This method promotes Backup AIM server temporarily acting as Primary to Primary AIM
server.
The API user must have admin privileges to call this method successfully.
Input parameters:
- token
- v (the AIM API version this request is designed for)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=9&method=promote&token=xxxxx
Output:
<api_response>
<version>9</version>
<timestamp>2021-06-01 11:04:35</timestamp>
<success>1</success>
</api_response>
or
<api_response>
<version>9</version>
<timestamp>2021-06-06 11:04:35</timestamp>
<success>0</success>
<errors>
<error>
<code>17</code>
<msg>ERROR - This request will only be processed by an active Backup AIM </
msg>
</error>
</errors>
</api_response>
get_all_c_usb
This method was last updated in API version 6, and is compatible with API requests from
version 6 onwards. This method returns a list of the C-USB LAN network extenders.
Input parameters:
- token
- v (the AIM API version this request is designed for)
Output values:
- version - the current API version number
- timestamp - the current server time
- success
- count_c_usbs - the total number of C-USB LAN network extenders
- for each C-USB LAN network extender:
- attribute: item (e.g. 17th C-USB LAN extender)
- mac (C-USB LAN extender MAC address)
- type (rx, tx)
- name (customisable name)
- online (0, 1)
- ip (C-USB LAN extender IP address)
- connectedTo (if connected, the MAC address of the connected C-USB LAN extender)
Examples
Input:
/api/?v=6&method=get_all_c_usb&token=xxxxx
Output:
<api_response>
<version>6</version>
<timestamp>2012-12-14 12:12:12</timestamp>
<success>1</success>
<count_c_usbs>2</count_c_usbs>
<c_usb_lan_extenders>
<c_usb item=”1”>
<mac>aa:aa:aa:aa:aa:aa</mac>
<type>rx</type>
<name>John’s Desk</name>
<online>1</online>
<ip>10.10.10.25</ip>
<connectedTo>bb:bb:bb:bb:bb:bb</connectedTo>
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
85
Page 87
</c_usb>
<c_usb item=”2”>
<mac>bb:bb:bb:bb:bb:bb</mac>
<type>tx</type>
<name>John’s PC</name>
<online>1</online>
<ip>10.10.10.27</ip>
</c_usb>
</c_usb_lan_extenders>
</api_response>
delete_c_usb
This method was last updated in API version 6, and is compatible with API requests from
version 6 onwards. This method deletes a C-USB LAN network extender. The API user
must have admin privileges to call this method successfully.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- mac (the C-USB LAN extender MAC address)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=6&method=delete_c_usb&token=xxxxx&mac=aa:aa:aa:aa:aa:aa
Output:
<api_response>
<version>6</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
update_c_usb
This method was last updated in API version 6, and is compatible with API requests from
version 6 onwards. This method updates the name eld for a C-USB LAN network
extender. The API user must have admin privileges to call this method successfully.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- mac (the C-USB LAN extender MAC address)
- name (the new display name for the C-USB LAN extender)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=6&method=update_c_usb&token=xxxxx&mac=aa:aa:aa:aa:aa:aa&name=John’s
Desk
Output:
<api_response>
<version>6</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
86
Page 88
connect_c_usb
This method was last updated in API version 6, and is compatible with API requests from
version 6 onwards. This method connects a C-USB LAN network extender receiver
to a C-USB LAN network extender transmitter. Note that if either the receiver or the
transmitter is currently connected, it will have to be disconnected rst.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- rx (the MAC address of the C-USB LAN extender receiver)
- tx (the MAC address of the C-USB LAN extender transmitter)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=6&method=connect_c_usb&token=xxxxx&rx=aa:aa:aa:aa:aa:aa&tx=bb:bb:bb:bb:b
b:bb
Output:
<api_response>
<version>6</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
disconnect_c_usb
This method was last updated in API version 6, and is compatible with API requests from
version 6 onwards. This method disconnects a C-USB LAN network extender receiver.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- mac (the MAC address of the C-USB LAN extender receiver)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=6&method=disconnect_c_usb&token=xxxxx&mac=aa:aa:aa:aa:aa:aa
Output:
<api_response>
<version>6</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
87
INFORMATION
INDEX
Page 89
reboot_devices
This method was last updated in API version 7, and is compatible with API requests from
version 7 onwards. This method sends a reboot command to the specied devices.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- ids (a comma-separated list of IDs of the devices to be rebooted)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=7&method=reboot_devices&token=xxxxx&ids=101,1701,501
Output:
<api_response>
<version>7</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
replace_device
This method was last updated in API version 9, and is compatible with API requests from
version 9 onwards
This method replaces the device with the uncongured device
Input parameters:
- token
- v (the AIM API version this request is designed for)
- d_id (device ID)
- r_d_id (device ID with which the user wants to replace their device)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=9&method=replace_device&d_id=101&r_d_id=102&token=xxxxx
Output:
<api_response>
<version>9</version>
<timestamp>2021-06-03 15:30:06</timestamp>
<success>1</success>
</api_response>
or
<api_response>
<version>9</version>
<timestamp>2021-06-03 15:30:06</timestamp>
<success>0</success>
<errors>
<error>
<code>9</code>
<msg>You must provide an ID</msg>
</error>
</errors>
</api_response>
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
88
Page 90
get_servers
This method was last updated in API version 9, and is compatible with API requests from
version 9 onwards.
This method returns a list of servers.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- page (page number to start showing results for, default = 1)
- results_per_page (number of results per page, default = 1000)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
- page (page number)
- results_per_page (number of results per page, default = unlimited)
- total_servers - the total number of servers
- count_servers - the number of servers on this page
- attribute: item (e.g. 1st server)
- name (the display name for the server)
- role - the role of AIM - primary, backup, solo, uncongured
- status - the status of AIM - active, standby, failed, quiscent
- ip - the server IP on which AIM is running
- mac - MAC address
- eth1 - 0 = no, 1 = DHCP, 2 = Static, 3 = bonded
- ip2 - if eth1 is not enabled then this eld will be empty
- mac2 - if eth1 is not enabled then this eld will be empty
- description (the display description for the server. Optional, default is empty.)
- location (the display location for the server. Optional, default is empty.)
Examples
Input:
/api/?v=9&method=get_servers&token=xxxxx
/api/?v=9&method=get_servers&page=2&results_per_page=3&token=xxxxx
Output:
<api_response>
<version>9</version>
<timestamp>2021-06-01 16:10:28</timestamp>
<success>1</success>
<page>1</page>
<results_per_page>1000</results_per_page>
<total_servers>2</total_servers>
<count_servers>2</count_servers>
<servers>
<server item=”1”>
<name>192.168.22.105</name>
<role>primary</role>
<status>active</status>
<ip>192.168.22.105</ip>
<mac>70:85:c2:1c:21:6e</ip>
<eth1>0</eth1>
<ip2></ip2>
<mac2></mac2>
<description></description>
<location></location>
</server>
<server item=”2”>
<name>192.168.22.106</name>
<role>backup</role>
<status>standby</status>
<ip>192.168.14.107</ip>
<mac>70:85:c2:1c:22:6e</ip>
<eth1>0</eth1>
<ip2></ip2>
<mac2></mac2>
<description />
<location />
</server>
</servers>
</api_response>
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
89
Page 91
identify_device
This method was last updated in API version 10, and is compatible with API requests
from version 10 onwards
This method sends a identify command to the specied devices.
Input parameters:
- token
- v (the AIM API version this request is designed for)
- id (ID of the device)
Output values:
- version - the current API version number
- timestamp - the current server time
- success (0 = fail, 1 = success)
- errors (if anything failed, details are returned here)
Examples
Input:
/api/?v=10&method=identify_device&token=xxxxx&id=101
Output:
<api_response>
<version>7</version>
<timestamp>2012-12-12 12:12:12</timestamp>
<success>1</success>
</api_response>
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
90
INFORMATION
INDEX
Page 92
APPENDIX H - DHCP server requirements for ALIF support
Version 1.0
ALIF DHCP client
The ALIF DHCP client will identify itself to a DHCP server using DHCP option 60
(Vendor-Class-Identier) containing the brand string appropriate to the rmware, e.g.
Adder.
The ALIF DHCP client will also provide the DHCP server with its unique hostname
and a request for DHCP option 125 (Vendor Identied Vendor Sub Options). See Using
DHCP option 125 for details.
DHCP server
A DHCP server will use the Vendor-Class-Identier to identify an ALIF and supply it with
Adder vendor information encapsulated in the Adder Enterprise number (25119) within
DHCP option 125 (Vendor Identied Vendor Sub Options).
As of ALIF rmware version 4.2, the required Adder vendor information to be
encapsulated is:
Sub-option 1: Array of IP addresses of all AIM servers in the cluster.
Note: ALIF will ignore any DHCP OFFER not containing this information.
Example Gamma (Cisco IOS DHCPd, Adder, AIM servers: 10.0.20.5, 10.0.20.6)
ip dhcp pool vlan20
network 10.0.20.0 255.255.255.0
default-router 10.0.20.1
option 60 ascii “adder”
option 125 hex 0000.621f.0a01.080a.0014.050a.0014.06
where:
0x0000621f Adder Enterprise number (25119)
0x0a Length
0x01 Sub-option 1
0x08 Length
0x0a001405 10.0.20.5 (Primary AIM)
0x0a001406 10.0.20.6 (Backup AIM)
Example Alpha (ISC DHCPd, Adder, AIM servers: 10.0.20.5, 10.0.20.6)
# ISC DHCPd conguration for Adder
set vendor-string = option vendor-class-identier;
option space adder code width 1 length width 1;
option adder.aim-servers code 1 = array of ip-address;
option space vivso code width 4 length width 1;
option vivso.iana code 0 = string;
option vivso.adder code 25119 = encapsulate adder;
option option-125 code 125 = encapsulate vivso;
default-lease-time 3600;
max-lease-time 7200;
log-facility local7;
class “adder”
{
match if option vendor-class-identier = “adder”;
}
subnet 10.0.20.0 netmask 255.255.255.0
{
pool
{
allow members of “adder”;
vendor-option-space adder;
option domain-name “customer.com”;
option domain-name-servers 10.0.20.2;
option routers 10.0.20.1;
option vivso.iana 01:01:01;
option adder.aim-servers 10.0.20.5,10.0.20.6;
range 10.0.20.100 10.0.20.200;
}
}
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
91
Page 93
Using DHCP Option 125
DHCP Option 125 is a vendor-specic feature that provides additional information to
the ALIF Receivers and Transmitters when requesting an IP Address. The option gives the
endpoints the IP Address of the Primary and any other Backup or Satellite AIM Servers
that reside on the network.
The information is provided in a hex code which can be formatted slightly differently
depending on the DHCP Server, but will typically look like:-
are included.
The Length B value is the total byte count of the hex IP Addresses. In the example
below, there are 2x IP hex addresses. Each IP hex address is 4-bytes, therefore Length B
Length B
0000621f0a01080a0014050a001406
0000621f0a01080a0014050a001406
The Hex code is broken down to the following elements:
0000621f Adder Enterprise number (25119)
0a Length A
01 Sub-option 1
08 Length B
0a001405 10.0.20.5 (Primary AIM)
0a001406 10.0.20.6 (Backup AIM)
The Adder Enterprise element of hex code is xed and does not change, however
the IP Address and lengths A & B hex values will change depending on the INFINITY
conguration.
The rst IP address in the list must always be the Primary AIM Server, followed by the
Backup then Satellite AIM’s.
There are a number of online websites that help you convert an IP Address into a hex
number. Alternatively, you could use a Calculator with a Hex and Dec function which
you may nd is built into your computers operating system.
An IP Address hex code can be calculated by converting each of the four octet decimals
individually into hex.
Decimal Hex
10 0a
0 00
20 14
5 05
10.0.20.5 = 0a001405
Each hex IP Address is 4-bytes in length:
0a 00 14 05
1 1 1 1 (Total 4 bytes)
The Lengths A and B values will change depending on the number of IP Addresses that
4 bytes 4 bytes (Total 8 bytes)
is 8-bytes in total which equates to 08 in hex.
Length A includes Sub-option 1 (1-byte) and the Length B value (1-byte) plus the total of
Length A
0000621f0a01080a0014050a001406
4 bytes 4 bytes (Total 10 bytes)2 bytes
Length B (8-bytes). This makes the total 10-bytes which equates to 0a in hex.
Example
In the following example an additional IP address will be added to the existing DHCP
option 125 hex code shown previously. It will be a Satellite AIM whose IP address is
10.0.30.1 which is on a different subnet.
Step 1: Convert IP Address 10.0.30.1 into hex, which is 0a001e01. Add it to the end of
the hex code:
0000621f..01..0a0014050a0014060a001e01
Step 2: Calculate Length B. Since we now have 3x IP addresses and each hex address
is 4-bytes, the total length is 12-bytes which equates to 0c in hex:
0000621f..010c0a0014050a0014060a001e01
Step 3: Calculate Length A. This is the total of Length B plus the byte count for Suboption 1 and the Length B value. The Sub-option 1 and Length B values are 1-byte each,
the Length B total is 12-bytes. This makes the total of Length A to be 14-bytes which
equates to 0e in hex:
0000621f0e010c0a0014050a0014060a001e01
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
92
Page 94
APPENDIX I - AIM database schema
Settings
Value Meaning
login_required Anon cannot login into the receiver
auto_login_user Allows hotkey access to the user without any login
show_multi_user_info Disable(0) or Enable(1) the use of multi-user feature
on OSD
osd_alerts Disable(0) or Enable(1) alerts on OSD
show_osd_banner Disable(0) or Enable(1) OSD Banner
osd_hotkeys_disabled Disable(0) or Enable(1) the use of OSD Hotkey
osd_login_message Message to display on the osd login page
keyboard_country Keyboard country code for receiver
download_backup Download the Database Backup File to Computer,if
value set to 1
backup_schedule Schedule the database backup at server
(Never/0, Hourly/1, Daily/2, Weekly/3)
allow_users_exclusive_mode Allow all users to access the Private Mode
ad_schedule Sync Schedule the active directory
(Never/0, Hourly/1, Daily/2, Weekly/3)
allow_force_disconnect Disable(0) or Enable(1) any user logged in to receiver
to disconnect the channel connected by another user
allow_disconnect_all_receivers Disable(0) or Enable(1) Disconnect all receivers icon
on dashboard
Allowed modes
Value Meaning
0 inherit
1 view/shared only
2 exclusive only
3 view/shared & exclusive
4 view only
On-line Status
Value Meaning
0 ofine
1 online
2 rebooting
3 factory_resetting
4 rmware_upgrading
5 online, but uncongured
6 running backup rmware
7 device ID no longer online
Congure Status
Value Meaning
0 Uncongured
1 Congured and Saved
INSTALLATIONCONFIGURATIONOPERATION
OSD Banner Position
Value Meaning
4,4 Top Left
4,50 Top Center
4,96 Top Right
96,4 Bottom Left
96,50 Bottom Center
96,96 Bottom Right
FURTHER
INFORMATION
INDEX
93
Page 95
APPENDIX J - Technical specications
Hardware
Industrial specication server with solid state memory
Software
Closed system with bespoke application preloaded
Physical design
1U short-depth (230mm) server
WxHxD: 16.93” x 1.75” x 9.05”
430mm x 44.5mm x 230mm
Weight: 5.95 lbs
2.7kg
Power
Input rating of server: 12VDC 2.0A
Power Adapter
Input: 100-240VAC 50/60Hz 1.5A
Output: 12VDC 5.0A
Connector: IEC input
IMPORTANT: A defective power adapter MUST only be replaced with this make
and model: Adder order code: PSU-IEC-12VDC-5A
INSTALLATIONCONFIGURATIONOPERATION
Permitted operational ambient conditions
Operating temperature: 0 to 40ºC / 32 to 104ºF
Relative Humidity: 10-90% non-condensing
Permitted Altitude: <2000m
Approvals: CE, FCC
FURTHER
INFORMATION
INDEX
94
Page 96
APPENDIX K - OPEN SOURCE LICENSES
This product includes binaries that are derived from the open source community by
Adder under the GNU General Public License v2. Please follow the link below to view
the full list of open source licenses used:
https://support.adder.com/tiki/tiki-index.php?page=AIM%3A+OpenSource+Licence3
The software included in this product contains copyrighted software that is licensed
under the GNU General Public License (GPL). You may obtain the complete
Corresponding Source Code from Adder for a period of three years after the last
shipment of this product, which will be no earlier than 2028, by contacting
support@adder.com or writing to:
Attn: ACD/Open Source Request,
Adder Technology Ltd,
Saxon Way, Bar Hill,
Cambridge, CB23 8SL,
United Kingdom
Please write “Source for product XXXXXXXX” in the subject line,
where XXXXXXXX is the model and version number.
This offer is valid to anyone in receipt of this information.
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
95
INFORMATION
INDEX
Page 97
www.adder.com
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
Documentation by:
www.ctxd.com
INDEX
© 2022 Adder Technology Limited
All trademarks are acknowledged.
Part No. MAN-000016 • Release 5.4
96
Page 98
Index
A
Accessing virtual machines 60
Active Directory 5,54
Add VDI 47
Auto Login
explanation 43
user authorisation 22,39,41
B
Base DN 27
Browsers
supported 12
C
Cable spec
null modem 64
Channel
add channel group 36
congure channel group 36
Channels
add a channel 35
congure a channel 35
view channels page 34
what are they? 4
Channels tab 34
Clear credentials 60
Credentials
VM 60
C-USB LAN 49,60
D
Dashboard
active connections page 31
backups page 28
connection log page 31
event log page 31
home page 17
settings page 18
updates page 29
Dashboard tab 17
Distinguished Name 27
F
Factory reset 15
Favorites 58
Firmware (AIM)
upgrade/downgrade 29,30
Frame Skipping 46
Front panel indicators 16
G
Groups
what are they? 4
H
Hotkey settings 22
Hotkey shortcuts 58
I
IGMP 69
Indicators 16
IP port
connecting 8
L
LDAP 27
License upgrade 68
Logging in
administrators 12
normal users 58
N
Network ports
conguration 25
O
On-Screen Display 4,58,59,61
OSD 4
login 58
main screen 59
On Screen Display 59
remote 61
shortcuts 58
P
Permissions 5
Port
VDI 47
Portfast 70
Presets 55
add presets page 56
congure presets page 56
Presets tab 55
R
Receivers
add receiver group page 41
congure group page 41
congure receiver page 38,39
view receivers page 37
Receivers tab 37
Redundant servers
setting up 66
Regular user 4
Relationship
three-way 4
Remote OSD 61
Remote support 31
Reset
manual 15
Restart Apache 29
S
Search lters 34
Security 4
Server redundancy 66
Servers tab 49,50
SFP ports 8
Shortcuts 58
Specications 94
Statistics tab 57
Swapping an AIM server 66
T
Technical specications
62,91,93,94
Transmitters
congure transmitter page 45
view transmitters page 44
Transmitters tab 44
U
Upgrade license 68
Users
active directory 54
add user group page 53
add user page 52
congure group page 53
congure user page 52
view users page 51
Users tab 51
V
VDI 47
Virtual Desktop Infrastructure
47
VM credentials 59,60
INSTALLATIONCONFIGURATIONOPERATION
FURTHER
INFORMATION
INDEX
97
Loading...