Get-XenPVSSiteProperty

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

Syntax

Get-XenPVSSiteProperty [-PVSSite] <PVS_site>
    -XenProperty {Uuid | NameLabel | NameDescription | PVSUuid | CacheStorage | Servers | Proxies}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenPVSSiteProperty [-Ref] <XenRef[PVS_site]>
    -XenProperty {Uuid | NameLabel | NameDescription | PVSUuid | CacheStorage | Servers | Proxies}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a PVSSite object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given PVS\_site.
NameLabel: Get the name/label field of the given PVS\_site.
NameDescription: Get the name/description field of the given PVS\_site.
PVSUuid: Get the PVS\_uuid field of the given PVS\_site.
CacheStorage: Get the cache\_storage field of the given PVS\_site.
Servers: Get the servers field of the given PVS\_site.
Proxies: Get the proxies field of the given PVS\_site.

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

-PVSSite

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

-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

-XenProperty

Selects which property to use.
Attribute Value
Type XenPVSSiteProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, PVSUuid, CacheStorage, Servers, Proxies

Inputs

  • PVS_site
  • XenRef[PVS_site]

Outputs

  • System.Object

Examples

Example 1: Get the PVSUuid property

PS> Get-XenPVSSite -Name "Demo PVSSite" | Get-XenPVSSiteProperty -XenProperty PVSUuid
Gets the PVSUuid property of a PVSSite.

Example 2: Get the CacheStorage property

PS> Get-XenPVSSite -Name "Demo PVSSite" | Get-XenPVSSiteProperty -XenProperty CacheStorage
Gets the CacheStorage property of a PVSSite.

Example 3: Get the Servers property

PS> Get-XenPVSSite -Name "Demo PVSSite" | Get-XenPVSSiteProperty -XenProperty Servers
Gets the Servers property of a PVSSite.