v4.2.1 Variables reference page for JSON configuration files

When you edit the appropriate JSON file from our SampleConfigs folder for use in your PowerShell DSC for ArcGIS module, you replace the placeholder variables with information and parameters of your own. Refer to this list for a full guide to each variable found.

Note: Boolean (true|false) values should be all lowercase and without quotes.

• AllNodes - This contains all the nodes on which the components of ArcGIS Enterprise will be installed.
  • NodeName - Each node is represented by a node name, which can be a machine name or an IP address.
  • Role - The software component role of the node; this can accept one or multiple values as a comma-separated list. Enter in the order you want to execute the roles on the node.
    • Accepted values are Server, Portal, DataStore, WebAdaptor, RasterDataStoreItem, Desktop, Pro, LicenseManager, SQLServerClient, and FileShare.
  • WebAdaptorConfig - An array of web adaptors and their configurations for each node an ArcGIS Web Adaptor will be deployed.
    • Role - The component in which the Web Adaptor will be configured with. Accepted values are Portal, or Server.
    • Context - The name of the ArcGIS Web Adaptor.
    • AdminAccessEnabled - (Optional) This enables access to ArcGIS Server Manager and the ArcGIS Server Admin Directory. The default value is false. Overrides ConfigData.WebAdaptor.AdminAccessEnabled.
    • WebSiteId - (Optional) The WebSiteId parameter is used to specify the website where the ArcGIS Web Adaptor web application will be created. The value for WebSiteId is a number specific to each website on your server and assigned by IIS. The IDs for the websites on your server can be found in IIS Manager. The default website has a website ID of 1. By default, the WebSiteId parameter is set to the default website (even if multiple websites exist).
  • DataStoreTypes - This is a valid parameter when the node role is DataStore.
    • Accepted values are Relational | SpatioTemporal | TileCache | GraphStore | ObjectStore.
  • SslCertificates - (Optional) SSL Certificates specific to the node. This block is an array where each SSL Certificate in the array can target multiple components or each of them individually.
    • Path - The file path of your SSL Certificate. A local or network share address.
    • Password - The password of the SSL certificate to be installed.
    • PasswordFilePath - (Optional) Encrypted password file path of the SSL certificate to be installed.
    • CNameFQDN - Refers to a fully qualified domain name (CN/SAN) associated with the certificate.
    • Target - Target Components (array) on Node on which the Certificate will be installed on [Server | Portal | WebAdaptor | DataStore].
    • SslRootOrIntermediate - (Optional) - Can have multiple blocks of Root and Intermediate CA Certificates.
      • Alias - Root and Intermediate CA Certificate Alias.
      • Path - Root and Intermediate CA Certificate Path.
  • ServerLicenseFilePath - (Optional) License File Path to be used with the given Server installed on the Node. Overrides the file path given in "ConfigData" block.
  • ServerLicensePassword - (Optional) License Password associated with the Server License File.
  • ServerLicensePasswordFilePath - (Optional) Encrypted License Password File Path associated with the Server License File.
  • TargetNodeEncryptionCertificateFilePath - (Optional) The path to the public certificate key, used for encrypted Managed Object Format (MOF) files.
  • TargetNodeEncryptionCertificateThumbprint - (Optional) The certificate thumbprint, used for encrypted Managed Object Format (MOF) files. Required if TargetNodeEncryptionCertificateFilePath variable is defined.
• ConfigData - Each node requires this data. It contains some universal variables, as well as configuration variables specific to the roles specified above.
  • Version - The software version of the different components that will be installed or upgraded to. All components of your deployment should be at the same software version.
    • Accepted values for ArcGIS Enterprise: 10.7, 10.7.1, 10.8, 10.8.1, 10.9, 10.9.1, 11.0, 11.1, 11.2.
    • Accepted values for ArcGIS WebStyles: 10.7.1, 10.8, 10.8.1, 10.9, 10.9.1, 11.0, 11.1, 11.2.
    • Accepted Values for ArcGIS Notebook Server: 10.7, 10.7.1, 10.8, 10.8.1, 10.9, 10.9.1, 11.0, 11.1, 11.2.
    • Accepted values for ArcGIS Mission Server: 10.8, 10.8.1, 10.9, 10.9.1, 11.0, 11.1, 11.2.
  • DesktopVersion - The software version of the different components that will be installed or upgraded to. All components of your deployment should be at the same software version.
    • Accepted values: 10.6, 10.6.1, 10.7, 10.7.1, 10.8, 10.8.1, 10.8.2.
  • ProVersion - The software version of the different components that will be installed or upgraded to. All components of your deployment should be at the same software version.
    • Accepted values: 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 3.0.3, 3.1, 3.2.
  • LicenseManagerVersion - The software version of the different components that will be installed or upgraded to. All components of your deployment should be at the same software version.
    • Accepted values: 2018.0, 2018.1, 2019.0, 2019.1, 2019.2, 2020.0, 2020.1, 2021.0, 2021.1, 2022.0, 2022.1, 2023.0.
  • InsightsVersion - The software version of the different components that will be installed or upgraded to. All components of your deployment should be at the same software version.
    • Accepted values: 3.4, 3.4.1, 2020.1, 2020.2, 2020.3, 2021.1, 2021.1.1, 2021.2, 2021.2.1, 2021.3, 2021.3.1, 2022.1, 2022.1.1, 2022.2, 2022.3, 2023.1, 2023.2, 2023.3.
  • OldVersion - To be provided for upgrades only; this is the present version of the different components that will be upgraded.
    • Accepted values: 10.6, 10.6.1, 10.7, 10.7.1, 10.8, 10.8.1, 10.9, 10.9.1, 11.0, 11.1.
  • OldInsightsVersion - To be provided for upgrades only; this is the present version of ArcGIS Insights that will be upgraded.
    • Accepted values: 2020.3, 2021.1, 2021.1.1, 2021.2, 2021.2.1, 2021.3, 2021.3.1, 2022.1, 2022.1.1, 2022.2, 2022.3, 2023.1, 2023.2.
  • DownloadSetups - (Optional - true | false) - When set to true, the setups will be downloaded from the internet. Requires an ArcGIS Online username and password to be specified using ConfigData.Credentials.AGOCredential attribute. Default is false.
  • DownloadSetupsToSharedPath - (Optional - 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 is false.
  • DownloadPatches - (Optional - true | false) - When set to true, ArcGIS Enterprise patches will be downloaded from the internet. Requires ConfigData.*.Installer.PatchesDir attribute. Default is false.
  • ForceLicenseUpdate - (Optional - true | false) - Will force an update of ArcGIS Server license.
  • FileShareLocalPath - The local path of the file share on your remote file share machine, if you're using one.
  • FileShareName - The name of the file share on the remote machine.
  • ServerContext - The context of the Server's Web Adaptor. Global attribute (applies to all target nodes).
  • PortalContext - The context of the Portal's Web Adaptor.
  • ServerRole - The role value for a specialized GIS Server.
    • Accepted values are GeneralPurposeServer, GeoAnalytics, GeoEvent, ImageHosting, RasterAnalytics, NotebookServer, MissionServer, KnowledgeServer and WorkflowManagerServer.
  • AdditionalServerRoles - An array of additional server roles to be federated.
    • Accepted values are Geoevent, RasterAnalytics, WorkflowManagerServer, GeoAnalytics, and ImageHosting.
  • Credentials
    • ServiceAccount - The Windows user account that will be used to install and run the different services of the components.
      • UserName - Local or Domain ServiceAccount username. Note: If the local account does not yet exist, the module will create one.
      • Password - Local or Domain ServiceAccount password.
      • PasswordFilePath - (Optional) Path to an encrypted file that contains the local or domain ServiceAccount password.
      • IsDomainAccount - Set to true if the ServiceAccount is a domain account. Default is false.
      • IsMSAAccount - Set to true if the ServiceAccount is a group managed service account. Default is false.
      • ForceUpdate - Set to true if the ServiceAccount password has changed. Default is false.
    • AGOCredential
      • UserName - ArcGIS Online username. Note: SAML accounts are not supported at this release.
      • Password - ArcGIS Online password.
      • PasswordFilePath - (Optional) Path to an encrypted file that contains the ArcGIS Online password.
    • ADServiceUser - (Optional) An Active Directory Service account used for updating portal's identity store to use Active Directory users with portal-tier authentication. To enable Integrated Windows Authentication (web-tier authentication), please refer to Configure ArcGIS Web Adaptor to use IWA.
      • UserName - ADServiceUser Username in the format of Domain\\username
      • Password - ADServiceUser Password
      • PasswordFilePath - (Optional) Path to an encrypted file that contains the Local or ADServiceUser account password.
  • Server
    • Installer
      • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
      • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
      • InstallDir - The path where the Server component will be installed.
      • InstallDirPython - The path where the Python directory will be placed.
      • PatchesDir - (Optional) The path to a folder that contains patch installation (.msp) files.
      • PatchInstallOrder - (Optional) An array of patch installation (.msp) file names. The patches will be installed in the exact order listed.
      • EnableArcMapRuntime - (Optional) Boolean true|false. Enables or disables ArcMapRuntime during a fresh installation of 10.9.1 or upgrade to 10.9.1, default is true (only available for 10.9.1).
      • EnableDotnetSupport - (Optional) Boolean true|false. Enables .Net Extension Support during a fresh installation of 10.9.1 or upgrade to 10.9.1, default is false (only available for 10.9.1).
    • LicenseFilePath- The path where your [.pvrc] or [.ecp] license file from My Esri resides. (ImageServer, GeoEvent, GeoAnalytics, GeneralPurposeServer, MissionServer, NotebookServer)
    • LicensePassword - (Optional) License Password associated with the License File.
    • LicensePasswordFilePath - (Optional) Encrypted License Password File Path associated with the License File.
    • EnableHTTPSOnly - (Conditional) Boolean true|false. When true, HTTPS Only is enabled on ArcGIS Server. When false (default), HTTP and HTTPS is enabled.
    • EnableHSTS - (Optional) Boolean true|false. When true, HSTS is enabled on ArcGIS Server, and ConfigData.Server.EnableHTTPSOnly must also be set to true. Default value is false.
    • SharedKey - (Optional) The shared key should be set to 16 characters (any characters beyond 16 are not used).
    • DisableServiceDirectory - (Optional) Boolean true|false (default). Flag to enable/disable the HTML view of the ArcGIS Server services directory.
    • ConfigStoreLocation - If you're installing on a single machine, provide a local path; otherwise, provide a Network File Share path.
    • ServerDirectoriesRootLocation - If you're installing on a single machine, provide a local path; otherwise, provide a Network File Share path.
    • ServerDirectories - (Optional) A JSON object representing a collection of server directories to create.
    • ServerLogsLocation - (Optional) File path to the root of the log directories.
    • LocalRepositoryPath - (Optional) Directory where the local config-store is stored when site is in read-only mode.
    • ContainerImagePaths - Array of File Paths of Notebook Server Container Images to be uploaded to Docker Runtime using the PostInstallUtility.
    • ExternalLoadBalancer - External Load Balancer Endpoint fronting Web Adaptors. This parameter can be used to use alternate Load Balancer (HAProxy, Nginx, F5, etc.) to IIS-ARR Load Balancer. When set, this is used along with ConfigData.ServerContext parameter to set the WebContextURL property. This is also used for the federated Services URL.
    • InternalLoadBalancer - Internal Load Balancer endpoint fronting 6443 ports on Server Machines. This parameter can be used to use Load Balancer like (HAProxy, Nginx, F5, etc.). When set, this will be used for the federated Server Admin URL. The webcontext will be set to arcgis.
    • InternalLoadBalancerPort - (Optional) Internal Load Balancer port fronting 6443 ports on Server Machines. Default is 6443.
    • PrimarySiteAdmin - The ArcGIS Server Primary Site Administrator (PSA) account.
      • UserName - Username of the PrimarySiteAdmin account.
      • Password - Password of the PrimarySiteAdmin account.
      • PasswordFilePath - (Optional) Path to an encrypted file that contains the PrimarySiteAdmin account password.
    • ConfigStoreCloudStorageAccount
      • UserName - Azure Cloud Storage Account Blob Storage URL Endpoint (Ex. username.blob.core.windows.net), or Amazon Web Services (AWS) Access Key. If using AWS IAM Role, omit UserName.
      • Password - Azure Cloud Storage Account Secret Key, SAS Token, or Amazon Web Services (AWS) Secret Key. If using AWS IAM Role, omit Password.
      • PasswordFilePath - (Optional) Encrypted Azure\AWS Cloud Storage Account Secret Key file path.
      • CloudStorageType - Required - AzureBlob, AzureFiles, or AWSS3DynamoDB.
      • AzureFileShareName - Required if CloudStorageType is AzureFiles.
      • CloudNamespace - Required if using cloud storage - Unique identifiable string for your deployment to avoid conflicts.
      • AWSRegion - Required if using AWSS3DynamoDB cloud storage type.
      • AzureBlobAuthenticationType - Required if CloudStorageType is AzureBlob. Accepted values are: AccessKey,ServicePrincipal,UserAssignedIdentity, or SASToken.
      • AzureBlobUserAssignedIdentityClientId - Azure User Assigned Identity Client Id. Required if CloudStorageType is AzureBlob and AzureBlobAuthenticationType is UserAssignedIdentity.
      • AzureBlobServicePrincipal
        • TenantId - Azure Service Principal Tenant Id.
        • ClientId - Azure Service Principal Client Id.
        • ClientSecret - Azure Service Principal Client Secret.
    • ServerDirectoriesCloudStorageAccount
      • UserName - Azure Cloud Storage Account Blob Storage URL Endpoint (Ex. username.blob.core.windows.net)
      • Password - Azure Cloud Storage Account Secret Key
      • PasswordFilePath - (Optional) Encrypted Azure Cloud Storage Account Secret Key file path.
      • CloudStorageType - Required - This can only be set to AzureFiles.
      • AzureFileShareName - Required if CloudStorageType is AzureFiles
      • CloudNamespace - Required if using cloud storage - Unique identifiable string for your deployment to avoid conflicts
    • RegisteredDirectories - (Optional) An array of Local Data Directory blocks to be registered with the server.
      • Name - Name of the Local Data Directories
      • PhysicalPath - Physical path of the Data Directory. Can be a Local Path or Network Share Path
      • DirectoryType - Type of Directory. Example - CACHE | JOBS | OUTPUT
    • Databases - (Optional)
      • DatabaseServerHostName - FQDN of Database Server
      • DatabaseName - Name of the database
      • DatabaseType - AzureSQLDatabase | SQLServerDatabase | AzurePostgreSQLDatabase | AzureMISQLDatabase
      • DatabaseAdminUser -
        • UserName - DatabaseAdminUser Username
        • Password - DatabaseAdminUser Password
        • PasswordFilePath - (Optional) Encrypted DatabaseAdminUser Password File
      • SDEUser -
        • UserName - SDEUser Username
        • Password - SDEUser Password
        • PasswordFilePath - (Optional) Encrypted SDEUser Password File
      • DatabaseUser -
        • UserName - DatabaseUser Username
        • Password - DatabaseUser Password
        • PasswordFilePath - (Optional) Encrypted DatabaseUser Password File
      • IsManaged - (true | false)
      • EnableGeodatabase - (true | false)
    • Extensions
      • DataInteroperability
        • Installer
          • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
          • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
      • DataReviewer
        • Installer
          • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
          • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
      • WorkflowManagerClassic
        • Installer
          • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
          • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
        • Features
          • Server
          • WebViewers
          • ALL
      • LocationReferencing
        • Installer
          • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
          • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
        • Features
          • PipeServer
          • RHServer
          • EventEditor
          • RCE
          • RoadwayReporter
      • MappingChartingSolution
        • Installer
          • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
          • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
        • Features
          • DefenseMapping
          • Maritime
          • ALL
  • GeoEventServer
    • LicenseFilePath- The path where your [.pvrc] or [.ecp] license file from My Esri resides. (GeoEvent)
    • LicensePassword - (Optional) License Password associated with the License File.
    • LicensePasswordFilePath - (Optional) Encrypted License Password File Path associated with the License File.
    • Installer
      • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
      • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
      • PatchesDir - (Optional) The path to a folder that contains patch installation (.msp) files.
      • PatchInstallOrder - (Optional) An array of patch installation (.msp) file names. The patches will be installed in the exact order listed.
    • EnableGeoeventSDK - (Optional - true | false(Default)) - Enables GeoEvent SDK during installation.
    • UserBackupConfigFiles - Boolean true|false (Default). This is required and needs to be set to true when upgrading ArcGIS GeoEvent Server 10.x to 11.x. Before upgrading to a new version of GeoEvent Server, it is recommended that you export your GeoEvent Serverconfiguration using ArcGIS GeoEvent Manager and back up any installed or added components. The components are added to the following folder: <ArcGIS Server installation directory>\GeoEvent\deploy. When upgrading from a 10.x version to GeoEvent Server 11.x, your existing GeoEvent Server site configuration is not automatically upgraded during the installation. You need to manually import your configuration file after successful completion of the upgrade.
  • WorkflowManagerServer
    • LicenseFilePath- The path where your [.pvrc] or [.ecp] license file from My Esri resides. (WorkflowManagerServer)
    • LicensePassword - (Optional) License Password associated with the License File.
    • LicensePasswordFilePath - (Optional) Encrypted License Password File Path associated with the License File.
    • Installer
      • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
      • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
      • PatchesDir - (Optional) The path to a folder that contains patch installation (.msp) files.
      • PatchInstallOrder - (Optional) An array of patch installation (.msp) file names. The patches will be installed in the exact order listed.
  • WorkflowManagerWebApp
    • Installer
      • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
      • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
  • SQLServerClient
    • Name
    • InstallerPath
    • ProductId
    • Arguments
  • Portal
    • Installer
      • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
      • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
      • InstallDir - The path where the Portal component will be installed.
      • ContentDir - The Path where the initial site will be configured. This needs to be a Local Path.
      • WebStylesPath - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe (10.7.1 and above).
      • WebStylesInstallerIsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
      • PatchesDir - (Optional) The path to a folder that contains patch installation (.msp) files.
      • PatchInstallOrder - (Optional) An array of patch installation (.msp) file names. The patches will be installed in the exact order listed.
    • LicenseFilePath - The Path where your [.pvrc], [.ecp] or [.json] license file from My Esri resides.
    • PortalLicenseUserTypeId - License User Type Id to be assigned to the Primary Site Administrator account while creating a site.
      • Accepted Values: GISProfessionalStdUT | GISProfessionalBasicUT | GISProfessionalAdvUT | creatorUT. Please refer to the authorization json file for available options.
    • LicensePassword - (Optional) License Password associated with the License File.
    • LicensePasswordFilePath - (Optional) Encrypted License Password File Path associated with the License File.
    • PortalAdministrator - Portal for ArcGIS initial administrator account. For additional information check out the Portal for ArcGIS Initial Administrator Account variable wiki page.
      • FullName - The full name for the initial administrator account.
      • Description - An optional description for the initial administrator account.
      • UserName - The initial administrator account name.
      • Password - The password for the initial administrator account.
      • PasswordFilePath - (Optional) Path to an encrypted file that contains the PortalAdministrator password.
      • Email - The account email address.
      • SecurityQuestionIndex - The index of the secret question to retrieve a forgotten password. This is a numerical value, for the full list of the secret questions and their indexes visit the Security Question Index List.
      • SecurityAnswer - The answer to the secret question specified in the SecurityQuestionIndex parameter.
    • PortalContentCloudStorageAccount
      • UserName - Azure Cloud Storage Account Blob Storage URL Endpoint (Ex. username.blob.core.windows.net), or Amazon Web Services (AWS) Access Key. If using AWS IAM Role, omit UserName.
      • Password - Azure Cloud Storage Account Secret Key, SAS Token, or Amazon Web Services (AWS) Secret Key. If using AWS IAM Role, omit Password.
      • PasswordFilePath - (Optional) Encrypted Azure\AWS Cloud Storage Account Secret Key file path.
      • CloudStorageType - Required - AzureBlob, AzureFiles, or AWSS3DynamoDB. If specifying AWSS3DynamoDB or AzureBlob for the CloudStorageType, the CloudNameSpace must pre-exist.
      • AzureFileShareName - Required if CloudStorageType is AzureFiles
      • CloudNamespace - Required if using cloud storage - Unique identifiable string for your deployment to avoid conflicts
      • AWSRegion - Required if using AWSS3DynamoDB cloud storage type.
      • AzureBlobAuthenticationType - Required if CloudStorageType is AzureBlob. Accepted values are: AccessKey,ServicePrincipal,UserAssignedIdentity, or SASToken.
      • AzureBlobUserAssignedIdentityClientId - Azure User Assigned Identity Client Id. Required if CloudStorageType is AzureBlob and AzureBlobAuthenticationType is UserAssignedIdentity.
      • AzureBlobServicePrincipal
        • TenantId - Azure Service Principal Tenant Id.
        • ClientId - Azure Service Principal Client Id.
        • ClientSecret - Azure Service Principal Client Secret.
    • EmailSettings - Starting at version 10.8.1, this resource returns the email settings that have been configured for your organization. These settings can be used to send out email notifications from ArcGIS Enterprise portal about password policy updates and user type, add-on, or organization capability license expirations.
      • SMTPServerAddress - Your host SMTP server address.
      • From - Admin email address.
      • Label - Admin email address appearance.
      • AuthenticationRequired - Set this Boolean (true|false), if your host SMTP server requires authentication.
      • SMTPPort - port number for host SMTP server.
      • UserName - username for smtp account. Only required if AuthenticationRequired is set to true.
      • Password - password for smtp account. Only required if AuthenticationRequired is set to true.
      • PasswordFilePath - (Optional) Encrypted Password File Path.
      • EncryptionMethod - SSL | TLS | NONE.
    • ContentDirectoryLocation - The path where content of your new site will be initialized. Generally, it is the ContentDir mentioned above, followed by \arcgisportal\content, but it can be a completely independent path as well. For a Single Machine Portal this can be a Local Path (Ex. same as ContentDir), but for 2 Machine Portal this needs to be a Shared Location.
    • DisableServiceDirectory - (Optional) Boolean true|false (default). Flag to enable/disable the HTML view of the Portal for ArcGIS services directory.
    • DisableAnonymousAccess - (Optional) Boolean true|false (default). Flag to enable/disable anonymous access to Portal for ArcGIS.
    • EnableHSTS - (Optional) Boolean true|false. When true, HSTS is enabled. Default value is false.
    • EnableAutomaticAccountCreation - (Optional) Set this Boolean to enable Automatic Account Creation if Integrated Windows Authentication is enabled by specifying ADServiceUser Credential in the Credentials block.
    • DefaultRoleForUser - This property sets which role the portal automatically assigns to new accounts. For additional infomration see the Set User Default Settings documentation.
      • Values (10.8 and above): org_admin | org_publisher | org_user | iBBBBBBBBBBBBBBB (Data Editor) | iAAAAAAAAAAAAAAA (Viewer) | Custom role ID
      • Values (10.7.1 and below): account_user | account_publisher | custom_role_ID
    • DefaultUserLicenseTypeIdForUser - This property sets the default user type assigned to users during account creation and when creating built-in accounts. These user types must be compatible with the DefaultRoleForUser that has been specified.
      • Values: fieldWorkerUT | GISProfessionalStdUT | GISProfessionalBasicUT | GISProfessionalAdvUT | creatorUT | editorUT | viewerUT
    • ExternalLoadBalancer - External Load Balancer Endpoint fronting Web Adaptors. This parameter can be used to use alternate Load Balancer (HAProxy, Nginx, F5, etc.) to IIS-ARR Load Balancer. When set, this is used along with ConfigData.PortalContext parameter to set the WebContextURL property.
    • InternalLoadBalancer - Internal Load Balancer endpoint fronting 7443 ports on Portal Machines. This parameter can be used to use a Load Balancer (HAProxy, Nginx, F5, etc.). When set this will be used to set the privatePortalUrl property. The webcontext will be set to arcgis.
    • InternalLoadBalancerPort (Optional) Internal Load Balancer port fronting 7443 ports on Portal Machines. Default value is 7443.
  • DataStore
    • Installer
      • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
      • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
      • InstallDir - The path where the component will be installed.
      • InstallAllFeatures - (Optional) Boolean true|false (default). When set to true all features will be installed.
      • PatchesDir - (Optional) The path to a folder that contains patch installation (.msp) files.
      • PatchInstallOrder - (Optional) An array of patch installation (.msp) file names. The patches will be installed in the exact order listed.
    • ContentDirectoryLocation - The directory where the data store will be initialized.
    • EnableFailoverOnPrimaryStop - (Optional) Boolean (true|false). Set to true to enable failover to secondary when primary datastore is stopped. The default is false.
    • EnablePointInTimeRecovery - (Optional) Boolean (true|false). Set to true to enable point in time recovery.
    • Backups - (Optional)
      • Relational
        • Name - Backup Name
        • Type - Backup Type - fs|s3|Azure
        • Location - Specify a pre-existing backup location. fs - fileshare location|s3 - Bucket Name|Azure - Container Name
        • ForceBackupLocationUpdate - Boolean (true|false)
        • IsDefault - Boolean (true|false)
        • CloudStorageAccount -
          • UserName - s3 - AWS Access Id / Azure - Cloud Storage Account Account Name.
          • Password - s3 - AWS secret key / Azure - Cloud Storage Secret Key.
          • PasswordFile - (Optional) s3 - AWS secret key / Azure - Cloud Storage Secret Key.
          • ForceUpdate - Boolean (true|false).
          • AWSS3Region - The region in which the S3 bucket resides. Required at 11.2 and above.
      • TileCache
        • Name - Backup Name
        • Type - Backup Type - fs|s3|Azure
        • Location - Specify a pre-existing backup location. fs - fileshare location|s3 - Bucket Name|Azure - Container Name
        • ForceBackupLocationUpdate - Boolean (true|false)
        • IsDefault - Boolean (true|false)
        • CloudStorageAccount -
          • UserName - s3 - AWS Access Id / Azure - Cloud Storage Account Account Name
          • Password - s3 - AWS secret key / Azure - Cloud Storage Secret Key
          • PasswordFile - (Optional) s3 - AWS secret key / Azure - Cloud Storage Secret Key
          • ForceUpdate - Boolean (true|false)
          • AWSS3Region - The region in which the S3 bucket resides. Required at 11.2 and above.
      • SpatioTemporal
        • Name - Backup Name
        • Type - Backup Type - fs|s3|Azure
        • Location - Specify a pre-existing backup location. fs - fileshare location|s3 - Bucket Name|Azure - Container Name
        • ForceBackupLocationUpdate - Boolean (true|false)
        • IsDefault - Boolean (true|false)
        • CloudStorageAccount -
          • UserName - s3 - AWS Access Id / Azure - Cloud Storage Account Account Name
          • Password - s3 - AWS secret key / Azure - Cloud Storage Secret Key
          • PasswordFile - s3 - AWS secret key / Azure - Cloud Storage Secret Key
          • ForceUpdate - Boolean (true|false)
          • AWSS3Region - The region in which the S3 bucket resides. Required at 11.2 and above.
      • ObjectStore
        • Name - Backup Name
        • Type - Backup Type - fs|s3|Azure
        • Location - Specify a pre-existing backup location. fs - fileshare location|s3 - Bucket Name|Azure - Container Name
        • ForceBackupLocationUpdate - Boolean (true|false)
        • IsDefault - Boolean (true|false)
        • CloudStorageAccount -
          • UserName - s3 - AWS Access Id / Azure - Cloud Storage Account Account Name
          • Password - s3 - AWS secret key / Azure - Cloud Storage Secret Key
          • PasswordFile - s3 - AWS secret key / Azure - Cloud Storage Secret Key
          • ForceUpdate - Boolean (true|false)
          • AWSS3Region - The region in which the S3 bucket resides. Required at 11.2 and above.
  • DataStoreItems - Only RasterStore is being tested and supported as of now. We may support Folder, CloudStore and BigDataFileShare in future releases.
    • RasterStore
      • FileShareName - The name of the raster file share
      • FileShareLocalPath - The local path of the raster file share on a specified machine (Only required when a new file share needs to be created)
      • ExternalFileSharePath - Reference an external raster file share
  • WebAdaptor
    • Installer
      • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
      • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
      • DotnetHostingBundlePath - The path to the Microsoft .Net Hosting Bundle exe file. For example, C:\\Software\\dotnet-hosting-6.0.9-win.exe.
      • DotnetHostingBundleDownloadUrl - The download Url to the Microsoft .Net Hosting Bundle exe file. When ConfigData.DownloadSetups is set to true, the exe file is downloaded from the specified Url to the path specified for DotnetHostingBundlePath (If a local path is specified and does not exist, the module will create it). For example, https://download.visualstudio.microsoft.com/download/pr/eaa3eab9-cc21-44b5-a4e4-af31ee73b9fa/d8ad75d525dec0a30b52adc990796b11/dotnet-hosting-6.0.9-win.exe
      • WebDeployPath - The path to the Web Deploy MSI file. For example, C:\\Software\\WebDeploy_amd64_en-US.msi
      • WebDeployDownloadUrl - The download Url to the Web Deploy MSI file. When ConfigData.DownloadSetups is set to true, the Web Deploy MSI file is downloaded from the specified Url to the path specified for WebDeployPath(If a local path is specified and does not exist, the module will create it). For example, https://download.microsoft.com/download/0/1/D/01DC28EA-638C-4A22-A57B-4CEF97755C6C/WebDeploy_amd64_en-US.msi
      • PatchesDir - (Optional) The path to a folder that contains patch installation (.msp) files.
      • PatchInstallOrder - (Optional) An array of patch installation (.msp) file names. The patches will be installed in the exact order listed.
      • ApacheTomcat
        • Version - The version of Apache Tomcat that will be installed.
        • Path - The path to the Apache Tomcat installer zip file.
        • 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 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). For example, https://archive.apache.org/dist/tomcat/tomcat-9/v9.0.19/bin/apache-tomcat-9.0.19-windows-x64.zip
        • InstallDir - The path where the component will be installed.
        • ServiceName - The name of the ApacheTomcat Windows Service to be created.
        • SSLProtocol - The desired TLS protocol settings. For example, TLSv1.3,TLSv1.2.
    • AdminAccessEnabled - (Optional) This enables access to ArcGIS Server Manager and the ArcGIS Server Admin Directory. The default value is false. Global attribute (applies to All target nodes).
    • WebSiteId - (Optional) The WebSiteId parameter is used to specify the website where the ArcGIS Web Adaptor web application will be created. The value for WebSiteId is a number specific to each website on your server and assigned by IIS. The IDs for the websites on your server can be found in IIS Manager. The default website has a website ID of 1. By default, the WebSiteId parameter is set to the default website (even if multiple websites exist).
    • OverrideHTTPSBinding - (Optional) Boolean true|false. Default is true, when set to false an existing SSL Certificate must already exist in IIS and be assigned to the 443 binding.
    • IsJavaWebAdaptor - (Conditional) Boolean true|false. Default is false, set to true when installing ArcGIS WebAdaptor (Java) on Windows.
    • JavaWebServerWebAppDirectory - Full file path to the web server's application directory in which the arcgis.war file will be deployed to.
  • Insights
    • Installer
      • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
      • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
  • Federation - (Required only when deploying a federated GIS server role)
    • PortalHostName - (Optional) The hostname of the portal with which you're federating the server. Required when federating a specialized server with a remote portal. (Needs to be a Fully Qualified Domain Name)
    • PortalPort - (Optional) The port number of the portal with which you're federating the server. Required when federating a specialized server with a remote portal.
    • PortalContext - (Optional) The context of the portal with which you're federating the server. Required when federating a specialized server with a remote portal.
    • PortalAdministrator - A primary admin user for the portal with which the GIS Server site will be federated.
      • UserName - Username of the PortalAdministrator.
      • Password - Password of the PortalAdministrator.
      • PasswordFilePath - (Optional) Path to an encrypted file that contains the PortalAdministrator password.
    • RestrictedPublishing - (Optional) Boolean true|false (default). When set to true, a federate server will be set to restricted publishing.
  • Desktop
    • Installer
      • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
      • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
      • InstallDir - The path where the Desktop component will be installed.
      • InstallDirPython - The path where the Python directory required by Desktop will be installed.
      • PatchesDir - (Optional) The path to a folder that contains patch installation (.msp) files.
    • Extensions
      • DataInteroperability
        • Installer
          • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
          • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
      • DataReviewer
        • Installer
          • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
          • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
      • WorkflowManagerClassic
        • Installer
          • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
          • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
        • Features
          • Desktop
          • TAM
          • ALL
      • LocationReferencing
        • Installer
          • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
          • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
        • Features
          • PipelineReferencing
          • Roads
      • MappingChartingSolution
        • Installer
          • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
          • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
        • Features
          • EsriProductionMapping
          • TAM
          • AviationCharting
          • FederalCharting
          • MaritimeCharting
          • EsriDefenseMapping
      • BackgroundGP64Bit
        • Installer
          • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
          • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
    • LicenseFilePath- The path where your [.pvrc] license file from My Esri resides.
    • LicensePassword - (Optional) License Password associated with the License File.
    • LicensePasswordFilePath - (Optional) Encrypted License Password File Path associated with the License File.
    • SeatPreference - (Required)
      • Fixed - Installs your ArcGIS software class as a Single Use seat..
      • Float - Installs your ArcGIS software class as a Concurrent Use seat.
    • InstallFeatures - Applications to install all Application subfeatures. ALL | (,,..). Possible values for subfeatures.
      • Applications - ArcMap, ArcCatalog
      • Miscellaneous features - Python
      • Extensions - Ext_3D_Analyst, ArcScan, GeoStatisticalAnalyst, ArcMap_Publishing_Extension, SpatialAnalyst, Schematics, NetworkAnalyst, TrackingAnalyst
      • Styles - CivicAndBusiness, NaturalResources
      • Templates - TemplateGeneral, TemplateIndustry, TemplateWorld, TemplateUSA
    • ModifyFlexdAcl - (Optional) true | false (Default). Enabling this property to true alters the following permissions to allow management of the FlexNet anchor service by any user: SERVICE_QUERY_CONFIG, SERVICE_QUERY_STATUS, SERVICE_ENUMERATE_DEPENDENTS, SERVICE_START SERVICE_INTERROGATE, SERVICE_USER_DEFINED_CONTROL, READ_CONTROL
    • EnableEUEI - true (Default - Enables participation of Esri User Experience Improvement Program) | false (Does not enable participation in the Esri User Experience Improvement.).
    • SoftwareClass - Viewer | Editor | Professional.
      • Viewer - (Required) Installs ArcGIS Desktop as Basic (ArcView).
      • Editor - Installs ArcGIS Desktop as Standard (ArcEditor).
      • Professional - Installs ArcGIS Desktop as Advanced (ArcInfo).
    • BlockAddIns - (Optional)
      • 0 - Load all add-ins regardless of whether they have digital signatures.
      • 1 - Only load and use add-ins that are digitally signed by a trusted certificate authority.
      • 2 - Only load and use add-ins that have been published by Esri.
      • 3 - Only load add-ins from the administrator folders and all add-ins published by Esri.
      • 4 - Do not load or execute add-ins in this application.
    • DesktopConfig - (Required - if you supply ESRI_LICENSE_HOST, SOFTWARE_CLASS, and SEAT_PREFERENCE on the command line.) Setting this parameter to true will prevent ArcGIS Administrator Wizard from being launched automatically at the end of the setup.
    • EsriLicenseHost - (Required for when SEAT_PREFERENCE is set to Concurrent Use) Machine name where license manager is installed.
  • Pro
    • Installer
      • Path - The path to the self extracting setup archive file you downloaded from My Esri.
      • IsSelfExtracting - boolean true|false. Default is true. Set to false if using the MSI.
      • DotnetDesktopRuntimeDownloadUrl - The download Url to the Microsoft .Net Desktop Runtime exe file. When ConfigData.DownloadSetups is set to true, the exe file is downloaded from the specified Url to the path specified for DotnetDesktopRuntimePath (If a local path is specified and does not exist, the module will create it). For example, https://download.visualstudio.microsoft.com/download/pr/5681bdf9-0a48-45ac-b7bf-21b7b61657aa/bbdc43bc7bf0d15b97c1a98ae2e82ec0/windowsdesktop-runtime-6.0.5-win-x64.exe.
      • DotnetDesktopRuntimePath - The path to the Microsoft .Net Desktop Runtime exe file. For example, C:\\Software\\windowsdesktop-runtime-6.0.5-win-x64.exe.
      • InstallDir - The path where the Pro component will be installed.
      • PatchesDir - (Optional) The path to a folder that contains patch installation (.msp) files.
    • Extensions
      • DataInteroperability
        • Installer
          • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
          • IsSelfExtracting - boolean true|false. Default is true. Set to false if using the MSI.
    • LicenseFilePath- The path where your [.pvrc] license file from My Esri resides.
    • LicensePasswordFilePath - (Optional) Encrypted License Password File Path associated with the License File.
    • LicensePassword - (Optional) License Password associated with the License File.
    • AuthorizationType -
      • SINGLE_USE - install ArcGIS Pro as a Single Use seat;
      • CONCURRENT_USE - install as a Concurrent Use seat;
      • NAMED_USER - uses a Named User license.
    • LockAuthSettings - true(Default) | false. During a silent, per-machine installation of ArcGIS Pro, if the authorization type is defined, this is set to true under HKEY_LOCAL_MACHINE\SOFTWARE\Esri\ArcGISPro\Licensing. When LOCK_AUTH_SETTINGS is true, the licensing settings in the registry apply to all ArcGIS Pro users on that machine; an individual user cannot make changes. To allow ArcGIS Pro users on the machine to define their own authorization settings through the ArcGIS Pro application, set LOCK_AUTH_SETTINGS to false. This property does not apply to a per-user installation.
    • BlockAddIns - If specified, the BlockAddins registry value allows system administrators to configure the types of add-ins that ArcGIS Pro will load. It is created under HKEY_LOCAL_MACHINE\SOFTWARE\Esri\ArcGISPro\Settings. This property is only read during a per-machine installation; it is ignored if specified for a per-user setup.
      • 0 will load all add-ins, regardless of whether they have digital signatures.
      • 1 will only load add-ins that are digitally assigned by a trusted certificate authority.
      • 2 will only load add-ins that have been published by Esri.
      • 3 will only load add-ins from the administrator folders and those published by Esri.
      • 4 will not load or execute add-ins.
      • 5 will only load add-ins from the administrator folders. Level 0 is the default.
    • SoftwareClass - Viewer | Editor | Professional.
    • PortalList - To add one or more portal connections to the Portals page. Use semicolons to separate portal URLs. Example value - <portalURL1>; <portalURL2>
    • AllUsers - Defines the installation context of the ArcGIS Pro setup, where ALLUSERS=1 specifies a per-machine install. If this parameter is not specified, the installation defaults to per-machine. If a user without administrative privileges attempts to set ALLUSERS=1, the installation fails. ALLUSERS=2, per-user install, is not supported.
    • EsriLicenseHost - Specifies the host name of the license manager. Multiple license servers can be defined by separating the host names with a semicolon; for example, @primaryLM;@backupLM2;@backupLM3.
    • EnableEUEI - true (Default - Enables participation of Esri User Experience Improvement Program) | false (Does not enable participation in the Esri User Experience Improvement.).
    • CheckForUpdatesAtStartup - true (Default enables automatic update notifications of ArcGIS Pro) | false.
  • LicenseManager
    • LicenseFilePath - The path where your [.prvs] license file from My Esri resides.
    • Installer
      • Path - The path to the self extracting setup archive file you downloaded from My Esri or the already extracted Setup.exe.
      • IsSelfExtracting - boolean true|false. Default is true. Set to false if using a pre-extracted setup.exe.
      • InstallDir - The path where the License Manager component will be installed.