--- external help file: PSProxmoxVE.dll-Help.xml Module Name: PSProxmoxVE online version: schema: 2.0.0 --- # Get-PveGroup ## SYNOPSIS Lists Proxmox VE groups. ## SYNTAX ``` Get-PveGroup [[-GroupId] ] [-Session ] [-ProgressAction ] [] ``` ## DESCRIPTION Returns all groups from the Proxmox VE access management system. Optionally filter by a specific group ID. ## EXAMPLES ### Example 1 ```powershell PS C:\> Get-PveGroup ``` Returns all groups. ### Example 2 ```powershell PS C:\> Get-PveGroup -GroupId "admins" ``` Returns the specified group. ## PARAMETERS ### -GroupId Optional group ID to filter results. ```yaml Type: String Parameter Sets: (All) Aliases: Required: False Position: 0 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 ``` ### -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 ## OUTPUTS ### PSProxmoxVE.Core.Models.Users.PveGroup ## NOTES ## RELATED LINKS