Invoke-XenPVSServer

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

Syntax

Invoke-XenPVSServer [-PVSServer] <PVS_server> -XenAction {Introduce | Forget} [-PassThru]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenPVSServer [-Ref] <XenRef[PVS_server]> -XenAction {Introduce | Forget}
    [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenPVSServer [-Uuid] <guid> -XenAction {Introduce | Forget} [-PassThru]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]

Description

Invokes an operation on a PVSServer object. Use the -XenAction parameter to select which operation to perform.
Introduce: Introduce new PVS server.
Forget: Forget a PVS server.

Parameters

-Addresses

IPv4/IPv6 addresses of the server. Accepted when -XenAction is Introduce.
Attribute Value
Type string[]
Required False
Position Named
Accepts pipeline input False

-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

-FirstPort

first UDP port accepted by this server. Accepted when -XenAction is Introduce.
Attribute Value
Type long
Required False
Position Named
Accepts pipeline input False

-LastPort

last UDP port accepted by this server. Accepted when -XenAction is Introduce.
Attribute Value
Type long
Required False
Position Named
Accepts pipeline input False

-PVSServer

The PVSServer object to operate on.
Attribute Value
Type PVS_server
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 PVSServer object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[PVS_server]
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

-Site

PVS site this server is a part of. Accepted when -XenAction is Introduce.
Attribute Value
Type XenRef[PVS_site]
Required False
Position Named
Accepts pipeline input False

-Uuid

The UUID of the PVSServer 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 XenPVSServerAction
Required True
Position Named
Accepts pipeline input False
Accepted values Introduce, Forget

Inputs

  • PVS_server
  • XenRef[PVS_server]
  • guid

Outputs

  • System.Object

Examples

Example 1: Run the Introduce operation

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

Example 2: Run the Introduce operation by uuid

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

Example 3: Run Introduce asynchronously

PS> Invoke-XenPVSServer -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff -XenAction Introduce -Async -PassThru | Wait-XenTask -ShowProgress
Runs the same operation asynchronously and follows the task it returns.