PowerShell/docs/list-user-groups.md

69 lines
1.5 KiB
Markdown
Raw Normal View History

2024-01-25 13:37:12 +01:00
Script: *list-user-groups.ps1*
========================
2021-11-08 21:36:42 +01:00
2023-07-29 09:45:37 +02:00
This PowerShell script lists the user groups of the local computer.
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2021-11-08 21:36:42 +01:00
```powershell
2023-07-29 10:15:44 +02:00
PS> ./list-user-groups.ps1 [<CommonParameters>]
2021-11-08 21:36:42 +01:00
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
2023-07-29 10:04:38 +02:00
Example
-------
2021-11-08 21:36:42 +01:00
```powershell
2023-08-06 21:36:33 +02:00
PS> ./list-user-groups.ps1
2021-11-08 21:36:42 +01:00
2023-07-29 09:45:37 +02:00
Name Description
---- -----------
Administrators Administrators have complete and unrestricted access to the computer/domain
2021-11-08 21:36:42 +01:00
...
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Related Links
-------------
2021-11-08 21:36:42 +01:00
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
2023-07-29 09:45:37 +02:00
Lists the user groups
2022-11-17 20:02:26 +01:00
.DESCRIPTION
2023-07-29 09:45:37 +02:00
This PowerShell script lists the user groups of the local computer.
2022-11-17 20:02:26 +01:00
.EXAMPLE
2023-08-06 21:36:33 +02:00
PS> ./list-user-groups.ps1
2022-11-17 20:02:26 +01:00
2023-07-29 09:45:37 +02:00
Name Description
---- -----------
Administrators Administrators have complete and unrestricted access to the computer/domain
2022-11-17 20:02:26 +01:00
...
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
try {
Get-LocalGroup
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2024-01-25 13:58:49 +01:00
*(generated by convert-ps2md.ps1 using the comment-based help of list-user-groups.ps1 as of 01/25/2024 13:58:40)*