Share via

Get-CrmAccessLicense

Module:
Microsoft.Crm.PowerShell Module

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

Syntax

DisplayLicenseInformation (Default) 

Get-CrmAccessLicense
    [-License]
    [-StartDate <DateTime>]
    [-EndDate <DateTime>]
    [-TabMethod <TabulationMethod>]
    [-Timeout <Int32>]
    [-Diag]
    [-Credential <PSCredential>]
    [-DwsServerUrl <String>]

ProcessLicenseName 

Get-CrmAccessLicense
    [-LicenseName] <String>
    [-StartDate <DateTime>]
    [-EndDate <DateTime>]
    [-TabMethod <TabulationMethod>]
    [-Timeout <Int32>]
    [-Diag]
    [-Credential <PSCredential>]
    [-DwsServerUrl <String>]

Description

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

Examples

Example 1

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

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

Example 2

PS C:\> Get-CrmAccessLicense -LicenseName "Dynamics CRM 2016 Basic CAL" -StartDate "1/1/2017" -EndDate "12/31/2017"

Gets users for the Dynamics CRM 2016 Basic CAL license type within a specific date range.

Parameters

-Credential

Expects a variable that contains the user credentials used for signing in to Dynamics 365 on-premises organization. To establish this variable, run the PowerShell command $Cred = Get-Credential.

Parameter properties

Type:PSCredential
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:True
Value from remaining arguments:False

-Diag

Turns on stack traces for error reports returned from 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.

Parameter properties

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

Parameter sets

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

-DwsServerUrl

The URL of the Deployment Web Service. This should be in the format: https://<serverurl>, for example, https://contoso.

Parameter properties

Type:String
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:True
Value from remaining arguments:False

-EndDate

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

Parameter properties

Type:DateTime
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

This parameter prints out the list of possible licenses.

Parameter properties

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

Parameter sets

DisplayLicenseInformation
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LicenseName

Specifies the name of the license to return information for. The possible values are returned by running the command Get-CrmAccessLicenses -License.

Parameter properties

Type:String
Default value:None
Accepted values: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
Supports wildcards:False
DontShow:False

Parameter sets

ProcessLicenseName
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StartDate

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

Parameter properties

Type:DateTime
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

-TabMethod

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

Parameter properties

Type:TabulationMethod
Default value:None
Accepted values:Net, Unique
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

-Timeout

For internal use only.

Parameter properties

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

Parameter sets

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

Inputs

System.Int32

System.Management.Automation.SwitchParameter

System.Management.Automation.PSCredential

System.String

Outputs

Microsoft.Crm.PowerShell.GetCrmAccessLicenseCmdlet+LicenseInfo

Microsoft.Crm.PowerShell.GetCrmAccessLicenseCmdlet+UserInfo

Microsoft.Crm.PowerShell.GetCrmAccessLicenseCmdlet+ServerInfo

Microsoft.Crm.PowerShell.GetCrmAccessLicenseCmdlet+EntityNetInfo