Get-XenVMAppliance
Gets the VMAppliance objects in the pool.
Syntax
Get-XenVMAppliance [[-Ref] <XenRef[VM_appliance]>] [-BestEffort]
[-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVMAppliance [-Uuid] <guid> [-BestEffort] [-SessionOpaqueRef <string>]
[<CommonParameters>]
Get-XenVMAppliance [-Name] <string> [-BestEffort] [-SessionOpaqueRef <string>]
[<CommonParameters>]
Description
Retrieves the VMAppliance objects in the pool. With no parameters the cmdlet returns the whole collection; use -Name, -Uuid or -Ref to select one.
VMAppliance: VM appliance.
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 |
-Name
The name of the VMAppliance to operate on.
| Attribute | Value |
|---|---|
| Type | string |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
| Aliases | name_label |
-Ref
The VMAppliance object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[VM_appliance] |
| Required | False |
| 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 |
-Uuid
The UUID of the VMAppliance to operate on.
| Attribute | Value |
|---|---|
| Type | guid |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
Inputs
-
XenRef[VM_appliance] -
guid -
string
Outputs
-
VM_appliance[]
Examples
Example 1: List every VMAppliance
PS> Get-XenVMAppliance
Retrieves every VMAppliance object in the pool. With no parameters the cmdlet fetches the whole collection.
Example 2: Retrieve one VMAppliance by name
PS> Get-XenVMAppliance -Name "Demo VMAppliance"
Retrieves a single VMAppliance. -Name matches on name\_label, which is not unique, so every match is operated on.
Example 3: Retrieve one VMAppliance by uuid
PS> Get-XenVMAppliance -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Retrieves a single VMAppliance. -Uuid is the way to be sure of exactly one object.
Related links
-
Class: VMAppliance
-
Using the XenServer PowerShell module