Set-SPProfileServiceApplication

Syntax

Default

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>]

MySiteSettings

Set-SPProfileServiceApplication
    [-Identity] <SPServiceApplicationPipeBind>
    -MySiteHostLocation <SPSitePipeBind>
    [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>]
    [-AssignmentCollection <SPAssignmentCollection>]
    [-Confirm]
    [-GetNonImportedObjects <Boolean>]
    [-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

Examples

EXAMPLE

$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'User Profile Service Application'}
Set-SPProfileServiceApplication -Identity $sa -PurgeNonImportedObjects:$true

Parameters

-ApplicationPool

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Parameter sets

-AssignmentCollection

Applicable: SharePoint Server 2010, 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

Parameter sets

-Confirm

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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

Parameter properties

Parameter sets

-GetNonImportedObjects

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Parameter sets

-Identity

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Parameter sets

-MySiteHostLocation

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Parameter sets

-MySiteManagedPath

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies the managed path ___location of personal sites.

The type must be a valid URL, in the form https://server_name.

Parameter properties

Parameter sets

-Name

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Parameter sets

-ProfileDBCredentials

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Parameter sets

-ProfileDBFailoverServer

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies the name of the failover SQL server for Profile database. It is used to build the connection string for the Profile database.

Parameter properties

Parameter sets

-ProfileSyncDBCredentials

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Parameter sets

-ProfileSyncDBFailoverServer

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies the name of the failover SQL server for Profile database. It is used to build the connection string for the Profile database.

Parameter properties

Parameter sets

-PurgeNonImportedObjects

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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

Parameter properties

Parameter sets

-SiteNamingConflictResolution

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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).

Parameter properties

Parameter sets

-SocialDBCredentials

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Parameter sets

-SocialDBFailoverServer

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies the name of the failover SQL server for Social database. It is used to build the connection string for the Social database.

Parameter properties

Parameter sets

-UseOnlyPreferredDomainControllers

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Restricts profile synchronization communication to a specific ___domain controller.

The valid values are $true or $false.

Parameter properties

Parameter sets

-WhatIf

Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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

Parameter properties

Parameter sets

CommonParameters