Get-XenVMApplianceProperty

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

Syntax

Get-XenVMApplianceProperty [-VMAppliance] <VM_appliance>
    -XenProperty {Uuid | NameLabel | NameDescription | AllowedOperations | CurrentOperations | VMs | SRsRequiredForRecovery}
    [-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]
Get-XenVMApplianceProperty [-Ref] <XenRef[VM_appliance]>
    -XenProperty {Uuid | NameLabel | NameDescription | AllowedOperations | CurrentOperations | VMs | SRsRequiredForRecovery}
    [-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]

Description

Gets a specified property of a VMAppliance object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VM\_appliance.
NameLabel: Get the name/label field of the given VM\_appliance.
NameDescription: Get the name/description field of the given VM\_appliance.
AllowedOperations: Get the allowed\_operations field of the given VM\_appliance.
CurrentOperations: Get the current\_operations field of the given VM\_appliance.
VMs: Get the VMs field of the given VM\_appliance.
SRsRequiredForRecovery: Get the list of SRs required by the VM appliance to recover.

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 VMAppliance object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[VM_appliance]
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 list of SRs have to be recovered . Accepted when -XenProperty is SRsRequiredForRecovery.
Attribute Value
Type XenRef[Session]
Required False
Position Named
Accepts pipeline input False

-VMAppliance

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenVMApplianceProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, AllowedOperations, CurrentOperations, VMs, SRsRequiredForRecovery

Inputs

  • VM_appliance
  • XenRef[VM_appliance]

Outputs

  • System.Object

Examples

Example 1: Get the AllowedOperations property

PS> Get-XenVMAppliance -Name "Demo VMAppliance" | Get-XenVMApplianceProperty -XenProperty AllowedOperations
Gets the AllowedOperations property of a VMAppliance.

Example 2: Get the CurrentOperations property

PS> Get-XenVMAppliance -Name "Demo VMAppliance" | Get-XenVMApplianceProperty -XenProperty CurrentOperations
Gets the CurrentOperations property of a VMAppliance.

Example 3: Get the VMs property

PS> Get-XenVMAppliance -Name "Demo VMAppliance" | Get-XenVMApplianceProperty -XenProperty VMs
Gets the VMs property of a VMAppliance.