Remove-CMAccessAccount

Module:

ConfigurationManager

Removes users or groups from an access account.

Syntax

Remove-CMAccessAccount
      -AccountType <AccessAccountType>
      [-Force]
      [-InputObject] <IResultObject>
      [-UserName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-CMAccessAccount
      -AccountType <AccessAccountType>
      -ApplicationId <String>
      [-Force]
      [-UserName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-CMAccessAccount
      -AccountType <AccessAccountType>
      -ApplicationName <String>
      [-Force]
      [-UserName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-CMAccessAccount
      -AccountType <AccessAccountType>
      -BootImageId <String>
      [-Force]
      [-UserName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-CMAccessAccount
      -AccountType <AccessAccountType>
      -BootImageName <String>
      [-Force]
      [-UserName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-CMAccessAccount
      -AccountType <AccessAccountType>
      -DriverPackageId <String>
      [-Force]
      [-UserName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-CMAccessAccount
      -AccountType <AccessAccountType>
      -DriverPackageName <String>
      [-Force]
      [-UserName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-CMAccessAccount
      -AccountType <AccessAccountType>
      [-Force]
      -OperatingSystemImageId <String>
      [-UserName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-CMAccessAccount
      -AccountType <AccessAccountType>
      [-Force]
      -OperatingSystemImageName <String>
      [-UserName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-CMAccessAccount
      -AccountType <AccessAccountType>
      [-Force]
      -OperatingSystemInstallerId <String>
      [-UserName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-CMAccessAccount
      -AccountType <AccessAccountType>
      [-Force]
      -OperatingSystemInstallerName <String>
      [-UserName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-CMAccessAccount
      -AccountType <AccessAccountType>
      [-Force]
      -PackageId <String>
      [-UserName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-CMAccessAccount
      -AccountType <AccessAccountType>
      [-Force]
      -PackageName <String>
      [-UserName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-CMAccessAccount
      -AccountType <AccessAccountType>
      [-Force]
      -SoftwareUpdateDeploymentPackageId <String>
      [-UserName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-CMAccessAccount
      -AccountType <AccessAccountType>
      [-Force]
      -SoftwareUpdateDeploymentPackageName <String>
      [-UserName <String>]
      [-DisableWildcardHandling]
      [-ForceWildcardHandling]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-CMAccessAccount cmdlet removes users or groups from an access account.

An access account is a list of users or groups that can access an established service or application that is located on a distribution point. For example, members in the Software Update Point Connection Access Account can access two services to manage software updates: Windows Server Update Services (WSUS) and WSUS Synchronization Manager.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Remove a user from an access account for an application by using its name

PS XYZ:\> Remove-CMAccessAccount -ApplicationName "SharePoint 2010" -Type WindowsUser -UserName "CONTOSO\ENarvaez" -Confirm

This command removes a Windows user from the access account for an application that is specified by using its name. You must confirm the action before the command performs it.

Example 2: Remove a group from an access account for a package by using its ID

PS XYZ:\> $ID = Get-CMAccessAccount -PackageId "CM1100002"
PS XYZ:\> Remove-CMAccessAccount -PackageId $ID -Type WindowsGroup -UserName "CONTOSO\Guest"

The first command gets the package object ID, and then stores it in the variable $ID.

The second command removes a group from the access account for the specified package. No confirmation is required.

Parameters

-AccountType

Specifies an account type. Valid values are: Guest, User, WindowsGroup, and WindowsUser.

Type:	AccessAccountType
Accepted values:	User, Guest, Administrator, WindowsUser, WindowsGroup
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ApplicationId

Specifies the ID of an application.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ApplicationName

Specifies the name of an application.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-BootImageId

Specifies the ID of a boot image.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-BootImageName

Specifies the name of a boot image.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DriverPackageId

Specifies the ID of a driver package.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DriverPackageName

Specifies the name of a driver package.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Forces the command to run without asking for user confirmation.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Type:	IResultObject
Aliases:	DriverPackage, Application, OperatingSystemImage, OperatingSystemInstaller, Package, SoftwareUpdateDeploymentPackage, BootImage
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-OperatingSystemImageId

Specifies the ID of an operating system image.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-OperatingSystemImageName

Specifies the name of an operating system image.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-OperatingSystemInstallerId

Specifies the ID of an operating system installer.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-OperatingSystemInstallerName

Specifies the name of an operating system installer.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PackageId

Specifies the ID of a deployed software script or program.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PackageName

Specifies the name of a deployed software script or program.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SoftwareUpdateDeploymentPackageId

Specifies the ID of a deployed software update.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SoftwareUpdateDeploymentPackageName

Specifies the name of a deployed software update.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-UserName

Specifies a Windows user account name in domain\user format.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object

Related Links

• New-CMAccessAccount
• Get-CMAccessAccount
• Set-CMAccessAccount
• Get-CMApplication
• Get-CMBootImage
• Get-CMDriverPackage
• Get-CMOperatingSystemImage
• Get-CMOperatingSystemInstaller
• Get-CMPackage
• Get-CMSoftwareUpdateDeploymentPackage