Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
527 lines (414 sloc) 12.8 KB

external help file: AdminUI.PS.Rba.dll-Help.xml ms.assetid: BB88D28C-3AA8-4F03-B0CF-07DE6769B4A9 online version: https://go.microsoft.com/fwlink/?linkid=833601 schema: 2.0.0

Set-CMAccessAccount

SYNOPSIS

Modifies the properties of an access account.

SYNTAX

SearchByValue (Default)

Set-CMAccessAccount [-InputObject] <IResultObject> -AccountType <AccessAccountType> [-UserName <String>]
 -Access <AccessRight> [-PassThru] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByApplicationName

Set-CMAccessAccount -ApplicationName <String> -AccountType <AccessAccountType> [-UserName <String>]
 -Access <AccessRight> [-PassThru] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByApplicationId

Set-CMAccessAccount -ApplicationId <String> -AccountType <AccessAccountType> [-UserName <String>]
 -Access <AccessRight> [-PassThru] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByBootImageName

Set-CMAccessAccount -BootImageName <String> -AccountType <AccessAccountType> [-UserName <String>]
 -Access <AccessRight> [-PassThru] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByBootImageId

Set-CMAccessAccount -BootImageId <String> -AccountType <AccessAccountType> [-UserName <String>]
 -Access <AccessRight> [-PassThru] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByDriverPackageName

Set-CMAccessAccount -DriverPackageName <String> -AccountType <AccessAccountType> [-UserName <String>]
 -Access <AccessRight> [-PassThru] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByDriverPackageId

Set-CMAccessAccount -DriverPackageId <String> -AccountType <AccessAccountType> [-UserName <String>]
 -Access <AccessRight> [-PassThru] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByOSImageName

Set-CMAccessAccount -OperatingSystemImageName <String> -AccountType <AccessAccountType> [-UserName <String>]
 -Access <AccessRight> [-PassThru] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByOSImageId

Set-CMAccessAccount -OperatingSystemImageId <String> -AccountType <AccessAccountType> [-UserName <String>]
 -Access <AccessRight> [-PassThru] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByOSInstallerName

Set-CMAccessAccount -OperatingSystemInstallerName <String> -AccountType <AccessAccountType>
 [-UserName <String>] -Access <AccessRight> [-PassThru] [-DisableWildcardHandling] [-ForceWildcardHandling]
 [-WhatIf] [-Confirm] [<CommonParameters>]

SearchByOSInstallerId

Set-CMAccessAccount -OperatingSystemInstallerId <String> -AccountType <AccessAccountType> [-UserName <String>]
 -Access <AccessRight> [-PassThru] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByPackageName

Set-CMAccessAccount -PackageName <String> -AccountType <AccessAccountType> [-UserName <String>]
 -Access <AccessRight> [-PassThru] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchByPackageId

Set-CMAccessAccount -PackageId <String> -AccountType <AccessAccountType> [-UserName <String>]
 -Access <AccessRight> [-PassThru] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SearchBySoftwareUpdateDeploymentPackageName

Set-CMAccessAccount -SoftwareUpdateDeploymentPackageName <String> -AccountType <AccessAccountType>
 [-UserName <String>] -Access <AccessRight> [-PassThru] [-DisableWildcardHandling] [-ForceWildcardHandling]
 [-WhatIf] [-Confirm] [<CommonParameters>]

SearchBySoftwareUpdateDeploymentPackageId

Set-CMAccessAccount -SoftwareUpdateDeploymentPackageId <String> -AccountType <AccessAccountType>
 [-UserName <String>] -Access <AccessRight> [-PassThru] [-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.

EXAMPLES

[!NOTE] Configuration Manager CmdLets must be run from the Configuration Manager site drive. For more information, see the getting started documentation.

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
Parameter Sets: (All)
Aliases: 
Accepted values: NoAccess, Read, Change, FullControl

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

-AccountType

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

Type: AccessAccountType
Parameter Sets: (All)
Aliases: 
Accepted values: User, Guest, Administrator, WindowsUser, WindowsGroup

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

-ApplicationId

Specifies the ID of an application.

Type: String
Parameter Sets: SearchByApplicationId
Aliases: 

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

-ApplicationName

Specifies the name of an application.

Type: String
Parameter Sets: SearchByApplicationName
Aliases: 

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

-BootImageId

Specifies the ID of a boot image.

Type: String
Parameter Sets: SearchByBootImageId
Aliases: 

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

-BootImageName

Specifies the name of a boot image.

Type: String
Parameter Sets: SearchByBootImageName
Aliases: 

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-DisableWildcardHandling

DisableWildcardHandling treats wildcard characters as literal character values. Cannot be combined with ForceWildcardHandling.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-DriverPackageId

Specifies the ID of a driver package.

Type: String
Parameter Sets: SearchByDriverPackageId
Aliases: 

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

-DriverPackageName

Specifies the name of a driver package.

Type: String
Parameter Sets: SearchByDriverPackageName
Aliases: 

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

-ForceWildcardHandling

ForceWildcardHandling processes wildcard characters and may lead to unexpected behavior (not recommended). Cannot be combined with DisableWildcardHandling.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-InputObject

Type: IResultObject
Parameter Sets: SearchByValue
Aliases: DriverPackage, Application, OperatingSystemImage, OperatingSystemInstaller, Package, SoftwareUpdateDeploymentPackage, BootImage

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OperatingSystemImageId

Specifies the ID of an operating system image.

Type: String
Parameter Sets: SearchByOSImageId
Aliases: 

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

-OperatingSystemImageName

Specifies the name of an operating system image.

Type: String
Parameter Sets: SearchByOSImageName
Aliases: 

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

-OperatingSystemInstallerId

Specifies the ID of an operating system installer.

Type: String
Parameter Sets: SearchByOSInstallerId
Aliases: 

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

-OperatingSystemInstallerName

Specifies the name of an operating system installer.

Type: String
Parameter Sets: SearchByOSInstallerName
Aliases: 

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

-PackageId

Specifies the ID of a deployed software script or program.

Type: String
Parameter Sets: SearchByPackageId
Aliases: 

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

-PackageName

Specifies the name of a deployed software script or program.

Type: String
Parameter Sets: SearchByPackageName
Aliases: 

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

-PassThru

Returns the current working object. By default, this cmdlet does not generate any output.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-SoftwareUpdateDeploymentPackageId

Specifies the ID of a deployed software update.

Type: String
Parameter Sets: SearchBySoftwareUpdateDeploymentPackageId
Aliases: 

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

-SoftwareUpdateDeploymentPackageName

Specifies the name of a deployed software update.

Type: String
Parameter Sets: SearchBySoftwareUpdateDeploymentPackageName
Aliases: 

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

-UserName

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

Type: String
Parameter Sets: (All)
Aliases: 

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

RELATED LINKS

Get-CMAccessAccount

New-CMAccessAccount

Remove-CMAccessAccount

Get-CMApplication

Get-CMBootImage

Get-CMDriverPackage

Get-CMOperatingSystemImage

Get-CMOperatingSystemInstaller

Get-CMPackage

Get-CMSoftwareUpdateDeploymentPackage

You can’t perform that action at this time.