Documentos de Académico
Documentos de Profesional
Documentos de Cultura
0
User Guide
August 2010
Veeam Reporter 4.0 | User Guide
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
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
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
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:
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
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.
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.
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
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).
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.
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.
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.
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
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.
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
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
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
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
Prerequisites
Veeam Reporter 4.0 uses the following firewall ports listed in the table below. Make sure these
ports are opened:
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
Page | 33
Veeam Reporter 4.0 | User Guide
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.
Page | 35
Veeam Reporter 4.0 | User Guide
Page | 36
Veeam Reporter 4.0 | User Guide
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
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
Page | 39
Veeam Reporter 4.0 | User Guide
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.
Page | 40
Veeam Reporter 4.0 | User Guide
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.
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.
Adding Jobs
To add a new collection job, click the New button in the toolbar and follow the Job wizard
steps.
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
Page | 45
Veeam Reporter 4.0 | User Guide
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.
Page | 46
Veeam Reporter 4.0 | User Guide
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
Page | 48
Veeam Reporter 4.0 | User Guide
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.
Page | 49
Veeam Reporter 4.0 | User Guide
Page | 50
Veeam Reporter 4.0 | User Guide
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.
Page | 51
Veeam Reporter 4.0 | User Guide
Page | 52
Veeam Reporter 4.0 | User Guide
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
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
Page | 55
Veeam Reporter 4.0 | User Guide
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
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.
Page | 57
Veeam Reporter 4.0 | User Guide
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.
After you have selected a necessary point in time, you can proceed to generating VI reports.
Page | 59
Veeam Reporter 4.0 | User Guide
Page | 60
Veeam Reporter 4.0 | User Guide
Page | 61
Veeam Reporter 4.0 | User Guide
Page | 62
Veeam Reporter 4.0 | User Guide
Page | 63
Veeam Reporter 4.0 | User Guide
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
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
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
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
Page | 69
Veeam Reporter 4.0 | User Guide
Page | 70
Veeam Reporter 4.0 | User Guide
Examples
This section provides simple examples of creating charts in dashboard widgets.
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
Page | 71
Veeam Reporter 4.0 | User Guide
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
Page | 72
Veeam Reporter 4.0 | User Guide
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
Page | 73
Veeam Reporter 4.0 | User Guide
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
Page | 74
Veeam Reporter 4.0 | User Guide
Page | 75
Veeam Reporter 4.0 | User Guide
Page | 76
Veeam Reporter 4.0 | User Guide
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
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
Page | 79
Veeam Reporter 4.0 | User Guide
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.
Disconnect-VRVIServer
This cmdlet allows you to disconnect from Veeam Reporter database and finish the current
working session.
Syntax
Disconnect-VRVIServer [[-Server] <VIServer[]>]
Parameters
Example of Use
The following example allows you to disconnect from the VeeamReporter database on the
VeeamSQLServer.
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
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
Page | 81
Veeam Reporter 4.0 | User Guide
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
# Fill Objects
ForEach ($vm in $vms)
{
$customObj = "" | select-Object Name, CapacityMB
$customObj.Name = $vm.Name
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
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
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-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>]
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
Example of Use
The following example gets the datastore on which Test2 virtual machine resides.
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>]
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
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>]
Return Value
This cmdlet returns a specific cluster or an array of clusters from the VMware Infrastructure
server by the specified parameters.
Members
Page | 87
Veeam Reporter 4.0 | User Guide
Example of Use
The following example retrieves a list of all clusters with the Manual DRS mode.
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>]
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.
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[]>]
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
Page | 90