New-XenPVSProxy

Last published : Nov 12, 2026
Creates a new PVSProxy object.
Related information
PVSProxy cmdlets

Syntax

New-XenPVSProxy -HashTable <hashtable> [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenPVSProxy -Record <PVS_proxy> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenPVSProxy [-PassThru] [-Site <XenRef[PVS_site]>] [-VIF <XenRef[VIF]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]

Description

Creates a new PVSProxy object.
PVS\_proxy.create: Configure a VM/VIF to use a PVS proxy.
PVSProxy: A proxy connects a VM/VIF with a PVS site.

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

-HashTable

A hashtable of field names to values, from which to create the PVSProxy.
Attribute Value
Type hashtable
Required True
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

-Record

An existing PVSProxy record whose fields are used to create the new object.
Attribute Value
Type PVS_proxy
Required True
Position Named
Accepts pipeline input False

-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 that we proxy for
Attribute Value
Type XenRef[PVS_site]
Required False
Position Named
Accepts pipeline input False

-VIF

VIF for the VM that needs to be proxied
Attribute Value
Type XenRef[VIF]
Required False
Position Named
Accepts pipeline input False

-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

  • None

Outputs

  • PVS_proxy
  • Task
  • void

Examples

Example 1: Create a PVSProxy

PS> $pvs_site = Get-XenPVSSite | Select-Object -First 1
PS> $vif = Get-XenVIF | Select-Object -First 1
PS> New-XenPVSProxy -Site $pvs_site -VIF $vif -PassThru
New-XenPVSProxy takes the arguments of the create call rather than a record of fields, and needs all of them. -PassThru returns the new PVSProxy.

Example 2: Create a PVSProxy and wait for the task

PS> $pvs_site = Get-XenPVSSite | Select-Object -First 1
PS> $vif = Get-XenVIF | Select-Object -First 1
PS> New-XenPVSProxy -Site $pvs_site -VIF $vif -Async -PassThru |
    Wait-XenTask -ShowProgress
-Async hands the work to the server and returns the Task that represents it, which pipes into Wait-XenTask.

Example 3: See what would be created

PS> $pvs_site = Get-XenPVSSite | Select-Object -First 1
PS> $vif = Get-XenVIF | Select-Object -First 1
PS> New-XenPVSProxy -Site $pvs_site -VIF $vif -WhatIf
Reports what would be created without creating it. Every cmdlet that changes the server takes -WhatIf and -Confirm.