Clint Branham
f6a2f843db
- generate-help.ps1: rewritten to use Update-MarkdownHelp (merge) by default, preserving hand-written descriptions and examples. Only New-MarkdownHelp on genuinely new cmdlets. -Force flag for full regen. - docs/cmdlets: parameter metadata updated via platyPS merge, CRLF normalized to LF - Removed stale Send-PveIso.md (cmdlet renamed to Send-PveFile) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
4.0 KiB
external help file, Module Name, online version, schema
| external help file | Module Name | online version | schema |
|---|---|---|---|
| PSProxmoxVE.dll-Help.xml | PSProxmoxVE | 2.0.0 |
Import-PveVmDisk
SYNOPSIS
Imports a disk image into a Proxmox VE virtual machine.
SYNTAX
Import-PveVmDisk -Node <String> -VmId <Int32> [-Disk] <String> -TargetStorage <String> -Source <String>
[-Format <String>] [-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Imports a disk image file into the specified VM by setting a disk configuration key with the PVE import-from syntax. The image can be a file already on PVE storage, a VMDK inside an uploaded OVA archive, or an absolute path on the PVE node. Use -Wait to block until complete.
EXAMPLES
Example 1
PS C:\> Import-PveVmDisk -Node "pve1" -VmId 100 -Disk scsi0 -TargetStorage "local-lvm" -Source "local:iso/noble-server-cloudimg-amd64.img" -Wait
Imports a cloud image into VM 100.
PARAMETERS
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Disk
Target disk slot (e.g. scsi0, sata0, virtio0).
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Format
Target disk format (qcow2, raw, vmdk).
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: qcow2, raw, vmdk
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Node
The PVE node name.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Session
{{ Fill Session Description }}
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Source
Import source (e.g. local:iso/image.img or local:import/vm.ova/disk.vmdk).
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TargetStorage
Target storage for the imported disk.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VmId
The VM identifier.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Wait
Wait for the import task to complete.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.