New-SPConfigurationDatabase

 

Applies to: SharePoint Server 2016

Topic Last Modified: 2016-09-09

Creates a new configuration database.

New-SPConfigurationDatabase -DatabaseName <String> -DatabaseServer <String> -FarmCredentials <PSCredential> -Passphrase <SecureString> [-AdministrationContentDatabaseName <String>] [-AssignmentCollection <SPAssignmentCollection>] [-DatabaseCredentials <PSCredential>] [-DatabaseFailOverServer <String>] [-DirectoryDomain <String>] [-DirectoryOrganizationUnit <String>] [-LocalServerRole <Invalid | WebFrontEnd | Application | SingleServer | SingleServerFarm | DistributedCache | Search | Custom | ApplicationWithSearch | WebFrontEndWithDistributedCache>] [-ServerRoleOptional <SwitchParameter>] [-SkipRegisterAsDistributedCacheHost <SwitchParameter>]

------------------EXAMPLE 1-----------------------

New-SPConfigurationDatabase -DatabaseName "SharePointConfigDB1" -DatabaseServer "SQL-01" -Passphrase (ConvertTo-SecureString "MyPassword" -AsPlainText -force) -FarmCredentials (Get-Credential)

This example prompts the user to provide user credentials for the default Farm Administrator account.

------------------EXAMPLE 2-----------------------

New-SPConfigurationDatabase -DatabaseName "SharePointConfigDB1" -DatabaseServer "SQL-01" -Passphrase (ConvertTo-SecureString "MyPassword" -AsPlainText -force) -FarmCredentials (Get-Credential) -LocalServerRole SingleServerFarm

This example creates a new configuration database that uses the SingleServerFarm server role type.

The New-SPConfigurationDatabase cmdlet creates a new configuration database on the specified database server. This is the central database for a new SharePoint farm.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016 reference.

 

Parameter Required Type Description

DatabaseName

Required

System.String

Specifies the name of the new configuration database.

DatabaseServer

Required

System.String

Specifies the database server on which to create the configuration database. If no value is specified, the default value is used.

FarmCredentials

Required

System.Management.Automation.PSCredential

Specifies credentials for the Farm Administrator account.

Passphrase

Required

System.Security.SecureString

Specifies the secure password phrase for the new farm. This passphrase is used to join other machines to this farm.

AdministrationContentDatabaseName

Optional

System.String

Specifies the name for the Central Administration content database for the new farm. If no name is specified, a default name is used.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

NoteNote:
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

DatabaseCredentials

Optional

System.Management.Automation.PSCredential

Specifies the Credential object for the database user. Use this parameter if you use SQL Server Authentication. If no database credentials are provided, Windows authentication is used.

DatabaseFailOverServer

Optional

System.String

Specifies the name of the mirror server for failover.

DirectoryDomain

Optional

System.String

Specifies the directory domain for the new farm. If no domain is specified, the domain in which the local computer is located is used.

DirectoryOrganizationUnit

Optional

System.String

Specifies the directory organizational unit for the new configuration database. If no organizational unit is specified, the organizational unit in which the local computer is located is used.

LocalServerRole

Optional

Microsoft.SharePoint.Administration.SPServerRole

Specifies which Server Role type to use. The valid values are the following:

-WebFrontEnd

-Application

-DistributedCache

-Search

-SingleServerFarm

-Custom

-ApplicationWithSearch

-WebFrontEndWithDistributedCache

ServerRoleOptional

Optional

System.Management.Automation.SwitchParameter

Configures the farm to not require a server role to be specified. If no server role is specified, the server defaults to the Custom role.

SkipRegisterAsDistributedCacheHost

Optional

System.Management.Automation.SwitchParameter

By default all the servers in the farm are registered as a cache host (that is, DistributedCacheService is running by default).

Use this parameter to not register the server computer as a distributed cache host. If you want to have a dedicated cache host, then use this parameter to make sure that caching service is not installed on the computer.

SiteMapDatabaseName

Optional

System.String

Specifies the database name of the Site Map site.

SiteMapDatabaseServer

Optional

System.String

Specifies the database server name of the Site Map site.

 
Show: