Get-CrmAccessLicense

Applies To: CRM 2016 on-prem, Dynamics 365 (on-premises)

Get-CrmAccessLicense

Retrieves the server licensing and client access license (CAL) information for the Microsoft Dynamics 365 deployment.

Syntax

Parameter Set: DisplayLicenseInformation
Get-CrmAccessLicense [[-License]] [-Credential <PSCredential> ] [-Diag] [-DwsServerUrl <String> ] [-EndDate <DateTime> ] [-StartDate <DateTime> ] [-TabMethod <GetCrmAccessLicenseCmdlet+TabulationMethod> {Net | Unique} ] [-Timeout <Int32> ] [ <CommonParameters>]

Parameter Set: ProcessLicenseName
Get-CrmAccessLicense [-LicenseName] <String> {Dynamics CRM Server 2016 | Dynamics CRM Workgroup Server 2016 | Dynamics CRM 2016 Enterprise CAL | Dynamics CRM 2016 Professional CAL | Dynamics CRM 2016 Basic CAL | Dynamics CRM 2016 Essential CAL | Dynamics CRM 2016 Administrative CAL | Dynamics CRM 2016 Device Enterprise CAL | Dynamics CRM 2016 Device Professional CAL | Dynamics CRM 2016 Device Basic CAL | Dynamics CRM 2016 Device Essential CAL} [-Credential <PSCredential> ] [-Diag] [-DwsServerUrl <String> ] [-EndDate <DateTime> ] [-StartDate <DateTime> ] [-TabMethod <GetCrmAccessLicenseCmdlet+TabulationMethod> {Net | Unique} ] [-Timeout <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-CrmAccessLicense cmdlet retrieves the server licensing and CAL information for the Microsoft Dynamics 365 deployment.

Parameters

-Credential<PSCredential>

Specifies the credentials used to log in to the Deployment web service.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Diag

Turns on stack traces for error reports returned from Microsoft Dynamics 365 service calls. Enabling this emits a detailed error message, including a stack trace, when an error is encountered by the Dynamics 365 PowerShell command.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-DwsServerUrl<String>

Identifies the location of the Deployment web service.This should be in the format: http://<serverurl> or https://<serverurl>, for example, http://contoso.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-EndDate<DateTime>

Filters data that is returned to data that is on or before this date.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-License

This parameter prints out the list of possible licenses.

Aliases	none
Required?	false
Position?	1
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-LicenseName<String>

Specifies the name of the license to report metrics for. The possible values are returned by a call to Get-CrmAccessLicenses –License.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-StartDate<DateTime>

Filters data that is returned to data that is on or after this date.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-TabMethod<GetCrmAccessLicenseCmdlet+TabulationMethod>

Describes the way that the set of data should be returned, either as unique records or counts.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Timeout<Int32>

For internal use only.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
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.

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

This example returns a list of all license types and counts for all current system work in a table format.

PS C:\> Get-CrmAccessLicense | Format-Table

-------------------------- EXAMPLE 2 --------------------------

This example gets users for a license type within a specific date range.

PS C:\> Get-CrmAccessLicense –LicenseName “Dynamics CRM 2015 Basic CAL” –TabMethod Unique -StartDate “5/1/2015” –EndDate “6/1/2015”