Export (0) Print
Expand All
Expand Minimize

Get-CMAccessAccount

Updated: February 7, 2014

Applies To: System Center 2012 R2 Configuration Manager

Get-CMAccessAccount

Gets an access account.

Syntax

Parameter Set: SearchByApplicationName
Get-CMAccessAccount -ApplicationName <String> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByApplication
Get-CMAccessAccount -Application <IResultObject> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByApplicationId
Get-CMAccessAccount -ApplicationId <String> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByBootImage
Get-CMAccessAccount -BootImage <IResultObject> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByBootImageId
Get-CMAccessAccount -BootImageId <String> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByBootImageName
Get-CMAccessAccount -BootImageName <String> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByDriverPackage
Get-CMAccessAccount -DriverPackage <IResultObject> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByDriverPackageId
Get-CMAccessAccount -DriverPackageId <String> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByDriverPackageName
Get-CMAccessAccount -DriverPackageName <String> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByOSImage
Get-CMAccessAccount -OperatingSystemImage <IResultObject> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByOSImageId
Get-CMAccessAccount -OperatingSystemImageId <String> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByOSImageName
Get-CMAccessAccount -OperatingSystemImageName <String> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByOSInstaller
Get-CMAccessAccount -OperatingSystemInstaller <IResultObject> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByOSInstallerId
Get-CMAccessAccount -OperatingSystemInstallerId <String> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByOSInstallerName
Get-CMAccessAccount -OperatingSystemInstallerName <String> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByPackage
Get-CMAccessAccount -Package <IResultObject> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByPackageId
Get-CMAccessAccount -PackageId <String> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchByPackageName
Get-CMAccessAccount -PackageName <String> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchBySoftwareUpdateDeploymentPackage
Get-CMAccessAccount -SoftwareUpdateDeploymentPackage <IResultObject> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchBySoftwareUpdateDeploymentPackageId
Get-CMAccessAccount -SoftwareUpdateDeploymentPackageId <String> [-UserName <String> ] [ <CommonParameters>]

Parameter Set: SearchBySoftwareUpdateDeploymentPackageName
Get-CMAccessAccount -SoftwareUpdateDeploymentPackageName <String> [-UserName <String> ] [ <CommonParameters>]




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

Parameters

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


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


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


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


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


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


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 object by using the Get-CMSoftwareUpdate 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 software update deployment object.


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


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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

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: Get an access account for a package by using the package ID

In this example, the first command gets the package that is identified by using its 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.


PS C:\> $ID = Get-CMPackage -PackageName "Configuration Manager Client Package" 
PS C:\> 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

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

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


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

Related topics

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft