Set-SPProfileServiceApplication
Sets properties of a User Profile Service application.
Syntax
Set-SPProfileServiceApplication
[-Identity] <SPServiceApplicationPipeBind>
[-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>]
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-GetNonImportedObjects <Boolean>]
[-MySiteHostLocation <SPSitePipeBind>]
[-ProfileDBCredentials <PSCredential>]
[-ProfileSyncDBCredentials <PSCredential>]
[-ProfileSyncDBFailoverServer <String>]
[-PurgeNonImportedObjects <Boolean>]
[-SocialDBCredentials <PSCredential>]
[-SocialDBFailoverServer <String>]
[-Name <String>]
[-UseOnlyPreferredDomainControllers <Boolean>]
[-WhatIf]
[-ProfileDBFailoverServer <String>]
[<CommonParameters>] Set-SPProfileServiceApplication
[-Identity] <SPServiceApplicationPipeBind>
[-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>]
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-GetNonImportedObjects <Boolean>]
-MySiteHostLocation <SPSitePipeBind>
[-MySiteManagedPath <SPPrefixPipeBind>]
[-ProfileDBCredentials <PSCredential>]
[-ProfileSyncDBCredentials <PSCredential>]
[-ProfileSyncDBFailoverServer <String>]
[-PurgeNonImportedObjects <Boolean>]
[-SiteNamingConflictResolution <String>]
[-SocialDBCredentials <PSCredential>]
[-SocialDBFailoverServer <String>]
[-Name <String>]
[-UseOnlyPreferredDomainControllers <Boolean>]
[-WhatIf]
[-ProfileDBFailoverServer <String>]
[<CommonParameters>] Description
This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet parameter sets.
The Set-SPProfileServiceApplication cmdlet sets properties of a User Profile Service application.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
Examples
---------------EXAMPLE---------------------
$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'User Profile Service Application'}
Set-SPProfileServiceApplication -Identity $sa -PurgeNonImportedObjects:$trueThis example purges objects from the Profile database which are not in scope of the User Profile import.
Parameters
-ApplicationPool
Specifies the existing IIS application pool in which to run the Web service for the service application.
The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object.
| Type: | SPIisWebServiceApplicationPoolPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-AssignmentCollection
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.
| Type: | SPAssignmentCollection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-Confirm
Prompts you for confirmation before executing the command.
For more information, type the following command: get-help about_commonparameters
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-GetNonImportedObjects
Specifies whether to inform the users that did not come from the import pipeline and will be marked for deletion. The list of users marked for deletion is displayed to the console window.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-Identity
Specifies the User Profile Service application to update.
The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPServiceApplication object.
| Type: | SPServiceApplicationPipeBind |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-MySiteHostLocation
Specifies the site collection where the My Site will be provisioned.
The type must be a valid URL, in the form https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscription1); or an instance of a valid SiteSubscription object.
| Type: | SPSitePipeBind |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-MySiteManagedPath
Specifies the managed path location of personal sites.
The type must be a valid URL, in the form https://server_name.
| Type: | SPPrefixPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-Name
Specifies the display name for the new User Profile Service application. The name that you use must be a unique name of a User Profile Service application in this farm. The name can be a maximum of 128 characters.
The type must be a valid name of a User Profile Service application; for example, UserProfileSvcApp1.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-ProfileDBCredentials
Specifies the set of security credentials, such as a user name and a password, that is used to connect to the User Profile database that this cmdlet creates.
The type must be a valid PSCredential object.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-ProfileDBFailoverServer
Specifies the name of the failover SQL server for Profile database. It is used to build the connection string for the Profile database.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-ProfileSyncDBCredentials
Specifies the set of security credentials, such as a user name and a password, that will be used to connect to the Profile Sync database that is specified in the ProfileSyncDBName parameter.
The type must be a valid PSCredential object.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-ProfileSyncDBFailoverServer
Specifies the name of the failover SQL server for Profile database. It is used to build the connection string for the Profile database.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-PurgeNonImportedObjects
Specifies whether to mark the non-imported users in the profile store for deletion and then inform the users that did not come from the import pipeline which will be marked for deletion. The list of users marked for deletion is displayed on the console window
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-SiteNamingConflictResolution
Specifies the format to use to name personal sites.
Use one of the following integer values:
1--Personal site collections are to be based on user names without any conflict resolution. For example, https://portal_site/location/username/
2-- Personal site collections are to be based on user names with conflict resolution by using domain names. For example, .../username/ or .../domain_username/
3 Personal site collections are to be named by using domain and user name always, to avoid any conflicts. For example, https://portal_site/location/domain_username/
The default value is 1 (do not resolve conflicts).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-SocialDBCredentials
The set of security credentials, including a user name and a password, that is used to connect to the Social database that this cmdlet creates.
The type must be a valid PSCredential object.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-SocialDBFailoverServer
Specifies the name of the failover SQL server for Social database. It is used to build the connection string for the Social database.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-UseOnlyPreferredDomainControllers
Restricts profile synchronization communication to a specific domain controller.
The valid values are $true or $false.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-WhatIf
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
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |