Académique Documents
Professionnel Documents
Culture Documents
Servers
Getting Started Guide
Supporting
BMC PATROL for Virtual Servers 2.9.00
December 2009
www.bmc.com
Contacting BMC Software
You can access the BMC Software website at http://www.bmc.com. From this website, you can obtain information
about the company, its products, corporate offices, special events, and career opportunities.
United States and Canada
Address BMC SOFTWARE INC Telephone 713 918 8800 or Fax 713 918 8000
2101 CITYWEST BLVD 800 841 2031
HOUSTON TX 77042-2827
USA
Outside United States and Canada
Telephone (01) 713 918 8800 Fax (01) 713 918 8000
Customer support
You can obtain technical support by using the BMC Software Customer Support website or by contacting Customer
Support by telephone or e-mail. To expedite your inquiry, see “Before contacting BMC.”
Support website
You can obtain technical support from BMC 24 hours a day, 7 days a week at http://www.bmc.com/support. From this
website, you can
■ read overviews about support services and programs that BMC offers
■ find the most current information about BMC products
■ search a database for issues similar to yours and possible solutions
■ order or download product documentation
■ download products and maintenance
■ report an issue or ask a question
■ subscribe to receive proactive e-mail alerts when new product notices are released
■ find worldwide BMC support center locations and contact information, including e-mail addresses, fax numbers, and
telephone numbers
3
License key and password information
If you have questions about your license key or password, contact BMC as follows:
■ (USA or Canada) Contact the Order Services Password Team at 800 841 2031, or send an e-mail message to
ContractsPasswordAdministration@bmc.com.
■ (Europe, the Middle East, and Africa) Fax your questions to EMEA Contracts Administration at +31 20 354 8702, or send
an e-mail message to password@bmc.com.
■ (Asia-Pacific) Contact your BMC sales representative or your local BMC office.
Contents 5
Uninstalling all products and log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Index 95
Contents 7
8 BMC PATROL for Virtual Servers Getting Started Guide
Figures
PATROL for Virtual Servers physical view (VMware environment) . . . . . . . . . . . . . 16
PATROL for Virtual Servers logical view (VMware environment) . . . . . . . . . . . . . . 17
Top 10 ESX Hosts report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Enterprise Inventory report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
List All Virtual Machines report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
ESX Servers Configuration report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
PATROL for Virtual Servers view (Citrix XenServer environment) . . . . . . . . . . . . . . 26
XenServer configuration report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Figures 9
10 BMC PATROL for Virtual Servers Getting Started Guide
Tables
Requirements for installing PATROL for Virtual Servers . . . . . . . . . . . . . . . . . . . . . 30
Default values for PATROL location variables for Windows . . . . . . . . . . . . . . . . . . . 41
Default values for PATROL location variables for UNIX . . . . . . . . . . . . . . . . . . . . . . . 42
PATROL for Virtual Servers KM files for the VMware environment . . . . . . . . . . . . . 57
PATROL for Virtual Servers KM files for the XenServer environment . . . . . . . . . . . 58
Accessing KM commands and InfoBoxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Accessing Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Agent configuration variables (VMware environment) . . . . . . . . . . . . . . . . . . . . . . . . 90
Agent configuration variables (Citrix XenServer environment) . . . . . . . . . . . . . . . . . 93
Tables 11
12 BMC PATROL for Virtual Servers Getting Started Guide
Chapter
1
1 Product components and capabilities
The chapter provides a brief overview of the features and functions available in
PATROL for Virtual Servers.
After you create a vCenter connection, PATROL for Virtual Servers automatically
discovers the hosts (ESX servers) and their associated virtual machines.
After discovery, PATROL for Virtual Servers creates a mapping of the hierarchical
connections between a physical host (ESX server) and associated virtual machines.
You can organize a virtual environment by either physical host (ESX server)
connections or cluster group connections that you create in vCenter.
■ assess how your virtual and physical resources are being utilized in your virtual
environment
PATROL for Virtual Servers application classes and parameters enable you to
determine the impact that resources assigned to your virtual machines have on
your physical resources.
PATROL for Virtual Servers collects performance and inventory data of the
configured ESX servers and their virtual machines from the respective ESX servers
for distributed or failover data.
You can create filters to include or exclude clusters, hosts, and virtual machines
from monitoring.
You can filter events by managed object type, event severity, event type, and by
the user who triggered the events.
VMware environment supports live migration of a virtual machine from one host
(ESX server) to another. PATROL for Virtual Servers enables you to monitor these
migrations for analysis by using various parameters that display the following
information:
— the number of times that a virtual machine is migrated since the most recent
Agent start
— the number of incoming and outgoing dynamic migrations for the past one hour
one day, and one week
In Figure 1, the virtual environment is shown in the physical view, organized by the
individual host connections contained in the vCenter.
In the logical view, PATROL for Virtual Servers organizes all virtual resources by
data centers, clusters, resource pools, and folders defined in the vCenter.
Figure 2 illustrates how individual hosts and virtual machines are organized using
the logical view.
■ the amount of resources used—how the assigned resources have been used by the
host or virtual machine
■ the hosts (ESX server) that are consuming the largest amount of CPU resources
■ the top ten virtual machines that are connected to these hosts
In the report, data is organized first by each host connection, with that host’s top ten
virtual machines listed underneath. The virtual machines listed for a host are the ones
that are using the most CPU resources.
■ host name
■ name of the virtual machine
■ type of operating system
■ IP address
■ status
■ amount of memory allocated
■ amount of disk space allocated
■ CPU resources used
■ memory resources used
Figure 5 shows a sample List All Virtual Machines report for a host connection:
■ names of ESX servers that are configured using a regular expression for distributed
data collection
■ names of ESX servers that are configured individually for distributed data
collection
■ names of ESX servers that are configured using a regular expression for failover
data collection
■ names of ESX servers that are configured individually for failover data collection
Thin provisioning
Thin provisioning means allocating and committing space on demand, which saves
storage space. When you have one or more thin provisioned disks in vCenter,
PATROL for Virtual Servers enables you to monitor the following using various
parameters:
■ the percentage usage of the committed space in these disks with respect to the total
provisioned space
For information about the thin provisioning parameters, see the PATROL for Virtual
Servers online Help.
To monitor the Citrix XenServer environment, you can add either a resource pool
master or a standalone host. When you add a resource pool master for monitoring,
PATROL for Virtual Servers discovers the inventory (hosts, virtual machines, and
storage repository) of that resource pool. It also fetches performance data such as
memory, network, processor, and disk details for all the hosts and virtual
machines that are part of the resource pool. A resource pool comprises of multiple
hosts, bound together into a single managed entity that can host virtual machines.
Shared repositories are discovered at the resource pool level and local repositories
are discovered at each host level.
For a standalone host (one that is not part of a resource pool), PATROL for Virtual
Servers discovers all the virtual machines and storage repository associated with
the host. It also fetches the performance data such as memory, network, processor,
and disk details for the standalone host and the associated virtual machines.
After discovery, PATROL for Virtual Servers creates a mapping of the hierarchical
connections between a physical host (XenServer) and associated virtual machines.
■ assess how your virtual and physical resources are being utilized in your virtual
environment
Application classes and parameters enable you to determine the impact that
resources assigned to your virtual machines have on your physical resources.
PATROL for Virtual Servers collects inventory data for the hosts, virtual machines,
and storage repositories in the Citrix XenServer environment.
BMC Performance Manager for Virtual Servers collects performance data for the
configured hosts and their virtual machines. After you add a host to the Citrix
XenServer environment and if the host is part of a resource pool, you need to
configure performance data collection account for all the hosts in that resource
pool to collect performance data. If that host is not part of any resource pool, you
do not need to configure performance data collection for that host.
PATROL for Virtual Servers monitors both types of migrations and displays the
number of virtual machines that are migrated to and from a host during the last
hour in the Host_VMInMigrations and Host_VMOutMigrations parameters for the
host. For a virtual machine, it also displays the number of times that machine was
migrated during the last hour. When a virtual machine is migrated, annotation of
the VM_MigrationCount parameter displays the following information:
■ access report
The performance data that you can measure includes the following:
■ how the resources are being used by the hosts or virtual machines
■ the rate of resource utilization, which is percentage of resources used versus the
amount of resources allotted
■ If the PATROL Agent is running and the performance data collection account is
not configured for the hosts in the resource pool: In this case, the KM is not able to
find the credentials for the new pool master. Therefore, you need to configure the
performance data collection account for the new pool master.
■ PATROL Agent is not running: In this case, at the startup of the PATROL Agent,
inventory is not discovered and the new pool master IP address and DNS mapping
is not done. Therefore, the KM is not able to find the IP address of the new pool
master. You need to modify the pool master details to start the monitoring.
2
2 Installing PATROL for Virtual Servers
This chapter provides the information that you need to install PATROL for Virtual
Servers. For information about the PATROL installation process, see the PATROL
Installation Reference Manual. The following topics are discussed in this chapter:
Local installation
If you install locally, you must install PATROL for Virtual Servers and a PATROL
Agent on the computer used to monitor VMware vCenter. In the PATROL 3.x
environment, you must also install PATROL for Virtual Servers and a PATROL
Console for Windows or UNIX on each computer from which you want to view
results.
If you install locally in a PATROL 7.x environment, you must install PATROL for
Virtual Servers on the computer that hosts the PATROL Console Server.
Remote installation
If you create an installable image, the product configuration information that you
enter, such as the BMC Software products installation directory, account names,
passwords, PATROL Agent port number, and security options, must be the same for
all computers on which the image is to be installed. If you want to specify different
settings for different computers, you must either create a separate image for each set
of values that you want to implement or edit the variables in the image’s control file
by using the ctltool utility.
For more information about creating, distributing, and installing installable images,
and about using the ctltool utility, see the PATROL Installation Reference Manual.
— monitor, manage, and develop KMs on UNIX by using a PATROL Console for
UNIX (PATROL 3.x architecture)
■ Managed Systems (also referred to as agent computers) host software that manages
the resources on the computer, such as a PATROL Agent or PATROL Knowledge
Modules (KMs). Select this option if the computer to which you are installing will
perform any of the following roles:
— host a PATROL Agent 3.5 (works with both the PATROL 3.x and PATROL 7.x
architecture)
— host KMs and components that contain the knowledge that PATROL uses to
monitor the resources on this computer
■ A Common Services (in only PATROL 7.x architecture) computer hosts services that
are shared among managed systems and console systems. You can install each of
these common services on any computer in the network. Select this option if the
computer to which you are installing will perform any of the following roles:
— host the PATROL Central Operator – Web Edition (PATROL 7.x architecture)
Web server
— host the PATROL Console Servers
— host the RTservers
PATROL 3.x
In a PATROL 3.x environment, you must install KMs on the following computers:
■ Computers hosting the PATROL Console for Windows or PATROL Console for
UNIX—Select Console Systems as the System Role in the installation utility when
installing KMs on computers hosting the PATROL Console for Windows or
PATROL Console for UNIX. This selection installs KM files for use by the console.
PATROL 7.x
In a PATROL 7.x environment, you must install KMs on the following computers:
NOTE
If you do not install each KM on the computer hosting the PATROL Console Server and
select Common Services Systems as the System Role in the installation utility, no KM icons
or KM Help files will be available in either PATROL Central Operator – Microsoft
Windows Edition or PATROL Central Operator – Web Edition.
When using PATROL Central Operator – Web Edition, install KMs on computers
hosting the PATROL Console Server using the Common Services Systems role and
computers hosting the PATROL Agent using the Managed Systems role.
For more information about the PATROL 7.x architecture, see the PATROL
Infrastructure Planning Guide.
For more information about implementing and using PATROL security, see the
following documentation:
NOTE
By default, the installation process configures the PATROL Agent to connect to a Classic
console through port 3181. This is the default port the Classic Console will use to attempt to
connect to the Agent. It is the port number that the Agent is bound to for outside
communications, and should not be confused with the port number that is used to
communicate with the RT Server.
■ You first should install on a limited number of computers in the test environment,
test the installation thoroughly, and then install in your production environment.
■ (UNIX only) If you want to install PATROL for Virtual Servers on a computer
running UNIX Classic console, UNIX Console Server, or UNIX Web Edition that
does not have a browser installed, you must have access to a second computer that
runs a browser that is supported by the installation utility. You can also install
without a browser if you build an image and run a silent install.
1 From an installation image that has been electronically downloaded from an EPD
site, run
■ setup.exe (Windows)
■ setup.sh (UNIX)
(UNIX only) If you are installing into a UNIX environment without a browser,
perform the following steps to launch the installation utility:
A From a command line, change to the directory to where the installation utility is
located and enter the following command to start the installation web server:
./setup.sh -serveronly
C Connect to the installation Web server from the browser to start the installation
utility by using the URL that is displayed in the message box on the computer in
which you are installing the product.
2 On the Welcome to the Installation Utility page, click Next to begin installation.
3 Review the license agreement, select Accept, and click Next to continue.
4 On the Select Installation Option page, select Install products on this computer now,
and click Next to continue.
5 On the Specify Installation Directory page, accept the default directory and click
Next to continue.
6 On the Select System Roles page, select any or all of the following roles to indicate
the components that you want to install and click Next.
■ If you are installing to a computer that hosts or will host a PATROL Console for
Windows or PATROL Console for UNIX, select Console Systems.
■ If you are installing to a computer that hosts or will host a PATROL Agent,
select Managed Systems.
NOTE
PATROL for Virtual Servers is supported only on a managed system that hosts or will
host a PATROL Agent on a supported Windows operating system.
■ If you are installing to a computer that hosts or will host the PATROL Central
Operator – Web Edition Web server, the PATROL Console Server, or the
RTserver, select Common Services.
7 On the Select Products and Components to Install page, select PATROL for Virtual
Servers, and click Next.
8 On the Provide the PATROL 3.x Product Directory page, enter the directory in
which you want to install PATROL for Virtual Servers.
This directory is appended to the base directory path that is shown in the BMC
Products Installation Directory field. The installation directory was entered in
step 5 on page 36.
9 (Windows only) On the Confirm BMC Product Startup Information page, perform
the following steps:
A In the Specify the Current Agent Port field, enter the port number that you want
the PATROL Agent to use. The default port number is 3181.
NOTE
If your previous installation used a different port number, change the default to the current
port number for the PATROL Agent.
B In the Restart the PATROL Agent automatically? field, select the appropriate
option:
■ Select Yes if you want the installation utility to restart the PATROL Agent
after the installation is complete.
■ Select No if you want to restart the PATROL Agent manually after the
installation is complete.
NOTE
This window will not be displayed if you are not installing into a managed system.
10 On the Review Selections and Install page, review the selections carefully to ensure
that they are correct.
11 When the status window reports that the installation is 100% complete, click Next
to view the results window to verify that the PATROL for Virtual Servers installed
successfully.
12 (optional) In the results window, click View Log to review the details of the
installation.
set(“/AgentSetup/AgentTuning/runqSchedPolicy”, “2”);
set(“/AgentSetup/AgentTuning/pslInstructionMax”, “5000000”);
■ install, uninstall, upgrade, and reinstall products on remote systems from one
central location.
■ view reports to check distribution status, gather distribution data, and diagnose
problems.
Ensure that you use the Distribution Server version 7.1.01 or later and apply any
available patches.
1 Using the Distribution Server Manager, start the Distribution Server and connect
to it.
4 Navigate to the location where the components are located and select the directory
that contains the Products directory (do not select the Products directory itself), and
click Next.
If the components are not accessible on a local drive, you can specify a path on the
network.
5 Select the check boxes for the components that you want to import, and click OK.
To set up products
1 Import components into the Distribution Server repository on the Components tab
of the Distribution Manager.
To set up systems
1 Create accounts in the operating system of the computers to which you want to
distribute PATROL for Virtual Servers.
2 Add accounts and create profiles for the systems on the Systems tab of the
Distribution Manager.
3 Add the systems and install the Distribution Client on the Systems tab of the
Distribution Manager.
4 Arrange systems in system groups on the Systems tab of the Distribution Manager.
To distribute products
2 Run reports to review distributions on the Reports tab of the Distribution Manager.
For detailed instructions about how to perform remote installations with the
Distribution Server, see the Distribution Server Getting Started Guide.
1. From the Start Menu, select Start => Settings => Control
Panel.
1. From the Start Menu, select Start => Programs => BMC
PATROL => PATROL Environment Probe.
NOTE
If the KM was pre-loaded, pre-load the VSM.kml again after the upgrade. If the KM was
not pre-loaded, then load the VSM.kml or VSM_XEN.kml depending upon the
environment you want to monitor.
5 Start the PATROL Central console and connect to the PATROL Agent.
To upgrade the PATROL for Virtual Servers KM in the PATROL Classic console
environment
2 Backup the PATROL Classic console cache and then delete the cache.
NOTE
If the KM was pre-loaded, pre-load the VSM.kml again after the upgrade. If the KM was
not pre-loaded, then load the VSM.kml or VSM_XEN.kml depending upon the
environment you want to monitor.
5 Start the PATROL Classic console and connect to the PATROL Agent.
NOTE
Installation requirement
You must install Netscape Navigator on the computer where the PATROL console
resides. You can install Netscape anywhere on your UNIX computer as long as the
binary is in the path.
Download location
At the time of publication, you can download UNIX versions of Netscape Navigator
from ftp://ftp.netscape.com/pub/communicator/.
LANG variable
The UNIX LANG environment variable must be set to C so that Netscape Navigator
will work properly. Otherwise, you might experience product failures.
PATH variable
The PATROL user account PATH variable must contain the location of the directory
containing the Netscape files. If the directory containing the Netscape files is not in
the path, add the directory to the PATROL user account path.
This requirement applies only to the PATROL user account on the PATROL console
computer.
PATROL_BROWSER variable
When PATROL starts the Help browser, it uses the command in the
PATROL_BROWSER environment variable. As a default, the PATROL_BROWSER
environment variable contains the following command:
EXAMPLE
For a Korn shell:
WARNING
If you use a different version of the installation program to uninstall, you might remove files
needed to perform uninstallation of other BMC Software products.
BMC_ROOT\Uninstall
uninstall.exe -v
If you want to retain log and configuration files, record the installation directory
where the products that you want to remove reside.
1 From the Uninstall directory in your BMC Software product installation directory,
double-click uninstall.exe to launch the installation utility in uninstall mode.
NOTE
As an option, you can launch the installation utility in uninstall mode by choosing Start =>
Settings => Control Panel => Add/Remove Programs and double-clicking BMC Software
Tools in the Add/Remove Programs Properties dialog box.
3 Select the installation directory from which you want to remove a product, and
click Next.
4 Select the product or products that you want to uninstall, and click Next.
After the uninstallation is complete, a window is displayed that tells you whether
the uninstallation was successful.
./uninstall.sh
3 Select the installation directory from which you want to remove a product, and
click Next.
4 Select the product or products that you want to uninstall, and click Next.
After the uninstallation is complete, a window is displayed that tells you whether
the uninstallation was successful.
1 If you are uninstalling from a UNIX environment without a browser, perform the
following steps to launch the installation utility:
A From a command line, change to the Uninstall directory and enter the following
command to start the installation Web server:
./uninstall.sh -serveronly
B A message box is displayed that shows the URL to use to connect to the
installation Web server.
D Connect to the installation Web server from the browser to start the installation
utility by using the URL that is displayed in the message box.
3 Select the installation directory from which you want to remove a product, and
click Next.
4 Select the product or products that you want to uninstall, and click Next.
After the uninstallation is complete, a window is displayed that tells you whether the
uninstallation was successful.
BMCProductsInstallationDirectory\Uninstall\Install\instdata
3 Open the uninstall.ctl file in a text editor, and edit the /BMC/Base variable to specify
the name of the directory from which you removed the products in step 2.
BMCProductsInstallationDirectory\Uninstall\Install\ instbin
Use the following table to help determine the log file and output log file locations:
Windows example
This command removes all installation files and directories except those that are used
by the utility at the time the uninstallation was performed. The command also
ensures that all log files, configuration files, and user-modified files are retained.
BMCProductsInstallationDirectory/Uninstall/Install/instdata
3 Open the uninstall.ctl file in a text editor, and edit the /BMC/Base variable to specify
the name of the directory from which you removed the products in step 1.
BMCProductsInstallationDirectory/Uninstall/Install/ instbin
Use the following table to help determine the log file and output log file locations:
UNIX example
This command removes all installation files and directories except those that are used
by the utility at the time the uinstallation is performed. Log files, configuration files,
and user-modified files, are also retained.
BMCProductsInstallationDirectory\Uninstall\Install\instdata
3 Open the uninstall-all.ctl file in a text editor, and edit the /BMC/Base variable to
specify the name of the directory from which you removed the products in step 2.
BMCProductsInstallationDirectory\Uninstall\Install\instbin
Use the following table to help determine the log file and output log file locations:
Windows example
This command removes all installation files and directories. The files used to perform
the installation are marked for deletion and are removed when the computer on
which the products were uninstalled is rebooted.
BMCProductsInstallationDirectory/Uninstall/Install/instdata
3 Open the uninstall-all.ctl file in a text editor, and edit the /BMC/Base variable to
specify the name of the directory from which you removed the products in step 1.
BMCProductsInstallationDirectory/Uninstall/Install/instbin
Use the following table to help determine the log file and output log file locations:
UNIX example
This command removes all installation files and directories. The files used to perform
the installation are marked for deletion and are removed when the computer on
which the products were uninstalled is rebooted.
3
Loading and configuring PATROL for
3
Virtual Servers
This chapter provides information about how to configure and use PATROL for
Virtual Servers. In this chapter, the term Knowledge Module (KM) is usually
equivalent to a .kml file. A .km file is equivalent to an application class, which is a
subset of a KM or .kml file.
■ The PATROL console version 3.5.2x or later and PATROL for Virtual Servers are
installed on the computer that you want to use for the PATROL console.
■ The PATROL Agent version 3.6.x or later and PATROL for Virtual Servers are
installed on the computer that you want to monitor and manage.
■ If you are using PATROL Central Operator – Web Edition, PATROL for Virtual
Servers is installed on the PATROL Console Server and PATROL Web Server.
Table 4 PATROL for Virtual Servers KM files for the VMware environment
(part 1 of 2)
File Description
VSM.kml loads all the application classes required to monitor the
VMware vCenter environment
VSM.km monitors hosts (ESX servers)
VSM_CLUSTER.km monitors the clusters used in vCenter
VSM_CNTR.km serves as a container for other application classes
VSM_CPU.km monitors CPU performance and utilization for hosts
VSM_CPU_CNTR.km serves as a container for application classes that monitor
CPU use and utilization for hosts and virtual machines
VSM_CPU_VM.km monitors CPU performance and utilization for virtual
machines
VSM_DATACENTER.km serves as a container for application classes that monitor
hosts and virtual machines
VSM_DATASTORE.km represents a datastore that is a storage location for all
files constituting a virtual machine configuration and
disks
VSM_DISK.km serves as a container for application classes that monitor
the disks used by virtual machines
VSM_DISK_CNTR.km serves as a container class for all the disk instances of a
virtual machine
VSM_DISK_PERF.km contains the parameters used to indicate the disk
performance of a physical host (ESX server) and virtual
machine
VSM_EVENTS.km contains the parameters that describe the status of an
event filter and the type and number of events
monitored by the event filter
VSM_EVENTS_CNTR.km serves as a container for all the event filters that are
configured for vCenter
VSM_FOLDER.km serves as a container for storing inventory objects
VSM_GUEST_DISKS.km discovers the virtual disks configured for the guest
operating system
VSM_HBA.km discovers storage adapters of an ESX server
VSM_HOST.km monitors ESX servers
VSM_MEMORY_V2.km monitors memory utilization by hosts and virtual
machines
VSM_RESOURCE_POOL.km represents a pool of physical resources indicating the
amount of computing power available to a host or
cluster of hosts
Table 4 PATROL for Virtual Servers KM files for the VMware environment
(part 2 of 2)
File Description
VSM_SCSI_LUN.km discovers disk SCSI LUNs of an ESX server
VSM_VC.km monitors a vCenter
VSM_VM.km monitors a virtual machine
VSM_VMOTION_CLUSTER.km monitors automatic migrations for a cluster
VSM_VMOTION_HOST.km monitors automatic migrations for a host
VSM_VMOTION_VM.km monitors automatic migrations for a virtual machine
VSM_VNET_PERF.km contains the parameters used to indicate the network
performance of a physical host (ESX server) and virtual
machine
Table 5 PATROL for Virtual Servers KM files for the XenServer environment
(part 1 of 2)
File Description
VSM_XEN.kml loads all the application classes required to monitor
the Citrix XenServer environment
VSM_XEN.km serves as a container for all XenServer monitoring
application classes
VSM_XEN_HOST.km represents the instances of individual hosts
(XenServers)
VSM_XEN_HOST_CNTR.km serves as a container for all host instances
VSM_XEN_HOST_MEMORY.km contains parameters that indicate how memory is
being used by a host (XenServer)
VSM_XEN_PCPU.km represents the CPU instances of the host and contains
parameters used to indicate the CPU details and CPU
utilization by a host
VSM_XEN_PCPU_CNTR.km serves as a container for the CPU instances of a host
VSM_XEN_PNET.km represents the physical network instances of a host
and contains parameters that indicate the network
performance
VSM_XEN_PNET_CNTR.km serves as a container for the physical network
instances
Table 5 PATROL for Virtual Servers KM files for the XenServer environment
(part 2 of 2)
File Description
VSM_XEN_RESOURCEPOOL.km represents a XenServer resource pool
1 In the Common Tasks tab of PATROL Central Operator Taskpad, click the Load
Knowledge Modules icon.
The wizard lists each computer on which a PATROL Agent has been installed.
3 Select the check boxes for the managed systems on which you want to load KMs,
and then click Next.
The wizard displays a list of available .kml files for each selected computer. Each
.kml file is listed once for each computer. You can display .km files instead
(equivalent to application classes) by changing the filter. The KMs available in this
product are listed in Table 4 on page 57 and Table 5 on page 58.
4 Click the Knowledge Module Lists tab, select the check box for the VSM.kml and
VSM_XEN.kml files to load PATROL for Virtual Servers, and then click Next.
You can load a .kml file on only a specific managed system by expanding the tree
for that KML and selecting the check box for just that managed system. You can
also load individual Knowledge Modules (.km files) on the Individual Knowledge
Modules tab.
5 Click Finish.
The Load KMs page appears, listing each computer on which a PATROL Agent
has been installed.
2 Select each computer on which you want to load the same KMs, and click Next.
The Load KMs page displays a list of available .km and .kml files.
NOTE
If you selected more than one computer, the Load KMs page displays only the .km
and .kml files that have been installed on all of the selected computers. If you want
to load a particular .km or .kml file on a particular computer, select that computer
by itself to load the file.
3 Select the VSM.kml and VSM_XEN.kml files to load PATROL for Virtual Servers.
4 Click Finish.
1 From the PATROL Console for Microsoft Windows menu bar, choose File => Load
KM.
The Load KMs dialog box displays a list of available .kml files. You can display .km
files instead (equivalent to application classes) by selecting KM Files (*.km) from
the list.
2 Select the VSM.kml and VSM_XEN.kml files to load PATROL for Virtual Servers,
and click Open.
PATROL loads the selected KMs on all of the computers listed under
PATROLMainMap in the tree view.
1 From the PATROL Console for UNIX menu bar, choose File => Load KM.
The Load KMs dialog box displays a list of available .kml files. You can display .km
files instead (equivalent to application classes) by changing the filter.
2 Select the VSM.kml and VSM_XEN.kml files to load PATROL for Virtual Servers,
and click Open.
PATROL loads the selected KMs on all of the computers to which your console is
connected.
To preload a KM, add it to the agent preload list by using the wpconfig or xpconfig
utility, as described in this section. For information about the wpconfig or xpconfig
utility, see the PATROL Agent Reference Manual.
■ You must have permission to modify the configuration change file (.cfg).
1 Access the pop-up menu for a PATROL Agent and choose Development => Agent
Configuration.
The console starts the wpconfig utility and displays the wpconfig window.
The variables in the AgentSetup folder are displayed in the right pane.
3 Scroll down the variable list and double-click the preloadedKMs variable.
6 In the Value field, use the comma-separated format without spaces to type the
names of the .kml files that you want to preload (for example, VSM.kml for
PATROL for Virtual Servers).
See Table 4 on page 57 and Table 5 on page 58 for a list of the KMs that are
available in this product.
7 Click OK.
The Apply Configuration dialog box is displayed, listing the PATROL Agent host
name to which you are connected.
11 Save your changes to the configuration change file by clicking the Save button.
1 Access the pop-up menu for a PATROL Agent and choose Development => Agent
Configuration.
The console starts the xpconfig utility and displays the xpconfig window.
2 From the Host column in the left pane of the xpconfig window, click a PATROL
Agent computer name to highlight it.
The configuration variables for the selected computer are displayed in the
Variables column in the right pane.
/AgentSetup/pre*
The filter displays all the variables that begin with this character string.
6 Click Change.
7 Use the comma-separated format without spaces to type the names of the .kml files
that you want to preload (for example, VSM.kml for PATROL for Virtual Servers).
See Table 4 on page 57 and Table 5 on page 58 for a list of the KMs that are
available in this product.
8 Choose File => Exit to close the Edit window and save your changes.
The xpconfig utility sends the updated configuration to the selected PATROL
Agent.
When you unload a .km file, its corresponding application class no longer appears in
your console. Unloading a .km file does not delete the file from the lib\knowledge or
psl directories on the PATROL console or PATROL Agent computer. If you want to
delete a KM completely from your system, you must uninstall the KM.
If a .km file was preloaded, unloading it does not stop the PATROL Agent from
collecting data for that .km file. However, if the .km file was not preloaded, then
unloading it does stop the file from running and collecting data on the PATROL
Agent.
If you no longer want the PATROL Agent to run a KM that was preloaded, you can
remove its corresponding .kml file or .km files from the PATROL Agent preload list as
described in “Removing KMs from the agent preload list” on page 67.
When you remove a KM from the PATROL Agent preload list, the agent does not run
the KM unless you load it with a running console. KMs that are not preloaded do not
run when no console is running.
NOTE
Unloading a KM is also referred to as deleting a KM in the PATROL Console for Windows
and the PATROL Console for UNIX. However, the files are actually unloaded from the
memory of a console rather than deleted from your hard drive.
1 On the Common Tasks tab of the taskpad, click the Unload Knowledge Modules icon.
The wizard lists each computer on which a PATROL Agent has been installed.
3 Select the check boxes for the computers from which you want to unload .km files,
and click Next.
The wizard displays a list of application class names (that correspond to .km file
names) for each computer selected. Each application class name is listed once for
each computer.
4 Select the check boxes for the .km and computer pair that you want to unload, and
click Next. To unload an entire KM, select all the .km files that make up the KM.
See Table 4 on page 57 and Table 5 on page 58 for a list of the .km files in each KM.
5 Click Finish.
The console removes the selected .km files from the current management profile.
1 From the Managed Systems page, click the Load/Unload KMs button.
The Load KMs page opens, listing each computer on which a PATROL Agent has
been installed.
2 Select the computers from which you want to unload .km files, and click Next.
The Load KMs page displays a list of .km files. Currently loaded .km files are
highlighted (selected) in the list.
3 Cancel the selection of the .km files that you want to unload by clicking them in the
list.
4 To unload an entire KM, cancel the selection of all the .km files that make up the
KM.
See Table 4 on page 57 and Table 5 on page 58 for a list of the .km files in each KM.
5 Click Finish.
The console removes the .km files that you specified from the current management
profile.
1 From the KM tab of the tree view, right-click the application class name that you
want to delete and choose Delete from the pop-up menu.
The console displays a dialog box that asks if you want to delete the selected
application.
The application class is removed from your console, and its corresponding .km file
is removed from your console session file when you save your changes.
3 Repeat Step 1 and Step 2 until you have deleted all of the application classes (.km
files) associated with the KM that you want to delete.
4 From the console menu bar, choose File => Save KM to save your changes.
1 From the PATROL Main window, choose Attributes => Application Classes.
2 Click the name of the application class that you want to delete.
3 From the List of Application Classes menu bar, choose Edit => Delete.
The application class is removed from your console, and its corresponding .km file
is removed from your console session file when you save your changes.
4 Repeat Step 2 and Step 3 until you have deleted all of the application classes
associated with the KM that you want to delete.
5 From the List of Application Classes menu bar, choose File => Save KM to save
your changes.
■ You must have permission to modify the configuration change file (.cfg).
To remove a KM from the preload list in the PATROL Console for Microsoft
Windows
1 Access the pop-up menu for a PATROL Agent and choose Development => Agent
Configuration.
The console starts the wpconfig utility and displays the wpconfig window.
The variables in the AgentSetup folder are displayed in the right pane.
3 Scroll down the variable list and double-click the preloadedKMs variable.
6 In the Value field, delete the .kml file names that you want to remove from the
preload list.
See Table 4 on page 57 and Table 5 on page 58 for a list of the KMs that are
available in this product.
The Apply Configuration dialog box is displayed, listing the PATROL Agent host
name to which you are connected.
11 Save your changes to the configuration change file by clicking the Save button.
To remove a KM from the Preload List in the PATROL Console for UNIX
1 Access the pop-up menu for a PATROL Agent and choose Development => Agent
Configuration.
The console starts the xpconfig utility and displays the xpconfig window.
2 From the Host column in the left pane of the xpconfig window, click a PATROL
Agent computer name to highlight it.
The configuration variables for the selected computer are displayed in the Variables
column in the right pane.
/AgentSetup/pre*
The filter displays all the variables that begin with that character string.
7 Delete the .kml file names that you want to remove from the preload list.
See Table 4 on page 57 and Table 5 on page 58 for a list of the KMs that are
available in this product.
8 Choose File => Exit to close the Edit window and save your changes.
The xpconfig utility sends the updated configuration to the selected PATROL
Agent.
Port Setting
VMware Virtual Infrastructure Web Service https port 443
VMware Virtual Infrastructure Web Service http port 80
VMware vCenter diagnostics port (TCP/IP) 8083
VMware vCenter port (TCP/IP) 902
VMware vCenter heartbeat port (UDP) 902
After you have installed the vCenter Web Service, confirm that the account given to
the KM can access the interface.
1 Open a browser and enter the name of the ESX server in the address line.
2 Click Browse objects managed by this host, located on the bottom right of the page.
4 Click OK.
The vCenter Web Service opens. If it does not, check with the vCenter
administrator to verify account settings.
NOTE
Changes to port settings require a manual restart of vCenter.
vCenter settings
The user must have at least read permission to highest level of the vCenter tree.
1 Select the highest object in the left hand treeview of vCenter so, as the account is
added, you will have access to all the objects below.
2 On the Permissions tab, right-click the user name and select Properties.
4 Click OK.
1 Select the highest object in the left hand treeview of vCenter so, as the account is
added, you will have access to all the objects below.
2 On the Permissions tab, right-click the user name and select Properties.
4 Click OK.
NOTE
After you make changes to account settings in vCenter, you must restart the application.
NOTE
If you connect to the same ESX 3.5 and later host through vCenter and directly through the
host, you will collect redundant data. Be sure to choose one option or the other when
collecting data from ESX 3.5 and later hosts.
You can configure ESX servers for distributed or failover data collection at a later
stage also. For more information about distributed and failover data collection, see
“Managing ESX servers for distributed or failover data collection in VMware
environment” on page 75.
1 In the PATROLMainMap tree, right-click the VMware vSphere node and choose
KM Commands = > Configure Service URL.
2 In the PATROL for Virtual Servers on host hostName dialog box, in the Host text
box, enter the host name or IP address of the vCenter to which you want to
connect.
3 In the Port text box, enter the port number for the vCenter.
See “Troubleshooting port number issues” on page 70 for more information about
port settings in vCenter.
NOTE
By default, the vCenter port number should appear in the Port text box. Do not modify the
default port number, unless the port number that you are using for vCenter is different
from the default. For vCenter version 2.5, the default port number is 443.
4 In the Username and Password text boxes, enter the user name and password
required to connect to the vCenter.
5 (Optional) In the Filter Clusters text box, specify one of the following and select
Include or Exclude to include or exclude the clusters from the inventory:
■ a regular expression to filter clusters that you want to include or exclude from
inventory
NOTE
If you enter a regular expression to include or exclude a cluster, all the hosts and virtual
machines under that cluster are included or excluded from the inventory.
6 (Optional) In the Filter Hosts text box, specify one of the following and select Include
or Exclude to include or exclude the hosts from the inventory:
■ a regular expression to filter hosts that you want to include or exclude from
inventory
NOTE
■ if you specify a pipe-separated (|-separated) list of host names, those names must be
fully qualified domain names of the ESX servers.
■ If you enter a regular expression to include or exclude a host, all the virtual machines
under that host are included or excluded from the inventory.
7 (Optional) In the Filter VMs text box, specify one of the following and select Include
or Exclude to include or exclude the virtual machines from the inventory:
The vCenter connection appears in the Select vCenter/ESX Server to remove list.
10 In the Configure Data Collection message box, click Yes to confirm that you want
to configure ESX servers, or click No to configure the ESX servers later.
12 To configure one ESX server, enter the name of ESX server in the ESX severs (s) text
box.
■ Select the Use regular expression check box, and enter a regular expression. All
the ESX servers that satisfy the regular expression will be configured.
NOTE
If you want to configure multiple ESX servers simultaneously, a common user with the
same password needs to be created on each of the ESX servers.
14 Select the Use vCenter credentials check box to use vCenter credentials.
1 Right-click the VMware vSphere node, and choose Configure Service URL.
2 In the PATROL for Virtual Servers on host hostName dialog box, from the Select
vCenter/ESX Server to Remove list, select the vCenter connection or ESX server to be
removed.
4 Click Apply.
5 In the Confirm Removal dialog box, click Apply to remove the vCenter or ESX
server connection.
The vCenter or ESX server connection is removed from the Select vCenter/ESX
Server to Remove list.
For more information about creating a list of virtual machines, see the PATROL for
Virtual Servers online Help.
For more information about creating this report, see the PATROL for Virtual Servers
online Help.
For more information about creating this report, see the PATROL for Virtual Servers
online Help.
In distributed data collection, PATROL for Virtual Servers collects performance data
of the configured ESX servers and their virtual machines from the respective ESX
servers and inventory data from vCenter.
In failover data collection, PATROL for Virtual Servers collects performance and
inventory data of configured ESX Servers and their virtual machines from the
respective ESX servers only when vCenter is down.
To configure the ESX server while adding it for monitoring, right-click the VMware
vSphere node and choose KM Commands => Configure Service URL. For more
information, see “Creating a vCenter connection” on page 72.
To configure the ESX servers at a later stage, right- click the VMware vSphere node
and choose KM Commands => Configure Data Collection - Distributed or
Failover => Configure ESX Server(s) List.
For more information about configuring ESX servers, see the PATROL for Virtual
Servers online Help.
For more information about removing ESX servers, see the PATROL for Virtual
Servers online Help.
To modify the regular expressions of ESX servers, right-click the VMware vSphere
node and choose KM Commands => Configure Data Collection - Distributed or Failover
=> Modify Regular Expressions.
For more information about modifying regular expressions, see the PATROL for
Virtual Servers online Help.
For more information about generating a configuration report, see the PATROL for
Virtual Servers online Help.
To configure an element for filtering, right- click the VMware vSphere node and
choose KM Commands => Configure Service URL.
For more information about configuring an element for filtering, see the PATROL for
Virtual Servers online Help.
For more information about modifying existing filters, see the PATROL for Virtual
Servers online Help.
■ Managed object - You can monitor events for a specific managed object (such as
Datacenter, ESX server, virtual machine, and cluster etc.) as well as their child
objects (if any).
■ Event severity - You can monitor the events with the following types of severity:
■ Event type - You can monitor various types of events such as VmConnectedEvent
and VmPoweredOffEvent. By default, all event types are monitored. For more
information about types of events, see VMware documentation.
■ User - You can monitor events for a specific user who triggered those events. By
default, events for all the users are monitored.
Whenever you create a filter, a node with the filter name is created under the Events
node in the PATROLMainMap tree.
For more information about creating filters, see the PATROL for Virtual Servers
online Help.
■ monitor new event types for the existing managed object by using that filter
■ monitor new event severity types for the existing managed object by using that
filter
■ monitor events for different users for the existing managed object
To modify an event filter, right-click the vCenter node and then, choose
KM Commands => Configure Event Monitoring => Modify Filter.
For more information about deleting filters, see the PATROL for Virtual Servers
online Help.
For more information about deleting filters, see the PATROL for Virtual Servers
online Help.
Acknowledging events
When you create filters for event monitoring, depending on the filter criteria you
have specified, following parameters are created under the Events folder of the
managed object:
■ Error
■ User
■ Warning
■ Information
You can acknowledge these parameters whenever they go into warning or alarm
state. After you acknowledge these parameters, they go into OK state. To
acknowledge event filtering parameters, right-click the created filter under the
managed object for which you have created event filters, and choose KM Commands
=> Acknowledge.
To turn the annotations on or off for the event filtering parameters, right-click the
Events folder for the managed object and then, choose KM Commands => Annotations
=> On, or KM Commands => Annotations => Off.
1. Create a connection between PATROL for Virtual Servers and the Citrix XenServer
environment. To do this, you need to add hosts (XenServers) to the Citrix
XenServer environment. For more information, see “Configuring a XenServer” on
page 81.
Configuring a XenServer
To monitor the Citrix XenServer environment, you can either add either a resource
pool master or a standalone host. When you add a resource pool master for
monitoring, PATROL for Virtual Servers discovers the inventory (hosts, virtual
machines and storage repository) of that resource pool. It also fetches performance
data such as memory, network, processor, and disk details for all the hosts and
virtual machines that are part of the resource pool.
For a standalone host (that is not part of a resource pool), PATROL for Virtual Servers
discovers all the virtual machines and storage repository associated with the host. It
also fetches the performance data such as memory, network, processor and disk
details for the standalone host and the associated virtual machines.
When you remove a pool master from monitoring, all the hosts under that resource
pool are also removed from monitoring.
Using Active Directory integration with Citrix XenServer version 5.5, you can
provide access to multiple users to access each resource pool. Because every user
account is given the same set of permissions as the local root account, every user can
download performance and inventory data for the resource pool. If the user account
has been added in the subject list of resource pool, the user can access performance
and inventory data of respective resource pool.
If external authentication has not been enabled for a user account, then the local root
account is required for connecting and collecting inventory and performance data
from XenServers.
Adding a XenServer
To add a host (XenServer) to the Citrix XenServer environment, right-click the Citrix
XenServers node, and choose KM Commands => Configure Citrix XenServer. For more
information about adding a XenServer, see the PATROL for Virtual Servers online
Help.
Removing a XenServer
To remove a XenServer
2 In the Configure Citrix XenServer dialog box, select the pool master or host from
the Select element to remove list.
4 Click Apply.
You can configure performance data collection account for multiple hosts
(XenServers) simultaneously. You can either provide a comma-separated list of hosts
or specify a regular expression. All the hosts that satisfy the regular expression are
configured for performance data collection.
You can also modify the regular expression later to configure performance data
collection account for a different set of hosts or to modify the specified credentials.
After you configure a performance data collection account, you can modify the
account details.
To modify XenServer regular expression, right-click the resource pool node and
choose KM Commands => Modify Regular Expression. For more information, see the
PATROL for Virtual Servers online Help.
■ the KM is monitoring the resource pool and the KM fails to find the host name
corresponding to the new pool master IP address
Use the Configure Performance Data Collection Account menu command to configure
the performance data collection account for the new pool master in the following pool
master failover scenario:
When the KM is monitoring the resource pool and the KM is not able to find the
credentials of the new pool master (because the performance data collection account
is not configured for the new pool master.)
For more information, see the BMC Performance Manager for Virtual Servers online
Help.
A
Accessing Menu Commands,
A
See the BMC Performance Manager for Virtual Servers Help for more detailed
information about navigation in the PATROL consoles.
■ Double-click a
parameter in the KM
tab of the console; from
the properties dialog
box, click the Help tab
and then click Show
Help.
PATROL Central From the console menu ■ In the Operator tab of ■ In the Operator tab of
Operator – Microsoft bar, choose Help => Help the navigation pane, the navigation pane,
Windows Edition Topics. In the Contents select an application select a parameter icon
tab, click PATROL for icon and press F1. and press F1.
Virtual Servers.
■ In the Operator tab of ■ In the Operator tab of
the navigation pane, the navigation pane,
right-click an right-click a parameter
application icon and icon and choose Help.
choose Help.
PATROL Central In the upper right corner of In the tree view, right-click In the tree view, right-click
Operator – Web PATROL Central, click an application class and a parameter and choose
Edition Help and choose PATROL choose Help. Help.
KM Help. In the PATROL
Central Operator – Web
Edition KM Help window,
click PATROL for Virtual
Servers.
B
B Agent configuration variables
This appendix contains the information about the pconfig variables for PATROL for
Virtual Servers that you can set in the PATROL Agent.
TurnOffEvents
/VSM/VC/vCenterName/filters/ stores the names of the filters that are configured for
event monitoring
childList
/VSM/VC/vCenterName/filters/ a flag indicating whether annotation report will be
visible for the event filtering parameters
eventAnnotation
/VSM/VC/vCenterName/filters/filter stores the name of the managed object that you want
Name to monitor through an event filter
objectName
/VSM/VC/vCenterName/filters/filter stores the type of the managed object that you want
Name to monitor through an event filter
objectType
/VSM/VC/vCenterName/filters/filter stores the severity of the event that you want to
Name monitor through an event filter
eventSeverity
/VSM/VC/vCenterName/filters/filter stores the types of the events that you want to
Name monitor through an event filter
eventType
eventUsers
/VSM/VC/vCenterName/filters/filter a flag indicating whether system-generated events
Name will be monitored for a managed object
systemUser
/VSM/VC/vCenterName/filters/filter a flag indicating whether events for the child objects
Name of a managed object will be monitored
childObjects
/VSM/VC/vCenterName/filters/filter stores the description of an event filter
Name
filterDescription
/VSM/VC/vCenterName/ sets maximum heap size value for the vsm_main
Java process. Default is 1200.
vsm_main.maxHeapSize
Valid values are: 256, 512, 1200, and 1500
/VSM/VC/vCenterName/ sets maximum heap size value for the vsm_esx Java
process. Default is 512.
vsm_esx.maxHeapSize
Valid values are: 256, 512, 1200, and 1500
/VSM/VC/vCenterName/ sets maximum heap size value for the vsm_events
Java process. Default is 256.
vsm_events.maxHeapSize
Valid values are: 256, 512, 1200, and 1500
defaultAccount
/XEN/ResourcePool/ stores the comma-separated list of regular expressions
resourcepoolName/ specified while configuring performance data collection
accounts for XenServers in a resource pool
xenRegEXList
/XEN/ResourcePool/ stores the comma-separated list of XenServers for which
resourcepoolName/ performance data collection account is configured
xenHostList
/XEN/ResourcePool/ stores the account associated with the regular expression
resourcepoolName/ stored in the xenRegEXList variable
regularExpression.userAccount
/XEN/ResourcePool/ stores the accounts associated with the XenServers stored
resourcepoolName/ in the xenHostList variable
XenServerName.userAccount
/XEN/XenServer/ sets maximum heap size value for the vsm_main Java
process. Default is 512.
vsm_main.maxHeapSize
Valid values are: 256, 512, 1200, and 1500.
Index
A
acknowledging events 80 distribution server
agent features 39
installing a KM to 33 importing a CD 39
importing an installation package 39
installation process 38
B installing with 39
C LANG 45
PATH 45, 46
C shell 45 setting for Help browser 45
Citrix XenServer environment hierarchy 26 setting for the browser 45
colormap option 45 ESX servers
common services configuring, for distributed or failover data collection
overview 33 76
configuring removing, from distributed or failover data collection
ESX servers, for distributed or failover data collection 76
76 eXceed 45
performance data collection accounts, for XenServers
82
VMware VirtualCenter 69
configuring PATROL for Virtual Servers
F
VMware environment 71 filters
XenServer environment 80 for clusters, hosts, and virtual machines, creating 77
configuring VMware VirtualCenter 69 for clusters, hosts, and virtual machines, modifying 78
console for events, creating 78
installing a KM to 33 for events, deleting 79
console systems overview 33 for events, modifying 79
creating Enterprise Inventory report 75
creating ESX Servers Configuration report 77
creating List all Virtual Machines report 75 H
creating Top 10 ESX Hosts report 75
Hot Plug support 23
creating XenServer Configuration report 83
customer support 2
I
D installation
choosing a target machine 33
distributed or failover data collection
preparing for 31
configuring, for ESX servers 76
system requirements 30
removing, for ESX servers 76
verifying requirements 30
Distributed Resource Scheduler 23
installation utility version 47
Index 95
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
N handling 83
overview 27
Netscape Navigator 44 preloading KMs
from PATROL Console for Microsoft Windows 62
from PATROL Console for Unix 63
O overview 62
preparing PATROL for Virtual Servers for installation 31
online Help product support 2
installing 33 products
overview uninstalling, UNIX environment 48
Enterprise Inventory report 19 uninstalling, Windows environment 48
ESX Servers Configuration 21
List All Virtual Machines report 20
Top 10 ESX Hosts report 18
XenServer Configuration report 27
R
regular expressions
ESX Servers, modifying 76
P XenServers, modifying 83
removing ESX servers from distributed or failover data
PATH environment variable 46 collection 76
PATROL Agent
installing a KM to 33
removing KMs
from a PATROL Console 65 V
from agent preload list 67 variables
overview 64 PATROL_BROWSER 46
reports PATROL_CACHE 41
Enterprise Inventory, creating 75 PATROL_HOME 41
Enterprise Inventory, overview 19 vCenter
ESX Servers Configuration, creating 77 confirm the web server account 70
ESX Servers Configuration, overview 21 Troubleshooting port number issues 70
List all Virtual Machines, creating 75 user account settings in vCenter Web Service 71
List All Virtual Machines, overview 20 user account settings in Virtual Infrastructure Client
Top 10 ESX Hosts, creating 75 71
Top 10 ESX Hosts, overview 18 vCenter connection
XenServer Configuration, creating 83 adding 72
XenServer Configuration, overview 27 removing 74
requirements version of the installation utility 47
overview 30 VMware environment
system 30 switching between a logical and physical view 15
VMware environment hierarchy
logical view 17
S physical view 16
security levels for PATROL 35
setting environment variables for Help browser 45
shells X
Bourne 45 XenServers
C 45 adding 81
Korn 45 removing 82
support, customer 2
system
requirements 30
system requirements 30
system roles
common services 33
console systems 33
managed systems 33
overview of target machines 33
T
target machines, overview 33
technical support 2
Thin provisioning 22
turning annotations on or off for event filtering
parameters 80
U
uninstallation
on Unix 48
on Windows 47
uninstalling products
in UNIX environment 48
in Windows environment 48
upgrading KMs in PATROL environments 43
user account 46
Index 97
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Copyright (c) 2000-2004 The Apache Software Foundation. All rights reserved.
1. Definitions.
“License” shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
“Licensor” shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
“Legal Entity” shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity.
For the purposes of this definition, “control” means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract
or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
“You” (or “Your”) shall mean an individual or Legal Entity exercising permissions granted by this License.
“Source” form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and
configuration files.
“Object” form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object
code, generated documentation, and conversions to other media types.
“Work” shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is
included in or attached to the work (an example is provided in the Appendix below).
“Derivative Works” shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial
revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative
Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
“Contribution” shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or
Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity
authorized to submit on behalf of the copyright owner. For the purposes of this definition, “submitted” means any form of electronic, verbal, or written
communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding
communication that is conspicuously marked or otherwise designated in writing by the copyright owner as “Not a Contribution.”
“Contributor” shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently
incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-
exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and
distribute the Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer
the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or
by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity
(including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory
patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in
Source or Object form, provided that You meet the following conditions:
(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source
form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
(d) If the Work includes a “NOTICE” text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the
attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the
following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the
Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the
NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You
distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as
modifying the License.
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use,
reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the
Work otherwise complies with the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the
Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall
supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as
required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its
Contributions) on an “AS IS” BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE,
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable
law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect,
special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not
limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such
Contributor has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for,
acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations,
You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and
hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or
additional liability.
OpenSSL License
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http:/ / www.openssl.org/ ).
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software must display the following acknowledgment:
“This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)”
4. The names “OpenSSL Toolkit” and “OpenSSL Project” must not be used to endorse or promote products derived from this software without prior written
permission. For written permission, please contact openssl-core@openssl.org.
5. Products derived from this software may not be called “OpenSSL” nor may “OpenSSL” appear in their names without prior written permission of the
OpenSSL Project.
6. Redistributions of any form whatsoever must retain the following acknowledgment: “This product includes software developed by the OpenSSL Project for
use in the OpenSSL Toolkit (http://www.openssl.org/)”
THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE OpenSSL PROJECT OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
====================================================================
Copyright (C) 1995-1998 Eric Young (eay@ cryptsoft.com) All rights reserved.
This library is free for commercial and non-commercial use as long as the following conditions are adhered to. The following conditions apply to all code
found in this distribution, be it the RC4, RSA, lhash, DES, etc., code; not just the SSL code. The SSL documentation included with this distribution is covered
by the same copyright terms except that the holder is Tim Hudson (tjh@cryptsoft.com).
Copyright remains Eric Young's, and as such any Copyright notices in the code are not to be removed. If this package is used in a product, Eric Young should
be given attribution as the author of the parts of the library used. This can be in the form of a textual message at program startup or in documentation (online
or textual) provided with the package.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software must display the following acknowledgement:
“This product includes cryptographic software written by Eric Young (eay@cryptsoft.com)” The word 'cryptographic' can be left out if the rouines from the
library being used are not cryptographic related :-).
4. If you include any Windows specific code (or a derivative thereof) from the apps directory (application code) you must include an acknowledgement: “This
product includes software written by Tim Hudson (tjh@cryptsoft.com)”
THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.
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 clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL
requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
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 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.
0. Definitions.
“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 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.
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 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.
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.
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.
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:
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 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
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.
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 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.
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.
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.
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 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.
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.
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.