Get-CMAccessAccount

Reference

Module:: ConfigurationManager

Gets an access account.

Syntax

Get-CMAccessAccount
   -ApplicationName <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Get-CMAccessAccount
   -ApplicationId <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Get-CMAccessAccount
   -BootImageId <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Get-CMAccessAccount
   -BootImageName <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Get-CMAccessAccount
   -DriverPackageId <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Get-CMAccessAccount
   -DriverPackageName <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Get-CMAccessAccount
   [-InputObject] <IResultObject>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Get-CMAccessAccount
   -OperatingSystemImageId <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Get-CMAccessAccount
   -OperatingSystemImageName <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Get-CMAccessAccount
   -OperatingSystemInstallerId <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Get-CMAccessAccount
   -OperatingSystemInstallerName <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Get-CMAccessAccount
   -PackageId <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Get-CMAccessAccount
   -PackageName <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Get-CMAccessAccount
   -SoftwareUpdateDeploymentPackageId <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Get-CMAccessAccount
   -SoftwareUpdateDeploymentPackageName <String>
   [-UserName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Description

The Get-CMAccessAccount cmdlet gets 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. You can get an access account to change the network access permissions for clients who use the account.

Note

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

Examples

Example 1: Get an access account for a package by using the package ID

PS XYZ:\> $ID = Get-CMPackage -PackageName "Configuration Manager Client Package"
PS XYZ:\> Get-CMAccessAcccount -PackageId $ID
Name:          Administrator
Type:          Administrator
Access:        FullControl
Sitecode:      CM1
PackageID:     CM100002
Name:          CONTOSO\PFuller
Type:          WindowsUser
Access:        Read
Sitecode:      CM1
PackageID:     CM100002

The first command gets the package that is identified by name. The command stores the ID of the specified package in the $ID variable.

The second command gets the access account for the identified package. The command output describes all users and groups that can access this package.

Example 2: Get an access account for a boot image by using the boot image name

PS XYZ:\> Get-CMAccessAccount -BootImageName "System Image (x64)"
Name:          CONTOSO\EDaugherty
Type:          WindowsUser
Access:        Read
Sitecode:      CM1
Boot Image:    System Image (x64)

The command gets the access account for a system boot image that is specified by using its name.

Parameters

-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 object.

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 object.

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 object.

Type:	String
Position:	Named
Default value:	None
Required:	True
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

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 object.

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 object.

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 object.

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

-SoftwareUpdateDeploymentPackageId

Specifies the ID of a software update deployment object.

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 object.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

AccessAccount[]

AccessAccount

Share via

Get-CMAccessAccount

Syntax

Description

Examples

Example 1: Get an access account for a package by using the package ID

Example 2: Get an access account for a boot image by using the boot image name

Parameters

-ApplicationId

-ApplicationName

-BootImageId

-BootImageName

-DisableWildcardHandling

-DriverPackageId

-DriverPackageName

-ForceWildcardHandling

-InputObject

-OperatingSystemImageId

-OperatingSystemImageName

-OperatingSystemInstallerId

-OperatingSystemInstallerName

-PackageId

-PackageName

-SoftwareUpdateDeploymentPackageId

-SoftwareUpdateDeploymentPackageName

-UserName

Inputs

Outputs

Feedback

Additional resources

Share via

Get-CMAccessAccount

Syntax

Description

Examples

Example 1: Get an access account for a package by using the package ID

Example 2: Get an access account for a boot image by using the boot image name

Parameters

-ApplicationId

-ApplicationName

-BootImageId

-BootImageName

-DisableWildcardHandling

-DriverPackageId

-DriverPackageName

-ForceWildcardHandling

-InputObject

-OperatingSystemImageId

-OperatingSystemImageName

-OperatingSystemInstallerId

-OperatingSystemInstallerName

-PackageId

-PackageName

-SoftwareUpdateDeploymentPackageId

-SoftwareUpdateDeploymentPackageName

-UserName

Inputs

Outputs

Related Links

Feedback

Additional resources