3View User Guide

Transcription

3View User Guide

3View User Guide
3Roam SA
Parc de Haute Technologie Bat 6
694 Avenue Maurice Donat
06250 Mougins
France
Tel: +33 4 92 98 83 62
No information contained herein is to be shared, copied, disclosed, or otherwise compromised without the
express written consent of
3View User Guide
Contents
1.
Overview.................................................................................................................... 8
Who should read this document ............................................................................ 8
3View Architecture ................................................................................................ 8
2.
Installation ................................................................................................................. 9
3.
Getting Started..........................................................................................................10
Connecting to 3View ............................................................................................10
3View Page Layout ..............................................................................................10
4.
Discovery ..................................................................................................................12
Overview of discovery ..........................................................................................12
Discovering devices .............................................................................................12
5.
Displaying Node Information .....................................................................................15
Node List ..............................................................................................................15
View Events: ........................................................................................................16
View Alarms: ........................................................................................................16
View Outages: ......................................................................................................16
Asset Info: ............................................................................................................16
HTTP: ..................................................................................................................16
Resource Graphs: ................................................................................................16
Rescan: ................................................................................................................16
Admin: ..................................................................................................................16
Change Node Label: .................................................................................17
Delete Node:.............................................................................................17
6.
Services ....................................................................................................................18
Overview of services ............................................................................................18
Marking a service as Unmanaged ........................................................................19
7.
Data Retrieval ...........................................................................................................21
Overview ..............................................................................................................21
Thresholds ...........................................................................................................21
Generating graphs for a node...............................................................................25
8.
2
Events and Alarms ....................................................................................................29
3Roam Proprietary Information
Strictly Confidential
v1.0 January 2012
3View User Guide
Events ..................................................................................................................29
Event Consolidation .............................................................................................30
Alarms ..................................................................................................................30
Supported Alarms for WLS ...................................................................................32
Supported Alarms for AERO ................................................................................34
9.
Notifications ..............................................................................................................37
10. User and Group Management ...................................................................................41
11. Maps 43
Overview ..............................................................................................................43
Creating a map.....................................................................................................43
Node Context Menu .............................................................................................46
12. Dashboard ................................................................................................................48
Node Status: ........................................................................................................48
Alarms: .................................................................................................................48
Resource Graphs: ................................................................................................48
13. Reports .....................................................................................................................50
Overview ..............................................................................................................50
Standard Reports .................................................................................................50
Custom Reports ...................................................................................................50
Appendix A ......................................................................................................................57
3View Server Specifications .................................................................................57
Appendix B ......................................................................................................................58
Web Browser Specifics ........................................................................................58
SVG Support ........................................................................................................58
Telnet/SSH Support .............................................................................................58
Firefox: .....................................................................................................59
Appendix C ......................................................................................................................62
System Administration Tasks ...............................................................................62
Logging in to the server ........................................................................................62
Super User ...........................................................................................................62
Editing configuration files .....................................................................................62
Restarting 3View ..................................................................................................62
Appendix D ......................................................................................................................64
Adding Map images..............................................................................................64
3
3View User Guide
Appendix E ......................................................................................................................65
GNU General Public License Version 3 ................................................................65
4
v1.0 January 2012
3View User Guide
Figures
Figure 1. 3View login page .................................................................................................................... 10
Figure 2. Page header ............................................................................................................................ 11
Figure 3. SNMP parameter configuration ............................................................................................. 12
Figure 4. Restarting discovery ............................................................................................................... 13
Figure 5. Discovery restart events ......................................................................................................... 14
Figure 6. Node page .............................................................................................................................. 15
Figure 7.Unmanage a service ................................................................................................................ 19
Figure 8. Service awaiting suspension ................................................................................................... 19
Figure 9. Unmanaged service ................................................................................................................ 20
Figure 10. Threshold configuration ....................................................................................................... 22
Figure 11. Edit threshold group ............................................................................................................. 23
Figure 12. Editing threshold values ....................................................................................................... 24
Figure 13. Changed threshold values .................................................................................................... 24
Figure 14. Example threshold event...................................................................................................... 25
Figure 15. Graph resource selection ..................................................................................................... 26
Figure 16. Temperature display (WLS500) ............................................................................................ 27
Figure 17. Example resource graphs ..................................................................................................... 27
Figure 18. Link status graph .................................................................................................................. 28
Figure 19. Event list ............................................................................................................................... 30
Figure 20. Alarm list............................................................................................................................... 31
Figure 21. Alarm clearing....................................................................................................................... 32
Figure 22. Notification status configuration.......................................................................................... 37
Figure 23. Current notification status ................................................................................................... 37
Figure 24. Listing destination paths ...................................................................................................... 38
Figure 25. Edit a destination path ......................................................................................................... 38
Figure 26. Choose destination path targets .......................................................................................... 39
Figure 27. Notification list ..................................................................................................................... 40
Figure 28. Notification detail ................................................................................................................. 40
Figure 29. User list ................................................................................................................................. 41
Figure 30. Group configuration ............................................................................................................. 42
Figure 31. Admin mode ......................................................................................................................... 43
Figure 32. New map option ................................................................................................................... 44
Figure 33. Rename map option ............................................................................................................. 44
Figure 34. Map name ............................................................................................................................ 44
Figure 35. Save map option ................................................................................................................... 45
Figure 36. Add node option ................................................................................................................... 45
Figure 37. Map showing severity view .................................................................................................. 46
Figure 38. Map context menu ............................................................................................................... 47
Figure 39. Dashboard node status ........................................................................................................ 48
Figure 40. Dashboard alarm status ....................................................................................................... 48
Figure 41. Dashboard resource graphs ................................................................................................. 49
Figure 42. Custom report list ................................................................................................................. 51
Figure 43. Custom report add graph ..................................................................................................... 52
Figure 44. Custom report node list........................................................................................................ 52
5
3View User Guide
Figure 45. Custom report resource list.................................................................................................. 53
Figure 46. Custom graph options .......................................................................................................... 54
Figure 47. Custom graph select prefabricated graph ............................................................................ 55
Figure 48. Custom graph final report .................................................................................................... 56
Figure 49. Associate Telnet and SSH URLs............................................................................................. 59
Figure 50. Firefox application assignment ............................................................................................ 60
Figure 51. Firefox application assignment (following) .......................................................................... 60
6
v1.0 January 2012
3View User Guide
Tables
Table 1. Service polling intervals ........................................................................................................... 18
Table 2. Availability colour code............................................................................................................ 18
Table 3. Predefined threshold values .................................................................................................... 21
Table 4. WLS supported alarms ............................................................................................................. 33
Table 5. WLS alarm set/clear ................................................................................................................. 34
Table 6. Aero supported alarms ............................................................................................................ 35
Table 7. AERO alarm set/clear ............................................................................................................... 36
Table 8. Map availability colour code.................................................................................................... 46
Table 9. Node options in map view ....................................................................................................... 47
Table 10. Dashboard availability colour code ....................................................................................... 48
7
3View User Guide
1. Overview
Who should read this document
This guide is intended to be used by operations staff who are familiar with the running and
monitoring of networks. Network and system planners and managers concerned with network
design, implementation and operation may also find the guide useful.
It is assumed that the reader and user of 3Viewhas a good working knowledge of networking
equipment and protocols and of network management theory.
3View Architecture
3View is built on the OpenNMS® network management software, which is an open-source
enterprise-grade system, widely used in the industry. Using this as a base, 3Roam have developed a
system which is highly customised and optimised to the task of monitoring networks built with
3Roam products.
OpenNMS and 3View are made available under the terms of the GNU General Public License Version
2.0, reproduced in Appendix E.
8
v1.0 January 2012
3View User Guide
2. Installation
The 3View server is delivered pre-installed by 3Roam on a dedicated server running Linux (see
Appendix A for specifications). The 3View client is a standard web browser. The following browsers
are supported:



Firefox version 3 and later
Internet Explorer version 8 and later (with SVG plugin – see Appendix B)
Google Chrome
For details on specific requirements for browser support, see Appendix B.
9
3View User Guide
3. Getting Started
Connecting to 3View
Once 3View is configured and started, the user interface (UI) can be accessed from a web browser
using the following URL:
http://<server hostname or address>:8980/opennms
The login page will be displayed:
Figure 1. 3View login page
The default username/password is admin/admin. Users can be added later as required.
Once the username and password have been entered, the dashboard page will be opened. This is the
home page of 3View which gives an overall view of the current state of the network. The dashboard
page is described in more detail in section 12.
3View Page Layout
All 3View pages have a common header which contains navigation links and global information. The
main items of interest are shown below:
10
v1.0 January 2012
3View User Guide
Notices flag
Current page
Logged-in user
Main menu bar
Figure 2. Page header
In the following sections some of the basic concepts and features of 3View are introduced.
11
3View User Guide
4. Discovery
Overview of discovery
Discovery is the mechanism by which devices are entered into the 3View database. It can be
automatic, where an IP address range is searched for devices, or for more control over the process,
individual IP addresses can be entered by the operator.
The discovery process works as follows:
1.
2.
3.
4.
5.
The operator enters one or more IP addresses or ranges of addresses
The discovery process is (re)started
3View then attempts to contact each address and to identify the type of device
3View identifies the services available on the device
3View initiates polling of information from the device
When a device is discovered, one of the steps is to identify the model type of the device, which
happens as part of the SNMP service detection (see below). The information about each device type
is in turn used to customise certain aspects such as the map icon and the data retrieval parameters.
Discovering devices
In order to add devices to 3View, they must be added to the discovery list. By default 3View uses
SNMP version 2c and a community string of 'public' to communicate with all devices. If this is not
suitable, the values can be modified for a device or range of devices by selecting Admin from the
main menu, then ‘Configure SNMP Community Names by IP'. Note that once configured, the values
cannot be viewed using the web user interface. In case this is required, the values can be viewed in
the file '/etc/opennms/snmp-config.xml'. For more information on editing files, see Appendix C.
Figure 3. SNMP parameter configuration
12
v1.0 January 2012
3View User Guide
Once the SNMP defaults are configured, the device addresses can be added as follows:
Select Admin from the main menu, then Configure Discovery from the Operations pane.
Devices can be added to the discovery list either by adding a specific IP address in the Specifics pane,
or by adding a range of addresses using the Include Ranges and Exclude Ranges panes. Once the
desired addresses have been entered, they should be saved, and the discovery process restarted by
clicking the Save and Restart Discovery button.
Figure 4. Restarting discovery
At this point the events list will be displayed which will show that the discovery was (re)started.
Refreshing the page using the browser refresh function will show event entries for any discovered
nodes.
13
3View User Guide
Figure 5. Discovery restart events
14
v1.0 January 2012
3View User Guide
5. Displaying Node Information
Node List
The node list page is selected from the main menu and lists all currently discovered nodes. Nodes can
be identified with a user-configurable label. In the case it is not configured, the host name of the
device is used. In the case no host name is configured, the FQDN address is used. If no FQDN address
is available, then the IP address is used to identify the node.
If the node list is very long, the Search option can be selected from the main menu bar to filter the
list of nodes to a manageable length.
From the node list, a node can be selected and the node page will be displayed. The node page
shows the following information:





Asset information
SNMP Attributes (system and administrative information)
Availability information
Recent event List
Recent outage List
Figure 6. Node page
15
3View User Guide
As well as this summary information, a node toolbar is available which gives access to more detailed
information concerning the node. These are described below:
View Events:
This provides a list of the events specific to this node. Selecting this link is equivalent to selecting the
main events link, and then filtering on this node. For more information see section 8.
View Alarms:
As for events, this link provides a list of the alarms specific to this node. Selecting this link is
equivalent to selecting the main alarms link, and then filtering on this node. For more information
see section 8.
View Outages:
Again, this provides a view of the outages for this node.
Asset Info:
3View allows administrative information for the device to be stored in its database. This pane shows
the asset information for the node and allows modifications to be made (assuming the user has the
required privileges). A summary of asset information is also displayed (if present) on the node page.
HTTP:
This allows a connection to be made to the web interface of the node. 3View provides a proxy to
allow HTTP connections to nodes even if they are not directly reachable from the client machine. This
allows nodes to be accessed even when connecting to the 3View server through a firewall.
Resource Graphs:
The details of resource graphing is covered in section 7. Graphs for this node may be conveniently
accessed using this link.
Rescan:
This link allows the node to be re-examined for available services. This procedure is performed every
24 hours in any case, but is useful if the monitoring status of a node (managed/unmanaged) is
changed. In this case a rescan must be performed to complete the procedure. See section 6 for
details on marking a service unmanaged.
Admin:
16
v1.0 January 2012
3View User Guide
This link opens the admin pane for the node. This allows configuration of the following:
Change Node Label:
The node label is automatically set to the SNMP hostname, FQDN address or IP address
when the node is added. If this name is not suitable a user-defined name can be set
here.
Delete Node:
This option can be used to delete the node. Be sure to also remove the node's address
from the discovery page, otherwise the node will be re-discovered within 24 hours.
17
3View User Guide
6. Services
Overview of services
Services are a generic term in 3View for things that should be monitored and for whom an availability
statistic should be calculated. The services currently monitored on 3Roam devices are:
ICMP
SNMP
HTTP
Link Status
Port Status
Device Status
Whether or not the device responds to an ICMP echo request (ping)
Whether or not the device responds to an SNMP request
Whether or not the device responds to an HTTP request
Whether or not alarms are present on each of the radio links of a device
Whether or not an Ethernet interface is up
Whether or not an AERO device is faulty
When a device is discovered by 3View, a service scan is performed to determine which services are
available on the device. Once complete, 3View begins monitoring each service according to predetermined rules to ensure that any interruptions are detected and reported.
In addition, the scan is repeated every 24 hours (or on demand) to detect any change in service
status, for example if the HTTP service is disabled in a WLS following the initial discovery.
For each identified service, an availability value over the previous 24 hours is maintained. This value
should thus be at 100% in the normal case, but will diminish in cases of service outage. The service
monitoring consists of a polling and thus the resulting availability should be used as a guide only. The
polling intervals for the different services are shown below:
Service
ICMP
SNMP
HTTP
Link/Port Status
Device Status
Polling Interval
30 seconds
300 seconds
300 seconds
30 seconds
30 seconds
Table 1. Service polling intervals
The individual service availability figures are displayed in the node page using the following colour
scheme.
Green
Yellow
Red
> 99.99%
> 97%
< 97%
Table 2. Availability colour code
18
v1.0 January 2012
3View User Guide
When a service is up, the 24 hour availability will increase to a limit of 100%. When a service is down,
or the node is unreachable, the availability will decrease.
Marking a service as Unmanaged
In general a service refers to a critical function of the unit and a failure of a service normally needs
immediate action. However, in some cases it is not desirable to monitor a service. For instance if an
Ethernet port is down, then it will show up as an outage in 3View.
However, it is common to have unconnected Ethernet ports and for such a port to be down is not
necessarily a cause for concern. In this case, it is not useful to have an outage showing up in 3View
since it may detract from other, real, problems.
To unmanage a service, click the Admin link on the main toolbar, then select 'Manage and Unmanage
Interfaces and Services'. Uncheck the interface/service to be unmanaged, then click 'Apply Changes'.
Figure 7.Unmanage a service
Click OK to proceed when prompted, then return to the node page, which should now show the
following:
Figure 8. Service awaiting suspension
19
3View User Guide
To complete the procedure, click 'Rescan' from the Node page toolbar. After a few seconds, refresh
the page and the service(s) will be marked 'Forced Unmanaged'.
Figure 9. Unmanaged service
The availability of this service will no longer be considered in the availability calculation for the node.
20
v1.0 January 2012
3View User Guide
7.
Data Retrieval
Overview
Once a device has been discovered and its type determined, 3View starts retrieving key performance
indicators (KPIs) which consist of a predefined set of data items reflecting the health of the device or
its connectivity to other devices.
These KPIs are then stored on the 3View server and can be used to visualise the overall performance
of each device.
The KPIs are retrieved every 5 minutes and stored in a special database called a Round-Robin
Database (RRD). This database allows data to be stored indefinitely without requiring unbounded
storage, by overwriting the oldest data once the database becomes full. By default, the following
values are stored for each KPI:




The raw value, every 5 minutes for 1 month
The average over 1 hour, every hour for 1 year
The minimum over 1 hour, every hour for 1 year
The maximum over 1 hour, every hour for 1 year
Using these values, graphs can be generated over any timeframe going back 1 year.
Nothing needs to be done to configure data collection - the elements to be collected are
automatically determined based on the type of device. As soon as the device has been discovered,
the collection will begin.
Thresholds
As data is collected, it may also be checked against pre-defined thresholds to ensure that individual
measures are within the expected range. 3View comes pre-configured with appropriate threshold
values for a number of KPIs, however they can be modified if necessary to suit a particular situation.
The pre-defined threshold values are shown in the table below:
KPI
WLS Received Signal Level
AERO Received Signal Level
WLS ODU Temperature
WLS MotherBoard Temperature
AERO Temperature
High/Low
Low
Low
High
High
High
Value
-60
-70
75
75
75
Re-arm Value
-57
-67
70
70
70
Table 3. Predefined threshold values
21
3View User Guide
If a threshold value is exceeded, an event will be generated to alert attention. This will in turn create
an alarm condition which will persist until the value returns to the re-arm value. The re-arm value
should be chosen to provide hysteresis and to avoid generating many events if a value fluctuates
around the threshold value.
To modify an existing threshold entry, select Admin->Manage Thresholds from the main toolbar.
Figure 10. Threshold configuration
The thresholds are divided into three groups:
3roam-wls1:
3roam-wls2:
3roam-aero:
WLS devices with a single radio (WLS100, WLS501)
WLS devices with two radios (WLS502)
AERO integrated devices
For WLS502 devices, the thresholds are individually selectable for the two radio ports. This allows for
different thresholds to be set on the received signal level in cases where the two links have a
different fade margin, and for whom the normal RSLs are different.
Select Edit to view the threshold values:
22
v1.0 January 2012
3View User Guide
Figure 11. Edit threshold group
This screen also allows the editing of threshold values. For example, to change the RSL threshold
from -60 to -55, with a re-arm value of -50, the procedure is as follows:
Click Edit on the row which corresponds to the RSL (first row). The following screen will be displayed:
23
3View User Guide
Figure 12. Editing threshold values
Change the threshold values as shown. Click Save when finished. Now the new threshold values can
be seen in the list:
Figure 13. Changed threshold values
24
v1.0 January 2012
3View User Guide
After changing a threshold value, the threshold package must be reloaded by clicking ‘Threshold
Groups’ (just below the 3Roam logo) and then clicking the ‘Request a reload threshold packages
configuration’ button (see Figure 10).
When a threshold is exceeded, an event similar to the following example will be generated:
Figure 14. Example threshold event
The event shows the received signal level (RSL) of interface mdu0 passing below the threshold level
of -60. Its measured value was -67.5
Generating graphs for a node
The other main use of collected data is to show historic trends through the use of graphs. Each node
type has a pre-configured set of graphs which show key performance information for the device. The
data is divided into node-specific data (which includes radio statistics), port-specific, which includes
traffic stats for both Ethernet and radio interfaces, and response data which shows response times
for the HTTP and SNMP services.
In general graphs can be generated for a variety of statistics on any of the discovered nodes using the
Reports facility (see section 13). The procedure shown here shortcuts directly to the “standard
reports” configuration with the current node pre-selected.
In order to generate a node graph:
Either:
Go to Reports->Standard Reports from the main menu bar, then select the desired node from
the list and click the Start button.
or
Go to the node page, e.g. using the 'Node List' menu item, then select 'Resource Graphs'
A list of available resource graphs will be shown on the left. These will include:
Node-level graphs, including temperature and radio parameters
IP-level graphs, including service response times
Port-level graphs, including throughput and packet statistics
Select the required groups, either by double-clicking, by dragging to the right, or by clicking 'Add All'
At this point the following screen will be shown, with the selected graph(s) on the right, and the
remaining choices on the left:
25
3View User Guide
Figure 15. Graph resource selection
Click 'Graph Selection' to display the graphs.
Each graph will show data for the last 24 hours by default. To select a different timeframe, click on a
graph. The same graph will be shown with controls to allow any timeframe to be selected.
Predefined 'Last Day', 'Last Week', 'Last Month' or 'Last Year' periods can be chosen, or a specific part
of the displayed graph can be selected by dragging the cursor across the desired time period directly
on the displayed graph.
Most graphs show multiple KPIs using different coloured lines. A legend printed below the graph
indicates which colour corresponds to which KPI. In the case of port statistics, colour areas are used
to show how the total throughput is broken down between the different packet types
(unicast/multicast/broadcast/errors). Examples are shown below:
26
v1.0 January 2012
3View User Guide
Figure 16. Temperature display (WLS500)
This graph plots the temperatures of the IDU and both ODUs of a WLS500. For each trace, the
average, maximum and minimum values are shown for the period which is plotted. Changing the
period will update those values.
Figure 17. Example resource graphs
This graph shows port statistics. This is an example of a ‘stacked’ graph, where the total traffic
throughput is divided into different traffic types which are then stacked on top of each other to give
a visual indicatio of the breakdown of the data. Here we can see that the traffic is a mix of unicast,
multicast and unicast.
The following example shows the link status graph which is contained in the’Node Level Performance
Data’ graph package. This graph shows a value of 100% when a radio link is up, and 0% when it is
down. It also has a red line showing the average value over the period being graphed. This has the
effect of giving an indication of the average availability of the link over the period and is thus very
useful.
27
3View User Guide
Figure 18. Link status graph
However note the following caveats:


The values on this graph are based on data collection polls, which are taken every 5 minutes.
This means that the availability figures are not accurate for small numbers of short outages.
It also means that the values may not concur with the service availability figure for the same
link which is based on a much shorter polling period.
The service is considered to be unavailable whenever the node is unreachable, even if the
link in question is up, and traffic is passing normally. This could happen for example if the
NMS server itself became disconnected from the network. In this case, the NMS takes a
worst-case decision and marks the service down. However, the link status graph shows a
break in this case (note the break on the example graph shown). During the break, the data is
not counted for the purposes of availability calculation, so it will not be considered down
during this period. This will also cause discrepancies with the service availability figure.
Thus, for best accuracy and worst-case values in cases of doubt, the service availability should be
used for last-24hour availability. However, for best flexibility of duration and best visualization, the
link status graph should be used.
28
v1.0 January 2012
3View User Guide
8. Events and Alarms
Events
Events are a fundamental part of 3View. Events can be generated either internally, or as a result of
an external influence such as the loss of a service, or the reception of an SNMP TRAP.
Events can be displayed in a number of ways, including:


From the Events main menu item
From the node page submenu or on the node page itself
In the latter case, only events for the selected node are displayed. In all cases, the list can be filtered
by clicking the + and - symbols next to filter markers for each event. For example, clicking the + next
to a node label will filter the list such that only events for that node are displayed. Clicking the - will
then remove the filter such that all events for all nodes are again displayed. Clicking the < next to a
date will lead to the display of all events starting at that data, and the > will show all events before
that date.
As filters are selected, the list of active filters will be displayed at the top of the page. Clicking on the next to any of these filters will cause it to be removed.
29
3View User Guide
Figure 19. Event list
From the Events sub-menu Advanced Search, a more detailed list of search parameters can be
specified. In addition, the events page has a menu item Severity Legend, which provides a reminder
of the meanings of the various severity values.
Event Consolidation
In order to minimise event repetition, certain events are automatically deleted when a new event of
the same type is received. As an example, if a link up event is received, and then in the future
another link up event is received for the same interface, the original event will be deleted, and the
new one added.
Alarms
Most events have a corresponding alarm. Alarms are very similar to events, in that each alarm is
derived from a matching event, and has the same severity as the event. However alarms have some
additional properties. In general, alarm represents a degraded state over a time period, rather than a
single point in time. For example, a link-down condition is represented by an alarm. The alarm is
active during the period that the link is down. The alarm is entered on reception of the link down
event, and is cleared on reception of a link up event. Alarms allow the operator to easily determine if
there is a problem with the network. Alarms exist for the following failure scenarios:
30
v1.0 January 2012
3View User Guide






Device alarms
Link alarms
Ethernet port down
Temperature over threshold
Received signal level below threshold
Node down
The current list of alarms can be viewed from the main Alarms menu item, or from the node page of
an individual device. Filtering is similar to those described for events.
One important difference between events and alarms is that alarms are automatically cleared from
the system when a clear event is received. More specifically, the clear event causes a clear alarm to
be registered, then the original alarm entry is cleared and its colour changed to light grey, before
finally all related alarm entries are removed. This whole process can take a few minutes, because it is
performed by background housekeeping process.
Figure 20. Alarm list
In some cases, alarms may not be cleared correctly because of management traffic being lost due to
disruptions associated with the alarm condition. In these cases, once it is clear that an alarm
condition has been resolved, the alarm can be cleared manually, by selecting the alarm (clicking the
Ack box), then selecting 'Clear Alarms', and clicking 'Go':
31
3View User Guide
Figure 21. Alarm clearing
Supported Alarms for WLS
The table below lists the alarms supported by 3View for the WLS100, WLS501 and WLS502 products:
32
v1.0 January 2012
3View User Guide
Alarm Name
Fan 1-6 failed
High threshold exceeded for
SNMP datasource
OduTemp_mdu0/1
SNMP
datasourceMboardTemp
Node is down
HTTP outage
Description
Hardware Platform
Fan has failed
Temperature of ODU is high
Detection
Severity
Trap
Statistics
polling
Minor
Warning
Temperature of IDU is high
Statistics
polling
Warning
Service
polling
Service
polling
Service
polling
Service
polling
Service
polling
Major
Statistics
polling
Minor
Trap
Statistics
polling
Major
Warning
Transmitter is muted
Trap
Warning
Ethernet interfaces
Interface is operationally down
Trap
Major
Services
Node is down or unreachable
Port eth0-5 outage
Embedded HTTP server is
down or unreachable
Embedded SNMP agent is
down or unreachable
Link mdu0/1 outage
SNMP outage
SNMP data collection on node
failed
Link mdu0/1 has alarms
Low threshold exceeded for
SNMP datasource
RSL_mdu0/1
Transmitter muted on ODU
mdu0/1
Port eth0-5 DOWN
Statistics
SNMP statistics collection has
failed
Radio Interfaces
RSL is low
Major
Major
Major
Major
Table 4. WLS supported alarms
Notes:
Some alarms are redundant, for example ‘Link mdu0 outage’ and ‘Link mdu0 has alarms’. Both
indicate that there is a problem with the radio link, but the latter is triggered by an SNMP trap which
is sent by the WLS at the moment the link fails. The other is detected by the regular service poll, and
may be delayed slightly. The idea is to ensure that the information is indicated to the operator as
soon as possible, but also to ensure that if the SNMP trap is lost, the fault is detected by the service
poll.
HTTP outage, SNMP outage, Port eth0-eth5 outage and Link mdu0/mdu1 outage are not triggered
after Node is down is triggered, so if a complete node fails, the system attempts to clarify the alarm
reporting by reporting a single ‘node down’ rather than cluttering the list with an alarm for each
service.
33
3View User Guide
The rules for how alarms are set and cleared are shown in the following table:
Alarm name
Fan 1-6 failed
SNMP datasource
OduTemp_mdu0/1
SNMP datasourceMboardTemp
Set when
Hardware Platform
A fan has failed
Temperature of ODU has
reached 75°C
HTTP outage
Temperature of IDU has
reached 75°C
Services
Node is down or
unreachable
HTTP server is down
SNMP outage
SNMP server is down
Port eth0-5 outage
Interface is operationally
down or unknown
In Interface is operationally
down or unknown
Statistics
Statistics collection has
failed
Radio Interfaces
down
RSL has decreased beyond
-60dBm
Node is down
Link mdu0/1 outage
failed
SNMP datasource RSL_mdu0/1
mdu0/1
Port eth0-5 DOWN
Ethernet Interfaces
down
Automatically cleared
when
A fan recovers by itself,
otherwise cleared manually
after replacement
Temperature of ODU has
decreased to 70°C
Temperature of IDU has
decreased to 70°C
Node is again reachable
HTTP server is again
responsive
SNMP server is again
responsive
Interface is operationally up
Statistics collection
recovered
RSL has increased beyond 57dBm
Transmitter is un-muted
Table 5. WLS alarm set/clear
Supported Alarms for AERO
Below is the alarm table for the AERO product:
Alarm Name
34
Description
Hardware Platform
Detection
Severity
v1.0 January 2012
3View User Guide
Tx alarm
Rx alarm
SNMP datasourceAeroTemp
Node is down
HTTP outage
SNMP outage
Port NMS/Payload outage
Link outage
Device status outage
failed
SNMP datasourceAeroRSL
Transmitter muted
Radio transmission chain has
failed
Radio reception chain has
failed
Temperature of AERO is high
Services
Embedded HTTP server is
down or unreachable
Embedded SNMP agent is
down or unreachable
Ethernet interface is
operationally down
Radio interface is operationally
down
Hardware has failed
Statistics
SNMP statistics collection has
failed
Radio Interfaces
RSL is low
Trap
Critical
Trap
Critical
Statistics
polling
Warning
Service
polling
Service
polling
Service
polling
Service
polling
Service
polling
Service
polling
Major
Statistics
polling
Minor
Statistics
polling
Trap
Warning
Major
Major
Major
Major
Major
Warning
Table 6. Aero supported alarms
The rules for how alarms are set and cleared are shown in the following table:
Alarm name
Set when
Tx alarm
Hardware Platform
Hardware has failed (Tx)
Rx Alarm
Hardware has failed (Rx)
SNMP datasourceAeroTemp
Temperature has reached
75°C (750 tenths)
Node is down
HTTP outage
Services
HTTP server is down
SNMP outage
SNMP server is down
Automatically cleared
when
Hardware recovers
(unlikely) otherwise cleared
manually after replacement
Hardware recovers
(unlikely) otherwise cleared
manually after replacement
Temperature has
decreased to 70°C (700
tenths)
Node is again reachable
HTTP server is again
responsive
SNMP server is again
35
3View User Guide
Port eth0-5 outage
Link mdu0/1 outage
Device status outage
failed
SNMP datasource
RSL_mdu0/1
mdu0/1
or unknown
In Interface is operationally
down or unknown
Hardware has failed or node
unreachable
responsive
Hardware has recovered
(unlikely) or node again
reachable.
Statistics
Statistics collection has failed
Statistics collection
recovered
Radio Interfaces
RSL has decreased beyond 70dBm (700 tenths)
RSL has increased beyond
-67dBm (670 tenths)
Transmitter is un-muted
Table 7. AERO alarm set/clear
36
v1.0 January 2012
3View User Guide
9. Notifications
Notifications are similar to alarms and are used to send emails to operators automatically when an
alarm condition is detected. Each notification is mapped to a particular alarm and they can be
activated individually.
Notifications also have a global on/off switch which is initially off. To configure the delivery of
notifications, select Admin from the main toolbar, then check the radio button marked 'Notification
Status'. Click 'Update' to complete the process.
Figure 22. Notification status configuration
The global status is reported in the main status area at the top right of each page:
Figure 23. Current notification status
In addition, each notification can be activated or de-activated individually. Select Admin->Configure
Notifications, then select 'Configure Event Notifications'. A list of all notifications is shown. The
default settings have been carefully selected and it is recommended not to change them, however if
changes need to be made, set the on/off buttons as necessary.
Be careful not to delete any notifications, since they cannot be undeleted. Editing notifications is an
advanced topic outside the scope of this guide.
To determine where notifications should be sent, select Configure Destination Paths. In general there
will be only one path. In general it is better to edit this path if you want to change the path for all
notifications. You can add a new one, but then each of the event notifications has to be reconfigured
one by one to change the selected path. By editing the existing path, this will not be necessary.
37
3View User Guide
Figure 24. Listing destination paths
Next, click the Edit button to change the destination.
Figure 25. Edit a destination path
Again click the Edit button to edit the targets.
38
v1.0 January 2012
3View User Guide
Figure 26. Choose destination path targets
Now, the options are to select:




One or more users from the first pane and/or
One or more groups from the second pane and/or
One or more roles from the third pane and/or
One or more external email addresses from the fourth pane
In the first three cases, notifications will only be sent if the selected user is scheduled as being able to
receive notifications (see below).
In general it is recommended to use one of the first two panes (users/groups) to select destinations.
Roles are mainly useful for cases where complex non-repeating schedules need to be maintained and
are beyond the scope of this guide.
To select multiple users/groups in a list, hold down the Ctrl key whilst clicking. Similarly, to remove a
selected entry, click again on the entry whilst holding the Ctrl key.
When the selection has been made, click Next>>>.
Next, accept the default 'Java Email' and click Next>>>.
Then click Finish to complete the configuration.
To confirm that emails are being sent to the correct users, generate a notification event (assuming
this is possible. E.g. pull an Ethernet cable) and go to the Notifications screen. Click All Outstanding
Notices and refresh until the notification is displayed.
39
3View User Guide
Figure 27. Notification list
Next, click on the notification ID, the left-most column, marked 'ID'. This will show the detail of the
notification. At the bottom of this display, the list of users to whom the notification was sent will be
shown:
Figure 28. Notification detail
As it can be seen, this notification was successfully emailed to the admin user.
40
v1.0 January 2012
3View User Guide
10. User and Group Management
In some cases, it may be desirable to have other users of 3View with reduced privileges, rather than
all users log in as admin. Alternatively, it may be desirable to have multiple notification targets, so
that different users can receive notifications at different times, as explained above in section 9.
To create a new user, select Admin->Configure Users, Groups and Roles, then select 'Configure Users'.
Figure 29. User list
Click Add New User, then select a username and password. Following this, a screen will be shown
where administrative information can be entered. Some of this information is used for notification,
e.g. the email address is used to send notifications by email. Other fields, such as pager ids etc can be
used with external applications but such configuration is outside the scope of this guide.
To edit an existing user, click the Modify icon on the same line as the user.
Users can also be associated with groups. This can be useful for assigning different maps depending
on user, since the default map is linked to a given user’s group membership.
To configure a group, select Admin->Configure Users, Groups and Roles, then select 'Configure
Groups'. A screen similar to that for users will be shown. Click ‘Add new group’ to add a new group,
or click the ‘Modify’ icon to edit an existing group.
If adding a new group, you will be asked for a group name and a comment describing the group.
Add or remove users to the group using the << and >> buttons. Also, at the top of this page, the
default map for the group can be selected. The other panes in this group are not described in this
document.
41
3View User Guide
Figure 30. Group configuration
Click ‘Finish’ when finished.
42
v1.0 January 2012
3View User Guide
11. Maps
Overview
The 3View Map View allows geographic views of the network to be displayed as one or more images
(which may be geographic maps or schematic images) arranged as a hierarchical set.
Node icons can then be placed on these backgrounds. The links between nodes are not displayed,
and must be added manually to the background image if required. However, the node status is
displayed in real-time using a coloured 'semaphore' which indicates one of the following:


The severity of the most severe alarm currently active for the node
The availability of the node over the last 24 hours
Creating a map
To enter the map view, select Map from the main toolbar. Initially an empty map will be shown
called NotOpenMap with a menu on the right.
Select Map->Admin Mode to enter the administrative mode to allow a map to be created. Note how
the menu changes and that more items are available.
Figure 31. Admin mode
Select Map->New to create a new map.
43
3View User Guide
Figure 32. New map option
Select Map->Rename to rename the map to the desired name.
Figure 33. Rename map option
Type the desired name and click Rename.
Figure 34. Map name
Select Map->Background... to choose a background image for the map. Images are located in the
following directory on the 3View server:
/usr/share/opennms/jetty-webapps/opennms/map/images/background/
See Appendix D for details on how to upload new background image files to the server.
Select Map->Save to save the map. Note that in general the map must be saved every time a change
is made, and that often changes may be lost just by selecting another menu option. If in doubt, save.
44
v1.0 January 2012
3View User Guide
Figure 35. Save map option
Now add the nodes. Select Node->Add to add a single node. A list of the nodes known by 3View will
be shown. Select a node and click Add. Select as many nodes as required. If there are a lot of nodes
to be added, the option Node->Add Range can be used to add a range of nodes in one go. All nodes
with an IP address within the range will be added. To add all nodes known to 3View, just accept the
default range of (*.*.*.*).
Figure 36. Add node option
Once the nodes are added, they can be dragged into position and the map saved.
Finally, click Map->Refresh Mode to return to the normal non-admin mode. The node icons will now
show their current alarm severity via their colour.
45
3View User Guide
Figure 37. Map showing severity view
An alternative view “Availability View” is also available from the View menu, which colours the icons
according to the following table:
Green
Yellow
Red
100%
> 97%
< 97%
Table 8. Map availability colour code
Node Context Menu
By double-clicking on a node icon, a menu can be accessed as follows.
46
v1.0 January 2012
3View User Guide
Figure 38. Map context menu
The items are as follows:
Item
HTTP
SSH
Telnet
Ping
Node Page
Alarms
Events
Resource Graphs
Description
Opens a connection to the web configuration of the node.
Opens a CLI connection to the node via SSH (requires operating system to
understand ssh:// URLs).
Opens a CLI connection to the node via telnet (requires operating system to
understand telnet:// URLs).
Opens a dialog box allowing a ping to be performed to the node.
Opens a window with the 3View node summary page.
Opens a window with the 3View node alarm page.
Opens a window with the 3View node event page.
Opens the 3View graph page for the node.
Table 9. Node options in map view
In order for the Telnet and SSH links to be operational, the browser needs to have a correctly
configured URL handler. See Appendix B for details on how to do this if the link does not work.
47
3View User Guide
12. Dashboard
The dashboard is the main page of 3View and combines the following views:
Node Status:
Figure 39. Dashboard node status
A quick view of the availability of each node with a simple two-colour scheme of:
Green
Red
100%
< 100%
Table 10. Dashboard availability colour code
Also shown is the number of outages for each node, i.e. the number of services which are currently
down.
Alarms:
Figure 40. Dashboard alarm status
The alarm pane shows a list of alarms currently active on all nodes.
Resource Graphs:
48
v1.0 January 2012
3View User Guide
Figure 41. Dashboard resource graphs
This pane gives a quick access to the resource graphs.
In general, it is recommended that either the dashboard or the map view is used as the 'default' page
to be left open to allow easy visibility to the overall health of the network.
49
3View User Guide
13. Reports
Overview
Reports in 3View allow multiple graphs of the type available from the node page to be combined into
a report format which can be saved, then subsequently recalled. In this way, different views of the
network can be easily visualized.
Standard Reports
Two types of report are available. The first is a standard report which is essentially identical to the
graphs found on the Node page. A list of nodes is presented. Select a node to be graphed, then
follow the steps described for the node graphs.
Custom Reports
Custom reports allow multiple graphs from one or more nodes to be collected together into a single
report. This can be used for example to show similar information for a group of nodes over a same
period of time.
As an example we will create a report showing interface statistics for each end of a radio link.
First select Reports from the main menu bar, followed by Custom Reports. A list of nodes will be
shown.
Select the radio button marked ‘Create New’ and click Submit.
50
v1.0 January 2012
3View User Guide
Figure 42. Custom report list
Now select a name for the graph, then set the ‘Number of graphs per line’ to 2. We want to have one
column per device. Click ‘Add New Graph’.
51
3View User Guide
Figure 43. Custom report add graph
Next, we select node Antibes to be at the top left of the page. Click ‘View Child Resource’ to see the
graph resources available for the node.
Figure 44. Custom report node list
52
v1.0 January 2012
3View User Guide
Select ‘WLS port parameters: Port Statistics mdu0’ and click ‘Choose child resource’
Figure 45. Custom report resource list
By default, the first graph which is available for the resource will be shown. We will accept this. Note
that we normally do not need to add a title, since the existing graph title tells us all we need to know.
The default graph duration is 1 week. To change this, select the desired duration from the list box. To
see the results of any changes on this page, click ‘Refresh sample view’:
53
3View User Guide
Figure 46. Custom graph options
Note that the graph index proposed by the page above was 1. This will be incremented for each
graph and allows the position of the graph on the page to be changed. Graphs are numbered from
left to right on each row, and from top to bottom.
Now we repeat the same procedure for the second graph, which will be the same graph for node
Grasse.
We now have the port throughput graphs for each node. We now wish to add a row for the Tx Port
Statistics for each node. The procedure is exactly the same as the above, except that we need to
change the graph as shown below, before clicking ‘Done with edits’:
54
v1.0 January 2012
3View User Guide
Figure 47. Custom graph select prefabricated graph
This process can thus be repeated to add as many graphs as required.
Finally, click ‘Save’ to save the report. The report will now appear in the custom report list.
To view the report, select the ‘View’ radio button and click ‘Submit’. The report will be shown.
55
3View User Guide
Figure 48. Custom graph final report
56
v1.0 January 2012
3View User Guide
Appendix A
3View Server Specifications






Dedicated server (Dell PowerEdge R310)
Rackable (1U)
Dual Gbps Ethernet port
Hot-swappable redundant hard drives (RAID 1)
Redundant power supply
Linux OS (Ubuntu 10.04.3 LTS – Long Term-Support)
57
3View User Guide
Appendix B
Web Browser Specifics
To get the full benefit of the 3View browser support, the following items may need to be configured
in the web browser.
SVG Support
Adobe SVG rendering support is required for display of the map page. This is supported in Firefox and
Chrome by default, but not always in Internet Explorer.
To install the plugin see http://www.adobe.com/svg/viewer/install/.
Telnet/SSH Support
From the map context menu, it is possible to connect to the CLI interface of a node using either the
telnet or SSH protocols. In order for this to work, a telnet/SSH client must be installed, and the
browser must be configured to associate it with the corresponding URL.
The recommended telnet/SSH client for Windows is Teraterm v4.73, which can be downloaded from
the following location: http://ttssh2.sourceforge.jp/.
During the installation, the option will be given to install handlers for Telnet and SSH URLs:
58
v1.0 January 2012
3View User Guide
Figure 49. Associate Telnet and SSH URLs
After this installation is finished, ensure the operating system has correctly associated the SSH and
Telnet protocols with TeraTerm.
Note however, that the above will only associate the URLs when using Internet Explorer and Chrome.
To do the same for Firefox the following procedure must be followed:
Firefox:
The simplest way to configure Telnet and SSH handlers in Firefox is to select the Telnet and SSH
options from the node menu. Firefox will ask to assign an application to them:
59
3View User Guide
Figure 50. Firefox application assignment
Click Choose, then navigate to the Teraterm executable file which can be found at the following
location:
My Computer -> C:\Program Files\teraterm
Select ‘ttermpro.exe’ and click Open.
Finally, click the checkbox ‘Remember my choice for telnet links’ as shown below:
Figure 51. Firefox application assignment (following)
60
v1.0 January 2012
3View User Guide
Click OK to finish.
Finally, because of a problem with Teraterm’s URL handling, a change needs to be made in order for
the Telnet link to function:
Using Notepad, or similar editor, edit the file TERATERM.INI (also found in My Computer ->
C:\Program Files\teraterm) and find the following lines:
[TTSSH]
; SSH enabled flag (1=enabled 0=disabled)
Enabled=1
And change the ‘Enabled’ flag to zero as follows:
[TTSSH]
; SSH enabled flag (1=enabled 0=disabled)
Enabled=0
Find also the following lines:
; TCP/IP parameters
; TCP port#
TCPPort=22
And change the ‘TCPPort’ number to 23 as follows:
; TCP/IP parameters
; TCP port#
TCPPort=23
Save and close the file.
61
3View User Guide
Appendix C
System Administration Tasks
This section gives some guidelines on how to perform some basic system administration tasks which
may be necessary for the smooth operation of the 3View server.
Logging in to the server
The easiest way to administer the server is from the console. In order to log into the server, click on
the desired username (by default, only one user ‘oper’ is configured). Enter the password (‘oper’ by
default. This should be changed as soon as possible for security reasons).
Super User
Some tasks require the user to be a linux super-user (or root user). On Ubuntu-based systems, there
is no root user by default. Instead, the ‘sudo’ command is used to execute commands with superuser privileges. In order to use sudo, use it to prefix a command given in a terminal. For example, to
edit a file using gedit with super-user privileges, type:
Sudo gedit
Editing configuration files
Almost all configuration of 3View is performed using a web browser as described in this user guide.
However a small number of tasks require the manual editing of configuration files.
For users unfamiliar with Linux system administration, it is recommended to use the gedit graphical
editor from the server console as follows:
Whilst logged in as ‘oper’, run a terminal from the applications menu by selecting:
Applications -> Accessories ->Terminal
A terminal box will be opened. Type the following to open geditwith superuser privileges:
sudogedit
You may be asked to enter your password once again (same as used for login). Geditwill now appear
and is similar to notepad or other GUI-based editors.
Restarting 3View
Occasionally, (e.g. after adding background image files) it is necessary to restart 3View. The
62
v1.0 January 2012
3View User Guide
procedure is as follows:
Log into the system as ‘oper’.
Open a terminal and execute the following command:
sudo /etc/init.d/opennms restart
Messages will be displayed showing the stopping and restarting of 3View. Occasionally the restart
message will state that the system has not yet restarted. This is normal and simply means that the
application is slow to start. This may happen due to routine database maintenance tasks which
sometimes run at startup.
In cases where there is a problem (e.g. a file was edited and a syntax error was made), then a
message will clearly state that the system did not start and a log file name will be given to help
troubleshoot the problem.
63
3View User Guide
Appendix D
Adding Map images
One useful feature of 3View is the ability to add background images on which to overlay node icons
in the map view. The images may be traditional maps, or may be schematic images or any other aid
to help visualise the network topology.
In order for 3View to be able to use an image, it must be uploaded to the server and the map
configuration updated.
The file can be copied to the server using ftp or via a USB key. The file(s) should be copied to the
following directory:
/usr/share/opennms/jetty-webapps/opennms/map/images/background/
Once the files are copied, they must be referenced in the map configuration file:
/etc/opennms/map.properties
Edit this file with gedit (see Appendix D for details on how to use gedit)
Find the section:
###################################################################
## B A C K G R O U N D
I M A G E S
###################################################################
# A comma-separated list of bgimages keys.
# bgimages.{KEY}.filename
Add a line which lists a keyword for each file as follows:
bgimages=nice,antibes,cannes
Then add a line linking each keyword to the associated filename:
bgimage.nice.filename=nice.jpg
bgimage.antibes.filename=antibes.jpg
bgimage.cannes.filename=cannes.jpg
Save and close the file, then restart 3View as explained in Appendix C.
64
v1.0 January 2012
3View User Guide
Appendix E
GNU General Public License Version 3
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL
that there is no warranty for this free software. For
authors' sake, the GPL requires that modified versions
changed, so that their problems will not be attributed
authors of previous versions.
clearly explains
both users' and
be marked as
erroneously to
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
65
3View User Guide
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
66
v1.0 January 2012
3View User Guide
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
67
3View User Guide
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
68
v1.0 January 2012
3View User Guide
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
69
3View User Guide
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
70
v1.0 January 2012
3View User Guide
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
71
3View User Guide
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
72
v1.0 January 2012
3View User Guide
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
73
3View User Guide
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year><name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
74
v1.0 January 2012
3View User Guide
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year><name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
75

3View User Guide

Transcription

Similar documents

Giuliana Rancic - Stephanie Stephens

Silego Technology - Globalpress Electronics Summit

coRcIAL. BaNks

ETRM Solutions - Primetech Systems Inc.

Convergence Challenges for the SME

WELCOME TO CAESARS PALACE

Vodafone template - Microsoft Advertising

How to File Sales Tax Online

Slides