Set-SPAccessServicesDatabaseServer
Sets parameters associated with a database server hosting Access Services databases.
Syntax
SetAvailableForCreateParameterSet
Set-SPAccessServicesDatabaseServer
[-ServiceContext] <SPServiceContextPipeBind>
-AvailableForCreate <Boolean>
-DatabaseServer <AccessServicesDatabaseServerPipeBind>
-DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-Exclusive <Boolean>]
[-WhatIf]
[<CommonParameters>]
SetCredentialsParameterSet
Set-SPAccessServicesDatabaseServer
[-ServiceContext] <SPServiceContextPipeBind>
-DatabaseServer <AccessServicesDatabaseServerPipeBind>
-DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-DatabaseServerCredentials <PSCredential>]
[-DatabaseServerName <String>]
[-WhatIf]
[<CommonParameters>]
SetEncryptParameterSet
Set-SPAccessServicesDatabaseServer
[-ServiceContext] <SPServiceContextPipeBind>
-DatabaseServer <AccessServicesDatabaseServerPipeBind>
-DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind>
-Encrypt <Boolean>
-TrustServerCertificate <Boolean>
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-WhatIf]
[<CommonParameters>]
SetFailoverParameterSet
Set-SPAccessServicesDatabaseServer
[-ServiceContext] <SPServiceContextPipeBind>
-DatabaseServer <AccessServicesDatabaseServerPipeBind>
-DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind>
-Failover <Boolean>
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-WhatIf]
[<CommonParameters>]
SetSecondaryDatabaseServerNameParameterSet
Set-SPAccessServicesDatabaseServer
[-ServiceContext] <SPServiceContextPipeBind>
-DatabaseServer <AccessServicesDatabaseServerPipeBind>
-DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-SecondaryDatabaseServerName <String>]
[-WhatIf]
[<CommonParameters>]
SetUserDomainParameterSet
Set-SPAccessServicesDatabaseServer
[-ServiceContext] <SPServiceContextPipeBind>
-DatabaseServer <AccessServicesDatabaseServerPipeBind>
-DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind>
-UserDomain <String>
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-WhatIf]
[<CommonParameters>]
SetServerStateParameterSet
Set-SPAccessServicesDatabaseServer
[-ServiceContext] <SPServiceContextPipeBind>
-DatabaseServer <AccessServicesDatabaseServerPipeBind>
-DatabaseServerGroup <AccessServicesDatabaseServerGroupPipeBind>
-State <DatabaseServerStates>
-StateOwner <ServerStateOwner>
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-WhatIf]
[<CommonParameters>]
Description
Sets parameters associated with a database server hosting Access Services databases allowing you to control database creation, credentials, and failover database servers.
Examples
EXAMPLE
$site = (Get-SPWebApplication -IncludeCentralAdministration | ?{$_.IsAdministrationWebApplication -eq $true}).Sites[0]
$dbsvr = (Get-SPAccessServicesDatabaseServer -ServiceContext $site -DatabaseServerGroup DEFAULT)[0]
Set-SPAccessServicesDatabaseServer -ServiceContext $site -DatabaseServerGroup DEFAULT -DatabaseServer $dbsvr -Exclusive $true -AvailableForCreate $false
Sets the first database in the database server group named DEFAULT to exclusive mode and disallowing creation of new Access Services database on the selected database server.
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 new Access Services databases can be created on the specified SQL Server.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SetAvailableForCreateParameterSet
| Position: | Named |
| Mandatory: | True |
| 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 |
-DatabaseServer
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the SQL Server hosting Access Services databases.
Parameter properties
| Type: | AccessServicesDatabaseServerPipeBind |
| 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 |
-DatabaseServerCredentials
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
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.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SetCredentialsParameterSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabaseServerGroup
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
The name of the Access Services database server group containing the SQL Server object to set.
Parameter properties
| Type: | AccessServicesDatabaseServerGroupPipeBind |
| 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 |
-DatabaseServerName
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the database server hosting Access Services databases.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SetCredentialsParameterSet
| Position: | Named |
| Mandatory: | False |
| 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
Encrypts the database server connection.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SetEncryptParameterSet
| Position: | Named |
| Mandatory: | True |
| 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
Sets the database server to exclusive mode. No further Access Services databases are allowed to be created on the database server.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SetAvailableForCreateParameterSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Failover
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Enables or disables failover for the Access Services database server.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SetFailoverParameterSet
| Position: | Named |
| Mandatory: | True |
| 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 the failover database server name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SetSecondaryDatabaseServerNameParameterSet
| 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 which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID.
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
Sets the database server state. Valid values:
Active
Locked
Reserved
Parameter properties
| Type: | DatabaseServerStates |
| Default value: | None |
| Accepted values: | Active, Locked, Reserved |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SetServerStateParameterSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-StateOwner
Applicable: SharePoint Server 2016, SharePoint Server 2019
Sets the state owner.
Valid values:
NoOwner
TenantMove
Parameter properties
| Type: | ServerStateOwner |
| Default value: | None |
| Accepted values: | NoOwner, TenantMove |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SetServerStateParameterSet
| Position: | Named |
| Mandatory: | True |
| 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
SetEncryptParameterSet
| Position: | Named |
| Mandatory: | True |
| 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
Sets the user domain for the specified database server.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SetUserDomainParameterSet
| Position: | Named |
| Mandatory: | True |
| 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