Set-CMAccessAccount

Set-CMAccessAccount

Modifies the properties of an access account.

Syntax

Parameter Set: SearchByApplicationName
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -ApplicationName <String> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByApplication
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -Application <IResultObject> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByApplicationId
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -ApplicationId <String> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByBootImage
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -BootImage <IResultObject> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByBootImageId
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -BootImageId <String> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByBootImageName
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -BootImageName <String> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByDriverPackage
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -DriverPackage <IResultObject> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByDriverPackageId
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -DriverPackageId <String> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByDriverPackageName
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -DriverPackageName <String> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByOSImage
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemImage <IResultObject> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByOSImageId
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemImageId <String> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByOSImageName
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemImageName <String> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByOSInstaller
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemInstaller <IResultObject> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByOSInstallerId
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemInstallerId <String> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByOSInstallerName
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -OperatingSystemInstallerName <String> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByPackage
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -Package <IResultObject> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByPackageId
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -PackageId <String> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByPackageName
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -PackageName <String> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchBySoftwareUpdateDeploymentPackage
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -SoftwareUpdateDeploymentPackage <IResultObject> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchBySoftwareUpdateDeploymentPackageId
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -SoftwareUpdateDeploymentPackageId <String> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchBySoftwareUpdateDeploymentPackageName
Set-CMAccessAccount -AccountType <AccessAccountType> {Administrator | Guest | User | WindowsGroup | WindowsUser} -SoftwareUpdateDeploymentPackageName <String> [-Access <AccessRight> {Change | FullControl | NoAccess | Read} ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-CMAccessAccount cmdlet modifies the properties of an access account. You can add users or groups to the access account and change the level of permissions to objects to which they have permissions.

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

-Access<AccessRight>

Specifies the access rights that are associated with an access account. The acceptable values for this parameter are:

-- No Access
-- Read
-- Change
-- Full Control

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-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

-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 deployed software update 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: Change access to a package by using the package name

The first command gets the package name, and then stores it in the $Name variable.

The second command sets access permissions for the user to the package to Read. You must confirm the action before the command performs it.

PS C:\> $Name = Get-CMAccessAccount -PackageName "Configuration Manager Client Package" 
PS C:\> Set-CMAccessAccount -PackageName $Name -Type User -UserName "CONTOSO\PFuller" -Access Read -Confirm

Get-CMAccessAccount

New-CMAccessAccount

Remove-CMAccessAccount

Get-CMApplication

Get-CMBootImage

Get-CMDriverPackage

Get-CMOperatingSystemImage

Get-CMOperatingSystemInstaller

Get-CMPackage

Get-CMSoftwareUpdateDeploymentPackage