Remove-PAMGroup

Module:: MIMPAM Module

Removes a group from the MIM Service and the foreign principal group object from the PAM domain.

Syntax

Default (Default)

Remove-PAMGroup
    [-Group] <PAMGroup>
    [-Force]
    [[-Session] <PAMSession>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Remove-PAMGroup cmdlet can be used to remove a PAM Group from MIM Service and PAM domain.

Examples

EXAMPLE 1

Remove-PAMGroup -Group (Get-PAMGroup -PrivDisplayName "contoso.corpadmins")

This command removes a single group with a specified display name from the MIM Service and the PAM domain.

Parameters

-Confirm

Prompts you for confirmation before executing the command.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Force

@{Text=}

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Group

The group to be deleted, returned by Get-PAMGroup.

Parameter properties

Type:	PAMGroup
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	1
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Session

Session with the PAM domain and MIM Service.

Parameter properties

Type:	PAMSession
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	2
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.