Get-XenVDIProperty

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

Syntax

Get-XenVDIProperty [-VDI] <VDI>
    -XenProperty {Uuid | NameLabel | NameDescription | AllowedOperations | CurrentOperations | SR | VBDs | CrashDumps | VirtualSize | PhysicalUtilisation | Type | Sharable | ReadOnly | OtherConfig | StorageLock | Location | Managed | Missing | Parent | XenstoreData | SmConfig | IsASnapshot | SnapshotOf | Snapshots | SnapshotTime | Tags | AllowCaching | OnBoot | MetadataOfPool | MetadataLatest | IsToolsIso | CbtEnabled | NbdInfo}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVDIProperty [-Ref] <XenRef[VDI]>
    -XenProperty {Uuid | NameLabel | NameDescription | AllowedOperations | CurrentOperations | SR | VBDs | CrashDumps | VirtualSize | PhysicalUtilisation | Type | Sharable | ReadOnly | OtherConfig | StorageLock | Location | Managed | Missing | Parent | XenstoreData | SmConfig | IsASnapshot | SnapshotOf | Snapshots | SnapshotTime | Tags | AllowCaching | OnBoot | MetadataOfPool | MetadataLatest | IsToolsIso | CbtEnabled | NbdInfo}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a VDI object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VDI.
NameLabel: Get the name/label field of the given VDI.
NameDescription: Get the name/description field of the given VDI.
AllowedOperations: Get the allowed\_operations field of the given VDI.
CurrentOperations: Get the current\_operations field of the given VDI.
SR: Get the SR field of the given VDI.
VBDs: Get the VBDs field of the given VDI.
CrashDumps: Get the crash\_dumps field of the given VDI.
VirtualSize: Get the virtual\_size field of the given VDI.
PhysicalUtilisation: Get the physical\_utilisation field of the given VDI.
Type: Get the type field of the given VDI.
Sharable: Get the sharable field of the given VDI.
ReadOnly: Get the read\_only field of the given VDI.
OtherConfig: Get the other\_config field of the given VDI.
StorageLock: Get the storage\_lock field of the given VDI.
Location: Get the location field of the given VDI.
Managed: Get the managed field of the given VDI.
Missing: Get the missing field of the given VDI.
Parent: Get the parent field of the given VDI. (Deprecated.)
XenstoreData: Get the xenstore\_data field of the given VDI.
SmConfig: Get the sm\_config field of the given VDI.
IsASnapshot: Get the is\_a\_snapshot field of the given VDI.
SnapshotOf: Get the snapshot\_of field of the given VDI.
Snapshots: Get the snapshots field of the given VDI.
SnapshotTime: Get the snapshot\_time field of the given VDI.
Tags: Get the tags field of the given VDI.
AllowCaching: Get the allow\_caching field of the given VDI.
OnBoot: Get the on\_boot field of the given VDI.
MetadataOfPool: Get the metadata\_of\_pool field of the given VDI.
MetadataLatest: Get the metadata\_latest field of the given VDI.
IsToolsIso: Get the is\_tools\_iso field of the given VDI.
CbtEnabled: Get the cbt\_enabled field of the given VDI.
NbdInfo: Get details specifying how to access this VDI via a Network Block Device server. For each of a set of NBD server addresses on which the VDI is available, the return value set contains a vdi\_nbd\_server\_info object that contains an exportname to request once the NBD connection is established, and connection details for the address. An empty list is returned if there is no network that has a PIF on a host with access to the relevant SR, or if no such network has been assigned an NBD-related purpose in its purpose field. To access the given VDI, any of the vdi\_nbd\_server\_info objects can be used to make a connection to a server, and then the VDI will be available by requesting the exportname.

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

-VDI

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenVDIProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, AllowedOperations, CurrentOperations, SR, VBDs, CrashDumps, VirtualSize, PhysicalUtilisation, Type, Sharable, ReadOnly, OtherConfig, StorageLock, Location, Managed, Missing, Parent, XenstoreData, SmConfig, IsASnapshot, SnapshotOf, Snapshots, SnapshotTime, Tags, AllowCaching, OnBoot, MetadataOfPool, MetadataLatest, IsToolsIso, CbtEnabled, NbdInfo

Inputs

  • VDI
  • XenRef[VDI]

Outputs

  • System.Object

Examples

Example 1: Get the AllowedOperations property

PS> Get-XenVDI -Name "Demo VDI" | Get-XenVDIProperty -XenProperty AllowedOperations
Gets the AllowedOperations property of a VDI.

Example 2: Get the CurrentOperations property

PS> Get-XenVDI -Name "Demo VDI" | Get-XenVDIProperty -XenProperty CurrentOperations
Gets the CurrentOperations property of a VDI.

Example 3: Get the SR property

PS> Get-XenVDI -Name "Demo VDI" | Get-XenVDIProperty -XenProperty SR
Gets the SR property of a VDI.
  • VDI cmdlets
  • Class: VDI
  • Using the XenServer PowerShell module