Invoke-XenLVHD
Invokes an operation on an LVHD object.
Syntax
Invoke-XenLVHD [-LVHD] <LVHD> -XenAction {EnableThinProvisioning} [-PassThru]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
[<CommonParameters>]
Invoke-XenLVHD [-Ref] <XenRef[LVHD]> -XenAction {EnableThinProvisioning} [-PassThru]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
[<CommonParameters>]
Invoke-XenLVHD [-Uuid] <guid> -XenAction {EnableThinProvisioning} [-PassThru]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
[<CommonParameters>]
Description
Invokes an operation on an LVHD object. Use the -XenAction parameter to select which operation to perform.
EnableThinProvisioning: Upgrades an LVHD SR to enable thin-provisioning. Future VDIs created in this SR will be thinly-provisioned, although existing VDIs will be left alone. Note that the SR must be attached to the SRmaster for upgrade to work.
Parameters
-AllocationQuantum
The amount of space to allocate to a VDI when it needs to be enlarged in bytes. Accepted when -XenAction is EnableThinProvisioning.
| Attribute | Value |
|---|---|
| Type | long |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-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 |
-Confirm
Prompts for confirmation before running the cmdlet.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
| Aliases | cf |
-InitialAllocation
The initial amount of space to allocate to a newly-created VDI in bytes. Accepted when -XenAction is EnableThinProvisioning.
| Attribute | Value |
|---|---|
| Type | long |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-LVHD
The LVHD object to operate on.
| Attribute | Value |
|---|---|
| Type | LVHD |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByValue) |
-PassThru
If set, the cmdlet returns the affected object. By default the cmdlet does not generate any output.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Ref
The LVHD object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[LVHD] |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
| Aliases | opaque_ref |
-SR
The LVHD SR to upgrade to being thin-provisioned. Accepted when -XenAction is EnableThinProvisioning.
| Attribute | Value |
|---|---|
| Type | XenRef[SR] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-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 LVHD to operate on.
| Attribute | Value |
|---|---|
| Type | guid |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
| Aliases | wi |
-XenAction
Selects which action to use.
| Attribute | Value |
|---|---|
| Type | XenLVHDAction |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | EnableThinProvisioning |
-XenHost
The LVHD Host to upgrade to being thin-provisioned. Accepted when -XenAction is EnableThinProvisioning.
| Attribute | Value |
|---|---|
| Type | XenRef[Host] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
Inputs
-
LVHD -
XenRef[LVHD] -
guid
Outputs
-
System.Object
Examples
Example 1: Run the EnableThinProvisioning operation
PS> Invoke-XenLVHD -XenAction EnableThinProvisioning -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff -PassThru
Invokes the EnableThinProvisioning operation on an LVHD. -PassThru writes the result to the pipeline.
Example 2: Run the EnableThinProvisioning operation by reference
PS> Invoke-XenLVHD -XenAction EnableThinProvisioning -Ref OpaqueRef:f433bf7b-2b0c-5f53-7018-7d195addb3ca -PassThru
Invokes the EnableThinProvisioning operation on an LVHD. -Ref takes the opaque reference, which is what the API itself uses and what the records hold. -PassThru writes the result to the pipeline.
Example 3: Run EnableThinProvisioning asynchronously
PS> Invoke-XenLVHD -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff -XenAction EnableThinProvisioning -Async -PassThru | Wait-XenTask -ShowProgress
Runs the same operation asynchronously and follows the task it returns.
Related links
-
Class: LVHD
-
Using the XenServer PowerShell module