New Variables Introduced in each PowerShell DSC Module Version - Esri/arcgis-powershell-dsc GitHub Wiki

Overview

With each release of the PowerShell DSC for ArcGIS Module, there may be new variables that are introduced to support the deployment, configuration, and customization of continuously evolving ArcGIS Software. This page is designed to help quickly identify new variables and when they were introduced to the PowerShell DSC Module.

For general ArcGIS Software version compatability with the PowerShell DSC for ArcGIS, checkout the Supported ArcGIS Versions page to see if the desired ArcGIS Software component type and version are supported with the desired PowerShell DSC for ArcGIS module version.

Below you will find the PowerShell DSC Module variable(s) and the corresponding ArcGIS PowerShell DSC module they were introduced. Unless otherwise noted, each section's variables and syntatical changes are cumulative and are assumed to be inherited in new versions of the PowerShell DSC Module for ArcGIS. Please visit the Variables Reference page for the desired version of the PowerShell DSC Module for ArcGIS.

Version 4.5.0 release of ArcGIS PowerShell DSC Module

Beginning at version 4.5.0 of the PowerShell DSC Module for ArcGIS, ArcGIS Web Adaptor 11.5 Java includes support for both Tomcat 9 and Tomcat 10. There is also support for ArcGIS Data Store Graph v. 11.5 for single instance mode and cluster mode.

In addition, additional attributes have been added to help control the URLs used for federation (even supported in the Base Enterprise Deployment JSON configuration files). These new attributes can be used to construct the desired ArcGIS Server services and ArcGIS Server Administration URLs when federating an ArcGIS Server site or Base Enterprise deployment.

JSON Configuration File Attribute Value Updates

  • ConfigData.Version - added accepted value of 11.5.

  • ConfigData.OldVersion - added accepted value of 11.4.

  • ConfigData.ProVersion - added accepted value of 3.5.

  • ConfigData.LicenseManagerVersion - added accepted value of 2025.0.

  • ConfigData.InsightsVersion - added accepted value of 2024.2.

New Variable(s) and Attribute(s)

AllNodes

  • AllNodes.SslCertificates.ImportCertificateChain

    • Boolean
    • Optional. Imports the full certificate chain. Defaults to true.
    • This attribute is only supported when working with ArcGIS software v. 11.5+

  • AllNodes.SslCertificates.ForceImport

    • Boolean
    • Optional. Force import the full certificate chain. Defaults to false.
    • This attribute is only supported when working with ArcGIS software v. 11.5+
Web Adaptor

  • ConfigData.WebAdaptor.Installer.ApacheTomcat.OldVersion

    • String
    • Optional. Old version of Apache Tomcat. Only required if upgrading to a newer version.

  • ConfigData.WebAdaptor.Installer.ApacheTomcat.OldServiceName

    • String
    • Optional. Old Apache Tomcat service name. Only required if upgrading to a newer version.

  • ConfigData.WebAdaptor.JavaWebServerType

    • String
    • Conditional. Only required when ConfigData.WebAdaptor.IsJavaWebAdaptor is set to True.
    • Allowed values include: ApacheTomcat9, ApacheTomcat10
Federation

  • ConfigData.Federation.ServerHostName

    • String
    • Optional. User-provided domain name (Ex. friendlydns.domain.com). This should be the friendly DNS of the ArcGIS server site.
    • This attribute is used to construct the ArcGIS Server Services URL for federation. All services that will be published to Portal for ArcGIS will use this url to construct the REST API urls.

  • ConfigData.Federation.ServerUrlPort

    • String
    • Optional. User-provided custom URL Port. This should be set to the port the ArcGIS Server services URL uses for communication. Typically this is port 443 (IIS) or 8443 (Apache Tomcat).
    • This attribute is used to construct the ArcGIS Server Services URL for federation.

  • ConfigData.Federation.ServerContext

    • String
    • Optional. Custom server context (Ex. arcgis). The context name to use when connecting to ArcGIS Server through https://ConfigData.Federation.ServerHostName:ConfigData.Federation.ServerUrlPort/ConfigData.Federation.ServerContext.
    • Typically this is the name of the ArcGIS Server web adaptor that will be used to access the site/publish services, etc.
    • This attribute is used to construct the ArcGIS Server Services URL for federation.

  • ConfigData.Federation.ServerAdminHostName

    • String
    • Optional. User-provided domain name (Ex. friendlydns.domain.com or the server admin domain name). Depending on the desired Administration URL for federation, this can be set to a few different values.
      • If the desired Admininstration URL for federation is to be the same as the external DNS (ArcGIS Server services URL), then this should be set to the friendlydns.domain.com domain.
      • If the desired Administration URL for federation is to be set as the internal ArcGIS Server Admin URL (ex. https://server.machine.com:6443/arcgis), then this attribute should be defined as the FQDN of the server machine name or the FQDN of the Load Balancer that directs 6443 traffic to multiple ArcGIS Server's (in HA configurations).
    • This attribute is used to construct the ArcGIS Server Administration URL for federation. All portal and server administrative tasks will communicate through this URL.

  • ConfigData.Federation.ServerAdminUrlPort

    • String
    • Optional. User-provided custom URL Port. This should be set to the port the desired ArcGIS Server Administration URL uses for communication. Typically this is port 6443 (directly to ArcGIS Server - :6443/arcgis), 443 (IIS Web Adaptor), 8443 (Apache Tomcat Web Adaptor). Depending on the desired Administration URL for federation, this can be set to a few different values.
      • If the desired Admininstration URL for federation is to be the same as the external DNS (ArcGIS Server services URL), then this should be set to the same value as ConfigData.Federation.ServerUrlPort.
      • If the desired Administration URL for federation is to be set as the internal ArcGIS Server Admin URL (ex. https://server.machine.com:6443/arcgis), then this attribute should be defined as 6443.
    • This attribute is used to construct the ArcGIS Server Administration URL for federation. All portal and server administrative tasks will communicate through this URL.

  • ConfigData.Federation.ServerAdminContext

    • String
    • Optional. Custom server context (Ex. arcgis). The context name to use when connecting to ArcGIS Server through https://ConfigData.Federation.ServerAdminHostName:ConfigData.Federation.ServerAdminUrlPort/ConfigData.Federation.ServerAdminContext. Depending on the desired Administration URL for federation, this can be set to a few different values.
      • If the desired Admininstration URL for federation is to be the same as the external DNS (ArcGIS Server services URL), then this should be set to the same value as ConfigData.Federation.ServerContext. Typically this is the name of the ArcGIS Server web adaptor that will be used to access the site/publish services, etc.
      • If the desired Administration URL for federation is to be set as the internal ArcGIS Server Admin URL (ex. https://server.machine.com:6443/arcgis), then this attribute should be defined as arcgis.
    • This attribute is used to construct the ArcGIS Server Administration URL for federation. All portal and server administrative tasks will communicate through this URL.
Example usage of abovementioned attributes:
  • This example shows how the federation block attributes can be used to set the ArcGIS Server Administration URL to the internal ArcGIS Server Adminitration URL (https://server.machine.com:6443/arcgis)
{
    "AllNodes":
    {
        "NodeName": "example.node.com",
        "SslCertificates" : [
            "ImportCertificateChain": true,
            "ForceImport": true
        ]
    },
    "ConfigData": {
        "WebAdaptor": {
            "Installer": {
                "ApacheTomcat": {
                    "OldVersion": "9.0.19",
                    "OldServiceName": "Tomcat9"
                }
            },
            "IsJavaWebAdaptor": true,
            "JavaWebServerType": "ApacheTomcat10"
        },
        "Federation": {
            "ServerHostName": "external.dns.com",
            "ServerUrlPort": "443",
            "ServerContext": "server",
            "ServerAdminHostName": "server.machine.com",
            "ServerUrlPort": "6443",
            "ServerContext": "arcgis",
        }
    }
}
{
    "AllNodes":
    {
        "NodeName": "example.node.com",
        "SslCertificates" : [
            "ImportCertificateChain": true,
            "ForceImport": true
        ]
    },
    "ConfigData": {
        "WebAdaptor": {
            "Installer": {
                "ApacheTomcat": {
                    "OldVersion": "9.0.19",
                    "OldServiceName": "Tomcat9"
                }
            },
            "IsJavaWebAdaptor": true,
            "JavaWebServerType": "ApacheTomcat10"
        },
        "Federation": {
            "ServerHostName": "external.dns.com",
            "ServerUrlPort": "443",
            "ServerContext": "server",
            "ServerAdminHostName": "external.dns.com",
            "ServerUrlPort": "443",
            "ServerContext": "server",
        }
    }
}

Deprecated Variables and Attributes

AllNodes
  • AllNodes.WebAdaptorConfig.AdminAccessEnabled
    • Beginning at ArcGIS Web Adaptor v. 11.5+ , AdminAccessEnabled has been deprecated and will always be set as true.

Version 4.4.0 release of ArcGIS PowerShell DSC Module

Beginning at version 4.4.0 of the PowerShell DSC Module for ArcGIS, when -DebugSwitch is used with Invoke-ArcGISConfiguration -Mode Upgrade, the ArcGIS Server Administration API will set the enableDebug parameter to true.

In addition, starting at version 11.4, ArcGIS Data Store SSL Certificates are managed using different tooling. ArcGIS Data Store 11.3 and below utilize the updatesslcertificate.bat ArcGIS Data Store command-line utility to handle the import of the certificates. Starting at version 11.4 ArcGIS Data Store uses the replacesslcertificate.bat command-line utility. The ability to import web server ssl certificates into each Data Store type (via different ports) is supported as well.

JSON Configuration File Attribute Value Updates

  • ConfigData.Version - added accepted value of 11.4.

  • ConfigData.OldVersion - added accepted value of 11.3.

New Variable(s) and Attribute(s)

AllNodes
  • AllNodes.SslCertificates.Target
    • Optional. Only required when a domain or CA-signed certificate needs to be imported into a particular application's web server (i.e. 7443 for ArcGIS Portal, 6443 for ArcGIS Server, etc.)
    • This attribute now has additional functionality to support deploying SSL certificates into the different types of Data Store's running on ports other than 2443 (ArcGIS Data Store's default web server port). It now includes DataStore-Relational | DataStore-TileCache | DataStore-ObjectStore | DataStore-GraphStore.
    • A full list of allowed target components (array) on Node on which the certificate can be installed on [Server | Portal | WebAdaptor | DataStore | DataStore-Relational | DataStore-TileCache | DataStore-ObjectStore | DataStore-GraphStore].
ConfigData
ArcGIS Server

  • ConfigData.Server.Installer.DotnetDesktopRuntimeDownloadUrl

    • Optional. Only Required when ConfigData.Server.Installer.DotnetDesktopRuntimePath is specified and the installer does not yet exist. ConfigData.DownloadSetups must also be set to true.
    • String
    • Use this attribute to define the URL used to download the Dot Net Dekstop Runtime for SOE/SOI's. Only required when ConfigData.DownloadSetups is set to true and SOE/SOI's are required for the deployment.

  • ConfigData.Server.Installer.DotnetDesktopRuntimePath

    • Optional
    • String
    • Use this attribute to define the path of the Dot Net Desktop Runtime to be installed. If ConfigData.DownloadSetups is set to true and the ConfigData.Server.Installer.DotnetDesktopRuntimeDownloadUrl is defined, the value of this attribue will be the path on disk that the PowerShell DSC Module for ArcGIS will download and run the Dot Net Desktop Runtime executable. If ConfigData.DownloadSetups is set to false, then ensure the Dot Net Desktop Runtime is downloaded and staged in the appropriate location for the PowerShell DSC to deploy.
Portal for ArcGIS
GeoEvent Server
Workflow Manager Server
ArcGIS Pro
ArcGIS Desktop
Example usage of abovementioned attributes: 
"AllNodes":
    {
        "NodeName": "example.node.com",
        "SslCertificates" : [
            "Target": [
                "DataStore-Relational",
                "DataStore-TileCache",
                "DataStore-ObjectStore",
                "DataStore-GraphStore"
            ]
        ]
    }
"ConfigData": {
    "Server": {
        "Installer": {
            "DotnetDesktopRuntimeDownloadUrl": "https://download.visualstudio.microsoft.com/download/pr/907765b0-2bf8-494e-93aa-5ef9553c5d68/a9308dc010617e6716c0e6abd53b05ce/windowsdesktop-runtime-8.0.8-win-x64.exe",
            "DotnetDesktopRuntimePath": "C:\\Software\\Archives\\11.4\\windowsdesktop-runtime-8.0.8-win-x64.exe"
        }
    }
}

Deprecated Variables and Attributes

ArcGIS Desktop
  • ConfigData.DesktopVersion
    • At version 4.4.0 of the PowerShell DSC Module only supports the following values: 10.8.1 and 10.8.2. Support for 10.6, 10.6.1, 10.7, 10.7.1, ande 10.8 has been deprecated.

Version 4.3.0 release of ArcGIS PowerShell DSC Module

Beginning at version 4.3.0 of the PowerShell DSC Module for ArcGIS, the use of Environment Variables to store passwords was introduced. This functionality can help provide a secure method of storing passwords on the local machines as environment variables instead of generating encrypted password files or keeping the passwords in plain text in the JSON configuration file. For more details on how to configure the nodes and the JSON configuration file to use these attributes, please visit Use environment variables for passwords.

In addition, the ability to run webgisdr import and export processes via the PowerShell DSC Module for ArcGIS has also been introduced. Visit our help document on how to use webgisdr via the PowerShell DSC Module for ArcGIS for more information.

JSON Configuration File Attribute Value Updates

  • ConfigData.Version - added accepted value of 11.3.

  • ConfigData.OldVersion - added accepted value of 11.2.

New Variable(s) and Attribute(s)

AllNodes

  • AllNodes.ServerLicensePasswordEnvironmentVariableName

    • Optional, String
    • Use this attribute to define the environment variable name to use as the key to retrieve the desired password.
    • This attribute will override the following attributes if they are defined:
      • ConfigData.Server.LicensePassword
      • ConfigData.Server.LicensePasswordFilePath
    • Example usage: 
      "AllNodes": [
    {
        "NodeName": "machine.name.com",
        "Role": [
            "Server"
        ],
        "ServerLicensePasswordEnvironmentVariableName": "ARCGIS_SERVER_LICENSE_PASSWORD"
    }
]

  • AllNodes.GeoEventServerLicensePasswordEnvironmentVariableName

    • Optional, String
    • Use this attribute to define the environment variable name to use as the key to retrieve the desired password.
    • This attribute will override the following attributes if they are defined:
      • ConfigData.Server.LicensePassword
      • ConfigData.Server.LicensePasswordFilePath
      • ConfigData.GeoEvent.LicensePassword
      • ConfigData.GeoEvent.LicensePasswordFilePath
    • Example usage: 
      "AllNodes": [
    {
        "NodeName": "machine.name.com",
        "Role": [
            "Server"
        ],
        "GeoEventServerLicensePasswordEnvironmentVariableName": "ARCGIS_GEOEVENT_SERVER_LICENSE_PASSWORD"
    }
]

  • AllNodes.WorkflowManagerServerLicensePasswordEnvironmentVariableName

    • Optional, String
    • Use this attribute to define the environment variable name to use as the key to retrieve the desired password.
    • This attribute will override the following attributes if they are defined:
      • ConfigData.Server.LicensePassword
      • ConfigData.Server.LicensePasswordFilePath
      • ConfigData.WorkflowManagerServer.LicensePassword
      • ConfigData.WorkflowManagerServer.LicensePasswordFilePath
    • Example usage: 
      "AllNodes": [
    {
        "NodeName": "machine.name.com",
        "Role": [
            "Server"
        ],
        "WorkflowManagerServerLicensePasswordEnvironmentVariableName": "ARCGIS_WFM_SERVER_LICENSE_PASSWORD"
    }
]

  • AllNodes.ProLicensePasswordEnvironmentVariableName

    • Optional, String
    • Use this attribute to define the environment variable name to use as the key to retrieve the desired password.
    • This attribute will override the following attributes if they are defined:
      • ConfigData.Pro.LicensePassword
      • ConfigData.Pro.LicensePasswordFilePath
    • Example usage: 
      "AllNodes": [
    {
        "NodeName": "machine.name.com",
        "Role": [
            "Pro"
        ],
        "ProLicensePasswordEnvironmentVariableName": "ARCGIS_PRO_LICENSE_PASSWORD"
    }
]

  • AllNodes.SslCertificates.PasswordEnvironmentVariableName

    • Optional, String
    • Use this attribute to define the environment variable name to use as the key to retrieve the desired password.
    • Example usage: 
      "AllNodes": [
    {
        "NodeName": "machine.name.com",
        "Role": [
            "Server"
        ],
        "SslCertificates": [
            {
                "Path": "C:\\path\\to\\certificate.pfx",
                "PasswordEnvironmentVariableName": "ARCGIS_CERTIFICATE_PASSWORD",
                "CNameFQDN": "machine.name.com",
                "Target": [
                    "Server"
                ],
                "SslRootOrIntermediate": [
                    {
                        "Alias": "root_cert",
                        "Path": "C:\\path\\to\\root_cert.cer"
                    },
                    {
                        "Alias": "intermediate_cert",
                        "Path": "C:\\path\\to\\intermediate_cert.cer"
                    }
                ]
            }
        ]
    }
]
ConfigData

  • ConfigData.SkipPatchInstalls

    • Optional, Boolean (true | false). Default value is false.
    • When this attribute is set to true the ArcGIS Enterprise patches are not downloaded or installed.
    • This attribute overrides any PatchesDir inside the JSON configuration file. This allows a user to keep the ConfigData.*.Installer.PatchesDir in their JSON configuration files at all times without requiring the patches to be downloaded and installed each time.

  • ConfigData.ServiceAccount.PasswordEnvironmentVariableName

    • Optional, String
    • Use this attribute to define the environment variable name to use as the key to retrieve the desired password for the ArcGIS (Windows) Service Account.

  • ConfigData.AGOCredential.PasswordEnvironmentVariableName

    • Optional, String
    • Use this attribute to define the environment variable name to use as the key to retrieve the desired password of the ArcGIS Online credential used to download patches and installation media.

  • ConfigData.ADServiceUser.PasswordEnvironmentVariableName

    • Optional, String
    • Use this attribute to define the environment variable name to use as the key to retrieve the desired password of the Active Directory account to use for configuring Active Directory logins to ArcGIS Enterprise.
ArcGIS Server

  • ConfigData.Server.Installer.VolumePaths

    • Optional. Only Required when ConfigData.DownloadSetups is set to true.
    • Array of String(s)
    • As of ArcGIS Enterprise 11.3, the ArcGIS Server self-extracting package consists of two files with .exe and .exe.001 extensions. Specify the path to the exe.001 file, ensure that both files are in the same folder. Only required when ConfigData.DownloadSetups is set to true.

  • ConfigData.Server.LicensePasswordEnvironmentVariableName

    • Optional, String
    • Use this attribute to define the environment variable name to use as the key to retrieve the desired password for the ArcGIS Server License file.

  • ConfigData.Server.PrimarySiteAdmin.PasswordEnvironmentVariableName

    • Optional, String
    • Use this attribute to define the environment variable name to use as the key to retrieve the desired password for the Primary Site Administrator account for ArcGIS Server.

  • ConfigData.Server.ConfigStoreCloudStorageAccount.AzureBlobServicePrincipal.AuthorityHost

    • Required if ConfigData.Server.ConfigStoreCloudStorageAccount.AzureBlobAuthenticationType is set to ServicePrincipal.
    • Use this attribute to define the Azure Identity URL to use for the service principal credential.
Portal for ArcGIS

  • ConfigData.Portal.Installer.VolumePaths

    • Optional. Only Required when ConfigData.DownloadSetups is set to true.
    • Array of String(s)
    • As of ArcGIS Enterprise 11.3, the Portal for ArcGIS self-extracting package consists of two files with .exe and .exe.001 extensions. Specify the path to the exe.001 file, ensure that both files are in the same folder.

  • ConfigData.Portal.PortalAdministrator.PasswordEnvironmentVariableName

    • Optional, String
    • Use this attribute to define the environment variable name to use as the key to retrieve the desired password for the Inital Administrator Account for Portal for ArcGIS.

  • ConfigData.Portal.EmailSettings.PasswordEnvironmentVariableName

    • Optional, String. Only required with SMTP servers that require authentication.
    • Use this attribute to define the environment variable name to use as the key to retrieve the desired password for the smtp server configuration with Portal for ArcGIS.

  • ConfigData.Portal.PortalContentCloudStorageAccount.AzureBlobServicePrincipal.AuthorityHost

    • Required if ConfigData.Portal.PortalContentCloudStorageAccount.AzureBlobAuthenticationType is set to ServicePrincipal.
    • Use this attribute to define the Azure Identity URL to use for the service principal credential.

  • ConfigData.Portal.WebGISDR

    • This JSON object can be used to import/export a webgisdr backup into ArcGIS Enterprise.
    • Required to use -Mode WebGISDrExport or -Mode WebGISDrImport
    • This JSON object includes the following required sub-attributes:
      • ConfigData.Portal.WebGISDR.WebGISDRPropertiesFilePath
      • ConfigData.Portal.WebGISDR.TimeoutInMinutes
      • ConfigData.Portal.WebGISDR.RunAsAccount.UserName
      • ConfigData.Portal.WebGISDR.RunAsAccount.Password
      • ConfigData.Portal.WebGISDR.RunAsAccount.IsDomainAccount
      • ConfigData.Portal.WebGISDR.RunAsAccount.IsMSAAccount
GeoEvent Server
  • ConfigData.GeoEventServer.LicensePasswordEnvironmentVariableName
    • Optional, String
    • Use this attribute to define the environment variable name to use as the key to retrieve the desired password for the Primary Site Administrator account for ArcGIS GeoEvent Server.
Workflow Manager Server
  • ConfigData.WorkflowManagerServer.LicensePasswordEnvironmentVariableName
    • Optional, String
    • Use this attribute to define the environment variable name to use as the key to retrieve the desired password for the Primary Site Administrator account for ArcGIS Workflow Manager Server.
ArcGIS Pro

  • ConfigData.Pro.Installer.EdgeWebView2RuntimeDownloadUrl

    • Optional, String.
    • Only used for ArcGIS Pro 3.3 or above
    • Attribute used to define the desired url to download Edge Web View 2 Runtime.

  • ConfigData.Pro.Installer.EdgeWebView2RuntimePath

    • Required, String.
    • Only used for ArcGIS Pro 3.3 or above
    • Attribute used to define the path of the Edge Web View 2 Runtime.

    Note: If ConfigData.Pro.Installer.EdgeWebView2RuntimeDownloadUrl is defined, the Edge Web View 2 Runtime will be downloaded to the path defined in ConfigData.Pro.Installer.EdgeWebView2RuntimePath

ArcGIS Desktop
  • ConfigData.Desktop.LicensePasswordEnvironmentVariableName
    • Optional, String. Only required with SMTP servers that require authentication.
    • Use this attribute to define the environment variable name to use as the key to retrieve the desired password for the ArcGIS Desktop License file.
Example usage of abovementioned attributes: 
"ConfigData": {
    "Credentials": {
        "ServiceAccount": {
            "UserName": "arcgis",
            "PasswordEnvironmentVariableName": "ARCGIS_SVC_ACCT_PASSWORD",
            "IsDomainAccount": false
        },
        "AGOCredential": {
            "UserName": "agoluser",
            "PasswordEnvironmentVariableName": "AGOL_ACCT_PASSWORD"
        },
        "ADServiceUser": {
            "UserName": "adsvcuser",
            "PasswordEnvironmentVariableName": "AD_SVC_ACCT_PASSWORD"
        },
    },
    "Server": {
        "LicensePasswordEnvironmentVariableName": "ARCGIS_SERVER_LICENSE_PASSWORD",
        "Installer": {
            "VolumePaths": [
                "C:\\Path\\to\\ArcGIS_Server.exe.001"
            ]
        }
        "PrimarySiteAdmin": {
            "UserName": "siteadmin",
            "PasswordEnvironmentVariableName": "ARCGIS_SITEADMIN_PASSWORD"
        }
    },
    "Portal": {
        "LicensePasswordEnvironmentVariableName": "ARCGIS_PORTAL_LICENSE_PASSWORD",
        "VolumePaths": [
                "C:\\Path\\to\\Portal_for_ArcGIS.exe.001"
            ]
        "PortalAdministrator": {
            "UserName": "portaladmin",
            "Email": "[email protected]",
            "PasswordEnvironmentVariableName": "ARCGIS_PORTALADMIN_PASSWORD",
            "SecurityQuestionIndex": 1,
            "SecurityAnswer": "vanilla"
        },
        "EmailSettings":{
            "SMTPServerAddress": "smtp.domain.com",
            "AuthenticationRequired": true,
            "UserName": "smtpuser",
            "PasswordEnvironmentVariableName": "SMTP_ACCT_PASSWORD",
        },
        "WebGISDR": {
            "WebGISDRPropertiesFilePath": "C:\\Program Files\\ArcGIS\\Portal\\tools\\webgisdr\\webgisdr-properties-dsc.properties",
            "TimeoutInMinutes": 3600,
            "RunAsAccount":{
                "UserName": "arcgis",
                "Password": "password",
                "IsDomainAccount": false,
                "IsMSAAccount": false
            }
        }            
    },
    "GeoEventServer": {
        "LicensePasswordEnvironmentVariableName": "ARCGIS_GEOEVENT_SERVER_LICENSE_PASSWORD"
    },
    "WorkflowManagerServer": {
        "LicensePasswordEnvironmentVariableName": "ARCGIS_WFM_SERVER_LICENSE_PASSWORD"
    },
    "Pro": {
        "Installer": {
            "EdgeWebView2RuntimeDownloadUrl": "https://go.microsoft.com/fwlink/p/?LinkId=2124703",
            "EdgeWebView2RuntimePath": "C:\\path\\to\\MicrosoftEdgeWebview2Setup.exe"
        }
    },
    "Desktop": {
        "LicensePasswordEnvironmentVariableName": "ARCGIS_DESKTOP_LICENSE_PASSWORD"
    }
}

Deprecated Variables and Attributes

None.

Version 4.2.1 release of ArcGIS PowerShell DSC Module

JSON Configuration File Attribute Value Updates

  • ConfigData.InsightsVersion - added accepted value of 2023.2 and 2023.3.

  • ConfigData.OldInsightsVersion - added accepted value of 2023.1 and 2023.2.

New Variable(s) and Attribute(s)

ConfigData
  • ConfigData.DownloadSetupsToSharedPath
    • Optional, boolean - true | false
    • When set to true, setups will be downloaded to a shared path. The share path must pre-exist and the NT\Authority Local System account from each target node must have permissions to access the location.
    • Default value is false.

Deprecated Variables and Attributes

None.

Version 4.2.0 release of ArcGIS PowerShell DSC Module

JSON Configuration File Syntax Changes

  • AllNodes.Role no longer accepts ServerWebAdaptor or PortalWebAdaptor. These variables are replaced by WebAdaptor.

  • If WebAdaptor is listed in the AllNodes.Role array, then the AllNodes.WebAdaptorConfig attribute will also need to be added and each web adpator that will be installed on the node will need the appropriate attributes defined.

  • ConfigData.Version - added accepted value of 11.2.

  • ConfigData.ProVersion - added accepted value of 3.2.

  • ConfigData.LicenseManagerVersion - added accepted value of 2023.0.

  • ConfigData.InsightsVersion - added accepted value of 2023.1.

  • ConfigData.OldVersion - added accepted value of 11.1.

  • ConfigData.OldInsightsVersion - added accepted value of 2022.3.

New Variables and Attributes

ArcGIS Server

  • ConfigData.Server.ConfigStoreCloudStorageAccount.AzureBlobAuthenticationType

    • Required if ConfigData.Server.ConfigStoreCloudStorageAccount.CloudStorageType is set to AzureBlob.
    • Accepted values are: AccessKey,ServicePrincipal,UserAssignedIdentity, or SASToken.

  • ConfigData.Server.ConfigStoreCloudStorageAccount.AzureBlobUserAssignedIdentityClientId

    • Required if ConfigData.Server.ConfigStoreCloudStorageAccount.CloudStorageType is set to AzureBlob and ConfigData.Server.ConfigStoreCloudStorageAccount.AzureBlobAuthenticationType is set to UserAssignedIdentity.

  • ConfigData.Server.ConfigStoreCloudStorageAccount.AzureBlobServicePrincipal

    • Required if ConfigData.Server.ConfigStoreCloudStorageAccount.CloudStorageType is set to AzureBlob
    • This JSON object includes the following required sub-attributes:
      • ConfigData.Server.ConfigStoreCloudStorageAccount.AzureBlobServicePrincipal.TenantId
      • ConfigData.Server.ConfigStoreCloudStorageAccount.AzureBlobServicePrincipal.ClientId
      • ConfigData.Server.ConfigStoreCloudStorageAccount.AzureBlobServicePrincipal.ClientSecret
Portal for ArcGIS

  • ConfigData.Portal.PortalContentCloudStorageAccount.AzureBlobAuthenticationType

    • Required if ConfigData.Portal.ConfigStoreCloudStorageAccount.CloudStorageType is set to AzureBlob.
    • Accepted values are: AccessKey,ServicePrincipal,UserAssignedIdentity, or SASToken.

  • ConfigData.Portal.PortalContentCloudStorageAccount.AzureBlobUserAssignedIdentityClientId

    • Required if ConfigData.Portal.ConfigStoreCloudStorageAccount.CloudStorageType is set to AzureBlob and ConfigData.Portal.PortalContentCloudStorageAccount.AzureBlobAuthenticationType is set to UserAssignedIdentity.

  • ConfigData.Portal.PortalContentCloudStorageAccount.AzureBlobServicePrincipal

    • This JSON object defines the Azure Blob service principal account to be used for Azure Blob Storage. Required if ConfigData.Portal.ConfigStoreCloudStorageAccount.CloudStorageType is set to AzureBlob.
    • This JSON object includes the following required sub-attributes:
      • ConfigData.Portal.PortalContentCloudStorageAccount.AzureBlobServicePrincipal.TenantId
      • ConfigData.Portal.PortalContentCloudStorageAccount.AzureBlobServicePrincipal.ClientId
      • ConfigData.Portal.PortalContentCloudStorageAccount.AzureBlobServicePrincipal.ClientSecret
ArcGIS Data Store

  • ConfigData.DataStore.Backups.Relational.CloudStorageAccount.AWSS3Region

    • Required at version 11.2 and above if using S3 storage for ArcGIS Relational Data Store backups.

  • ConfigData.DataStore.Backups.TileCache.CloudStorageAccount.AWSS3Region

    • Required at 11.2 and above if using S3 storage for ArcGIS Tile Cache Data Store backups.

  • ConfigData.DataStore.Backups.SpatioTemporal.CloudStorageAccount.AWSS3Region

    • Required at 11.2 and above if using S3 storage for ArcGIS Spatiotemportal Big Data Store backups.

  • ConfigData.DataStore.Backups.ObjectStore

    • This JSON object includes the following sub-attributes:
      • ConfigData.DataStore.Backups.ObjectStore.Name
      • ConfigData.DataStore.Backups.ObjectStore.Type
      • ConfigData.DataStore.Backups.ObjectStore.Location
      • ConfigData.DataStore.Backups.ObjectStore.ForceBackupLocationUpdate
      • ConfigData.DataStore.Backups.ObjectStore.IsDefault
      • ConfigData.DataStore.Backups.ObjectStore.CloudStorageAccount.UserName
      • ConfigData.DataStore.Backups.ObjectStore.CloudStorageAccount.Password
      • ConfigData.DataStore.Backups.ObjectStore.CloudStorageAccount.PasswordFile
      • ConfigData.DataStore.Backups.ObjectStore.CloudStorageAccount.ForceUpdate
      • ConfigData.DataStore.Backups.ObjectStore.CloudStorageAccount.AWSS3Region
ArcGIS Web Adaptor

  • ConfigData.WebAdaptor.Installer.ApacheTomcat

    • Added support for Java based ArcGIS Web Adaptors using Apache Tomcat.
    • If desired, the PowerShell DSC Module can download, install, and/or configure Apache Tomcat web server on Windows.
    • This JSON object includes the following sub-attributes:
      • ConfigData.WebAdaptor.Installer.ApacheTomcat.Version - The version of Apache Tomcat that will be installed. Ensure that this version is supported by the desired version of the ArcGIS Web Adaptor software system requirements.
      • ConfigData.WebAdaptor.Installer.ApacheTomcat.Path - The path to the Apache Tomcat installer zip file.
      • ConfigData.WebAdaptor.Installer.ApacheTomcat.DownloadUrl - The download url to the Apache Tomcat installer zip file. When ConfigData.DownloadSetups is set to true, the zip file is downloaded from the specified url (for example, https://archive.apache.org/dist/tomcat/tomcat-9/v9.0.19/bin/apache-tomcat-9.0.19-windows-x64.zip) to the path specified for ConfigData.WebAdaptor.Installer.ApacheTomcat.Path (If a local path is specified and does not exist, the module will create it).
      • ConfigData.WebAdaptor.Installer.ApacheTomcat.InstallDir - The path where the component will be installed.
      • ConfigData.WebAdaptor.Installer.ApacheTomcat.ServiceName - The name of the ApacheTomcat Windows Service to be created.
      • ConfigData.WebAdaptor.Installer.ApacheTomcat.SSLProtocol - The desired TLS protocol settings. For example, TLSv1.3,TLSv1.2.

  • ConfigData.WebAdaptor.IsJavaWebAdaptor

    • Boolean true|false. Default value is false.
    • Set to true when installing ArcGIS WebAdaptor (Java) on Windows.

  • ConfigData.WebAdaptor.JavaWebServerWebAppDirectory

    • Full file path to the web server's application directory in which the arcgis.war file will be deployed to.
    • Required when ConfigData.WebAdaptor.IsJavaWebAdaptor is set to true

Deprecated Variables and Attributes

The following variables and/or attributes were removed from the variables reference page for v4.2.0 of the PowerShell DSC Module.

  • AllNodes.ServerContext
  • AllNodes.AdminAccessEnabled
  • AllNodes.PortalLicenseFilePath
  • AllNodes.PortalLicensePassword
  • AllNodes.PortalLicensePasswordFilePath

Version 4.1.0 release of ArcGIS PowerShell DSC Module

JSON Configuration Syntax Changes

  • ConfigData.Version - added accepted value of 11.1.

  • ConfigData.ProVersion - added accepted value of 3.1.

  • ConfigData.LicenseManagerVersion - added accepted value of 2022.1.

  • ConfigData.OldVersion - added accepted value of 11.0.

New Variables and Attributes

  • ConfigData.*.Installer.IsSelfExtracting

    Note: The '*' above indicates that this applies to all of the JSON object blocks under ConfigData that include an Installer object. For example, this applies to Portal, Server, DataStore, WebAdaptor, etc.

ArcGIS Server
  • ConfigData.Server.Extensions.*.Installer.IsSelfExtracting

    Note: The '*' above indicates that this applies to all of the JSON object blocks under ConfigData.Server.Extensions that include an Installer object. For example, this applies to DataInteroperability, DataReviewer, WorkflowManagerClassic, LocationReferencing, etc.

  • ConfigData.Server.SharedKey
Portal for ArcGIS
  • ConfigData.Portal.Installer.WebStylesInstallerIsSelfExtracting
  • ConfigData.Portal.PortalAdministrator.FullName
  • ConfigData.Portal.PortalAdministrator.Description
ArcGIS WebAdaptor
  • ConfigData.WebAdaptor.Installer.DotnetHostingBundlePath
  • ConfigData.WebAdaptor.Installer.WebDeployPath
  • ConfigData.WebAdaptor.Installer.DotnetHostingBundleDownloadUrl
  • ConfigData.WebAdaptor.Installer.WebDeployDownloadUrl
ArcGIS Desktop
  • ConfigData.Desktop.Extensions.*.Installer.IsSelfExtracting

    Note: The '*' above indicates that this applies to all of the JSON object blocks under ConfigData.Desktop.Extensions that include an Installer object. For example, this applies to DataInteroperability, DataReviewer, WorkflowManagerClassic, LocationReferencing, etc.

ArcGIS Pro
  • ConfigData.Pro.Installer.DotnetDesktopRuntimeDownloadUrl
  • ConfigData.Pro.Installer.DotnetDesktopRuntimePath
  • ConfigData.Pro.Extensions.*.Installer.IsSelfExtracting

    Note: The '*' above indicates that this applies to all of the JSON object blocks under ConfigData.Pro.Extensions that include an Installer object. For example, this applies to DataInteroperability.

Deprecated Variables and Attributes

None.

⚠️ **GitHub.com Fallback** ⚠️