gsadmin/PSProxmoxVE
1
0
Fork 0
mirror of https://github.com/GoodOlClint/PSProxmoxVE.git synced 2026-08-16 16:38:20 +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/Send-PveFile.md
+72 -75
View File
@@ -30,75 +30,13 @@ PS C:\> Send-PveFile -Node pve1 -Storage local -Path ./ubuntu.iso -ContentType i
## PARAMETERS
### -Node
The PVE node name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Storage
The storage pool name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Path
Local path to the file to upload.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ContentType
Content type: iso, vztmpl, or import.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: iso, vztmpl, import
Required: False
Position: 3
Default value: iso
Accept pipeline input: False
Accept wildcard characters: False
```
### -Checksum
Checksum value to verify the upload.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Aliases:
Required: False
Position: Named
@@ -113,8 +51,7 @@ Checksum algorithm (md5, sha1, sha256, sha512).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Aliases:
Accepted values: md5, sha1, sha256, sha512
Required: False
@@ -124,13 +61,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Wait
Wait for the task to complete before returning.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: False
Position: Named
@@ -139,6 +76,52 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ContentType
Content type: iso, vztmpl, or import.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: iso, vztmpl, import
Required: False
Position: 3
Default value: iso
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Path
Local path to the file to upload.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -154,13 +137,28 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -Storage
The storage pool name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Wait
Wait for the task to complete before returning.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -169,13 +167,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
@@ -202,7 +200,6 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None