SPDocKit
Try it for FreeContact UsProduct Site
  • SPDocKit by Syskit
  • Release Notes
    • SPDocKit 12
    • SPDocKit 11.1.0
    • SPDocKit 11
    • SPDocKit 10
    • SPDocKit 9.1.0
    • SPDocKit 9
    • SPDocKit 8.0.3
    • SPDocKit 8
  • Requirements
    • SharePoint On-Premises User Permissions Requirements
    • Supported SharePoint Editions
    • System Requirements
    • Server Load Permission Requirements
    • Service Application Permission Requirements
  • Installation
    • Install SPDocKit
    • Upgrade to the Latest Version
    • Uninstall SPDocKit
  • Activation
    • Activate SPDocKit
    • Manage License
    • Activation Privacy Statement
  • Configuration
    • Configure SPDocKit
    • Configure SPDocKit Database
    • Import and Export SPDocKit Settings
  • Create SharePoint Farm Snapshots
    • Snapshots Screen
    • Manual Snapshots
    • Automatic Snapshots
  • Explore Reports & Create Documentation
    • Farm Explorer
      • Farm Explorer Screen
      • Farm Dashboard
      • Farm Explorer Reports
      • Farm Documentation
      • Passwords and Product keys
      • Generate an AutoSPInstaller XML Configuration File
      • Change the Limit on Site Topology Report
    • Site Explorer
      • Site Explorer Screen
    • Permission Reports
      • Permissions Reports screen
    • Analytics and Usage Reports
      • Analytics and Usage Reports Screen
      • Analytics Dashboard
      • Site Collection Analytics
      • Document Extensions Reports
    • Audit Reports
      • Audit Reports Screen
      • Audit Dashboard
      • Audit Log Details
      • Administrative Actions
      • Audit Settings
    • Best Practices
      • Best Practices Screen
      • Best Practices Reports
    • Subscriptions and Alerts
      • Subscriptions and Alerts
      • Create New Subscription
      • Create New Alert
    • Customizing Reports
      • Customize View
      • Add Comments
  • Compare SharePoint Configurations
    • Compare Wizard
    • Compare SharePoint Farms
    • Compare Servers
    • Compare Web Applications
    • Compare Site Collections
    • Compare SharePoint Permissions
    • Compare Web.Config Files
  • Manage SharePoint Permissions
    • Permissions Explorer Screen
    • Manage Permissions Ribbon Actions
    • Users and Groups Actions
      • Manage Groups Wizard
      • Group Memberships Wizard
      • Copy Permissions Wizard
      • Move Permissions Wizard
      • Manage Permissions Wizard
      • Remove Permissions Wizard
    • Securable Objects Actions
      • Break/Restore Permission Inheritance Wizard
      • Restore Permissions
      • Copy Object Permissions Wizard
    • Site Collection Actions
      • Site Collection Administrators Wizard
      • Permission Levels Wizard
      • Clean Site Collections Wizard
    • Add Tags
    • SPDocKit Permission Management Event Log
  • Configure & Extend SPDocKit
    • Backstage Screen
    • Options Wizard
    • License Management
    • Role Based Security
    • Extend SPDocKit
      • Install SPDocKit Extensions
      • Download SPDocKit Extensions
      • Activate SPCAF Extension
  • Query & Change SharePoint Settings
    • Queries and Rules Screen
    • Create SharePoint Governance Policy Rule
    • Create SPDocKit Query
    • Change SPDocKit Query Results Limit
    • Create Audit Queries and Rules
  • FAQ
    • Requirements
    • Installation
    • Activation
    • Configuration
    • Features
    • Security
    • Miscellaneous
    • SPDocKit Insights Removed
    • SPDocKit Insights Migration
  • Known Issues
    • CREATE TABLE permissions denied
    • Custom features missing in reports
    • Data retention not working properly
    • Distributed Cache loading issue
    • Load crashes with NullReference exception
    • Available Windows updates
    • Permissions Wizard issue
    • PowerPivot FileNotFoundException issue
    • SQL Clusters support
    • Storage Metrics report subscription
    • Unaccounted differences in the UPA settings
    • Custom Query issue with URL export
    • Recursive groups issue with export
  • Troubleshooting
    • SharePoint
      • Could not access content database
      • The service application ‘UPA Name’ does not have any proxies that are default in a proxy group
    • Server Load & User Permissions
      • RPC Server is Unavailable
      • Error occurred while loading Web Application
      • Error occurred while trying to load 'Problems and Solutions' and 'Rule Definitions'
      • Error while loading IIS Settings Information
      • Errors while trying to load the SharePoint farm
      • Errors while loading server information
      • Failed at retrieving SQL Accounts from the following servers
      • My permissions loading status is reported as ”Failed”
      • Service was unable to read Active Directory properties
      • SQL Server is unavailable
      • Error adding service account to "spdockit_service_role" database role
    • SQL Server Connection
      • SPDocKit won’t connect to a provided server and database
      • Configure SQL server to listen on a specific port
      • Is SQL Server configured to use a named instance
      • Inbound traffic on TCP Port 1433 needs to be allowed on the SQL
      • Service user does not have rights to connect to the SQL server
      • TCP/IP network traffic not enabled on the SQL Server
Powered by GitBook
On this page
  • What is AutoSPInstaller?
  • How to generate an AutoSPInstaller XML Configuration File?

Was this helpful?

  1. Explore Reports & Create Documentation
  2. Farm Explorer

Generate an AutoSPInstaller XML Configuration File

This article describes how to generate an AutoSPInstaller XML configuration file.

PreviousPasswords and Product keysNextChange the Limit on Site Topology Report

Last updated 2 years ago

Was this helpful?

What is AutoSPInstaller?

SPDocKit offers a feature that can generate an XML configuration file, which you can use later with when creating new SharePoint farms. It helps you create farms that are identical or as similar as possible to your current environment.

AutoSPInstaller is an open-source project by Brian Lalancette. It's based on PowerShell scripts that are used when installing and configuring SharePoint farms. It provisions SharePoint farms automatically, assisting SharePoint admins with their SharePoint farms.

This feature allows you to create an AutoSPInstaller script based on previously loaded farm settings using SPDocKit. Once you load SharePoint farm settings and you are happy with your farm configuration, you can create a copy of that environment using the Save XML configuration feature.

SPDocKit gathers all the relevant data from your farm, and allows you to modify the settings. It then creates an XML file containing the settings of the selected SharePoint farm, such as services and Web applications, as well as managed accounts or host named mappings.

The combination of SPDocKit and AutoSPInstaller is a tremendous time-saver when you have to create two identical farms. It bypasses the painstaking manual configuration of those farms and it gives administrators the ability to copy the configuration of one farm quickly to another and then deploy it.

How to generate an AutoSPInstaller XML Configuration File?

To generate an AutoSPInstaller XML configuration file, follow these instructions:

  1. Open an existing snapshot or create a new one.

  2. Navigate to the Farm Explorer in the navigation bar and click Save XML Configuration from the Farm Explorer Home ribbon.

  3. The AutoSPInstaller Configuration File Wizard will open, and under General Settings choose where you wish to save your file and the Web applications and services you wish to include. Click Next to continue.

  4. Specify the farm account and the general farm configuration for your new farm. Click Next to continue.

  5. In the next few steps, define the Server Mappings, SQL Server Mappings and Account Mappings. The current farm server and account names will be listed under the source column. Use the Replace option to rename multiple target farm server and account names at once. For SharePoint 2016 FP1 farms, you can define MinRoles as well.

  6. On the Managed Account Settings tab, provide the passwords for your managed accounts. This is an optional step, but you can use the Auto Fill All Credentials button to retrieve the credentials from the current farm.

  7. Depending on what you selected in the General Settings section, you will be asked to provide the login data for Unattended Accounts, such as for Visio or PerformancePoint Service Account. Click Next to continue to Service Application Settings.

  8. On the Service Application Settings tab lets you setup User Profile and Search Service details.

  9. In the next step, choose what kinds of applications you want to provision along with the names you want to use for them.

  10. In the last two steps, define the mappings for host names and databases. Click Next to generate your configuration file.

  11. Review your results on the last tab and click Finish to close the AutoSPInstaller wizard.

After SPDocKit generates the XML file, visit to validate the settings. Use the XML file as the input to another SharePoint server to create a farm that matches your settings. Find out more about generating an XML configuration file in SPDocKit in our .

AutoSPInstaller
AutoSPInstaller Online
SPDocKit and AutoSPInstaller webinar