Get-XenPVSProxyProperty

Last published : Nov 12, 2026
Gets a property of a PVSProxy object.
Related information
PVSProxy cmdlets

Syntax

Get-XenPVSProxyProperty [-PVSProxy] <PVS_proxy>
    -XenProperty {Uuid | Site | VIF | CurrentlyAttached | Status} [-BestEffort]
    [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenPVSProxyProperty [-Ref] <XenRef[PVS_proxy]>
    -XenProperty {Uuid | Site | VIF | CurrentlyAttached | Status} [-BestEffort]
    [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a PVSProxy object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given PVS\_proxy.
Site: Get the site field of the given PVS\_proxy.
VIF: Get the VIF field of the given PVS\_proxy.
CurrentlyAttached: Get the currently\_attached field of the given PVS\_proxy.
Status: Get the status field of the given PVS\_proxy.

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

-PVSProxy

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

-Ref

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenPVSProxyProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, Site, VIF, CurrentlyAttached, Status

Inputs

  • PVS_proxy
  • XenRef[PVS_proxy]

Outputs

  • System.Object

Examples

Example 1: Get the Site property

PS> Get-XenPVSProxy -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPVSProxyProperty -XenProperty Site
Gets the Site property of a PVSProxy.

Example 2: Get the VIF property

PS> Get-XenPVSProxy -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPVSProxyProperty -XenProperty VIF
Gets the VIF property of a PVSProxy.

Example 3: Get the CurrentlyAttached property

PS> Get-XenPVSProxy -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPVSProxyProperty -XenProperty CurrentlyAttached
Gets the CurrentlyAttached property of a PVSProxy.