New-SPAccessServicesDatabaseServer
Adds a server to host Access Services databases.
Syntax
Default (Default)
New-SPAccessServicesDatabaseServer
[-ServiceContext] <SPServiceContextPipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-AvailableForCreate <Boolean>]
[-Confirm]
[-DatabaseServerCredentials <PSCredential>]
[-DatabaseServerGroupName <String>]
-DatabaseServerName <String>
[-Encrypt <Boolean>]
[-Exclusive <Boolean>]
[-SecondaryDatabaseServerName <String>]
[-ServerReferenceId <Guid>]
[-TrustServerCertificate <Boolean>]
[-UserDomain <String>]
[-ValidateServer <Boolean>]
[-WhatIf]
[-LoginType <LoginType>]
[-State <DatabaseServerStates>]
[-StateOwner <ServerStateOwner>]
[<CommonParameters>]
Description
This cmdlet adds additional Access Services database servers to host Access Services databases.
Examples
Example 1
New-SPAccessServicesDatabaseServer -ServiceContext https://siteUrl -DatabaseServerName SQLSVR01 -ValidateServer:$true
This example adds the SQL Server named SQLSVR01 as an Access Services database server using the context of the site, https://siteUrl. This also validates SQLSVR01 is capable of hosting Access Services databases.
Parameters
-AssignmentCollection
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
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.
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.
Parameter properties
| Type: | SPAssignmentCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AvailableForCreate
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Indicates whether or not the SQL Server is available to create Access Services databases on. The default value is true.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabaseServerCredentials
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the credentials used to connect to the SQL Server.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabaseServerGroupName
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the Access Services database group name. The default value is DEFAULT.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabaseServerName
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the name of the SQL Server to add.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Encrypt
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies to use SSL encryption between Access Services and the SQL Server hosting Access Services databases.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Exclusive
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
If the SQL Server has AvaliableForCreate set to False, this will update it to True. If the SQL Server Id does not match the database server Id and the server has AvailableForCreate set to True, this will set AvailableForCreate to False.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-LoginType
Applicable: SharePoint Server 2016, SharePoint Server 2019
Indicates the login type. Valid values are:
ApplicationLogin
LocalDBApplicationLogin
ServerLogin
StorageAccountLogon
WindowsAzureServerLogin
The default value is ServerLogin.
Parameter properties
| Type: | LoginType |
| Default value: | None |
| Accepted values: | ApplicationLogin, LocalDBApplicationLogin, ServerLogin, StorageAccountLogon, WindowsAzureServerLogin |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SecondaryDatabaseServerName
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies a secondary SQL Server to associate to the new SQL Server. This is used for disaster recovery purposes.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ServerReferenceId
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Provide a specific Server Reference Id. By default, a Server Reference Id is generated automatically when the SQL Server is added.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ServiceContext
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the service context to retrieve Access Services information from.
Parameter properties
| Type: | SPServiceContextPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-State
Applicable: SharePoint Server 2016, SharePoint Server 2019
Indicates the availability of the SQL Server to be added. Valid values are:
Active
Locked
Reserved
The default value is Active.
Parameter properties
| Type: | DatabaseServerStates |
| Default value: | None |
| Accepted values: | Active, Locked, Reserved |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-StateOwner
Applicable: SharePoint Server 2016, SharePoint Server 2019
Specifies the state owner. Valid values are:
NoOwner
TenantMove
The default value is NoOwner.
Parameter properties
| Type: | ServerStateOwner |
| Default value: | None |
| Accepted values: | NoOwner, TenantMove |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TrustServerCertificate
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Sets a value that indicates whether the channel will be encrypted while bypassing walking the certificate chain to validate trust.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserDomain
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the ___domain to use for credentials.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ValidateServer
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Validates the SQL Server is in a supported state to host Access Services databases.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.SharePoint.PowerShell.SPServiceContextPipeBind
Microsoft.SharePoint.PowerShell.SPAssignmentCollection