Invoke-XenVMPP
\[Removed\] Invokes an operation on a VMPP object.
Syntax
Invoke-XenVMPP [-VMPP] <VMPP> -XenAction {ProtectNow | ArchiveNow} [-PassThru]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Invoke-XenVMPP [-Ref] <XenRef[VMPP]> -XenAction {ProtectNow | ArchiveNow} [-PassThru]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Invoke-XenVMPP [-Uuid] <guid> -XenAction {ProtectNow | ArchiveNow} [-PassThru]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Invoke-XenVMPP [-Name] <string> -XenAction {ProtectNow | ArchiveNow} [-PassThru]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Description
REMOVED. This class has been removed.
Invokes an operation on a VMPP object. Use the -XenAction parameter to select which operation to perform.
ProtectNow: This call executes the protection policy immediately. (Removed.)
ArchiveNow: This call archives the snapshot provided as a parameter. (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 |
-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 |
-Snapshot
The snapshot to archive. Accepted when -XenAction is ArchiveNow.
| Attribute | Value |
|---|---|
| Type | XenRef[VM] |
| 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 |
-XenAction
Selects which action to use.
| Attribute | Value |
|---|---|
| Type | XenVMPPAction |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | ProtectNow, ArchiveNow |
Inputs
-
VMPP -
XenRef[VMPP] -
guid -
string
Outputs
-
System.Object
Examples
Example 1: Run the ProtectNow operation
PS> Get-XenVMPP -Name "Demo VMPP" | Invoke-XenVMPP -XenAction ProtectNow -PassThru
Invokes the ProtectNow operation on a VMPP. -PassThru writes the result to the pipeline.
Example 2: Run the ProtectNow operation by name
PS> Invoke-XenVMPP -XenAction ProtectNow -Name "Demo VMPP" -PassThru
Invokes the ProtectNow operation on a VMPP. -Name matches on name\_label, which is not unique, so every match is operated on. -PassThru writes the result to the pipeline.
Example 3: Run the ProtectNow operation by uuid
PS> Invoke-XenVMPP -XenAction ProtectNow -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff -PassThru
Invokes the ProtectNow operation on a VMPP. -Uuid is the way to be sure of exactly one object. -PassThru writes the result to the pipeline.
Related links
-
Class: VMPP
-
Using the XenServer PowerShell module