Get-XenSRProperty

Last published : Nov 12, 2026
Gets a property of an SR object.

Syntax

Get-XenSRProperty [-SR] <SR>
    -XenProperty {Uuid | NameLabel | NameDescription | AllowedOperations | CurrentOperations | VDIs | PBDs | VirtualAllocation | PhysicalUtilisation | PhysicalSize | Type | ContentType | Shared | OtherConfig | Tags | SmConfig | Blobs | LocalCacheEnabled | IntroducedBy | Clustered | IsToolsSr | SupportedTypes | DataSources}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenSRProperty [-Ref] <XenRef[SR]>
    -XenProperty {Uuid | NameLabel | NameDescription | AllowedOperations | CurrentOperations | VDIs | PBDs | VirtualAllocation | PhysicalUtilisation | PhysicalSize | Type | ContentType | Shared | OtherConfig | Tags | SmConfig | Blobs | LocalCacheEnabled | IntroducedBy | Clustered | IsToolsSr | SupportedTypes | DataSources}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of an SR object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given SR.
NameLabel: Get the name/label field of the given SR.
NameDescription: Get the name/description field of the given SR.
AllowedOperations: Get the allowed\_operations field of the given SR.
CurrentOperations: Get the current\_operations field of the given SR.
VDIs: Get the VDIs field of the given SR.
PBDs: Get the PBDs field of the given SR.
VirtualAllocation: Get the virtual\_allocation field of the given SR.
PhysicalUtilisation: Get the physical\_utilisation field of the given SR.
PhysicalSize: Get the physical\_size field of the given SR.
Type: Get the type field of the given SR.
ContentType: Get the content\_type field of the given SR.
Shared: Get the shared field of the given SR.
OtherConfig: Get the other\_config field of the given SR.
Tags: Get the tags field of the given SR.
SmConfig: Get the sm\_config field of the given SR.
Blobs: Get the blobs field of the given SR.
LocalCacheEnabled: Get the local\_cache\_enabled field of the given SR.
IntroducedBy: Get the introduced\_by field of the given SR.
Clustered: Get the clustered field of the given SR.
IsToolsSr: Get the is\_tools\_sr field of the given SR.
SupportedTypes: Return a set of all the SR types supported by the system.
DataSources

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

-Ref

The SR object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[SR]
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases opaque_ref

-SR

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

-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 XenSRProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, AllowedOperations, CurrentOperations, VDIs, PBDs, VirtualAllocation, PhysicalUtilisation, PhysicalSize, Type, ContentType, Shared, OtherConfig, Tags, SmConfig, Blobs, LocalCacheEnabled, IntroducedBy, Clustered, IsToolsSr, SupportedTypes, DataSources

Inputs

  • SR
  • XenRef[SR]

Outputs

  • System.Object

Examples

Example 1: Get the AllowedOperations property

PS> Get-XenSR -Name "Demo SR" | Get-XenSRProperty -XenProperty AllowedOperations
Gets the AllowedOperations property of an SR.

Example 2: Get the CurrentOperations property

PS> Get-XenSR -Name "Demo SR" | Get-XenSRProperty -XenProperty CurrentOperations
Gets the CurrentOperations property of an SR.

Example 3: Get the VDIs property

PS> Get-XenSR -Name "Demo SR" | Get-XenSRProperty -XenProperty VDIs
Gets the VDIs property of an SR.
  • Class: SR
  • Using the XenServer PowerShell module