Set-XenVMPP

Last published : Nov 12, 2026
\[Removed\] Sets fields of a VMPP object.
Related information
VMPP cmdlets

Syntax

Set-XenVMPP [-VMPP] <VMPP> [-PassThru] [-NameLabel <string>] [-NameDescription <string>]
    [-IsPolicyEnabled <bool>] [-BackupType {snapshot | checkpoint | unknown}]
    [-BackupRetentionValue <long>] [-BackupFrequency {hourly | daily | weekly | unknown}]
    [-BackupSchedule <hashtable>]
    [-ArchiveFrequency {never | always_after_backup | daily | weekly | unknown}]
    [-ArchiveSchedule <hashtable>] [-ArchiveTargetType {none | cifs | nfs | unknown}]
    [-ArchiveTargetConfig <hashtable>] [-IsAlarmEnabled <bool>] [-AlarmConfig <hashtable>]
    [-BackupLastRunTime <DateTime>] [-ArchiveLastRunTime <DateTime>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenVMPP [-Ref] <XenRef[VMPP]> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-IsPolicyEnabled <bool>]
    [-BackupType {snapshot | checkpoint | unknown}] [-BackupRetentionValue <long>]
    [-BackupFrequency {hourly | daily | weekly | unknown}] [-BackupSchedule <hashtable>]
    [-ArchiveFrequency {never | always_after_backup | daily | weekly | unknown}]
    [-ArchiveSchedule <hashtable>] [-ArchiveTargetType {none | cifs | nfs | unknown}]
    [-ArchiveTargetConfig <hashtable>] [-IsAlarmEnabled <bool>] [-AlarmConfig <hashtable>]
    [-BackupLastRunTime <DateTime>] [-ArchiveLastRunTime <DateTime>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenVMPP [-Uuid] <guid> [-PassThru] [-NameLabel <string>] [-NameDescription <string>]
    [-IsPolicyEnabled <bool>] [-BackupType {snapshot | checkpoint | unknown}]
    [-BackupRetentionValue <long>] [-BackupFrequency {hourly | daily | weekly | unknown}]
    [-BackupSchedule <hashtable>]
    [-ArchiveFrequency {never | always_after_backup | daily | weekly | unknown}]
    [-ArchiveSchedule <hashtable>] [-ArchiveTargetType {none | cifs | nfs | unknown}]
    [-ArchiveTargetConfig <hashtable>] [-IsAlarmEnabled <bool>] [-AlarmConfig <hashtable>]
    [-BackupLastRunTime <DateTime>] [-ArchiveLastRunTime <DateTime>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenVMPP [-Name] <string> [-PassThru] [-NameLabel <string>] [-NameDescription <string>]
    [-IsPolicyEnabled <bool>] [-BackupType {snapshot | checkpoint | unknown}]
    [-BackupRetentionValue <long>] [-BackupFrequency {hourly | daily | weekly | unknown}]
    [-BackupSchedule <hashtable>]
    [-ArchiveFrequency {never | always_after_backup | daily | weekly | unknown}]
    [-ArchiveSchedule <hashtable>] [-ArchiveTargetType {none | cifs | nfs | unknown}]
    [-ArchiveTargetConfig <hashtable>] [-IsAlarmEnabled <bool>] [-AlarmConfig <hashtable>]
    [-BackupLastRunTime <DateTime>] [-ArchiveLastRunTime <DateTime>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

REMOVED. This class has been removed.
Changes writable fields of a VMPP. Each optional parameter listed below corresponds to a field that can be set.

Parameters

-AlarmConfig

This parameter has no documentation.
Attribute Value
Type hashtable
Required False
Position Named
Accepts pipeline input False

-ArchiveFrequency

Set the value of the archive\_frequency field
Attribute Value
Type vmpp_archive_frequency
Required False
Position Named
Accepts pipeline input False
Accepted values never, always_after_backup, daily, weekly, unknown

-ArchiveLastRunTime

This parameter has no documentation.
Attribute Value
Type DateTime
Required False
Position Named
Accepts pipeline input False

-ArchiveSchedule

This parameter has no documentation.
Attribute Value
Type hashtable
Required False
Position Named
Accepts pipeline input False

-ArchiveTargetConfig

This parameter has no documentation.
Attribute Value
Type hashtable
Required False
Position Named
Accepts pipeline input False

-ArchiveTargetType

Set the value of the archive\_target\_config\_type field
Attribute Value
Type vmpp_archive_target_type
Required False
Position Named
Accepts pipeline input False
Accepted values none, cifs, nfs, unknown

-BackupFrequency

Set the value of the backup\_frequency field
Attribute Value
Type vmpp_backup_frequency
Required False
Position Named
Accepts pipeline input False
Accepted values hourly, daily, weekly, unknown

-BackupLastRunTime

This parameter has no documentation.
Attribute Value
Type DateTime
Required False
Position Named
Accepts pipeline input False

-BackupRetentionValue

This parameter has no documentation.
Attribute Value
Type long
Required False
Position Named
Accepts pipeline input False

-BackupSchedule

This parameter has no documentation.
Attribute Value
Type hashtable
Required False
Position Named
Accepts pipeline input False

-BackupType

Set the backup\_type field of the given VMPP.
Attribute Value
Type vmpp_backup_type
Required False
Position Named
Accepts pipeline input False
Accepted values snapshot, checkpoint, unknown

-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

-Confirm

Prompts for confirmation before running the cmdlet.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases cf

-IsAlarmEnabled

Set the value of the is\_alarm\_enabled field
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-IsPolicyEnabled

Set the is\_policy\_enabled field of the given VMPP.
Attribute Value
Type bool
Required False
Position Named
Accepts pipeline input False

-Name

The name of the VMPP to operate on.
Attribute Value
Type string
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases name_label

-NameDescription

Set the name/description field of the given VMPP.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-NameLabel

Set the name/label field of the given VMPP.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-PassThru

If set, the cmdlet returns the affected object. By default the cmdlet does not generate any output.
Attribute Value
Type SwitchParameter
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

-Uuid

The UUID of the VMPP to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

-VMPP

The VMPP object to operate on.
Attribute Value
Type VMPP
Required True
Position 0
Accepts pipeline input True (ByValue)

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases wi

Inputs

  • VMPP
  • XenRef[VMPP]
  • guid
  • string

Outputs

  • VMPP
  • void

Examples

Example 1: Set the NameLabel field

PS> Get-XenVMPP -Name "Demo VMPP" | Set-XenVMPP -NameLabel "new value"
Sets the NameLabel field of a VMPP.

Example 2: Set the NameDescription field

PS> Get-XenVMPP -Name "Demo VMPP" | Set-XenVMPP -NameDescription "new value"
Sets the NameDescription field of a VMPP.

Example 3: Set the IsPolicyEnabled field

PS> Get-XenVMPP -Name "Demo VMPP" | Set-XenVMPP -IsPolicyEnabled $true
Sets the IsPolicyEnabled field of a VMPP.
  • VMPP cmdlets
  • Class: VMPP
  • Using the XenServer PowerShell module