Edit

Share via


Update-SPHelp

Updates SharePoint cmdlet help.

Syntax

Default (Default)

Update-SPHelp
    [-AssignmentCollection <SPAssignmentCollection>]
    [-Force]
    [<CommonParameters>]

Description

The Update-SPHelp cmdlet checks the Windows Download Center for updates for the SharePoint Management Shell help files against the version of the help files on the local computer. If there updates available, the cmdlet will download and install these updates. By default, the cmdlet will allow checking for updates only once every 24 hours. To override this check, use the Force parameter.

The computer that the cmdlet is being run on must have an internet connection.

Note: This cmdlet currently does not update cmdlet help.

Examples

EXAMPLE 1

Update-SPHelp

Updates SharePoint cmdlet help.

EXAMPLE 2

Update-SPHelp -Force

This example over-rides the throttling logic and checks for updates to the help files even if a check was made in the last 24 hours.

EXAMPLE 3

Update-SPHelp -Verbose

This example checks for updates to the help files and provides detailed feedback for each step of the process.

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.

NOTE: 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

-Force

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

Over-rides the throttling logic and checks for updates to the help files even if a check was made in the last 24 hours.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

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

Outputs

System.Object