SharePointServer module
The following cmdlet references are for SharePoint Server.
Access Services (2010) cmdlets
Cmdlet | Description |
---|---|
Get-SPAccessServiceApplication |
Returns an Access Services application or a collection of Access Services applications. |
New-SPAccessServiceApplication |
Creates a new instance of an Access Services application in SharePoint Server. |
Set-SPAccessServiceApplication |
Sets global properties of an existing Access Services application in SharePoint Server. |
Access Services (2013) cmdlets
Cmdlet | Description |
---|---|
Copy-SPAccessServicesDatabaseCredentials |
This cmdlet copies Access Services database credentials from one server to another. |
Export-SPAccessServicesDatabase |
Exports an Access Services Database to a DACPAC via the Data-Tier Framework. |
Get-SPAccessServicesApplication |
Gets an Access Services Service Application. |
Get-SPAccessServicesDatabase |
Returns an Access Services database. |
Get-SPAccessServicesDatabaseServer |
Returns SQL Server instances associated with Access Services. |
Get-SPAccessServicesDatabaseServerGroup |
Returns a database server group. |
Get-SPAccessServicesDatabaseServerGroupMapping |
Returns the mapping of the database server group. |
Import-SPAccessServicesDatabase |
Imports an Access Services Database to a DACPAC via the Data-Tier Framework. |
New-SPAccessServicesApplication |
Creates an Access Services Service Application. |
New-SPAccessServicesApplicationProxy |
Creates a Proxy for an Access Services Service Application. |
New-SPAccessServicesDatabaseServer |
Adds a server to host Access Services databases. |
Remove-SPAccessServicesDatabaseServer |
Removes a server configured to host Access Services databases. |
Reset-SPAccessServicesDatabasePassword |
Resets the specified Access Services Database password with a randomly generated password. |
Set-SPAccessServicesApplication |
Sets the properties of a Access Services service application. |
Set-SPAccessServicesDatabaseServer |
Sets parameters associated with a database server hosting Access Services databases. |
Set-SPAccessServicesDatabaseServerGroupMapping |
Sets or creates the Access Services database server group mapping. |
SharePoint Addin cmdlets
Cmdlet | Description |
---|---|
Add-SPAppDeniedEndpoint |
Adds a relative URL endpoint of a server to the list of app-denied endpoints. |
Clear-SPAppDeniedEndpointList |
Remove all app-denied endpoints in the farm. |
Disable-SPAppAutoProvision |
Disables automatic provisioning of an app. |
Enable-SPAppAutoProvision |
Enables automatic provisioning of an app. |
Export-SPAppPackage |
Exports an app package. |
Get-SPAppAcquisitionConfiguration |
Returns app acquisition settings. |
Get-SPAppAutoProvisionConnection |
Returns provision connection settings for an app. |
Get-SPAppDeniedEndpointList |
Returns the app-denied endpoint list for the entire farm. |
Get-SPAppDisablingConfiguration |
Returns the disable sync list state for an app. |
Get-SPAppDomain |
Returns the ___domain used to host apps. |
Get-SPAppHostingQuotaConfiguration |
Returns the hosting quotas for an app. |
Get-SPAppInstance |
Returns the metadata for an instance of an app. |
Get-SPAppPrincipal |
Displays a specific app principal object. |
Get-SPAppScaleProfile |
Returns settings for an app profile. |
Get-SPAppSiteSubscriptionName |
Returns the name of the specified site subscription. |
Get-SPAppStateSyncLastRunTime |
Returns the latest time the app state update job was invoked. |
Get-SPAppStateUpdateInterval |
Returns the interval in hours between updates of the app state update job. |
Get-SPAppStoreConfiguration |
Returns app SharePoint Store settings. |
Get-SPAppStoreWebServiceConfiguration |
Returns properties of a SharePoint Store app. |
Get-SPInternalAppStateSyncLastRunTime |
Returns the latest time the internal app state update job was invoked. |
Get-SPInternalAppStateUpdateInterval |
Returns the interval in hours between updates of the internal app state update job. |
Import-SPAppPackage |
Imports an app package. |
Install-SPApp |
Installs an instance of an app. |
New-SPMarketplaceWebServiceApplicationProxy |
Creates a service application proxy for the app identity data web service. |
Register-SPAppPrincipal |
Lets an on-premises administrator register an app principal. |
Remove-SPAppDeniedEndpoint |
Removes a relative URL endpoint of a server from the list of app-denied endpoints. |
Remove-SPAppPrincipalPermission |
Removes the permissions on a specified app principal. |
Restart-SPAppInstanceJob |
Restarts an app instance. |
Set-SPAppAcquisitionConfiguration |
Sets app acquisition settings. |
Set-SPAppAutoProvisionConnection |
Sets provision connection settings for an app. |
Set-SPAppDisablingConfiguration |
Sets the disable list sync state for an app. |
Set-SPAppDomain |
Sets the ___domain used to host apps. |
Set-SPAppHostingQuotaConfiguration |
Sets hosting quotas for an app. |
Set-SPAppManagementDeploymentId |
Sets the identifier of the farm or tenant used by the Office Marketplace to issue App licenses. |
Set-SPAppPrincipalPermission |
Sets the permissions on a given app principal. |
Set-SPAppScaleProfile |
Sets settings for the app profile. |
Set-SPAppSiteDomain |
Creates or changes the URL of any installed app. |
Set-SPAppSiteSubscriptionName |
Sets or changes the name for the specified site subscription. |
Set-SPAppStateUpdateInterval |
Sets the interval in hours between updates of the app state update job. |
Set-SPAppStoreConfiguration |
Sets SharePoint Store settings for an app. |
Set-SPAppStoreWebServiceConfiguration |
Sets properties of a SharePoint Store app. |
Set-SPInternalAppStateUpdateInterval |
Sets the interval in hours between updates of the internal app state update job. |
Uninstall-SPAppInstance |
Uninstalls an instance of an app. |
Update-SPAppCatalogConfiguration |
Sets a specific site collection as the App Catalog site collection. |
Update-SPAppInstance |
Updates the app instance. |
App Management Service cmdlets
Cmdlet | Description |
---|---|
New-SPAppManagementServiceApplication |
Creates an App Management Service application. |
New-SPAppManagementServiceApplicationProxy |
Creates an App Management Service application proxy. |
Backup and Restore Operations cmdlets
Cmdlet | Description |
---|---|
Backup-SPConfigurationDatabase |
Performs a farm-level configuration-only backup. |
Backup-SPFarm |
Creates a backup of an individual database, Web application, or the entire farm. |
Backup-SPSite |
Performs a backup of a site collection. |
Export-SPWeb |
Exports a site, list, or library. |
Get-SPBackupHistory |
Returns a history of backup and restore operations. |
Restore-SPDeletedSite |
Restores a deleted site collection. |
Restore-SPFarm |
Restores one or more items from a backup. |
Restore-SPSite |
Restores a site collection. |
Bing Maps cmdlets
Cmdlet | Description |
---|---|
Get-SPBingMapsBlock |
Returns Bing Maps blocked status. |
Get-SPBingMapsKey |
Returns the Bing Maps key. |
Set-SPBingMapsBlock |
Sets Bing maps to blocked status. |
Set-SPBingMapsKey |
Sets the Bing Maps key. |
Business Data Connectivity Services cmdlets
Cmdlet | Description |
---|---|
Clear-SPBusinessDataCatalogEntityNotificationWeb |
Clears the entity notification site. |
Copy-SPBusinessDataCatalogAclToChildren |
Copies a set of permissions of a Business Data Connectivity Metadata Store metadata object to its child objects. |
Disable-SPBusinessDataCatalogEntity |
Deactivates an External Content type in the Business Data Connectivity Metadata Store. |
Enable-SPBusinessDataCatalogEntity |
Activates an External Content type in the Business Data Connectivity Metadata Store. |
Export-SPBusinessDataCatalogModel |
Exports a Business Data Connectivity Model. |
Get-SPBusinessDataCatalogEntityNotificationWeb |
Returns the entity notification site. |
Get-SPBusinessDataCatalogMetadataObject |
Returns a Business Data Connectivity Metadata Store metadata object. |
Get-SPBusinessDataCatalogThrottleConfig |
Returns the throttling configuration for a Business Data Connectivity Service application. |
Get-SPODataConnectionSetting |
Returns Business Connectivity Services OData connection properties. |
Get-SPODataConnectionSettingMetadata |
Returns a Business Data Connectivity service metadata object. |
Grant-SPBusinessDataCatalogMetadataObject |
Grants a right to a principal for the specified Business Data Connectivity Metadata Store metadata object. |
Import-SPBusinessDataCatalogDotNetAssembly |
Imports a .NET Connectivity assembly. |
Import-SPBusinessDataCatalogModel |
Imports a Business Data Connectivity Model. |
New-SPBusinessDataCatalogServiceApplication |
Creates a new Business Data Connectivity service application in the farm. |
New-SPBusinessDataCatalogServiceApplicationProxy |
Creates a new Business Data Connectivity service application proxy in the farm. |
Remove-SPBusinessDataCatalogModel |
Deletes a Business Data Connectivity Model. |
Revoke-SPBusinessDataCatalogMetadataObject |
Revokes a right to a principal in the specified Business Data Connectivity Metadata Store metadata object. |
Set-SPBusinessDataCatalogEntityNotificationWeb |
Sets the entity notification site. |
Set-SPBusinessDataCatalogMetadataObject |
Sets the value of a property or attribute of a Business Data Connectivity Metadata Store metadata object. |
Set-SPBusinessDataCatalogServiceApplication |
Sets global properties for a Business Data Connectivity service application in the farm. |
Set-SPBusinessDataCatalogThrottleConfig |
Sets the throttling configuration for a Business Data Connectivity Service application. |
Database Operations cmdlets
Cmdlet | Description |
---|---|
Add-DatabaseToAvailabilityGroup |
Adds one or more SharePoint databases to a SQL Server Availability Group |
Add-SPScaleOutDatabase |
Adds an existing scale-out database to the specified service application. |
Add-SPServerScaleOutDatabase |
Adds an existing scale-out content database to the specified service application. |
Clear-SPScaleOutDatabaseDeletedDataSubRange |
Clears all partitions inside the specified deleted subrange. |
Clear-SPScaleOutDatabaseLog |
Clears all scale-out logs. |
Clear-SPScaleOutDatabaseTenantData |
Removes all data related to the specified site subscription. |
Clear-SPServerScaleOutDatabaseDeletedDataSubRange |
Clears all partitions inside the specified deleted subrange. |
Clear-SPServerScaleOutDatabaseLog |
Clears all scale-out logs in the specified scale-out database unless there is a scale-out log entry newer than the specified time-out value. |
Clear-SPServerScaleOutDatabaseTenantData |
Removes all data related to the specified site subscription. |
Dismount-SPContentDatabase |
Detaches a content database from its currently associated Web application. |
Export-SPScaleOutDatabaseTenantData |
Exports the data of the specified subscription. |
Export-SPServerScaleOutDatabaseTenantData |
Exports the data of the specified subscription. |
Get-AvailabilityGroupStatus |
Returns one or more objects representing the availability groups known to the SharePoint farm. |
Get-SPContentDatabase |
Returns one or more content databases. |
Get-SPContentDatabaseOrphanedData |
Gets orphaned data in content database. |
Get-SPDatabase |
Retrieves all properties of a database. |
Get-SPScaleOutDatabase |
Returns all scale-out database objects. |
Get-SPScaleOutDatabaseDataState |
Returns the state information about the specified scale-out database. |
Get-SPScaleOutDatabaseInconsistency |
Displays all inconsistencies related to scale-out databases' ranges. |
Get-SPScaleOutDatabaseLogEntry |
Queries a scale-out database for scale-out logs. |
Get-SPServerScaleOutDatabase |
Returns all scale-out database objects. |
Get-SPServerScaleOutDatabaseDataState |
Returns the state information about the specified scale-out database. |
Get-SPServerScaleOutDatabaseInconsistency |
Displays all inconsistencies related to scale-out databases' ranges. |
Get-SPServerScaleOutDatabaseLogEntry |
Queries a scale-out database for scale-out logs. |
Import-SPScaleOutDatabaseTenantData |
Imports data from the specified subscription id. |
Import-SPServerScaleOutDatabaseTenantData |
Imports data from the specified subscription id. |
Mount-SPContentDatabase |
Attaches an existing content database to the farm. NOTE: Please be aware that if a content database that does not exists is specified, it will be created by this cmdlet. |
Move-SPBlobStorageLocation |
Copies a content database to a new ___location by using Remote BLOB Storage (RBS). |
New-SPContentDatabase |
Creates a new content database and attaches it to the specified Web application. |
Remove-DatabaseFromAvailabilityGroup |
Removes one or more SharePoint databases from an availability group in SQL Server. |
Remove-SPContentDatabase |
Deletes a content database. |
Remove-SPScaleOutDatabase |
Removes a specific scale-out database. |
Remove-SPServerScaleOutDatabase |
Removes a specific scale-out database. |
Set-SPContentDatabase |
Sets global properties of a SharePoint content database. |
Set-SPScaleOutDatabaseDataRange |
Extends the range of a specified scale-out database. |
Set-SPScaleOutDatabaseDataSubRange |
Creates a subrange for a specified scale-out database. |
Set-SPServerScaleOutDatabaseDataRange |
Extends the range of a specified scale-out database. |
Set-SPServerScaleOutDatabaseDataSubRange |
Creates a subrange for a specified scale-out database. |
Split-SPScaleOutDatabase |
Moves a specified percentage of partitions from one scale-out database to another. |
Split-SPServerScaleOutDatabase |
Moves a specified percentage of partitions from one scale-out database to another. |
Test-SPContentDatabase |
Tests a content database. |
Upgrade-SPContentDatabase |
Resumes a failed database upgrade or begins a build-to-build database upgrade. |
Diagnostics Logs (ULS) cmdlets
Cmdlet | Description |
---|---|
Clear-SPLogLevel |
Resets the Windows event logging and trace logging to their default values. |
Get-SPLogEvent |
Returns results from a Unified Logging Service (ULS) trace log. |
Get-SPLogLevel |
Returns a list of objects or diagnostic levels. |
Merge-SPLogFile |
Combines trace log entries from all farm computers into a single log file on the local computer. |
New-SPLogFile |
Creates a new log file. |
Set-SPLogLevel |
Sets the trace and event level for a set of categories. |
Distributed Cache cmdlets
Cmdlet | Description |
---|---|
Add-SPDistributedCacheServiceInstance |
Adds an instance of the distributed cache service to a local server. |
Clear-SPDistributedCacheItem |
Clears cached items from the distributed cache server. |
Get-SPDistributedCacheClientSetting |
Returns distributed cache settings from usage. |
Remove-SPDistributedCacheServiceInstance |
Removes an instance of the distributed cache service from a local server. |
Set-SPDistributedCacheClientSetting |
Sets distributed cache settings. |
Stop-SPDistributedCacheServiceInstance |
Stops an instance of the Distributed Cache service on a local server. |
Update-SPDistributedCacheSize |
Reconfigures the allocation of memory that is dedicated to the Distributed Cache service. |
Excel Calculation Services cmdlets
Cmdlet | Description |
---|---|
Get-SPExcelBIServer |
Returns the server ID of the instance of Analysis Services. |
Get-SPExcelBlockedFileType |
Returns a file type or list of file types that are prevented from loading. |
Get-SPExcelDataConnectionLibrary |
Returns a trusted data connection library or a list of trusted data connection libraries. |
Get-SPExcelDataProvider |
Returns a safe data provider or a list of safe data providers. |
Get-SPExcelFileLocation |
Returns a trusted file ___location or a list of trusted file locations. |
Get-SPExcelServiceApplication |
Returns an SPExcelServiceApplication object. |
Get-SPExcelUserDefinedFunction |
Returns a user-defined function or a collection of user-defined functions. |
New-SPExcelBIServer |
Configures Analysis Services servers to work with Excel Services. |
New-SPExcelBlockedFileType |
Adds a file type to the list of file types that Excel Services Application prevents from loading. |
New-SPExcelDataConnectionLibrary |
Adds a new data connection library to Excel Services Application. |
New-SPExcelDataProvider |
Adds a new safe data provider to Excel Services Application. |
New-SPExcelFileLocation |
Adds a new trusted ___location to Excel Services Application. |
New-SPExcelServiceApplication |
Creates a new instance of Excel Services Application. |
New-SPExcelUserDefinedFunction |
Adds a new user-defined function to Excel Services Application. |
Remove-SPExcelBIServer |
Removes an instance of Analysis Services. |
Remove-SPExcelBlockedFileType |
Removes an entry from the list of file types that are prevented from loading on Excel Services Application. |
Remove-SPExcelDataConnectionLibrary |
Removes a data connection library from Excel Services Application. |
Remove-SPExcelDataProvider |
Removes a data provider from Excel Services Application. |
Remove-SPExcelFileLocation |
Removes a trusted file ___location from Excel Services Application. |
Remove-SPExcelUserDefinedFunction |
Removes a user-defined function from Excel Services Application. |
Set-SPExcelBIServer |
Specifies a description for an existing BI server for Excel Services. |
Set-SPExcelDataConnectionLibrary |
Sets properties of a data connection library for Excel Services Application. |
Set-SPExcelDataProvider |
Sets properties of a safe data provider for Excel Services Application. |
Set-SPExcelFileLocation |
Sets properties of a trusted file ___location for Excel Services Application. |
Set-SPExcelServiceApplication |
Sets global properties for Excel Services Application. |
Set-SPExcelUserDefinedFunction |
Sets properties of a user-defined function in Excel Services Application. |
Farm cmdlets
Cmdlet | Description |
---|---|
Disable-SPTimerJob |
Disables a timer job. |
Enable-SPTimerJob |
Enables a timer job. |
Get-SPBrowserCustomerExperienceImprovementProgram |
Returns the current opt-in state for the browser Customer Experience Improvement Program. |
Get-SPFarm |
Returns the local SharePoint farm. |
Get-SPFarmConfig |
Returns a global property or a collection of global properties for the local farm. |
Get-SPMobileMessagingAccount |
Retrieves mobile messaging accounts for the specified Web application. |
Get-SPProcessAccount |
Returns a system account or a managed account. |
Get-SPProduct |
Returns a list of the SharePoint-related products installed in the farm and the versions of all updates installed for each product. |
Get-SPServer |
Returns the server or servers in the farm that match the given identity. |
Get-SPService |
Gets a service in the farm. |
Get-SPServiceHostConfig |
Returns the common Web service settings. |
Get-SPServiceInstance |
Returns the services instance for a specific server or the entire farm. |
Get-SPTimerJob |
Returns timer jobs. |
Get-SPUserSettingsProvider |
Returns a list of User Settings Providers installed on the farm. |
Get-SPUserSettingsProviderManager |
Returns the User Settings Provider Manager. |
Get-SPWebPartPack |
Returns the Web Part packages that were installed for the specified scope. |
Install-SPWebPartPack |
Installs the specified Web Part package to the specified ___location. |
New-SPUserSettingsProvider |
Adds a new User Settings Provider. |
Remove-SPApplicationCredentialKey |
Removes the application credential key from the local server. |
Remove-SPUserSettingsProvider |
Removes a User Settings Provider. |
Rename-SPServer |
Renames a server that is currently connected to the farm. |
Set-SPApplicationCredentialKey |
Sets the application credential key on the local server. |
Set-SPBrowserCustomerExperienceImprovementProgram |
Turns on or off the browser Customer Experience Improvement Program. |
Set-SPCustomLayoutsPage |
Maps a new path for a custom layout page. |
Set-SPFarmConfig |
Sets a global property or a collection of global properties for the local farm. |
Set-SPIRMSettings |
Sets the Information Rights Management (IRM) settings. |
Set-SPMobileMessagingAccount |
Configures the specified mobile messaging account. |
Set-SPServiceHostConfig |
Configures one or more common settings for all Web services. |
Set-SPTimerJob |
Sets the schedule for running a timer job. |
Start-SPAdminJob |
Immediately starts any waiting administrative job on the local computer. |
Start-SPService |
Enables a service in the farm. |
Start-SPServiceInstance |
Starts the service instance for a service on a specific server or the farm. |
Start-SPTimerJob |
Runs a timer job once. |
Stop-SPService |
Disables a service in the farm. |
Stop-SPServiceInstance |
Stops the service instance for a service. |
Uninstall-SPWebPartPack |
Uninstalls the specified Web Part package. |
Unpublish-SPServiceApplication |
Stops sharing the specified service application outside the farm. |
Farm and Sandbox Solutions cmdlets
Cmdlet | Description |
---|---|
Add-SPSolution |
Uploads a SharePoint solution package to the farm. |
Add-SPUserSolution |
Uploads a new sandboxed solution to the solution gallery. |
Disable-SPUserSolutionAllowList |
Disables the user managed solutions gallery capability on the farm. |
Enable-SPUserSolutionAllowList |
Enables the user managed solutions gallery capability on the farm. |
Get-SPSolution |
Returns a specified SharePoint solution. |
Get-SPUserSolution |
Returns a specified sandboxed solution. |
Get-SPUserSolutionAllowList |
Gets the user managed solutions gallery configured on the specified web application. |
Install-SPSolution |
Deploys an installed SharePoint solution in the farm. |
Install-SPUserSolution |
Activates a sandboxed solution in a site collection. |
New-SPUserSolutionAllowList |
Creates a user managed solutions gallery. |
Remove-SPSolution |
Removes a SharePoint solution from a farm. |
Remove-SPSolutionDeploymentLock |
Removes the solution deployment lock for a server. |
Remove-SPUserSolution |
Removes a sandboxed solution from the solution gallery. |
Uninstall-SPSolution |
Retracts a deployed SharePoint solution. |
Uninstall-SPUserSolution |
Deactivates a sandboxed solution in a site collection. |
Update-SPSolution |
Upgrades a deployed SharePoint solution. |
Update-SPUserSolution |
Upgrades an activated sandboxed solution in a farm. |
FAST Search Service cmdlets
Cmdlet | Description |
---|---|
Add-FASTSearchResource |
Uploads a resource to the resource store. |
Add-FASTSearchSpelltuning |
Enables the spell tuning processor, used to fine-tune a spell check dictionary. |
Clear-FASTSearchContentCollection |
Clears the content of a Microsoft FAST Search Server 2010 for SharePoint content collection. |
Get-FASTSearchContentCollection |
Retrieves Microsoft FAST Search Server 2010 for SharePoint content collections. |
Get-FASTSearchDocumentProcessingPipeline |
Retrieves FAST Search Server 2010 for SharePoint document processing pipelines. |
Get-FASTSearchMetadataCategory |
Retrieves a crawled property category. |
Get-FASTSearchMetadataCrawledProperty |
Retrieves a crawled property from Microsoft FAST Search Server 2010 for SharePoint. |
Get-FASTSearchMetadataCrawledPropertyMapping |
Retrieves a list of crawled properties mapped to a managed property. |
Get-FASTSearchMetadataFullTextIndex |
Retrieves a full text index. |
Get-FASTSearchMetadataFullTextIndexMapping |
Retrieves mappings between managed properties and the full text indexes. |
Get-FASTSearchMetadataManagedProperty |
Retrieves a managed property with the specified name. |
Get-FASTSearchMetadataRankProfile |
Retrieves rank profiles from the Microsoft FAST Search Server 2010 for SharePoint system. |
Get-FASTSearchResource |
Downloads a resource from the resource store. |
Get-FASTSearchSearchSettingGroup |
Retrieves Microsoft FAST Search Server 2010 for SharePoint search setting groups. |
Get-FASTSearchSecurityAliaser |
Gets a security principal aliaser. |
Get-FASTSearchSecurityCCTKServer |
Gets the CCTK server general setting. |
Get-FASTSearchSecurityClaimsUserStore |
Get the claims security user store. |
Get-FASTSearchSecurityCompleteGroupExpansion |
Gets complete group expansion information for a user. |
Get-FASTSearchSecurityDecodedSid |
Gets the user identifier and SID from the encoded security identifier. |
Get-FASTSearchSecurityDefaultUserStore |
Gets the default user store general setting. |
Get-FASTSearchSecurityEncodedSid |
Gets the encoded extended security identifier. |
Get-FASTSearchSecurityGeneralSettings |
Gets the security general settings. |
Get-FASTSearchSecurityLogLevel |
Gets the log level general setting. |
Get-FASTSearchSecurityLotusNotesUserStore |
Gets a Lotus Notes user store. |
Get-FASTSearchSecurityPublicFilter |
Gets the public filter general setting. |
Get-FASTSearchSecurityRegexAliaser |
Gets a regular expression principal aliaser. |
Get-FASTSearchSecurityUserFilter |
Gets a user's search security filter. |
Get-FASTSearchSecurityUserStore |
Gets a user store. |
Get-FASTSearchSecurityUserStoreGroupExpansion |
Gets all groups in a user store that the specified user is a member of. |
Get-FASTSearchSecurityWorkerNode |
Gets status information about a security worker or workers. |
Get-FASTSearchSecurityXMLAliaser |
Gets a security principal aliaser. |
Get-FASTSearchSpelltuningStatus |
Retrieves the status of spell tuning. |
Install-FASTSearchAdminDatabase |
Installs the database used by the Microsoft FAST Search Server 2010 for SharePoint administration services. |
New-FASTSearchContentCollection |
Creates a new Microsoft FAST Search Server 2010 for SharePoint content collection. |
New-FASTSearchMetadataCategory |
Creates a new category for crawled properties. |
New-FASTSearchMetadataCrawledProperty |
Creates a new crawled property. |
New-FASTSearchMetadataCrawledPropertyMapping |
Creates a new mapping from a crawled property to a managed property. |
New-FASTSearchMetadataFullTextIndex |
Creates a new full text index. |
New-FASTSearchMetadataFullTextIndexMapping |
Creates a new mapping from a managed property into the full text index. |
New-FASTSearchMetadataManagedProperty |
Creates a new managed property. |
New-FASTSearchMetadataRankProfile |
Creates a new rank profile to calculate relevance in queries. |
New-FASTSearchSearchSettingGroup |
Creates a new Microsoft FAST Search Server 2010 for SharePoint search setting group. |
New-FASTSearchSecurityClaimsUserStore |
Creates a FAST Search Server 2010 for SharePoint security user store to provide security for claims content. |
New-FASTSearchSecurityLotusNotesUserStore |
Creates a FAST Search Server 2010 for SharePoint security user store to provide security for Lotus Notes content. |
New-FASTSearchSecurityRegexAliaser |
Creates a regular expression aliaser. |
New-FASTSearchSecurityRegexAliaserPattern |
Creates a new regular expression pattern for a regex principal aliaser. |
New-FASTSearchSecurityXMLAliaser |
Creates an XML principal aliaser. |
Remove-FASTSearchContentCollection |
Deletes a Microsoft FAST Search Server 2010 for SharePoint content collection. |
Remove-FASTSearchMetadataCategory |
Removes a crawled property category from the installation. |
Remove-FASTSearchMetadataCrawledPropertyMapping |
Removes a crawled-property-to-managed-property mapping. |
Remove-FASTSearchMetadataFullTextIndex |
Removes a full text index from the Microsoft FAST Search Server 2010 for SharePoint system. |
Remove-FASTSearchMetadataFullTextIndexMapping |
Removes a managed-property-to-full-text-index mapping. |
Remove-FASTSearchMetadataManagedProperty |
Removes a managed property from the Microsoft FAST Search Server 2010 for SharePoint system. |
Remove-FASTSearchMetadataRankProfile |
Removes a rank profile from the Microsoft FAST Search Server 2010 for SharePoint system. |
Remove-FASTSearchResource |
Deletes a resource from the resource store. |
Remove-FASTSearchSearchSettingGroup |
Deletes a Microsoft FAST Search Server 2010 for SharePoint search setting group. |
Remove-FASTSearchSecurityAliaser |
Removes a security aliaser. |
Remove-FASTSearchSecurityUserStore |
Removes a user store. |
Remove-FASTSearchSpelltuning |
Disables spell tuning. |
Set-FASTSearchConfiguration |
Configures the local instance of Microsoft FAST Search Server 2010 for SharePoint. |
Set-FASTSearchIPSec |
Configures local Internet Protocol security (IPsec) for Microsoft FAST Search Server 2010 for SharePoint. |
Set-FASTSearchMetadataCategory |
Updates the settings of a crawled property category. |
Set-FASTSearchMetadataCrawledProperty |
Updates the properties of a crawled property. |
Set-FASTSearchMetadataCrawledPropertyMapping |
Specifies which crawled properties map into specific managed properties. |
Set-FASTSearchMetadataFullTextIndex |
Updates the properties of a full text index. |
Set-FASTSearchMetadataFullTextIndexMapping |
Updates the importance level of an existing full text index mapping. |
Set-FASTSearchMetadataManagedProperty |
Updates the features of a managed property. |
Set-FASTSearchMetadataRankProfile |
Reconfigures a rank profile. |
Set-FASTSearchSecurityCCTKServer |
Updates the CCTK server general setting. |
Set-FASTSearchSecurityClaimsUserStore |
Updates a claims user store. |
Set-FASTSearchSecurityDefaultUserStore |
Updates the default user store general setting. |
Set-FASTSearchSecurityLogLevel |
Updates the log level general setting. |
Set-FASTSearchSecurityLotusNotesUserStore |
Updates a Lotus Notes user store. |
Set-FASTSearchSecurityPublicFilter |
Updates the public filter general setting. |
Set-FASTSearchSecurityRegexAliaser |
Updates a regular expression aliaser. |
Set-FASTSearchSecurityXMLAliaser |
Updates an XML aliaser. |
Uninstall-FASTSearchAdminDatabase |
Uninstalls the database used by the Microsoft FAST Search Server 2010 for SharePoint administration services. This cmdlet is primarily called during uninstallation by the FAST Search Server 2010 for SharePoint installer. |
Feature cmdlets
Cmdlet | Description |
---|---|
Disable-SPFeature |
Disables an installed SharePoint Feature at a given scope. |
Enable-SPFeature |
Enables an installed SharePoint Feature at the given scope. |
Get-SPFeature |
Returns the SharePoint Features based on a given scope. |
Install-SPFeature |
Installs a SharePoint Feature by using the Feature.xml file. |
Uninstall-SPFeature |
Uninstalls an installed feature definition. |
Hybrid and Migration cmdlets
Cmdlet | Description |
---|---|
Copy-SPContentTypes |
Specifies content types for replicating from on-premises to SharePoint Online (SPO) environment. |
Get-SPInsightsConfig |
Returns the uploader.xml and Microsoft.Office.BigData.DataLoader.exe.config files from the Configuration database. |
Get-SPO365LinkSettings |
Gets hybrid configurations. |
New-SPAzureAccessControlServiceApplicationProxy |
Creates a new service application proxy group. |
Set-SPO365LinkSettings |
Set SharePoint O365 Link Settings for Hybrid Configuration. |
Stop-SPContentTypeReplication |
Stops Content Type replication job from SharePoint Online. |
Test-SPO365LinkSettings |
Validates whether the configured Office 365 hybrid site uses a valid template. |
Identity (General) cmdlets
Cmdlet | Description |
---|---|
Add-SPClaimTypeMapping |
Adds a claim mapping to a trusted security token service (STS) identity provider. |
Get-SPClaimProvider |
Returns a claim provider. |
Get-SPClaimProviderManager |
Returns a claim provider manager. |
Get-SPClaimTypeEncoding |
Returns a list of all the types of claims. |
Get-SPUser |
Returns the user account or accounts that match a given search criteria. |
Move-SPUser |
Migrates a user account in SharePoint Products. |
New-SPClaimProvider |
Registers a new claim provider in the farm. |
New-SPClaimsPrincipal |
Creates a claims principal. |
New-SPClaimTypeEncoding |
Registers a new type of claim. |
New-SPClaimTypeMapping |
Creates a claim mapping rule for a security token service (STS) identity provider. |
New-SPManagedAccount |
Registers a new managed account. |
New-SPUser |
Adds an existing user to a SharePoint site with the designated permissions. |
Remove-SPClaimProvider |
Unregisters a claim provider. |
Remove-SPClaimTypeMapping |
Deletes a claim type mapping rule for a security token service (STS) identity provider. |
Remove-SPManagedAccount |
Removes a managed account registration from the farm. |
Remove-SPUser |
Removes a user from a Web site. |
Set-SPClaimProvider |
Updates registration of a claims provider. |
Set-SPUser |
Configures properties of an existing user. |
InfoPath Forms Service cmdlets
Cmdlet | Description |
---|---|
Add-SPInfoPathUserAgent |
Adds a user agent to a farm. |
Disable-SPInfoPathFormTemplate |
Deactivates a InfoPath form template from the specified site collection. |
Enable-SPInfoPathFormTemplate |
Activates a InfoPath form template in the specified site collection. |
Export-SPInfoPathAdministrationFiles |
Saves InfoPath form templates on the SharePoint Central Administration Web site and .udcx files to a .cab file. |
Get-SPDataConnectionFile |
Returns a data connection file or a collection of data connection files. |
Get-SPDataConnectionFileDependent |
Returns deployed forms on the server dependent on a universal data connection. |
Get-SPInfoPathFormsService |
Returns the InfoPath Forms Services in SharePoint Server settings that are in the farm. |
Get-SPInfoPathFormTemplate |
Returns a InfoPath form template. |
Get-SPInfoPathUserAgent |
Returns a user agent or all the currently defined user agents for the farm. |
Get-SPInfoPathWebServiceProxy |
Returns the Web proxy settings for the Web application. |
Import-SPInfoPathAdministrationFiles |
Imports InfoPath form templates and .udcx files that are located on the SharePoint Central Administration Web site. |
Install-SPDataConnectionFile |
Installs the provided data connection file. |
Install-SPInfoPathFormTemplate |
Installs an InfoPath form template on a farm. |
Remove-SPInfoPathUserAgent |
Removes a user agent. |
Set-SPDataConnectionFile |
Sets properties of a data connection file. |
Set-SPInfoPathFormsService |
Sets parameters for InfoPath Forms Services in SharePoint Server. |
Set-SPInfoPathFormTemplate |
Sets properties of a InfoPath form template. |
Set-SPInfoPathWebServiceProxy |
Sets parameters for an existing SharePoint Web service application. |
Start-SPInfoPathFormTemplate |
Activates a previously quiesced InfoPath form template. |
Stop-SPInfoPathFormTemplate |
Disables a InfoPath form template on a farm before an upgrade. |
Test-SPInfoPathFormTemplate |
Validates that a InfoPath form template is browser-enabled. |
Uninstall-SPDataConnectionFile |
Removes a data connection file. |
Uninstall-SPInfoPathFormTemplate |
Removes a InfoPath form template from a farm. |
Update-SPInfoPathAdminFileUrl |
Updates InfoPath form templates (.xsn files) and universal data connections (.udcx files), including all .xsn files and .udcx files that were deployed by an administrator. |
Update-SPInfoPathFormTemplate |
Upgrades all InfoPath form templates on the farm. |
Update-SPInfoPathUserFileUrl |
Updates InfoPath form templates (.xsn files) and universal data connections (.udcx files). |
Installation and Upgrade cmdlets
Cmdlet | Description |
---|---|
Connect-SPConfigurationDatabase |
Connects the local server computer to a farm. |
Copy-SPSideBySideFiles |
Copy side by side files. |
Disconnect-SPConfigurationDatabase |
Disconnects the local server computer from the farm. |
Get-SPPendingUpgradeActions |
Displays pending upgrade actions. |
Get-SPUpgradeActions |
Returns all upgrade actions. |
Initialize-SPResourceSecurity |
Enforces resource security on the local server. |
Install-SPApplicationContent |
Copies shared application data to existing Web application folders. |
Install-SPHelpCollection |
Installs the provided Help site collection files in the current farm. |
Install-SPService |
Installs and provisions services on a farm. |
New-SPCentralAdministration |
Creates a new SharePoint Central Administration Web application. |
New-SPConfigurationDatabase |
Creates a new configuration database. |
Remove-SPCentralAdministration |
Removes the SharePoint Central Administration web site from the local server. |
Remove-SPConfigurationDatabase |
Permanently removes a configuration database. |
Set-SPCentralAdministration |
Sets the port for the SharePoint Central Administration Web site. |
Set-SPPassPhrase |
Sets the pass phrase to a new value. |
Set-SPServer |
Changes the role of the server. |
Uninstall-SPHelpCollection |
Removes Help collection files. |
Update-SPFarmEncryptionKey |
Changes the value of the farm encryption key and using the new key, re-encrypts all the data. |
Upgrade-SPFarm |
Activates the Upgrade method for the local farm. |
Machine Translation Services cmdlets
Cmdlet | Description |
---|---|
Get-SPTranslationThrottlingSetting |
Gets time duration settings. |
New-SPTranslationServiceApplication |
Provisions a new instance of the Machine Translation service. |
New-SPTranslationServiceApplicationProxy |
Creates a Machine Translation Service application proxy on the local farm. |
Remove-SPTranslationServiceJobHistory |
Removes Machine Translation service jobs. |
Set-SPTranslationServiceApplication |
Sets property settings on a Machine Translation service application. |
Set-SPTranslationServiceApplicationProxy |
Sets properties to the Machine Translation service application proxy. |
Set-SPTranslationThrottlingSetting |
Sets the timer job duration. |
Managed Account cmdlets
Cmdlet | Description |
---|---|
Get-SPManagedAccount |
Retrieves accounts registered in the configuration database. |
Repair-SPManagedAccountDeployment |
Repairs the local managed account credential deployment. |
Set-SPManagedAccount |
Configures the managed account. |
Managed Metadata Service cmdlets
Cmdlet | Description |
---|---|
Copy-SPTaxonomyGroups |
Copies Managed Metadata Taxonomy Groups from SharePoint on-premises to SharePoint Online. |
Export-SPMetadataWebServicePartitionData |
Exports the data from a metadata Web service for a site subscription. |
Get-SPMetadataServiceApplication |
Returns a managed metadata service application. |
Get-SPMetadataServiceApplicationProxy |
Returns an existing connection to a managed metadata service application, which is also known as a proxy, to the managed metadata service application. |
Get-SPTaxonomySession |
Returns a TaxonomySession object. |
Import-SPMetadataWebServicePartitionData |
Restores the data for a site subscription. |
Move-SPProfileManagedMetadataProperty |
Moves multiple-string values into a term set. |
New-SPMetadataServiceApplication |
Creates a new managed metadata service application. |
New-SPMetadataServiceApplicationProxy |
Creates a new connection to a managed metadata service application. |
Set-SPMetadataServiceApplication |
Sets the properties of a managed metadata service application. |
Set-SPMetadataServiceApplicationProxy |
Sets the properties of a connection to a managed metadata service application. |
Stop-SPTaxonomyReplication |
Terminates Hybrid SharePoint Taxonomy replication from SharePoint Online site to local SharePoint on-premises site. |
Office Store Apps Default Activation cmdlets
Cmdlet | Description |
---|---|
Get-SPOfficeStoreAppsDefaultActivation |
Returns the properties of apps for Office. |
Set-SPOfficeStoreAppsDefaultActivation |
Sets the properties of apps for Office. |
Office Web Apps/Office Online Server cmdlets
Cmdlet | Description |
---|---|
Get-SPWOPIBinding |
Returns a list of bindings that were created by using New-SPWOPIBinding on the current SharePoint farm where this cmdlet is run. |
Get-SPWOPISuppressionSetting |
Returns the suppression settings on the current SharePoint farm where this cmdlet is run. |
Get-SPWOPIZone |
Returns the zone that is configured on the current SharePoint farm for the WOPI application to use. |
New-SPWOPIBinding |
Creates a new binding to associate file name extensions or applications with actions on the current SharePoint farm where this cmdlet is run. |
New-SPWOPISuppressionSetting |
Disables Office Web Apps for the action, file name extension, or programmatic identifier that you've specified on the current SharePoint farm. |
Remove-SPWOPIBinding |
Removes bindings for applications, file name extensions and their associated actions on the current SharePoint farm where this cmdlet is run. |
Remove-SPWOPISuppressionSetting |
Removes the suppression settings for a file name extension or programmatic ID and action on the current SharePoint farm where this cmdlet is run. |
Set-SPWOPIBinding |
Updates the default click action for an application or file name extension binding. |
Set-SPWOPIZone |
Configures the zone that the current SharePoint farm will use to navigate the browser to the WOPI application. |
Update-SPWOPIProofKey |
Updates the public key that is used to connect to the WOPI application on the current SharePoint farm where this cmdlet is run. |
PerformancePoint Services cmdlets
Cmdlet | Description |
---|---|
Clear-SPPerformancePointServiceApplicationTrustedLocation |
Clears all the trusted locations for a PerformancePoint Service application identity. |
Export-SPPerformancePointContent |
Exports a Performance Point Server (PPS) dashboard. |
Get-SPPerformancePointServiceApplication |
Returns a PerformancePoint Service application object and properties. |
Get-SPPerformancePointServiceApplicationTrustedLocation |
Returns a trusted ___location object and properties for a PerformancePoint Service application. |
Import-SPPerformancePointContent |
Imports a Performance Point Server (PPS) dashboard. |
New-SPPerformancePointServiceApplication |
Creates a new service application for the PerformancePoint Service. |
New-SPPerformancePointServiceApplicationProxy |
Creates a proxy for a PerformancePoint Service application. |
New-SPPerformancePointServiceApplicationTrustedLocation |
Creates a new trusted ___location for a PerformancePoint Service application. |
Remove-SPPerformancePointServiceApplication |
Deletes a PerformancePoint Service application from a farm. |
Remove-SPPerformancePointServiceApplicationProxy |
Deletes the proxy for a PerformancePoint Service application. |
Remove-SPPerformancePointServiceApplicationTrustedLocation |
Removes a single trusted ___location from a PerformancePoint Service application. |
Set-SPPerformancePointSecureDataValues |
Sets global settings for the unattended service account. |
Set-SPPerformancePointServiceApplication |
Sets global runtime properties for a PerformancePoint Services application. |
PowerPoint Conversion Services cmdlets
Cmdlet | Description |
---|---|
New-SPPowerPointConversionServiceApplication |
Creates a PowerPoint Conversion Service application. |
New-SPPowerPointConversionServiceApplicationProxy |
Creates a PowerPoint Conversion Service application proxy. |
Set-SPPowerPointConversionServiceApplication |
Configures settings for a PowerPoint Conversion Service application. |
PowerShell (General) cmdlets
Cmdlet | Description |
---|---|
Deploy-SPVariation |
Creates new site variations on the source variation site specified by the Identity parameter for all target variations labels. |
Get-SPVariationJob |
Displays the current status of Variations. |
Repair-SPVariation |
Corrects invalid variations system data that is found. |
Start-SPAssignment |
Initiates a new assignment store. |
Stop-SPAssignment |
Disposes of objects in the provided assignment collection. |
Test-SPVariation |
Analyzes the variations hierarchy and reports identified problems. |
Update-SPHelp |
Updates SharePoint cmdlet help. |
Project Server cmdlets
Cmdlet | Description |
---|---|
Disable-ProjectServerLicense |
If the farm has Project Server enabled, this cmdlet will disable the Project Server functionality across the farm. All Project Web App sites will be read only and will still contain any data that existed before the license was disabled. New Project Web App sites cannot be created. |
Disable-SPProjectActiveDirectoryEnterpriseResourcePoolSync |
Disables Timer Job execution of the Active Directory Enterprise Resource Pool synchronization. |
Disable-SPProjectEmailNotification |
Turns off the Project Web App site level setting for email notifications in Project Server. |
Disable-SPProjectEnterpriseProjectTaskSync |
Disables task sync between Project Web App and the associated project site. Once this is disabled, tasks created in the enterprise project in Project Web App will no longer sync to the task list on the project site associated with the project. This feature is disabled by default. |
Disable-SPProjectQueueStatsMonitoring |
Disables monitoring Project Server queue statistics. |
Enable-ProjectServerLicense |
Enables all Project Server functionality in the farm. The cmdlet depends on the farm having a valid SharePoint Server license (trials are allowed). Any existing Project Web App sites will become read/write. A Project Server Trial key will only be accepted if the farm has never had a Project Server trial key previously. |
Enable-SPProjectActiveDirectoryEnterpriseResourcePoolSync |
Enables Timer Job execution of the Active Directory Enterprise Resource Pool synchronization. |
Enable-SPProjectEmailNotification |
Turns on the Project Web App site level setting for email notifications in Project Server. |
Enable-SPProjectEnterpriseProjectTaskSync |
Enables task sync between Project Web App and the associated project site. Once this is enabled, tasks created in the enterprise project in Project Web App will sync to the task list on the project site associated with the project. This feature is disabled by default. If you enable this feature, the restrictions that come with SharePoint lists, such as the maximum number of items supported before throttling, apply. Syncing tasks uses the queue and can affect performance. You should enable it only if you really need it. |
Enable-SPProjectQueueStatsMonitoring |
Enables monitoring Project Server queue statistics. |
Get-ProjectServerLicense |
Retrieves the status of the license for Project Server. If the current license is a trial, it will also indicate the expiry date and if it has expired. |
Get-SPProjectDatabaseQuota |
Microsoft internal use only. |
Get-SPProjectDatabaseUsage |
Returns an approximate size, in megabytes (MB) of the Project Web App data used in the content database. |
Get-SPProjectEnterpriseProjectTaskSync |
Returns whether the task list sync between Project Web App and project sites is enabled or disabled. This cmdlet returns a value only if the feature has previously been enabled or disabled. |
Get-SPProjectEventServiceSettings |
Returns the settings for the Microsoft Project Server Events Service. There is currently only one setting which is the port that the service listens on for requests. |
Get-SPProjectIsEmailNotificationEnabled |
Returns the Project Web App site level setting for email notifications. True if notifications is turned on, False otherwise. |
Get-SPProjectOdataConfiguration |
Returns the settings for how the OData service is configured for an instance of Project Web App. |
Get-SPProjectPCSSettings |
Gets the settings for the Project Calculation Engine on the Project Server. |
Get-SPProjectPermissionMode |
Returns the permission mode for a Project Web App (PWA) instance. |
Get-SPProjectQueueSettings |
Returns a list of all Project Server Queue settings and their current values for the specified Project Server Service Application. |
Get-SPProjectWebInstance |
Returns an instance of a Project Web App site. |
Invoke-SPProjectActiveDirectoryEnterpriseResourcePoolSync |
Triggers Active Directory Enterprise Resource Pool synchronization on the specified instance of Project Web App. |
Invoke-SPProjectActiveDirectoryGroupSync |
Manually starts the synchronization job to synchronize Project Server group membership with the specified Active Directory groups. |
Migrate-SPProjectDatabase |
Copies the data from the Project Server 2013 database into the corresponding SharePoint Server 2016 content database containing the migrated site collection. |
Migrate-SPProjectResourcePlans |
Migrates the published resource plan assignment data to engagements. Run after data migration has been completed from Project Server 2013 to Project Server 2016, Project Server 2019. |
New-SPProjectServiceApplication |
Creates a new Project Server Service application. |
New-SPProjectServiceApplicationProxy |
Creates a proxy for a Project Server Service application. |
Pause-SPProjectWebInstance |
Switches the specified instance of Project Web App to read-only, preventing any changes from being made through the Project Server PSI or CSOM. |
Remove-SPProjectWebInstanceData |
Disassociates a Site Collection with the Project Server instance. |
Repair-SPProjectWebInstance |
Re-queues specific Project Server queue items that may have fallen out of the queue. |
Reset-SPProjectEventServiceSettings |
Resets the Microsoft Project Server Events Service 2016 settings to the default values. The Microsoft Project Server Events Service 2016 needs to be restarted for the changes to take effect. |
Reset-SPProjectPCSSettings |
Resets the settings for the Project Calculation Engine on Project Server. |
Reset-SPProjectQueueSettings |
Resets all Project Server Queue settings to their default values for a specific Project Server Service Application. |
Resume-SPProjectWebInstance |
Switches the specified instance of Project Web App to read-write mode, allowing users to change data again. |
Set-SPProjectDatabaseQuota |
Microsoft internal use only. |
Set-SPProjectEventServiceSettings |
Allows you to change the Microsoft Project Server Events Service 2016 TCP port settings. If you change the TCP port, the Microsoft Project Server Events Service 2016 needs to be restarted for the changes to take effect. |
Set-SPProjectOdataConfiguration |
Sets the properties for how the OData service is configured for an instance of Project Web App. |
Set-SPProjectPCSSettings |
Sets the settings for the Project Calculation Engine on Project Server. |
Set-SPProjectPermissionMode |
Changes the permission mode for a Project Web App instance. Running this cmdlet deletes all security settings and reverts to the default settings for the specified mode. |
Set-SPProjectQueueSettings |
Sets the value of one or multiple Project Server Queue settings for a specific Project Server service application. |
Set-SPProjectServiceApplication |
Sets the properties of a Project Server Service application. |
Set-SPProjectUserSync |
Controls the behavior of WSS user sync. |
Set-SPProjectUserSyncDisabledSyncThreshold |
Defines the threshold over which a user sync job will not be executed but instead will be deleted. This threshold is the product of the number of projects multiplied by the number of users. |
Set-SPProjectUserSyncFullSyncThreshold |
Defines the threshold over which a delta user sync job will be executed as a complete user sync. This threshold is the product of the number of projects multiplied by the number of users. |
Set-SPProjectUserSyncOffPeakSyncThreshold |
Defines the threshold over which a full user sync job will be executed during off peak hours instead of immediately. This threshold is the product of the number of projects multiplied by the number of users. |
Start-SPProjectGenerateWsdl |
Generates ASPX pages from WSDL files. |
Sync-SPProjectPermissions |
Manually synchronizes permissions between a Project Web App instance and its associated project sites. |
Test-SPProjectServiceApplication |
This cmdlet runs a series of health checks against the Project Service Application. |
Test-SPProjectWebInstance |
Runs a suite of tests on an existing Project Web Instance. |
Request Management cmdlets
Cmdlet | Description |
---|---|
Add-SPRoutingMachineInfo |
Adds a new routing target to the farm. |
Add-SPRoutingMachinePool |
Adds a new machine pool. |
Add-SPRoutingRule |
Adds a routing rule. |
Add-SPThrottlingRule |
Adds a new throttling rule. |
Get-SPRequestManagementSettings |
Returns a Request Manager object. |
Get-SPRoutingMachineInfo |
Returns all the routing targets. |
Get-SPRoutingMachinePool |
Returns all available routing pools. |
Get-SPRoutingRule |
Returns all routing rules. |
Get-SPThrottlingRule |
Returns all throttling rules. |
New-SPRequestManagementRuleCriteria |
Creates criteria for the rule to match. |
Remove-SPRoutingMachineInfo |
Removes an external routing target. |
Remove-SPRoutingMachinePool |
Removes a routing pool from Request Manager. |
Remove-SPRoutingRule |
Removes a routing rule. |
Remove-SPThrottlingRule |
Removes a throttling rule. |
Set-SPRequestManagementSettings |
Sets Request Manager properties. |
Set-SPRoutingMachineInfo |
Sets routing target properties. |
Set-SPRoutingMachinePool |
Sets properties of a machine pool. |
Set-SPRoutingRule |
Changes properties of an existing routing rule. |
Set-SPThrottlingRule |
Changes properties of an existing throttling rule. |
Search Service Application cmdlets
Cmdlet | Description |
---|---|
Backup-SPEnterpriseSearchServiceApplicationIndex |
Takes a backup of the search index to a specified backup ___location. |
Export-SPEnterpriseSearchTopology |
Saves an existing search topology. |
Get-SPEnterpriseSearchAdministrationComponent |
Returns the administration component for a search service application. |
Get-SPEnterpriseSearchComponent |
Retrieves one or all search components in a given search topology. |
Get-SPEnterpriseSearchContentEnrichmentConfiguration |
Returns the content enrichment configuration for the specified search service application. |
Get-SPEnterpriseSearchCrawlContentSource |
Returns a crawl content source. |
Get-SPEnterpriseSearchCrawlCustomConnector |
Returns a CustomConnector object type. |
Get-SPEnterpriseSearchCrawlDatabase |
Returns a crawl store. |
Get-SPEnterpriseSearchCrawlExtension |
Returns the file types to be included in the content index. |
Get-SPEnterpriseSearchCrawlLogReadPermission |
Retrieves the list of users with permission to access the crawl log information. |
Get-SPEnterpriseSearchCrawlMapping |
Returns a crawl mapping for the search application. |
Get-SPEnterpriseSearchCrawlRule |
Accesses crawl rules. |
Get-SPEnterpriseSearchFileFormat |
Retrieves all parseable file formats. |
Get-SPEnterpriseSearchHostController |
Lists the specified or all search host controllers in the farm. |
Get-SPEnterpriseSearchLanguageResourcePhrase |
Returns a language resource phrase. |
Get-SPEnterpriseSearchLinguisticComponentsStatus |
Returns the status of the linguistic query and document processing components. |
Get-SPEnterpriseSearchLinksDatabase |
Retrieves a reference to a links database. |
Get-SPEnterpriseSearchMetadataCategory |
Returns a crawled property category. |
Get-SPEnterpriseSearchMetadataCrawledProperty |
Returns a crawled property. |
Get-SPEnterpriseSearchMetadataManagedProperty |
Returns a managed property. |
Get-SPEnterpriseSearchMetadataMapping |
Returns the current status of a managed property mapping. |
Get-SPEnterpriseSearchOwner |
Retrieves the search object owner. |
Get-SPEnterpriseSearchPropertyRule |
Returns a property rule instance, which can be used in result item types. |
Get-SPEnterpriseSearchPropertyRuleCollection |
Returns the collection of rules that are applied to search results. |
Get-SPEnterpriseSearchQueryAndSiteSettingsService |
Returns the search manager service. |
Get-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance |
Returns the service manager service instance. |
Get-SPEnterpriseSearchQueryAndSiteSettingsServiceProxy |
Returns the search manager service proxy. |
Get-SPEnterpriseSearchQueryAuthority |
Returns an authoritative page. |
Get-SPEnterpriseSearchQueryDemoted |
Returns a demoted site rule. |
Get-SPEnterpriseSearchQueryKeyword |
Returns a keyword term. |
Get-SPEnterpriseSearchQueryScope |
Returns a query results scope. |
Get-SPEnterpriseSearchQueryScopeRule |
Returns a shared scope rule. |
Get-SPEnterpriseSearchQuerySpellingCorrection |
Returns the object that exposes the Query Spelling Correction (QSC) configuration. |
Get-SPEnterpriseSearchQuerySuggestionCandidates |
Returns a list of queries. |
Get-SPEnterpriseSearchRankingModel |
Returns a ranking model. |
Get-SPEnterpriseSearchResultItemType |
Retrieves result item types. |
Get-SPEnterpriseSearchResultSource |
Retrieves a result source. |
Get-SPEnterpriseSearchSecurityTrimmer |
Returns a custom security trimmer. |
Get-SPEnterpriseSearchService |
Returns the search service for the farm. |
Get-SPEnterpriseSearchServiceApplication |
Returns the search service application for a farm. |
Get-SPEnterpriseSearchServiceApplicationBackupStore |
Retrieves information about the search service application backup files. |
Get-SPEnterpriseSearchServiceApplicationProxy |
Returns the search service application proxy. |
Get-SPEnterpriseSearchServiceInstance |
Returns the search service instance for a farm. |
Get-SPEnterpriseSearchSiteHitRule |
Returns the shared site hit rule. |
Get-SPEnterpriseSearchStatus |
Retrieves diagnostics information for the search components. |
Get-SPEnterpriseSearchTopology |
Retrieves one or all search topologies that belong to a given search service application. |
Get-SPEnterpriseSearchVssDataPath |
Retrieves the index paths for all active search index components on the current server. |
Import-SPEnterpriseSearchCustomExtractionDictionary |
Imports a custom extraction dictionary. |
Import-SPEnterpriseSearchPopularQueries |
Imports queries from a comma-separated list. The search box will suggest these queries as users type. |
Import-SPEnterpriseSearchThesaurus |
Deploys the dictionary to the thesaurus component in the query processing flow. |
Import-SPEnterpriseSearchTopology |
Imports and activates a topology from an XML file. |
Move-SPEnterpriseSearchLinksDatabases |
Moves data across links databases. |
New-SPEnterpriseSearchAdminComponent |
Creates a new admin component for the given topology and search service instance. |
New-SPEnterpriseSearchAnalyticsProcessingComponent |
Creates a new analytics processing component for the given topology and search service instance. |
New-SPEnterpriseSearchContentEnrichmentConfiguration |
Creates a new ContentEnrichmentConfiguration object. |
New-SPEnterpriseSearchContentProcessingComponent |
Creates a new content processing component for the given topology and search service instance. |
New-SPEnterpriseSearchCrawlComponent |
Creates a new crawl component for the given topology and search service instance. |
New-SPEnterpriseSearchCrawlContentSource |
Creates a content source for a Search service application. |
New-SPEnterpriseSearchCrawlCustomConnector |
Registers a protocol for custom crawling. |
New-SPEnterpriseSearchCrawlDatabase |
Creates a crawl database which can be added to a search service application. |
New-SPEnterpriseSearchCrawlExtension |
Adds an extension rule to a Search service application. |
New-SPEnterpriseSearchCrawlMapping |
Creates a crawl mapping rule for a shared search application. |
New-SPEnterpriseSearchCrawlRule |
Creates a new crawl rule. |
New-SPEnterpriseSearchFileFormat |
Adds a new file format to the parsing system. |
New-SPEnterpriseSearchIndexComponent |
Creates a new index component for the given topology and search service instance. |
New-SPEnterpriseSearchLanguageResourcePhrase |
Adds a language resource phrase to a shared search application. |
New-SPEnterpriseSearchLinksDatabase |
Creates a new links database for a search service application. |
New-SPEnterpriseSearchMetadataCategory |
Adds a crawled property category to a search service application. |
New-SPEnterpriseSearchMetadataCrawledProperty |
Adds a crawled property. |
New-SPEnterpriseSearchMetadataManagedProperty |
Adds a managed property to a shared search application. |
New-SPEnterpriseSearchMetadataMapping |
Adds a managed property mapping. |
New-SPEnterpriseSearchQueryAuthority |
Adds an authoritative page to a shared search application. |
New-SPEnterpriseSearchQueryDemoted |
Adds a demoted site rule to a shared search application. |
New-SPEnterpriseSearchQueryKeyword |
Adds a keyword term to a shared search application. |
New-SPEnterpriseSearchQueryProcessingComponent |
Creates a new query processing component for the given topology and search service instance. |
New-SPEnterpriseSearchQueryScope |
Adds a query results scope to a shared search application. |
New-SPEnterpriseSearchQueryScopeRule |
Adds a shared scope rule to a query scope. |
New-SPEnterpriseSearchRankingModel |
Adds a ranking model to a shared search application. |
New-SPEnterpriseSearchResultItemType |
Creates a new result item type. |
New-SPEnterpriseSearchResultSource |
Creates a new result source. |
New-SPEnterpriseSearchSecurityTrimmer |
Adds a custom security trimmer to a shared search application. |
New-SPEnterpriseSearchServiceApplication |
Adds a search service application to a farm. |
New-SPEnterpriseSearchServiceApplicationProxy |
Adds a new search application proxy to a farm. |
New-SPEnterpriseSearchSiteHitRule |
Adds a new site hit rule for a search application. |
New-SPEnterpriseSearchTopology |
Creates a new search topology in the given search service application. |
Remove-SPEnterpriseSearchComponent |
Removes the specified search component from the given search topology. |
Remove-SPEnterpriseSearchContentEnrichmentConfiguration |
Removes the current content enrichment configuration from the search service application. |
Remove-SPEnterpriseSearchCrawlContentSource |
Deletes a specified crawl content source from a search application. |
Remove-SPEnterpriseSearchCrawlCustomConnector |
Removes a CustomConnector object. |
Remove-SPEnterpriseSearchCrawlDatabase |
Deletes a crawl database. |
Remove-SPEnterpriseSearchCrawlExtension |
Removes a file name extension from the list of files that can be crawled. |
Remove-SPEnterpriseSearchCrawlLogReadPermission |
Removes permission to view crawl log information. |
Remove-SPEnterpriseSearchCrawlMapping |
Deletes a crawl mapping. |
Remove-SPEnterpriseSearchCrawlRule |
Deletes a crawl rule. |
Remove-SPEnterpriseSearchFileFormat |
Removes support for parsing a file format. |
Remove-SPEnterpriseSearchLanguageResourcePhrase |
Deletes a language resource phrase from a shared search application. |
Remove-SPEnterpriseSearchLinksDatabase |
Deletes a links database. |
Remove-SPEnterpriseSearchMetadataCategory |
Deletes a crawled property category. |
Remove-SPEnterpriseSearchMetadataManagedProperty |
Deletes a metadata managed property. |
Remove-SPEnterpriseSearchMetadataMapping |
Deletes a metadata mapping from a managed property. |
Remove-SPEnterpriseSearchQueryAuthority |
Deletes an authoritative page. |
Remove-SPEnterpriseSearchQueryDemoted |
Deletes a demoted site rule. |
Remove-SPEnterpriseSearchQueryKeyword |
Deletes a query keyword. |
Remove-SPEnterpriseSearchQueryScope |
Deletes a query scope. |
Remove-SPEnterpriseSearchQueryScopeRule |
Deletes query results scope rules. |
Remove-SPEnterpriseSearchRankingModel |
Deletes a ranking model. |
Remove-SPEnterpriseSearchResultItemType |
Removes a result item type for a search object owner. |
Remove-SPEnterpriseSearchResultSource |
Deletes a result source. |
Remove-SPEnterpriseSearchSecurityTrimmer |
Deletes a custom security trimmer. |
Remove-SPEnterpriseSearchServiceApplication |
Deletes a search service application. |
Remove-SPEnterpriseSearchServiceApplicationProxy |
Deletes a search service application proxy. |
Remove-SPEnterpriseSearchServiceApplicationSiteSettings |
Cleans up search settings for a particular site collection, subscription, or search application. |
Remove-SPEnterpriseSearchSiteHitRule |
Deletes a site hit rule. |
Remove-SPEnterpriseSearchTenantConfiguration |
Removes all tenant specific search settings. |
Remove-SPEnterpriseSearchTenantSchema |
Removes a defined search schema. |
Remove-SPEnterpriseSearchTopology |
Removes an inactive search topology from a search service application. |
Restore-SPEnterpriseSearchServiceApplication |
Restores third-party backup of a search application. |
Restore-SPEnterpriseSearchServiceApplicationIndex |
Restores the search index from the specified backup files. |
Resume-SPEnterpriseSearchServiceApplication |
Resumes a search service application that was suspended. |
Set-SPEnterpriseSearchAdministrationComponent |
Sets properties of an administration component for a search service application. |
Set-SPEnterpriseSearchContentEnrichmentConfiguration |
Stores the specified content enrichment configuration to the search service application. |
Set-SPEnterpriseSearchCrawlContentSource |
Sets the properties of a crawl content source for a Search service application. |
Set-SPEnterpriseSearchCrawlDatabase |
Sets properties of a crawl database for a Search service application. |
Set-SPEnterpriseSearchCrawlLogReadPermission |
Grants users permission to view the crawl log information. |
Set-SPEnterpriseSearchCrawlRule |
Sets properties for a crawl rule. |
Set-SPEnterpriseSearchFileFormatState |
Sets the activation state of a parser for a given file format. |
Set-SPEnterpriseSearchLinguisticComponentsStatus |
Sets the operation status of the linguistic query and document processing components. |
Set-SPEnterpriseSearchLinksDatabase |
Sets properties of a links database for a search service application. |
Set-SPEnterpriseSearchMetadataCategory |
Sets properties of a crawled property category. |
Set-SPEnterpriseSearchMetadataCrawledProperty |
Sets the properties of a metadata crawled property. |
Set-SPEnterpriseSearchMetadataManagedProperty |
Sets the properties of a metadata managed property. |
Set-SPEnterpriseSearchMetadataMapping |
Sets the properties of a managed property mapping for a search service application. |
Set-SPEnterpriseSearchPrimaryHostController |
Sets the primary search host controller for the farm. |
Set-SPEnterpriseSearchQueryAuthority |
Sets the properties of an authoritative page for a shared search application. |
Set-SPEnterpriseSearchQueryKeyword |
Sets the properties of a keyword term for a shared search application. |
Set-SPEnterpriseSearchQueryScope |
Sets the properties of a query results scope for a shared search application. |
Set-SPEnterpriseSearchQueryScopeRule |
Sets the properties of a shared scope rule for a query scope. |
Set-SPEnterpriseSearchQuerySpellingCorrection |
Sets the operation status of the Query Spelling Corrections (QSC) component. |
Set-SPEnterpriseSearchRankingModel |
Sets the properties of a ranking model for a shared search service application. |
Set-SPEnterpriseSearchResultItemType |
Sets properties of a result item type. |
Set-SPEnterpriseSearchResultSource |
Sets properties of a result source. |
Set-SPEnterpriseSearchService |
Sets the properties of a search service for a farm. |
Set-SPEnterpriseSearchServiceApplication |
Sets the properties of a search service application for a farm. |
Set-SPEnterpriseSearchServiceApplicationProxy |
Sets properties of a search service application proxy. |
Set-SPEnterpriseSearchServiceInstance |
Sets the properties of a search service instance. |
Set-SPEnterpriseSearchTopology |
Activates a given search topology. |
Start-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance |
Starts an instance of a search manager service. |
Start-SPEnterpriseSearchServiceInstance |
Starts an instance of a search service. |
Stop-SPEnterpriseSearchQueryAndSiteSettingsServiceInstance |
Stops an instance of a search manager service. |
Stop-SPEnterpriseSearchServiceInstance |
Stops an instance of a search service. |
Suspend-SPEnterpriseSearchServiceApplication |
Suspends a search service application, pausing all crawls and search operations, to perform a task such as system maintenance. |
Upgrade-SPEnterpriseSearchServiceApplication |
Upgrades a search service application. |
Upgrade-SPEnterpriseSearchServiceApplicationSiteSettings |
Upgrades search settings for a particular site collection. |
Secure Store Service cmdlets
Cmdlet | Description |
---|---|
Add-SPSecureStoreSystemAccount |
Adds an account to a designated list. |
Clear-SPSecureStoreCredentialMapping |
Deletes a credential mapping from a Secure Store Service application. |
Clear-SPSecureStoreDefaultProvider |
Clears the secure store provider. |
Disable-SPSingleSignOn |
Disables the single sign-on (SSO) Service on a farm server. |
Get-SPSecureStoreApplication |
Returns a Secure Store application. |
Get-SPSecureStoreSystemAccount |
Returns a list of users from a designated list. |
New-SPSecureStoreApplication |
Creates a new Secure Store application. |
New-SPSecureStoreApplicationField |
Creates a new Secure Store application fields object. |
New-SPSecureStoreServiceApplication |
Creates a new Secure Store Service application in the farm. |
New-SPSecureStoreServiceApplicationProxy |
Creates a new Secure Store Service application proxy in the farm. |
New-SPSecureStoreTargetApplication |
Creates a new Secure Store target application. |
Remove-SPSecureStoreApplication |
Deletes a Secure Store application. |
Remove-SPSecureStoreSystemAccount |
Removes a user account from a designated list. |
Set-SPSecureStoreApplication |
Sets properties of a Secure Store application. |
Set-SPSecureStoreDefaultProvider |
Updates the secure store provider. |
Set-SPSecureStoreServiceApplication |
Sets properties of a Secure Store Service application in the farm. |
Update-SPSecureStoreApplicationServerKey |
Synchronizes the key on a Microsoft SharePoint server with the Secure Store master key. |
Update-SPSecureStoreCredentialMapping |
Sets a new credential mapping for a Secure Store Service application. |
Update-SPSecureStoreGroupCredentialMapping |
Sets a new group credential mapping for a Secure Store Service application. |
Update-SPSecureStoreMasterKey |
Changes the master key of a Secure Store Service application. |
Upgrade-SPSingleSignOnDatabase |
Migrates the application definitions from Single Sign-On (SSO) database to Secure Store database as target applications. |
Security (General) cmdlets
Cmdlet | Description |
---|---|
Add-SPShellAdmin |
Adds a user to the SharePoint_Shell_Access role for the specified database. |
Get-SPAuthenticationProvider |
Returns an authentication provider. |
Get-SPAuthenticationRealm |
Returns the authentication realms. |
Get-SPCertificateAuthority |
Returns the SharePoint certificate authority (CA). |
Get-SPIRMSettings |
Returns the Information Rights Management (IRM) settings. |
Get-SPSecurityTokenServiceConfig |
Returns the security token service (STS) for the farm. |
Get-SPShellAdmin |
Returns the names of all users who have the SharePoint_Shell_Access role. |
Get-SPTrustedIdentityTokenIssuer |
Returns an identity provider. |
Get-SPTrustedRootAuthority |
Returns a trusted root authority. |
Get-SPTrustedSecurityTokenIssuer |
Returns the trusted security token issuer object. |
Get-SPTrustedServiceTokenIssuer |
Returns the object that represents the farm trust. |
Grant-SPObjectSecurity |
Adds a new security principal to an SPObjectSecurity object. |
New-SPAuthenticationProvider |
Creates a new authentication provider in the farm. |
New-SPTrustedIdentityTokenIssuer |
Creates an identity provider in the farm. |
New-SPTrustedRootAuthority |
Creates a trusted root authority. |
New-SPTrustedSecurityTokenIssuer |
Creates a trust between a server to server principal. |
New-SPTrustedServiceTokenIssuer |
Creates a trust with a SharePoint farm. |
Remove-SPShellAdmin |
Removes a user from the SharePoint_Shell_Access role. |
Remove-SPTrustedIdentityTokenIssuer |
Deletes a Security Token Service (STS) identity provider from the farm. |
Remove-SPTrustedRootAuthority |
Deletes a trusted root authority. |
Remove-SPTrustedSecurityTokenIssuer |
Removes the trusted security token service object. |
Remove-SPTrustedServiceTokenIssuer |
Deletes the object that represents the farm trust. |
Revoke-SPObjectSecurity |
Removes a security principal from a SPObjectSecurity object. |
Set-SPAuthenticationRealm |
Sets the authentication realm. |
Set-SPSecurityTokenServiceConfig |
Updates the settings of the SharePoint security token service (STS) identity provider. |
Set-SPTrustedIdentityTokenIssuer |
Sets the identity providers of a Web application. |
Set-SPTrustedRootAuthority |
Creates a new trusted root authority. |
Set-SPTrustedSecurityTokenIssuer |
Sets the trusted token issuer. |
Set-SPTrustedServiceTokenIssuer |
Updates a trust with the farm. |
Service Application cmdlets
Cmdlet | Description |
---|---|
Add-SPServiceApplicationProxyGroupMember |
Adds a member to the service application proxy group. |
Get-SPConnectedServiceApplicationInformation |
Returns the health of the service application proxy. |
Get-SPServiceApplication |
Returns the specified service application. |
Get-SPServiceApplicationEndpoint |
Returns the endpoint of a service application. |
Get-SPServiceApplicationPool |
Returns the specified Internet Information Services (IIS) application pool. |
Get-SPServiceApplicationProxy |
Returns an instance of the specified service application proxy. |
Get-SPServiceApplicationProxyGroup |
Returns the proxy group for the specified service application. |
Get-SPServiceApplicationSecurity |
Returns the SPObjectSecurity object for a service application. |
New-SPServiceApplicationPool |
Creates a new Web service application pool. |
New-SPServiceApplicationProxyGroup |
Creates a new service application proxy group. |
Publish-SPServiceApplication |
Shares the specified local service application outside the farm. |
Receive-SPServiceApplicationConnectionInfo |
Configures this farm to receive service information from another farm. |
Remove-SPServiceApplication |
Deletes the specified service application on the local server. |
Remove-SPServiceApplicationPool |
Completely deletes the specified Web service application pool. |
Remove-SPServiceApplicationProxy |
Deletes the specified service application proxy. |
Remove-SPServiceApplicationProxyGroup |
Completely deletes the specified service application proxy group. |
Remove-SPServiceApplicationProxyGroupMember |
Removes one or more proxies from the specified service application proxy group. |
Set-SPServiceApplication |
Sets properties of a service application. |
Set-SPServiceApplicationEndpoint |
Sets the host of an endpoint for a service application. |
Set-SPServiceApplicationPool |
Changes the account used for the Identity of the specified application pool. |
Set-SPServiceApplicationSecurity |
Updates the SPObjectSecurity object for a service application. |
Session State Service cmdlets
Cmdlet | Description |
---|---|
Disable-SPSessionStateService |
Turns off the session state service on the farm. |
Enable-SPSessionStateService |
Creates a session state database and turns on the session state service. |
Get-SPSessionStateService |
Returns the properties of the session state service, including time-out and database settings. |
Set-SPSessionStateService |
Updates the credentials that are used to communicate with the state service database. |
Site cmdlets
Cmdlet | Description |
---|---|
Copy-SPSite |
Makes a copy of a site collection. |
Get-SPDeletedSite |
Gets a list of deleted site collections. |
Get-SPServiceContext |
Returns a service context. |
Get-SPSite |
Returns all site collections that match the specified criteria. |
Get-SPSiteAdministration |
Returns a site administration object that allows farm administrators to view certain information about site collections to which they might not have access. |
Get-SPSiteMaster |
Returns site master information. |
Get-SPSiteUpgradeSessionInfo |
Manage or report site upgrade. |
Get-SPSiteURL |
Displays all URL mappings for the site. |
Move-SPDeletedSite |
Moves deleted site collections from one content database to another. |
Move-SPSite |
Moves site collections from one content database to another. |
New-SPSite |
Creates a new site collection at the specified URL. |
New-SPSiteMaster |
Creates a site master. |
Remove-SPDeletedSite |
Removes a deleted site collection. |
Remove-SPSite |
Completely deletes an existing site collection and all subsites. |
Remove-SPSiteMaster |
Removes a site master. |
Remove-SPSiteUpgradeSessionInfo |
Removes an SPSite object from upgrade. |
Remove-SPSiteURL |
Removes an URL mapping from the site. |
Repair-SPSite |
Activates the RunRepairs method against the referenced SPSite object. |
Request-SPUpgradeEvaluationSite |
Requests an upgrade evaluation site for a specified site. |
Reset-SPSites |
Synchronizes the content database with the configuration database of the farm. |
Set-SPSite |
Configures the specified sites. |
Set-SPSiteAdministration |
Allows farm administrators to configure any site collection. |
Set-SPSiteURL |
Adds or changes an URL mapping for the site. |
Test-SPSite |
Activates the RunTests method against a referenced SPSite object. |
Upgrade-SPSite |
Starts the upgrade process on a site collection. |
Site Subscriptions cmdlets
Cmdlet | Description |
---|---|
Add-SPSiteSubscriptionFeaturePackMember |
Adds a feature to a SharePoint Feature set. |
Add-SPSiteSubscriptionProfileConfig |
Adds a new site subscription to a User Profile Service application. |
Clear-SPMetadataWebServicePartitionData |
Removes all data for a site subscription on a metadata Web service application. |
Clear-SPSiteSubscriptionBusinessDataCatalogConfig |
Deletes all data from the Business Data Connectivity Metadata Store for a specified partition. |
Export-SPSiteSubscriptionBusinessDataCatalogConfig |
Exports all data from the Business Data Connectivity Metadata Store associated with a partition. |
Export-SPSiteSubscriptionSettings |
Creates a backup file of site subscription data. |
Get-SPSiteSubscription |
Returns the site subscription for the given URL or all site subscriptions in the local farm. |
Get-SPSiteSubscriptionConfig |
Returns the configuration properties of a site subscription. |
Get-SPSiteSubscriptionEdiscoveryHub |
Displays the eDiscovery hub for a site subscription. |
Get-SPSiteSubscriptionEdiscoverySearchScope |
Displays the search scope for the eDiscovery hub of the specified site collection. |
Get-SPSiteSubscriptionFeaturePack |
Retrieves available SharePoint Feature sets or the Feature set assigned to a given site subscription. |
Get-SPSiteSubscriptionIRMConfig |
Gets the Information Rights Management (IRM) settings. |
Get-SPSiteSubscriptionMetadataConfig |
Returns the site subscription configuration settings for a Metadata Service application. |
Import-SPSiteSubscriptionBusinessDataCatalogConfig |
Imports data associated with an exported file that contains all data associated with the Business Data Connectivity Metadata Store for a given partition. |
Import-SPSiteSubscriptionSettings |
Restores a backup of subscription site settings to the given subscription identifier. |
New-SPSiteSubscription |
Creates a new site subscription. |
New-SPSiteSubscriptionFeaturePack |
Creates a new SharePoint Feature set that can be used to limit the features available to a site subscription. |
Remove-SPSiteSubscription |
Removes data stored in a subscription settings service application for a set of site subscriptions. |
Remove-SPSiteSubscriptionBusinessDataCatalogConfig |
Removes the Business Data Connectivity Metadata Store for a partition. |
Remove-SPSiteSubscriptionFeaturePack |
Removes a SharePoint Feature set from a site subscription. |
Remove-SPSiteSubscriptionFeaturePackMember |
Removes a feature definition from the provided SharePoint Feature set. |
Remove-SPSiteSubscriptionMetadataConfig |
Removes site subscription configuration settings. |
Remove-SPSiteSubscriptionProfileConfig |
Deletes a site subscription from a User Profile Service application. |
Remove-SPSiteSubscriptionSettings |
Removes the settings service data for a specified site subscription, or finds and removes orphaned data. |
Set-SPSiteSubscriptionConfig |
Sets the configuration properties of a site subscription. |
Set-SPSiteSubscriptionEdiscoveryHub |
Sets properties for the eDiscovery hub of a site subscription. |
Set-SPSiteSubscriptionIRMConfig |
Sets the Information Rights Management (IRM) settings. |
Set-SPSiteSubscriptionMetadataConfig |
Sets the site subscription configuration settings for a specified Metadata Service application. |
Set-SPSiteSubscriptionProfileConfig |
Sets the parameters of a site subscription. |
State Service cmdlets
Cmdlet | Description |
---|---|
Dismount-SPStateServiceDatabase |
Removes the association to a state service database from the farm without dropping the database in the Microsoft SQL Server database. |
Get-SPStateServiceApplication |
Returns state service applications on the farm. |
Get-SPStateServiceApplicationProxy |
Returns state service application proxies on the farm. |
Get-SPStateServiceDatabase |
Returns a state service database. |
Initialize-SPStateServiceDatabase |
Installs the state database schema into a state service database. |
Mount-SPStateServiceDatabase |
Attaches an existing state service database to the farm. |
New-SPStateServiceApplication |
Creates a new state service application. |
New-SPStateServiceApplicationProxy |
Creates a proxy for a state service application. |
New-SPStateServiceDatabase |
Creates and provisions a new state service database and installs the state database schema into it. |
Remove-SPStateServiceDatabase |
Removes a state service database from a state service application and drops it from the SQL Server. |
Resume-SPStateServiceDatabase |
Resumes a paused state service database so that new rows of data are received. |
Set-SPStateServiceApplication |
Updates the name of a state service application. |
Set-SPStateServiceApplicationProxy |
Updates the name of a state service application proxy. |
Set-SPStateServiceDatabase |
Updates properties of a state service database. |
Suspend-SPStateServiceDatabase |
Pauses a state database and thus prevents new rows of data from being added to a database. |
Subscription Settings Service cmdlets
Cmdlet | Description |
---|---|
New-SPSubscriptionSettingsServiceApplication |
Creates a new subscription settings service application. |
New-SPSubscriptionSettingsServiceApplicationProxy |
Creates an application proxy to a subscription settings service application. |
Set-SPSubscriptionSettingsServiceApplication |
Sets properties of a subscription settings service application. |
Topology Service cmdlets
Cmdlet | Description |
---|---|
Get-SPTopologyServiceApplication |
Displays properties of the topology service application for the current farm. |
Get-SPTopologyServiceApplicationProxy |
Retrieves the topology service application proxy. |
Set-SPTopologyServiceApplication |
Sets the properties on the topology service application of the local farm. |
Set-SPTopologyServiceApplicationProxy |
Sets the proxy properties of the topology service application. |
Usage and Health Services cmdlets
Cmdlet | Description |
---|---|
Add-SPDiagnosticsPerformanceCounter |
Adds a new instance of a performance counter to a Web front end computer or a database server. |
Disable-SPHealthAnalysisRule |
Disables health analyzer rules. |
Enable-SPHealthAnalysisRule |
Enables a health analyzer rule. |
Get-SPDiagnosticConfig |
Retrieves ULS diagnostic configuration values of the farm. |
Get-SPDiagnosticsPerformanceCounter |
Returns a collection of performance counters. |
Get-SPDiagnosticsProvider |
Returns a diagnostics provider. |
Get-SPHealthAnalysisRule |
Gets a health analyzer rule. |
Get-SPHelpCollection |
Returns Help collection files. |
Get-SPUsageApplication |
Returns a specified usage application. |
Get-SPUsageDefinition |
Returns a usage definition object. |
Get-SPUsageService |
Returns a usage service. |
Merge-SPUsageLog |
Returns records from usage log files. |
New-SPUsageApplication |
Creates a new usage application. |
New-SPUsageLogFile |
Starts a new usage log file on the current server computer. |
Remove-SPDiagnosticsPerformanceCounter |
Removes an instance of a performance counter. |
Remove-SPUsageApplication |
Removes a usage application from the local farm. |
Set-SPDiagnosticConfig |
Sets diagnostic configuration settings on the farm. |
Set-SPDiagnosticsProvider |
Enables a diagnostics provider and updates its retention policy. |
Set-SPUsageApplication |
Sets properties of a usage application. |
Set-SPUsageDefinition |
Sets the retention period for a usage provider. |
Set-SPUsageService |
Updates the properties of a usage service. |
Start-SPDiagnosticsSession |
Starts a diagnostic session to report diagnostic information to the usage database. |
Stop-SPDiagnosticsSession |
Stops a diagnostic session. |
User Licensing cmdlets
Cmdlet | Description |
---|---|
Add-SPUserLicenseMapping |
Maps a security group, forms-based role, or claim to a SharePoint user license. |
Disable-SPUserLicensing |
Disables user license enforcement. |
Enable-SPUserLicensing |
Enables user-license enforcement. |
Get-SPUserLicense |
Returns the list of supported SharePoint user licenses. |
Get-SPUserLicenseMapping |
Returns the claim-to-user license mappings. |
Get-SPUserLicensing |
Returns the state of user-license enforcement. |
New-SPUserLicenseMapping |
Creates a license mapping object. |
Remove-SPUserLicenseMapping |
Removes a claim-to-SharePoint user license mapping. |
User Profile Service cmdlets
Cmdlet | Description |
---|---|
Add-SPPluggableSecurityTrimmer |
Adds a pluggable security trimmer to a Profile service application proxy. |
Add-SPProfileLeader |
Adds a company leader. |
Add-SPProfileSyncConnection |
Adds a synchronization connection. |
Clear-SPContentDatabaseSyncData |
Clears synchronization information from the content databases that have not been synchronized since the mentioned number of days. |
Export-SPTagsAndNotesData |
Exports the SharePoint Newsfeed tags and notes from the SharePoint database to a ZIP file. |
Get-SPMicrofeedOptions |
Returns the feed cache settings for the current user profile application. |
Get-SPPluggableSecurityTrimmer |
Gets pluggable security trimmers added to a profile service application proxy. |
Get-SPProfileLeader |
Returns the current company leaders. |
Get-SPProfileServiceApplicationSecurity |
Returns permission and identity information. |
Move-SPSocialComment |
Moves social comments. |
New-SPProfileServiceApplication |
Adds a User Profile Service Application to a farm. |
New-SPProfileServiceApplicationProxy |
Creates a User Profile Service application proxy on the local farm. |
Remove-SPActivityFeedItems |
Removes activity events from the published and consolidated tables. |
Remove-SPPluggableSecurityTrimmer |
Removes a pluggable security trimmer from a profile service application proxy. |
Remove-SPProfileLeader |
Remove a company leader. |
Remove-SPProfileSyncConnection |
Removes a synchronization connection. |
Remove-SPSocialItemByDate |
Deletes tags, notes, or ratings. |
Set-SPDefaultProfileConfig |
Changes the MySitesPublicEnabled property of the User Profile Application Proxy. |
Set-SPMicrofeedOptions |
Sets the feed cache settings. |
Set-SPProfileServiceApplication |
Sets properties of a User Profile Service application. |
Set-SPProfileServiceApplicationProxy |
Sets properties of a proxy for a User Profile Service application. |
Set-SPProfileServiceApplicationSecurity |
Sets permission and identity information. |
Update-SPProfilePhotoStore |
Updates the profile photo store to be compatible with SharePoint Server. |
Update-SPProfileSync |
Updates the configuration of the User Profile Synchronization job based on the parameters specified. |
Update-SPRepopulateMicroblogFeedCache |
Refreshes the microblog feed cache. |
Update-SPRepopulateMicroblogLMTCache |
Refreshes the cache. |
Upgrade-SPProfileServiceApplication |
Upgrades User Profile Service and its related profile and social store. |
Visio Services cmdlets
Cmdlet | Description |
---|---|
Get-SPVisioExternalData |
Returns the settings for external data connections for a Visio Services application. |
Get-SPVisioPerformance |
Returns the Visio Services settings for the performance of a Visio Services application. |
Get-SPVisioSafeDataProvider |
Returns the settings of a safe data provider for a Visio Services application. |
Get-SPVisioServiceApplication |
Returns properties of a Visio Services application or a collection of Visio Services applications. |
Get-SPVisioServiceApplicationProxy |
Returns properties of a Visio Services application proxy or a collection of Visio Services application proxies. |
New-SPVisioSafeDataProvider |
Adds a new data provider to a Visio Services application. |
New-SPVisioServiceApplication |
Adds a new Visio Services application to a farm. |
New-SPVisioServiceApplicationProxy |
Adds a new Visio Services application proxy to a farm. |
Remove-SPVisioSafeDataProvider |
Removes a data provider from a Visio Services application. |
Set-SPVisioExternalData |
Configures settings related to external data connections for a Visio Services application. |
Set-SPVisioPerformance |
Sets performance properties for a Visio Services application. |
Set-SPVisioSafeDataProvider |
Specifies a description of a safe data provider for a Visio Services application. |
Set-SPVisioServiceApplication |
Sets the ServiceApplicationPool property for a Visio Services application. |
Web cmdlets
Cmdlet | Description |
---|---|
Disable-SPWebTemplateForSiteMaster |
Disables the site master in the farm. |
Enable-SPWebTemplateForSiteMaster |
Creates a template for a site master. |
Get-SPWeb |
Returns all subsites that match the given criteria. |
Get-SPWebTemplate |
Displays all globally installed site templates that match the given identity. |
Get-SPWebTemplatesEnabledForSiteMaster |
Returns a list of site master web templates. |
Import-SPWeb |
Imports a web, list, or library. |
New-SPWeb |
Creates a new site in an existing site collection. |
Remove-SPWeb |
Completely deletes the specified Web. |
Set-SPWeb |
Configures the specified subsite. |
Web Application cmdlets
Cmdlet | Description |
---|---|
Convert-SPWebApplication |
Converts the authentication mode of a web application. |
Disable-SPWebApplicationHttpThrottling |
Turns off network throttling for a Web application. |
Enable-SPWebApplicationHttpThrottling |
Turns on network throttling for a Web application. |
Get-SPAlternateURL |
Returns all alternate URLs that match a given set of criteria. |
Get-SPContentDeploymentJob |
Returns a content deployment job or a collection of content deployment jobs. |
Get-SPContentDeploymentPath |
Returns a content deployment path or a collection of content deployment paths. |
Get-SPCustomLayoutsPage |
Returns a mapping to a custom layout page. |
Get-SPDesignerSettings |
Displays SharePoint Designer features. |
Get-SPManagedPath |
Returns all managed paths that match the given criteria. |
Get-SPWebApplication |
Returns all Web applications that match the given criteria. |
Get-SPWebApplicationAppDomain |
Returns all app domains for a specific web application. |
Get-SPWebApplicationHttpThrottlingMonitor |
Returns all counters and their associated Health Score bucket values for network throttling on a Web application. |
New-SPAlternateURL |
Creates a new public or internal URL for the specified Web application zone or resource. |
New-SPContentDeploymentJob |
Creates a content deployment job. |
New-SPContentDeploymentPath |
Creates a new content deployment path. |
New-SPManagedPath |
Creates a new managed path for the given Web application for all host header site collections. |
New-SPWebApplication |
Creates a new Web application within the local farm. |
New-SPWebApplicationAppDomain |
Creates an AppDomain entry. |
New-SPWebApplicationExtension |
Creates a new zone instance for the Web application. |
Remove-SPAlternateURL |
Completely deletes the specified alternate URL. |
Remove-SPContentDeploymentJob |
Removes a content deployment job. |
Remove-SPContentDeploymentPath |
Removes a content deployment path. |
Remove-SPManagedPath |
Deletes the specified managed path from the specified host header or Web application. |
Remove-SPWebApplication |
Deletes the specified Web application. |
Remove-SPWebApplicationAppDomain |
Deletes the AppDomain. |
Set-SPAlternateURL |
Configures the specified alternate URL. |
Set-SPContentDeploymentJob |
Sets properties of a content deployment job. |
Set-SPContentDeploymentPath |
Sets properties of a content deployment path. |
Set-SPDesignerSettings |
Sets SharePoint Designer features. |
Set-SPWebApplication |
Configures the specified Web application. |
Set-SPWebApplicationHttpThrottlingMonitor |
Sets the Health Score bucket values for an existing network throttling performance counter for a specified Web application. |
Start-SPContentDeploymentJob |
Starts a content deployment job. |
Word Automation Services cmdlets
Cmdlet | Description |
---|---|
New-SPWordConversionServiceApplication |
Creates a new instance of a Word Automation Services application on the farm. |
Remove-SPWordConversionServiceJobHistory |
Removes entries from the Word Automation Services job history database. |
Set-SPWordConversionServiceApplication |
Sets properties of a Word Automation Services application. |
Work Management Service cmdlets
Cmdlet | Description |
---|---|
New-SPWorkManagementServiceApplication |
Creates a new Work Management Service application. |
New-SPWorkManagementServiceApplicationProxy |
Creates a new Work Management Service application proxy. |
Set-SPWorkManagementServiceApplication |
Sets settings for the Work Management Service application. |
Set-SPWorkManagementServiceApplicationProxy |
Sets the settings for the Work Management Service application proxy. |
Workflow Service (SharePoint 2013 Workflows / Workflow Manager) cmdlets
Cmdlet | Description |
---|---|
Copy-SPActivitiesToWorkflowService |
Copies the Workflow Activities from SharePoint to Workflow Manager. Activities are defined within Microsoft provided or custom coded assemblies. |
Get-SPWorkflowConfig |
Returns workflow settings for the specified Web application. |
Get-SPWorkflowServiceApplicationProxy |
Returns the Workflow Service Application Proxy. |
New-SPWorkflowServiceApplicationProxy |
Creates a proxy to connect to Workflow Manager. |
Register-SPWorkflowService |
Registers a Workflow Manager farm with the SharePoint farm. |
Set-SPWorkflowConfig |
Configures the workflow settings for the specified Web application. |
DO NOT USE THESE CMDLETS
Cmdlet | Description |
---|---|
Add-SPEduClassMember |
Not in use |
Add-SPEduUser |
Do not use |
Dismount-SPSiteMapDatabase |
Do not use. |
Get-SPEduServiceSetting |
Do not use |
Get-SPSiteMapDatabase |
Do not use |
Install-SPEduSites |
Do not use |
Migrate-SPDatabase |
Do not use. |
Mount-SPSiteMapDatabase |
Mounts a Site Map database. Do not use. |
Move-SPAppManagementData |
Do Not Use |
New-SPBECWebServiceApplicationProxy |
Do not use. |
New-SPEduClass |
Do not use |
Remove-SPEduClassMember |
Do not use |
Set-SPEduServiceSetting |
Do not use |
Upgrade-SPAppManagementServiceApplication |
Do Not Use |
Upgrade-SPSiteMapDatabase |
Do not use. |