V2. Variables reference page for JSON configuration files - Esri/arcgis-powershell-dsc GitHub Wiki

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.

  • 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', 'ServerWebAdaptor', 'PortalWebAdaptor', 'LoadBalancer', 'RasterDataStoreItem', 'Desktop', 'Pro' and 'LicenseManager'.
    • DataStoreTypes - This is a valid parameter when the node role is 'DataStore'. Valid values are 'Relational | SpatioTemporal | TileCache'.
    • 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.
      • Alias - The alias with which the certificate will be used. The alias refers to a fully qualified domain name (CN/SAN) associated with the certificate and is not the same as the parameter of the Portal Admin REST API operation "importExistingServerCertificate".
      • Target - Target Components (array) on Node on which the Certificate will be installed on [Server | Portal | WebAdaptor | LoadBalancer].
    • PortalLicenseFilePath - (Optional) License File Path to be used with the given Portal installed on the Node. Overrides the file path given in "ConfigData" block.
    • PortalLicensePassword - (Optional) License Password associated with the Portal License File.
    • 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.
  • 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.
    • 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.
    • 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.
    • 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.
    • OldVersion - To be provided for upgrades only; this is the present version of the different components that will be upgraded.
    • 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.
    • 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.
    • ServerContext - The context of the Server's Web Adaptor.
    • 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' and 'RasterAnalytics'.
    • SevenZipInstallerDir - The path where the 7-Zip setup will be installed.
    • SevenZipInstallerPath - The path to the 7-Zip MSI Installer file.
    • Credentials
      • ServiceAccount - The Windows user account that will be used to install and run the different services of the components. Set the 'IsDomainAccount' Parameter to 'true' if the ServiceAccount is a domain account.
      • PrimarySiteAdmin - A primary administrator user for the different components of ArcGIS Enterprise.
      • ADServiceUser - An Active Directory Service user for enabling use of Integrated Windows Authentication with your portal.
    • 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
    • Server
      • Installer
        • Path - The path to the server Installer file you downloaded from My Esri.
        • InstallDir - The path where the Server component will be installed.
        • InstallDirPython - The path where the Python directory required by Server will be installed.
        • PatchesDir - (Optional)
      • LicenseFilePath- The path where your [.pvrc] or [.ecp] license file from My Esri resides. (ImageServer, GeoEvent, GeoAnalytics, GeneralPurposeServer)
      • LicensePassword - (Optional) License Password associated with the License File.
      • 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.
      • RegisteredDirectories - (Optional) An array of Local Data Directory blocks to be registered with 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
    • Portal
      • Installer
        • Path - The path to the portal Installer file you downloaded from My Esri.
        • 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 Portal Web Styles Installer file you downloaded from My Esri. Required parameter starting 10.7.1.
        • PatchesDir - (Optional)
      • LicenseFilePath - The Path where your [.pvrc], [.ecp] or [.json] license file from My Esri resides.
      • PortalLicenseUserType - Licence User Type Name to be assigned to the Primary Site Administrator account while creating a site.
      • LicensePassword - (Optional) License Password associated with the License File.
      • 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.
      • EnableAutomaticAccountCreation - (Optional) Set this Boolean to enable Automatic Account Creation if Integrated Windows Authentication is enabled by specifying 'ADServiceUser' Credential in the Credentials block.
    • DataStore
      • Installer
        • Path - The path to the data store Installer file you downloaded from My Esri.
        • InstallDir - The path where the component will be installed.
        • PatchesDir - (Optional)
      • ContentDirectoryLocation - The directory where the data store will be initialized.
    • DataStoreItems - Only RasterStore is being tested and supported as of now. We will 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 web adaptor's Installer file that should be installed.
      • AdminAccessEnabled - (Optional) This enables access to ArcGIS Server Manager and the ArcGIS Server Admin Directory. The default value is false.
    • LoadBalancer - Load Balancer requires IIS URL Rewrite Module 2 and Microsoft Application Request Routing 3.0
      • InstallerPath - Array of two blocks giving details of the modules that need to be installed to make Load Balancer work
        • FilePath - File Path of Module.
        • Name - Name of the Module.
        • ProductId - Product Id of the Module.
    • 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.
      • PrimarySiteAdmin - A primary admin user for the portal with which the GIS Server site will be federated.
    • Desktop
      • Installer
        • Path - The path to the Desktop Installer file you downloaded from My Esri.
        • 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)
      • LicenseFilePath- The path where your [.pvrc] or [.ecp] license file from My Esri resides.
      • LicensePassword - (Optional) License Password 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 Pro Installer file you downloaded from My Esri.
        • InstallDir - The path where the Pro component will be installed.
        • PatchesDir - (Optional)
      • LicenseFilePath- The path where your [.pvrc] or [.ecp] license file from My Esri resides.
      • 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 and ALLUSERS=2 is a per-user instance. If this parameter is not specified, the installation defaults to per user. If a user without administrative privileges attempts to set ALLUSERS=1, the installation fails.
      • 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
      • Installer
        • Path - The path to the License Manager Installer file you downloaded from My Esri.
        • InstallDir - The path where the License Manager component will be installed.
⚠️ **GitHub.com Fallback** ⚠️