Microsoft Dynamics CRM 2013 Operating and Maintaining Guide

Manager user interface. You can also use the methods that are described in the Microsoft Dynamics CRM SDK to perform these tasks. The Windows PowerShell cmdlets are installed on the computer when you install a Full Server role or when you install the Deployment Tools server role, if you’re installing individual server roles. To execute commands, you must first configure Microsoft Dynamics CRM 2013 with Windows PowerShell

Microsoft Dynamics CRM 2013 Operating and Maintaining Guide Version 6.1.0 1 1 This document is provided "as-is". Information and views expressed in this document, including URL and other Internet Web site references, may change without notice. Some examples depicted herein are provided for illustration only and are fictitious. No real association or connection is intended or should be inferred. This document does not provide you with any legal rights to any intellectual property in any Microsoft product. You may copy and use this document for your internal, reference purposes. The videos and eBooks are in English only. Also, if you click the links, you may be redirected to a U.S. website whose content is in English. © 2014 Microsoft Corporation. All rights reserved. Microsoft, Active Directory, ActiveX, Azure, BizTalk, JScript, Microsoft Dynamics, Outlook, SharePoint, SQL Server, Visual Basic, Visual Studio, Windows, Windows Server, and Windows Vista are trademarks of the Microsoft group of companies. All other trademarks are property of their respective owners. 2 Contents 3 Operating and Maintaining Guide for Microsoft Dynamics CRM 2013 The Microsoft Dynamics CRM 2013 Operating and Maintaining Guide contains resources and topics designed to help you operate and maintain your on-premises deployment of Microsoft Dynamics CRM 2013. In This Section Operating Guide for Microsoft Dynamics CRM 2013 (on-premises) Monitor and troubleshoot Microsoft Dynamics CRM Microsoft Dynamics CRM 2013 data protection and recovery Related Sections Microsoft Dynamics CRM 2013 Installing Guide Microsoft Dynamics CRM 2013 Administration Guide Send us your comments about this document (Op and Maintain Guide) If you have a question or comment about this document, click to send an e-mail message to the Microsoft Dynamics CRM content team. If your question is about Microsoft Dynamics CRM products, and not about the content of this book, search the Microsoft Help and Support Center or the Microsoft Knowledge Base. Operating Guide for Microsoft Dynamics CRM 2013 (on-premises) As you administer Microsoft Dynamics CRM, you’ll want to guarantee availability for your users by monitoring server status and performance, troubleshooting issues, and planning for disaster recovery. 4 Ongoing maintenance of Microsoft Dynamics CRM includes operations such as updating, customizing, monitoring, and relocating or reconfiguring Microsoft Dynamics CRM Server and required or optional technologies such as Microsoft SQL Server and Microsoft SharePoint. Operations that require intensive database transactions cannot be run concurrently. This include the following operations. • Language pack provisioning • Importing a solution • Publishing customizations • Database updates (Microsoft Dynamics CRM (on-premises) only) • Solution update operations (Microsoft Dynamics CRM Online only) In This Section Administer the deployment using Windows PowerShell Enable Windows Error Reporting Monitor and troubleshoot Microsoft Dynamics CRM Change a Microsoft Dynamics CRM service account or AppPool identity Microsoft Dynamics CRM 2013 data protection and recovery Related Sections Planning Guide for Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online Installing Guide for Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online Administration Guide for Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online Customization Guide for Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online Report Writers Guide for Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online Administer the deployment using Windows PowerShell Windows PowerShell enables you to easily run deployment commands to change the configuration of your deployment, such as tasks that can be performed by using the Deployment Manager user interface. You can also use the methods that are described in the Microsoft 5 Caution Dynamics CRM SDK to perform these tasks. The Windows PowerShell cmdlets are installed on the computer when you install a Full Server role or when you install the Deployment Tools server role, if you’re installing individual server roles. To execute commands, you must first configure Microsoft Dynamics CRM 2013 with Windows PowerShell. This topic describes how to do this and explains each of the supported commands. You can find all the organization database settings available in Get and set deployment configuration settings. For sample scripts, refer to the See Also links later in this topic. For more information about Windows PowerShell, see Scripting with Windows PowerShell. This release of the cmdlets includes the following improvements: • Remote execution of PowerShell scripts • Improved error reporting from cmdlets • Improved output from cmdlets For more information about the programmatic use of the Deployment Web Service see “Administer the deployment using the deployment web service” in the Microsoft Dynamics CRM 2013 SDK. In This Topic Configure the Microsoft Dynamics CRM PowerShell cmdlets Use the PowerShell cmdlets Set properties using PowerShell cmdlets Supported PowerShell cmdlets Configure the Microsoft Dynamics CRM PowerShell cmdlets 1. Log into the administrator account on your Microsoft Dynamics CRM server. 2. Open a Windows PowerShell command prompt. 3. In a Windows PowerShell window, enter the following command: Add-PSSnapin Microsoft.Crm.PowerShell This command adds the Microsoft Dynamics CRM Windows PowerShell snap-in to the current session. The snap-in is registered during installation and setup of the Microsoft Dynamics CRM server. 6 Register the cmdlets 1. At the PowerShell prompt, type the following: Get-Help *Crm* 1. At the PowerShell prompt, type the following, replacing CrmCmdletName with the name of a command: Get-Help CRMCMDLETNAME For detailed help for a specific a cmdlet, use Get-Help CRMCMDLET –full, such as the Import-CRMOrganization cmdlet. Get-Help Import-CRMOrganization -full You must register the Microsoft Dynamics CRM Windows PowerShell commands, otherwise you will receive the following message when you try to run a cmdlet. The term ‘MICROSOFT DYNAMICS CRM WINDOWS POWERSHELL COMMAND' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again. Use the PowerShell cmdlets Once you have registered the Microsoft Dynamics CRM Windows PowerShell commands, you can use them to perform tasks. Use the following command to output the list of deployment administrators: PS C:\Users\Administrator> Get-CrmDeploymentAdministrator This command results in the following output: Id Name ExtensionData 4f431656-90f8-e211-831c- 00155da83c4f myDomainName\Administrator 7 Get a list of the Microsoft Dynamics CRM cmdlets Get help for a cmdlet Warning Set properties using PowerShell cmdlets Once you have registered the Microsoft Dynamics CRM Windows PowerShell commands, you can use them to perform tasks, such as set deployment-wide properties or set some organization properties. Examples are provided in the table below and in the following topics. Supported PowerShell cmdlets The following table lists the cmdlets available for use with Windows PowerShell. Cmdlet Description Add-CrmServer Adds a Microsoft Dynamics CRM server to the specified deployment. Disable-CrmOrganization Disables the specified Microsoft Dynamics CRM organization. For an example using this command, see Example – Disable or Enable an Organization. Disable-CrmServer Disables the specified Microsoft Dynamics CRM server. Edit-CrmOrganization Edits properties of the specified Microsoft Dynamics CRM organization. For an example using this command, see Example – Edit the Attributes of an Organization. Enable-CrmOrganization Enables the specified Microsoft Dynamics CRM organization. For an example using this command, see Example – Disable or Enable an 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. 8 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. For a list of the settings objects, see Get and set deployment configuration settings. 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. For complete usage information, see Add a deployment administrator (PowerShell). New-CrmOrganization Initiates the process to create a new organization in the Microsoft Dynamics CRM deployment. For an example using this command, see Example – Create an Organization. For complete usage information, see Create an organization (PowerShell). Remove-CrmCertificate Removes the specified certificate from Microsoft Dynamics CRM. Remove-CrmDeploymentAdministrator Removes the specified deployment administrator from the Microsoft Dynamics CRM deployment. For complete usage information, see Delete a deployment administrator. 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. 9 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. For a list of the settings objects, see Get and set deployment configuration 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. See Also Operating Guide for Microsoft Dynamics CRM 2013 (on-premises) Examples of Windows PowerShell commands Get and set deployment configuration settings Add a deployment administrator (PowerShell) Create an organization (PowerShell) Configure web address settings (PowerShell) Configure IFD settings (PowerShell) Configure claims settings (PowerShell) Delete a deployment administrator Examples of Windows PowerShell commands Before you can try these examples, you must set up the Microsoft Dynamics CRM Windows PowerShell cmdlets. More information: Administer the deployment using Windows PowerShell In This Topic Example: Enable tracing 10 [...]... Windows PowerShell $error variable However, you should know that errors are placed on a stack If any other command (Microsoft Dynamics CRM or otherwise) runs immediately after the Microsoft Dynamics CRM cmdlet and throws an exception, the top item in $error will be pushed down If the Microsoft Dynamics CRM cmdlet exception was the last one thrown in the shell you can access the error details as shown below... Delete a deployment administrator Create an organization (PowerShell) This sample code is for Microsoft Dynamics CRM 2013 Download the Microsoft Dynamics CRM SDK package It can be found in the following location in the download package: SampleCode\PS1\CreateOrg.ps1 Requirements To set up the Microsoft Dynamics CRM PowerShell cmdlets, see Administer the deployment using Windows PowerShell 27 Demonstrates... administrator Configure web address settings (PowerShell) This sample code is for Microsoft Dynamics CRM 2013 Download the Microsoft Dynamics CRM SDK package It can be found in the following location in the download package: SampleCode\PS1\ConfigureWebAddressSettings.ps1 Requirements To set up the Microsoft Dynamics CRM PowerShell cmdlets, see Administer the deployment using Windows PowerShell Demonstrates... Delete a deployment administrator Configure IFD settings (PowerShell) This sample code is for Microsoft Dynamics CRM 2013 Download the Microsoft Dynamics CRM SDK package It can be found in the following location in the download package: 32 SampleCode\PS1\ConfigureIfd.ps1 Requirements To set up the Microsoft Dynamics CRM PowerShell cmdlets, see Administer the deployment using Windows PowerShell Demonstrates... a deployment administrator 34 Configure claims settings (PowerShell) This sample code is Microsoft Dynamics CRM 2013 Download the Microsoft Dynamics CRM SDK package It can be found in the following location in the download package: SampleCode\PS1\ConfigureClaims.ps1 Requirements To set up the Microsoft Dynamics CRM PowerShell cmdlets, see Administer the deployment using Windows PowerShell Demonstrates... if (-not (Get-PSSnapin -Name Microsoft. Crm. PowerShell -ErrorAction SilentlyContinue)) { Add-PSSnapin Microsoft. Crm. PowerShell $RemoveSnapInWhenDone = $True } New-CrmDeploymentAdministrator -Name $Name if($RemoveSnapInWhenDone) { Remove-PSSnapin Microsoft. Crm. PowerShell } See Also Administer the deployment using Windows PowerShell Examples of Windows PowerShell commands Get and set deployment configuration... Windows PowerShell commands Add a deployment administrator (PowerShell) Create an organization (PowerShell) 25 Configure web address settings (PowerShell) Configure IFD settings (PowerShell) Configure claims settings (PowerShell) Delete a deployment administrator Add a deployment administrator (PowerShell) This sample code is for Microsoft Dynamics CRM 2013 Download the Microsoft Dynamics CRM SDK package... (PowerShell) Configure claims settings (PowerShell) Delete a deployment administrator 14 Get and set deployment configuration settings You can use the Get- and Set-CrmSettings commands to retrieve and update many different settings properties for a Microsoft Dynamics CRM deployment In This Topic AsyncSettings ClaimsSettings CustomCodeSettings DashboardSettings DupSettings EtmSettings IfdSettings ImportSettings... Configure web address settings (PowerShell) Configure IFD settings (PowerShell) Delete a deployment administrator Delete a deployment administrator This sample code is Microsoft Dynamics CRM 2013 on-premises Download the Microsoft Dynamics CRM SDK package It can be found in the following location in the download package: SampleCode\PS1\ConfigureClaims.ps1 36 ... [string]$SdkRootDomain, [string]$SslHeader, [string]$WebAppRootDomain ) $RemoveSnapInWhenDone = $False if (-not (Get-PSSnapin -Name Microsoft. Crm. PowerShell -ErrorAction SilentlyContinue)) { Add-PSSnapin Microsoft. Crm. PowerShell $RemoveSnapInWhenDone = $True } $WebAddressSettings = Get-CrmSetting -SettingType WebAddressSettings 31 if($DeploymentSdkRootDomain) {$WebAddressSettings.DeploymentSdkRootDomain = $DeploymentSdkRootDomain}