V4. Getting Started - Esri/arcgis-powershell-dsc GitHub Wiki

Supported ArcGIS versions

ArcGIS Enterprise

  • 11.2, 11.1, 11.0, 10.9.1, 10.9, 10.8.1, 10.8, 10.7.1, 10.7

ArcGIS GeoEvent Server

  • 11.2, 11.1, 11.0, 10.9.1, 10.9, 10.8.1, 10.8, 10.7.1, 10.7

ArcGIS Mission Server

  • 11.2, 11.1, 11.0, 10.9.1, 10.9, 10.8.1, 10.8

ArcGIS Notebook Server

  • 11.2, 11.1, 11.0, 10.9.1, 10.9, 10.8.1, 10.8, 10.7.1, 10.7

ArcGIS Workflow Manager Server and Web App

  • 11.2, 11.1, 11.0, 10.9.1, 10.9, 10.8.1

Note: The Workflow Manager web app is included with the portal setup starting at 10.9.1

ArcGIS Server Extensions

  • Data Interoperability
    • 11.2, 11.1, 11.0, 10.9.1, 10.9, 10.8.1, 10.8, 10.7.1, 10.7
  • Data Reviewer
    • 11.2, 11.1, 11.0, 10.9.1, 10.9, 10.8.1, 10.8, 10.7.1, 10.7
  • Workflow Manager Classic
    • 10.9.1, 10.9, 10.8.1, 10.8, 10.7.1, 10.7
  • Location Referencing
    • 10.8.1, 10.8, 10.7.1, 10.7
  • Mapping and Charting Solutions
    • 11.2, 11.1, 11.0, 10.9.1, 10.9, 10.8.1, 10.8, 10.7.1, 10.7

Note: For 11.0 and above use ArcGIS Maritime server setup.

ArcGIS Insights

  • 2023.3, 2023.2, 2023.1, 2022.3, 2022.2, 2022.1.1, 2022.1, 2021.3.1, 2021.3, 2021.2.1,2021.2, 2021.1.1, 2021.1, 2020.3, 2020.2, 2020.1, 3.4.1, 3.4

ArcGIS Desktop

  • 10.8.2, 10.8.1, 10.8, 10.7.1, 10.7

ArcGIS Desktop Extensions

  • Data Interoperability
    • 10.8.2, 10.8.1, 10.8, 10.7.1, 10.7
  • Data Reviewer
    • 10.8.2, 10.8.1, 10.8, 10.7.1, 10.7
  • Workflow Manager Classic
    • 10.8.2, 10.8.1, 10.8, 10.7.1, 10.7
  • Location Referencing
    • 10.8.2, 10.8.1, 10.8, 10.7.1, 10.7
  • Mapping and Charting Solutions
    • 10.8.2, 10.8.1, 10.8, 10.7.1, 10.7
  • Background Geoprocessing (64Bit)
    • 10.8.2, 10.8.1, 10.8, 10.7.1, 10.7

ArcGIS Pro

  • 3.2, 3.1, 3.0.3, 2.9, 2.8, 2.7, 2.6, 2.5, 2.4, 2.3, 2.2, 2.1, 2.0

ArcGIS Pro Extensions

  • Data Interoperability
    • 3.2, 3.1, 3.0.3, 2.9, 2.8, 2.7, 2.6, 2.5, 2.4, 2.3, 2.2, 2.1, 2.0

ArcGIS License Manager

  • 2023.0, 2022.1, 2022.0, 2021.1, 2021.0, 2020.1, 2020.0, 2019.2, 2019.1, 2019.0, 2018.1, 2018.0

Supported Operating System (OS) Platforms

  • Windows 8 (8.1) or Windows Server 2012 (R2)

  • Windows 10, Windows Server 2016, Windows Server 2019, or Windows Server 2022

    • Windows Management Framework (WMF) 5.0 or 5.1. Typically, this comes pre-installed with the Operating System (OS). Run the following Powershell command to see which version is installed:

      $PSVersionTable
      

Note - For client SKUs' (Windows 7,8.x,10), run the following commands i.e. Windows 8.1 and 10 to enable Windows PS Remoting.

Set-ExecutionPolicy RemoteSigned
winrm quickconfig

Instructions on how to get started using the artifacts from GitHub

  • Set the Location Configuration Manager (LCM) ConfigurationMode to ApplyOnly. For detailed steps please visit Microsoft's Configuring the Local Configuration Manager documentation.
  • Clone the repository to your local machine (e.g:- c:\arcgis-automation)
  • 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)
  • Download software installers and licenses from My Esri.
  • If your ArcGIS deployment spans more than a single machine, then use one of the following options -
    • Add the installation files, licenses, and certificates to a file share. Grant permissions on the file share to the Local System Account of the machines on which installations needs to execute. The LCM component of PowerShell DSC runs as the Windows Local System Account.
    • Manually copy software installation files and Licenses to each of the target machines in the deployment.
  • Edit the desired JSON configuration file (Examples can be found in the SampleConfigs folder).
  • Run the Invoke-ArcGISConfiguration commandlet and provide the path to the configuration file as an input parameter. -Mode and -Credential are optional arguments. When -Mode isn't specified it will default to InstallLicenseConfigure.
Invoke-ArcGISConfiguration -ConfigurationParametersFile [Path to Configuration json File](/Esri/arcgis-powershell-dsc/wiki/Path-to-Configuration-json-File) -Mode [Install | InstallLicense | InstallLicenseConfigure | Uninstall | Upgrade] -Credential [Config RunAs - Optional] 

or simply,

 Invoke-ArcGISConfiguration [Path to Configuration json File](/Esri/arcgis-powershell-dsc/wiki/Path-to-Configuration-json-File) [Install | InstallLicense | InstallLicenseConfigure | Uninstall | Upgrade] -Credential [Config RunAs - Optional]

Instructions on how to get started using the artifacts from PowerShell Gallery

  • Set the Location Configuration Manager (LCM) ConfigurationMode to ApplyOnly. For detailed steps please visit Microsoft's Configuring the Local Configuration Manager documentation.
  • Download software installers and licenses from My Esri.
  • If your ArcGIS deployment spans more than a single machine, then use one of the following options -
    • Add the installation files, licenses, and certificates to a file share. Grant permissions on the file share to the Local System Account of the machines on which installations needs to execute. The LCM component of PowerShell DSC runs as the Windows Local System Account.
    • Manually copy software installation files and Licenses to each of the target machines in the deployment.
  • Install the ArcGIS module using the command Install-Module arcgis.
  • Download sample configuration files from the GitHub repository.
  • Edit the desired JSON configuration file.
  • Run the Invoke-ArcGISConfiguration commandlet and provide the path to the configuration file as an input parameter. -Mode and -Credential are optional arguments. When -Mode isn't specified it will default to InstallLicenseConfigure.
Invoke-ArcGISConfiguration -ConfigurationParametersFile [Path to Configuration json File](/Esri/arcgis-powershell-dsc/wiki/Path-to-Configuration-json-File) -Mode [Install | InstallLicense | InstallLicenseConfigure | Uninstall | Upgrade] -Credential [Config RunAs - Optional] 

or simply,

Invoke-ArcGISConfiguration [Path to Configuration json File](/Esri/arcgis-powershell-dsc/wiki/Path-to-Configuration-json-File) [Install | InstallLicense | InstallLicenseConfigure | Uninstall | Upgrade] -Credential [Config RunAs - Optional]