manualshive.com logo in svg

Black Box iPATH ACR1000A-CTL-192, User Manual, Page: 89 / 101

Share
Download
Black Box iPATH ACR1000A-CTL-192 User Manual Download Page 89

89

1.877.877.2269

BLACKBOX.COM

NEED HELP?

LEAVE THE TECH TO US

LIVE 24/7

TECHNICAL

SUPPORT

1.877.877.2269

</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-remote 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)
- 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>
<errors>
<error>
<code>210</code>
<msg>”.$config[‘error_codes’][210].”</msg>
</error>
</errors>
</api_response>

Summary of Contents for iPATH ACR1000A-CTL-192

Page 1: ...USER GUIDE ACR1000A CTL 24 ACR1000A CTL 48 ACR1000A CTL 96 ACR1000A CTL 192 ACR1000A CTL 288 ACR1000A CTL ULT iPATH AGILITY CONTROLLER 24 7 TECHNICAL SUPPORT AT 1 877 877 2269 OR VISIT BLACKBOX COM ...

Page 2: ...demarks of BB Technologies Inc Any other trademarks mentioned in this manual are acknowledged to be the property of the trademark owners We re here to help If you have any questions about your application or our products contact Black Box Tech Support at 877 877 2269 or go to blackbox com and click on Talk to Black Box You ll be live with one of our technical experts in less than 60 seconds ...

Page 3: ...case the user at his own expense will be required to take whatever measures may be necessary to correct the interference Changes or modifications not expressly approved by the party responsible for compliance could void the user s authority to operate the equipment This digital apparatus does not exceed the Class A limits for radio noise emis sion from digital apparatus set out in the Radio Interf...

Page 4: ...breros o gabinetes que impidan el flujo de aire por los orificios de ventilación 10 El equipo eléctrico deber ser situado fuera del alcance de fuentes de calor como radiadores registros de calor estufas u otros aparatos incluyendo amplificadores que producen calor 11 El aparato eléctrico deberá ser connectado a una fuente de poder sólo del tipo descrito en el instructivo de operación o como se ind...

Page 5: ...s 18 4 5 The Dashboard tab 19 4 6 Enabling Remote Support 37 4 7 The Channels tab 39 4 8 The Remotes tab 43 4 9 The Locals tab 48 4 10 The Servers tab 51 4 11 The Users tab 52 4 12 The Presets tab 56 4 13 The Statistics tab 59 CHAPTER 5 OPERATION 60 5 1 Logging in 60 5 2 Hotkey shortcuts 61 5 3 The Local OSD screen 62 5 4 Using the Remote OSD feature 63 APPENDIX A TIPS FOR SUCCESS WHEN NETWORKING ...

Page 6: ...m 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 Manufacturer Stontronics model DSA 60PFB 12 1 120500 part number T5386DV IMPORTANT A defective power adapter MUST only be replaced with the correct unit from Black Box PERMITTED OPERATIONAL AMBIENT CONDITIONS Operating temperature 0 to 40ºC 32 to...

Page 7: ... and remotes Using the intuitive iPATH web based interface one or more administrators can manage potentially thousands of users who are interacting with an almost unlimited number of devices iPATH operates as a self contained compact server including its own DHCP server unit that can be situated anywhere within your network of Agility devices The iPATH server connects to your network and provides ...

Page 8: ...nput to begin operation All configuration of your Agility locals channels remotes and users are performed using the intuitive iPATH browser interface via a network connected computer The iPATH server front panel The iPATH server rear panel In normal use only the network and power connectors are used ringed in red 1 O Agility High Performance KVM C O N T R O L L E R i P A T H Green indicator Power ...

Page 9: ...an IP address Note For the local feed through feature to operate the iPATH server must be at version 4 8 or greater while the endpoints must be at version 4 6 or greater In operation the user of the console at the Agility remote 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 ...

Page 10: ...ed 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 2 2 2 USER TYPES This guide refers to the two main categories of users involved with the iPATH system An Admin administrator user accesses the iPATH system via a network linked computer running an Internet browser Once the necessary username and password have been e...

Page 11: ... user For administrators full access to the iPATH Suite is granted This comprehensive application shows nine main tabbed areas Dashboard Channels Remotes Locals 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 back...

Page 12: ...work connection 3 1 1 NETWORK CONNECTIONS The iPATH server has two network connections on the rear panel port 1 on the left and port 2 on the right These allow the unit to be connected to internal and external network connections respectively as required The external network connection allows admin users located away from the internal network to be able to login Network port 2 supports DHCP howeve...

Page 13: ...on section of this guide In particular do not use an unearthed power socket or extension cable TO CONNECT THE POWER SUPPLY 1 Attach the output connector of the power supply to the power input socket on the left side of the rear panel 2 Connect the main body of the power supply to a nearby earthed mains outlet To switch on the iPATH server unit click the power switch on the front panel Allow 3 minu...

Page 14: ...ssible to downgrade from v4 4 endpoint code Therefore v4 4 iPATH has been designed to run with both v4 3 and v4 4 endpoint code These are both identical in functionality but v4 4 endpoint code uses 4 bit ECC flash and v4 3 uses 1 bit ECC flash To upgrade to v4 5 endpoint code it is necessary to first upgrade to v4 4 Once at v4 4 it is not possible to downgrade However v4 5 does allow a downgrade t...

Page 15: ...ned to be easy to mount within a standard 19 rack but is also suitable for free standing use on the desktop The server chassis requires just a 1U space within the rack TO MOUNT THE IPATH SERVER WITHIN A RACK MOUNT 1 Slide the iPATH server into the vacant 1U space within the rack mount 2 Secure each bracket to the rack using two screws per side as shown below ...

Page 16: ...ted browsers list opposite and enter the default IP address for the iPATH 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 first actions Go to Dashboard Users Click on the furthest right ...

Page 17: ... change the computer s configuration to be able to see iPATH server s new network address IMPORTANT To use subnet operation you must have a DHCP server within your network in order to assign IP addresses to the iPATH and Agility endpoints If subnet operation is used without a DHCP server the Agility endpoints will not communicate with iPATH As a result the iPATH will need a factory reset in order ...

Page 18: ... that they may operate within the network Once Agility units have been added you can use the iPATH server Dashboard to select and further configure any or all of them 4 4 1 IF AN AGILITY UNIT IS NOT LOCATED There are several reasons why an Agility unit might not be located by iPATH The Agility unit has been locally configured or is otherwise not using its factory default setting Try performing a f...

Page 19: ... started which user remote 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 iPATH system See also the Event Log page Latest Channels Created shows the last five channels created wi...

Page 20: ... 24 hours will be hidden 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 specifically to a user will override settings applied to user groups they re in which in turn override this g...

Page 21: ...l 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 remotes Note the admin configuration web pages remain in English Debug Level This allows information to be collec...

Page 22: ...eeds up switching as the graphics card does not have to go through a hotplug detect routine when a new remote is switched to that channel If the new remote has a monitor with a different native resolution then the EDID will be updated to allow for a change in video mode Hot Plug Detect Control Determines whether to enable hot plug detection for monitors By default this is enabled Hot Plug Detect S...

Page 23: ... a Virtual Keyboard is always reported to the USB host It may be necessary to disable this for use with some KVM switches Reserved USB ports This setting lets you set aside a specific number of USB ports up to 8 on the local that can be made available for certain USB devices which require a quirk setting under advanced USB features connected to a remote Note This setting can only be applied global...

Page 24: ...nnel name on the OSD overlay Video Compatibility Check This reads the EDID from the attached monitor and determines whether the monitor is capable of displaying the selected video mode before connecting a channel This prevents the remote 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 Force 60Hz If enabled th...

Page 25: ...k 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 a Black Box reseller For each of the four USB ports on the remote certain rules can be applied dependin...

Page 26: ... servers are reffered 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 th...

Page 27: ...ation whereupon three further Bonding Mode options are displayed Active Backup This can be used when both of the iPATH 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 iPATH server and the switch In this mode one of the iPATH server s network ports will be active ...

Page 28: ...vailable IP addresses to Agility endpoint devices When used in multi subnet mode the internal DHCP server with the iPATH is disabled and instead the iPATH 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 Thi...

Page 29: ...o an external Syslog server Syslog IP Address The address of the external syslog server Note Ensure that this is not set to the iPATH s IP adress as iPATH cannot log its own syslog messages SNMP This option allows the iPATH 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 authe...

Page 30: ...econd part is returned from iPATH 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 ...

Page 31: ...hese entries to pinpoint the current location of the installation 4 5 10 DASHBOARD SETTINGS MAIL This page sets up the email functionality of the iPATH 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 iPATH should be invoked SMTP Domain name IP Enter the name or IP address of the e...

Page 32: ... downloaded as empty AD Enabled Determines whether Active Directory features will be used Account Suffix Enter the account suffix 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 use...

Page 33: ...uarter 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 file to another location IMPORTANT It is advisable to make...

Page 34: ...ts Install Firmware onto Devices Allows you to determine various upgrade settings and then commence the upgrade process 4 5 14 UPGRADING AGILITY FIRMWARE GLOBALLY This method allows the iPATH admin user to upgrade firmware on remotes and locals wherever they are located 1 Use the Upload New TX RX Firmware section to place new local and or remote firmware file s onto the iPATH server Once uploaded ...

Page 35: ...tem these need to be swapped out for Agility ACR1000A R2 endpoints Ensure that your iPATH is running 4 0 40623 If your iPATH has a 4 0 version below this it must be upgraded first Upgrade your Agility ACR1000A units to firmware version 3 7 Ensure the Agility ACR1000A R2 units are running 3 7 This is essential to ensure that the replace device feature works It is not possible to downgrade Agility e...

Page 36: ...B on off shared exclusive mode serial on off Click to end a connection between a remote and a channel 4 5 18 DASHBOARD EVENT LOG This page lists events that have occurred within the iPATH system A drop down list box is available at the top of the page that allows you to filter log page entries to show only particular categories as follows All Lists all events Admin Lists automatic events and or th...

Page 37: ... is enabled Below is a diagram that shows how the feature works Note There have been different versions of this Remote Support feature where the behaviour varies slightly We recommend that you have the latest firmware installed The manager must be connected to a network which has internet access using Ethernet Port 2 On the manager navigate to Dashboard Settings Network You will need to configure ...

Page 38: ... administrator account so that we can access the web interface if required 4 6 1 WEB INTERFACE ACCESS During the Remote Support session we may need access to the iPATH 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 iPATH Administrator Please let us know the user and password that you have created 4 6 2 TROUB...

Page 39: ...in 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 configurable 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 Priv...

Page 40: ...erial Only one remote can use a local s serial port at any time Sensitive This will mark the channel as sensitive within the OSD channels list Allowed Connection This section allows you to define the types of connection that you wish to permit users to make You can define particular individual or combined connection types to suit requirements Note This setting for each channel acts as the final ar...

Page 41: ... 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 use...

Page 42: ...t 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...

Page 43: ...Configure Remote 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 firmware updates that have been applied Identify unit Causes the LED lights to flash on th...

Page 44: ...onnect to a channel The channels permissions displayed to this anonymous user are those that are set for the anonymous user that is defined within the Dashboard Settings page Inherit from Remote Groups When selected the requirement for user login will be determined by the Login Required settings within the Remote Groups to which this unit belongs If ANY of the remote groups to which this remote be...

Page 45: ... local FAE for advice Video Compatibility Check This reads the EDID from the attached monitor and determines whether the monitor is capable of displaying the selected video mode before connecting a channel This prevents the remote 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 Force 60Hz If enabled the remot...

Page 46: ...remote terminal and connect to a channel The channels permissions displayed to this anonymous user are those that are set for the anonymous user defined 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 Yes When selected a user will need to login with the us...

Page 47: ... currently included in this group within the left list and those remotes that are included within the right list To add a remote to this group Highlight one or more use the CTRL key if selecting more than one remote names in the left list and then click to add the name s to the right list To add all remotes to the group Click to move all remote names from the left to the right list To remove a rem...

Page 48: ...for each local Type local type Name Online status IP address Firmware revision of local Channels attributed to each local Presets 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 Configure device Displays the Configure Local page Reboot device Allows you to reboot or reset a uni...

Page 49: ... the maximum bandwidth permissible to the local Range 1 to 95 Video Settings This section allows you to directly adjust various key video controls within the local in order to obtain the most efficient operation taking into account connection speeds and the nature of the video images sent by that local Magic Eye Determines whether the Magic Eye feature should be enabled on Agility not Agility revi...

Page 50: ...ured by the local For video sources that update only infrequently or for those that update very frequently but where high fidelity 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 define the key parameters for the...

Page 51: ...ix entries within the Status column Active This server is functioning as an iPATH server and is administering Agility devices Primary or Solo servers with this status are fully functional iPATH servers that will accept network configuration changes A Backup server with this status is functioning as an Active Primary It will execute channel changes but will not accept network configuration changes ...

Page 52: ...owing 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 Remotes the number of remotes to which the user has access Allow Private indicates whether the user is permitted to access channels in private mode ...

Page 53: ...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 Re...

Page 54: ...the right for details about including and excluding group membership Permissions This section defines 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 channe...

Page 55: ...he 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 filter page and edit your settings Click the Save Sync button to synchronize the selected items into the iPATH user database Active Directory Tips A backup schedule is recommended so that any ...

Page 56: ...ly 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 According to how a preset is configured it is possible to have one or more remotes connected to separate channels i e unicast or multiple remotes connected to a single channel i e multicast The preset allows multiple Agility remotes ...

Page 57: ...ions on the preset are implied by the permissions on the preset s contents 4 12 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 The Add and Configure pages are similar in content Preset Name and Description The Preset Name is m...

Page 58: ...cularly useful in large installations Remote Channel Pairs Pair 1 From the two drop down lists choose a remote 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 define another remote channel pairing Note While channels can be assigned to multiple remotes each remote may only appear once within ...

Page 59: ... also empty the search box and click again Where many devices are listed you can also choose to filter by locals or remotes At the top of the Type column click either to display only locals or click to display only remotes To remove all applied filters 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 w...

Page 60: ...on Ctrl Alt C to display the On Screen Display or OSD this hotkey combination can be altered on the Dashboard Settings Remotes page You will either see the list of channels for which you have permission or be presented with the following login 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 clic...

Page 61: ...monly 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 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 ...

Page 62: ...y numbered shortcuts Click to add this channel as a favorite 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 Filter this column using the specified term Remove the search filter Click to sort the list in ascending order via this column The list is ...

Page 63: ...mbination 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 remotes to which you have access rights Click on the required remote from the list 5 The Remote OSD for the chosen Agility remote will be displayed Remote OSDs always have black horizontal bar...

Page 64: ...ariety of information including the following Appendix A Tips for success when networking Agility Appendix B Troubleshooting Appendix C Redundant servers Appendix D Upgrade licence Appendix E Glossary Appendix F iPATH API Appendix G DHCP server requirements Appendix H Using DHCP option 125 Appendix I Safety information APPENDICES ...

Page 65: ...re 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 Fiber Channel Look for switches that perform their most onerous tasks e g IGMP snooping using multiple dedicated processors ASICS Ensure t...

Page 66: ...le DVI replacements Converters cause Agility local units to massively increase data output Wherever possible create a private network A 3 1 THE RECOMMENDED LAYOUT The layout shown in Figure A 1 below has been found to provide the most efficient network layout for rapid throughput when using IGMP snooping Figure A 1 Recommended layout for networking Agility local and remote units where IGMP snoopin...

Page 67: ...rizontal 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 Agility locals If moving video images are being shown frequently then leave Frame Skipping at a low percentage and instead reduce the Peak bandwidth limiter Where screens are ...

Page 68: ...mbo frames the switches will attempt to break the large packets down into standard packets This process introduces a certain latency and could be a cause for dropped packets One or more Agility units may be using an old firmware version Firmware versions prior to v2 1 exhibited an issue with the timing of IGMP join and leave commands that caused multicast flooding in certain configurations REMEDIE...

Page 69: ...nical support for assistance Replace old VGA adapters on host computers with DVI video cards 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 iP...

Page 70: ...s V After five minutes you should be given the options of Reboot and Factory Reset Choose the Factory Reset option in order to clear this issue 6 You can now configure the secondary server in either of two ways Click the icon to configure the server remotely from the primary server Click the icon to open a restricted page in order to configure the server directly from its own IP address If you use...

Page 71: ...emove the original iPATH Agility Controller from the network Connect the new iPATH Agility Controller in its place and power up 7 All the devices will appear as offline Using a paperclip perform a factory reset on all the Agility endpoints so as they acquire the new certificate and keys All Agility units require a minimum of firmware version 3 3 C 3 2 FOR DUAL IPATH INSTALLATIONS USING REDUNDANCY ...

Page 72: ...isited and reset plus the iPATH database will need to be fully reconfigured 1 Place a new iPATH Agility Controller into the network and then perform a factory reset on every Agility device This will force the Agility units back to their default states whereupon they will announce themselves to the new iPATH Agility Controller 2 Use a computer connected to the same network to login to the new iPATH...

Page 73: ...devices from 192 to 288 D 1 TO UPGRADE YOUR IPATH LICENCE 1 Visit the Dashboard Settings General page of the iPATH unit to be upgraded At the bottom of the page click the upgrade licence link The subsequent file dialog will show a Product Code that is unique to your iPATH Agility Controller 2 Contact your supplier and quote all of the following The unique product code The serial number of the iPAT...

Page 74: ...multicast data ServSwitch Agility units make use of IGMPv2 when performing multicasts to ensure that no unnecessary congestion is caused E 1 2 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 ...

Page 75: ...o frames or Jumbo packets offer advantages for ServSwitch Agility 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 ...

Page 76: ...acket 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 fly 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 ...

Page 77: ...6 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 s...

Page 78: ...dded update_device updated get_devices connect_channel connect_preset create_channel create_preset v4 iPATH v4 1 added create_channel delete_channel updated get_channels v3 iPATH v3 2 added create_preset delete_preset v2 iPATH v2 3 added get_devices get_channels connect_channel disconnect_channel Updated version compatibility information v1 iPATH v1 3 added login logout get_presets connect_preset ...

Page 79: ... 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 iPATH 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 ...

Page 80: ...en 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 errors api_response get_devices This method was last updated in API version 5 and is compatible with A...

Page 81: ...otal 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 offline 1 interface 1 online d_online2 0 interface 2 offline 1 interface 2 onl...

Page 82: ...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 remote groups this remote is a part of count_receiver_presets the number of presets this remote is a part of count_users the number of users who have access to this remote Examples Input api v 2 method get_devices token xxxxx api v 2 method get_devices device_type ...

Page 83: ...clusive 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 pa...

Page 84: ...nels This method was last updated in API version 4 and is compatible with API requests from version 2 onwards This method returns a list of channels available to the authenticated user for a specific remote It was updated in version 4 to include additional information Input parameters token v the iPATH API version this request is designed for page page number to start showing results for default 1...

Page 85: ...d 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...

Page 86: ...rsion 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 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 Output values version the current API version number timestamp ...

Page 87: ... 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...

Page 88: ...his request is designed for c_id the ID of the channel acquired from get_channels rx_id the ID of the remote 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 ...

Page 89: ...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 ap...

Page 90: ... 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 Output ...

Page 91: ...isplay name for the new preset pairs a comma separated list of the channel ID remote 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 curr...

Page 92: ...nse 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 r...

Page 93: ... 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 Output api_response version 3 version timestamp 2012 12 12 12 12 12 timestamp success 1 success id 91 success api_response...

Page 94: ...ers token v the iPATH 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...

Page 95: ...Input parameters token v the iPATH 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 ve...

Page 96: ...Identifier to identify an Agility and supply it with vendor information encapsulated in the Enterprise number 25119 within DHCP option 125 Vendor Identified Vendor Sub Options As of Agility firmware version 4 2 the required vendor information to be encapsulated is Sub option 1 Array of IP addresses of all iPATH servers in the cluster Note Agility will ignore any DHCP OFFER not containing this info...

Page 97: ...ode width 4 length width 1 option vivso iana code 0 string option vivso blackbox code 25119 encapsulate blackbox option option 125 code 125 encapsulate vivso default lease time 3600 max lease time 7200 log facility local7 class blackbox match if option vendor class identifier blackbox subnet 10 0 20 0 netmask 255 255 255 0 pool allow members of blackbox vendor option space blackbox option domain n...

Page 98: ...y iPATH 0a001406 10 0 20 6 Backup iPATH The Enterprise element of hex code is fixed and does not change however the IP Address and lengths A B hex values will change depending on the Agility configuration The first IP address in the list must always be the Primary iPATH Server followed by the Backup then Satellite iPATH s There are a number of online websites that help you convert an IP Address in...

Page 99: ...hose 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 Len...

Page 100: ...ntained within power adapter No user serviceable parts within power adapter do not dismantle Plug the power adapter into a socket outlet close to the module that it is powering Replace the power adapter with a manufacturer approved type only Do not use the power adapter if the power adapter case becomes damaged cracked or broken or if you suspect that it is not operating properly If you use a powe...

Page 101: ... COPYRIGHT 2019 BLACK BOX CORPORATION ALL RIGHTS RESERVED NEED HELP LEAVE THE TECH TO US LIVE 24 7 TECHNICAL SUPPORT 1 877 877 2269 877 877 2269 blackbox com ACR1000A CTL_USER_4 9 ...

Reviews:

No comments