gsadmin/PSProxmoxVE
1
0
Fork 0
mirror of https://github.com/GoodOlClint/PSProxmoxVE.git synced 2026-08-28 16:06:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update cmdlet help via platyPS merge, fix generate-help.ps1

Browse Source 
- 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>
This commit is contained in:
Clint Branham
2026-03-23 17:41:04 -05:00
parent d5f4e13637
commit f6a2f843db
90 changed files with 24596 additions and 3615 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/cmdlets/Import-PveVmDisk.md
+63 -63
View File
@@ -13,7 +13,7 @@ Imports a disk image into a Proxmox VE virtual machine.
## SYNTAX
```
Import-PveVmDisk [-Disk] <String> -Node <String> -VmId <Int32> -TargetStorage <String> -Source <String>
Import-PveVmDisk -Node <String> -VmId <Int32> [-Disk] <String> -TargetStorage <String> -Source <String>
[-Format <String>] [-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@@ -32,33 +32,18 @@ Imports a cloud image into VM 100.
## PARAMETERS
### -Node
The PVE node name.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept pipeline input: False
Accept wildcard characters: False
```
@@ -77,36 +62,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -TargetStorage
Target storage for the imported disk.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
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).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Format
Target disk format (qcow2, raw, vmdk).
@@ -123,18 +78,18 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Wait
Wait for the import task to complete.
### -Node
The PVE node name.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
@@ -153,13 +108,58 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -Source
Import source (e.g. local:iso/image.img or local:import/vm.ova/disk.vmdk).
```yaml
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.
```yaml
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.
```yaml
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.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -168,13 +168,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named