Get-XenVMPPProperty
\[Removed\] Gets a property of a VMPP object.
Syntax
Get-XenVMPPProperty [-VMPP] <VMPP>
-XenProperty {Uuid | NameLabel | NameDescription | IsPolicyEnabled | BackupType | BackupRetentionValue | BackupFrequency | BackupSchedule | IsBackupRunning | BackupLastRunTime | ArchiveTargetType | ArchiveTargetConfig | ArchiveFrequency | ArchiveSchedule | IsArchiveRunning | ArchiveLastRunTime | VMs | IsAlarmEnabled | AlarmConfig | RecentAlerts | Alerts}
[-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVMPPProperty [-Ref] <XenRef[VMPP]>
-XenProperty {Uuid | NameLabel | NameDescription | IsPolicyEnabled | BackupType | BackupRetentionValue | BackupFrequency | BackupSchedule | IsBackupRunning | BackupLastRunTime | ArchiveTargetType | ArchiveTargetConfig | ArchiveFrequency | ArchiveSchedule | IsArchiveRunning | ArchiveLastRunTime | VMs | IsAlarmEnabled | AlarmConfig | RecentAlerts | Alerts}
[-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Description
REMOVED. This class has been removed.
Gets a specified property of a VMPP object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VMPP. (Removed.)
NameLabel: Get the name/label field of the given VMPP. (Removed.)
NameDescription: Get the name/description field of the given VMPP. (Removed.)
IsPolicyEnabled: Get the is\_policy\_enabled field of the given VMPP. (Removed.)
BackupType: Get the backup\_type field of the given VMPP. (Removed.)
BackupRetentionValue: Get the backup\_retention\_value field of the given VMPP. (Removed.)
BackupFrequency: Get the backup\_frequency field of the given VMPP. (Removed.)
BackupSchedule: Get the backup\_schedule field of the given VMPP. (Removed.)
IsBackupRunning: Get the is\_backup\_running field of the given VMPP. (Removed.)
BackupLastRunTime: Get the backup\_last\_run\_time field of the given VMPP. (Removed.)
ArchiveTargetType: Get the archive\_target\_type field of the given VMPP. (Removed.)
ArchiveTargetConfig: Get the archive\_target\_config field of the given VMPP. (Removed.)
ArchiveFrequency: Get the archive\_frequency field of the given VMPP. (Removed.)
ArchiveSchedule: Get the archive\_schedule field of the given VMPP. (Removed.)
IsArchiveRunning: Get the is\_archive\_running field of the given VMPP. (Removed.)
ArchiveLastRunTime: Get the archive\_last\_run\_time field of the given VMPP. (Removed.)
VMs: Get the VMs field of the given VMPP. (Removed.)
IsAlarmEnabled: Get the is\_alarm\_enabled field of the given VMPP. (Removed.)
AlarmConfig: Get the alarm\_config field of the given VMPP. (Removed.)
RecentAlerts: Get the recent\_alerts field of the given VMPP. (Removed.)
Alerts: This call fetches a history of alerts for a given protection policy. (Removed.)
Parameters
-BestEffort
If set, the cmdlet continues processing further objects instead of throwing a terminating error when an operation fails for one object.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-HoursFromNow
how many hours in the past the oldest record to fetch is. Accepted when -XenProperty is Alerts.
| Attribute | Value |
|---|---|
| Type | long |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Ref
The VMPP object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[VMPP] |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
| Aliases | opaque_ref |
-SessionOpaqueRef
The session object on which to run the cmdlet. This overrides the default session and lets you target a specific open XenServer connection.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-VMPP
The VMPP object to operate on.
| Attribute | Value |
|---|---|
| Type | VMPP |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByValue) |
-XenProperty
Selects which property to use.
| Attribute | Value |
|---|---|
| Type | XenVMPPProperty |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | Uuid, NameLabel, NameDescription, IsPolicyEnabled, BackupType, BackupRetentionValue, BackupFrequency, BackupSchedule, IsBackupRunning, BackupLastRunTime, ArchiveTargetType, ArchiveTargetConfig, ArchiveFrequency, ArchiveSchedule, IsArchiveRunning, ArchiveLastRunTime, VMs, IsAlarmEnabled, AlarmConfig, RecentAlerts, Alerts |
Inputs
-
VMPP -
XenRef[VMPP]
Outputs
-
System.Object
Examples
Example 1: Get the IsPolicyEnabled property
PS> Get-XenVMPP -Name "Demo VMPP" | Get-XenVMPPProperty -XenProperty IsPolicyEnabled
Gets the IsPolicyEnabled property of a VMPP.
Example 2: Get the BackupType property
PS> Get-XenVMPP -Name "Demo VMPP" | Get-XenVMPPProperty -XenProperty BackupType
Gets the BackupType property of a VMPP.
Example 3: Get the BackupRetentionValue property
PS> Get-XenVMPP -Name "Demo VMPP" | Get-XenVMPPProperty -XenProperty BackupRetentionValue
Gets the BackupRetentionValue property of a VMPP.
Related links
-
Class: VMPP
-
Using the XenServer PowerShell module