.png)
New-SPConfigurationDatabase
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Creates a new configuration database.
New-SPConfigurationDatabase [-DatabaseName] <String> [-DatabaseServer] <String> [[-DirectoryDomain] <String>] [[-DirectoryOrganizationUnit] <String>] [[-AdministrationContentDatabaseName] <String>] [[-DatabaseCredentials] <PSCredential>] [-FarmCredentials] <PSCredential> [-Passphrase] <SecureString> [[-SkipRegisterAsDistributedCacheHost] <SwitchParameter>] [-AssignmentCollection <SPAssignmentCollection>]
Parameters
| 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. | ||
| 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. | ||
| AdministrationContentDatabaseName | Required | 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. | ||
| 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. | ||
| 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. | ||
| 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. | ||
| 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.
|
Note: Detailed Description
The New-SPConfigurationDatabase cmdlet creates a new configuration database on the specified database server. This is the central database for a new SharePoint farm.
Input Types
Return Types
------------------EXAMPLE-----------------------
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.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
