Black Box ACR1000A-CTL-24 Manual
Black Box ACR1000A-CTL-24 Manual

Black Box ACR1000A-CTL-24 Manual

Ipath agility controller
Hide thumbs Also See for ACR1000A-CTL-24:
Table of Contents

Advertisement

Quick Links

®
NETWORK SERVICES
iPATH
Agility Controller
iPATH Agility Controller manages your Agility
network and its connected users.
This self-contained server unit contains all necessary hardware and software.
Order toll-free in the U.S.: Call 877-877-BBOX (outside U.S. call 724-746-5500)
Customer
FREE technical support 24 hours a day, 7 days a week: Call 724-746-5500 or fax 724-746-0746
Support
www.blackbox.com • info@ blackbox.com
Information
®
ACR1000A-CTL-24
ACR1000A-CTL-48
ACR1000A-CTL-192
ACR1000A-CTL-288
ACR1000A-CTL-96
ACR1000A-CTL-ULC

Advertisement

Table of Contents
loading

Summary of Contents for Black Box ACR1000A-CTL-24

  • Page 1 ® ® ACR1000A-CTL-24 ACR1000A-CTL-48 ACR1000A-CTL-96 NETWORK SERVICES ACR1000A-CTL-192 ACR1000A-CTL-288 ACR1000A-CTL-ULC iPATH Agility Controller ™ iPATH Agility Controller manages your Agility network and its connected users. This self-contained server unit contains all necessary hardware and software. Order toll-free in the U.S.: Call 877-877-BBOX (outside U.S. call 724-746-5500)
  • Page 2 Agility Controller Trademarks Used in this Manual Black Box and the Double Diamond logo are registered trademarks of BB Technologies, Inc. Mac is a registered trademark of Apple Computer, Inc. Linux is registered trademark of Linus Torvalds. Windows is a registered trademark of Microsoft Corporation.
  • Page 3 FCC and IC RFI Statements Federal Communications Commission and Industry Canada Radio Frequency Interference Statements This equipment generates, uses, and can radiate radio-frequency energy, and if not installed and used properly, that is, in strict accordance with the manufacturer’s instructions, may cause inter ference to radio communication. It has been tested and found to comply with the limits for a Class A computing device in accordance with the specifications in Subpart B of Part 15 of FCC rules, which are designed to provide reasonable protection against such interference when the equipment is operated in a commercial environment.
  • Page 4 iPATH Agility Controller Instrucciones de Seguridad (Normas Oficiales Mexicanas Electrical Safety Statement) 1. Todas las instrucciones de seguridad y operación deberán ser leídas antes de que el aparato eléctrico sea operado. 2. Las instrucciones de seguridad y operación deberán ser guardadas para referencia futura. 3.
  • Page 5: Table Of Contents

    Table of Contents Contents 1. Specifications ....................................7 1.1 Lithium battery .................................. 7 2. Introduction ....................................8 2.1 Agility/iPATH features ................................ 9 2.1.1 AFZ lossless codec..............................9 2.1.2 New feature: AFZ+ codec ............................. 9 2.1.3 Magic Eye (anti-dither support added) ......................... 9 2.1.4 Transport Layer Security (TLS) ..........................
  • Page 6 iPATH Agility Controller 4.6 The Receivers Tab ................................42 4.6.1 Search Filters ..............................42 4.6.2 Receivers > View Receivers ..........................42 4.6.3 Receivers > Configure Receiver .......................... 43 4.6.4 Receivers > Add Receiver Group or Configure Group ..................45 4.6.5 Receivers > Update Firmware ..........................46 4.7 The Transmitters Tab ...............................
  • Page 7: Specifications

    CAUTION: RISK OF EXPLOSION IF BATTERY IS REPLACED BY AN INCORRECT TYPE. • If the lithium battery needs to be changed, you must return the product to your nearest Black Box dealer. The battery must be replaced by an authorized Black Box dealer.
  • Page 8: Introduction

    Agility Controller 2. Introduction Black Box Agility local and remote units allow multiple remote users to access host computers in a very flexible manner. Such flexibility requires management and coordination – that is where the iPATH Agility Controller becomes vital.
  • Page 9: Agility/Ipath Features

    Chapter 2: Overview 2.1 Agility/iPATH features 2.1.1 AFZ lossless codec The AFZ compression scheme is primarily focused on improving the performance for “natural” images (i.e. photographs and movies) and is automatically selected whenever there is a benefit to do so. The AFZ codec is lossless and is very low latency (a small fraction of a frame delay).
  • Page 10: Transport Layer Security (Tls)

    iPATH Agility Controller 2.1.4 Transport Layer Security (TLS) Agility and Agility Dual units support the industry standard Transport Layer Security (TLS) protocol. This offers protection against eavesdropping and tampering by third parties when data are transferred between Agility transmitters and receivers across networks (and also between Agility units and iPATH Agility Controllers).
  • Page 11: Ipath Agility Controller Basics

    Chapter 2: Overview 2.2 Teaming operation The units have dual network interface ports which can be used in parallel to produce important benefits: • Improved connection speeds up to 2 Gigabits per second, and • Important link redundancy that can maintain operation in the event of a failed connection. Teaming offers immediate speed improvements in a one-to-one arrangement...
  • Page 12 iPATH Agility Controller 2.3.3 User Types This guide refers to the two main categories of users involved with the iPATH Agility Controller system: • An Admin (administrator) user accesses the iPATH Agility Controller system via a network-linked computer running an Internet browser.
  • Page 13 Chapter 2: Overview 2.3.5 Active Directory To streamline administration even further, iPATH Agility Controller supports Active Directory. By synchronizing with an LDAP/Active Directory server, details of users (including their usernames and group memberships) can be securely synchronized from existing databases in order to both minimize the initial configuration as well as streamline ongoing updates. 2.3.6 iPATH Agility Controller Interface iPATH Agility Controller appears in two main ways, depending on whether you are an administrator or a regular user.
  • Page 14: Ipath Agility Controller Unit Features

    iPATH Agility Controller 2.4 iPATH Agility Controller Unit Features The iPATH Agility Controller unit is housed within a durable, metallic enclosure with most connectors situated at the rear panel. The smart front face features two indicators, a power switch and two USB ports, as shown in Figure 2-4: Green indicator: indicator:...
  • Page 15: What's Included

    Chapter 2: Overview 2.5 What‘s Included Your package should include the following items. If anything is missing or damaged, contact Black Box at 724-746-5500 or info@blackbox.com. 2.5.1 iPATH Agility Controller Package (ACR1000A-CTL-24 to -288 and -ULC) • iPATH Agility Controller unit, •...
  • Page 16: Installation

    iPATH Agility Controller 3. Installation 3.1 Connections The iPATH Agility Controller unit is supplied fully pre-loaded and permits no local user interaction. All configuration takes place remotely via the network connections and as a result only two connections are required: Network and power. 3.1.1 Network Connections The iPATH Agility Controller has two network connections on the rear panel: port 1 on the left and port 2 on the right.
  • Page 17 Chapter 3: Installation 3.1.2 Power Supply Connection Important: Please read and adhere to the electrical safety information given within the Safety information section of this guide. In particular, do not use an unearthed power socket or extension cable. 1 Attach the output connector of the power supply (country specific power supplies are available) to the power input socket on the left side of the rear panel, as shown in Figure 3-2: Figure 3-2.
  • Page 18: Installation Requirements

    iPATH Agility Controller 3.2 Installation Requirements • All Agility units linked with the iPATH Agility Controller must have firmware version 3.3 or greater. • On the network switch(es) that have iPATH Agility Controller(s) attached, ensure that the portfast option is enabled on each port to which an iPATH Agility Controller unit is connected.
  • Page 19: Configuration

    Chapter 4: Configuration 4. Configuration This section covers configuration of the iPATH Agility Controller Suite for administrators. For details about the regular user interface, please see the Operation section. 4.1 Supported Browsers The iPATH Agility Controller admin interface requires an A-grade browser with Javascript enabled. The list of appropriate browsers is as follows (Note: For best results always use the latest versions of the supported browsers.): •...
  • Page 20 iPATH Agility Controller IMPORTANT When you log in for the first time on an iPATH Agility Controller (firmware v4.0 or above) you need to specify a role before being able to configure the server. There are two options: • Solo - There is only ever going to be one iPATH Agility Controller on the network (with no redundancy and failover), or •...
  • Page 21: Basic Steps For A New Configuration

    Chapter 4: Configuration 4.3 Basic steps for a new configuration When adding and configuring new devices using an iPATH Agility Controller, these are the basic steps that you need to take: 1 Add the new Agility devices to the network and ensure that they are using a default factory configuration. If necessary, reset each one (see section 4.3.4).
  • Page 22: When Adding Agility Units

    iPATH Agility Controller 4.3.2 When adding Agility units When new Agility transmitters and receivers are added to a network, they are designed to automatically announce themselves* to the iPATH Agility Controller. Once the iPATH Agility Controller receives their announcement(s), the Agility units will be added to the administrator’s view of the Dashboard (Note: If adding a pre 3.3 Agility then the Agility unit must be trusted first, then upgraded to 3.3 (or above) and then can be configured).
  • Page 23: The Dashboard Tab

    Chapter 4: Configuration 4.4 The Dashboard Tab The Dashboard is your main point of contact for checking and changing the general status of all iPATH Agility Controller 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.
  • Page 24: Dashboard > Settings

    iPATH Agility Controller 4.4.2 Dashboard > Settings Click the Settings option below the Dashboard tab. The Settings section contains global configuration options for the iPATH Agility Controller system and is divided into eight pages, each accessible by clicking the relevant button located below the blue options bar: General •...
  • Page 25 Chapter 4: Configuration Note: By default, all new channels are set to inherit this global value. So it’s easy to change all channel connection modes sim- ply 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.
  • Page 26 iPATH Agility Controller 4.4.2.2 Dashboard > Settings > Transmitters This page applies a standard global configuration to all transmitters. Magic Eye Determines whether the Magic Eye feature should be enabled on Agility (excluding Agility Revision 1) transmitters. Magic Eye works to overcome the issues with increased bandwidth usage caused by ‘dithering’ techniques used on some computers, such as Apple Macs.
  • Page 27 Chapter 4: Configuration 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: It is not possible to reserve USB ports on the transmitter when used with iPATH Agility Controller. Enable Dummy Boot Keyboard It is often necessary to have a keyboard reported at start up.
  • Page 28 iPATH Agility Controller 4.4.2.3 Dashboard > Settings > Receivers This page applies a standard global configuration to all receivers. Hotkey settings The first few rows determine the Hotkeys that can be used to invoke certain functions. It is possible to select mouse keys to perform these functions, though it is not possible to use both mouse switching and a hot key combination.
  • Page 29 Chapter 4: Configuration USB Settings HID only If enabled, allows only HID (mice and keyboards) devices to be connected to the receivers. Disable Isochronous Endpoint Alerts When an isochronous USB device is connected to the receiver there will no longer be a warning message. Agility units do not support isochronous devices.
  • Page 30 iPATH Agility Controller 4.4.2.4 Dashboard > Settings > Servers This page is used to configure redundant operation for the iPATH Agility Controllers. It is now possible to place two iPATH Agility Controllers on the same subnet. One iPATH Agility Controller is the Primary (or Master) the other is the secondary (or Slave).
  • Page 31 Chapter 4: Configuration 4.4.2.5 Dashboard > Settings > Network This page applies global network parameters to the iPATH Agility Controller network. 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.
  • Page 32 iPATH Agility Controller 4.4.2.6 Dashboard > Settings > Time This page deals with all time related settings for the installation and allows up to three external NTP servers to be defined. NTP Enabled Determines whether one or more external Network Time Protocol servers should be used to provide timing for the installation. Server 1 Address Enter the IP address of the NTP server.
  • Page 33 Chapter 4: Configuration 4.4.2.8 Dashboard > Settings > Active Directory 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. AD Enabled? Determines whether Active Directory features will be used. Account Suffix Enter the account suffix for your domain.
  • Page 34: Dashboard > Backup

    IMPORTANT: You are strongly recommended to arrange regular scheduled backups of your iPATH Agility Controller database. Black Box 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”...
  • Page 35: Dashboard > Updates

    Note: When changing the iPATH Agility Controller firmware, it will be necessary to reboot the unit in order to apply the changes. To upgrade/downgrade the iPATH Agility Controller firmware 1 Download the appropriate firmware file from Black Box technical support. 2 Visit the Dashboard > Updates page of the iPATH Agility Controller unit and within the ‘Upgrade iPATH Software’ section, click the Browse...
  • Page 36: Dashboard > Active Connections Page

    iPATH Agility Controller 4.4.4.2 Upgrading Agility firmware globally This method allows the iPATH Agility Controller admin user to upgrade firmware on receivers and transmitters, wherever they are located. 1 Use the “Upload New TX/RX Firmware” section to place new transmitter and/or receiver firmware file(s) onto the iPATH Agility Controller.
  • Page 37: Dashboard > Event Log Page

    The remote support feature grants a member of the technical support team remote access to the iPATH Agility Controller unit. This page shows the current state of remote support, whether currently enabled or disabled, plus a button to change the remote support state. Note: Before enabling remote support contact Black Box technical support. 724-746-5500 | blackbox.com Page 37...
  • Page 38: The Channels Tab

    iPATH Agility Controller 4.5 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.
  • Page 39: Channels > Add Or Configure A Channel

    Chapter 4: Configuration 4.5.3 Channels > Add or Configure a Channel From the View Channels page, you can add a new channel or configure an existing channel: • To create a new channel: Click the “Add Channel” option. • To configure an existing channel: Click for a channel.
  • Page 40 iPATH Agility Controller 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.
  • Page 41: Channels > Add Or Configure Channel Group

    Chapter 4: Configuration 4.5.4 Channels > Add or Configure 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 configure an existing channel group: •...
  • Page 42: The Receivers Tab

    iPATH Agility Controller 4.6 The Receivers Tab The Receivers tab shows a paginated table of all receiver devices within the iPATH Agility Controller 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.
  • Page 43: Receivers > Configure Receiver

    Chapter 4: Configuration 4.6.3 Receivers > Configure Receiver From the View Receivers page, you can configure 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. Login Required •...
  • Page 44 iPATH Agility Controller Receiver Keyboard Country Code Select the country code of the keyboard connected to the receiver. 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.
  • Page 45: Receivers > Add Receiver Group Or Configure Group

    Chapter 4: Configuration 4.6.4 Receivers > Add Receiver Group or Configure Group From the View Receiver Groups page, you can create a new group or configure an existing group: • To create a new group: Click the “Add Receiver Group” option. •...
  • Page 46: Receivers > Update Firmware

    iPATH Agility Controller 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.
  • Page 47: The Transmitters Tab

    Chapter 4: Configuration 4.7 The Transmitters Tab The Transmitters tab shows a paginated table of all transmitter devices within the iPATH Agility Controller network. Click the TRANSMITTERS tab to view the transmitters page. 4.7.1 Search filters The key fields (Name, Description and Location) all provide a search filter to locate particular items within long lists.
  • Page 48: Transmitters > Configure Transmitter

    iPATH Agility Controller 4.7.3 Transmitters > Configure Transmitter When you click for a particular transmitter, this page lists information about the unit and allows numerous settings to be configured. IP Address Allows you to alter the IP address of the transmitter unit. Any change in address will be enacted when you click the “Save” button at the foot of the page.
  • Page 49: Transmitters > Update Firmware

    Chapter 4: Configuration Hot Plug Detect Signal Period By default this is set at 100ms, which is sufficient for most graphics cards. Occasionally it may be necessary to adjust this. A technical support engineer will advise if necessary. Background Refresh The transmitter sends portions of the video image only when they change.
  • Page 50: The Servers Tab

    iPATH Agility Controller 4.8 The Servers tab The Servers tab shows a table of all servers within the iPATH Agility Controller network. Click the SERVERS tab to view the page. For installations that require greater redundancy, it is possible to have two iPATH Agility Controllers running on the same subnet. If the primary server fails then a secondary server with the same database can take over until the primary unit recovers.
  • Page 51: The Users Tab

    Chapter 4: Configuration 4.9 The Users Tab The Users tab shows a paginated table of all users within the iPATH Agility Controller network. Within the list, the admin user is always present and cannot be deleted - to avoid being locked out of the iPATH Agility Controller system. The username and name details of the admin account, however, can be edited as required.
  • Page 52: Users > Add User Or Configure User Page

    iPATH Agility Controller 4.9.3 Users > Add User or Configure User Page From the View Users page, you can add a new user or configure an existing user: • To add a user: Click the “Add User” option. • To configure an existing user: Click for a user.
  • Page 53: Users > Add User Group Or Configure Group Page

    Chapter 4: Configuration 4.9.4 Users > Add User Group or Configure Group Page From the View User Groups page, you can create a new group or configure an existing group: • To create a new group: Click the “Add User Group” option. •...
  • Page 54: Users > Active Directory

    iPATH Agility Controller 4.9.5 Users > Active Directory To simplify integration alongside existing systems within organizations, iPATH Agility Controller 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.
  • Page 55: The Presets Tab

    Chapter 4: Configuration 4.10 The Presets Tab Presets enable multiple actions to be pre-defined so that they can be initiated with a single action. This feature is particularly useful when switching multiple Agility units, such as in the example below where multiple video heads need to be switched in unison between different server systems, as shown in Figure 4-2: Figure 4-2.
  • Page 56 iPATH Agility Controller The Presets page is where the admin user can create and configure 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 defined by the admin. The permitted connection modes are worked out according to: •...
  • Page 57: Presets > Add Or Configure Presets Page

    Chapter 4: Configuration 4.10.1 Presets > Add or Configure Presets Page From the Presets page, you can add a new preset or configure an existing preset: • To create a new preset: Click the “Add Preset” option. • To configure an existing preset: Click for a preset.
  • Page 58: Operation

    iPATH Agility Controller 5. Operation For non-admin users, iPATH Agility Controller offers a clear way to choose and access multiple channels. 5.1 Logging In 1 On the keyboard connected to your Agility 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 >...
  • Page 59: Hotkey Shortcuts

    Chapter 5: Operation 5.2 Hotkey shortcuts The following standard shortcuts are available for use with the Local OSD (and Remote OSD). These default hotkey combinations 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...
  • Page 60: The Local Osd Screen

    iPATH Agility Controller 5.3 The Local OSD screen Top corner icons Once logged in, the list of channels for which you have permission are Enter ‘Remote OSD’ mode shown in the Local OSD (blue bars) screen. • To choose a channel/preset, click on one of the blue connection Exit ‘Remote OSD’...
  • Page 61: Using The Remote Osd Feature

    Chapter 5: Operation 5.4 Using the Remote OSD feature The Remote OSD feature allows authorized users to access and take control of Agility 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 the following: •...
  • Page 62: Further Information

    iPATH Agility Controller 6. Further information This chapter contains a variety of information, including the following: • Appendix A - Tips for success when networking Agility units • Appendix B - Troubleshooting • Appendix C - Redundant servers: Setting up and swapping out •...
  • Page 63: Appendix A. Tips For Success When Networking Agility Units

    Appendices Appendix A. Tips for success when networking Agility units Agility units use multiple strategies to minimise 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 maximise network efficiency and help minimise data output.
  • Page 64: Creating An Efficient Network Layout

    iPATH Agility Controller A.3 Creating an efficient network layout Network layout is vital. The use of IGMP snooping also introduces certain constraints, so take heed: • Keep it flat. Use a basic line-cascade structure rather than a pyramid or tree arrangement (see note below). •...
  • Page 65: Configuring The Switches And Devices

    Appendices A.4 Configuring the switches and devices The layout is vital but so too is the configuration: • Enable IGMP Snooping on all L2 switches. • Ensure that IGMP Fast-Leave is enabled on all switches with Agility units connected directly to them. •...
  • Page 66: Appendix B. Troubleshooting

    iPATH Agility Controller Appendix B. Troubleshooting Problem: The video image of the Agility receiver shows horizontal lines across the screen. This issue is known as Blinding because the resulting video image looks as though you’re viewing it through a venetian blind. When video is transmitted by Agility units, the various lines of each screen are divided up and transmitted as separate data packets.
  • Page 67: Problem: The Mouse Pointer Of The Agility Receiver Is Slow Or Sluggish When Moved Across The Screen

    Check the video settings on the PC. If the Dither video box option is enabled, disable it. • Apple Mac with Nvidia graphics Use the Black Box utility for Mac’s – Contact technical support. • Apple Mac with ATI graphics Use the Agility Dual series unit with Magic Eye dither removal feature.
  • Page 68 iPATH Agility Controller Problem: iPATH Agility Controller cannot locate working Agility units. There are a few possible causes: • The Agility units must be reset back to their zero config IP addresses for iPATH Agility Controller discovery. If you have a working network of Agility unit’s without iPATH Agility Controller and then add iPATH Agility Controller to the network, the iPath manager will not discover the Agility units until they are reset to the zero config IP addresses.
  • Page 69: Appendix C. Redundant Servers: Setting Up And Swapping Out

    Appendices Appendix C. Redundant servers: Setting up and swapping out This appendix contains two main sections related to the creation and repair of iPATH Agility Controller installations that employ redundancy. • Setting up iPATH Agility Controller redundancy - below • Swapping out an iPATH Agility Controller - on next page Note: When upgrading from a 3.1 redundant system after upgrading the primary iPATH Agility Controller and then the associated devices to 3.3, it is important to remember to upgrade the backup iPATH Agility Controller to 3.3.
  • Page 70: Swapping Out An Ipath Agility Controller

    iPATH Agility Controller C.3 Swapping out an iPATH Agility Controller Once Agility devices have been configured to run with an iPATH Agility Controller, their default IP addresses are automatically changed as part of the installation process. In this state the Agility devices become undetectable to any new iPATH Agility Controller that does not have access to the database of devices.
  • Page 71: Appendix D. Upgrade Licence

    Appendices Appendix D. Upgrade Licence iPATH Agility Controllers are licenced according to the number of devices that can be managed. As your installation grows you can purchase an updated iPATH licence at any time using the following procedure. Four licences are available, ranging from a maximum of 24 managed devices up to a maximum of 288: •...
  • Page 72: Appendix E. Glossary

    iPATH Agility Controller Appendix E. Glossary E.1 Internet Group Management Protocol Where a Agility 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.
  • Page 73 Appendices E.2 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.
  • Page 74 iPATH Agility Controller E.4 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.
  • Page 75 Appendices E.5 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 standardized way to categorize the necessary functions of any standard network. There are seven layers in the OSI model (see Figure C-1) and these define 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 fiber, radio wave, etc.) that carries the data to another user;...
  • Page 76: Appendix F - Ipath Api

    iPATH Agility Controller Appendix F - iPATH API The iPATH API provides access for external applications to key routines used within the iPATH Agility Controller. This appendix provides a reference to the available methods. API version: 3 Changelog • v3 (iPATH v3.2) - added create_preset, delete_preset. •...
  • Page 77 Appendices 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 iPATH user’s login credentials to be presented in the first request. The API will return an authentication code, which must be passed in all future requests.
  • Page 78 iPATH Agility Controller 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 function can be used until the logout function is called. Input parameters: - token - v (the iPATH API version this request is designed for)
  • Page 79 Appendices get_devices This method was last updated in API version 2, and is compatible with API requests from version 2 onwards. This function returns a list of devices. Input parameters: - token - v (the iPATH API version this request is designed for) - device_type (‘rx’...
  • Page 80 iPATH Agility Controller The following property is only returned for transmitters: - count_transmitter_channels (the number of channels containing this transmitter) The following properties are only returned for receivers: - con_exclusive (0/1 - if the last connection is/was in exclusive mode) - con_control (0/1 - if the last connection has/had USB enabled) - con_start_time (start time of last connection e.g.
  • Page 81 Appendices <d_backup_firmware>2.3.16682</d_backup_firmware> <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_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>...
  • Page 82 iPATH Agility Controller <d_date_added>2012-07-13 17:50:04</d_date_added> <d_status>0</d_status> <count_transmitter_channels>3</count_transmitter_channels> </device> </devices> </api_response> get_channels This method was last updated in API version 2, and is compatible with API requests from version 2 onwards. This simple function returns a list of channels available to the authenticated user, for a specific receiver. Input parameters: - token - v (the iPATH API version this request is designed for)
  • Page 83 Appendices Examples Input: /api/?v=2&method=get_channels&token=xxxxx 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> <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> <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>...
  • Page 84 iPATH Agility Controller get_presets This method was last updated in API version 1, and is compatible with API requests from version 1 onwards This simple function returns a list of presets available to the authenticated user. Input parameters: - token - v (the iPATH 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)
  • Page 85 Appendices <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> <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> <exclusive_button>hidden</exclusive_button> </connection_preset> </api_response> 724-746-5500 | blackbox.com Page 85...
  • Page 86 iPATH Agility Controller connect_channel This method was last updated in API version 2, and is compatible with API requests from version 2 onwards This simple function connects a receiver to a channel. Input parameters: - token - v (the iPATH 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_receivers) - view_only (optional, 0/1 - defaults to 0)
  • Page 87 Appendices connect_preset This method was last updated in API version 1, and is compatible with API requests from version 1 onwards This simple function connects all channel-receiver pairs in a preset. Input parameters: - token - v (the iPATH API version this request is designed for) - id - the ID of the preset (acquired from get_presets) - view_only (optional, 0/1 - defaults to 0) - exclusive (optional, 0/1 - defaults to 0)
  • Page 88 iPATH Agility Controller disconnect_channel This method was last updated in API version 2, and is compatible with API requests from version 2 onwards This function disconnects a receiver, a number of receivers, or all connected receivers. Input parameters: - token - v (the iPATH API version this request is designed for) - rx_id (ID(s) of the receiver, as an integer, or comma-separated set of integers.
  • Page 89 Appendices disconnect_preset This method was last updated in API version 1, and is compatible with API requests from version 1 onwards This function disconnects all channel-receiver pairs in a preset, or disconnects ALL connections in the whole iPATH network. Input parameters: - token - v (the iPATH API version this request is designed for) - id (optional.
  • Page 90 iPATH Agility Controller create_preset This method was last updated in API version 3, and is compatible with API requests from version 3 onwards This function creates a new preset. The API user must have admin privileges to call this method successfully. Input parameters: - token - v (the iPATH API version this request is designed for)
  • Page 91 Appendices delete_preset This method was last updated in API version 3, and is compatible with API requests from version 3 onwards This function deletes a preset. The API user must have admin privileges to call this method successfully. Input parameters: - token - v (the iPATH API version this request is designed for) - id (the ID of the preset to be deleted)
  • Page 92 iPATH Agility Controller 724-746-5500 | blackbox.com Page 92...
  • Page 93 About Black Box Black Box Network Services is your source for an extensive range of networking and infrastructure products. You’ll find everything from cabinets and racks and power and surge protection products to media converters and Ethernet switches all supported by free, live 24/7 Tech support available in 60 seconds or less.

Table of Contents