Invoke-XenPVSSite

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

Syntax

Invoke-XenPVSSite [-PVSSite] <PVS_site> -XenAction {Introduce | Forget} [-PassThru]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenPVSSite [-Ref] <XenRef[PVS_site]> -XenAction {Introduce | Forget} [-PassThru]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenPVSSite [-Uuid] <guid> -XenAction {Introduce | Forget} [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Invoke-XenPVSSite [-Name] <string> -XenAction {Introduce | Forget} [-PassThru]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]

Description

Invokes an operation on a PVSSite object. Use the -XenAction parameter to select which operation to perform.
Introduce: Introduce new PVS site.
Forget: Remove a site's meta data.

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

-Name

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

-NameDescription

description of the PVS site. Accepted when -XenAction is Introduce.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-NameLabel

name of the PVS site. Accepted when -XenAction is Introduce.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-PVSSite

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

-PVSUuid

unique identifier of the PVS site. Accepted when -XenAction is Introduce.
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 PVSSite object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[PVS_site]
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 PVSSite 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 XenPVSSiteAction
Required True
Position Named
Accepts pipeline input False
Accepted values Introduce, Forget

Inputs

  • PVS_site
  • XenRef[PVS_site]
  • guid
  • string

Outputs

  • System.Object

Examples

Example 1: Run the Introduce operation

PS> Get-XenPVSSite -Name "Demo PVSSite" | Invoke-XenPVSSite -XenAction Introduce -PassThru
Invokes the Introduce operation on a PVSSite. -PassThru writes the result to the pipeline.

Example 2: Run the Introduce operation by name

PS> Invoke-XenPVSSite -XenAction Introduce -Name "Demo PVSSite" -PassThru
Invokes the Introduce operation on a PVSSite. -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 Introduce asynchronously

PS> Invoke-XenPVSSite -Name "Demo PVSSite" -XenAction Introduce -Async -PassThru | Wait-XenTask -ShowProgress
Runs the same operation asynchronously and follows the task it returns.