ADDER.NET [Version 1.10] User Guide AD DER .
The Manager Using the Manager.......................................................................6 Getting started with the Manager..............................................6 Adding new devices.................................................................7 Devices..........................................................................................7 Managing device entries.......................................................11 Advanced Control (Hardware Manager).........................
Welcome Introduction Host - A computer system that is accessible remotely via a KVM-over-IP device. If a KVM-over-IP device serves a single host, then they are usually considered to be the same logical entity and there is no need to separately define the host. Host group - A logical collection of host computers linked to the same or different KVM devices which can be managed collectively and represented by a single entry within ADDER.NET.
getting started the manager The Connector This module can be used by registered users to allow quick access to all of the targets for which they have access rights. Targets may be devices, hosts or device groups, as appropriate. the connector The Manager This module is accessible only to managers and is where details about all devices, hosts and users are configured and stored. ADDER.
Stage 1: Installing the ADDER.NET server To install the ADDER.NET server: 1 Insert the CD-ROM or run the install executable. 2 Follow the on-screen instructions. During the installation, you will be asked to select the link that you will normally use to access the system. Options are: • The host name (e.g. host1), • The fully qualified domain name (e.g. host1.yourcompany.local), or • The IP address (e.g. 192.168.1.22). ADDER.NET’s secure access method requires you to specify how you will address the ADDER.
getting started To log on to ADDER.NET 1 Open your web browser and use the link that you specified during the installation, e.g. host1, host1.yourcompany.local, 192.168.1.22, http:// localhost, etc. ADDER.NET will display the logon page: IMPORTANT To ensure correct operation of ADDER.NET, no device is permitted to use the ‘Force VNC Protocol 3.3’ option. This is because ADDER.NET uses the advanced security features available in VNC protocol 4, and for this reason VNC Protocol version 3.3 is not supported.
The Manager Getting started with the Manager Among its menus, the Manager has three main options to represent the three key areas of information that it holds: • Devices (KVM-over-IP equipment), • Hosts (computers), and • Users. When commissioning a new installation, the starting point usually lies with the Devices, although Hosts or Users may be added at any time.
Adding new devices Browse – Displays the Device Browser page so that you can see a list of the registered devices, each one showing its name, type, status, description, IP address (including port) and location details. Click the Manage button for the required device to see further information. Search – Allows you to enter various criteria on which to search for a particular device. Scan Network – Allows you to define a range of IP address locations in which to seek new devices.
Note: Power control devices (PCDs) will appear in the Other Device Types and from there cannot be properly configured. To add PCDs, use either the manual method or the device autoconfiguration service. the connector Any new KVM-over-IP devices will be shown with a white background containing a checkbox. Click the checkbox to mark the device for inclusion. the manager getting started welcome 3 Click the checkbox(es) of the device(s) that you wish to add and click the Add button.
4 Click the Manage button of the newly discovered device that you wish to configure. The Device Manager page will display connection and control details for the selected device: Indicates the device type as declared by the device itself. Enter the relevant admin password for the device. This password will be used once during the acquisition stage and then discarded from ADDER.NET in order to maintain security.
First, choose the type of device that you wish to add. Enter a name for the device (to aid identification). welcome Tips: Ensure that the device that you seek is switched on, correctly configured and is connected to an IP network that can be accessed by ADDER.NET. If the ADDER.NET server system is on the other side of a firewall from the device(s) that you seek, ensure that an exception is registered with the firewall for port 5900. Please see Appendix 5 - Configuring firewalls for more details.
Managing device entries To manage a device entry 1 On the ADDER.NET Manager menu bar, place your mouse pointer over Devices and then choose Browse from the drop down list. The Device Browser page will show a list of all devices registered within ADDER.NET. Where large numbers of devices are registered within ADDER.NET, you can use the search facility to quickly locate a particular device.
Advanced Control (Hardware Manager) Click to overwrite the host information on the device with the host settings stored within ADDER.NET. This option is only displayed for devices that can store host details. Click this link to reboot the device. Click to discover the current configuration settings of the selected KVM device - these details are required in order to populate the ‘Hardware Configuration’ section (shown right) getting started This is the port through which ADDER.
used as a wildcard character during searches. 2 As required, enter one or more search criteria for the device: • The name of the device, • The description of the device, • The IP address of the device, • The IP Port number of the device, • The Device ID, • The location of the device. • The Status of the device, i.e. whether it has or hasn’t yet been acquired. Note: Any of these fields can use the ‘*’ wildcard character to give a wider match.
Power control devices Altering outlet allocation welcome To alter the allocation of (server and KVM) devices to the power control outlets of the PCD, click the Change button to display the following: To clear an allocation Note: It is not necessary to clear an existing allocation before linking an outlet to a new device; the old association will be broken automatically. 1 Click the checkbox(es) for the required outlet(s) in the Current outlet allocations... area.
Cluster name – enter a unique name for the cluster. Optionally use this field to add further identification information. Devices may be added to the cluster in this section. See the next page for more details To add a device: Highlight the device name in the left hand box and click the ‘Add’ button. the connector the manager To create a device cluster 1 On the ADDER.NET Manager menu bar, place your mouse pointer over Devices and then choose Add Cluster from the drop down list.
To create (and manage) a device cluster (continued) Use this section to determine which users and/ or user groups should be permitted to access the devices and hosts within this cluster. Highlight one or more items within the left hand box (hold down the CTRL key to select more than one item) - then click the Add button to transfer them to the right hand box. When the list of available users/user groups is long, use the filtering tools to reduce the unwanted items within the list.
To search for a device cluster 1 On the ADDER.NET Manager menu bar, place your mouse pointer over Devices and then choose Search Clusters from the drop down list. The ‘Cluster Search’ page will be displayed: welcome To manage a device cluster 1 On the ADDER.NET Manager menu bar, place your mouse pointer over Devices and then choose Browse Clusters from the drop down list. The screen will show a list of all clusters registered within ADDER.
Browse Host Groups – Displays the Host Group Browser page so that you can see a list of all registered host groups. Click the Manage button for the required host group to see further information and make changes. Search Host Groups – Allows you to search for host groups by name or description. Add Host Group – Allows you to create new host groups and to define the host computers to be included and the users/groups that should be permitted access to those hosts.
welcome Optionally enter details for the device that will assist with recognition, physical location, asset status and also allow it to be located using a keyword search. Hot key / port The hot key / port setting depends on the device to which the host is connected: • If a single port device or a VNC Server program is used, then no hot key / port number is required. • If the device has multiple ports then simply specify the port number to which the host is connected as follows: 01, 02, 03...24.
Managing host entries ‘Connect’ or ‘SSH’ To manage a host entry 1 On the ADDER.NET Manager menu bar, place your mouse pointer over Hosts and then choose Browse from the drop down list. The screen will show a list of all hosts registered within ADDER.NET. Where large numbers of hosts are registered within ADDER.NET, use the search facility to quickly locate a particular host. 2 Click the Manage button adjacent to the required host name to display the Host Manager page ð Click to link with the host.
2 As required, enter one or more search criteria for the host: • The name of the host, • The Device or Cluster to which the host belongs, • The description of the host, • The location of the host. 3 Choose the search logic that you wish to apply: • Include hosts that meet ANY of your search criteria, • Include hosts that meet ALL of your search criteria, • Show hosts that DON’T match your search criteria. 4 When all search criteria are in place, click the Search button.
Host groups Host Groups are logical collections of host computers (which may be connected to the same or to different KVM devices) so that common access rights to the host computers within the group can be given to individual users or user groups. If required, one or more Host Groups can be included within other Host Groups to create staged layers of groupings. the manager getting started welcome To create a host group 1 On the ADDER.
welcome To create (and manage) a host group continued Use this section to determine which host computers, host groups and/or devices/device clusters should be included within this host group. Use this section to determine which users and/or user groups should be permitted to access this host group. Highlight one or more items within the left hand box (hold down the CTRL key to select more than one item) - then click the Add button to transfer them to the right hand box.
To search for a host group 1 On the ADDER.NET Manager menu bar, place your mouse pointer over Hosts and then choose Search Host Groups from the drop down list. The ‘Host Group Search’ page will be displayed: welcome To manage a host group entry 1 On the ADDER.NET Manager menu bar, place your mouse pointer over Hosts and then choose Browse Host Groups from the drop down list. The screen will show a list of all host groups registered within ADDER.
To add a new user 1 On the ADDER.NET Manager menu bar, place your mouse pointer over Users and then choose Add from the drop down list. The New User page will be displayed: 2 When all details have been completed for the new user, click the Submit Changes button. The details will be stored within the ADDER.NET database. ADDER.NET will then display the User Manager for the new user, from where it is possible to set up and modify the access privileges of the new user. Enter the name of the new user.
Determines whether the user can see all areas (Manager) or just the Connector 3 When all details in the upper section of the page have been completed, click the Submit Changes button. The details will be stored within the ADDER.NET database. Choose the language in which the ADDER.NET menus, entry labels, error messages, defined values, etc. should be presented to the user. Indicates which targets the user has selected as “Favourites. Optional description for the user.
User Groups provide a simplified means to administer access rights collectively to any number of individual users. Where necessary, one or more User Groups can be included within other User Groups to create staged layers of grouping. To create a user group 1 On the ADDER.NET Manager menu bar, place your mouse pointer over Users and then choose Add User Group from the drop down list.
To create (and manage) a user group continued Use this section to determine which targets (devices, device clusters, hosts and/or host groups) the members of this user group should be permitted to access. Highlight one or more items within the left hand box (hold down the CTRL key to select more than one item) - then click the Add button to transfer them to the right hand box. When the list of available targets is long, use the filtering tools to reduce the unwanted items within the list.
To search for a user group 1 On the ADDER.NET Manager menu bar, place your mouse pointer over Hosts and then choose Search User Groups from the drop down list. The ‘User Group Search’ page will be displayed: welcome To manage a user group 1 On the ADDER.NET Manager menu bar, place your mouse pointer over Hosts and then choose Browse User Groups from the drop down list. The screen will show a list of all user groups registered within ADDER.
Tools Time period (in minutes) of inactivity after which ADDER.NET will automatically logout for security purposes. Determines the language that the system will use, unless over-ridden by user preference. getting started the manager Alerts – This options displays a complete list of all operational alerts that have been generated by the ADDER.NET server in response to events and states which may require attention. Individual alerts are also presented within the various relevant sections of ADDER.NET.
To access the Active Directory controls 1 On the ADDER.NET Manager menu bar, place your mouse pointer over Tools and then choose Active Directory from the drop down list. The Active Directory Update page will be displayed. From this page you can configure the main parameters that determine access to the external Active Directory: Using SSL (LDAPS and Windows) When the ‘Use SSL’ option is selected, ADDER.NET requires that your Domain Controller be set-up to use secure-LDAP [LDAPS].
The Check/Delete drop down box works in association with the check boxes that are located directly above. You can use the ‘Select All’ option to include every folder. • When ‘Check’ is selected, click the Go button to preview the results of an import procedure as determined by the folders that are selected. The preview results are presented in the User Count and Group Count columns and also in the Check Results section in the lower portion of the screen.
the manager The timing box changes depending upon the type of import interval. Use the appropriate box to specify how often synchronisation should take place with the external directory. getting started Enter/edit a description for this import schedule the connector To create or edit an update schedule 1 Within the Active Directory Import page, click the Schedule automated imports link. If one or more import schedules already exist, they will be listed. Either click the Edit...
Using logs ADDER.NET provides a status logging system where messages generated by all registered devices can be viewed centrally. This feature saves you having to access each device individually. Use the Date ranges to define a suitable time period The device filter section can be used in two ways: • Specify a range of IP address (‘from’ and ‘to’) to display logs from all qualifying devices. getting started welcome To view logs 1 On the ADDER.
Device auto-configuration welcome getting started the manager 2 Within the appropriate device parameters section, click the Change button for the Enable option and then change the setting to Yes. the connector Provided all of the requirements listed above are met (and auto-configuration is enabled - see opposite), each new device will be automatically acquired by ADDER.NET and added to the list of devices. From there you can edit and configure the entry in the usual manner.
The Connector Accessing the Connector Searching for hosts, devices or clusters To access the Connector module The Connector is accessible in two main ways, either: • Directly from the logon page if you are not authorised to view the ADDER.NET Manager module, or • From within the Manager module: Click the Connector option from the Manager menu bar.
Using hosts To view information about a host, device or cluster 1 Locate the required host, device or cluster entry within the Connector page. 2 Click the icon. or Click Connect/SSH button to link with the host. Opens either a VNC window (for a KVM connection) or a PuTTY window (for a secure serial connection via a Console CAM) as appropriate to view/ control the host. getting started 2 Click the icon. • To remove a favourite: click the icon.
Connector preferences 3 Alter the value of the option and click the Change button to store it. 4 Select any other option from the menu bar to leave the Preferences page. the connector the manager 2 Click the Change button adjacent to the required option. The chosen option will now allow you to alter its value: getting started welcome To access the Connector preferences 1 On the ADDER.NET Connector menu bar, choose the Preferences option.
Further information I cannot make a connection to the required host. • Ensure that you have installed the VNC-URI client on you computer. How do I backup the installation? • ADDER.NET takes daily backups automatically. You can also take separate backups (to any destination) at any time. Please see Appendix 3: Backing up and restoring. • Email – support@adder.
3 User’s VNC viewer uses established that provides access to the requested host computer. User getting started 4 A VNC session is 4 KVM-over-IP device Host PC 1 The user’s VNC Viewer requests access to a specific host computer. 1 5 2 ADDER.NET sends T MI AD NE O Host PC a secure ticket back to the user giving timed access to the host computer. 2 ADDER.NET Access Log 5 All activities are fully logged within ADDER.
Appendix 2 - What are S3 connections? 4 User’s VNC viewer uses Notes: It is recommended that S3 is always used when managing the above devices. Connections can still be made with other devices, however, tickets will always be used in place of S3. • Client PCs must have ADDER.NET v1.7 or later VNC-URI Client software. The ADDER.NET v1.6 (and earlier) VNC-URI Client software will not work. It typically connects to the device but without authentication so the user is prompted for a password.
\\computer\directory\name.ldif saves file on a remote computer in specified directory. ADDER.NET does not maintain a list of manual backup files, it just provides access to the default backups directory. As such, the last two examples above are not directly accessible for the restore function and would need to be manually copied into the backups directory before they could be used. To enable a complete recovery of the server, it is also necessary to take a backup of the server’s cryptographic keys.
welcome getting started the manager To fully recover an ADDER.NET installation, the following steps are necessary: 1 Install ADDER.NET 2 Stop ADDER.NET 3 Replace the complete keys directory with the backed-up keys directory. 4 Copy the backed-up database file into the backups directory. 5 Start ADDER.NET 6 Login as admin 7 Use the Backup & Restore page to select and recover the main database file.
Appendix 4 - Firmware upgrades Select the appropriate upgrade file here Choose the device(s) of the selected type that you wish to upgrade getting started the manager 5 Select the required upgrade(s). The page will display information about the upgrade and will also list all of the registered devices to which this upgrade is applicable. If an upgrade is not applicable to a device, that device will not be shown in the list.
Appendix 5 - Configuring firewalls Port Number 80 * 443 * 123 514 1132 Protocol TCP TCP UDP UDP TCP getting started For Users Users Devices Devices Devices Reason Unencrypted web access Encrypted web access Device clock synchronisation Device status (if in-use) information Devices connecting to ADDER.NET * If ADDER.NET has been installed using non-standard ports, then the ports actually in use, rather than 80 and 443 need to be opened.
Appendix 6 - Console server connections To solve connection problems In certain cases, you may find that connections to Serial CAMs fail due to them slightly exceeding the default timeout period of 15 seconds. If you experience such failures, extend the timeout period as follows: 1 On the ADDER.NET Manager menu bar, place your mouse pointer over Tools and then choose Configure ADDER.NET from the drop down list. 2 Change the S3 Timeout option to 20000 (20 seconds).
U Active Directory import 31 import options 32 setting 30 synchronisation 33 Add device manually 10 Admin access loss of 43 Advanced Control hardware manager 12 Alerts 30 Auto-configuration 35 Device auto-configuration 35 Device Browser 8 Device cluster add new 15 manage 17 Search 17 Device Manager 9,11 Devices adding 7 Device Search 13 Distinguished Name 31 Hardware Manager 12 Host groups 22 add new 22 manage 23,24 search 24 Hosts 18 add new 18 manage 20 search 21 using 37 Ping 11 Power control in the
welcome Tel: +65 6288 5767 Fax: +65 6284 1150 the manager Adder Asia Pacific 6 New Industrial Road, Hoe Huat Industrial Building #07-01, Singapore 536199 the connector Adder Corporation, 350R Merrimac Street, Newburyport, MA 01950, United States of America Tel: +1-888-932-3337 Fax: +1-888-275-1117 Adder Technology Limited, Technology House, Trafalgar Way, Bar Hill, Cambridge, CB23 8SQ, United Kingdom Tel: +44 (0)1954 780044 Fax: +44 (0)1954 780081 getting started © 2011 Adder Tec