Add-XenVMPP

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

Syntax

Add-XenVMPP [-VMPP] <VMPP> [-PassThru] [-BackupSchedule <KeyValuePair[string, string]>]
    [-ArchiveTargetConfig <KeyValuePair[string, string]>]
    [-ArchiveSchedule <KeyValuePair[string, string]>]
    [-AlarmConfig <KeyValuePair[string, string]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenVMPP [-Ref] <XenRef[VMPP]> [-PassThru]
    [-BackupSchedule <KeyValuePair[string, string]>]
    [-ArchiveTargetConfig <KeyValuePair[string, string]>]
    [-ArchiveSchedule <KeyValuePair[string, string]>]
    [-AlarmConfig <KeyValuePair[string, string]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenVMPP [-Uuid] <guid> [-PassThru] [-BackupSchedule <KeyValuePair[string, string]>]
    [-ArchiveTargetConfig <KeyValuePair[string, string]>]
    [-ArchiveSchedule <KeyValuePair[string, string]>]
    [-AlarmConfig <KeyValuePair[string, string]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenVMPP [-Name] <string> [-PassThru] [-BackupSchedule <KeyValuePair[string, string]>]
    [-ArchiveTargetConfig <KeyValuePair[string, string]>]
    [-ArchiveSchedule <KeyValuePair[string, string]>]
    [-AlarmConfig <KeyValuePair[string, string]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

REMOVED. This class has been removed.
Adds values to the collection-valued fields of a VMPP. Each optional parameter listed below corresponds to a field that can be added to.

Parameters

-AlarmConfig

This parameter has no documentation.
Attribute Value
Type KeyValuePair[string, string]
Required False
Position Named
Accepts pipeline input False

-ArchiveSchedule

This parameter has no documentation.
Attribute Value
Type KeyValuePair[string, string]
Required False
Position Named
Accepts pipeline input False

-ArchiveTargetConfig

This parameter has no documentation.
Attribute Value
Type KeyValuePair[string, string]
Required False
Position Named
Accepts pipeline input False

-BackupSchedule

This parameter has no documentation.
Attribute Value
Type KeyValuePair[string, string]
Required False
Position Named
Accepts pipeline input False

-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

-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

-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: Add a backupschedule

PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Add-XenVMPP -BackupSchedule $entry -Name "Demo VMPP"

Example 2: Add an archivetargetconfig

PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Add-XenVMPP -ArchiveTargetConfig $entry -Name "Demo VMPP"

Example 3: Add an archiveschedule

PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Add-XenVMPP -ArchiveSchedule $entry -Name "Demo VMPP"
  • VMPP cmdlets
  • Class: VMPP
  • Using the XenServer PowerShell module