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>
2.1 KiB
2.1 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 |
Get-PveClusterResource
SYNOPSIS
Lists resources across the Proxmox VE cluster.
SYNTAX
Get-PveClusterResource [[-Type] <String>] [-Node <String>] [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Returns cluster-wide resources (VMs, containers, nodes, storage, SDN). Optionally filter by resource type or node name.
EXAMPLES
Example 1
PS C:\> Get-PveClusterResource
Returns all cluster resources.
Example 2
PS C:\> Get-PveClusterResource -Type vm
Returns only VM resources across the cluster.
PARAMETERS
-Node
Filter results to a specific node name.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
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
-Type
Filter by resource type.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: vm, lxc, node, storage, sdn
Required: False
Position: 0
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.