|
| 1 | +--- |
| 2 | +external help file: Microsoft.Office.Server.UserProfiles.dll-help.xml |
| 3 | +Module Name: microsoft.sharepoint.powershell |
| 4 | +online version: |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# Update-SPProfileSync |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | +Updates the configuration of the User Profile Synchronization job based on the parameters specified. |
| 12 | + |
| 13 | +## SYNTAX |
| 14 | + |
| 15 | +``` |
| 16 | +Update-SPProfileSync [[-ExcludeWebApplications] <String>] [[-SynchronizationTiming] <String>] |
| 17 | + [[-SweepTiming] <String>] [[-IgnoreIsActive] <Boolean>] [-AssignmentCollection <SPAssignmentCollection>] |
| 18 | + [-WhatIf] [-Confirm] [<CommonParameters>] |
| 19 | +``` |
| 20 | + |
| 21 | +## DESCRIPTION |
| 22 | +The Update-SPProfileSync cmdlet updates the configuration of the User Profile Synchronization job based on the parameters specified. |
| 23 | + |
| 24 | +## EXAMPLES |
| 25 | + |
| 26 | +### EXAMPLE 1 |
| 27 | +``` |
| 28 | +Update-SPProfileSync -IgnoreIsActive:$false |
| 29 | +``` |
| 30 | + |
| 31 | +This example updates the User Profile Synchronization job marking it to sync all users irrespective of their activity, without prompting for user confirmation. |
| 32 | + |
| 33 | +### EXAMPLE 2 |
| 34 | +``` |
| 35 | +Update-SPProfileSync -SynchronizationTiming "every 15 minutes" |
| 36 | +``` |
| 37 | + |
| 38 | +This example updates the User Profile Synchronization job marking it to run every 15 minutes, without prompting for user confirmation. |
| 39 | + |
| 40 | +## PARAMETERS |
| 41 | + |
| 42 | +### -ExcludeWebApplications |
| 43 | +Comma-delimited list of Web application URLs to exclude from consideration in the synchronization process. |
| 44 | + |
| 45 | +The values specified delete any existing values set. |
| 46 | + |
| 47 | +```yaml |
| 48 | +Type: String |
| 49 | +Parameter Sets: (All) |
| 50 | +Aliases: |
| 51 | + |
| 52 | +Required: False |
| 53 | +Position: 1 |
| 54 | +Default value: None |
| 55 | +Accept pipeline input: True (ByValue) |
| 56 | +Accept wildcard characters: False |
| 57 | +``` |
| 58 | +
|
| 59 | +### -SynchronizationTiming |
| 60 | +Sets the schedule for the main synchronization job. |
| 61 | +You can mention the schedule using a text string of SPSchedule format (for example, "every 15 minutes" means the job is scheduled to run every 15 minutes, "daily at 09:00:00" means the job is scheduled to run at 9 AM every day). |
| 62 | +
|
| 63 | +The default is once per hour. |
| 64 | +
|
| 65 | +You can use the SPSchedule.FromString() string method to pass in the strings, "every 5 minutes" or "weekly xxxxxxx". |
| 66 | +
|
| 67 | +```yaml |
| 68 | +Type: String |
| 69 | +Parameter Sets: (All) |
| 70 | +Aliases: |
| 71 | + |
| 72 | +Required: False |
| 73 | +Position: 2 |
| 74 | +Default value: None |
| 75 | +Accept pipeline input: True (ByValue) |
| 76 | +Accept wildcard characters: False |
| 77 | +``` |
| 78 | +
|
| 79 | +### -SweepTiming |
| 80 | +Performs the same tasks as the SynchronizationTiming parameter. |
| 81 | +However, the SweepTiming parameter sets the schedule for the "sweep" job. |
| 82 | +The sweep job is driven by the SharePoint Foundation change log and is used as a lightweight way to capture new users added. |
| 83 | +For example, you might have a fully synchronized site, but then a user is added to the site. |
| 84 | +The sweep job ensures that the incremental newly added user gets the User Profile properties replicated quickly. |
| 85 | +
|
| 86 | +The default value is every 1 minute. |
| 87 | +
|
| 88 | +```yaml |
| 89 | +Type: String |
| 90 | +Parameter Sets: (All) |
| 91 | +Aliases: |
| 92 | + |
| 93 | +Required: False |
| 94 | +Position: 3 |
| 95 | +Default value: None |
| 96 | +Accept pipeline input: True (ByValue) |
| 97 | +Accept wildcard characters: False |
| 98 | +``` |
| 99 | +
|
| 100 | +### -IgnoreIsActive |
| 101 | +Specifies whether to sync only active profiles or all profiles. |
| 102 | +User profiles of users who contribute to the site are considered as Active. |
| 103 | +
|
| 104 | +The valid values are True or False. |
| 105 | +
|
| 106 | +```yaml |
| 107 | +Type: Boolean |
| 108 | +Parameter Sets: (All) |
| 109 | +Aliases: |
| 110 | + |
| 111 | +Required: False |
| 112 | +Position: 4 |
| 113 | +Default value: None |
| 114 | +Accept pipeline input: True (ByValue) |
| 115 | +Accept wildcard characters: False |
| 116 | +``` |
| 117 | +
|
| 118 | +### -AssignmentCollection |
| 119 | +Manages objects for the purpose of proper disposal. |
| 120 | +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. |
| 121 | +Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. |
| 122 | +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. |
| 123 | +
|
| 124 | +When the Global parameter is used, all objects are contained in the global store. |
| 125 | +If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. |
| 126 | + |
| 127 | +```yaml |
| 128 | +Type: SPAssignmentCollection |
| 129 | +Parameter Sets: (All) |
| 130 | +Aliases: |
| 131 | +
|
| 132 | +Required: False |
| 133 | +Position: Named |
| 134 | +Default value: None |
| 135 | +Accept pipeline input: True (ByValue) |
| 136 | +Accept wildcard characters: False |
| 137 | +``` |
| 138 | + |
| 139 | +### -Confirm |
| 140 | +Prompts you for confirmation before running the cmdlet. |
| 141 | + |
| 142 | +```yaml |
| 143 | +Type: SwitchParameter |
| 144 | +Parameter Sets: (All) |
| 145 | +Aliases: cf |
| 146 | +
|
| 147 | +Required: False |
| 148 | +Position: Named |
| 149 | +Default value: None |
| 150 | +Accept pipeline input: False |
| 151 | +Accept wildcard characters: False |
| 152 | +``` |
| 153 | + |
| 154 | +### -WhatIf |
| 155 | +Shows what would happen if the cmdlet runs. |
| 156 | +The cmdlet is not run. |
| 157 | + |
| 158 | +```yaml |
| 159 | +Type: SwitchParameter |
| 160 | +Parameter Sets: (All) |
| 161 | +Aliases: wi |
| 162 | +
|
| 163 | +Required: False |
| 164 | +Position: Named |
| 165 | +Default value: None |
| 166 | +Accept pipeline input: False |
| 167 | +Accept wildcard characters: False |
| 168 | +``` |
| 169 | + |
| 170 | +### CommonParameters |
| 171 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. |
| 172 | +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). |
| 173 | + |
| 174 | +## INPUTS |
| 175 | + |
| 176 | +## OUTPUTS |
| 177 | + |
| 178 | +## NOTES |
| 179 | + |
| 180 | +## RELATED LINKS |
0 commit comments