Set-CMAccessAccount
Modifies the properties of an access account.
Syntax
Set-CMAccessAccount
-Access <AccessRight>
-AccountType <AccessAccountType>
[-InputObject] <IResultObject>
[-PassThru]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMAccessAccount
-Access <AccessRight>
-AccountType <AccessAccountType>
-ApplicationId <String>
[-PassThru]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMAccessAccount
-Access <AccessRight>
-AccountType <AccessAccountType>
-ApplicationName <String>
[-PassThru]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMAccessAccount
-Access <AccessRight>
-AccountType <AccessAccountType>
-BootImageId <String>
[-PassThru]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMAccessAccount
-Access <AccessRight>
-AccountType <AccessAccountType>
-BootImageName <String>
[-PassThru]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMAccessAccount
-Access <AccessRight>
-AccountType <AccessAccountType>
-DriverPackageId <String>
[-PassThru]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMAccessAccount
-Access <AccessRight>
-AccountType <AccessAccountType>
-DriverPackageName <String>
[-PassThru]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMAccessAccount
-Access <AccessRight>
-AccountType <AccessAccountType>
-OperatingSystemImageId <String>
[-PassThru]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMAccessAccount
-Access <AccessRight>
-AccountType <AccessAccountType>
-OperatingSystemImageName <String>
[-PassThru]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMAccessAccount
-Access <AccessRight>
-AccountType <AccessAccountType>
-OperatingSystemInstallerId <String>
[-PassThru]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMAccessAccount
-Access <AccessRight>
-AccountType <AccessAccountType>
-OperatingSystemInstallerName <String>
[-PassThru]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMAccessAccount
-Access <AccessRight>
-AccountType <AccessAccountType>
-PackageId <String>
[-PassThru]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMAccessAccount
-Access <AccessRight>
-AccountType <AccessAccountType>
-PackageName <String>
[-PassThru]
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMAccessAccount
-Access <AccessRight>
-AccountType <AccessAccountType>
[-PassThru]
-SoftwareUpdateDeploymentPackageId <String>
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-CMAccessAccount
-Access <AccessRight>
-AccountType <AccessAccountType>
[-PassThru]
-SoftwareUpdateDeploymentPackageName <String>
[-UserName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
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.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>
. For more information, see getting started.
Examples
Example 1: Change access to a package by using the package name
PS XYZ:\> $Name = Get-CMAccessAccount -PackageName "Configuration Manager Client Package"
PS XYZ:\> Set-CMAccessAccount -PackageName $Name -Type User -UserName "CONTOSO\PFuller" -Access Read -Confirm
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.
Parameters
-Access
Specifies the access rights that are associated with an access account. Valid values are: No Access, Read, Change, and Full Control.
Type: | AccessRight |
Accepted values: | NoAccess, Read, Change, FullControl |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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 |
-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
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 |
-PassThru
Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
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