Remove-CMAccessAccount
Remove-CMAccessAccount
Removes users or groups from an access account.
Syntax
Parameter Set: SearchByApplicationName
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -ApplicationName <String> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByApplication
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -Application <IResultObject> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByApplicationId
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -ApplicationId <String> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByBootImage
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -BootImage <IResultObject> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByBootImageId
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -BootImageId <String> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByBootImageName
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -BootImageName <String> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByDriverPackage
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -DriverPackage <IResultObject> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByDriverPackageId
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -DriverPackageId <String> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByDriverPackageName
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -DriverPackageName <String> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByOSImage
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemImage <IResultObject> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByOSImageId
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemImageId <String> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByOSImageName
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemImageName <String> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByOSInstaller
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemInstaller <IResultObject> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByOSInstallerId
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemInstallerId <String> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByOSInstallerName
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemInstallerName <String> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByPackage
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -Package <IResultObject> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByPackageId
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -PackageId <String> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByPackageName
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -PackageName <String> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchBySoftwareUpdateDeploymentPackage
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -SoftwareUpdateDeploymentPackage <IResultObject> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchBySoftwareUpdateDeploymentPackageId
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -SoftwareUpdateDeploymentPackageId <String> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchBySoftwareUpdateDeploymentPackageName
Remove-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -SoftwareUpdateDeploymentPackageName <String> [-Force] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
Parameters
-AccountType<AccessAccountType>
Specifies an account type. The acceptable values for this parameter are:
-- Guest
-- User
-- WindowsGroup
-- WindowsUser
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Application<IResultObject>
Specifies a deployed application object. You can get an application object by using the Get-CMApplication cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ApplicationId<String>
Specifies the ID of an application.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ApplicationName<String>
Specifies the name of an application.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-BootImage<IResultObject>
Specifies a boot image object. A boot image object contains the Windows files that are required to prepare a computer for the installation of an operating system. You can get a boot image object by using the Get-CMBootImage cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-BootImageId<String>
Specifies the ID of a boot image.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-BootImageName<String>
Specifies the name of a boot image.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DriverPackage<IResultObject>
Specifies a driver package object. A driver package object specifies a group of hardware drivers that are required to install an operating system. You can get a driver package object by using the Get-CMDriverPackage cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DriverPackageId<String>
Specifies the ID of a driver package.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DriverPackageName<String>
Specifies the name of a driver package.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Force
Forces the command to run without asking for user confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperatingSystemImage<IResultObject>
Specifies an operating system image object. An operating system image object contains the Windows files that compose a complete Windows installation. You can get an operating system image object by using the Get-CMOperatingSystemImage cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperatingSystemImageId<String>
Specifies the ID of an operating system image.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperatingSystemImageName<String>
Specifies the name of an operating system image.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperatingSystemInstaller<IResultObject>
Specifies an operating system installer object. An operating system installer object contains the Windows files that are required to prepare a computer for the installation of an operating system. To obtain an operating system installer object, use the Get-CMOperatingSystemInstaller cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperatingSystemInstallerId<String>
Specifies the ID of an operating system installer.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperatingSystemInstallerName<String>
Specifies the name of an operating system installer.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Package<IResultObject>
Specifies a deployed software script or program object. You can get a package by using the Get-CMPackage cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PackageId<String>
Specifies the ID of a deployed software script or program.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PackageName<String>
Specifies the name of a deployed software script or program.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SoftwareUpdateDeploymentPackage<IResultObject>
Specifies a software update deployment object. You can get a software update deployment object by using the Get-CMSoftwareUpdateDeploymentPackage cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SoftwareUpdateDeploymentPackageId<String>
Specifies the ID of a deployed software update.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SoftwareUpdateDeploymentPackageName<String>
Specifies the name of a deployed software update.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UserName<String>
Specifies a Windows user account name in domain\user format.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Remove a user from an access account for an application by using its name
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.
PS C:\> Remove-CMAccessAccount -ApplicationName "SharePoint 2010" -Type WindowsUser -UserName "CONTOSO\ENarvaez" -Confirm
Example 2: Remove a group from an access account for a package by using its ID
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.
PS C:\> $ID = Get-CMAccessAccount -PackageId "CM1100002"
PS C:\> Remove-CMAccessAccount -PackageId $ID -Type WindowsGroup -UserName "CONTOSO\Guest"