mirror of
https://github.com/GoodOlClint/PSProxmoxVE.git
synced 2026-07-26 07:58:14 +00:00
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>
165 lines
2.9 KiB
Markdown
165 lines
2.9 KiB
Markdown
---
|
|
external help file: PSProxmoxVE.dll-Help.xml
|
|
Module Name: PSProxmoxVE
|
|
online version:
|
|
schema: 2.0.0
|
|
---
|
|
|
|
# Suspend-PveContainer
|
|
|
|
## SYNOPSIS
|
|
Suspends an LXC container on a Proxmox VE node.
|
|
|
|
## SYNTAX
|
|
|
|
```
|
|
Suspend-PveContainer -Node <String> -VmId <Int32> [-Wait] [-Timeout <Int32>] [-Session <PveSession>]
|
|
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
|
|
```
|
|
|
|
## DESCRIPTION
|
|
Sends a suspend command to the specified LXC container. Use -Wait to block until the suspend task completes.
|
|
|
|
## EXAMPLES
|
|
|
|
### Example 1
|
|
```powershell
|
|
PS C:\> Suspend-PveContainer -Node pve1 -VmId 100 -Wait
|
|
```
|
|
|
|
## PARAMETERS
|
|
|
|
### -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
|
|
```
|
|
|
|
### -Node
|
|
The PVE node name.
|
|
|
|
```yaml
|
|
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 }}
|
|
|
|
```yaml
|
|
Type: PveSession
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -Timeout
|
|
Timeout in seconds for -Wait (default 60).
|
|
|
|
```yaml
|
|
Type: Int32
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: 60
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -VmId
|
|
The container 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 task to complete before returning.
|
|
|
|
```yaml
|
|
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.
|
|
|
|
```yaml
|
|
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 }}
|
|
|
|
```yaml
|
|
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](http://go.microsoft.com/fwlink/?LinkID=113216).
|
|
|
|
## INPUTS
|
|
|
|
### System.String
|
|
### System.Int32
|
|
## OUTPUTS
|
|
|
|
### PSProxmoxVE.Core.Models.Vms.PveTask
|
|
## NOTES
|
|
|
|
## RELATED LINKS
|