Get-XenVMProperty
Gets a property of a VM object.
Syntax
Get-XenVMProperty [-VM] <VM>
-XenProperty {Uuid | AllowedOperations | CurrentOperations | NameLabel | NameDescription | PowerState | UserVersion | IsATemplate | IsDefaultTemplate | SuspendVDI | ResidentOn | ScheduledToBeResidentOn | Affinity | MemoryOverhead | MemoryTarget | MemoryStaticMax | MemoryDynamicMax | MemoryDynamicMin | MemoryStaticMin | VCPUsParams | VCPUsMax | VCPUsAtStartup | ActionsAfterSoftreboot | ActionsAfterShutdown | ActionsAfterReboot | ActionsAfterCrash | Consoles | VIFs | VBDs | VUSBs | CrashDumps | VTPMs | PVBootloader | PVKernel | PVRamdisk | PVArgs | PVBootloaderArgs | PVLegacyArgs | HVMBootPolicy | HVMBootParams | HVMShadowMultiplier | Platform | PCIBus | OtherConfig | Domid | Domarch | LastBootCPUFlags | IsControlDomain | Metrics | GuestMetrics | LastBootedRecord | Recommendations | XenstoreData | HaAlwaysRun | HaRestartPriority | IsASnapshot | SnapshotOf | Snapshots | SnapshotTime | TransportableSnapshotId | Blobs | Tags | BlockedOperations | SnapshotInfo | SnapshotMetadata | Parent | Children | BiosStrings | ProtectionPolicy | IsSnapshotFromVmpp | SnapshotSchedule | IsVmssSnapshot | Appliance | StartDelay | ShutdownDelay | Order | VGPUs | AttachedPCIs | SuspendSR | Version | GenerationId | HardwarePlatformVersion | HasVendorDevice | RequiresReboot | ReferenceLabel | DomainType | NVRAM | PendingGuidances | PendingGuidancesRecommended | PendingGuidancesFull | Groups | SecurebootCertificatesState | Cooperative | BootRecord | DataSources | AllowedVBDDevices | AllowedVIFDevices | PossibleHosts | SRsRequiredForRecovery | SecurebootReadiness}
[-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]
Get-XenVMProperty [-Ref] <XenRef[VM]>
-XenProperty {Uuid | AllowedOperations | CurrentOperations | NameLabel | NameDescription | PowerState | UserVersion | IsATemplate | IsDefaultTemplate | SuspendVDI | ResidentOn | ScheduledToBeResidentOn | Affinity | MemoryOverhead | MemoryTarget | MemoryStaticMax | MemoryDynamicMax | MemoryDynamicMin | MemoryStaticMin | VCPUsParams | VCPUsMax | VCPUsAtStartup | ActionsAfterSoftreboot | ActionsAfterShutdown | ActionsAfterReboot | ActionsAfterCrash | Consoles | VIFs | VBDs | VUSBs | CrashDumps | VTPMs | PVBootloader | PVKernel | PVRamdisk | PVArgs | PVBootloaderArgs | PVLegacyArgs | HVMBootPolicy | HVMBootParams | HVMShadowMultiplier | Platform | PCIBus | OtherConfig | Domid | Domarch | LastBootCPUFlags | IsControlDomain | Metrics | GuestMetrics | LastBootedRecord | Recommendations | XenstoreData | HaAlwaysRun | HaRestartPriority | IsASnapshot | SnapshotOf | Snapshots | SnapshotTime | TransportableSnapshotId | Blobs | Tags | BlockedOperations | SnapshotInfo | SnapshotMetadata | Parent | Children | BiosStrings | ProtectionPolicy | IsSnapshotFromVmpp | SnapshotSchedule | IsVmssSnapshot | Appliance | StartDelay | ShutdownDelay | Order | VGPUs | AttachedPCIs | SuspendSR | Version | GenerationId | HardwarePlatformVersion | HasVendorDevice | RequiresReboot | ReferenceLabel | DomainType | NVRAM | PendingGuidances | PendingGuidancesRecommended | PendingGuidancesFull | Groups | SecurebootCertificatesState | Cooperative | BootRecord | DataSources | AllowedVBDDevices | AllowedVIFDevices | PossibleHosts | SRsRequiredForRecovery | SecurebootReadiness}
[-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]
Description
Gets a specified property of a VM object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VM.
AllowedOperations: Get the allowed\_operations field of the given VM.
CurrentOperations: Get the current\_operations field of the given VM.
NameLabel: Get the name/label field of the given VM.
NameDescription: Get the name/description field of the given VM.
PowerState: Get the power\_state field of the given VM.
UserVersion: Get the user\_version field of the given VM.
IsATemplate: Get the is\_a\_template field of the given VM.
IsDefaultTemplate: Get the is\_default\_template field of the given VM.
SuspendVDI: Get the suspend\_VDI field of the given VM.
ResidentOn: Get the resident\_on field of the given VM.
ScheduledToBeResidentOn: Get the scheduled\_to\_be\_resident\_on field of the given VM.
Affinity: Get the affinity field of the given VM.
MemoryOverhead: Get the memory/overhead field of the given VM.
MemoryTarget: Get the memory/target field of the given VM. (Deprecated.)
MemoryStaticMax: Get the memory/static\_max field of the given VM.
MemoryDynamicMax: Get the memory/dynamic\_max field of the given VM.
MemoryDynamicMin: Get the memory/dynamic\_min field of the given VM.
MemoryStaticMin: Get the memory/static\_min field of the given VM.
VCPUsParams: Get the VCPUs/params field of the given VM.
VCPUsMax: Get the VCPUs/max field of the given VM.
VCPUsAtStartup: Get the VCPUs/at\_startup field of the given VM.
ActionsAfterSoftreboot: Get the actions/after\_softreboot field of the given VM.
ActionsAfterShutdown: Get the actions/after\_shutdown field of the given VM.
ActionsAfterReboot: Get the actions/after\_reboot field of the given VM.
ActionsAfterCrash: Get the actions/after\_crash field of the given VM.
Consoles: Get the consoles field of the given VM.
VIFs: Get the VIFs field of the given VM.
VBDs: Get the VBDs field of the given VM.
VUSBs: Get the VUSBs field of the given VM.
CrashDumps: Get the crash\_dumps field of the given VM.
VTPMs: Get the VTPMs field of the given VM.
PVBootloader: Get the PV/bootloader field of the given VM.
PVKernel: Get the PV/kernel field of the given VM.
PVRamdisk: Get the PV/ramdisk field of the given VM.
PVArgs: Get the PV/args field of the given VM.
PVBootloaderArgs: Get the PV/bootloader\_args field of the given VM.
PVLegacyArgs: Get the PV/legacy\_args field of the given VM.
HVMBootPolicy: Get the HVM/boot\_policy field of the given VM. (Deprecated.)
HVMBootParams: Get the HVM/boot\_params field of the given VM.
HVMShadowMultiplier: Get the HVM/shadow\_multiplier field of the given VM.
Platform: Get the platform field of the given VM.
PCIBus: Get the PCI\_bus field of the given VM. (Deprecated.)
OtherConfig: Get the other\_config field of the given VM.
Domid: Get the domid field of the given VM.
Domarch: Get the domarch field of the given VM.
LastBootCPUFlags: Get the last\_boot\_CPU\_flags field of the given VM.
IsControlDomain: Get the is\_control\_domain field of the given VM.
Metrics: Get the metrics field of the given VM.
GuestMetrics: Get the guest\_metrics field of the given VM.
LastBootedRecord: Get the last\_booted\_record field of the given VM.
Recommendations: Get the recommendations field of the given VM.
XenstoreData: Get the xenstore\_data field of the given VM.
HaAlwaysRun: Get the ha\_always\_run field of the given VM. (Deprecated.)
HaRestartPriority: Get the ha\_restart\_priority field of the given VM.
IsASnapshot: Get the is\_a\_snapshot field of the given VM.
SnapshotOf: Get the snapshot\_of field of the given VM.
Snapshots: Get the snapshots field of the given VM.
SnapshotTime: Get the snapshot\_time field of the given VM.
TransportableSnapshotId: Get the transportable\_snapshot\_id field of the given VM.
Blobs: Get the blobs field of the given VM.
Tags: Get the tags field of the given VM.
BlockedOperations: Get the blocked\_operations field of the given VM.
SnapshotInfo: Get the snapshot\_info field of the given VM.
SnapshotMetadata: Get the snapshot\_metadata field of the given VM.
Parent: Get the parent field of the given VM.
Children: Get the children field of the given VM.
BiosStrings: Get the bios\_strings field of the given VM.
ProtectionPolicy: Get the protection\_policy field of the given VM. (Deprecated.)
IsSnapshotFromVmpp: Get the is\_snapshot\_from\_vmpp field of the given VM. (Removed.)
SnapshotSchedule: Get the snapshot\_schedule field of the given VM.
IsVmssSnapshot: Get the is\_vmss\_snapshot field of the given VM.
Appliance: Get the appliance field of the given VM.
StartDelay: Get the start\_delay field of the given VM.
ShutdownDelay: Get the shutdown\_delay field of the given VM.
Order: Get the order field of the given VM.
VGPUs: Get the VGPUs field of the given VM.
AttachedPCIs: Get the attached\_PCIs field of the given VM.
SuspendSR: Get the suspend\_SR field of the given VM.
Version: Get the version field of the given VM.
GenerationId: Get the generation\_id field of the given VM.
HardwarePlatformVersion: Get the hardware\_platform\_version field of the given VM.
HasVendorDevice: Get the has\_vendor\_device field of the given VM.
RequiresReboot: Get the requires\_reboot field of the given VM.
ReferenceLabel: Get the reference\_label field of the given VM.
DomainType: Get the domain\_type field of the given VM.
NVRAM: Get the NVRAM field of the given VM.
PendingGuidances: Get the pending\_guidances field of the given VM.
PendingGuidancesRecommended: Get the pending\_guidances\_recommended field of the given VM.
PendingGuidancesFull: Get the pending\_guidances\_full field of the given VM.
Groups: Get the groups field of the given VM.
SecurebootCertificatesState: Get the secureboot\_certificates\_state field of the given VM.
Cooperative: Return true if the VM is currently 'co-operative' i.e. is expected to reach a balloon target and actually has done. (Deprecated.)
BootRecord: Returns a record describing the VM's dynamic state, initialised when the VM boots and updated to reflect runtime configuration changes, for example CPU hotplug. (Deprecated.)
DataSources
AllowedVBDDevices: Returns a list of the allowed values that a VBD device field can take.
AllowedVIFDevices: Returns a list of the allowed values that a VIF device field can take.
PossibleHosts: Return the list of hosts on which this VM may run.
SRsRequiredForRecovery: List all the SR's that are required for the VM to be recovered.
SecurebootReadiness: Return the secureboot readiness of the VM.
Parameters
-Async
If set, the operation runs asynchronously and returns a Task object that can be used to track its progress.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-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 VM object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[VM] |
| 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 |
-SessionTo
The session to which the SRs of the VM have to be recovered. Accepted when -XenProperty is SRsRequiredForRecovery.
| Attribute | Value |
|---|---|
| Type | XenRef[Session] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-VM
The VM object to operate on.
| Attribute | Value |
|---|---|
| Type | VM |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByValue) |
-XenProperty
Selects which property to use.
| Attribute | Value |
|---|---|
| Type | XenVMProperty |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | Uuid, AllowedOperations, CurrentOperations, NameLabel, NameDescription, PowerState, UserVersion, IsATemplate, IsDefaultTemplate, SuspendVDI, ResidentOn, ScheduledToBeResidentOn, Affinity, MemoryOverhead, MemoryTarget, MemoryStaticMax, MemoryDynamicMax, MemoryDynamicMin, MemoryStaticMin, VCPUsParams, VCPUsMax, VCPUsAtStartup, ActionsAfterSoftreboot, ActionsAfterShutdown, ActionsAfterReboot, ActionsAfterCrash, Consoles, VIFs, VBDs, VUSBs, CrashDumps, VTPMs, PVBootloader, PVKernel, PVRamdisk, PVArgs, PVBootloaderArgs, PVLegacyArgs, HVMBootPolicy, HVMBootParams, HVMShadowMultiplier, Platform, PCIBus, OtherConfig, Domid, Domarch, LastBootCPUFlags, IsControlDomain, Metrics, GuestMetrics, LastBootedRecord, Recommendations, XenstoreData, HaAlwaysRun, HaRestartPriority, IsASnapshot, SnapshotOf, Snapshots, SnapshotTime, TransportableSnapshotId, Blobs, Tags, BlockedOperations, SnapshotInfo, SnapshotMetadata, Parent, Children, BiosStrings, ProtectionPolicy, IsSnapshotFromVmpp, SnapshotSchedule, IsVmssSnapshot, Appliance, StartDelay, ShutdownDelay, Order, VGPUs, AttachedPCIs, SuspendSR, Version, GenerationId, HardwarePlatformVersion, HasVendorDevice, RequiresReboot, ReferenceLabel, DomainType, NVRAM, PendingGuidances, PendingGuidancesRecommended, PendingGuidancesFull, Groups, SecurebootCertificatesState, Cooperative, BootRecord, DataSources, AllowedVBDDevices, AllowedVIFDevices, PossibleHosts, SRsRequiredForRecovery, SecurebootReadiness |
Inputs
-
VM -
XenRef[VM]
Outputs
-
System.Object
Examples
Example 1: Get the AllowedOperations property
PS> Get-XenVM -Name "Demo VM" | Get-XenVMProperty -XenProperty AllowedOperations
Gets the AllowedOperations property of a VM.
Example 2: Get the CurrentOperations property
PS> Get-XenVM -Name "Demo VM" | Get-XenVMProperty -XenProperty CurrentOperations
Gets the CurrentOperations property of a VM.
Example 3: Get the PowerState property
PS> Get-XenVM -Name "Demo VM" | Get-XenVMProperty -XenProperty PowerState
Gets the PowerState property of a VM.
Related links
-
Class: VM
-
Using the XenServer PowerShell module