Object Properties

In this article

    To create grouping expressions, you can use properties of the following types of objects:

    Host

    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.

    Note:

    • 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.

    CustomProperty

    Text (string)

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

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

    Note: This property is available for Microsoft Hyper-V hosts only.

    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 a host name.

    Memory

    Numeric
    (double precision floating-point number)

    Returns an amount of host physical memory, in GB.

    Location

    Text (string)

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

    ProcessorCores

    Numeric (integer)

    Returns a number of processor cores for a host.

    CPUFrequency

    Numeric
    (double precision floating-point number)

    Returns a CPU frequency, in MHz.

    VMCount

    Numeric (integer)

    Returns a number of VMs registered on a host.

    Datacenter

    Text (string)

    Returns a name of a datacenter.

    HostModel

    Text (string)

    Returns a host model.

    Note: This property is available for VMware vSphere hosts only.

    CPUSockets

    Numeric (integer)

    Returns a number of CPU sockets for a host.

    InfrastructureLocation

    Text (string)

    Returns a path to a host in the virtual infrastructure.

    Connection_State

    Text (string)

    Returns a connection state of a host.

    PowerState

    Text (string)

    Returns a power state of a host.

     

    Storage

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

    Property

    Return Data Type

    Description

    CustomAttribute

    Text (string)

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

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

    Notes:

    • This property is available for VMware vSphere storage systems 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 storage.

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

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

    Name

    Text (string)

    Returns a storage object name.

    Capacity

    Numeric
    (double precision floating-point number)

    Returns storage capacity, in GB.

    FileSystemType

    Text (string)

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

    FreeSpace

    Numeric
    (double precision floating-point number)

    Returns an amount of free storage space, in GB.

    UsedSpace

    Numeric
    (double precision floating-point number)

    Returns an amount of used storage space, in GB.

    VMCount

    Numeric (integer)

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

    Type

    Text (string)

    Returns a storage type (Shared or Local).

    InfrastructureLocation

    Text (string)

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

    Datacenter

    Text (string)

    Returns a name of a datacenter.

    DatastoreCluster

    Text (string)

    Returns a name of a cluster where storage object resides.

    Note: This property is available for VMware vSphere storage objects only.

     

    Cluster

    The following properties of clusters are supported in grouping expressions.

    Property

    Return Data Type

    Description

    CustomAttribute

    Text (string)

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

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

    Notes:

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

    CustomProperty

    Text (string)

    Returns a value of a custom property assigned to a cluster.

    Specify the name of a custom property in brackets. For example, CustomProperty("department") will return the value of the 'department' property for a cluster.

    Note: This property is available for Microsoft Hyper-V clusters only.

    Tag

    Text (string)

    Returns a tag assigned to a cluster.

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

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

    Name

    Text (string)

    Returns a cluster name.

    CPUFrequency

    Numeric (integer)

    Returns cluster CPU frequency, in MHz.

    Connection_State

    Text (string)

    Returns a connection state of a cluster.

    Note: This property is available for Microsoft Hyper-V clusters only.

    Datacenter

    Text (string)

    Returns a name of a datacenter.

    HostCount

    Numeric (integer)

    Returns a number of hosts in a cluster.

    Memory

    Numeric (integer)

    Returns a memory size of a cluster, in MB.

    ProcessorCores

    Numeric (integer)

    Returns a sum of cores for all hosts in a cluster.

    VMCount

    Numeric (integer)

    Returns a number of VMs whose files reside in a cluster.

    InfrastructureLocation

    Text (string)

    Returns a path to a cluster in the virtual infrastructure.

    IsDRSEnabled

    Text (string)

    Returns a flag that indicates if distributed resource scheduler enabled in a cluster.

    Note: This property is available for VMware vSphere clusters only.

    Location

    Text (string)

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

    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 VMs only.
    • You cannot use methods to define the custom attribute name. However, the CustomAttribute property can be used to define values in methods.

    CustomProperty

    Text (string)

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

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

    Note: This property is available for Microsoft Hyper-V VMs only.

    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 a VM name.

    GuestOS

    Text (string)

    Returns a 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 a VM power state.

    • For VMware vSphere: Powered On, Powered Off, Suspended
    • For Microsoft Hyper-V: Powered Off, Running, Saved

    Location

    Text (string)

    Returns a location assigned to a VM in Veeam Backup & Replication.

    VMFolderPath

    Text (string)

    Returns a name of a folder where VM files reside.

    Note: This property is available for VMware vSphere VMs only.

    HasSnapshots

    Text (string)

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

    Note: This property is available for VMware vSphere VMs only.

    HasCheckpoints

    Text (string)

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

    Note: This property is available for Microsoft Hyper-V VMs only.

    SnapshotCreateTime

    Date and time

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

    Notes:

    • This property is available for VMware vSphere VMs only.
    • If a VM has several snapshots, the property returns the creation date of the latest snapshot.

    CheckpointCreateTime

    Date and time

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

    Notes:

    • This property is available for Microsoft Hyper-V VMs only.
    • If a VM has several checkpoints, the property returns the creation date of the current checkpoint.

    SnapshotAge

    Numeric (integer)

    Returns how many hours ago a snapshot was created.

    Note: This property is available for VMware vSphere VMs only.

    Datacenter

    Text (string)

    Returns a name of a datacenter.

    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.

    HasBackups

    Text (string)

    Returns a flag indicating whether a VM has backups or not (Yes, No).

    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.

    BackupRPO

    Numeric (integer)

    Returns the number of hours that passed since last backup session completed.

    ReplicationRPO

    Numeric (integer)

    Returns the number of hours that passed since last replication session completed.

    BackupJob

    Text (string)

    Returns a name of a backup job that protects a VM.

    InfrastructureLocation

    Text (string)

    Returns a path to a VM in the virtual infrastructure.

    VMFolderPath

    Text (string)

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

    Note: This property is available for VMware vSphere VMs 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 a 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.

    IpAddress

    Text (string)

    Returns an IP address assigned to a VM.

    ComputerName

    Text (string)

    Returns a domain name assigned to a VM.

    Connection_State

    Text (string)

    Returns a connection state of a VM.

    Datacenter

    Text (string)

    Returns a name of a datacenter where a VM resides.

    IsReplica

    Text (string)

    Returns a flag indicating whether a VM is a replica of an original VM.

    CPUFrequency

    Numeric
    (double precision floating-point number)

    Returns a frequency of a CPU in MHz.

    Note: This property is available for Microsoft Hyper-V VMs only.

    IsShielded

    Text (string)

    Returns a flag indicating whether a VM is shielded.

    Note: This property is available for Microsoft Hyper-V VMs only.

    Computer

    The following properties of protected computers are supported in grouping expressions.

    Property

    Return Data Type

    Description

    BackupServer

    Text (string)

    Returns a name of Veeam Backup & Replication server that manages the backup agent.

    LastBackupDate

    Date and time

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

    BackupRPO

    Numeric (integer)

    Returns a number of hours that passed since last backup session completed.

    BpAgentLicenseType

    Text (string)

    Returns a type of license installed on a backup agent.

    Location

    Text (string)

    Returns a location assigned to a computer in Veeam Backup & Replication.

    BpAgentManagementType

    Text (string)

    Returns a management type of a backup agent (Standalone, Managed by VBR).

    Name

    Text (string)

    Returns a name of a computer that runs a backup agent.

    ProtectedComputersGroup

    Text (string)

    Returns a name of a protection group for a computer.

    ClusterName

    Text (string)

    Returns a name of a failover cluster in which a computer resides.

    IpAddress

    Text (string)

    Returns an IP address assigned to a computer that runs a backup agent.

    FQDN

    Text (string)

    Returns an FQDN assigned to a computer that runs a backup agent.

    JobName

    Text (string)

    Returns a name of a job that runs on a backup agent.

    PolicyName

    Text (string)

    Returns a name of a backup policy assigned to a backup agent.

     

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.