Help Center
Choose product document...
Veeam ONE 9.5
Business View User Guide

Object Properties

To create expressions for dynamic groups, you can use properties of the following types of objects.

Host System

The following properties of host systems are supported in grouping expressions.

Property

Return Data Type

Description

CustomAttribute

 

Text (string)

Returns a value of a custom attribute assigned to a host.

Specify the name of a custom attribute in brackets. For example, CustomAttribute("department") will return the value of the 'department' attribute for a host.

Notes:

  • This property is available for VMware vSphere hosts only.
  • You cannot use methods to define the custom attribute name. However, the CustomAttribute property can be used to define values in methods.

Tag

Text (string)

Returns a tag assigned to a host.

Specify the name of a tag category in brackets. For example, Tag("department") will return the tag of the 'department' category for a host.

Note: This property is available for VMware vSphere 5.5 or later.

Name

Text (string)

Returns the host name.

Memory

Numeric
(double precision floating-point number)

Returns the amount of host physical memory, in GB.

Geolocation

Text (string)

Returns the location assigned to a host in Veeam Backup & Replication.

Note: This property is available starting from Veeam ONE 9.5 Update 3.

ProcessorCores

Numeric (integer)

Returns the number of processor cores for a host.

CPUFrequency

Numeric
(double precision floating-point number)

Returns CPU frequency, in MHz.

VMCount

Numeric (integer)

Returns the number of VMs registered on a host.

HostModel

Text (string)

Returns the host model.

CPUSockets

Numeric (integer)

Returns the number of CPU sockets for a host.

Location

Text (string)

Returns the path to a host in the virtual infrastructure.

 

Storage

The following properties of storage systems are supported in grouping expressions.

Property

Return Data Type

Description

Name

Text (string)

Returns a storage object name.

Capacity

Numeric
(double precision floating-point number)

Returns storage capacity, in GB.

FileSystemType

Text (string)

Returns the type of storage file system, such as VMFS or NTFS.

FreeSpace

Numeric
(double precision floating-point number)

Returns the amount of free storage space, in GB.

 

VMCount

Numeric (integer)

Returns the number of VMs whose files reside on a storage object.

Type

Text (string)

Returns the storage type (Shared or Local).

Location

Text (string)

Returns the path to a storage object in the virtual infrastructure.

 

Virtual Machine

The following properties of VMs are supported in grouping expressions.

Property

Return Data Type

Description

CustomAttribute

Text (string)

Returns a value of a custom attribute assigned to a VM.

Specify the name of a custom attribute in brackets. For example, CustomAttribute("department") will return the value of the 'department' attribute for a VM.

Notes:

  • This property is available for VMware vSphere hosts only.
  • You cannot use methods to define the custom attribute name. However, the CustomAttribute property can be used to define values in methods.

Tag

Text (string)

Returns a tag assigned to a VM.

Specify the name of a tag category in brackets. For example, Tag("department") will return the tag of the 'department' category for a VM.

Note: This property is available for VMware vSphere 5.5 or later.

Name

Text (string)

Returns the VM name.

GuestOS

Text (string)

Returns the VM guest OS.

vCPU

Numeric (integer)

Returns the number of vCPUs configured for a VM.

Memory

Numeric
(double precision floating-point number)

Returns the amount of memory allocated to a VM.

VirtualDiskSize

Numeric
(double precision floating-point number)

Returns the amount space occupied by all VM disks.

PowerState

Text (string)

Returns the VM power state.

  • For VMware vSphere: poweredOn, poweredOff, suspended
  • For Microsoft Hyper-V: Powered off, Running, Saved

Geolocation

Text (string)

Returns the location assigned to a host in Veeam Backup & Replication.

Note: This property is available starting from Veeam ONE 9.5 Update 3.

Folder

Text (string)

Returns the name of a folder where VM files reside.

HasSnapshots

Text (string)

Returns a flag indicating whether a VM has snapshots/checkpoints or not (Yes, No).

SnapshotCreationTime

Date and time

Returns the date and time when a snapshot was created, in the mm/dd/yyyy hh:mm:ss format.

Note: If a VM has several snapshots, the property returns the creation date of the latest snapshot (for VMware vSphere) or the date of the current checkpoint (for Microsoft Hyper-V).

Datastore

Text (string)

Returns the name of a storage system (datastore) where VM files reside.

Note: If VM files reside on several datastores, the property returns the name of a datastore where the VM configuration file is located.

LastBackupDate

Date and time

Returns the date and time when the latest backup session was performed for a VM in Veeam Backup & Replication, in the mm/dd/yyyy hh:mm:ss format.

Note: The backup session is returned only if a restore point was created as a result of this session.

Location

Text (string)

Returns a path to a VM in the virtual infrastructure.

UserLocation

Text (string)

Returns a user path to a VM in the virtual infrastructure.

Note: This property is available for VMware vSphere only.

Network

Text (string)

Returns the network to which a VM is connected.

Note: If a VM is connected to several networks, the property will return a random network.

ReplicationJob

Text (string)

Returns the name of a replication job in which a VM is included in Veeam Backup & Replication.

Note: If a VM is included in several replication jobs, the property will return a random job.

 

Veeam Large Logo

Deployment Guide

Deployment for Large-Scale Environments

Monitor User Guide

Reporter User Guide

Business View User Guide

Multi-Tenant Monitoring and Reporting

Working with Alarms

Veeam Backup & Replication Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation