Skip to main content

Test-MemberOfGroup

SYNOPSIS​

Tests if a user is a member of a group.

SYNTAX​

Test-MemberOfGroup [-Group] <Object> [-Username] <Object> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION​

This function will test if a user is a member of a group.

EXAMPLES​

EXAMPLE 1​

This will test if the user localadmin is a member of the Administrators group.

Test-MemberOfGroup -Group (Get-Group -Name 'Administrators') -Username 'localadmin';

PARAMETERS​

-Group​

The group to test if the user is a member of.

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Username​

The username to test if they are a member of the group.

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
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.

INPUTS​

OUTPUTS​

[Boolean] - $True if the user is a member of the group, otherwise $False.​

NOTES​

This function is designed to work with the ADSI provider for the local machine. It will not work with remote machines or other providers.