Edit

Share via


Get-CMAccessLicense

Gets license usage information.

Syntax

ByName (Default)

Get-CMAccessLicense
    [-License]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [<CommonParameters>]

ByCount

Get-CMAccessLicense
    -LicenseName <String>
    [-Count]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [<CommonParameters>]

ByValue

Get-CMAccessLicense
    -LicenseName <String>
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [<CommonParameters>]

Description

The Get-CMAccessLicense cmdlet gets license usage information for the servers and clients in the scope of Configuration Manager. This cmdlet returns a list of features able to be licensed and a list of unique users and devices per licensable feature.

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 all licensable features for all servers and clients

PS XYZ:\> Get-CMAccessLicense -License

This command gets all licensable features for all servers and clients within the scope of Configuration Manager.

Example 2: Get the unique users, devices, and license-specific unique ID for a specified license

PS XYZ:\> Get-CMAccessLicense -LicenseName ConfigMgr_2012_EndPointClient

This command gets the unique users, devices, and license-specific IDs for the license named ConfigMgr_2012_EndPointClient.

Parameters

-Count

Indicates that the cmdlet returns a count of unique users and devices for the specified licensable feature.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByCount
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-License

Indicates that the cmdlet gets all licensable features for all of the servers and clients within the scope of Configuration Manager. You can specify the name of the license that is returned for the LicenseName parameter to obtain the unique users and devices for that specific license.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LicenseName

Specifies the name of a licensable feature. If specified, the cmdlet gets only the unique users and devices for the specified license name. The acceptable values for this parameter are:

  • ConfigMgr_2012_CoreServer
  • ConfigMgr_2012_CoreClient
  • ConfigMgr_2012_EndpointClient

Parameter properties

Type:String
Default value:None
Accepted values:ConfigMgr_2012_CoreServer, ConfigMgr_2012_CoreClient, ConfigMgr_2012_EndpointClient
Supports wildcards:False
DontShow:False

Parameter sets

ByCount
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object