2013 Device Discovery Console User Guide PERPETUAL INNOVATION
Lenel OnGuard 2013 Device Discovery Console User Guide, product version 6.6. This guide is item number DOC-410, revision 3.003, July 2012 Copyright 2008-2012 Lenel Systems International, Inc. Information in this document is subject to change without notice. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Lenel Systems International, Inc. Non-English versions of Lenel documents are offered as a service to our global audiences. We have attempted to provide an accurate translation of the text, but the official text is the English text, and any differences in the translation are not binding and have no legal effect. The software described in this document is furnished under a license agreement and may only be used in accordance with the terms of that agreement. Lenel and OnGuard are registered trademarks of Lenel Systems International, Inc. Microsoft, Windows, Windows Server, and Windows Vista are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Integral and FlashPoint are trademarks of Integral Technologies, Inc. Crystal Reports for Windows is a trademark of Crystal Computer Services, Inc. Oracle is a registered trademark of Oracle Corporation. Other product names mentioned in this User Guide may be trademarks or registered trademarks of their respective companies and are hereby acknowledged. Portions of this product were created using LEADTOOLS 1991-2012 LEAD Technologies, Inc. ALL RIGHTS RESERVED. OnGuard includes ImageStream Graphic Filters. Copyright 1991-2012 Inso Corporation. All rights reserved. ImageStream Graphic Filters and ImageStream are registered trademarks of Inso Corporation.
Table of Contents CHAPTER 1 Introduction............................................. 5 Functions......................................................................5 Supported Device Types..........................................................5 Supported Camera Types.............................................................. 6 Architecture....................................................................7 User Interface..................................................................8 Discovery Services Pane.............................................................. 8 Device List Pane.................................................................... 8 Device Management Pane............................................................. 8 Installation.....................................................................8 WinPcap........................................................................... 8 Bonjour........................................................................... 8 CHAPTER 2 Device Services.......................................... 9 Managing Device Services........................................................9 Add a Device Service........................................................ 9 Edit a Device Service........................................................ 9 Remove a Device Service.................................................... 10 Enable a Device Service..................................................... 10 Disable a Device Service.................................................... 10 Export Device Services...................................................... 10 Import Device Services...................................................... 10 Service Credential Management Tool...............................................10 Add New Account......................................................... 11 Remove Existing Account................................................... 11 Change Password.......................................................... 11 Show All Accounts......................................................... 11 Initialize Configuration File.................................................. 11 Device Discovery Console User Guide 3
Table of Contents Display Help.............................................................. 12 CHAPTER 3 Managing Devices...................................... 13 Device List................................................................... 13 Grouping and Sorting Devices......................................................... 13 Device Status...................................................................... 13 Command Status................................................................... 14 Device Procedures............................................................. 14 Discover Devices........................................................... 14 Filter Devices.............................................................. 14 Ping Device............................................................... 14 Reboot Device............................................................. 15 Get Device Version......................................................... 15 Set Credentials............................................................. 15 Change Device Password..................................................... 15 Import All Device Credentials................................................. 15 Export All Device Credentials................................................. 16 Manually Assign an IP Address................................................ 16 Assign a Range of IP Addresses to Devices...................................... 16 Check for the Default Password................................................ 16 View Device Details......................................................... 16 Remove a Device from the Device List.......................................... 17 4 Device Discovery Console User Guide
CHAPTER 1 Introduction Device Discovery is a utility used for locating and managing IP devices on a network. It consists of the Device Discovery Console and Device Discovery Service. The Device Discovery Console can discover devices in the local subnet, or connect to the Device Discovery Service to find devices on other subnets. Note: Devices located on a different subnet may not be able to launch the device Web page or change IP address. Functions The Device Discovery Console can perform the following functions: Discover device Ping device Reboot device Get version Check default password Change IP Assign a range of IP addresses to devices Supported Device Types The following IP device types are supported: Access controllers (LNL-3300, LNL-2210, and LNL-2220) Cameras Video recorders (govision) Device servers (Lantronix) Access point devices (Lenel ILS) Device Discovery Console User Guide 5
Introduction Function Support by Device Type Discover Device Ping Device Reboot Device Get Version Check Default Password Change IP Assign range of IPs Camera Yes Yes Most a Most b Most c Most d Most e Access Point Device Server Access Controller Video Recorder Yes Yes Yes Yes No Yes Yes Yes Yes Yes Yes No Yes Yes Yes Yes No No No No No Yes Yes R2 only R2 only No Yes Yes a. Not supported for older Panasonic or govision R1 cameras. b. Not supported for older Panasonic or govision R1 cameras. c. Not supported for older Panasonic or govision cameras. d. Not supported for older Panasonic cameras. e. Not supported for older Panasonic cameras. Supported Camera Types The following camera types are supported: Lenel Sony IQEye Axis - new models, with the exception of first generation Axis models: 2100, 2110, 2120, 2130, 2401, 2411, 2420 Panasonic - newer models support the ability for discovery for only 20 minutes after they are powered on. To work around this issue, restart the camera or configure the Network setup > Easy IP Setup setting on the camera Web page. This setting is available with newer firmware versions. Panasonic Camera Display Names Some Panasonic cameras are displayed by their series number rather than their model number in the Device Discovery Console. These cameras will not display their camera model numbers, but instead they display the series of the camera. For example, the Panasonic NS954 is part of the WV-NS950 series and would be displayed as a Panasonic NS950. The following table provides a list of the Panasonic camera series and their display names. Refer to your manufacturer documentation to determine which series your camera belongs to. Panasonic Camera Display Names Series WV-NP244 Series Display name NP240 6 Device Discovery Console User Guide
Architecture Panasonic Camera Display Names Series WV-NF284 Series WV-NS202 Series WV-NS202A Series WV-NW484S Series WV-NS950 Series WV-NW960 Series WV-NF302 Series WV-NP304 Series WV-NP1000 Display name NF284 NS202 NS202A NW484 NS950 NW960 NF302 NP304 NP1000 Architecture The Device Discovery Console installation includes a internal discovery service used to discover devices on the local subnet. To discover devices on other subnets, the Device Discovery Service must be installed on each additional subnet that devices are located. Device Discovery Console User Guide 7
Introduction User Interface The Device Discovery Console user interface consists of three panes, Discovery Services, Device List, and Device Management. Discovery Services Pane The Discovery Services pane is located on the left side of the interface. It can be minimized by clicking the arrows on the Discovery Services title bar.this pane is used to add, modify, remove, import, and export services located in other subnets. Device List Pane The Device List pane is located in the center of the interface. It can be used to scan for devices, select devices for performing operations, or sort devices for easy viewing. Device Management Pane The Device Management pane is located on the right side of the interface, and consists of four accordion buttons: Status, CREDENTIALS, IP ADDRESS ASSIGNMENT, and DEVICE DETAILS. This pane is used to retrieve information from devices, set and change credentials, update IP address assignments, and view device information. Installation The Device Discovery Console and Service can be installed from the OnGuard disc. A custom installation is required to install either the Device Discovery Console or the Device Discovery Service. The Security Utility must be run after the Device Discovery utility is installed. WinPcap WinPcap is a required third-party component and must be installed manually from the Supplemental Materials disc. Bonjour Bonjour is a third-party protocol used to discover device services on a local area network. Bonjour is supported, but not required or installed with the Device Discovery utility. If Bonjour is installed, it will be used for device discovery. 8 Device Discovery Console User Guide
CHAPTER 2 Device Services The Device Discovery Service is installed automatically with the Device Discovery Console to discover devices on the local subnet. The Device Discovery Service can be installed on other subnets to discover devices located on other subnets. Managing Device Services Device Discovery Services located on other subnets can be added, modified or removed from the Device Discovery Console. Device Services can also be exported to a file for later use. Note: Devices located on a different subnet may not be able to launch the device Web page or change IP address. Add a Device Service 1. Click the Add button on the Discovery Services panel. 2. Enter an IP Address / Host Name and Port for the new Discovery Service. 3. Enter the User Name and Password credentials for the Discovery Service. Note: By default the user credentials for the Device Discovery Service are user name lenel and password lenel. These credentials can be changed using the Service Credential Management Tool. For more information, refer to Service Credential Management Tool on page 10. 4. Confirm the password and click [OK]. 5. The new Discovery Service will be added to the list. The current status of the service is displayed below the IP address or host name of the service. Edit a Device Service 1. Select a service from the list in the Discovery Services panel. Device Discovery Console User Guide 9
Device Services 2. Click the Edit button at the bottom of the panel. 3. Modify the user credentials. 4. Click [OK]. Remove a Device Service 1. Select a service from the list in the Discovery Services panel. 2. Click the Remove button at the bottom of the panel. 3. Click [OK] to remove the service from the list. Enable a Device Service 1. Select a service from the list in the Discovery Services panel. 2. Double-click the service or click the Enable button at the bottom of the panel. Disable a Device Service 1. Select a service from the list in the Discovery Services panel. 2. Double-click the service or click the Disable button at the bottom of the panel. Export Device Services To save device service information: 1. Click the Export button located at the bottom of the Discovery Services panel. 2. Choose a file name for the XML file and browse to the save location. 3. Click [Save]. Import Device Services 1. Click the Import button located at the bottom of the Discovery Services panel. 2. Browse to the XML file containing the services you wish to import. 3. Select the file and click [Open]. Service Credential Management Tool The Service Credential Management tool can be used to manage the user credentials or add additional accounts for the Discovery Service. This tool is located in the Device Discovery Service folder. By default, this location is C:\Program Files\OnGuard\Device Discovery Service. The Service Credential Management tool must be run from the Windows Command Prompt on the computer running the Device Discovery Service. 10 Device Discovery Console User Guide
Service Credential Management Tool Add New Account 1. Open the Run dialog by clicking Start > Run. 2. Type cmd and click [OK] to open the Windows Command Prompt. 3. To navigate to the Device Discovery Service folder, type the following command and press <Enter>: cd C:\Program Files\OnGuard\Device Discovery 4. Type the following command, replacing <username> and <password> with the credentials for the new account, and press <Enter>: ServiceCredentialManagement.exe -a <username> <password> Remove Existing Account 1. Open the Run dialog by clicking Start > Run. 2. Type cmd and click [OK] to open the Windows Command Prompt. 3. To navigate to the Device Discovery Service folder, type the following command and press <Enter>: cd C:\Program Files\OnGuard\Device Discovery 4. Type the following command, replacing <username> and with the credentials for the account you want to remove, and press <Enter>: ServiceCredentialManagement.exe -r <username> Change Password 1. Open the Run dialog by clicking Start > Run. 2. Type cmd and click [OK] to open the Windows Command Prompt. 3. To navigate to the Device Discovery Service folder, type the following command and press <Enter>: cd C:\Program Files\OnGuard\Device Discovery 4. Type the following command, replacing <username>, <oldpassword>, and <newpassword> with the credentials you want to update, and press <Enter>: ServiceCredentialManagement.exe -c <username> <oldpassword> <newpassword> Show All Accounts 1. Open the Run dialog by clicking Start > Run. 2. Type cmd and click [OK] to open the Windows Command Prompt. 3. To navigate to the Device Discovery Service folder, type the following command and press <Enter>: cd C:\Program Files\OnGuard\Device Discovery 4. Type the following command and press <Enter>: ServiceCredentialManagement.exe -s Initialize Configuration File 1. Open the Run dialog by clicking Start > Run. 2. Type cmd and click [OK] to open the Windows Command Prompt. Device Discovery Console User Guide 11
Device Services 3. To navigate to the Device Discovery Service folder, type the following command and press <Enter>: cd C:\Program Files\OnGuard\Device Discovery 4. Type the following command and press <Enter>: ServiceCredentialManagement.exe -i Display Help The following procedure will display help for using the Service Credential Management tool. 1. Open the Run dialog by clicking Start > Run. 2. Type cmd and click [OK] to open the Windows Command Prompt. 3. To navigate to the Device Discovery Service folder, type the following command and press <Enter>: cd C:\Program Files\OnGuard\Device Discovery 4. Type the following command and press <Enter>: ServiceCredentialManagement.exe -h 12 Device Discovery Console User Guide
CHAPTER 3 Managing Devices Devices can be managed with the Device Discovery Console. Device List The device list provides a summary of the devices that have been discovered using the Device Discovery Console and any configured discovery services. Grouping and Sorting Devices The order of devices in the device list can be customized using the Group by and Sort by dropdowns. Devices can be grouped by brand, discovery service, device status, or device type. Groups can be expanded or collapsed for easier viewing by clicking the accordion buttons in the device list. The Sort by drop-down provides an order to the device list. Devices can be sorted by brand, model, version, command status, IP address and port, hardware address, discovery service, and device type. Device Status There are three device statuses that may be displayed in the Device List: Online, green circle icon - Device is powered on and has proper connection with the Device Discovery Console Offline, red square icon - Device is powered off or is not connected to the network Unknown, yellow triangle icon - Device is connected to the network, but with an incorrect IP address Note: The Device Discovery Console considers an IP address incorrect if the network address is different than the IP address discovered by the Device Discovery Service. Device Discovery Console User Guide 13
Managing Devices Command Status As commands are performed on devices in the device list the Command Status display will be updated. If an error occurs, the status will be displayed in red. To view a tooltip with more information about the error, position the mouse over the error status in the device list. Command Status Descriptions Get version succeeded - Displayed after a successful Get Version command. Credential invalid - Displayed when the device credentials are incorrect. The device default user credentials are attempted as items are discovered which results in a Credential invalid message for all devices that have changed the default password. Ping succeeded - Displayed after a successful Ping Device command. Credential changed - Displayed after credentials have been updated in the Device Discovery Console. Device Procedures Discover Devices This procedure will scan the currently enabled Discovery Services. 1. Click [Scan], or, if you wish to clear the device list first, select [Scan and Clear List First] from the drop-down. Note: If [Scan and Clear List First] is used, device credentials that have been set on the Device Discovery Console will be reset to the default for that device type. To save device credentials for later use, use the Export command on the CREDENTIALS panel. For more information, refer to Export All Device Credentials on page 16. 2. The discovery service status will display a status of Scanning and devices will appear in the list as they are discovered. Filter Devices To filter the list of devices that appears in the Device List pane: 1. Click the Device filter settings button at the bottom of the Discovery Services pane. 2. On the Device Filter dialog, select the check box for each device you want displayed, then click [OK]. 3. Click [Scan (Clear List First)] to rescan and apply the filter. Ping Device 1. Select one or more devices from the device list. 2. Click [Ping Device]. The Command Status will be updated in the device list for the device with the result of the ping command. 14 Device Discovery Console User Guide
Device Procedures Reboot Device 1. Select one or more devices from the device list. 2. Click [Reboot Device]. The Command Status will be display the status of the reboot as it occurs. Get Device Version 1. Select one or more devices from the device list. 2. Click [Get Version]. The Command Status will be updated to display the result of the get version command. Set Credentials If the device does not use the default credentials, the user name and password must be set in the Device Discovery Console to perform commands on the device. Note: Device credentials are not automatically saved when the device list is cleared. To save device credentials for later use, use the Export command on the CREDENTIALS panel. For more information, refer to Export All Device Credentials on page 16. 1. Select the device from the device list. 2. Expand the CREDENTIALS panel by clicking on the accordion button. 3. Enter the User Name, Password, and Confirm Password fields. 4. Click [Set Credentials]. 5. The Command Status of the device in the device list will be updated to display Credential changed. To verify that the credentials set match those configured on the device, click [Get Version]. If the credentials are correct, the Command Status will display Get version succeeded. If the credentials are incorrect, the Command Status will display Credential invalid. Change Device Password To change the device credentials from the Device Discovery Console: 1. Select the device from the device list. 2. Expand the CREDENTIALS panel by clicking on the accordion button. 3. Select the Apply credentials to device check box. 4. Enter the credentials into the Old Password, New Password, and Confirm New Password fields. 5. Click [Set Credentials]. Import All Device Credentials To load previously entered device credentials into the Device Discovery Console: 1. Expand the CREDENTIALS panel by clicking on the accordion button. 2. Click [Import]. 3. In the Open dialog, browse to the file location and select the file. Device Discovery Console User Guide 15
Managing Devices 4. Click [Open]. The Command Status for each device with saved credentials will be updated to display Credential changed. Export All Device Credentials Device credentials that have been entered into the Device Discovery Console are not retained when the device list is cleared. To save device credentials that for later use: 1. Expand the CREDENTIALS panel by clicking on the accordion button. 2. Click [Export]. 3. In the Save As dialog, enter a File name and browse to the desired save location. 4. Click [Save]. Manually Assign an IP Address Note: Devices located on a different subnet may not be able to change IP address. 1. Select a device from the device list. 2. Expand the IP ADDRESS ASSIGNMENT panel by clicking on the accordion button. 3. Select the Manually assign IP address radio button. 4. Enter a New IP, Subnet Mask, and Gateway IP addresses for the device. 5. Click [Assign IP Address]. 6. Verify that the device displays a status of Change IP succeeded. Assign a Range of IP Addresses to Devices 1. Select one or more devices from the device list. 2. Expand the IP ADDRESS ASSIGNMENT panel by clicking on the accordion button. 3. Select the Assign available IP address from range radio button. 4. Enter an IP for the Start of Range and a higher IP for the End of Range. 5. Enter the Subnet Mask and Gateway IP addresses. 6. Click [Assign IP Addresses]. 7. Verify that the devices display a status of Change IP succeeded. Check for the Default Password It is recommended that you change the default password of devices for security purposes. To verify that devices have had their default password changed: 1. Select one or more devices from the device list. 2. Click [Check for Default Password]. 3. Check the status message in the device list for the default password status of each of the selected devices. View Device Details To view the brand, model, version, hardware address, IP address, port, and discovery service for a device: 1. Select one device from the Device List. 16 Device Discovery Console User Guide
Device Procedures 2. Expand the DEVICE DETAILS accordion button to view the information for the selected device. Remove a Device from the Device List To remove a device from the device list: 1. Select one or more devices from the device list. 2. Click [Remove from list]. The device(s) will be removed from the device list. If a scan is performed, the removed devices will reappear in the list if they are found. Device Discovery Console User Guide 17
Managing Devices 18 Device Discovery Console User Guide
Index A Add device service... 9 new service account... 11 Architecture... 7 Assign a range of IP addresses... 16 B Bonjour... 8 C Camera types supported... 6 Change password camera... 15 device service... 11 Check for the default password... 16 Command status... 14 D Device statuses... 13 Device Discovery Service Service Credential Management tool.. 10 Device list... 8, 13 grouping and sorting... 13 Device management... 8 Device procedures... 14 Devices types supported... 5 Disable device service... 10 Discover devices... 14 Discovery services... 8 Display help Service Credential Management tool.. 12 E Edit device service... 9 Enable device service... 10 Export device credentials... 16 device service... 10 F Features... 5 Filter devices... 14 Functions... 5 support by device type... 6 G Get device version... 15 I Import device credentials... 15 device service... 10 Initialize configuration file... 11 Installation... 8 M Manage device services... 9 Manually assign an IP address... 16 Device Discovery Console User Guide 19
Index P Panasonic camera display names... 6 Ping device... 14 R Reboot device... 15 Remove device service... 10 existing service account... 11 S Set credentials... 15 Show device service accounts... 11 Supported camera types... 6 Supported device types... 5 U User interface... 8 V View device details... 16 W WinPcap... 8 20 Device Discovery Console User Guide
Index Device Discovery Console User Guide 21
Lenel Systems International, Inc. 1212 Pittsford-Victor Road Pittsford, New York 14534 USA Tel 585.248.9720 Fax 585.248.9185 www.lenel.com docfeedback@lenel.com