Invoke-XenPGPU

Last published : Nov 12, 2026
Invokes an operation on a PGPU object.
Related information
PGPU cmdlets

Syntax

Invoke-XenPGPU [-PGPU] <PGPU> -XenAction {EnableDom0Access | DisableDom0Access}
    [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenPGPU [-Ref] <XenRef[PGPU]> -XenAction {EnableDom0Access | DisableDom0Access}
    [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenPGPU [-Uuid] <guid> -XenAction {EnableDom0Access | DisableDom0Access}
    [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]

Description

Invokes an operation on a PGPU object. Use the -XenAction parameter to select which operation to perform.
EnableDom0Access (Deprecated.)
DisableDom0Access (Deprecated.)

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress.
Attribute Value
Type SwitchParameter
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

-PGPU

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

-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 PGPU object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[PGPU]
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 PGPU to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

-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 XenPGPUAction
Required True
Position Named
Accepts pipeline input False
Accepted values EnableDom0Access, DisableDom0Access

Inputs

  • PGPU
  • XenRef[PGPU]
  • guid

Outputs

  • System.Object

Examples

Example 1: Run the EnableDom0Access operation

PS> Get-XenPGPU -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Invoke-XenPGPU -XenAction EnableDom0Access -PassThru
Invokes the EnableDom0Access operation on a PGPU. -PassThru writes the result to the pipeline.

Example 2: Run the EnableDom0Access operation by uuid

PS> Invoke-XenPGPU -XenAction EnableDom0Access -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff -PassThru
Invokes the EnableDom0Access operation on a PGPU. -Uuid is the way to be sure of exactly one object. -PassThru writes the result to the pipeline.

Example 3: Run EnableDom0Access asynchronously

PS> Invoke-XenPGPU -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff -XenAction EnableDom0Access -Async -PassThru | Wait-XenTask -ShowProgress
Runs the same operation asynchronously and follows the task it returns.
  • PGPU cmdlets
  • Class: PGPU
  • Using the XenServer PowerShell module