You are on page 1of 90

Veeam Reporter 4.

0
User Guide
August 2010
Veeam Reporter 4.0 | User Guide

Copyright © 2005‐2010 Veeam Software Inc. All rights reserved worldwide.

No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval


system, or translated into any language in any form by any means, without written permission
from Veeam Software Inc (Veeam). The information contained in this document represents the
current view of Veeam on the issue discussed as of the date of publication and is subject to
change without notice. Veeam shall not be liable for technical or editorial errors or omissions
contained herein. Veeam makes no warranties, express or implied, in this document. Veeam
may have patents, patent applications, trademark, copyright, or other intellectual property
rights covering the subject matter of this document. All other trademarks mentioned herein
are the property of their respective owners. Except as expressly provided in any written license
agreement from Veeam, the furnishing of this document does not give you any license to
these patents, trademarks, copyrights, or other intellectual property.

Important! Please read the End User Software License Agreement before using the accompanying
software program(s). Using any part of the software indicates that you accept the terms of the
End User Software License Agreement.

Page | 2
Veeam Reporter 4.0 | User Guide

CONTENTS
ABOUT THIS GUIDE .......................................................................................................................................... 5
OVERVIEW ............................................................................................................................................... 5
CONVENTIONS .......................................................................................................................................... 5
ABOUT VEEAM SOFTWARE ............................................................................................................................. 6
CONTACTING VEEAM SOFTWARE ................................................................................................................. 6
CONTACTING VEEAM SUPPORT ................................................................................................................... 6
OVERVIEW ......................................................................................................................................................... 7
FIRST STEPS....................................................................................................................................................... 9
ARCHITECTURE ............................................................................................................................................... 10
VEEAM REPORTER COMPONENTS ............................................................................................................... 10
USER INTERFACE ..................................................................................................................................... 11
VEEAM REPORTER USER GROUPS ............................................................................................................... 11
COLLECTION JOBS ................................................................................................................................... 11
REPORTING MODES ................................................................................................................................. 12
REPORT PACKS ....................................................................................................................................... 12
TYPES OF REPORTS ........................................................................................................................................ 13
OFFLINE REPORTS ................................................................................................................................... 13
Infrastructure Reports ........................................................................................................... 13
Permissions Report................................................................................................................ 21
Infrastructure Changes Report .............................................................................................. 21
Raw Data Analysis Report ..................................................................................................... 21
SSRS-BASED REPORTS ............................................................................................................................ 23
Storage Capacity Report ....................................................................................................... 23
Infrastructure Report ............................................................................................................. 24
Infrastructure Changes Report .............................................................................................. 24
Host Performance ................................................................................................................. 25
VM Performance ................................................................................................................... 27
Capacity Planning................................................................................................................. 29
WHAT IF: Add host................................................................................................................. 30
WHAT IF: Add VM .................................................................................................................. 30
WHAT IF: Add VM .................................................................................................................. 32
PLANNING AND PREPARATION .................................................................................................................... 33
PREREQUISITES ....................................................................................................................................... 33
REQUIREMENTS....................................................................................................................................... 33
System Requirements ............................................................................................................ 33
Required Permissions ............................................................................................................ 34
DEPLOYMENT ................................................................................................................................................. 35
FREE AND COMMERCIAL VERSION .............................................................................................................. 35
INSTALLING VEEAM REPORTER 4.0 ............................................................................................................. 36
UPGRADING VEEAM REPORTER.................................................................................................................. 40
VEEAM REPORTER LICENSING .................................................................................................................... 41
Installing a License ................................................................................................................ 42
Revoking ESX Severs from the License ................................................................................... 42
ADMINISTRATION .......................................................................................................................................... 43
WORKING WITH COLLECTION JOBS ............................................................................................................ 43
Adding Jobs .......................................................................................................................... 43
Editing and Deleting Collection Jobs ..................................................................................... 46
Running Collection Jobs Manually ........................................................................................ 47
WORKING WITH REPORTING JOBS .............................................................................................................. 48
Editing and Deleting Reporting Jobs ..................................................................................... 51
Running Reporting Jobs Manually ........................................................................................ 52
CUSTOMIZING APPLICATION SETTINGS ....................................................................................................... 53
CUSTOMIZING DATA ADMINISTRATION SETTINGS ......................................................................................... 58

Page | 3
Veeam Reporter 4.0 | User Guide

WORKSPACE ................................................................................................................................................... 59
SELECTING REPORTING DATE .................................................................................................................... 59
GENERATING OFFLINE REPORTS ................................................................................................................ 60
Granulating Visio Reports ..................................................................................................... 60
Creating Raw Data Analysis Templates ................................................................................. 61
Re-Organizing Raw Data Analysis Reports ............................................................................ 61
GENERATING SSRS-BASED REPORTS.......................................................................................................... 62
Creating SSRS-Based Reports from Templates....................................................................... 62
Generating SSRS-Based Reports ............................................................................................ 63
Editing and Deleting SSRS Reports ........................................................................................ 63
GENERATING REPORTS FOR BUSINESS GROUPS OF VMS ................................................................................ 64
DASHBOARD ................................................................................................................................................... 65
CUSTOMIZING DASHBOARD LAYOUT.......................................................................................................... 66
CREATING DASHBOARD WIDGETS.............................................................................................................. 67
WORKING WITH DASHBOARD WIDGETS ...................................................................................................... 68
USING AGGREGATE FUNCTIONS IN CHARTS ................................................................................................. 68
SORTING AND FILTERING DATA IN CHARTS .................................................................................................. 69
WORKING WITH CHARTS .......................................................................................................................... 70
Presentation of Data in Charts .............................................................................................. 70
EXAMPLES ............................................................................................................................................. 71
Creating 3-D Column and 3-D Cylinder Charts ...................................................................... 71
Creating Clustered Column Charts ........................................................................................ 72
Creating Exploded Pie Charts ................................................................................................ 73
Creating Stacked Columns Charts ......................................................................................... 74
VEEAM REPORT VIEWER ................................................................................................................................ 75
INSTALLING VEEAM REPORT VIEWER........................................................................................................... 75
WORKING WITH VEEAM REPORT VIEWER ..................................................................................................... 77
CUSTOMIZING REPORTS OPTIONS .............................................................................................................. 78
POWERSHELL SNAP-IN .................................................................................................................................. 79
CONNECT-VRVISERVER ........................................................................................................................... 79
DISCONNECT-VRVISERVER ....................................................................................................................... 80
GET-VRVM ........................................................................................................................................... 80
GET-VRVMHOST ................................................................................................................................... 82
GET-VRDATASTORE ................................................................................................................................ 84
GET-VRRESOURCEPOOL .......................................................................................................................... 85
GET-VRCLUSTER .................................................................................................................................... 86
GET-VRSNAPSHOT.................................................................................................................................. 88
GET-VRCURRENTDATE ............................................................................................................................ 88
SET-VRCURRENTDATE ............................................................................................................................ 89

Page | 4
Veeam Reporter 4.0 | User Guide

ABOUT THIS GUIDE


Overview
This user guide provides information about main features, installation and use of Veeam
Reporter 4.0. The document is intended for network administrators, consultants, analysts and
any other IT professionals using the product.

Conventions
In order to help you get the most out of this guide, we have used the following formatting
conventions, terms and abbreviations in the document:

Convention Description
Emphasis This type of formatting is used to designate user interface
elements (names of dialog windows, buttons and so on).
Italics This type of formatting is used to designate names of files,
file paths, cross-references and options of choice (for
example, in a drop-down list).
Notes This type of formatting is used for tips, notes and important
information the user should pay attention to.

Term/Abbreviation Description
vCenter VMware vCenter Server
VI VMware Virtual Infrastructure
VM Virtual machine
SSRS Microsoft SQL Server Reporting Services

Page | 5
Veeam Reporter 4.0 | User Guide

ABOUT VEEAM SOFTWARE


Contacting Veeam Software
At Veeam Software we pay close attention to comments from our customers. It is important to
us not only to quickly help you with your technical support issues — we make it our mission to
listen to your input, and to build our products with your suggestions in mind.
Should you have a Customer Support issue or question, please feel free to contact us. We have
qualified English speaking technicians and customer support staff in the USA and Europe who
will help you with any inquiry that you may have.

Office U.S. EMEA Benelux APAC


address: Headquarters Headquarters Headquarters Headquarters

6479 Reflections 400 Thames Valley Park Evert van de Level 21 & 22, 201
Drive, Suite 200 Thames Valley Park Beekstraat 310, Miller Street
Columbus, Drive, Reading, 1118 CX Schiphol North Sydney
Ohio 43017 Berkshire RG6 1PT Centrum, NSW 2060, Australia
The Netherlands

Phone: +1-614-339-8200 +44 (0) 1276-804-501 +31(0)20 654 18 05 +61 2 8014 7476
Fax:
+1-614-675-9494 +44 (0) 1276-804-676 +31(0)20 654 1801

Contacting Veeam Support


We offer e–mail and phone technical support for customers on maintenance and assistance
during the evaluation period. For better experience please provide the following when
contacting our technical support:
 Information about operating system and database you are using.
 Error message and/or accurate description of the problem.
To submit your support ticket or obtain additional information, please visit
http://www.veeam.com/support/.

Note: Before contacting technical support, you may be able to find a resolution to your issue at
Veeam Technical Support Forum at: www.veeam.com/forums/.

Page | 6
Veeam Reporter 4.0 | User Guide

OVERVIEW
Veeam Reporter 4.0 (formerly known as Veeam Reporter Enterprise) is an enterprise-level
reporting solution specifically designed for large VI3 and vSphere virtual environments that
allows you to automatically discover and collect information about your VMware virtual
environment, its components and configuration settings, and provide comprehensive visual
reports for analysis, documentation and decision-making support.
Veeam Reporter 4.0 features the following options and functionality:

Built for Enterprises


Veeam Reporter 4.0 is developed for professional use by VMware administrators, system
integrators and datacenter managers. The application enables multi-admin access, providing a
number of VMware environment administrators with a possibility to generate reports on
necessary VI objects.

Support for Heterogeneous Virtual Environment


Veeam Reporter 4.0 is fully compatible with ESX Server 3.x and 4.x, Virtual Center 2.0 and
vCenter Server 4.x.

Unattended Data Collection and Ad Hoc Reporting


Veeam Reporter 4.0 features a convenient way of collecting VI data with collection jobs. You
may schedule to collect VI data periodically by the defined time schedule or run collection
jobs once-only. Retrieved data is stored to the SQL database, enabling the user to select a
necessary state of the VI and generate reports as of this state at any moment of time.
Veeam Reporter 4.0 collects VI data agentlessly, thus putting no additional load on vCenter
and ESX servers.

Reporting in Visio, Excel, Word, PDF


Veeam Reporter 4.0 offers a wide variety of reports in Microsoft Visio, Microsoft Excel,
Microsoft Word and Adobe PDF, as well as SSRS-based reports to present your environment
from different viewpoints and in various profiles.

Automated Reporting and Report Delivery


Veeam Reporter 4.0 allows you to generate reports on a regular basis, or schedule reporting
tasks. A report tasks aggregates general reporting data such as: what reports should be
generated, which VI objects should be reported about, by what schedule should reports be
generated, and to which location ready reports should be saved.

Change Management
Infrastructure Changes reports provide comparative data on VI environment states in different
points in time, allowing for VI environment changes analysis and planning. They also provide
information about the who, what, where, when, and how for configuration changes in the
virtual environment.

Jobs Notifications
Veeam Reporter 4.0 provides a possibility to receive e-mail notifications informing about the
performed collection job status and errors that occur in the process of jobs execution.
Additionally, you can select to be notified on all changes that have occurred in the VI
environment since the last collection job run.

Page | 7
Veeam Reporter 4.0 | User Guide

Integration with Veeam Business View


Veeam Reporter 4.0 integrates with Veeam Business View: it uses categorization data to build a
business topology of virtual infrastructure apart from a traditional vCenter hierarchy, and
makes your reports more useful by basing them on VM business unit, department or purpose
and other business categories – instead of just cluster, host and datacenter level.

Customizable Dashboard
The new, redesigned web UI (user interface) allows you to easily create and customize your
own dashboard. You can add commonly used reports and observe the most important aspects
of your virtual environment at a glance. You can also integrate reports into third-party
dashboards and intranet web portals, such as Microsoft SharePoint.

PowerShell Snap-In
Veeam Reporter 4.0 comes with PowerShell snap-in to Microsoft Windows PowerShell, proving
access to the Veeam Reporter database and enabling the user to perform administrative tasks
by running single cmdlets or custom automation scripts via the command-line interface.

Page | 8
Veeam Reporter 4.0 | User Guide

FIRST STEPS
You should take the following steps to start working with the application safely and flawlessly.
1. Install Veeam Reporter 4.0. Download the latest version of the application from:
http://www.veeam.com/vmware-esx-reporter/download.html. Unpack the downloaded
archive and run the VeeamReporter.exe file. Then follow the installation wizard steps. To
learn more, see the Installing Veeam Reporter 4.0 section.
2. Create and run a collection job. Once you launch Veeam Reporter 4.0 for the first time,
you need to retrieve data from your virtual infrastructure to be able to generate reports.
To do so, you should create and run a collection job. In the Configuration section of
Veeam Reporter 4.0, click Collection Jobs on the left. Click the New button to create a
new collection job (to learn more, see the Working with Collection Jobs section). To
start the created collection job, select it and click the Start button on the toolbar.
If you have a vCenter server in your VI environment, we recommend that you create a
job for it to immediately collect data for all objects in its hierarchy. After that, you will be
able to select VI objects that were engaged in the performed job using the Workspace,
and generate reports for it.
3. Generate reports manually or create a reporting job. To generate report manually,
click the Workspace tab, select a necessary VI object from the tree view, date and
collection job session, choose reports and click the Create Report button. To generate
reports automatically, create and run a reporting job. To learn more, see the Working
with Reporting Jobs section.
4. Customize your dashboard. To add reports to the Dashboard, you should first create
and save them using Workspace of Veeam Reporter 4.0. Keep in mind that you can add
to the Dashboard only saved SSRS-based reports. To customize the Dashboard, click the
Dashboard tab and then click the Edit Dashboard button. Customize the layout by
dragging blue borders from the right and the bottom of the screen. Then, drag reports
from the Reports list and drop them onto the created cells. To learn more, see the
Dashboard section.

Page | 9
Veeam Reporter 4.0 | User Guide

ARCHITECTURE
This chapter provides a high-level overview of the Veeam Reporter 4.0 architecture and
functionality.

Veeam Reporter Components


Veeam Reporter 4.0 is a reporting solution with the client-server architecture targeted at large
VI environments. In the process of its work, it uses the SQL backend as a centralized storage for
VI environment data that can be accessed via the web interface by multiple clients (VMware
environment administrators) who need to generate reports.

Veeam Reporter 4.0 consists of the following components:


 Veeam Reporter Server is responsible for collecting VI environment data and storing it to
the SQL database, as well as controlling collection jobs execution by the defined time
frame.
 Veeam Reporter Web UI enables web access for multiple clients who can access data,
collected by the Veeam Reporter Server, via the web browser to generate different
kinds of VI environment reports.
 Veeam SQL Database with which Veeam Reporter Server and Veeam Web Server
communicate in the process of work is used for storing collected VI environment data
and details about collection jobs performance. At installation, Veeam Reporter 4.0 sets
up SQL Server 2008 Express with Advanced Services instance or uses an SQL server that
is already installed, either locally or remotely.
The following components can further extend the functionality of Veeam Reporter 4.0:
 Veeam Report Viewer is a standalone Veeam tool installed together with Veeam Reporter
4.0 that is intended for generating reports in the Microsoft Word, Microsoft Excel,
Microsoft Visio and Adobe PDF formats from the .vmr files created by Veeam Reporter
4.0. To learn more, see the Veeam Report Viewer section.
 Veeam Reporter PowerShell snap-in coming with Veeam Reporter 4.0 allows users to
easily automate reporting tasks by running single cmdlets or custom automation
scripts via the command-line interface.

Note: The PowerShell snap-in is not available in the free version of Veeam Reporter 4.0.

Page | 10
Veeam Reporter 4.0 | User Guide

User Interface
Users working with Veeam Reporter 4.0 can perform main actions using the three application
views: Dashboard, Workspace and Configuration section. These sections can be accessed by
clicking corresponding tabs of the application window.
 Using the Dashboard, you can easily create and customize widgets that will help you
to see the most important aspects of your VMware virtual environment at a glance. A
detailed description of work with the Dashboard is provided in the Dashboard section
of this guide.
 Using the Workspace of Veeam Reporter 4.0, you can create different types of reports.
A detailed description on the reports generation procedure is provided in the
Workspace section of this guide.
 Using the Configuration section of Veeam Reporter 4.0, you can perform
administrative actions: create and manage data collection and reporting jobs, work
with jobs sessions, set up and customize main application settings. A detailed
description of these operations is provided in the Administration section of this guide.

Veeam Reporter User Groups


To be able to work with Veeam Reporter 4.0, the user should be a member of the Veeam
Reporter Administrators or Veeam Reporter Viewers local group on the computer where
Veeam Reporter Server is installed. Both groups are created when Veeam Reporter Web UI is
installed.
 Users listed in the Veeam Reporter Administrators group have rights to work with the
Configuration section, Workspace and Dashboard: manage data collection and
reporting jobs, specify application settings, generate reports, create and customize the
dashboard.
 Users listed in the Veeam Reporter Viewers group have rights to work with the
Workspace to generate reports, and view the reports added to the Dashboard.
You can add new members to Veeam Reporter groups using the standard Windows user
manager (from the Control panel, select Administrative Tools > Computer Management >
Local Users and Groups).

Note: By default, the user who installs Veeam Reporter 4.0 is added to both Veeam Reporter
Administrators and Veeam Reporter Viewers groups.

Collection Jobs
To collect VI environment data that will be used for reports generation, Veeam Reporter 4.0
uses collection jobs. The collection job is a task for collecting data on one or a number of VI
objects that is performed once or regularly by the defined schedule. During a collection job,
Veeam Reporter collects configuration, performance, and event data across multiple vCenters
for all 25 VMware object types, nearly 600 different object properties and more than 150
events. At the first run of a job, Veeam Reporter retrieves available historical performance data
from the vCenter Servers and ESX hosts (for up to one year for vCenters and for the last 24
hours for ESX hosts). At all consecutive runs, incremental collection is performed, gathering
only data which changed since the last collection job run.
Every run of a collection job initiates a new job session; data collected at every session is
stored to the Veeam Reporter SQL database.
Completed job sessions act as historic points for VI environment data. To generate reports, the
user should select a necessary session, that is, define the time when the VI environment or a VI
object was in the desired state, and generate a report as of this state.

Page | 11
Veeam Reporter 4.0 | User Guide

Collection jobs can be run manually or scheduled to be run at specific time with some
periodicity. To learn more, see the Working with Collection Jobs section.

Reporting Modes
After you collect data about your virtual infrastructure with the help of collection jobs, you can
pass to reports generation. Veeam Reporter 4.0 provides two reporting modes:
 Manual generation of reports. To generate reports manually, you should use the
Workspace of Veeam Reporter 4.0.
 Automatic generation of reports. To generate reports automatically, you should
create a reporting job. A reporting job is an automated task for reports generation that
can be executed manually or scheduled for specific time. You can select to receive
ready reports by e-mail, automatically write them to a folder on a hard drive and to a
network share. Created reports will contain the latest data about virtual infrastructure
that has been collected by collection jobs.

Report Packs
Veeam Reporter 4.0 is delivered with report packs that have been designed to simplify
reporting tasks. Report packs contain a set of templates that touch most of the VMware VI
objects and are designed to meet the most custom reporting requirements. You can use
report templates to generate reports as-is or customize them to create your own report library.
Report packs are not tied to the application and can be downloaded and installed
independent of the product release. Right now Veeam Reporter 4.0 includes the following
report packs:
 Offline report pack contains reports that can be generated with the native Veeam
Reporter’s reporting engine: Infrastructure reports, Permissions report, Infrastructure
Changes report and Raw Data Analysis report. To view Offline reports, you need to
install Veeam Report Viewer.
 Base report pack contains basic reports that can be generated with the new SSRS
engine: Storage Capacity report, Infrastructure report, Infrastructure Changes report.
 Performance report pack contains additional reports that can be generated with the
new SSRS engine: Host Performance and VM Performance.
 Capacity planning report pack contains capacity planning reports that can be
generated with the new SSRS engine: general Capacity Planning and three reports for
possible changes (Add host, Add VM, Host failure).
To work with reports generated with the SSRS engine, you need to integrate Veeam Reporter
4.0 with Microsoft SQL Server Reporting Services. To learn more, see the Specifying SSRS
Server Settings section.
You can repair or remove existing SSRS-based report packs and add new ones via the SSRS
Server tab of the Configuration -> Settings section. Base and Performance report packs are
built-in and cannot be removed, whereas Capacity planning report pack can be either repaired
or removed completely.

Page | 12
Veeam Reporter 4.0 | User Guide

TYPES OF REPORTS
Veeam Reporter 4.0 allows you to create reports using two reporting engines: the native
reporting engine of Veeam Reporter 4.0 and the new reporting engine based on Microsoft SQL
Server Reporting Services (SSRS). This section provides a detailed description of reports that
you can create with the two reporting engines.

Offline Reports
When reports are generated with the native reporting engine, Veeam Reporter 4.0 exports VI
data to files of its proprietary .vmr format. The .vmr file stores raw VI data required for reports
generation. To work with .vmr files, Veeam Reporter 4.0 uses a special tool — Veeam Report
Viewer that is launched as soon as the .vmr file is opened. Veeam Report Viewer is free — you
can download and install it by clicking the Download Veeam Report Viewer link in the
Workspace of Veeam Reporter 4.0. The download link becomes available when you select
Offline report pack from the list of report packs in the Workspace.
Veeam Report Viewer uses report data collected in the .vmr files to generate report files in the
Microsoft Word, Microsoft Excel, Microsoft Visio and Adobe PDF formats. By default, ready
reports are stored to %userprofile%\My Documents\My Veeam Reports\<date of folder creation>.
To learn more about Veeam Report Viewer, see the Veeam Report Viewer
section.
Reports that can be generated with the native reporting engine are included in the Offline
report pack. Using this report pack, you can create the following types of reports:
 Infrastructure reports present the topology map and ‘inventory’ of your virtual
infrastructure or some of its objects from different viewpoints: configuration, network,
storage, vMotion, datastore utilization and LUN multipath.
 Permissions report contains a list of users and groups with their associated permission
roles assigned to VI objects.
 Infrastructure changes report informs about changes in the virtual environment that
occurred at a specific period of time.
 Raw data analysis report contains raw data for the virtual infrastructure or any selected
VI object and can be used for data mining and building other custom reports.

Infrastructure Reports
Infrastructure reports provide comprehensive and easy-to-understand data about different
profiles of your VMware environment in various formats: Microsoft Visio, Microsoft Excel,
Microsoft Word and Adobe PDF.

Visio Reports
Veeam Reporter 4.0 uses Microsoft Visio diagrams to visualize the topology of your VI
environment from different viewpoints. The report contains a set of pages for target VI
profiles: Configuration, Network, Storage, vMotion and Datastore Utilization. Additionally, you
can generate a report with LUN multipath data.
Beside the VI topology, Visio reports allow viewing detailed information on every reported
object. To see VI object data, click a necessary object in the report, and its data will be shown
in the Custom Properties window. If this window is not displayed, select View > Custom
Properties Window from the main menu.

Note: For Microsoft Visio 2007, select View > Shapes Data Window.

Page | 13
Veeam Reporter 4.0 | User Guide

You can make Microsoft Visio reports more informative using callouts with the information
about VI objects. To learn more, see the Customizing Reports Options section.
Visio reports are fully interactive and can be used for planning and modeling purposes. You
can rearrange all objects and immediately see how your virtual infrastructure would look like.
Beside actual VI objects, Visio reports can also include pseudo objects that are used for
configuration purposes. For example, if there are any orphaned VMs and VMs without network
cards in your virtual environment, the Network report will contain a pseudo network called
“Disconnected VMs” with which these VMs will be associated. Pseudo objects are used in all
Visio reports except the Multipath report.
Configuration report. The Configuration report visualizes the virtual environment from the
hierarchical point of view. It allows viewing what folders, clusters, datacenters and resource
pools are configured in your virtual infrastructure and what VMs belong to them.

Page | 14
Veeam Reporter 4.0 | User Guide

Network report. The Network report visualizes the VI network topology and connections
between network objects (hosts, virtual networks, clusters, folders, datacenters and virtual
machines) as they are configured in your VI environment. Additionally, the network hierarchy
in the report contains VM kernels and service consoles presented as networks.
Beside visualizing the network configuration and connection data, the Network report informs
about VMs connection problems and enables you to immediately identify misconfigured VMs.
Such problems may be caused by 'cold migration' or deletion of a network. A VM having
connection problems is associated with a pseudo network called ’Disconnected VMs’.

Page | 15
Veeam Reporter 4.0 | User Guide

Storage report. The Storage report visualizes datastores in your VI environment, informs on
VMs or VM hard disks that reside on them, and provides storage capacity data.
The report provides information on datastores in two perspectives:
 Storage to VMs. This view lists all datastores and shows what VMs reside to them.
 Storage to Disks. This view lists all datastores and shows what VM disks reside to them.

Page | 16
Veeam Reporter 4.0 | User Guide

vMotion report. The vMotion report facilitates planning vMotion strategy and detecting
potential problems in the vMotion deployment. The report is focused on virtual machines'
ability to migrate between hosts and shows only vMotion-related objects: clusters, hosts
enabled for vMotion, shared datastores and virtual machines residing on shared datastores.
Objects that are included or can be potentially included into vMotion are organized under
pseudo-objects representing vMotion configurations.

Page | 17
Veeam Reporter 4.0 | User Guide

Datastore Utilization report. The Datastore Utilization report analyzes the configuration of
your VI taking into consideration free space available on storage devices. Each of the storage
devices is associated with one of the following pie charts: Normally Utilized (25% to 85%), Over
Utilized (more than 85%) and Under Utilized (less than 25%), which identify the level of
occupancy for these devices.
If there are no datastores with a specific level of occupancy, the corresponding pie chart will
not be displayed. For example, if there are no datastores with a medium degree of occupancy
in your virtual infrastructure, the report will not contain the Normally Utilized (25% to 85%) pie
chart.

Page | 18
Veeam Reporter 4.0 | User Guide

Multipath report. The Multipath report outlines the multipath technique that leverages
multiple alternative paths through your virtual network, as it is implemented in your VI
environment. You can view the list of storages connected to ESX servers, host bus adapters
and LUN information on them.

Excel Reports
Excel Infrastructure reports provide detailed information on all objects in the VI environment
and their properties in different profiles. You can select to generate the Inventory, Storage
capacity and Multipath reports.
Inventory report. The Inventory report provides structured presentation of data on the
inventory objects together with their properties. The report data is distributed between a
number of spreadsheets.

The Table of Content spreadsheet contains links to different information blocks on other report
spreadsheets, and additionally provides data on relations between VI objects (Datastore to
Host, Datastore to LUN, VM to Datastore, VM to LUN, VM to Host, VM to Resource Pool, VM to

Page | 19
Veeam Reporter 4.0 | User Guide

Virtual Application, Distributed Virtual Switch to Datacenter, Distributed Virtual Portgroup to


Distributed Virtual Switch, Distributed Virtual Port to Distributed Virtual Portgroup, Host to
Distributed Virtual Port, License to Host, Host to Host Profile, VM to Network, Network to Host,
Network to Virtual Switch).
The Veeam Reporter spreadsheet provides blocks of properties data for custom attributes,
datacenters, iSCSI adapters, SCSI adapters, shared datastores, datastores, clusters, hosts,
resource pools, virtual applications, distributed virtual switches, distributed virtual portgroups,
distributed virtual ports, host profiles, licenses, LUNs, virtual switches, physical adapters,
folders, service consoles, VMkernels, networks and VMs.
The OS Summary spreadsheet provides data on operating systems running in your VI
environment, and the total OS number.
Storage Capacity report. The Storage Capacity report is intended for storage capacity
analysis, planning and deployment. This report represents a PivotTable, enabling you to filter
the report content by specific objects or attributes, and display only selected data in both the
report graph and data tables. The lists of options for data filtering are located under the report
graph.

Note: To learn more about the PivotTable, see http://office.microsoft.com/en-


us/excel/CH101768451033.aspx.

The Datastores spreadsheet of this report provides summary information on your datastores
utilization and allows you to plan moving VMs from the most loaded datastores to less busy
ones.
The Virtual Disks spreadsheet informs about the amount of disk space allocated for VMs on a
separate datastore. You can use this report to identify virtual machines which are taking the
most of the storage space and/or running in the snapshot mode. This report allows you to
plan reducing storage space consumption by removing unnecessary snapshots, and
investigating the reasons behind high VMDK sizes of the top machines.
The Logical Disks spreadsheet informs about virtual machines which logical disks are running
out of free space. This report allows you to plan extending logical disks, adding new ones, or
moving some VM applications to another logical disk. Please note that this report only
provides logical disks capacity information for VM with VMware Tools installed, which is why
some rows may appear empty.
Multipath report. The Multipath report outlines the multipath technique, which leverages
multiple alternative paths through your virtual network, as it is implemented in your VI
environment. You can view the list of iSCISI and Fibre Channel datastores connected to ESX
servers and information on the datastore extent(s), detailing its capacity and selection path

Page | 20
Veeam Reporter 4.0 | User Guide

policy (fixed or most recently used); the extent available path(s), target, and the extent path
state (active, disabled, standby, or dead).

Microsoft Word and Adobe PDF Reports


Microsoft Word report generated with Veeam Reporter 4.0 contains an inventory of VI
objects with their properties and relations to other VI objects. The reports are stored in the .rtf
format and can be used for saving, printing and sharing purposes. You can also use the
Microsoft Compare Documents function to track changes from a specific moment in the past.
Adobe PDF report generated with Veeam Reporter 4.0 contains an inventory of VI objects
together with their properties and relations to other VI objects. The reports can be used for
saving, printing, sharing and document archiving purposes.

Permissions Report
The Permissions report is a report in the Microsoft Excel format that contains a list of users and
groups with their associated permission roles assigned to VI objects. The report provides
permissions information in two perspectives:
 Objects to users. This spreadsheet lists all objects of virtual infrastructure, and users
who have different permissions on them.
 Users to objects. This spreadsheet lists all users within the virtual infrastructure, and
objects to which they have access.

Infrastructure Changes Report


The Infrastructure Changes report is a report in the Microsoft Excel format that allows viewing
changes in the virtual environment for a selected period of time. In contrast to the Inventory
reports displaying properties of all VI objects, the Infrastructure Changes report contains only
properties of those objects that have been changed. Veeam Reporter 4.0 allows you to
generate Infrastructure Changes reports for a specified date range, or for the last N days, hours
or months.

Raw Data Analysis Report


The Raw Data Analysis report represents a PivotTable with raw data of selected VI
environment objects. Due to the interactive nature of the PivotTable, this report can be used
for data mining and building other custom reports — you can select necessary options to
make a number of reports you need from a single source report.

Page | 21
Veeam Reporter 4.0 | User Guide

The Raw Data Analysis report data is distributed between four spreadsheets: Guest OS, Storage
Allocated, Storages and Data. The first three tabs present data in a table and visualize it with
the help of a pie chart or a diagram; the last spreadsheet contains raw VI data itself.
The Storage Allocated tab is available only if you have the Veeam Business View server
connected to Veeam Reporter 4 and data collection sessions to collect business data have
been completed successfully. At the same time, the Storages tab will be hidden. And, vice
versa, if the Veeam Business View server is not connected and/or business data has not been
collected, the Storages tab will be available, and the Storage Allocated tab will be hidden.

Page | 22
Veeam Reporter 4.0 | User Guide

SSRS-Based Reports
Veeam Reporter 4.0 features a new reporting engine based on Microsoft SQL Server Reporting
Services (SSRS).
SSRS is an industry-standard, web-based enterprise reporting solution providing an easy way
to create custom reports and explore business data. It offers all necessary tools— you do not
need to install additional applications to generate and view reports. SSRS supports multi-user
access, enabling a number of report consumers using different client platforms to access
reports through the web interface.
As SQL Server Reporting Services supports work with a wide variety of data sources, you can
use VI data collected by Veeam Reporter 4.0 to build reports for VMware infrastructure with
the SSRS solution that is deployed in your production environment.
To connect to the SSRS server, you should specify its settings in the Configuration view of
Veeam Reporter 4.0. To learn more, see the Specifying SSRS Server Settings section. In its turn,
in SSRS Veeam Reporter 4.0 creates a new folder named Veeam Reporter which contains the
Datasource folder with a connection string to the VeeamReporter database, and a folder for
each report pack.
Using report templates from report packs, you can create custom reports describing different
aspects of your virtual environment, and save them. Saved reports can be used for automatic
reporting jobs (to learn more, see the Working with Reporting Jobs section), or published on
Veeam Reporter’s dashboard, both as graphic charts or as tables with data. You can also
integrate them into third-party dashboards and intranet web portals, such as Microsoft
SharePoint. To learn more, see the Dashboard section.
You can create the following types of SSRS-based reports:
 Storage Capacity report allows you to chart and view capacity resources for datastores,
virtual and logical disks.
 Infrastructure report allows you to view detailed information about VI objects of
selected type, and their properties.
 Infrastructure Changes report allows you to view changes that have taken place for VI
objects of specific type, and their properties.
 Host Performance report charts CPU, memory, disk and network performance data for
selected ESX hosts.
 VM Performance report charts CPU, memory, disk, network and heartbeat performance
data for VMs in the selected VM container.
SSRS-based reports can be viewed via the web, or saved in the Adobe PDF, Microsoft Word
and Microsoft Excel formats.

Storage Capacity Report


The Storage Capacity report visualizes storage data using three sections:
 Storage Overview section provides summary data about capacity, free and used space
on all storages in your virtual environment.
 Virtual Disks Capacity section provides information about VM virtual disks and
snapshots.
 Logical Disks section provides information about used and free space on logical disks
of VMs.

Page | 23
Veeam Reporter 4.0 | User Guide

Sections of the report visualize summary reporting data in charts. To get comprehensive
storage capacity information in the table format, click the Details link at the bottom right
corner of the corresponding section.

Infrastructure Report
Infrastructure reports allow you to get detailed inventory data about selected types of VI
objects and their properties. Veeam Reporter 4.0 provides powerful tools for creating custom
reports about any type of VI object and offers advanced filtering, sorting and grouping options
that can help you generate reports for any area of your interest. You can get comprehensive
information about any objects or essences in your virtual environment: vCenter, ESX(i) hosts,
virtual machine, custom attributes, networks, roles and permissions and so on.

Infrastructure reports are created with the help of the Infrastructure Report template. You
should select the type of objects that needs to be reported about, and their properties. The
Infrastructure report is generated in the table format, where selected objects are presented as
table rows and object properties are displayed in table columns. At the same time, you can
always present report data in the graphic view using Veeam Reporter’s dashboard and
dashboard widgets. To learn more, see the Dashboard section.

Infrastructure Changes Report


The Infrastructure Changes report allows you to get information about all changes that have
taken place in the virtual infrastructure for selected VI objects and their properties. In contrast
to Inventory reports displaying data for all objects of selected type and their properties, the
Infrastructure Changes report contains only those items that have been changed.

Page | 24
Veeam Reporter 4.0 | User Guide

The Infrastructure Changes report visualizes changes in three charts – Added objects, Modified
objects and Deleted objects. If no changes have been made (that is, objects have not been
added, modified or deleted), the corresponding chart will not be displayed.
The table under charts contains a full list of modified objects. You can get detailed information
about every item in the list by clicking its name in the Object column.

Infrastructure Changes reports also include audit information for changed objects. You can
immediately see not only what configuration changes have been made in the virtual
environment, but also who made them, where, when and how. This data can be especially
helpful for troubleshooting, root cause analysis, and recovering the virtual environment from
accidental changes or changes that produced unexpected results.

Host Performance
Veeam Reporter 4.0 collects and achieves historical performance data from vCenter server and
ESX servers and allows you to generate reports providing data about all aspects of ESX host
performance.

Note: The list of counters is formed dynamically and depends on your vCenter server.

Page | 25
Veeam Reporter 4.0 | User Guide

Performance Description Units of


Counters Measurement
CPU Usage Total level of CPU usage for the selected Percent
(Percent) ESX host
CPU Usage (MHz) Total level of CPU usage for the selected MHz
ESX host in MHz
CPU Used Amount of CPU time used from the time a Millisecond
call to CPU starts until it ends
Disk Bus Resets Number of bus resets in the defined interval Number
Disk Command Number of disk commands aborted in the Number
Aborts defined interval
Disk Commands Sum of disk commands to the datastore Number
Issues issued in the defined interval
Disk Read Latency Average amount of time taken to read data Millisecond
from the perspective of a Guest OS
Disk Read Rate Rate of reading data from the disk KBps
Disk Read Number of disk read request in the defined Number
Requests interval
Disk Usage Aggregated storage performance statistics. KBps
The sum of data read and written for all disk
instances of the host
Disk Write Latency The average amount of time taken for a Millisecond
write data from the perspective of a Guest
OS
Disk Write Rate Rate of writing data to the disk KBps
Disk Write Number of disk write requests in the Number
Requests defined interval
Actively Used Amount of memory that is actively used KB
Memory Average
Memory Balloon Amount of memory used by memory KB
control
Memory Amount of host memory consumed by the KB
Consumed virtual machine for guest memory
Memory Overhead Amount of additional host memory KB
allocated to the virtual machine
Shared Memory Amount of memory that is shared KB
Average
Memory Swap Amount of memory that is used by swap KB
Used
Memory Usage Memory usage as percentage of total Percent
configured or available memory
Network Data Rate at which data is received KBps
Receive Rate
Network Data Rate at which data is transmitted KBps
Transmit Rate
Network Packets Number of packets received in the defined Number
Received interval
Network Packets Number of packets transmitted in the Number
Transmitted defined interval
Network Usage The sum of data received and transmitted KBps
for all the NIC instances of the host

Page | 26
Veeam Reporter 4.0 | User Guide

VM Performance
Veeam Reporter 4.0 collects and achieves historical performance data from vCenter server and
ESX servers and allows you to generate reports providing data about all aspects of VM
performance.

Note: The list of counters is formed dynamically and depends on your vCenter server.

Performance Description Units of


Counters Measurement
CPU Ready Time that a virtual machine should wait in Millisecond
the ready-to-run state to be scheduled on
CPU
CPU System CPU time spent on system processes Millisecond
CPU Usage Total level of CPU usage for the selected VM Percent
(Percent)
CPU Usage (MHz) Total level of CPU usage for the selected VM MHz
in MHz
CPU Used Amount of CPU time used from the time a Millisecond
call to CPU starts until it ends
CPU Wait CPU time spent in the wait state Millisecond
Disk Bus Resets Number of bus resets in the defined interval Number
Disk Command Number of disk commands aborted in the Number
Aborts defined interval
Disk Commands Sum of disk commands to the datastore Number
Issued issued in the defined interval
Disk Read Rate Rate of reading data from the disk KBps
Disk Read Number of disk read request in the defined Number
Requests interval
Disk Usage Aggregated storage performance statistics. KBps
The sum of data read and written for all disk
instances of the host
Disk Write Rate Rate of writing data to the disk KBps
Disk Write Number of disk write requests in the Number
Requests defined interval
Actively Used Amount of memory that is actively used KB

Page | 27
Veeam Reporter 4.0 | User Guide

Memory Average
Memory Balloon Amount of memory used by memory KB
control
Memory Amount of host memory consumed by the KB
Consumed virtual machine for guest memory
Memory Overhead Amount of additional host memory KB
allocated to the virtual machine
Shared Memory Amount of memory that is shared KB
Average
Memory Swapped Amount of memory that is swapped KB
Memory Usage Memory usage as percentage of total Percent
configured or available memory
Network Data Rate at which data is received KBps
Receive Rate
Network Data Rate at which data is transmitted KBps
Transmit Rate
Network Packets Number of packets received in the defined Number
Received interval
Network Packets Number of packets transmitted in the Number
Transmitted defined interval
Network Usage The sum of data received and transmitted KBps
for all the NIC instances of the host
Heartbeat Number of heartbeats in the defined Number
interval

Page | 28
Veeam Reporter 4.0 | User Guide

Capacity Planning
Veeam Reporter 4.0 can predict resource utilization growth in the future according to the
current performance. The Capacity Planning report allows you to estimate when resource
utilization will reach a certain threshold. This is helpful for evaluating the need for VI
expansion. The report can be generated for various objects. For instance, the illustration below
shows a report which predicts when utilization levels of a cluster will reach a certain threshold.

The Predicted Date column contains an estimated date when resource utilization will reach a
set threshold. If you click any link in this column, a graph will be generated showing previous
utilization for the corresponding resource with an approximation for the specified time period.

Page | 29
Veeam Reporter 4.0 | User Guide

WHAT IF: Add host


Veeam Reporter 4.0 can calculate how resource utilization will change after adding one or
more hosts to the VI. This report can be helpful when planning VI expansion. The report can be
generated for various objects. The illustration below shows a report which helps to compare
utilization levels for a cluster in two situations – when no hosts are added and when a host is
added.

The No change column contains predictions of resource utilization levels after a specified time
period in case no new hosts are added. The Host(s) added column shows predicted resource
utilization for the same time period if a new host (or several hosts) is added to the VI. By
clicking one of the links in the table you can view graphs for relative utilization levels with an
approximation for the specified time period.

Page | 30
Veeam Reporter 4.0 | User Guide

WHAT IF: Add VM


Veeam Reporter 4.0 can calculate how resource utilization will change after adding one or
more VMs to the VI. This report can be helpful when planning to add new VMs. The report can
be generated for various objects. For instance, the illustration below shows a report which
helps to compare utilization levels for a cluster in two situations – when no VMs are added and
when five VMs are added.

The No change column contains predictions of resource utilization levels after a specified time
period in case no new VMs are added. The VM(s) added column shows predicted resource
utilization for the same time period if a VM (or several VMs) is added to the VI. By clicking one
of the links in the table you can view graphs for relative utilization levels with an
approximation for the specified time period.

Page | 31
Veeam Reporter 4.0 | User Guide

WHAT IF: Host Failure


Veeam Reporter 4.0 can predict how resource utilization will change if a host fails. This report
is very helpful when evaluating risks associated with failures. The report can be generated for
various objects. For instance, the illustration below shows a report which helps to compare
utilization levels for a cluster in two situations – when no hosts fail and when a certain host
fails.

Two columns under Cluster utilization contain predictions of resource utilization levels after
a specified time period if no hosts fail. The columns under Cluster utilization after host
failure shows predicted resource utilization for the same time period if a host fails (the name
of the host is given in the Failed host column). By clicking one of the links in the table you can
view graphs for relative utilization levels with an approximation for the specified time period.

Page | 32
Veeam Reporter 4.0 | User Guide

PLANNING AND PREPARATION


This chapter describes the planning and preparation steps that you should take before the
Veeam Reporter deployment.

Prerequisites
Veeam Reporter 4.0 uses the following firewall ports listed in the table below. Make sure these
ports are opened:

Advanced Default Value


Property/Option
Proxy settings option Do not use proxy settings

Use SSL port SSL enabled (to use HTTP, disable this option)
SSL port 443

Requirements
This section describes the list of system requirements to the virtual infrastructure, SQL
database, Veeam Reporter Server, Report Viewing Console, as well as rights and permissions
necessary to work with Veeam Reporter 4.0.

System Requirements
To ensure successful usage of Veeam Reporter 4.0, the following system requirements should
be met:

Virtual Infrastructure
VMware VMware Infrastructure 3 (VI3)
Infrastructure VMware vSphere 4.x

SQL Database
SQL Database Microsoft SQL Server 2005 or 2008
Microsoft SQL Server Reporting Services 2008

Veeam Reporter Server


Hardware Processor: Pentium IV or faster
Memory: 1024MB (2048MB recommended with local SQL
Express installation)
OS 32-bit and 64-bit versions of the following operating systems:
• Windows XP
• Windows Server 2003
• Windows Vista
• Windows Server 2008
• Windows Server 2008 R2
• Windows 7
All the latest service packs and security updates should be
installed.

Page | 33
Veeam Reporter 4.0 | User Guide

Software Microsoft .NET Framework 3.5 or later


Microsoft Internet Information Services (IIS) 5.1 or later

Report Viewing Console

OS 32-bit and 64-bit versions of the following operating systems:


• Windows XP
• Windows Server 2003
• Windows Vista
• Windows Server 2008
• Windows Server 2008 R2
• Windows 7
All the latest service packs and security updates should be
installed.
Software Microsoft .NET Framework 3.5 or later
Microsoft Internet Explorer 6.0 or later, or Mozilla Firefox 3.5
or later
Microsoft Office 2007 or later (some reports cannot be
viewed with Excel 2003)
Microsoft Visio 2003 or later
PDF viewer

Required Permissions
 To be able to access SQL backend data, the clients should be members of the Veeam
Reporter Administrators or Veeam Reporter Viewers local groups on the Veeam
Reporter Server console. To learn more about the user groups, see the Veeam Reporter
User Groups section.
 Make sure that the SQL Server account is granted administrative privileges on both the
specified SQL Server instance and on the local machine, as Windows authentication for
SQL Server is required.

Page | 34
Veeam Reporter 4.0 | User Guide

DEPLOYMENT
The Veeam Reporter 4.0 setup comprises three components — Veeam Reporter Server, Veeam
Reporter Web UI and Veeam Reporter PowerShell snap-in.
 The Veeam Reporter Server component is responsible for controlling execution of data
collection and reporting jobs and storing VI objects data to the SQL database. At
installation, the Veeam Reporter Server setup installs a new SQL Server 2008 Express
with Advanced Services instance or offers to use an SQL server installed remotely or
locally.
 The Veeam Reporter Web UI component enables web access to collected data for
multiple clients, intending to generate different kinds of VI environment reports, via the
web browser. This component can be installed on the computer with Reporter Server,
or on a different machine. If Veeam Reporter components are installed on different
machines and/or a remote SQL server is used, the Named Pipes protocol on SQL must
be enabled.
 The Veeam Reporter PowerShell snap-in enables the user to perform reporting tasks by
running single cmdlets or custom automation scripts via the command-line interface.

Important! Before installing Veeam Reporter 4.0, make sure that IIS version 5.1 or higher is installed on
your computer.

Free and Commercial Version


Veeam Reporter 4.0 is available in two versions: a licensable version featuring full application
functionality and a free version featuring limited application functionality (see table below). If
the user does not provide a license at the installation process, Veeam Reporter 4.0 is regarded
to be used as a free version. Without a license file it can be used for up to 90 days. After that, it
will be necessary to get a commercial or free license file from www.veeam.com.

Feature Full Version Free Version


SSRS-based reports Supports unlimited user- Limited to one user-
defined SSRS-based reports defined SSRS-based report
Veeam Reporter Supports any number of reports Limited to one report
Dashboard to be used as widgets
Custom report Supports installation of Only default report packs
packs additional report packs can be used
PowerShell access Available via the PowerShell Not available
snap-in
Automatic Reports generation and delivery Reporting jobs can only be
reporting jobs can be scheduled run manually
Change All VI changes can be tracked Infrastructure Changes
management for any period of time report is available only for
the last 24 hours
Capacity planning Future VI performance can be Not available
predicted
Infrastructure Full VI layout can be presented Only two types of Visio
management as a set of diagrams reports are available –
Configuration and Storage
Raw data analysis Fully supported Not available
Technical support Full support and updates Not available

Page | 35
Veeam Reporter 4.0 | User Guide

Installing Veeam Reporter 4.0


This section will guide you through the installation process of Veeam Reporter 4.0.

Step 1. Run Veeam Reporter Setup


Download the latest version of the application from:
http://www.veeam.com/vmware-esx-reporter/download.html. Unpack the downloaded
archive and run the VeeamReporter.exe file.

Step 2. Accept License Agreement


Read, then accept or decline the License Agreement. If you select I do not accept the terms
in the license agreement, the installation process will be terminated.

Page | 36
Veeam Reporter 4.0 | User Guide

Step 3. Choose Components and Destination


At this step, you should select a destination folder for installation of Reporter Server and
Reporter Web UI components.
Use the Space button to estimate how much free space is available on your disks. Note that at
least 17 MB is required to install the Reporter Server component, and 35 MB is required to
install the Reporter Web UI component.
Click Change... to select a necessary installation folder.

Tip: You can install Veeam Reporter components on different machines. To install components
separately, click a component you do not want to install and disable it. You will then have to
run setup on another machine and install this component there.

Page | 37
Veeam Reporter 4.0 | User Guide

Step 4. Install License


At this step, specify the license file for Veeam Reporter. You can use the trial license that was
sent to you after registration, the purchased full license or install Veeam Reporter without the
license file and use the free version (see Free and Commercial Version). Click the Browse…
button and select a necessary .lic file.

Step 5. Set up a Database to Be Used


Select to install a new SQL server or use the existing one. If the second option is selected, enter
the SQL Server instance name in the HOSTNAME\INSTANCE format.

Note: In case the VeeamReporter database already exists on the SQL Server instance (that is, it was
created by the previous installations of Veeam Reporter), a warning message notifying about it
will be displayed. Click the Use Existing button to connect to the detected database. If
necessary, the existing database will be upgraded to the latest version.

Page | 38
Veeam Reporter 4.0 | User Guide

Step 6. Select SSRS Instance


At this step, you should select an SSRS instance that will be used for integration with Veeam
Reporter 4.0. You can use a remote SSRS instance that already exists in your environment (for
this option, you will have to manually specify SSRS settings in Veeam Reporter 4.0 after it is
installed), install a new SSRS instance using the Veeam Reporter setup, or use a local SSRS
instance.
If you select one of the two latter options, make sure the Configure selected SSRS instance
for Veeam Reporter automatically check box is selected — otherwise you will have to
manually specify SSRS settings after Veeam Reporter is installed. To learn more, see the
Specifying SSRS Server Settings section.

Step 7. Specify Service Credentials


Specify the user name and password to be used by Veeam Reporter 4.0. Please note that the
user should have the database owner rights to the VeeamReporter database on the Veeam SQL
Server instance.

Page | 39
Veeam Reporter 4.0 | User Guide

Step 8. Specify the TCP Port


If necessary, change the number of TCP port to be used by Veeam Reporter IIS web site. By
default, port 1239 is used.

Step 9. Install Veeam Reporter 4.0


Click Next, then click Install. Veeam Reporter Server will be installed on your computer. Once
installation is complete, click Finish to finish working with the setup wizard.

Important! If you are installing Veeam Reporter on Windows XP, you may need to enable access to Veeam
Reporter web interface. Select Tools > Options from the main Windows Explorer menu, then
click View and clear the Use simple file sharing check box.

Upgrading Veeam Reporter


Important! We strongly recommend that you back up your current Veeam Reporter SQL database before
starting the upgrade process. Also, it is crucial that you stop all collection and reporting jobs.

To upgrade Veeam Reporter Enterprise 3.5 or Veeam Reporter 4.0:


1. Download the latest version of Veeam Reporter from
http://www.veeam.com/vmware-esx-reporter/download.html.
2. Extract the downloaded archive.
3. Run the setup file on all computers where the product components are installed. The
setup will detect the components – Veeam Reporter Web UI, Veeam Reporter Server and
Veeam Reporter PowerShell, and remove them after confirmation.
4. Follow the installation wizard steps (learn more).
5. During the upgrade process, the setup detects and upgrades the SQL database used
by a previous version of Veeam Reporter. If Veeam Reporter used SQL Express 2005
installed locally, the setup will offer to install the SQL Server Reporting Services
component to be used for generating SSRS-based reports.
6. Upgrade the Report Viewer component on all computers used to view reports
produced by Veeam Reporter.

Page | 40
Veeam Reporter 4.0 | User Guide

Veeam Reporter Licensing


Veeam Reporter 4.0 is licensed per socket for each Managed Server. Managed Server is defined
as VMware ESX Server that is collected data from or otherwise managed by the software.
"Socket" means a single, physical chip that houses no more than six (6) processor cores.
The trial license key is sent to you after registering at
http://www.veeam.com/vmware-esx-reporter/download.html, and is valid for 30 days from
the moment of registration. To obtain a full license key for the desired number of sockets,
please refer to http://www.veeam.com/buy-end-user.html.
The full license includes a one-year maintenance plan. To renew your maintenance plan,
please contact us at support@veeam.com
To learn how to install Veeam Reporter license, see the Customizing Application Settings
section.

Page | 41
Veeam Reporter 4.0 | User Guide

Installing a License
When installing Veeam Reporter 4.0, you will be asked to specify the license file that was sent
to you after registration. If you do not specify the license file, Veeam Reporter 4.0 will be used
as a free version with some functionality restrictions (see Free and Commercial Version). After
90 days it will be necessary to activate Veeam Reporter 4.0 by registering at www.veeam.com,
receiving and specifying the free license file.
You can install a new product license and see information on the currently used one using the
License section of Veeam Reporter 4.0. Сlick Configuration link at the top right corner of the
window, and then click License on the left.
To install a new license, click the Browse button and select a necessary .lic file. Then click the
Install button. After the Veeam Reporter Server verifies the license data, information about
the license and license status will be displayed at the upper part of the License section.

Revoking ESX Severs from the License


Veeam Reporter 4.0 provides you with a possibility to revoke unused ESX servers from a
license — that is, to re-use the license applied to one ESX server to another ESX server. This
may be required if the ESX server to which the license is applied does not require reporting
anymore (for example, if it is no longer used).
When you access the Configuration section of Veeam Reporter 4.0 for the first time, the
License usage section is empty. After you run a collection job targeted at some VI object, for
example a vCenter server, this section will display the list of ESX servers that were engaged in
the job, with the number of sockets per each.
To revoke a specific ESX server, click the Revoke link next to it. Licensed sockets used by it will
be freed and will become available for use by other ESX servers.

Note: When you successfully update a license, the list of ESX hosts will be cleared.

Page | 42
Veeam Reporter 4.0 | User Guide

ADMINISTRATION
This section provides a detailed description of main administration activities performed via the
Configuration section of Veeam Reporter 4.0: creating and managing data collection and
reporting jobs, working with jobs sessions, installing a license and customizing main
application settings. To open the Configuration section click Configuration in the top right
corner.

Working with Collection Jobs


To manage data collection, click Collection Jobs in the left part of the Configuration section.
The list of existing jobs will be displayed. Use the toolbar at the top to add new jobs, edit and
delete existing ones, as well as start and stop created jobs.
To learn more about jobs, see the Collection Jobs section.

Adding Jobs
To add a new collection job, click the New button in the toolbar and follow the Job wizard
steps.

Step 1. Specify General Job Settings


At the first step, you should specify general job data. Enter a name and description of the
created job.
Note that the Job name field is obligatory — you will not be able to pass to the next step of
the wizard if a name of the created job is not specified.

Step 2. Define Job Scope


At this step, you should add VI objects for which data should be collected. Veeam Reporter 4.0
allows you to add standalone ESX hosts and vCenter servers. If you add a vCenter server, you
can collect data for all objects in its hierarchy starting from the root node, or for any specific
object — datacenter, cluster and folder.
The scope of a collection job may cover a number of separate VI objects.
To add a VI object to a job:
1. In the Server field, enter a vCenter server or ESX server name.
2. In the User name and Password fields, specify user credentials for the added server.
3. If you are adding a vCenter server, select VI objects that should be reported about: click
the Browse button to the right of the Collection scope field and select a necessary
object from the list.
Once you click the Browse button, the Veeam Reporter Server will verify entered VI
object data (server name and user credentials) and connect to vCenter server.
Connection to the server may take a while; please do not click any buttons or close the
window before the vCenter server hierarchy is displayed.
4. If you are using a proxy server in your VI environment, click the Proxy… button. In the
displayed window, select a necessary value from the Proxy list: Automatic — a proxy
server will be automatically detected and used; or Manual — you will have to specify
the proxy address and port manually.
5. The Use SSL option is used to encrypt transmitted VI data. Encryption affects CPU
usage of the ESX server slightly, but provides secure data transfer. If you do not want to
use this option, clear the check box.

Page | 43
Veeam Reporter 4.0 | User Guide

6. Then, click the Add button below to add the selected object to the data collection
scope. When you click the Add button, Veeam Reporter 4 will check if the selected VI
object is available and add it to the scope of a collection job.
Repeat the procedure for all objects that should be added to the created job.
To delete an object from the job scope, click the Delete link next to a necessary object in the
list of objects.

Note: If the user account has Read-only permissions on target objects, data for some objects (for
example, datastore and license information) will not be collected. To be able to get audit data
that is collected from the vCenter server, the user should also have permissions on the root
object.

Page | 44
Veeam Reporter 4.0 | User Guide

Step 3. Specify Collection Job Schedule


At this step, you should define the time frame by which the created collection job should be
executed.
If you are planning to run the created job manually, click the Next button to pass to the next
step of the wizard. If you want the job to be run automatically, select the Run this job
automatically check box and specify a necessary time schedule:
 To run the job at some time interval, select the Periodically every… hours option and
specify the interval at which the job should be run.
 To run the job every day at specific time, select the Daily at this time option and
specify the time when the job should be executed. In the Choose days section below,
select on which week days the job should be run.

Page | 45
Veeam Reporter 4.0 | User Guide

Step 4. Specify Change Notification Options


At this step, you can select to receive e-mail notifications about changes for VI objects that
have occurred since the last run of a job. A notification will contain all changes for VM
containers that you added to the collection jobs.
1. In the To field, specify the e-mail address of the recipient (to enter multiple e-mail
addresses, use semicolon).
2. In the Subject field, specify a subject of the notification to be sent. You can use the
%JobName% and %JobResult% variables in this field.

Important! To receive e-mail notifications, you should configure general e-mail and notification settings
under Settings in the Configuration section. If these settings are not specified, Veeam
Reporter 4.0 will display a warning note.

Editing and Deleting Collection Jobs


To edit settings of a previously created job, select it in the list of jobs, click the Edit button on
the toolbar and edit the job data as necessary.
To delete a job, select it in the list and click the Delete button on the toolbar.

Page | 46
Veeam Reporter 4.0 | User Guide

Running Collection Jobs Manually


To manually start/stop a collection job, select it in the list and click Start/Stop in the toolbar.
Every run of a collection job initiates a new job session. To view details on job sessions, click
Sessions History in the left part of the Configuration section.
The list of sessions provides data on all collection jobs that were started. Every session is
described with the following data: name of the job for which a session has been initiated, start
date and session status.
To display detailed information on a specific session, click the session in the list.

Tip: To easily find a necessary session, you can sort the list of sessions by job name, start date or
status. Click a corresponding column heading once or twice to sort sessions in the ascending
or descending order.

Page | 47
Veeam Reporter 4.0 | User Guide

Working with Reporting Jobs


To automate a reporting procedure, you can create and schedule a reporting job. A reporting
job aggregates main settings for a reporting task: types of reports that should be generated, VI
objects for which data should be provided, scheduling and delivery settings.
To manage report generation, click Reporting Jobs in the left part of the Configuration
section. The list of existing report jobs will be displayed. Use the toolbar at the top to add new
jobs, edit and delete existing ones, as well as start and stop created jobs.
To learn more about jobs, see the Reporting Modes section.

Add a Reporting Job


To add a new reporting job, click the New button on the toolbar and follow the Reporting
Job wizard steps.

Step 1. Specify General Job Settings


At the first step, you should specify general job data. Enter a name and description of the
created job.
Note that the Job name field is obligatory — you will not be able to pass to the next step of
the wizard if a name of the created job is not specified.

Step 2. Choose the Reporting Engine


At this step of the wizard, you should select the engine that will generate reports: Microsoft
SQL Reporting Services or Veeam Report Viewer.

Page | 48
Veeam Reporter 4.0 | User Guide

Step 3. Choose Report Types


At this step of the wizard, you should select what types of reports you want to generate when
a reporting job is run.
 If you have selected Microsoft SQL Reporting Services as a reporting engine, select the
report pack you want to use, reports and a format in which reports should be
generated. You can also provide a short description for the created reports.
 If you have selected Veeam Report Viewer as an engine, specify the caption that will
label created reports, a report pack you want to use and types of reports that you want
to create.

Important! To be able to select an SSRS-based report, you should beforehand save it using the Workspace
of Veeam Reporter 4.0. To learn more, see the Workspace section.

Step 4. Define Job Scope


This step is available only if you have selected Veeam Report Viewer as an engine. Select VI
objects for which a report should be created. You generate reports for standalone ESX hosts,
vCenter servers and objects in their hierarchy.

Page | 49
Veeam Reporter 4.0 | User Guide

Step 5. Specify Reporting Job Schedule


At this step, you should define the time frame by which the created reporting job should be
executed.
If you are planning to run the created job manually, click the Next button to pass to the next
step of the wizard.
If you want the job to be run automatically, select the Run this job automatically check box
and specify a necessary time schedule:
 To run the job every day at specific time, select the Daily at this time option and
specify the time when the job should be executed. In the Choose days section below,
select on which week days the job should be run.
 To run the job at some time interval, select the Periodically every… hours option and
specify the interval at which the job should be run.

Page | 50
Veeam Reporter 4.0 | User Guide

Step 6. Specify Report Delivery Settings


You can select to deliver generated reports by e-mail or store them to a folder on a hard drive
or to a network share.
1. In the To field, specify the e-mail address of the recipient (to enter multiple e-mail
addresses, use semicolon).
2. In the Subject field, specify a subject of an e-mail to be sent. You can use the
%JobName% and %JobResult% variables in this field.
3. In the Path field, specify a path to a local folder or a network share to which a report
should be stored. Keep in mind that you should enter a path to the existing local or
shared folder. When you click Finish, Veeam Reporter 4.0 will check if the specified
folder exists and the Veeam Reporter Scheduling Service has access to it and, if a
problem occurs, display a warning icon next to the Path field.
4. After reports are saved to the specified destination, you can execute a custom script.
Click the Advanced... button and specify a path to a script executable file.

Important! To be able to receive e-mails with reports, you should configure general e-mail and
notification settings under Settings in the Configuration section. If these settings are not
specified, Veeam Reporter 4.0 will display a warning note.

Editing and Deleting Reporting Jobs


To edit settings of a previously created job, select it in the list of jobs, click the Edit button on
the toolbar and edit the job data as necessary.
To delete a job, select it in the list and click the Delete button on the toolbar.

Page | 51
Veeam Reporter 4.0 | User Guide

Running Reporting Jobs Manually


To manually start/stop a collection job, select it in the list and click Start/Stop in the toolbar.
Every run of a reporting job initiates a new job session. To view details on job sessions, click
Sessions History in the left part of the Configuration section.

Page | 52
Veeam Reporter 4.0 | User Guide

Customizing Application Settings


Using the Settings view of the Configuration section, you can customize general Veeam
Reporter settings.
The application settings are divided under the following tabs:
 On the SQL Server tab, you can specify SQL server and database settings for Veeam
Reporter 4.0.
 On the SSRS Server tab, you can specify settings of the Microsoft SQL Server Reporting
Services server that will be used for integration with Veeam Reporter 4.0.
 On the SMTP Server tab, you can specify e-mail settings that will be used for sending e-
mail notifications and reports.
 On the Business View Server tab, you can specify settings of the Veeam Business View
server that will be used for integration with Veeam Reporter 4.0.
 On the Email Notifications tab, you can specify general notification settings.
 On the Advanced tab, you can select units of measurement in which data should be
presented in reports.

Specifying SQL Server Settings


After installation, the SQL Server tab will contain the database settings that you defined
during the application setup. You can change the database settings as required.
1. In the Database server field, enter the SQL Server name in the HOSTNAME\INSTANCE
format.
2. In the Authentication type field, select the type of authentication to connect to the
database – Windows authentication or SQL Server authentication, and provide user
credentials to connect to it. To avoid problems, we recommend specifying the user
name in the DOMAIN\USERNAME format.

Important! The database name is pre-set to VeeamReporter by default. Please do not change this value to
ensure correct work with the database.

Page | 53
Veeam Reporter 4.0 | User Guide

Specifying SSRS Server Settings


The SSRS Server tab allows you to provide settings of the Microsoft SQL Reporting Services
server that will be used for integration with Veeam Reporter 4.0.
1. Select the Use Microsoft SQL Server Reporting Services check box.
2. In the SSRS server URL field, enter a name of the server on which SSRS is installed in
the following format: http://servername:port/VirtualDirectory. To check the URL, launch
Reporting Services Configuration Manager and refer to the Web Service URL section.
3. Enter a user name and password to connect to the server. To avoid problems, we
recommend specifying the user name in the DOMAIN\USERNAME format.
4. Use the Manage report packs section to add or delete report packs that you want to
use for reports generation. By default, Veeam Reporter 4.0 is delivered with the Base
and Performance report packs pre-installed.

Tip: Veeam Reporter 4.0 provides a possibility to verify entered server settings. To check if you
have entered correct data, click the Test button. Veeam Reporter 4.0 will display a notification
informing if the data you provided is correct or not.

Page | 54
Veeam Reporter 4.0 | User Guide

Specifying SMTP Server Settings


The SMTP Server tab allows you to specify e-mail settings that will be used to send
notifications about changed data and reports generated with reporting jobs.
1. In the SMTP Server field, enter a full DNS name or IP address of the SMTP server that
will be used for sending e-mail messages.
2. In the From field, enter the e-mail address from which e-mail notifications should be
sent.
3. If your SMTP server requires SMTP authentication, specify authentication credentials:
user name and password.
4. If necessary, specify advanced SMTP server settings: port to be used and connection
timeout.
After you define e-mail settings, navigate to the Email Notifications tab to configure main
notification settings.

Page | 55
Veeam Reporter 4.0 | User Guide

Specifying Business View Server Settings


The Business View Server tab allows you to provide settings of the Veeam Business View
server from which categorization data will be retrieved. To learn more, see the Generating
Reports for Business Groups of VMs section.
1. Select the Enable Veeam Business View integration check box.
2. In the Business View server URL field, specify a name of the server in the following
format: http://servername:port/<path>. If a default port is used, you can specify a DNS
name of the server and click the Test button.
3. Enter a user name and password to connect to the server. To avoid problems, we
recommend specifying the user name in the DOMAIN\USERNAME format.

Tip: Veeam Reporter 4.0 provides a possibility to verify entered server settings. To check if you
have entered correct data, click the Test button. Veeam Reporter 4.0 will display a notification
informing if the data you provided is correct or not.

Page | 56
Veeam Reporter 4.0 | User Guide

Specifying Email Notification Settings


The Email Notifications tab allows you to customize general settings for notifications that will
be sent to inform the user about the current status of collection and reporting jobs. If you
want notifications to be sent:
1. Select the Enable automated e-mail notifications on Veeam Reporter jobs check
box.
2. In the To field, enter the e-mail address of an e-mail notification recipient. To specify
several addresses, use semicolon.
3. In the Subject field, enter a subject of the e-mail. You can use the following variables in
the subject: %JobName% and %JobResult%.
4. Select the events on which e-mail notifications should be sent: on jobs success, on job
failure, and if an error occurs during the job execution.
You can send a test e-mail to check if e-mail and notification settings are configured properly
— to this end, click the Send Test Message button.

When the selected event occurs, Veeam Reporter 4.0 will send a notification e-mail to the
specified e-mail address(es). The body of the notification e-mail contains a description and
status of a job; additionally, a log file containing a detailed description of the events workflow
is attached to the message.

Note: Notification e-mails sent by Veeam Reporter 4.0 may be regarded as unsolicited e-mails by
some e-mail clients. If you are not receiving notifications, check the folder with junk messages
in your e-mail client.

Specifying Advanced Settings


The Advanced tab allows you to choose in which units of measurements VI data will be
presented in SSRS reports. You can select one of the following values:
 GB
 MB
 KB
 bytes

Page | 57
Veeam Reporter 4.0 | User Guide

Customizing Data Administration Settings


The Data Administration view allows you to specify the duration for storing historical data in
the VeeamReporter database, and define VI objects which should or should not be displayed in
the Workspace.
1. Click the Configuration link at the top right corner, and then click Data
Administration on the left.
2. Use the Historical data retention period list to select the time interval for which data
should be saved. After you specify the retention policy data, Veeam Reporter 4.0 will
create a system Data Administration job that will automatically run on Sundays and
delete all data exceeding the defined time interval.
Under Hide objects from the infrastructure tree you can select which objects should
or should not be displayed in the VI hierarchy of the Workspace. Click Hide to hide an
object or Show to show a hidden object. Note that this option is applicable only to
vCenter servers, ESX hosts and VM containers for which data is collected.

Page | 58
Veeam Reporter 4.0 | User Guide

WORKSPACE
The Workspace of Veeam Reporter 4.0 is intended for generation of different kinds of reports
containing data on VI environment objects from different viewpoints. To enter the
Workspace, click the Workspace tab.
The left pane of the Workspace contains the VI environment hierarchy tree, where the user
can select a necessary VI object for which reports are to be generated. The right part of the
Workspace is used to display general information on the selected VI object and allows the
user to choose what kinds of reports should be generated. You can generate reports using the
Offline, Base and Performance report packs. To learn more about different reports, see the
Types of Reports section.

Selecting Reporting Date


Veeam Reporter 4.0 generates reports from data that was collected and stored in the
VeeamReporter database at a specific job run (that is, a job session). The time of the job session
performance here acts as a benchmark for the VI environment state.
If you enter the Workspace, select a necessary report and click the Create Report button,
reports will be created as of the latest point of collecting data (last session of a collection job).
To select a specific state of the VI environment (the date and session):
1. Click the Change Date... button at the top of the inventory tree.
2. Click the Calendar icon or use the Next and Prev buttons to select a necessary date.
3. In the Sessions list, select the session at which the VI environment was in the desired
reporting state.

After you have selected a necessary point in time, you can proceed to generating VI reports.

Page | 59
Veeam Reporter 4.0 | User Guide

Generating Offline Reports


To generate reports from the Offline report pack:
1. From the Report packs list, select Offline report pack.
2. Select a necessary report from the Reports list.
3. Select a necessary VI object(s) in the VI infrastructure three.
4. Select a necessary date of which report should be generated using the Change Date…
button at the top of the inventory tree (to learn more, see the Selecting Reporting Date
section). If you want reports to contain the latest VI data, skip this step.
5. Specify report settings, if necessary:
• For Infrastructure reports: select check boxes next to types of reports you want to
generate.
• For the Infrastructure Changes report: if you want the report to contain data for
the latest N hours, days or months, select the Show changes for the last option
and enter a necessary number of days, hours or months. If you want the report to
contain data for some time interval, select the Show changes in the specified
date range option and choose necessary collection job sessions as time limits.
6. Click the Create button to generate a .vmr file. You can save the created file or open it
to generate reports in Microsoft Visio, Microsoft Word, Microsoft Excel or Adobe PDF
formats.

Granulating Visio Reports


As Visio infrastructure reports provide a detail topology data for all objects in your virtual
infrastructure, a report for a large virtual infrastructure can be really dense and cumbersome at
scaling. To facilitate work with Visio reports, Veeam Reporter 4.0 provides a possibility to
granulate them and re-group VI topology around key objects. A granulated report is
generated as a single index Visio page containing links to subreports.

To granulate a Visio report:


1. From the main menu of Veeam Report Viewer, select Tools > Options.

Page | 60
Veeam Reporter 4.0 | User Guide

2. Click the Visio tab.


3. In the Object limit section, set the number of VI objects that should be displayed on
one page. You can enter any value between 200 and 2000. When the number of objects
exceeds the specified value, Veeam Reporter 4.0 will create additional report pages.
After you generate a report, click the information icon next to a necessary VI object and select
a necessary type of report. A subreport grouped around this object will be opened in a
separate Visio page.

Creating Raw Data Analysis Templates


Working with the Raw Data Analysis report, you can create a template that will be used for
generating custom reports with raw VI data meeting your production needs.
To create a report template:
1. Customize the generated Raw Data Analysis report using filters, diagrams, pivot tables
and formulas.
2. Save the modified report as the Raw_Data_custom.xlsx file in the
%installationPath%\Veeam Report Viewer\Templates folder.
Veeam Report Viewer will apply the created template in future, and use specified settings for
the Raw Data Analysis report generation. This template will be used even after Veeam Report
Viewer and Veeam Reporter are updated.

Re-Organizing Raw Data Analysis Reports


Along with other VI information, Veeam Reporter 4.0 collects custom attributes information
for VMs, templates and ESX hosts and displays it in Raw Data Analysis reports line by line.
Using Veeam Report Viewer options, you can re-order custom attributes data and present it as
columns in the table. This way, you can facilitate work with the custom attributes data that is
commonly used to categorize VI environment.
To work with custom attributes data:
1. Select Tools > Options... from the main menu of Veeam Report Viewer.
2. In the VM properties to add category data to field on the General tab, specify names
of VM columns to which values of custom attributes should be added. To specify
multiple VM properties, enter their values one by one using semicolon.
When building the Raw Data Analysis report, Veeam Report Viewer will use specified VM
properties to display categorization data stored in custom attributes.

Page | 61
Veeam Reporter 4.0 | User Guide

Generating SSRS-Based Reports


To generate SSRS-based reports, you should create them using templates from the Basic
report pack. The created reports will be saved to the SSRS database and can used for further
reporting.

Creating SSRS-Based Reports from Templates


To create a report from a report template:
1. From the Report packs list, select Base report pack.
2. Select a necessary report template from the Reports list.
3. Customize report template as necessary:
• For Infrastructure report: in the Object Type field, select for which type of
object report should be created. In the Columns field, select properties for the
selected type of objects that should included into the report. Use the Custom
Filter, Sort By and Group By fields to organize data in the created report.
• For the Infrastructure Changes report: in the Object Type field, select for which
type of object report should be created. In the Object properties field, select
properties for the selected type of objects that should included into the report. If
you want the report to contain data for the latest N hours, days or months, select
the Show changes for the last option and enter a necessary number of days,
hours or months. If you want the report to contain data for some time interval,
select the Show changes in the specified date range option and choose
necessary collection job sessions as time limits.
• For Host Performance and VM Performance reports, select a necessary
performance counter from the list.
• For Capacity planning report, select the threshold, type of objects and time
period of predictions. For WHAT IF: Add host and WHAT IF: Add VM reports, it is
also necessary to specify the host/VM from your VI with parameters similar to the
host/VM you are planning to add, and the number of such hosts/VMs. For WHAT
IF: Host failure report, select the type of objects and time period of predictions.
3. Click the Save as… button to save the created report.
The created report will be saved to the SSRS database and added to the Reports list. You can
now use it to generate SSRS-based reports and add it to the Veeam Reporter’s dashboard (to
learn more, see the Dashboard section).

Page | 62
Veeam Reporter 4.0 | User Guide

Generating SSRS-Based Reports


To generate SSRS-based reports:
1. From the Report packs list, select Basic report pack.
2. Select the report you created from the Reports list.
3. Select a necessary VI object(s) in the VI infrastructure.
4. Select a necessary date of which report should be generated using the Change Date…
button at the top of the inventory tree (to learn more, see the Selecting Reporting Date
section). If you want reports to contain the latest VI data, skip this step.
5. If necessary, select the Open report in new window check box.
6. Click the Create Report button.
Veeam Reporter 4.0 will open the created report using the web browser. You can view it or
save in the Microsoft Word, Microsoft Excel or Adobe PDF formats.

Editing and Deleting SSRS Reports


Using the Workspace of Veeam Reporter 4.0, you can edit and delete reports that you created
using templates from SSRS-based report packs.
To edit a report, select it in the Reports list and edit its data using the Reports settings
section. Then, click the Save button to save changes that you made.
To delete a report, select it in the Reports list and click the Delete button. Keep in mind that
when you delete a report, it will also be removed from the Veeam Reporter’s dashboard.

Page | 63
Veeam Reporter 4.0 | User Guide

Generating Reports for Business Groups of VMs


Veeam Reporter 4.0 uses advantages of Veeam Business View and provides reporting options
for your VMware virtual infrastructure presented in a business perspective. Veeam Reporter 4.0
meets real-world scenarios and allows generating reports for groups of VMs categorized on
the basis of business unit, department, purpose, SLA and other business categories.

Veeam Business View is a free add-on that works with other Veeam products to enable
business categorization for VMware vSphere environment. Unlike VMware vCenter server that
provides only technical view on the virtual infrastructure, Veeam Business View presents the
hierarchy of VMs in business terms, as they are categorized in your virtual infrastructure. To
learn more about Veeam Business View, see http://www.veeam.com/vmware-business-
view.html.
Veeam Business View comes with a built-in web service having a number of public methods
that can be used for integration by any third-party application. Veeam Reporter 4.0 fully
integrates with Veeam Business View and retrieves categorization data directly from the
Veeam Business View database, thus putting no additional workloads on the vCenter server.
To integrate categorization data into Veeam Reporter 4.0, it is necessary to specify the server
on which Veeam Business View database resides in the main application settings. To learn
more, see the Specifying Business View Server Settings section.
You can work with the business view of your virtual infrastructure just as you work with the
traditional view and create all kinds of reports with respect to specific business groups of VMs.
To create a report for business groups of VMs:
1. From the Report packs list, select a necessary pack.
2. Select a necessary type of report from the Reports list.
3. To switch to the business view of you VI, click the Business View tab at the bottom of
the VI tree. Then, select a necessary VM category or a number of categories.
4. Select a necessary date of which report should be generated using the Change …
button at the top of the inventory tree (to learn more, see the Selecting Reporting Date
section). If you want reports to contain the latest VI data, skip this step.
5. Click the Create Report button.

Important! If you select to generate reports for business groups of VMs, the following types of reports will
not be available: reports from the Offline report pack (except the Raw Data Analysis report),
and Host Performance report from the Performance report pack.

Page | 64
Veeam Reporter 4.0 | User Guide

DASHBOARD
Veeam Reporter 4.0 allows you to easily create and customize your own dashboard with
commonly used reports or summaries of reports.
A dashboard includes a number of reports displaying the most important aspects of virtual
infrastructure. By aggregating key VI data on a single screen, the dashboard allows VMware
administrators and executives to immediately focus on critical areas of VMware virtual
infrastructure.
Reporting data in Veeam Reporter’s dashboard is constantly updated with collection jobs —
this lets the dashboard provide at-a-glance perspective of the current state of the VMware
virtual environment. You can view and share the created dashboard through the web, or
integrate reports into third-party dashboards and intranet web portals, such as Microsoft
SharePoint.

Dashboard can be created and customized in the Design mode of the Dashboard view. The
Design mode is available for users having Veeam Reporter Administrators’ rights. Users having
Viewers’ rights can only view dashboards. To access the dashboard in the Design mode, click
the Dashboard tab, and then click the Edit Dashboard button.
The Design view has two panes — the upper pane displays the Dashboard layout, and the
lower pane contains reports that you can add to the Dashboard. To create a dashboard, you
should:
 Customize the dashboard layout
 Create dashboard widgets

Page | 65
Veeam Reporter 4.0 | User Guide

Customizing Dashboard Layout


The Dashboard can include any number of reports. Before you add reports to the dashboard,
you should design a grid into which reports should be nested.
To create a dashboard grid, use the upper pane of the Design view.
1. To access the Design mode, click the Dashboard tab, and then click the Edit
Dashboard button.
2. Click the arrow at the top right corner of the lower pane to collapse the list of reports.
3. Drag the blue borders from the right and the bottom of the screen to a necessary
position to create cells into which reports will be added. You can create as many cells as
you need.

Tip: To discard changes you made, expand the Reports list and click the Reset Dashboard button
at the top of the pane.

Page | 66
Veeam Reporter 4.0 | User Guide

Creating Dashboard Widgets


The list of reports that you can add to the dashboard is displayed at the lower pane of the
Design view. To be able to add a report, you should beforehand create it in the Workspace
view using predefined report templates, and save it. Keep in mind that you can only save
SSRS-based reports created from templates in the basic report pack.
To display data of added reports, the dashboard uses web-based widgets. Every widget is
located in a separate cell, or frame, in the dashboard. Widgets enable users to represent
report data using different combinations of chart types, filtering and grouping options, as well
as aggregate functions. You can, for example, organize report data as a chart pie, table or
clustered column and select to display top 10 data sets, while hiding the others.
To create a report widget, drag a report from the list of reports and drop it onto a necessary
cell in the dashboard grid. Once you drop a report, Veeam Reporter 4.0 will display the New
Dashboard Widget window. You can use a pre-defined widget or create a new one by
specifying necessary data selection, sorting and chart type settings.

Dashboard widgets allow you to create charts of the following types: 3-D column and 3-D
cylinder, Clustered column, Exploded pie, Line with markers and Stacked column.
Every type of chart requires specific set of data – for example, exploded pies are two-
dimension charts so you need to select two data sets that will be used for building a chart,
while 3-D column and cylinder charts require 3 sets of data. In the Working with Charts
section, you will find basic principles of charting and data presenting as well as simple
examples that will help you build charts in Veeam Reporter’s dashboard.

Page | 67
Veeam Reporter 4.0 | User Guide

Working with Dashboard Widgets


Using the Design mode of the Dashboard, you can edit and delete widgets, refresh data in
them, change widgets position in the dashboard, get more detailed information about
underlying reports and retrieve the URL of the widget to integrate it into third-party portal,
such as Microsoft SharePoint.
 To edit a widget, click the Edit Widget button at the top right corner of the widget
frame and edit data as required. To delete a widget, click the Delete Widget button.
 To change the widget position in the dashboard, simply drag and drop it onto a
necessary cell.
 Data in widgets is automatically refreshed with every run of data collection jobs. To
force data refresh, click the Refresh Widget button at the top right corner of the
widget frame.
 To see detailed data for the report that was used for widget creation, click the View Full
Report button at the top right corner of the widget frame.
 To get the URL of the widget to be able to integrate it into the third-party portal, click
the Get URL link at the top right corner of the widget frame. URLs of widgets can also
be copied by uses having Veeam Report Viewers rights.

Using Aggregate Functions in Charts


Dashboard widgets allow you to select one of the following aggregate functions for
presenting report data:

Function Description
Avg Returns the average of values in selected data fields.
Count Returns the number of records in the table. Records with no
values (empty records) are not counted.
CountDistinct Returns the number of distinct values in selected data fields.
Max Returns the maximum value from selected data fields.
Min Returns the minimum value from selected data fields.
Sum Returns the sum of values in selected data fields.

Page | 68
Veeam Reporter 4.0 | User Guide

Sorting and Filtering Data in Charts


When you create a widget, you can either add the whole report to the dashboard or create a
summary of your report that will display the most important information. To select what data
you want to present, use the Sorting options section of the New Dashboard Widget
window.
 From the Sort by list, select a data field by which you want to sort information in the
report.
 From the Sort direction list, select the sorting order – Ascending or Descending.
 From the Show top list, select the number of data fields that you want to display.

Page | 69
Veeam Reporter 4.0 | User Guide

Working with Charts


Depending on the type of chart you want to create, data sets to be selected and their
presentation in the chart may vary. This section provides basic information about charting and
data presenting in the dashboard.

Presentation of Data in Charts


To create a chart using dashboard widgets, you should select data that you want to present in
the chart. As well as in standard charts, charts in Veeam Reporter 4.0 display data fields, data
categories and data series.
 Data field is a single bar, area, dot, slice, or other symbol in a chart. Data fields originate
from a cell in the table or spreadsheet. Related data fields in a chart constitute a data
series.
 Data category is a group of data fields united on the basis of some criterion. Data
categories are usually presented on the horizontal axis.
 Data series is a set of related data that is distinguished by the same color and pattern
in the chart. Data series originate from table rows and columns. You can plot one or
more data series in a chart. Pie charts can have only one data series.
The chart below visualizes the number of VMs in different connection states on different ESX
hosts. Here VM state is a data series, reference of a VM to an ESX host is a data category and
VM count is a data field.

Page | 70
Veeam Reporter 4.0 | User Guide

Examples
This section provides simple examples of creating charts in dashboard widgets.

Creating 3-D Column and 3-D Cylinder Charts


3-D column and 3-D cylinder charts can be helpful if you want to compare data of different
categories across a number of data series side by side. In 3-D Column and 3-D Cylinder charts,
categories are organized along the horizontal axis, values are organized along the vertical axis
and data series are organized along the depth axis.

Example
Let’s create a chart displaying how much free space is available on datastores connected to
ESX hosts.

In this chart, we will visualize data from the following simple report created on the basis of the
Infrastructure Report template with the following report settings:
 Object type: Storage
 Report columns: Name, Free Space, Host System

To create a 3-D column or cylinder chart:


1. Drag the report to the dashboard cell. The New Dashboard Widget window will be
displayed.
2. Select the Create new widget from the following datasource option and choose
Table 1 from the list below.
3. In the Data selection section, from the Series fields list select Host System.
4. From the Category fields list, select Name.
5. From the Date fields list, select Free Space.
6. From the Aggregate function list, select Sum.
7. To sort data in the chart by free space, in the Sorting options section from the Sort by
list select Free space and from the Sort direction list select Descending.
8. In the Chart type section, select 3-D Column or 3-D Cylinder.

Page | 71
Veeam Reporter 4.0 | User Guide

Creating Clustered Column Charts


Clustered column charts can be helpful if you want to compare arrangements of data, being as
a single unit or structural element, across categories. Clustered column charts display data in
two dimensions. Categories are organized along the horizontal axis; data fields are grouped by
categories and organized along the vertical axis.

Example
Let’s create a chart displaying the number of VMs with thin-provisioned thick-provisioned
virtual disks on shared storage.

In this chart, we will visualize data from the following simple report created on the basis of the
Infrastructure Report template with the following report settings:
 Object type: Virtual Machine
 Report columns: Name, Virtual Disk is Thin-Provisioned, Storage

To create a clustered column chart:


1. Drag the report to the Dashboard cell. The New Dashboard Widget window will be
displayed.
2. Select the Create new widget from the following datasource option and choose
Table 1 from the list below.
3. In the Data selection section, from the Series fields list select Storage.
4. From the Category fields list, select Virtual Disk is Thin Provisioned.
5. From the Date fields list, select Name.
6. From the Aggregate function list, select Count.
7. In the Chart type section, select Clustered Column.

Page | 72
Veeam Reporter 4.0 | User Guide

Creating Exploded Pie Charts


Exploded pie charts can be helpful if you want to show the size of values proportional to the
sum of all values.
Using pie charts, you can present only one data series. Data categories are constituted from
data fields and represent parts of the whole pie.

Example
Let’s create a chart displaying the number of different OS’es installed on VMs.

In this chart, we will visualize data from the following simple report created on the basis of the
Infrastructure Report template with the following report settings:
 Object type: Virtual Machine
 Report columns: Name, Guest OS

To create an exploded pie chart:


1. Drag the report to the Dashboard cell. The New Dashboard Widget window will be
displayed.
2. Select the Create new widget from the following datasource option and choose
Table 1 from the list below.
3. As the pie chart displays only one data series, skip the Series fields list.
4. From the Category fields list, select Guest OS.
5. From the Date fields list, select Name.
6. From the Aggregate Function list, select Count.
7. In the Chart type section, select Exploded Pie.

Page | 73
Veeam Reporter 4.0 | User Guide

Creating Stacked Columns Charts


Stacked column charts can be helpful if you want to present several data series and need to
emphasize their contribution to the whole.
Stacked column charts show relation of data series to the whole. In stacked columns, data
series are presented as parts of the column, data categories (columns) are organized across
the horizontal axis and values are organized across the vertical axis.

Example
Let’s create a chart displaying the total amount of free space on all storages.

In this chart, we will visualize data from the following simple report created on the basis of the
Infrastructure Report template with the following report settings:
 Object type: Storage
 Report columns: Name, Free Space

To create a stacked column chart:


1. Drag the report to the Dashboard cell. The New Dashboard Widget window will be
displayed.
2. Select Create new widget from the following datasource option and choose Table 1
from the list below.
3. From the Series fields list, select Name.
4. As we want to see the total amount of free storage space, skip the Category fields list.
5. From the Date fields list, select Free Space.
6. From the Aggregate Function list, select Sum.
7. To sort the data in the chart by free space, in the Sorting options section from the Sort
by list select Free space and from the Sort direction list select Descending.
8. In the Chart type section, select Stacked Column.

Page | 74
Veeam Reporter 4.0 | User Guide

VEEAM REPORT VIEWER


To generate Offline reports, Veeam Reporter 4.0 exports VI data to files of Veeam’s proprietary
format — .vmr. When the .vmr report file is opened, Veeam Report Viewer is launched. It is a
free tool that processes data collected into the .vmr file and creates reports in Microsoft Excel,
Microsoft Visio, Microsoft Word and Adobe PDF formats.

Installing Veeam Report Viewer


This section will guide you through the installation process of Veeam Report Viewer.

Step 1. Run Veeam Report Viewer Setup


Click the Download Veeam Report Viewer link in the Workspace of Veeam Reporter 4.0. The
download link becomes available when you select Offline report pack from the list of report
packs in the Workspace. Wait for the Welcome screen to appear and click Next.

Step 2. Accept License Agreement


Read through the License Agreement and accept it to continue. If you select I do not agree,
you will not be able to proceed with the installation.

Page | 75
Veeam Reporter 4.0 | User Guide

Step 3. Specify Destination Folder


Specify the destination folder where you wish to install Veeam Report Viewer. To change the
default path, click Change and select the necessary folder. Click Next to continue.

Step 4. Begin Installation


Click Install to begin the installation.

Step 5. Finish Installation


Click Close when the installation is finished to close the setup wizard.

Page | 76
Veeam Reporter 4.0 | User Guide

Working with Veeam Report Viewer


You can trace the progress of the Microsoft Word, Microsoft Excel, Microsoft Visio and Adobe
PDF files generation. To display the Veeam Report Viewer window, click the Veeam Report
Viewer icon in the system tray:

The Veeam Report Viewer window displays detailed information on the generation process:
task status, progress, detailed description, type of a created report, file name and path, date
and time of report creation.
Using the Veeam Report Viewer window, you can cancel a running task at any moment of time
and view details of the generation process: select a task in the list and click the Cancel or
Details button on the toolbar or right-click a task and select a necessary command from the
shortcut menu.

Page | 77
Veeam Reporter 4.0 | User Guide

Customizing Reports Options


To customize general options for generated reports and specify the main Veeam Report
Viewer tool preferences, select the Options… command from the Tools menu.
On the General tab, specify main tool settings:
 Select the Minimize to tray on closing check box if necessary.
 In the Default report caption field, enter the caption that should label created reports.
 From the Prefix format list, select the format in which the date should be presented in
generated reports.
 In the Business View category attributes section, select to which columns in the Raw
Data Analysis report business values assigned to VMs should be written. To learn more,
see the Re-Organizing Raw Data Analysis Reports section.
On the Visio tab, specify main settings for Visio reports:
 Select the Show callouts in Visio check box to display callouts next to VI objects in
generated reports. A callout is an annotation text box in a diagram page that describes
object properties. Printing out reports with callouts included makes the reports more
informative and detailed.
 In the Page size section, select a necessary size of pages for generated reports.
 Select the Show local storages check box if you want to include local storage objects
in generated reports.
 In the Object limit section, select the maximum number of objects that should be
displayed on a report page. To learn more, see the Granulating Visio Reports section.

Page | 78
Veeam Reporter 4.0 | User Guide

POWERSHELL SNAP-IN
Veeam Reporter 4.0 comes with PowerShell snap-in — a snap-in to Microsoft Windows
PowerShell. The PowerShell snap-in represents an integration module that can be installed on
the client console, proving access to the VeeamReporter database and enabling the user to
perform administrative tasks by running single cmdlets or custom automation scripts via the
command-line interface.
Veeam Reporter PowerShell snap-in requires Windows PowerShell that is included into the
Veeam Reporter setup. If you are installing Veeam Reporter 4.0 on OS’es with Windows
PowerShell pre-installed (for example, Windows 2008) and it is disabled, the setup will display
a warning message requesting to enable Windows PowerShell.
PowerShell snap-in includes the following cmdlets. To learn more about a specific cmdlet and
its members (if any), click the corresponding link below.
 Connect-VRVIServer
 Disconnect-VRVIServer
 Get-VRVM
 Get-VRVMHost
 Get-VRDatastore
 Get-VRResourcePool
 Get-VRCluster
 Get-VRSnapshot
 Get-VRCurrentDate
 Set-VRCurrentDate

Important! If you receive the following message: «There were errors in loading the format data file», run
the Set-ExecutionPolicy RemoteSigned command.

Connect-VRVIServer
This cmdlet allows you to connect to the VeeamReporter database and start a new working
session.

Syntax
Connect-VRVIServer [-SQLInstance <String[]>] [-SQLDatabase <String[]>] [-User <String>] [-
Password <String>] [-Session <String>] [<CommonParameters>]

Parameters

Parameter Description Required Pipeline


Input
SQLInstance Specifies the name of the SQL Server True False
Instance in the HOSTNAME\INSTANCE
format (for example,
localhost\VeeamSQLServer).
SQLDatabase Specifies the name of the Veeam False True
Reporter database (for example, (ByValue)
VeeamReporter).
User Specifies a user name for authenticating False True
with the database. (ByValue)

Page | 79
Veeam Reporter 4.0 | User Guide

Password Specifies a password for authenticating False True


with the database.
Session Specifies the session ID to use when re- False True
establishing an already started session.

Return Value
This cmdlet returns the object of the connected database.

Example of Use
The following example allows you to connect to the VeeamReporter database on the
VeeamSQLServer.

Connect-VRVIServer 'localhost\veeamsqlserver' 'veeamreporter'

Disconnect-VRVIServer
This cmdlet allows you to disconnect from Veeam Reporter database and finish the current
working session.

Syntax
Disconnect-VRVIServer [[-Server] <VIServer[]>]

Parameters

Parameter Description Required Pipeline


Input
Server Specifies the server to disconnect from. If False True
this parameter is not specified, all active (ByValue)
connections are closed.

Example of Use
The following example allows you to disconnect from the VeeamReporter database on the
VeeamSQLServer.

Get-VRCurrentDate$connection =Connect-VRVIServer 'localhost\veeamsqlserver'


'Veeamreporter'
Disconnect-VRVIServer $connection

Get-VRVM
This cmdlet allows you to get one or more virtual machine from the VMware Infrastructure
server by the specified parameters.

Syntax
Get-VRVM [-Server <VIServer[]>] [-Datastore <Datastore[]>] [-Location <VIContainer[]>] [[-
Name] <String[]>] [-Id <String[]>] [-NoRecursion] [<CommonParameters>]

Page | 80
Veeam Reporter 4.0 | User Guide

Parameters

Parameter Description Required Pipeline


Input
Server One or more virtual Infrastructure servers False False
to apply the command on. If no value is
given to this parameter, the command
takes the server currently specified in the
$DefaultVIServer variable.
Datastore Gets the virtual machines associated with False False
one or more of the specified datastores.
Location Specifies one or more virtual False True
infrastructure container objects (e.g. (ByValue)
folders, datacenters, clusters) to search for
virtual machines.
Name Specifies one or more names of virtual False False
machine names to get. Use commas to
separate multiple names. Using wildcards
is supported.
Id Specifies one or more virtual machines by False False
ID. Use commas to separate multiple IDs.
NoRecursion Get-VRVM searches recursively from any False False
provided starting point. Setting this
parameter disables the command
recursive behavior.

Return Value
This cmdlet returns a specific VM object or an array of VM objects from the VMware
Infrastructure server by the specified parameters.

Members

Property Description Return Type


CDDrives Returns a list of CD drives for the current VM. CD drives
object(s)
CustomFields Returns a collection of custom attributes for Custom fields
the current VM. object(s)
Description Returns a description of the current VM. String
FloppyDrives Returns a list of floppy drives for the current Floppy drives
VM. object(s)
Guest Returns the guest OS for the current VM. Guest OS
object
HardDisk Returns a list of hard disks for the current VM. Hard disk
object(s)
Host Returns a host on which the current VM is Host object
running.
HostId Returns an ID of the host on which the String
current VM is running.
Id Returns an Id of the current VM. String
MemoryMB Returns the memory size of the current VM. Int32
Name Returns the name of the current VM. String
NetworkAdapters Returns a list of network adapters for the Network

Page | 81
Veeam Reporter 4.0 | User Guide

current VM. adapter


object(s)
NumCPU Returns the number of CPU for the current Int32
VM.
PowerState Returns a power state of the current VM – Power state
PoweredOff, Suspended or PoweredOn. object(s)

Example of Use
The following example retrieves a list of virtual machines, sorts them by size of virtual disks in
the descending order, and saves the result as a .txt file.

$SQLInstance = 'localhost\veeamsqlserver'
$SQLDBName = ‘Veeamreporter'
$server = Connect-VRVIServer $SQLInstance $SQLDBName

# Get all Virtual Machines


$vms = Get-VRVM
$customObjects = @()

# Fill Objects
ForEach ($vm in $vms)
{
$customObj = "" | select-Object Name, CapacityMB
$customObj.Name = $vm.Name

# fill disk capacity


$customObj.CapacityMB = 0
ForEach ($hardDisk in $vm.HardDisks)
{
$customObj.CapacityMB += [math]::round(($hardDisk.CapacityKB/1024),
0)
}
$customObjects += $customObj
}
# disconnect from server
Disconnect-VRVIServer -Server $server -Confirm:$False
# sort objects
$customObjects = $customObjects | sort-object -property CapacityMB -descending
$customObjects >> vmSortedByCapacity.txt

Get-VRVMHost
This cmdlet allows you get one or more VM server hosts from a VMware Infrastructure server
by the specified parameters.

Syntax
Get-VRVMHost [-Server <VIServer[]>] [-Datastore <Datastore[]>] [-State <VMHostState[]>] [-
Location <VIContainer[]>] [[-Name] <String[]>] [-Id <String[]>] [-NoRecursion]
[<CommonParameters>] [-VM <VirtualMachine[]>] [-ResourcePool <ResourcePool[]>]

Page | 82
Veeam Reporter 4.0 | User Guide

Parameter Description Required Pipeline


Input
Server Specifies the VMware Infrastructure False False
server to apply the command on. If no
value is given to this parameter, the
command takes the server currently
specified in the $DefaultVIServer
variable.
Datastore If set, the command retrieves the virtual False False
machine hosts associated with one or
more of the specified datastores.
State Specifies the state of the virtual machine False False
hosts to be returned by the Get-
VRVMHost command. It must be one of
the following: Connected, Disconnected,
NotResponding, Maintenance.
Location Specifies one or more virtual False True
infrastructure container objects (e.g. (ByValue)
folders, datacenters, clusters) to search
for virtual machine hosts.
Name Specifies one or more names of virtual False False
machine hosts to get. Use commas to
separate multiple names. Using
wildcards is supported.
Id Specifies one or more virtual machine False False
hosts by Id. To specify multiple IDs, use
commas to separate the IDs.
NoRecursion Get-VRVMHost searches recursively from False False
any provided starting point. Setting this
parameter disables the command
recursive behavior.
VM Specifies one or more virtual machines False True
running on the virtual machine hosts (ByValue)
retrieved by the command.
ResourcePool Specifies one or more resource pools False True
associated with the standalone virtual (ByValue)
machine hosts retrieved by the
command.

Return Value
This cmdlet returns a specific VM server host or an array of hosts from the VMware
Infrastructure server by the specified parameters.

Members

Property Description Return Type


CustomFields Returns a collection of custom attributes for the Custom fields
current host. object(s)
Id Returns an ID of the current host. String
Name Returns the name of the current host. String
State Returns a power state of the current host – Power state
Connected, Disconnected, NotResponding, object(s)
Maintenance.

Page | 83
Veeam Reporter 4.0 | User Guide

Example of Use
The following example retrieves a list of all VM servers in the Connected state.

Get-VRVMHost –State Connected

Get-VRDatastore
This cmdlet allows you get one or more datastores from a VMware Infrastructure server by the
specified parameters.

Syntax
Get-VRDatastore [-Server <VIServer[]>] [[-Name] <String[]>] [<CommonParameters>] [-
Datacenter <Datacenter[]>] [-VMHost <VMHost[]>] [-VM <VirtualMachine[]>] [-Entity
<VIObject[]>] [<CommonParameters>]

Parameter Description Required Pipeline


Input
Server Specifies the VMware Infrastructure server False False
to apply the command on. If no value is
given to this parameter, the command
takes the server currently specified in the
$DefaultVIServer variable.
Name Specifies one or more datastores names to False False
search for. Use commas to separate
multiple names. Using wildcards is
supported.
Datacenter If set, the command retrieves the datastores False True
associated with the specified datacenters. (ByValue)
Use commas to separate multiple
datacenters names. Using wildcards is
supported.
VMHost If set, the command retrieves the datastores False True
used by one or more of the specified virtual (ByValue)
machine hosts. Use commas to separate
multiple hosts names. Using wildcards is
supported.
VM If set, the command retrieves the datastores False True
used by one or more of the specified virtual (ByValue)
machines. Use commas to separate
multiple virtual machines. Using wildcards
is supported.
Entity This parameter serves as a generic False False
equivalent to the Datacenter, VM and
VMHost parameters. This means you can
pass simultaneously a collection containing
datacenters, virtual machines and virtual
machine hosts instead of passing them
separately through the respective
parameters.

Return Value
This cmdlet returns a specific datastore or an array of datastores from the VMware
Infrastructure server by the specified parameters.

Page | 84
Veeam Reporter 4.0 | User Guide

Members

Property Description Return Type

Accessible Checks if the current datastore is accessible or Boolean


not.
CapacityMB Returns the current datastore capacity (in MB). Int64
FreeSpaceMB Returns how much free space is available on the Int64
current datastore (in MB).
Id Returns an ID of the current datastore. String
Name Returns the name of the current datastore. String
Type Returns the type of the current datastore – NFS String
or VMFS.

Example of Use
The following example gets the datastore on which Test2 virtual machine resides.

$vm = Get-VRVM -Name Test2


Get-VRDatastore -VM $vm

Get-VRResourcePool
This cmdlet allows you get one or more resource pools from a VMware Infrastructure server by
the specified parameters.

Syntax
Get-VRResourcePool [-Server <VIServer[]>] [-VM <VirtualMachine[]>] [-Location
<VIContainer[]>] [[-Name] <String[]>] [-Id <String[]>] [-NoRecursion] [<CommonParameters>]

Parameter Description Required Pipeline


Input

Server Specifies the VMware Infrastructure server False False


to apply the command on. If no value is
given to this parameter, the command
takes the server currently specified in the
$DefaultVIServer variable.
VM If set, the command retrieves only the False True
resource pools containing one or more of (ByValue)
the specified virtual machines.
Location Specifies one or more virtual False True
infrastructure container objects (e.g. (ByValue)
folders, datacenters, clusters) within
which to search for resource pools.
Name Specifies one or more resource pool False False
names to search for. Use commas to
separate multiple names. Using wildcards
is supported.
Id Specifies one or more resource pools by False False
Id. Use commas to separate multiple Ids.
NoRecursion Get-VRResourcePool searches recursively False False
from any provided starting point. Setting
this parameter disables the command

Page | 85
Veeam Reporter 4.0 | User Guide

recursive behavior.

Return Value
This cmdlet returns a specific resource pool or an array of resource pools from the VMware
Infrastructure server by the specified parameters.

Members

Property Description Return


Type

CpuExpandableReservation Checks if the CPU expandable Boolean


reservation option is enabled for
the current resource pool.
CpuLimitMHz Returns the CPU limit set for the Int64
current resource pool.
CpuReservationMHz Returns the CPU reservation limit Int64
for the current resource pool.
CpuSharesLevel Returns the CPU shares level for the Level object
current resource pool (Low,
Normal, High or Custom).
CustomFields Returns a collection of custom Custom
attributes for the current resource fields
pool. object
Id Returns an ID of the current String
resource pool.
MemExpandableReservation Checks if the memory expandable Boolean
reservation option is enabled for
the current resource pool.
MemLimitMB Returns the memory limit set for Int64
the current resource pool.
MemReservationMB Returns the memory reservation Int64
limit for the current resource pool.
MemSharesLevel Returns the memory shares level Level object
for the current resource pool (Low,
Normal, High or Custom).
Name Returns the name of the current String
resource pool.
NumCpuShares Returns the number of CPU shares Int34
set for the current resource pool.
NumMemShares Returns the number of memory Int34
shares set for the current resource
pool.

Example of Use
The following example gets a list of all existing resource pools.

Get-VRResourcepool

Get-VRCluster
This cmdlet allows you get one or more clusters from a VMware Infrastructure server by the
specified parameters.

Page | 86
Veeam Reporter 4.0 | User Guide

Syntax
Get-VRCluster [-Server <VIServer[]>] [-VM <VirtualMachine[]>] [-VMHost <VMHost[]>] [-
Location <VIContainer[]>] [[-Name] <String[]>] [-Id <String[]>] [-NoRecursion]
[<CommonParameters>]

Parameter Description Required Pipeline


Input

Server Specifies the VMware Infrastructure server False False


to apply the command on. If no value is
given to this parameter, the command
takes the server currently specified in the
$DefaultVIServer variable.
VM If set, the command retrieves the clusters False True
containing one or more of the specified (ByValue)
virtual machines.
VMHost If set, the command retrieves the clusters False True
containing one or more of the specified (ByValue)
virtual machine hosts.
Location Specifies one or more virtual False True
infrastructure container objects (e.g. (ByValue)
folders, datacenters, clusters) to search for
clusters.
Name Specifies one or more cluster names to False False
search for. Use commas to separate
multiple names. Using wildcards is
supported.
Id Specifies one or more clusters by ID. Use False False
commas to separate multiple IDs.
NoRecursion The command searches recursively from False False
any provided starting point. Setting this
parameter disables the command
recursive behavior.

Return Value
This cmdlet returns a specific cluster or an array of clusters from the VMware Infrastructure
server by the specified parameters.

Members

Property Description Return Type


CustomFields Returns a collection of custom CustomFields
attributes for the current object(s)
cluster.
DrsEnabled Checks if DRS is enabled for the Boolean
current cluster.
DrsMode Returns the DRS mode set for DrsMode
the current cluster. object(s)
HAAdmissionControlEnabled Checks if HA admission control Boolean
is enabled for the current
cluster.
HAEnabled Checks if HA is enabled for the Boolean
current cluster.
HAFailoverLevel Returns the HA failover level set Int32

Page | 87
Veeam Reporter 4.0 | User Guide

for the current cluster.


Id Returns an ID of the current String
cluster.
Name Returns name of the current String
cluster.

Example of Use
The following example retrieves a list of all clusters with the Manual DRS mode.

Get-VRCluster | where {$_.DrsMode –eq “Manual”}

Get-VRSnapshot
This cmdlet allows you get one or more VM snapshots from a VMware Infrastructure server.

Syntax
Get-VRSnapshot [[-Name] <String[]>] [[-VM] <VirtualMachine[]>] [-Server <VIServer[]>]
[<CommonParameters>]

Parameter Description Required Pipeline


Input

Name Specifies one or more snapshot names to False False


search for. Use commas to separate multiple
names. Using wildcards is supported.
VM Specifies one or more virtual machines to False True
get snapshots from. (ByValue)
Server Specifies the VMware Infrastructure server False False
to apply the command on. If no value is
given to this parameter, the command takes
the server currently specified in the
$DefaultVIServer variable.

Return Value
This cmdlet returns a specific snapshot or an array of snapshots.

Example of Use
The following example gets a snapshot of Test2 virtual machine.

$vm = Get-VRVM -Name Test2


Get-VRSnapshot -VM $vm

Get-VRCurrentDate
This cmdlet allows you to get the current date that is used as a point-in-time for retrieving
data from the Veeam Reporter database. By default, this date equals the time of the
PowerShell startup.

Syntax
Get-VRCurrentDate

Page | 88
Veeam Reporter 4.0 | User Guide

Return Value
This cmdlet returns the current date for data retrieving.

Example of Use
The following example gets the current date used for retrieving data from the Veeam Reporter
database.

Get-VRCurrentDate

Set-VRCurrentDate
This cmdlet allows you to set the current date that will be used as a point-in-time for retrieving
data from the Veeam Reporter database.

Syntax
Set-VRCurrentDate [[–Date] [<Date[]>]

Parameter Description Required Pipeline


Input

Date Specifies the date that will be used to retrieve False False
data from the Veeam Reporter database. The
date is provided in the format of the current
local settings, with or without specifying of
time value.

Return Value
This cmdlet returns the set date for data retrieving.

Example of Use
The following example gets a list of virtual machines added from March 22, 2009 till March 24,
2009.

Page | 89
Veeam Reporter 4.0 | User Guide

$DateFrom = '22.03.2009'
$DateTo = '24.03.2009'
$SQLInstance = 'localhost\veeamsqlserver'
$SQLDBName = 'Veeamreporter'
$server = Connect-VRVIServer $SQLInstance $SQLDBName

Set-VRCurrentDate –Date $DateFrom


$vms1 = Get-VRVM
Set-VRCurrentDate –Date $DateTo
$vms2 = Get-VRVM
Disconnect-VRVIServer -Server $server -Confirm:$False
$addedVms = @()
ForEach ($vm in $vms2){
$match = $vms1 | where {$_.Name -eq $vm.Name}
if ($match -eq $null){
$addedVms += $vm
}
}
Write-Host "Added Virtual Machines"
$addedVms

Page | 90