Export (0) Print
Expand All

Set-SPSecureStoreServiceApplication

 

Applies to: SharePoint Server 2013 Enterprise, SharePoint Foundation 2013

Topic Last Modified: 2013-12-18

Sets properties of a Secure Store Service application in the farm.

Set-SPSecureStoreServiceApplication -Identity <SPServiceApplicationPipeBind> [-ApplicationPool <SPIisWebServiceApplicationPool>] [-AssignmentCollection <SPAssignmentCollection>] [-AuditingEnabled <SwitchParameter>] [-AuditlogMaxSize <Nullable>] [-Confirm [<SwitchParameter>]] [-DatabaseCredentials <PSCredential>] [-DatabaseName <String>] [-DatabasePassword <SecureString>] [-DatabaseServer <String>] [-DatabaseUsername <String>] [-FailoverDatabaseServer <String>] [-Sharing <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

The Set-SPSecureStoreServiceApplication cmdlet sets properties of a Secure Store Service application in the farm.

 

Parameter Required Type Description

Identity

Required

Microsoft.SharePoint.PowerShell.SPServiceApplicationPipeBind

Specifies the service application to update.

ApplicationPool

Optional

Microsoft.SharePoint.Administration.SPIisWebServiceApplicationPool

Specifies the existing IIS application pool to run the Web service in for the new service application.

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.

AuditingEnabled

Optional

System.Management.Automation.SwitchParameter

Turns on auditing for the Secure Store Service.

AuditlogMaxSize

Optional

System.Nullable

Specifies the number of days to retain the audit log.

The type must be a valid integer.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

DatabaseCredentials

Optional

System.Management.Automation.PSCredential

Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication.

DatabaseName

Optional

System.String

Specifies the name of the Secure Store service database.

DatabasePassword

Optional

System.Security.SecureString

Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL authentication is used to access the metadata service application database.

DatabaseServer

Optional

System.String

Specifies the name of the host server for the database specified in DatabaseName.

DatabaseUsername

Optional

System.String

Specifies the user name to use for connecting to the database for the Secure Store service application. Use this parameter only if SQL authentication is used to access the service application database.

FailoverDatabaseServer

Optional

System.String

Specifies the name of the host server for the failover database server.

Sharing

Optional

System.Management.Automation.SwitchParameter

Specifies that the Secure Store Service application is published and shared across the farm.

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

------------------EXAMPLE------------------

Set-SPSecureStoreServiceApplication -Identity $contosoServApp -AuditlogMaxSize 40

This example sets the maximum size of the audit log to 40 days for the given service application.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft