Remove-CBGroup

NAME Remove-CBGroup



SYNOPSIS

Removes a group from CloudBolt.





SYNTAX

Remove-CBGroup [-Session] <Object> [-ID] <Int32> [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

The `Remove-CBGroup` function removes a group from CloudBolt. Pass the session to the targeted CloudBolt instance

to the `Session` parameter (use `New-CBSession` to create a session). Pass the ID of the group to the `ID`

parameter. You can also pipe the ID to this function, or pipe an object with an ID property.





PARAMETERS

-Session <Object>

The session/connecton to the CloudBolt instance to use. Use `New-CBSession` to create a session object.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ID <Int32>

The ID of the group to remove.



Required? true

Position? 2

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

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



OUTPUTS



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



PS C:\\>Remove-CBGroup -Session $session -ID 54



Demonstrates how to remove a group using its ID.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-CBGroup -Session $session -ID 65 | Remove-CBGroup -Session $session



Demonstrates how you can pipe group objects to `Remove-CBGroup`.











RELATED LINKS