Get-XenVBDProperty
Gets a property of a VBD object.
Syntax
Get-XenVBDProperty [-VBD] <VBD>
-XenProperty {Uuid | AllowedOperations | CurrentOperations | VM | VDI | Device | Userdevice | Bootable | Mode | Type | Unpluggable | StorageLock | Empty | OtherConfig | CurrentlyAttached | StatusCode | StatusDetail | RuntimeProperties | QosAlgorithmType | QosAlgorithmParams | QosSupportedAlgorithms | Metrics}
[-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVBDProperty [-Ref] <XenRef[VBD]>
-XenProperty {Uuid | AllowedOperations | CurrentOperations | VM | VDI | Device | Userdevice | Bootable | Mode | Type | Unpluggable | StorageLock | Empty | OtherConfig | CurrentlyAttached | StatusCode | StatusDetail | RuntimeProperties | QosAlgorithmType | QosAlgorithmParams | QosSupportedAlgorithms | Metrics}
[-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Description
Gets a specified property of a VBD object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VBD.
AllowedOperations: Get the allowed\_operations field of the given VBD.
CurrentOperations: Get the current\_operations field of the given VBD.
VM: Get the VM field of the given VBD.
VDI: Get the VDI field of the given VBD.
Device: Get the device field of the given VBD.
Userdevice: Get the userdevice field of the given VBD.
Bootable: Get the bootable field of the given VBD.
Mode: Get the mode field of the given VBD.
Type: Get the type field of the given VBD.
Unpluggable: Get the unpluggable field of the given VBD.
StorageLock: Get the storage\_lock field of the given VBD.
Empty: Get the empty field of the given VBD.
OtherConfig: Get the other\_config field of the given VBD.
CurrentlyAttached: Get the currently\_attached field of the given VBD.
StatusCode: Get the status\_code field of the given VBD.
StatusDetail: Get the status\_detail field of the given VBD.
RuntimeProperties: Get the runtime\_properties field of the given VBD.
QosAlgorithmType: Get the qos/algorithm\_type field of the given VBD.
QosAlgorithmParams: Get the qos/algorithm\_params field of the given VBD.
QosSupportedAlgorithms: Get the qos/supported\_algorithms field of the given VBD.
Metrics: Get the metrics field of the given VBD. (Removed.)
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 VBD object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[VBD] |
| 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 |
-VBD
The VBD object to operate on.
| Attribute | Value |
|---|---|
| Type | VBD |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByValue) |
-XenProperty
Selects which property to use.
| Attribute | Value |
|---|---|
| Type | XenVBDProperty |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | Uuid, AllowedOperations, CurrentOperations, VM, VDI, Device, Userdevice, Bootable, Mode, Type, Unpluggable, StorageLock, Empty, OtherConfig, CurrentlyAttached, StatusCode, StatusDetail, RuntimeProperties, QosAlgorithmType, QosAlgorithmParams, QosSupportedAlgorithms, Metrics |
Inputs
-
VBD -
XenRef[VBD]
Outputs
-
System.Object
Examples
Example 1: Get the AllowedOperations property
PS> Get-XenVBD -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVBDProperty -XenProperty AllowedOperations
Gets the AllowedOperations property of a VBD.
Example 2: Get the CurrentOperations property
PS> Get-XenVBD -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVBDProperty -XenProperty CurrentOperations
Gets the CurrentOperations property of a VBD.
Example 3: Get the VM property
PS> Get-XenVBD -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVBDProperty -XenProperty VM
Gets the VM property of a VBD.
Related links
-
Class: VBD
-
Using the XenServer PowerShell module