Upgrade PowerShell DSC Module for ArcGIS

When to Upgrade the PowerShell DSC Module for ArcGIS

Upgrading the PowerShell DSC for ArcGIS Module may be required for a number of reasons, for example, upgrading to the latest version of ArcGIS Enterprise or to ensure all nodes have the latest version of the PowerShell DSC Module for ArcGIS installed. Before upgrading, ensure that the ArcGIS Software component type and version is supported with the desired PowerShell DSC for ArcGIS module version.

Note: The PowerShell DSC Module for ArcGIS can be upgraded without upgrading ArcGIS Software. As long as the ArcGIS Software component type and version are supported with the desired version of the module.

Common reasons to upgrade the PowerShell DSC Module:

• Upgrading ArcGIS Software
• To ensure all machines have the latest version installed
• New features
• Bug fixes

Note: Regardless of the version of the PowerShell DSC Module for ArcGIS that is chosen for the deployment, it is required that all nodes (machines) participating in a deployment using the PowerShell DSC Module for ArcGIS have the same version of the PowerShell DSC Module for ArcGIS installed.

Steps to upgrade the PowerShell DSC Module for ArcGIS

The steps outlined below

Note: You must remove the old version of the PowerShell DSC Module for ArcGIS entirely prior to installing the target version of the module. Overwriting the old version with a new version will not completely update the module and errors may occur.

1. Delete the old version of the PowerShell DSC Module for ArcGIS from the node

   • Option 1: Using File Explorer

     • Open File Explorer and navigate to the PowerShell Module Directory. By default this is located in C:\Program Files\WindowsPowerShell\Modules
     • Delete the ArcGIS directory entirely

   • Option 2: Using PowerShell

     • Open PowerShell command-let as an Administrator

     • Remove the PowerShell Module for ArcGIS.

       Remove-Item -Path "C:\Program Files\WindowsPowerShell\Modules\ArcGIS" -Recurse -Force

   Note: If the PowerShell DSC Module for ArcGIS was initially installed using the PowerShell Gallery, the module can be uninstalled from each node using the following command:

   Uninstall-Module -Name 'ArcGIS'

2. Install PowerShell DSC Module for ArcGIS

   • Option 1: Using artifacts from GitHub

     • Use Git to clone the repository to your local machine (e.g: c:\arcgis-automation-dsc)
     • Add the "ArcGIS" Modules folder to your PsModulePath or Copy the modules into the default PowerShell Modules folder (e.g:- C:\Program Files\WindowsPowerShell\Modules)
       • If your deployment spans multiple nodes, please reference the Scripts to push ArcGIS Module page for instructions on how to automatically install the PowerShell DSC Module for ArcGIS

   • Option 2: Using artifacts from PowerShell Gallery

     • Open PowerShell command-let as an Administrator
     • Run the following PowerShell command:

       Install-Module -Name ArcGIS

     • Follow the additional prompts for downloading the PowerShell DSC Module for ArcGIS from the PowerShell Gallery.

3. Run the PowerShell command below on each node to confirm the ArcGIS Module is the same on each machine:

   Get-Module -ListAvailable -Name 'ArcGIS'

4. Repeat steps 1-3 for all nodes that will participate in the PowerShell DSC deployment.