< Back

Uninstall-CGroup

Sun Jan 12, 2020 11:40 pm

NAME Uninstall-CGroup



SYNOPSIS

Removes a *local* group.





SYNTAX

Uninstall-CGroup [-Name] <String> [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

The `Uninstall-CGroup` function removes a *local* group using .NET's [DirectoryServices.AccountManagement

API](https://msdn.microsoft.com/en-us/librar ... ement.aspx). If the group

doesn't exist, returns without doing any work or writing any errors.



This function was added in Carbon 2.1.0.





PARAMETERS

-Name <String>

The name of the group to remove/uninstall.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String





OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Uninstall-WhsGroup -Name 'TestGroup1'



Demonstrates how to uninstall a group. In this case, the `TestGroup1` group is removed.











RELATED LINKS

Add-CGroupMember

Install-CGroup

Remove-CGroupMember

Test-CGroup

Test-CGroupMember





Name : Uninstall-IisAppPool

Category : Alias

Synopsis : Uninstall-CIisAppPool

Component :

Role :

Functionality :





Name : Uninstall-IisWebsite

Category : Alias

Synopsis : Uninstall-CIisWebsite

Component :

Role :

Functionality :