Outdoor Wireless Solution Pharos Control User Guide REV1.0.
Contents Contents ............................................................................................................... I Chapter 1 Quick Start Guide ............................................................................... 1 1.1 Introduction .............................................................................................................. 1 1.2 Installation ...............................................................................................................
Chapter 8 Log ..................................................................................................... 63 8.1 Log Classification ................................................................................................... 64 8.2 Log List .................................................................................................................. 65 8.3 Log Details .............................................................................................................
Pharos Control User Guide Chapter 1 1.1 Quick Start Guide Introduction Pharos Control is a client-server based network management system application that allows for the centralized management and maintenance over the entire network formed by TP-LINK Pharos devices. It provides the following main features: Discover Pharos devices in the same subnet with the server. Connect devices and monitor their status: The Pharos Control server will monitor the status updates of those devices under management.
Pharos Control User Guide RAM may be able to serve around 50 devices while a few thousand managed devices may require a better performing multi-core machine with 2-3GB dedicated memory. The server and client installers are provided for windows XP/Vista/7/8 and Server. Server and Client Location: Ensure the managed devices are in the same subnet with the server on which the Pharos Control server is installed. The client machine can be either in the subnet with the server or in the Internet.
Pharos Control User Guide Step 2. Unzip the file and double click the PharosCtrol.exe file . Please wait for the InstallShield Wizard preparing the setup shown as the following screen. Figure 1-2 Preparing to Install Step 3. Then the following screen will appear. Please close all the antivirus software for the installation and click OK to continue.
Pharos Control User Guide Step 4. Then the following screen will appear. Click Next to continue. If you want to stop the installation, click Cancel. Figure 1-4 Welcome to the InstallShield Wizard Step 5. Choose the destination location for the installation files and click Next to continue.
Pharos Control User Guide By default, the installation files are saved on the Program Files folder of system disk. Click the Browse button to modify the destination location as needed. Step 6. Take server’s installation as an example here. Select Pharos Control Server and click Next.
Pharos Control User Guide Step 7. The following screen shows the default settings of the server. You can customize the server port number, the username and password here. Click Next to continue. Figure 1-7 Server Config Step 8. Till now, the Wizard is ready to begin the installation. Click Next to start the installation on the following screen.
Pharos Control User Guide Step 9. The InstallShield Wizard is installing the software, shown as the following screen. Please wait.
Pharos Control User Guide Step 10. On the following screen, click Finish to complete the installation and launch the Pharos Control Server. Figure 1-10 Complete Installation 1.3 Before Login Ensure the server is reachable from the client before login. If the server is behind an NAT gateway, please refer to the gateway’s reference guide to open the corresponding port as configured in Figure 1-7 if you want to access the Pharos Control Server from the Internet.
Pharos Control User Guide Chapter 2 2.1 Pharos Control Interface Pharos Control Server Double click at the bottom right corner of the taskbar to open the Pharos Control Server Monitor Window: Figure 2-1 Server Monitor The upper half of the window displays the running status of the server. The lower half contains corresponding operation buttons. Server status: Displays the server’s status. Server port: Displays the server’s listening port number.
Pharos Control User Guide : View the running logs of the server. : Shut down the server. : Backup the database. : Configure the Server’s port and whether it will run automatically at boot. : Start the server. : Reset the server to factory settings, which will lose the user’s current configuration. : Shut down the server and close this window.
Pharos Control User Guide Open the Server Monitor Window. Configure the Server’s port and whether it will run automatically at boot. Restart the server. Start the server. Shut down the server. Reset the server to factory settings, which will lose the user’s current configuration. Backup the database. Restore the database with a previous backup. Shut down the server and close this window. 2.2 Pharos Control Client 2.2.
Pharos Control User Guide Figure 2-3 Login the Client 2.2.2 Client Interface Overview The Client’s typical interface is shown as Figure 2-4. Section A is entry category. Section B is entries under the selected category and the corresponding buttons. Section C is the detailed information of the selected entry. The red box marked at the top of this window is the notification message box.
Pharos Control User Guide Figure 2-4 Typical Interface 2.2.3 Navigation Use the top level navigation tabs to access different functions. Figure 2-5 Navigation Tabs Device page displays Pharos devices managed by Pharos Control. Firmware page allows managing firmware files saved in the Pharos Control Server. Task page allows viewing and editing scheduling tasks. Trigger page allows managing triggering rules and events. Account page allows viewing and managing all the users’ accounts.
Pharos Control User Guide Chapter 3 Device Device Tab is used to view and classify the Pharos devices for ease of navigation, including Device Classification, Device List and Device Details.
Pharos Control User Guide 3.1 Device Classification Device Classification is in Section A of the Device Tab. Figure 3-2 Device Classification Devices can be categorized into several groups in Section A. “All devices” and “Auto grouping” are dynamic groups, in which devices are automatically added and removed. Under the “Auto grouping”, Managed and Unmanaged are built-in groups. User can also create a new group and define its corresponding search criteria.
Pharos Control User Guide Figure 3-3 Customized Group Manual Grouping: Devices in this static group are added or removed by the users manually. Operations: Maximize the current window. Add a new group. Delete the selected group. Edit the name of the selected group. Note: The Managed and Unmanaged folder under Autogrouping cannot be edited or deleted.
Pharos Control User Guide 3.2 Device List Device List is in Section B of the Device Tab. Figure 3-4 Device List Device List displays the device information of the selected group. Entry Introduction: Device name: Name of the device. Status: Status of the device, including Managed, Unmanaged or Error. Managed indicates the device is reachable and under management. Unmanaged indicates the device either cannot reach Pharos Control or is down.
Pharos Control User Guide Product: The device’s model and version. Version: The device’s software version. SNR: Signal Noise Ratio. Tx Rate: Displays the data rate at which the device transmits wireless packets. Rx Rate: Displays the data rate at which the device receives wireless packets. Tx Total: The total wireless packets that the device has transmitted. Rx Total: The total wireless packets that the device has received. CPU Usage: The device’s CPU usage.
Pharos Control User Guide The following figure shows the device’s status transition in Pharos Control. Figure 3-5 Status Transition Operations: Search the devices in the same subnet with the server. The discovering process and results are displayed in the Device Details window. Ensure the Discovery function is enabled on the Management Tab->Miscellaneous page of the Pharos series products, so that they can be discovered by Pharos Control. Maximize the current window.
Pharos Control User Guide Add a new device model manually. Enter the related information of the device to be added and click OK to save. Product: Select the device model from the pull-down list. Device Name: Enter the device’s name. Mode: Select the device’s operation mode from the pull-down list, including Auto, Access Point, Client, Repeater, Bridge, AP Router and AP Client Router. IP Address: Enter the device’s IP address. MAC Address: Enter the device’s MAC address.
Pharos Control User Guide Click to edit the information of the selected device. Edit the related information of the selected device and click OK to save. Product: Select the device model from the pull-down list. Device Name: Edit the device’s name. Mode: Select the device’s operation mode from the pull-down list, including Auto, Access Point, Client, Repeater, Bridge, AP Router and AP Client Router. IP Address: Edit the device’s IP address. MAC Address: Edit the device’s MAC address.
Pharos Control User Guide Upgrade the software of the device being managed. Click this button and the Upgrade confirmation window will pop up. Please note that only the device being managed will show up in this window. For information about how to manage the device, please refer to Start manage. In this window, select the target device and the corresponding firmware file, and click OK to upgrade the device. The firmware files should be uploaded to the server in advance.
Pharos Control User Guide Reboot the selected devices. Click this button and the Reboot confirmation window will pop up. Select one or multiple devices in this window and click OK to reboot them. Device Name: The device’s name. IP Address: The device’s IP address.
Pharos Control User Guide Click this button to add scheduled tasks. Add the scheduled tasks in this window and click OK to save. Name: Enter the scheduled task’s name. Scheduled: Configure the scheduled execution time. Once: This scheduled task will be executed once. Date: Specify the task’s execution time. Cycle: This scheduled task will be executed periodically. From: The start time of the execution period. To: The end time of the execution period.
Pharos Control User Guide Click the menu button (or right click any device entry below) to display all the operations available. Operations without corresponding buttons are introduced below: Start Manage: Select the unmanaged device in the list below to manage it. Its username, password and SSH port number should be configured in advance in Edit Managing Option.
Pharos Control User Guide Ping: Click this to ping the selected device. Configure the parameters related to the ping operation, and click OK to save. Count: The amount of times to send ping request during the test. Timeout: Specify the timeout time of the ping test. Device Name: The name of target device. IP Address: The IP address of target device. Open Web UI: Open the Web interface of the selected device. It is opened in the default browser by default.
Pharos Control User Guide Add to Group: Add the selected device to the user-defined group. Enter a key word to search all the columns in the device list below, and a partial text match will be highlighted. 3.3 Device Details Device Details is in Section C of the Device Tab. Device Details contains 5 sub tabs: General, Discover, Reboot, Upgrade and Ping. Every sub tab divides into two windows. General Tab: The left window of Section C displays the detailed information of the selected device.
Pharos Control User Guide Figure 3-6 Device Details Attribute: This column displays the name of the device’s attribute, including device name, status, mode, MAC address, IP address, SSID, root AP SSID, Product, SNR, Tx rate, Rx rate, Tx total, Rx total, CPU load, CPU frequency, memory usage, memory size, client number, Transmit CCQ, version and description. Value: The corresponding value of each attribute.
Pharos Control User Guide Suspend/Continue the current graphic displaying. Click this button to configure the attribute set. Click Add set to add a new attribute set. Select the attributes to be displayed, and click OK to save. Name: Enter the name of the new attribute set. Attribute: The name of the attribute. Description: The description of the attribute. Tx Rate: Displays the data rate at which the device transmits wireless packets.
Pharos Control User Guide Click Manage set to configure the existed attribute sets. In this window you can edit each set’s attributes or delete the set, and click OK to save. (Please note that you cannot delete or edit a set’s attribute when the set is being displayed.) Delete: Click this button to delete the selected set. Attribute: Check the boxes to choose the attributes contained in the selected set. Select the set to display the changes of its attributes in real-time.
Pharos Control User Guide Discover Tab: The left window of Section C displays the discovery operation list. Figure 3-8 Discovery List Entry introduction: Queue Total: The total number of the discovery operations in the list below. Completed: The total number of the completed discovery operations in the list below. Failed: The total number of the failed discovery operations in the list below. Name: Displays the name of the discovery operation distinguished by the time it was carried on.
Pharos Control User Guide The right window of Section C displays the progress bar of the selected discovery operation and its result. Figure 3-9 Discovery Status Entry introduction: Discovery: The time when the discovery operation begins. Status: The status of the discovery operation. Progress: The progress of the discovery operation. New: This table lists the newly discovered devices in this operation which are not in the list of 3.2 Device List.
Pharos Control User Guide Reboot Tab: The left window of Section C displays the reboot operation list. Figure 3-10 Reboot List Entry introduction: Queue Total: The total number of the reboot operations in the list below. Completed: The total number of the completed reboot operations in the list below. Failed: The total number of the failed reboot operations in the list below. Name: Displays the name of the reboot operation distinguished by the time it was carried on.
Pharos Control User Guide The right window of Section C displays the progress bar of the selected reboot operation and its result. Figure 3-11 Reboot Status Entry introduction: Reboot: The time when the reboot operation begins. Status: The status of the reboot operation. Device Name: The name of the device. Progress: The progress of the reboot operation. Upgrade Tab: The left window of Section C displays the upgrade operation list.
Pharos Control User Guide Completed: The total number of the completed upgrade operations in the list below. Failed: The total number of the failed upgrade operations in the list below. Name: Displays the name of the upgrade operation distinguished by the time it was carried on. Status: Displays the result of the upgrade operation. Operations: Clear all the upgrade operation lists in this tab. Delete the selected upgrade operation entry.
Pharos Control User Guide Ping Tab: The left window of Section C displays the ping operation list. Figure 3-14 Ping List Entry introduction: Queue Total: The total number of the ping operations in the list below. Completed: The total number of the completed ping operations in the list below. Failed: The total number of the failed ping operations in the list below. Name: Displays the name of the ping operation distinguished by the time it was carried on.
Pharos Control User Guide The right window of Section C displays the information of the selected ping operation and its result. Figure 3-15 Ping Status Entry Introduction: Ping: The total number of the ping operations in the list below. Status: Displays the status of the ping operation. Device name: The name of the device. IP Address: The IP address of the device. The window in the right displays the detailed ping operation result.
Pharos Control User Guide Chapter 4 Firmware Firmware Tab is used for managing the firmware files in the server, including Firmware Classification, Firmware List and Firmware Details. Figure 4-1 Firmware Tab 4.1 Firmware Classification Firmware Classification is in Section A of the Firmware Tab.
Pharos Control User Guide Firmware files can be categorized in Section A. Users can customize groups to save firmware files uploaded into the server. All the groups are under the root Firmwares by default. Entry Introduction: Firmwares: List all the firmware files saved in the server. CPE-210: The manually added firmware group. Operations: Maximize the current window. Add a new firmware group. Delete the selected firmware group. Manage the selected group.
Pharos Control User Guide Machine Type: The firmware file’s applicable product models. Version: The firmware file’s version. 4.2 Firmware List Firmware List is in Section B of the Firmware Tab. Figure 4-3 Firmware List Firmware List displays the firmware files’ information of the selected group. Entry Introduction: File Name: Name of the firmware file. Software Version Software version of the firmware file. Hardware Version: Hardware version of the firmware file.
Pharos Control User Guide Delete the selected firmware file from server. Activate the selected firmware file. The firmware file is activated by default when it’s uploaded. Deactivate the selected firmware file to remove it from the applicable list when users upgrade the devices. Click the menu button (or right click any device entry below) to display all the operations in this window.
Pharos Control User Guide Status: The firmware file’s status, including activated and deactivated. The deactivated firmware file cannot be used to upgrade devices. Software Version: The software version of the firmware file. Hardware Version: The hardware version of the firmware file. Uploader: The uploader of the firmware file. Upload Date: The upload date. Build Date: The firmware file’s build date and version. Support List: The product models that this firmware file supports.
Pharos Control User Guide Chapter 5 Task Task Tab is used for editing the scheduled tasks and viewing their running status. This tab includes Task Classification, Task List and Task Details.
Pharos Control User Guide 5.1 Task Classification Task Classification is in Section A of the Task Tab. Figure 5-2 Task Classification Tasks are categorized into four groups: Scheduled, Running, Completed and Failed. These four categories cannot be edited or deleted. Click the corresponding folder to view its tasks. Entry Introduction: Scheduled: The scheduled tasks which are not executed yet. Running: The running tasks. Completed: The completed tasks. Failed: The failed tasks.
Pharos Control User Guide 5.2 Task List Task List is in Section B of the Task Tab. Figure 5-3 Task List This section is used to manage the scheduled tasks. Please note that the function of adding tasks is on the Device Tab. Different devices have different operation buttons and entries. Scheduled: Figure 5-4 Scheduled Task List Entry Introduction: Schedule Name: The name of the scheduled task. Action: The action to be executed, including Discovery, Reboot and Firmware upgrade.
Pharos Control User Guide Schedule by: The creator of the task. You can sort the entries on a specific column by simply clicking the column name. Operations: Maximize the current window. Delete the selected task. Click to edit the information of the selected task entry. Activate the selected task. The scheduled task is activated by default when it is created. Deactivate the selected task to make it inactive. Run the selected task immediately.
Pharos Control User Guide Status: The current status of the task. Start Time: The start time of the task. Operations: Maximize the current window. Enter a key word to search all the columns in the task list below, and a partial text match will be highlighted. Completed Figure 5-6 Completed Task List Entry Introduction: No. : The sequence number. Task Name: The name of the task and its start time. Action: The action of the task, including Discovery, Reboot and Firmware upgrade.
Pharos Control User Guide Delete the selected task record. (multiple) Displays the 50 tasks recently completed. The previous page. The next page. Displays the 50 tasks firstly completed. Click the menu button (or right click any task entry below) to display all the operations in this window. Enter a key word to search all the columns in the task list below, and a partial text match will be highlighted. Failed Entry Introduction: No. : The sequence number.
Pharos Control User Guide The next page. Displays the 50 tasks firstly failed. Click the menu button (or right click any task entry below) to display all the operations in this window. Enter a key word to search all the columns in the task list below, and a partial text match will be highlighted. 5.3 Task Details Task Details is in Section C of the Task Tab. Different kinds of task corresponds to different details window.
Pharos Control User Guide Chapter 6 Trigger Trigger Tab is used to configure and manage the trigger rules and trigger events saved in the server. This tab includes Trigger Rules and Trigger Events Classification, Trigger Rules/Events List and Trigger Rules/Events Details. Figure 6-1 Trigger Tab 6.1 Trigger Rule and Event Classification Trigger Rule and Event Classification is in Section A of the Trigger Tab.
Pharos Control User Guide Trigger events are divided into two folders: Checked and Unchecked. The unread trigger events are saved in the Unchecked folder, and the read trigger events are saved in the Checked folder. Operation: Maximize the current window. 6.2 Trigger Rule/Event List Trigger Rules/Events List is in Section B of the Trigger Tab. Trigger rules and events have different operation buttons and lists.
Pharos Control User Guide Add new trigger rules. Name: Enter the name of the trigger rule. Assign meaningful names to rules that will easily identify them. Device Group: Limit the trigger rule to a specified device group defined in 3.1 Device Classification. Condition: Specify the status changes. The status includes Unmanaged, Managed and Error. Action: An email notification will be sent when the specified trigger occurs. Configure the recipient address and subject of the email.
Pharos Control User Guide Trigger Events: Figure 6-4 Trigger Event List Trigger events divide into two types depending on whether the notification email has been read: Checked Entry Introduction: Trigger name: The name of the trigger Device name: The device on which the event happened. Time: The time when the trigger event happened. Type: The transition of the device status. Action: The action that was taken after the event triggered. Operations: Maximize the current window.
Pharos Control User Guide Time: The time when the trigger event happened. Type: The device’s status transition type. Action: The action that was taken after the event triggered. Operations: Maximize the current window. Delete the selected trigger event. Set the selected unchecked event as checked. Click the menu button (or right click any trigger event below) to display all the operations in this window.
Pharos Control User Guide Action: Action to take on device status changes. (only supports email notification) Receiver: The recipient of the notification email on the trigger event. Subject: The subject of the notification email. Trigger Events: Figure 6-6 Trigger Event Details Attribute: The name of the trigger event’s attribute. Value: The attribute’s corresponding value. Trigger Name: The name of the trigger event. Device Name: The device on which the event happened.
Pharos Control User Guide Chapter 7 Account Account Tab is used to create or edit user accounts for this system. You can assign different privileges to different user accounts by assigning them to different account groups (Administrator, Manager or Guest). This tab includes Account Classification, Account List and Account Details.
Pharos Control User Guide 7.1 Account Classification Account Classification is in Section A of the Account Tab. Figure 7-2 Account Classification User Accounts are categorized into three groups: Administrator, Manager and Guest. These three categories cannot be edited or deleted. Click the folder to view its corresponding accounts.
Pharos Control User Guide Different user accounts and their privileges: Account Administrator Manager Guest √ X X √ X X Upgrading device firmware √ √ X Uploading firmware files √ √ X Device page and viewing √ √ X Privilege Downloading firmware files and editing scheduled tasks Connecting devices to the system Accessing all functions of the the System Log Table 7-1 Accounts and Privileges Operation: Maximize the current window. 7.
Pharos Control User Guide Entry Introduction: Name: The name of the user account. Role: The role of the user. Login: Whether the user logs in. E-mail: The email address of the user. Telephone: The telephone number of the user. Notes: Notes about this account. You can sort the entries on a specific column by simply clicking the column name. Operations: Maximize the current window.
Pharos Control User Guide Add a new user account. Role: Specify the user’s role. It is Manager by default. The illustrations bellow shows that the manager has the privileges to view the status of all devices and change configurations of all devices, but it cannot change the configurations of the server. User Name: Enter the user name. Password: Enter the user’s password. Confirm: Re-enter the password for confirmation. E-mail: Enter the user’s email address. Telephone: Optional.
Pharos Control User Guide Edit the selected user account information. Note: The user’s role and user name cannot be edited if it is currently logged in. Click the menu button (or right click any account entry below) to display all the operations in this window. Enter a key word to search all the columns in the account list below, and a partial text match will be highlighted. 7.3 Account Details Account Details is in section C of the Account Tab.
Pharos Control User Guide Attribute: The name of the user account’s attribute. Value: The value of the corresponding attribute. Name: The name of the user account. Role: The role of the user. Login: Whether the user logs in. E-mail: The email address of the user. Telephone: The telephone number of the user. Notes: Notes about this user account.
Pharos Control User Guide Chapter 8 Log Log Tab is used for viewing the log information saved in the server. The log information is categorized into three groups: Log, Error and Debug. The Log Tab includes three sections: Log Classification, Log List and Log details.
Pharos Control User Guide 8.1 Log Classification Log Classification is in Section A of the Log Tab. Figure 8-2 Log Classification All the logs are categorized into three types: Log, Error and Debug. Log: The informational system service messages. Error: Some errors or warning messages. Debug: The debugging information.
Pharos Control User Guide 8.2 Log List Log List is in Section B of the Log Tab. Figure 8-3 Log List This section is used to view and export the log entries under the selected group. Entry Introduction: Time: The log’s generating time. Message: Detailed information of this log. Type: The type of this log. Device Name: The device name. If the log is system-level, this column will be blank. MAC: The MAC address of the device. If the log is system-level, this column will be blank.
Pharos Control User Guide Export all the log entries in this section to your computer as an Excel file. Click the menu button (or right click any device entry below) to display all the operations in this window. Operations without corresponding buttons are introduced below: Enter a key word to search all the columns in the firmware file list below, and a partial text match will be highlighted. 8.3 Log Details Log Details is in Section C of the Log Tab.
Pharos Control User Guide Chapter 9 Preference Click at the top right corner to configure the SMTP settings. Figure 9-1 Preference Mail server address: Specify the SMTP server to be used by the system. Mail server port: Specify the email server port. Mail username: Specify the SMTP username. Mail password: Specify the SMTP password.
Pharos Control User Guide Chapter 10 My Settings This window is used to view and edit the logging user’s information. You can edit the logging user’s password, email, telephone and notes on this page. Among them, email, telephone and notes are optional.
Pharos Control User Guide Chapter 11 Application Example 11.1 Email Notification The Pharos Control can monitor and record the specified device group’s status changes, such as managed, unmanaged and error. Example: send an email notification when a specified device group’s status goes wrong. Configuration Procedure: Step 1. Open the Preference page to configure the SMTP server. Enter the mail server’s address and port, and specify the email account and password on the following page.
Pharos Control User Guide Step 5. Specify the recipient and the subject of the notification email in the Action box.
Pharos Control User Guide 11.2 Auto-upgrade The Pharos Control can execute discovery, reboot and upgrade actions on specified device(s) at a certain point in time. Example: Specify a time to upgrade the device. Configuration Procedure: Step 1. Upload the firmware file to the server on the page Firmware->Add firmware.
Pharos Control User Guide Step 2. Open Device->Add schedule window. Figure 11-5 Schedule a Firmware Upgrade Task Step 3. Enter the scheduled task’s name and specify the scheduled period as once and specify the exact date. Step 4. In the Task box, select the scheduled task as Firmware upgrade and select the target Device and Firmware in the list below.
Pharos Control User Guide 11.3 Auto-reboot The Pharos Control can execute discovery, reboot and upgrade actions on specified device(s) at a certain point in time. Example: Specify a time to reboot the device. Configuration Procedure: Step 1. Open Device->Add schedule window. Figure 11-6 Schedule a Device Reboot Task Step 2. Enter the scheduled task’s name and specify the scheduled period as once and specify the exact date.
Pharos Control User Guide Step 3. In the Task box, select the scheduled task as Reboot and select the target Device and click OK to apply.