gsadmin/PSProxmoxVE
1
0
Fork 0
mirror of https://github.com/GoodOlClint/PSProxmoxVE.git synced 2026-08-27 15:36:57 +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/Set-PveVmGuestPassword.md
+68 -70
View File
@@ -13,9 +13,8 @@ Sets a user password inside the guest via the QEMU guest agent.
## SYNTAX
```
Set-PveVmGuestPassword [-Node] <String> [-VmId] <Int32> -Username <String> -Password <SecureString>
[-Crypted] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Set-PveVmGuestPassword [-Node] <String> [-VmId] <Int32> -Username <String> -Password <SecureString> [-Crypted]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -30,60 +29,15 @@ PS C:\> Set-PveVmGuestPassword -Node pve1 -VmId 100 -Username root -Password (Re
## 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
Position: 0
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: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Username
The username whose password to set.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Password
The new password.
```yaml
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@@ -96,7 +50,7 @@ Indicates the password is already crypted/hashed.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases:
Required: False
Position: Named
@@ -105,6 +59,36 @@ 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
```
### -Password
The new password.
```yaml
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -120,6 +104,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Username
The username whose password to set.
```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: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -135,21 +149,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -168,7 +167,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
### System.Int32