Microsoft Dynamics CRM 2013 PowerShell Cmdlets

Colin Maitland, 07 October 2014

Microsoft Dynamics CRM 2013 provides a number of Windows PowerShell cmdlets that may be used to manage a Microsoft Dynamics CRM 2013 deployment. These cmdlets are available on the Microsoft Dynamics CRM 2013 Server which has the Deployment Tools Server Role installed.

In order to use the cmdlets you must be a Deployment Administrator and must first register the Microsoft.Crm.Powershell snap-in using the following command-line command:

•  Add-PSSnapin Microsoft.Crm.Powershell
 

This command may be used to get a list of available commands: 

•  Get-Help *crm*
 

This command may be used to get help for a specific cmdlet identified using CrmCmdletName: 

•  Get-Help CrmCmdletName 
 

This command may be used to get detailed help for a specific cmdlet identified using CrmCmdletName: 

•  Get-Help CrmCmdletName - full 
 

The following table provides a list of the available commands: 

CMDLET

DESCRIPTION

Add-CrmServer

Adds a Microsoft Dynamics CRM server to the specified deployment.

Disable-CrmOrganization

Disables the specified Microsoft Dynamics CRM server.

Edit-CrmOrganization

Edits properties of the specified Microsoft Dynamics CRM organization.

Enable-CrmOrganization

Enables the specified Microsoft Dynamics CRM organization.

Enable-CrmServer

Enables the specified Microsoft Dynamics CRM server.

Get-CrmAccessLicense

Retrieves the server licensing and CAL licensing information for the deployment.

Get-AdvancedSetting

Gets an advanced setting value for Microsoft Dynamics CRM. In some cases, this cmdlet should only be used under the direction of Microsoft Support.

Get-CrmCertificate

Retrieves the certificate information for Microsoft Dynamics CRM. The certificate object contains the public key of the service bus signing certificate.

Get-CrmDeploymentAdministrator

Retrieves the deployment administrators for the Microsoft Dynamics CRM deployment.

Get-CrmLicenseProperty

Retrieves the license properties object for Microsoft Dynamics CRM.

Get-CrmOperationStatus

Retrieves the status on asynchronous operations sitting in the asynchronous operation queue for Microsoft Dynamics CRM.

Get-CrmOrganization

Retrieves one or all of the organizations in the deployment of Microsoft Dynamics CRM.

Get-CrmServer

Retrieves a server object for one or all Microsoft Dynamics CRM servers in a deployment.

Get-CrmSetting

Retrieves a Microsoft Dynamics CRM deployment setting object.

Import-CrmOrganization

Initiates the process to import a Microsoft Dynamics CRM organization database into the deployment.

New-CrmDeploymentAdministrator

Creates a new deployment administrator for the Microsoft Dynamics CRM deployment.

New-CrmOrganization

Initiates the process to create a new organization in the Microsoft Dynamics CRM deployment.

Remove-CrmCertificate

Removes the specified certificate from Microsoft Dynamics CRM.

Remove-CrmDeploymentAdministrator

Removes the specified deployment administrator from the Microsoft Dynamics CRM deployment.

Remove-CrmOrganization

Deletes the specified organization from the Microsoft Dynamics CRM deployment.

Remove-CrmServer

Deletes the specified server from the Microsoft Dynamics CRM deployment.

Set-CrmAdvancedSetting

Sets an advanced setting value for Microsoft Dynamics CRM. This is for internal use only, unless under the direction of Microsoft Support.

Set-CrmCertificate

Creates a certificate record or sets the properties of an existing certificate record in the Microsoft Dynamics CRM configuration database.

Set-CrmProductKey

Sets the product key for the Microsoft Dynamics CRM deployment.

Set-CrmSetting

Sets the specified Microsoft Dynamics CRM deployment wide settings.

Update-CrmOrganization

Updates the specified Microsoft Dynamics CRM organization with the latest software updates or upgrades the organization from Microsoft Dynamics CRM 2011 to Microsoft Dynamics CRM 2013.

 

Finally, complete information on the Microsoft Dynamics CRM PowerShell cmdlets is provided in the Microsoft Dynamics CRM 2013 Implementation Guide for CRM Online and CRM 2013 (on-premises) under the Administer the deployment using Windows PowerShell topic.

Category List

Filter by Author