Install-SPSolutionDeploys an installed SharePoint solution in the farm.InstallSPSolutionInstall-SPSolutionIdentitySPSolutionPipeBindAllWebApplicationsSwitchParameterAssignmentCollectionSPAssignmentCollectionCASPoliciesSwitchParameterConfirmSwitchParameterForceSwitchParameterGACDeploymentSwitchParameterLanguageUInt32LocalSwitchParameterTimeStringWebApplicationSPWebApplicationPipeBindWhatIfSwitchParameterInstall-SPSolutionIdentitySPSolutionPipeBindSynchronizeSwitchParameterAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterLanguageUInt32WhatIfSwitchParameterIdentitySpecifies the SharePoint solution to deploy.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object.SPSolutionPipeBindSPSolutionPipeBind AllWebApplicationsSpecifies that the new SharePoint solution is deployed for all SharePoint Web applications in the farm.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection CASPoliciesSpecifies that code access security (CAS) policies can be deployed for the new SharePoint solution.SwitchParameterSwitchParameter ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceForces the deployment of the new SharePoint solution.SwitchParameterSwitchParameter GACDeploymentSpecifies that global assembly cache (GAC) can be deployed for the new SharePoint solution.SwitchParameterSwitchParameter LanguageSpecifies a language for the solution when a solution language package is deployed. If this parameter is not specified, zero ("0") is assumed. Use zero for solutions that are valid for all languages. UInt32UInt32 LocalDeploys the solution on the active server computer.SwitchParameterSwitchParameter SynchronizeSynchronizes all solutions or the specified solution in the local farm.SwitchParameterSwitchParameter TimeSpecifies when the solution will be deployed. The default value is immediate deployment.The type must be a valid DateTime value, in the form 2010, 5, 1.StringString WebApplicationDeploys the SharePoint solution for the specified SharePoint Web application.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Install-SPSolution cmdlet deploys an installed SharePoint solution in the farm. Use the Add-SPSolution cmdlet to install a SharePoint solution package io the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Install-SPSolution -Identity contoso_solution.wsp -GACDeploymentThis example deploys the installed SharePoint solution contoso_solution.wsp in the farm and specifies that GAC can be deployed for the new SharePoint solution.Get-SPSolutionAdd-SPSolutionUpdate-SPSolutionUninstall-SPSolutionRemove-SPSolutionRemove-SPSolutionDeploymentLock Install-SPSolution Get-SPMobileMessagingAccountRetrieves mobile messaging accounts for the specified Web application.GetSPMobileMessagingAccountGet-SPMobileMessagingAccountIdentitySPMobileMessagingAccountPipeBindWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies whether to return either Short Message Service (SMS) or Multimedia Messaging Service (MMS) account information. Valid values are: SMS and MMS . If you do not specify this parameter, account information is returned for both SMS and MMS. SPMobileMessagingAccountPipeBindSPMobileMessagingAccountPipeBind WebApplicationSpecifies the identity of the Web application to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Web application name (for example, WebApplication1212); or a valid name (for example, WebApp2423).You either must specify WebApplication or must use the HostHeader switch and specify the full URL in the Identity parameter.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPMobileMessagingAccount cmdlet retrieves the specified mobile messaging accounts for the specified Web application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185.--------------EXAMPLE----------------- C:\PS>Get-SPMobileMessagingAccount -WebApplication http://sitenameThis example retrieves the current mobile account settings information of the Web application http://sitename. Set-SPMobileMessagingAccount Get-SPMobileMessagingAccount Clear-SPSiteSubscriptionBusinessDataCatalogConfigDeletes all data from the Business Data Connectivity Metadata Store for a specified partition.ClearSPSiteSubscriptionBusinessDataCatalogConfigClear-SPSiteSubscriptionBusinessDataCatalogConfigServiceContextSPServiceContextPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterServiceContextSpecifies the service context for which the Business Data Connectivity models are deleted.SPServiceContextPipeBindSPServiceContextPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Clear-SPSiteSubscriptionBusinessDataCatalogConfig cmdlet deletes all models and data from the Business Data Connectivity Metadata Store for a specified service partition.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Clear-SPSiteSubscriptionBusinessDataCatalogConfig -ServiceContext http://contosoThis example deletes all data from the Business Data Connectivity Metadata Store for the specified site. Export-SPSiteSubscriptionBusinessDataCatalogConfigImport-SPSiteSubscriptionBusinessDataCatalogConfig Clear-SPSiteSubscriptionBusinessDataCatalogConfig Remove-SPSiteSubscriptionFeaturePackMemberRemoves a feature definition from the provided SharePoint Feature set.RemoveSPSiteSubscriptionFeaturePackMemberRemove-SPSiteSubscriptionFeaturePackMemberIdentitySPSiteSubscriptionFeaturePackPipeBindFeatureDefinitionSPFeatureDefinitionPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterRemove-SPSiteSubscriptionFeaturePackMemberIdentitySPSiteSubscriptionFeaturePackPipeBindAllFeatureDefinitionsSwitchParameterAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the Feature set from which to remove a feature.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a feature set (for example, FeatureSet1); or an instance of a valid SPFeatureSet object.SPSiteSubscriptionFeaturePackPipeBindSPSiteSubscriptionFeaturePackPipeBind AllFeatureDefinitionsClears all features from the Feature set.SwitchParameterSwitchParameter FeatureDefinitionSpecifies the feature definition to be removed.SPFeatureDefinitionPipeBindSPFeatureDefinitionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPSiteSubscriptionFeaturePackMember cmdlet removes the provided FeatureDefintion parameter from the feature set specified by the Identity parameter. If the AllFeatureDefinitions flag is provided, all feature definitions are removed from the given Feature set.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1----------------------- C:\PS>$FS = Get-SPSiteSubscriptionFeaturePack "30daa535-b0fe-4d10-84b0-fb04029d161a" C:\PS>Remove-SPSiteSubscriptionFeaturePackMember -Identity $fs -FeatureDefinition (Get-SPFeature "PublishingSite")This example removes the PublishingSite feature from the Feature set that has ID 30daa535-b0fe-4d10-84b0-fb04029d161a.------------------EXAMPLE 2----------------------- C:\PS>Get-SPSiteSubscriptionFeaturePack "30daa535-b0fe-4d10-84b0-fb04029d161a" | Remove-SPSiteSubscriptionFeaturePackMember -AllFeatureDefinitionsThis example removes all features from the Feature set 30daa535-b0fe-4d10-84b0-fb04029d161a.Add-SPSiteSubscriptionFeaturePackMemberGet-SPSiteSubscriptionFeaturePackRemove-SPSiteSubscriptionFeaturePack Remove-SPSiteSubscriptionFeaturePackMember Get-SPUsageApplicationReturns a specified usage application.GetSPUsageApplicationGet-SPUsageApplicationIdentitySPUsageApplicationPipeBindAssignmentCollectionSPAssignmentCollectionUsageServiceSPUsageServicePipeBindIdentitySpecifies the usage application to get. If the Identity parameter is not specified, the cmdlet returns the local usage application.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage application (for example, UsageApplication1); or an instance of a valid SPUsageApplication object.SPUsageApplicationPipeBindSPUsageApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection UsageServiceFilters to return the usage application with the specified parent SPUsageService object.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object.SPUsageServicePipeBindSPUsageServicePipeBind The Get-SPUsageApplication cmdlet return a specified usage application. If the Identity parameter is not specified, the cmdlet returns the local usage application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ---------------EXAMPLE------------------ C:\PS>Get-SPUsageApplication -Identity "Usage and Health data collection"This example returns the usage application named, Usage and Health data collectionNew-SPUsageApplicationSet-SPUsageApplicationRemove-SPUsageApplication Get-SPUsageApplication Import-SPBusinessDataCatalogDotNetAssemblyImports a .NET Connectivity assembly.ImportSPBusinessDataCatalogDotNetAssemblyImport-SPBusinessDataCatalogDotNetAssemblyLobSystemLobSystemPathStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDependentAssemblyPathsString[]WhatIfSwitchParameterLobSystemSpecifies the LobSystem that the assembly corresponds to.LobSystemLobSystem PathSpecifies the path to the primary assembly.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DependentAssemblyPathsSpecifies a list of paths to dependent assemblies.String[]String[] WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Import-SPBusinessDataCatalogDotNetAssembly cmdlet imports a .NET Connectivity Assembly that corresponds to a .NET Assembly Connector and LobSystem in the metadata store.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -----------------EXAMPLE 1---------------- C:\PS>Import-SPBusinessDataCatalogDotNetAssembly -LobSystem $ContosoDB -Path "c:\Folder\Assembly.dll"This example imports the assembly Assembly.-----------------EXAMPLE 2---------------- C:\PS>Import-SPBusinessDataCatalogDotNetAssembly -LobSystem $ContosoDB -Path "c:\Folder\Assembly.dll" -DependentAssemblyPaths "c:\Folder\Assembly2.dll","c:\Folder\Assembly3.dll"This example imports the assembly Assembly, and also imports the dependent assemblies Assembly2 and Assembly3. Import-SPBusinessDataCatalogDotNetAssembly Set-SPUsageDefinitionSets the retention period for a usage provider.SetSPUsageDefinitionSet-SPUsageDefinitionIdentitySPUsageDefinitionPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDaysRetainedInt32EnableSwitchParameterWhatIfSwitchParameterIdentitySpecifies the usage definition object to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage definition (for example, SiteSubscriptionConfig1); or an instance of a valid SPUsageDefinition object.SPUsageDefinitionPipeBindSPUsageDefinitionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DaysRetainedSpecifies the number of days that usage data for the usage provider is retained in the usage service database. The default value is 14.The type must be an integer between 0 and 31.Int32Int32 EnableTurns on the specified usage provider.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPUsageDefinition cmdlet sets the retention period for a specified usage provider. A usage definition object defines a specific type of usage provider.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -----------------EXAMPLE-------------------- C:\PS>Set-SPUsageDefinition -Identity "Page Requests" -DaysRetained 31This example sets the number of days that stores page requests usage data to 31.Get-SPUsageDefinition Set-SPUsageDefinition Remove-SPClaimProviderUnregisters a claim provider.RemoveSPClaimProviderRemove-SPClaimProviderIdentitySPClaimProviderPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the claim provider to unregister.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a claim provider (for example, MyClaimProvider1); or an instance of a valid SPClaimProvider object.SPClaimProviderPipeBindSPClaimProviderPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Remove-SPClaimProvider cmdlet unregisters a claim provider. If the unregistered claim provider was assigned to a trusted identity token issuer, the trusted token issuer will use the default (system) claim provider.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Remove - SPClaimProvider -Identity "12345678-90ab-cdef-1234-567890bcdefgh"This example removes a claim provider from the farmGet-SPClaimProviderNew-SPClaimProviderSet-SPClaimProvider Remove-SPClaimProvider Get-SPServiceApplicationPoolReturns the specified Internet Information Services (IIS) application pool.GetSPServiceApplicationPoolGet-SPServiceApplicationPoolIdentitySPIisWebServiceApplicationPoolPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the name or identifier (ID) of the application pool to get.SPIisWebServiceApplicationPoolPipeBindSPIisWebServiceApplicationPoolPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPServiceApplicationPool cmdlet returns the IIS application pool specified by the Identity parameter, or returns all application pools if the Identity parameter is not specified.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185.--------------EXAMPLE----------------- C:\PS>Get-SPServiceApplicationPoolThis example returns all the service application pools in the farm.New-SPServiceApplicationPoolSet-SPServiceApplicationPoolRemove-SPServiceApplicationPool Get-SPServiceApplicationPool New-SPClaimsPrincipalCreates a claims principal.NewSPClaimsPrincipalNew-SPClaimsPrincipalIdentityStringIdentityTypeWindowsSamAccountName | WindowsSecurityGroupName | WindowsSecurityGroupSid | FormsUser | FormsRole | EncodedClaimAssignmentCollectionSPAssignmentCollectionNew-SPClaimsPrincipalIdentityStringTrustedIdentityTokenIssuerSPTrustedIdentityTokenIssuerPipeBindAssignmentCollectionSPAssignmentCollectionNew-SPClaimsPrincipalClaimValueStringClaimTypeStringTrustedIdentityTokenIssuerSPTrustedIdentityTokenIssuerPipeBindIdentifierClaimSwitchParameterAssignmentCollectionSPAssignmentCollectionNew-SPClaimsPrincipalEncodedClaimStringAssignmentCollectionSPAssignmentCollectionNew-SPClaimsPrincipalClaimValueStringClaimTypeStringClaimProviderSPClaimProviderAssignmentCollectionSPAssignmentCollectionClaimValueSpecifies the claim value of the claims object. The claims value specifies the user, group, or computer that the claim is authenticating.The type must be a valid claim value; for example, john@contoso.com.StringString EncodedClaimConverts a simple claim to a full encoded claim.The type must be a valid claim value; for example, i:001w|redmond\user.StringString IdentitySpecifies the name of the new claims principal.The type must be a valid name of a claims principal.StringString ClaimTypeSpecifies the type of claim to create. The value I indicates a unique user identity claim, and the value C indicates all other claims.The type must be either of the following values: I or C.StringString TrustedIdentityTokenIssuerSpecifies the ID of the authentication provider.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of an Authentication provider (for example, MyAuthprovider1); or an instance of a valid SPTrustedIdentityTokenIssuer object.SPTrustedIdentityTokenIssuerPipeBindSPTrustedIdentityTokenIssuerPipeBind IdentityTypeSpecifies the type of the new claims principal.The type must be one of the following: WindowsSamAccountName, WindowsSecurityGroupSid, FormsUser, FormsRole, or EncodedClaim.WindowsSamAccountName | WindowsSecurityGroupName | WindowsSecurityGroupSid | FormsUser | FormsRole | EncodedClaimWindowsSamAccountName | WindowsSecurityGroupName | WindowsSecurityGroupSid | FormsUser | FormsRole | EncodedClaim ClaimsProviderSpecifies the security token service identity provider that will contain the claims principal.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, MyIDprovider1); or an instance of a valid SPIdentityProvider object.IdentifierClaimSpecifies if the new claim is an identity claim.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The New-SPClaimsPrincipal cmdlet creates a claims principal.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------------EXAMPLE 1----------------------------- C:\PS>New-SPSite http://sitename/sites/newsite -owner (New-SPClaimsPrincipal contoso\johndoe -IdentityProvider "NTLM")This example creates a claim principal for a Windows user.-------------------------EXAMPLE 2----------------------------- C:\PS>New-SPSite http://localhost/sites/newsite -owner (New-SPClaimsPrincipal contoso\allusers -IdentityProvider "NTLM")This example creates a claim principal for a Windows group.-------------------------EXAMPLE 3----------------------------- C:\PS>New-SPSite http://sitename/sites/newsite -owner (New-SPClaimsPrincipal -ClaimValue "john@contoso.com" -ClaimType Email -IdentityProvider "LiveID STS" -IdentifierClaim Yes)This example creates a claim principal for a trusted identity token issuer claim.-------------------------EXAMPLE 4----------------------------- C:\PS>$ip = New-SPIdentityProvider -ASPNetMembershipProvider "myMembershipProvider" -ASPNetRoleProvider "myRoleProvider" C:\PS>New-SPSite http://sitename/sites/newsite -owner (New-SPClaimsPrincipal "john@contoso.com" -IdentityProvider $ip)This example creates a claim principal for a ASPNet Membership User.-------------------------EXAMPLE 5----------------------------- C:\PS>New-SPSite http://sitename/sites/newsite -owner (New-SPClaimsPrincipal "Sales Manager Role" -IdentityProvider "myRoleProvider")This example creates a claim principal for a ASPNet Role.-------------------------EXAMPLE 6----------------------------- C:\PS>New-SPSite http://sitename/sites/newsite -owner (New-SPClaimsPrincipal "i:xxx|xxxx|contoso\user")This example creates a claim principal for a Basic Claim Role, which is also called an encoded claim). New-SPClaimsPrincipal Set-SPSecurityTokenServiceConfigUpdates the settings of the SharePoint security token service (STS) identity provider.SetSPSecurityTokenServiceConfigSet-SPSecurityTokenServiceConfigAssignmentCollectionSPAssignmentCollectionFormsTokenLifetimeInt32ImportSigningCertificateX509Certificate2MaxLogonTokenCacheItemsInt32MaxServiceTokenCacheItemsInt32ServiceTokenCacheExpirationWindowInt32ServiceTokenLifetimeInt32WindowsTokenLifetimeInt32Set-SPSecurityTokenServiceConfigSigningCertificateThumbprintStringAssignmentCollectionSPAssignmentCollectionFormsTokenLifetimeInt32MaxLogonTokenCacheItemsInt32MaxServiceTokenCacheItemsInt32ServiceTokenCacheExpirationWindowInt32ServiceTokenLifetimeInt32SigningCertificateStoreNameStringWindowsTokenLifetimeInt32SigningCertificateThumbprintSpecifies the thumbrpint of the signing certificate.The type must be a valid identity of a signing certificate; for example 2796BAE63F1801E277261BA0D77770028F20EEE4.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection FormsTokenLifetimeSpecifies the expiration time, in minutes, for tokens issued to ASP.NET Membership Provider and Role providers. The default value is 1380.The type must be a valid integer.Int32Int32 ImportSigningCertificateSpecifies the X.509 certificate object from trusted authentication provider farm.The type must be a name of a valid X.509 certificate; for example, Certificate1.X509Certificate2X509Certificate2 MaxLogonTokenCacheItemsSpecifies the maximum number of entries for the in-memory logon token cache. The default value is 10000 entries.The type must be a valid integer.Int32Int32 MaxServiceTokenCacheItemsSpecifies the maximum number of entries for the in-memory service token cache. The default value is 10000 entries.The type must be a valid integer.Int32Int32 ServiceTokenCacheExpirationWindowSpecifies the interval, in minutes, for automatically renewing the token in the cache. The default value is 2 minutes.The type must be a valid integer.Int32Int32 ServiceTokenLifetimeSpecifies the expiration time, in minutes, for the security token service cache. The default value is 15 minutes.The type must be a valid integer.Int32Int32 SigningCertificateStoreNameSpecifies the certificate store where the signing certificate resides. The identity store for an identity provider can be a SQL database table, an Active Directory Domain Services (AD DS), or Active Directory Lightweight Directory Service (AD LDS).The type must be a valid identity of a signing certificate store; for example IdentityStore1.StringString WindowsTokenLifetimeSpecifies the expiration time, in minutes, for tokens issued to Windows users. The default value is 1380 minutes.The type must be a valid integer.Int32Int32 The Set-SPSecurityTokenServiceConfig cmdlet updates the settings of the SharePoint security token service (STS) identity provider. If a certificate file is used, the certificate must be an X509 certificate with private keys, otherwise an exception is raised.This cmdlet operates only with certificates that can be exported. To create a certificate which can be used in this cmdlet specify the X509KeyStorageFlags.Exportable bit in the keyStorageFlags parameter of the x509Certificate2 object constructor.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1------------------ C:\PS>Set-SPSecurityTokenServiceConfig - SigningCertificateThumbprint "2796BAE63F1801E277261BA0D77770028F20EEE4"This example updates the signing certificate of the SharePoint security token service (STS) identity provider with a certificate that has been deployed in the certificate store.------------------EXAMPLE 2------------------ C:\PS>$cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx Enter password: **** Set - SPSecurityTokenServiceConfig -ImportSingingCertificate $certThis example imports the signing certificate for the SharePoint STS identity provider.Get-SPSecurityTokenServiceConfig Set-SPSecurityTokenServiceConfig Get-SPServiceApplicationProxyGroupReturns the proxy group for the specified service application.GetSPServiceApplicationProxyGroupGet-SPServiceApplicationProxyGroupIdentitySPServiceApplicationProxyGroupPipeBindAssignmentCollectionSPAssignmentCollectionGet-SPServiceApplicationProxyGroupDefaultSwitchParameterAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the name or the GUID of the proxy group.SPServiceApplicationProxyGroupPipeBindSPServiceApplicationProxyGroupPipeBind DefaultReturns the default sevice proxy group for the farm.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPServiceApplicationProxyGroup cmdlet displays a list of the proxy groups in the farm. To display a specific proxy group, use the Identity parameter. If no parameter value is specified, a list of all proxy groups is displayed.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE----------------- C:\PS>Get-SPServiceApplicationProxyGroupThis example retrieves all of the service application proxy groups in the farm.New-SPServiceApplicationProxyGroupRemove-SPServiceApplicationProxyGroupAdd-SPServiceApplicationProxyGroupMember Get-SPServiceApplicationProxyGroup New-SPWebApplicationExtensionCreates a new zone instance for the Web application.NewSPWebApplicationExtensionNew-SPWebApplicationExtensionIdentitySPWebApplicationPipeBindNameStringZoneDefault | Intranet | Internet | Custom | ExtranetAdditionalClaimProviderSPClaimProviderPipeBind[]AllowAnonymousAccessSwitchParameterAssignmentCollectionSPAssignmentCollectionAuthenticationMethodStringAuthenticationProviderSPAuthenticationProviderPipeBind[]ConfirmSwitchParameterHostHeaderStringPathStringPortUInt32SecureSocketsLayerSwitchParameterSignInRedirectProviderSPTrustedIdentityTokenIssuerPipeBindSignInRedirectURLStringUrlStringWhatIfSwitchParameterIdentitySpecifies the Web application to extend.SPWebApplicationPipeBindSPWebApplicationPipeBind NameSpecifies the name of the new IIS Web site in the Web application.StringString ZoneSpecifies one of the five zones with which the internal URL of this new extension is to be associated. This zone cannot already be in use..The type must be any one of the following values: Default, Intranet, Internet, Extranet, or CustomDefault | Intranet | Internet | Custom | ExtranetDefault | Intranet | Internet | Custom | Extranet AdditionalClaimProviderAdds a specific claim provider to the defined Web application.SPClaimProviderPipeBind[]SPClaimProviderPipeBind[] AllowAnonymousAccessAllows anonymous access to the Web application zone.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection AuthenticationMethodUses Kerberos or NTLM to specify the authentication method.StringString AuthenticationProviderSpecifies the authentication provider(s) that applies to a Web apllication.SPAuthenticationProviderPipeBind[]SPAuthenticationProviderPipeBind[] ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter HostHeaderSpecifies a valid URL assigned to the Web application by that must correlate to the alternate access mapping configuration, in the form http://server_name.When the HostHeader parameter is present, the value of this field is the internal URL for the Web application. The Url parameter is used to specify the public URL.StringString PathSpecifies the physical directory for the new Web site (in the virtual directories folder). The type is a valid path, in the form C:\Inetpub\wwwroot\MyWebApplication.StringString PortSpecifies the application port. Can be any valid port number.If no port is specified, a nonconflicting port number is automatically generated.If you specify a port number that is already assigned, IIS does not start the new site until you change either the port number of the new site or the port number of the old site.UInt32UInt32 SecureSocketsLayerEnables Secure Sockets Layer (SSL) encryption for this Web application. If you use SSL, you must add the certificate on each server by using the IIS administration tools. Until this is done, the Web application is inaccessible from this IIS Web site.SwitchParameterSwitchParameter SignInRedirectProviderSets the sign-in redirect URL to point to the URL that is defined in the specified authentication provider.SPTrustedIdentityTokenIssuerPipeBindSPTrustedIdentityTokenIssuerPipeBind SignInRedirectURLSpecifies the sign-in redirect URL for the Web application.StringString UrlSpecifies the load-balanced URL for the Web application zone.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The New-SPWebApplicationExtension cmdlet creates a new zone instance for the Web application. This is also known as extending a Web application and allows alternate permissions to be configured for the same content that is available in the existing Web application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Get-SPWebApplication http://sitename | New-SPWebApplicationExtension -Name "ExtranetSite" -SecureSocketsLayer -Zone "Extranet" -URL "https://extranet.sitename.com"This example extends the given Web application at http://sitename to the Extranet zone for SSL use.Get-SPWebApplicationSet-SPWebApplication New-SPWebApplicationExtension Add-SPSolutionUploads a SharePoint solution package to the farm.AddSPSolutionAdd-SPSolutionLiteralPathStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterLanguageUInt32WhatIfSwitchParameterLiteralPathSpecifies the path to the solution package.The type must be a valid path in either of the following forms:- C:\folder_name- \\server_name\folder_name StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter LanguageSpecifies the language pack to install with the solution package.The type must be a valid language identifier; for example, 1033.UInt32UInt32 WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Add-SPSolution cmdlet adds a SharePoint solution package to the farm. This cmdlet does not deploy the uploaded SharePoint solution. Use the Install-SPSolution cmdlet to deploy the SharePoint solution in the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Add-SPSolution -LiteralPath c:\contoso_solution.wspThis example adds the SharePoint solution in the file contoso_solution.wsp to the farm.Get-SPSolutionUpdate-SPSolutionUninstall-SPSolutionRemove-SPSolutionInstall-SPSolutionRemove-SPSolutionDeploymentLock Add-SPSolution Enable-SPBusinessDataCatalogEntityActivates an External Content type in the Business Data Connectivity Metadata Store.EnableSPBusinessDataCatalogEntityEnable-SPBusinessDataCatalogEntityIdentityEntityAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the External Content type in the Business Data Connectivity Metadata Store to activate.EntityEntity AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Enable-SPBusinessDataCatalogEntity cmdlet activates an External Content type in the Business Data Connectivity Metadata Store.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$entityToEnable = Get-SPBusinessDataCatalogMetadataObject -Namespace "Contoso" -Name "Customer" -BdcObjectType "Entity" -ServiceContext http://contoso Enable-SPBusinessDataCatalogEntity -Identity $entityToEnableThis example activates the External Content type with the name Customer in the Contoso namespace on the site http://contoso. Note that the terms External Content type and Entity refer to the same object type.Disable-SPBusinessDataCatalogEntity Enable-SPBusinessDataCatalogEntity Set-SPWebApplicationConfigures the specified Web application.SetSPWebApplicationSet-SPWebApplicationIdentitySPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDefaultQuotaTemplateStringDefaultTimeZoneInt32ForceSwitchParameterServiceApplicationProxyGroupSPServiceApplicationProxyGroupPipeBindWhatIfSwitchParameterSet-SPWebApplicationIdentitySPWebApplicationPipeBindZoneDefault | Intranet | Internet | Custom | ExtranetAdditionalClaimProviderSPClaimProviderPipeBind[]AssignmentCollectionSPAssignmentCollectionAuthenticationMethodStringAuthenticationProviderSPAuthenticationProviderPipeBind[]ConfirmSwitchParameterForceSwitchParameterSignInRedirectProviderSPTrustedIdentityTokenIssuerPipeBindSignInRedirectURLStringWhatIfSwitchParameterSet-SPWebApplicationIdentitySPWebApplicationPipeBindSMTPServerStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterOutgoingEmailAddressStringReplyToEmailAddressStringWhatIfSwitchParameterIdentitySpecifies the name or URL of the Web application.The type must be a valid name, in the form WebApplication-1212, or URL, in the form http://server_name/WebApplicaiton-1212.SPWebApplicationPipeBindSPWebApplicationPipeBind OutgoingEmailAddressSpecifies the new outgoing e-mail address for e-mail messages sent from this Web application. The type must be a valid address; for example, someone@example.com.StringString ReplyToEmailAddressConfigures the reply e-mail address. The type must be a valid address; for example, someone@example.com.StringString SMTPServerSpecifies the new outbound SMTP server that this Web application will use.StringString ZoneWhen configuring zone-specific settings, the zone to configure must be specified. This zone must already exist. The type must be any one of the following values: Default , Intranet , Internet , Extranet , or Custom .Default | Intranet | Internet | Custom | ExtranetDefault | Intranet | Internet | Custom | Extranet AdditionalClaimProviderAdds a specific claim provider to the defined Web application.SPClaimProviderPipeBind[]SPClaimProviderPipeBind[] AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection AuthenticationProviderDefines the authentication provider(s) that applies to the Web application.SPAuthenticationProviderPipeBind[]SPAuthenticationProviderPipeBind[] ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DefaultQuotaTemplateSpecifies the new default site quota template for this Web application.StringString DefaultTimeZoneSpecifies the default time zone for new site collections in this Web application.Int32Int32 HostHeaderSpecifies a valid URL assigned to the Web application that must correlate to the alternate access mapping configuration; for example, http://server_name. When the HostHeader parameter is present, the value of this field is the internal URL for the Web application. The Url parameter is used to specify the public URL. SecureSocketsLayerEnables Secure Sockets Layer (SSL) encryption for this Web application. If you use SSL, you must add the certificate on each server by using the IIS administration tools. Until you add the certificates, the Web application is inaccessible from this IIS Web site.ServiceApplicationProxyGroupSpecifies a custom service application proxy group for the Web application to use. The Web application will use the proxies in this proxy group to connect to service applications. If this parameter is not specified, the farm's default proxy group is used.SPServiceApplicationProxyGroupPipeBindSPServiceApplicationProxyGroupPipeBind SignInRedirectProviderSets the sign-in redirect URL to point to the URL that is defined in the specified authentication provider.SPTrustedIdentityTokenIssuerPipeBindSPTrustedIdentityTokenIssuerPipeBind SignInRedirectURLSpecifies the sign-in redirect URL for the Web application.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPWebApplication cmdlet configures the Web application specified by the Identity parameter. For any settings that are zone-specific (for the Zone parameter set), the zone to configure must be provided. The provided zone must already exist.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Get-SPWebApplication http://somesite | Set-SPWebApplication -Zone "Extranet" -HostHeader "http://www.contoso.com" - AllowAnonymousAccessThis example sets the HostHeader URL for the Extranet zone of the given Web application as http://www.contoso.com and enables anonymous access.Get-SPWebApplicationNew-SPWebApplicationRemove-SPWebApplication Set-SPWebApplication Rename-SPServerRenames a server that is currently connected to the farm.RenameSPServerRename-SPServerIdentitySPServerPipeBindNameStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the original name of the server.The type must be a URL, in the form http://server_name, or a GUID, in the form 1234-4567-987gb.SPServerPipeBindSPServerPipeBind NameSpecifies the new name of the server.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Rename-SPServer cmdlet changes the name of the server for internal use within SharePoint 2010 Products. The server itself must be manually renamed.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Rename-SPServer -Identity "wfb1" -Name "WFE1"This example changes the name of the SharePoint server wfb1 to WFE1.Get-SPServer Rename-SPServer Remove-SPConfigurationDatabasePermanently removes a configuration database. RemoveSPConfigurationDatabaseRemove-SPConfigurationDatabaseAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPConfigurationDatabase cmdlet permanently removes the farm's configuration database. The configuration database must be already dismounted from any associated farm. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Remove-SPConfigurationDatabaseThis example permanently deletes a configuration database from a farm. Backup-SPConfigurationDatabaseDisconnect-SPConfigurationDatabaseConnect-SPConfigurationDatabaseNew-SPConfigurationDatabaseDismount-SPConfigurationDatabase Remove-SPConfigurationDatabase Get-SPWebApplicationReturns all Web applications that match the given criteria.GetSPWebApplicationGet-SPWebApplicationIdentitySPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionIncludeCentralAdministrationSwitchParameterIdentitySpecifies the name, URL, or GUID of the Web application.The type must be a valid URL, in the form http://server_name; a GUID, in the form 1234-5678-9876-0987; or a valid name, in the form SPWebApplication - 1212.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection IncludeCentralAdministrationIncludes the Central Administration Web application in the collection of Web applications that can be returned. The IncludeCentral Administration parameter must still meet any other filters provided.SwitchParameterSwitchParameter The Get-SPWebApplication cmdlet returns all Web applications that match the scope given by the Identity parameter. The Identity can be the name of the name, URL, or GUID of the Web application. If no Identity is specified, all Web applications are returned.The Central Administration Web application is only returned if its exact identity is provided or the IncludeCentralAdministration flag is provided.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1---------------------- C:\PS>$w = Get-SPWebApplication http://sitenameThis example gets the Web application for http://sitename and stores it in a variable.------------------EXAMPLE 2----------------------- C:\PS>Get-SPWebApplication -IncludeCentralAdministration | Where { $_.DefaultServerComment -eq "SharePoint Central Administration v4"} | Format-List *This example displays all public properties on the SharePoint Central Administration Web application in list format.Get-SPWebApplicationHttpThrottlingMonitor Get-SPWebApplication Remove-SPServiceApplicationProxyGroupMemberRemoves one or more proxies from the specified service application proxy group.RemoveSPServiceApplicationProxyGroupMemberRemove-SPServiceApplicationProxyGroupMemberIdentitySPServiceApplicationProxyGroupPipeBindMemberSPServiceApplicationProxyPipeBind[]AssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the identity of the service application proxy group from which to remove the member or members.SPServiceApplicationProxyGroupPipeBindSPServiceApplicationProxyGroupPipeBind MemberSpecifies the member or members to remove from the service application proxy group.SPServiceApplicationProxyPipeBind[]SPServiceApplicationProxyPipeBind[] AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPServiceApplicationProxyGroupMember cmdlet removes one or more proxies from the specified service application proxy group.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Remove-SPServiceApplicationProxyGroupMember RemoteProxyGroup -Member babab30e-8e3a-428b-8ff4-4d5c8f455e6dThis example removes a service application proxy from the selected service application proxy group named RemoteProxyGroup.The service application proxy group GUID is unique to every farm. You can run Get-SPServiceApplicationProxyGroup | Select Name,Id to see the GUID of the service application proxy groups. Use this result for any other SPServiceApplicationProxyGroup cmdlets.Add-SPServiceApplicationProxyGroupMember Remove-SPServiceApplicationProxyGroupMember New-SPSiteSubscriptionCreates a new site subscription.NewSPSiteSubscriptionNew-SPSiteSubscriptionAssignmentCollectionSPAssignmentCollectionAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The New-SPSiteSubscription cmdlet creates a new subscription to which the SPSites object can belong. Sites that are members of a site subscription can share settings and configuration information. A site collection can be a member of only one site subscription and, once set, cannot be changed.Site subscriptions are not persisted in a database until used in conjunction with either an SPSite or the Site Subscription Settings Service. After a site subscription is applied to any site collection in the farm, the site subscription can be retrieved by using the Get-SPSiteSubscription cmdlet.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1----------------------- C:\PS>New-SPSiteSubscription |%{ New-SPSite http://contoso.com/sites/admin -SiteSubscription $_ -Template "TenantAdmin#0"} C:\PS>This example creates a new site subscription and applies it to a new Tenant Administration site collection.------------------EXAMPLE 2----------------------- C:\PS>$s = New-SPSiteSubscription C:\PS>Get-SPSite http://sitename | Set-SPSite -SiteSubscription $s C:\PS>Set-SPSite http://sitename -SiteSubscription {New-SPSiteSubscription}This example adds a new subscription to an existing site collection at http://sitename.Get-SPSiteSubscriptionRemove-SPSiteSubscription New-SPSiteSubscription Set-SPPassPhraseSets the pass phrase to a new value.SetSPPassPhraseSet-SPPassPhraseConfirmPassPhraseSecureStringPassPhraseSecureStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterSet-SPPassPhrasePassPhraseSecureStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterLocalServerOnlySwitchParameterWhatIfSwitchParameterConfirmPassphraseSecureStringSecureString PassphraseSpecifies the new Passphrase value.SecureStringSecureString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter LocalServerOnlyScopes the Passphrase change to the local server only. If this parameter is not used, the Passphrase change is performed farm-wide.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPPassPhrase cmdlet sets the Passphrase to a new Passphrase value. If the LocalServerOnly parameter is not used, the farm encryption key is re-encrypted with the new value and attempts to propagate this value to all other servers in the farm. If the LocalServerOnly parameter is used, this is updated on the local machine only, and the farm encryption key is not changed. The Passphrase value must be the same on all servers in the farm if the farm is to function correctly. So if the Passphrase fails to propagate to all servers, the LocalServerOnly parameter can be used to set the remaining servers to the new Passphrase value manually.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>$passphrase = ConvertTo-SecureString -asPlainText -Force C:\PS>Set-SPPassPhrase -PassPhrase $passphrase -ConfirmThis example queries for a string to use as a passphrase, and sets the farm passphrase to a new value. Set-SPPassPhrase Remove-SPTrustedServiceTokenIssuerDeletes the object that represents the farm trust.RemoveSPTrustedServiceTokenIssuerRemove-SPTrustedServiceTokenIssuerIdentitySPTrustedServiceTokenIssuerPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the trusted service token issuer to delete.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted service token issuer (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object.SPTrustedServiceTokenIssuerPipeBindSPTrustedServiceTokenIssuerPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Remove-SPTrustedServiceTokenIssuer cmdlet deletes the object that represents the farm trust.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Remove - SPTrustedServiceTokenIssuer "WFE Farm 2"This example deletes the trusted service token issuer WFE Farm 2.Set-SPTrustedServiceTokenIssuerNew-SPTrustedServiceTokenIssuerGet-SPTrustedServiceTokenIssuer Remove-SPTrustedServiceTokenIssuer Get-SPServiceInstanceReturns the services instance for a specific server or the entire farm.GetSPServiceInstanceGet-SPServiceInstanceIdentitySPServiceInstancePipeBindAllSwitchParameterAssignmentCollectionSPAssignmentCollectionGet-SPServiceInstanceServerSPServerPipeBindAllSwitchParameterAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the GUID of the service instance.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh.SPServiceInstancePipeBindSPServiceInstancePipeBind ServerSpecifies the server from which to return the service instance.SPServerPipeBindSPServerPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPServiceInstance cmdlet returns the services instance specified by the Identity parameter for a specific server. If the Server parameter is not specified, the Get-SPServiceInstance cmdlet returns results for the entire farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE----------------- C:\PS>Get-SPServiceInstance -Server ServerAThis example displays the service instances from a given server.Start-SPServiceInstanceStop-SPServiceInstance Get-SPServiceInstance Receive-SPServiceApplicationConnectionInfoConfigures this farm to receive service information from another farm.ReceiveSPServiceApplicationConnectionInfoReceive-SPServiceApplicationConnectionInfoFarmUrlUriAssignmentCollectionSPAssignmentCollectionFilterStringFarmUrlUriUri AssignmentCollectionSPAssignmentCollectionSPAssignmentCollection FilterStringString The Receive-SPServiceApplicationConnectionInfo cmdlet retrieves the list of service applications published by another farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Receive-SPServiceApplicationConnectionInfo -FarmUrl http://FarmB/topology/topology.svcThis example retreives a list of service applications published by a given farm.The FarmURL parameter can be obtained by the Get-SPTopologyServiceApplication cmdlet. Receive-SPServiceApplicationConnectionInfo New-SPContentDatabaseCreates a new content database and attaches it to the specified Web application.NewSPContentDatabaseNew-SPContentDatabaseNameStringWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionAssignNewDatabaseIdSwitchParameterClearChangeLogSwitchParameterConfirmSwitchParameterDatabaseCredentialsPSCredentialDatabaseServerStringMaxSiteCountInt32WarningSiteCountInt32WhatIfSwitchParameterNameSpecifies the new content database to create within the farm.The type must be a valid name of a SharePoint content database; for example, SPContentDB1.StringString WebApplicationAttaches the content database to the specified SharePoint Web application.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection AssignNewDatabaseIdCreates a new database ID automatically when the content database is attached.SwitchParameterSwitchParameter ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ClearChangeLogClears any pending changes from the change log in the content database.SwitchParameterSwitchParameter DatabaseCredentialsSpecifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication.The type must be a valid PSCredential object.PSCredentialPSCredential DatabaseServerSpecifies the name of the host server for the content database specified in the Name parameter.The type must be a valid SQL Server host name; for example, SQLServerHost1.StringString MaxSiteCountSpecifies the maximum number of Web sites that can use the content database.The type must be a positive integer.Int32Int32 WarningSiteCountSpecifies the number of sites that can be created before a warning event is generated and the owner of the site collection is notified.The type must be a positive integer.Int32Int32 WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The New-SPContentDatabase cmdlet creates a new content database and attaches it to the specified Web application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE-------------------- C:\PS>New-SPContentDatabase "MyDatabase" -DatabaseServer "MyServer" -WebApplication http://sitenameThis example creates a new content database for the sitename Web application. New-SPContentDatabase Remove-SPServiceApplicationProxyGroupCompletely deletes the specified service application proxy group.RemoveSPServiceApplicationProxyGroupRemove-SPServiceApplicationProxyGroupIdentitySPServiceApplicationProxyGroupPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentityThe identity of the service application proxy group to delete.SPServiceApplicationProxyGroupPipeBindSPServiceApplicationProxyGroupPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Completely deletes the specified service application proxy group.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------------EXAMPLE------------------------- C:\PS>Remove-SPServiceApplicationProxyGroup RemoteProxyGroupThis example deletes the service application proxy group named RemoteProxyGroup.The service application proxy group GUID is unique to every farm. You can run Get-SPServiceApplicationProxyGroup | Select Name,Id to see the GUID of the service application proxy groups. Use this result for any other SPServiceApplicationProxyGroup cmdlets.Get-SPServiceApplicationProxyGroupNew-SPServiceApplicationProxyGroup Remove-SPServiceApplicationProxyGroup Get-SPWorkflowConfigReturns workflow settings for the specified Web application.GetSPWorkflowConfigGet-SPWorkflowConfigWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionGet-SPWorkflowConfigSiteCollectionSPSitePipeBindAssignmentCollectionSPAssignmentCollectionSiteCollectionSpecifies the name or URL of the site collection.The only other parameter that is used with the SiteCollection parameter is the DeclarativeWorkflowsEnabled parameter. No other parameters are used. SPSitePipeBindSPSitePipeBind WebApplicationSpecifies the name or URL of the Web application.The type must be a valid name, in the form WebApplication-1212, or a URL, in the form http://server_name/WebApplication-1212.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPWorkflowConfig cmdlet returns workflow settings for the Web application specified by the WebApplication parameter.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE----------------- C:\PS>Get-SPWorkFlowConfig -webapplication http://sitenameThis example gets workflow settings for the specified Web application (http://sitename).To get farm-level workflow settings for event delivery time-out, postpone threshold, and batch size, use the Get-SPFarmConfig cmdlet. Set-SPWorkflowConfig Get-SPWorkflowConfig Set-SPDiagnosticConfigSets diagnostic configuration settings on the farm.SetSPDiagnosticConfigSet-SPDiagnosticConfigAllowLegacyTraceProvidersSwitchParameterAssignmentCollectionSPAssignmentCollectionCustomerExperienceImprovementProgramEnabledSwitchParameterDaysToKeepLogsInt32DownloadErrorReportingUpdatesEnabledSwitchParameterErrorReportingAutomaticUploadEnabledSwitchParameterErrorReportingEnabledSwitchParameterEventLogFloodProtectionEnabledSwitchParameterEventLogFloodProtectionNotifyIntervalInt32EventLogFloodProtectionQuietPeriodInt32EventLogFloodProtectionThresholdInt32EventLogFloodProtectionTriggerPeriodInt32InputObjectPSObjectLogCutIntervalInt32LogDiskSpaceUsageGBInt32LogLocationStringLogMaxDiskSpaceUsageEnabledSwitchParameterScriptErrorReportingDelayInt32ScriptErrorReportingEnabledSwitchParameterScriptErrorReportingRequireAuthSwitchParameterAllowLegacyTraceProvidersSpecifies that trace providers built for previous versions of SharePoint Products and Technologies can write to the trace session for SharePoint 2010 Products.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection CustomerExperienceImprovementProgramEnabledSpecifies whether participation in the Customer Experience Improvement Program (CEIP) is enabled.The CEIP is designed to improve the quality, reliability, and performance of Microsoft products and technologies. With your permission, anonymous information about your server is sent to Microsoft to help improve SharePoint Products and Technologies.The type must be either of the following values:- $True- $FalseThe default value is $True .SwitchParameterSwitchParameter DaysToKeepLogsSpecifies the number of days to keep trace log files. The type must be a valid number between 1 and 366. The default value is 14 days. .Int32Int32 DownloadErrorReportingUpdatesEnabledSpecifies whether the error reporting remote control file is downloaded.The type must be either of the following values:- $True- $FalseThe default value is $True .SwitchParameterSwitchParameter ErrorReportingAutomaticUploadEnabledSpecifies whether error reports are uploaded to Microsoft automatically.Error reports include the following: information regarding the condition of the server when a problem occurs; the operating system version and computer hardware in use; and the digital product ID, which can be used to identify your license. The IP address of your computer is also sent because you are connecting to an online service to send error reports; however, the IP address is used only to generate aggregate statistics.The type must be either of the following values:- $True- $FalseThe default value is $True .SwitchParameterSwitchParameter ErrorReportingEnabledSpecifies whether collection of error reports is enabled.Error reports are created when your system encounters hardware or software problems. Microsoft and its partners actively use these reports to improve the reliability of the software. Error reports include the following: information regarding the condition of the server when the problem occurs; the operating system version and computer hardware in use; and the digital product ID, which can be used to identify your license. The IP address of your computer is also sent because you are connecting to an online service to send error reports; however, the IP address is used only to generate aggregate statistics .The type must be either of the following values:- $True- $FalseThe default value is $True .SwitchParameterSwitchParameter EventLogFloodProtectionEnabledSpecifies whether the Event log flood protection feature is enabled.If multiple similar events are written to the event log, Microsoft SharePoint Foundation 2010 suppresses some duplicate messages, and then after a period of time a summary message is written that shows how many events were suppressed.The type must be either of the following values:- $True- $FalseThe default value is $True .SwitchParameterSwitchParameter EventLogFloodProtectionNotifyIntervalSpecifies in minutes how often to write a summary event indicating how many events were suppressed due to flood protection.The integer range is between 1 and 1440. The default value is 5.Int32Int32 EventLogFloodProtectionQuietPeriodSpecifies in minutes how much time must pass without an event firing to exit flood protection.The integer range is between 1 and 1440. The default value is 2.Int32Int32 EventLogFloodProtectionThresholdSpecifies the number of events allowed in a given timeframe before an event is considered to be flooding the event log.The integer range is between 1 and 100. The default value is 5.Int32Int32 EventLogFloodProtectionTriggerPeriodSpecifies in minutes the timeframe to watch for events that may be flooding.The integer range is between 1 and 1440. The default value is 2.Int32Int32 InputObjectUse the result from the Get-SPDiagnosticConfig cmdlet, make modifications, and then pipeline the object into Set-SPDiagnosticConfig cmdlet to update the Windows SharePoint Services database.PSObjectPSObject LogCutIntervalSpecifies a time period to roll over to the next log file.The type must be a valid number between 0 and 1440.The default value is 30.Int32Int32 LogDiskSpaceUsageGBSpecifies the maximum amount of storage to use for trace log files, in gigabytes (GB). The default value is 1000 and only takes effect when the LogMaxDiskSpaceusageEnabled cmdlet is set to True.The type must be a valid number between 1 and 1000.Int32Int32 LogLocationSpecifies the path of where to log files will reside.The type must be a valid path, in the form C:\Logs.The default location is %CommonProgramFiles%\Microsoft Shared\Web Server Extensions\14\Logs.StringString LogMaxDiskSpaceUsageEnabledSpecifies whether to restrict the maximum space to use for trace log files. The type must be either of the following values:- $True- $FalseThe default value is $False .SwitchParameterSwitchParameter ScriptErrorReportingDelaySpecifies the time (in minutes) between script error reports. The type must be a valid integer between 0 and 1440. The value is specified in minutes.The default value is 30.Int32Int32 ScriptErrorReportingEnabledSpecifies whether error reporting is enabled for client script errors.The type must be either of the following values:- $True- $FalseThe default value is $True .SwitchParameterSwitchParameter ScriptErrorReportingRequireAuthSpecifies whether script error reporting requires authentication.The type must be either of the following values:- $True- $FalseThe default value is $True .SwitchParameterSwitchParameter Use the Set-SPDiagnosticConfig cmdlet to set diagnostic configuration settings on the entire farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1----------------------- C:\PS>set-spdiagnosticconfig -errorReportingEnable -DownloadErrorReportingUpdatesEnabled:$false -DaysToKeepLog 60This example set the number of days to keep the log file to 60. ------------------EXAMPLE 2----------------------- C:\PS>$L = get-spdiagnosticconfig C:\PS>$L.CustomerExperienceImprovementProgramEnabled = $false C:\PS>$L.LogCutInterval = 60 C:\PS>$L | Set-SPDiagnosticConfigThis example enables ErrorReporting, disables DownloadErrorReportingUpdates, and then sets DaysToKeepLog to 60.Get-SPDiagnosticConfig Set-SPDiagnosticConfig Get-SPLogLevelReturns a list of objects or diagnostic levels.GetSPLogLevelGet-SPLogLevelAssignmentCollectionSPAssignmentCollectionIdentityString[]AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection IdentitySpecifies a valid category name; for example, Backup and Restore, or Administration.String[]String[] The Get-SPLogLevel cmdlet displays a list of objects or diagnostic levels based on the criteria specified. If no parameter is specified, a list of all diagnostic levels for all categories is returned.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE 1----------------- C:\PS>Get-SPLogLevelThis example displays throttle levels for all categories.--------------EXAMPLE 2----------------- C:\PS>Get-SPLogLevel -Identity "Category1"This example displays the throttle level for the Category1 category.--------------EXAMPLE 3----------------- C:\PS>"Cat1", "Cat2", "Cat3" | Get-SpLogLevelThis example displays the throttle level for multiple categories.--------------EXAMPLE 4----------------- C:\PS>Get-SPLogLevel -Identity "Area:*"This example displays the throttle level for all categories in one area.Set-SPLogLevelClear-SPLogLevel Get-SPLogLevel Start-SPTimerJobRuns a timer job once.StartSPTimerJobStart-SPTimerJobIdentitySPTimerJobPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the timer job to run.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object.SPTimerJobPipeBindSPTimerJobPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Start-SPTimerJob cmdlet runs a timer job once on each front-end Web server where the parent service is provisioned.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -----------------EXAMPLE---------------- C:\PS>Get-SPTimerJob job-recycle-bin-cleanup | Start-SPTimerJobThis example starts the timer job named, job-recycle-bin-cleanup.Get-SPTimerJobSet-SPTimerJobDisable-SPTimerJobEnable-SPTimerJob Start-SPTimerJob Copy-SPBusinessDataCatalogAclToChildrenCopies a set of permissions of a Business Data Connectivity Metadata Store metadata object to its child objects.CopySPBusinessDataCatalogAclToChildrenCopy-SPBusinessDataCatalogAclToChildrenMetadataObjectMetadataObjectAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterMetadataObjectSpecifies the Business Data Connectivity metadata object.MetadataObjectMetadataObject AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Copy-SPBusinessDataCatalogAclToChildren cmdlet copies a set of rights of a Business Data Connectivity metadata object to its child objects.Any principals and their rights will be lost from the child metadata objects. Make sure that the parent metadata object has the final permissions you want, or make sure to append them to the child object again after you run this cmdlet.Running this cmdlet on a BdcObjectType BdcCatalog (Business Data Connectivity Metadata Store) will propagate to: - BDC Models- External Systems- External Content Types- Methods- Method InstancesRunning this cmdlet on a BdcObjectType Model (Business Data Connectivity Model) will propagate to:- Nothing; this type has no child metadata objectsRunning this cmdlet on a BdcObjectType LobSystem (External System) will propagate to:- External Content Types- Methods- Method InstancesRunning this cmdlet on a BdcObjectType Entity (External Content Type) will propagate to:- Methods- Method InstancesFor permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$ExternalSystem = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "LobSystem" -ServiceContext http://contoso -Name "ContosoDatabase"This example looks at the principals (users) and their corresponding rights given for the External System metadata object, and overwrites the permissions of its child metadata objects with these same principals and rights.Any principals and their rights will be lost from the child metadata objects. Make sure that the parent metadata object has the final permissions you want, or make sure to append them to the child object again after you run this cmdlet.Get-SPBusinessDataCatalogMetadataObjectGrant-SPBusinessDataCatalogMetadataObject Copy-SPBusinessDataCatalogAclToChildren New-SPWebCreates a new site in an existing site collection.NewSPWebNew-SPWebUrlStringAddToQuickLaunchSwitchParameterAddToTopNavSwitchParameterAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDescriptionStringLanguageUInt32NameStringTemplateSPWebTemplatePipeBindUniquePermissionsSwitchParameterUseParentTopNavSwitchParameterWhatIfSwitchParameterUrlSpecifies the URL where the new site is to be created. The URL must be inside an existing site collection. The URL must be a valid URL, in the form http://server_name/site1.StringString LanguageSpecifies the language template identifier for the new site. If no language is specified, the site is created with the same language that was specified when the product was installed.The type must be a valid language identifier ( LCID ).UInt32UInt32 TemplateSpecifies the Web template for the new site. The template must already exist. If no template is specified, no template is applied and a template can be selected later.SPWebTemplatePipeBindSPWebTemplatePipeBind NameSpecifies the title of the new site. If no title is specified, the default title is applied. The default title is configured for each template.StringString DescriptionDescribes the new site. If no description is specified, the entry is left blank.StringString AddToQuickLaunchAdds this site to the Quick Launch.SwitchParameterSwitchParameter UniquePermissionsSpecifies that this site is to be created with unique permissions.SwitchParameterSwitchParameter AddToTopNavAdds this site to the top-level navigation bar.SwitchParameterSwitchParameter UseParentTopNavSpecifies that the same top-level navigation bar as the parent site is to be used for this site.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The New-SPWeb cmdlet creates a new site in the existing site collection specified by the Url parameter. You can create a site with a specific default language by specifying the Language parameter. If no language is specified, the site is created with the same language that was specified when the product was installed. You can create a site from a specific template by specifying the Template parameter. If no template is specified, the site is created and the template can be provided later or by the first user to log on.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). none------------------EXAMPLE----------------------- C:\PS>New-SPWeb http://somesite/subweb1 -Template "STS#0"This example creates a new subsite by using the Team Site template at the provided URL (http://somesite/subweb1). The Team Site template is a value referenced as the variable STS#0 for the Template parameter.Get-SPWebSet-SPWebRemove-SPWebImport-SPWeb New-SPWeb Get-SPUserReturns the user account or accounts that match a given search criteria.GetSPUserGet-SPUserIdentitySPUserPipeBindWebSPWebPipeBindAssignmentCollectionSPAssignmentCollectionGroupSPGroupPipeBindLimitStringIdentitySpecifies the GUID or login name of the user to be returned. The type must be a valid URL, in the form http://server_name, or GUID, in the form1234-5678-9807.SPUserPipeBindSPUserPipeBind WebSpecifies the Web site to be used as a scope.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a Microsoft SharePoint Foundation 2010 Web site (for example, MySPSite1); or an instance of a valid SPWeb object.SPWebPipeBindSPWebPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection GroupSpecifies the user group to which the new user belongs.SPGroupPipeBindSPGroupPipeBind LimitSpecifies the maximum number of users to return. The default value is 500.StringString The Get-SPUser cmdlet returns all SharePoint user accounts that match the scope given by the Identity, Web, or Group parameters.The Identity parameter can use the alias of a user for returning exact matches. However, a scope must be provided if the Get-SPUser cmdlet is to work.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Get-SPUser -Web "http://zsharepoint2" -Group "Viewers"This example returns all members of the group Viewers on the Web site http://zsharepoint2.Move-SPUserNew-SPUserSet-SPUserRemove-SPUser Get-SPUser Mount-SPContentDatabaseAttaches an existing content database to the farm.MountSPContentDatabaseMount-SPContentDatabaseNameStringWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionAssignNewDatabaseIdSwitchParameterClearChangeLogSwitchParameterConfirmSwitchParameterDatabaseCredentialsPSCredentialDatabaseServerStringMaxSiteCountInt32UpdateUserExperienceSwitchParameterWarningSiteCountInt32WhatIfSwitchParameterNameSpecifies the existing content database to attach to the farm.The type must be a valid name of a SharePoint content database; for example, SPContentDB1.StringString WebApplicationAttaches the content database to the specified SharePoint Web application.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection AssignNewDatabaseIdCreates a new database ID automatically when the content database is attached.SwitchParameterSwitchParameter ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ClearChangeLogClears any pending changes from the change log in the content database.SwitchParameterSwitchParameter DatabaseCredentialsSpecifies the PSCredential object that contains the user name and password to be used for database SQL Authentication.The type must be a valid PSCredential object.PSCredentialPSCredential DatabaseServerSpecifies the name of the host server for the content database specified in the Name parameter.The type must be a valid SQL Server host name; for example, SQLServerHost1.StringString MaxSiteCountSpecifies the maximum number of Web sites that can use the content database.The type must be a positive integer.Int32Int32 UpdateUserExperienceDetermines whether the content databases should upgrade to the latest user interface. By default, the user interface will not change during upgrade. SwitchParameterSwitchParameter WarningSiteCountSpecifies the number of sites that can be created before a warning event is generated and the owner of the site collection is notified.The type must be a positive integer.Int32Int32 WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Mount-SPContentDatabase cmdlet attaches an existing content database to the farm. If the database being mounted requires an upgrade, this cmdlet will cause the database to be upgraded.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -----------------EXAMPLE--------------------- C:\PS>Mount-SPContentDatabase "MyDatabase" -DatabaseServer "MyServer" -WebApplication http://sitenameThis example mounts an already existing database to the sitename Web application.Get-SPContentDatabaseSet-SPContentDatabaseRemove-SPContentDatabaseUpgrade-SPContentDatabaseDismount-SPContentDatabaseGet-SPServerInitialize-SPContentDatabase Mount-SPContentDatabase Uninstall-SPUserSolutionDeactivates a sandboxed solution in a site collection.UninstallSPUserSolutionUninstall-SPUserSolutionIdentitySPUserSolutionPipeBindSiteSPSitePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the sandboxed solution to deactivate.The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object.SPUserSolutionPipeBindSPUserSolutionPipeBind SiteDeactivates the sandboxed solution for the specified site collection.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object.SPSitePipeBindSPSitePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Uninstall-SPUserSolution cmdlet deactivates a sandboxed solution in a site collection so that you can delete it by using the Remove-SPUserSolution cmdlet. A user solution is a sandboxed solution. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE--------------- C:\PS>Uninstall-SPUserSolution -Identity contoso_solution.wsp -Site http://sitenameThis example deactivates the sandboxed solution contoso_solution.wsp on the site http://sitename.Update-SPUserSolutionInstall-SPUserSolutionRemove-SPUserSolutionGet-SPUserSolutionAdd-SPUserSolution Uninstall-SPUserSolution Initialize-SPResourceSecurityEnforces resource security on the local server.InitializeSPResourceSecurityInitialize-SPResourceSecurityAssignmentCollectionSPAssignmentCollectionAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Initialize-SPResourceSecurity cmdlet enforces resource security on the local server. This cmdlet enforces security for all resources, including files, folders, and registry keys.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Initialize-SPResourceSecurityThis example enforces resource security on the local server. Initialize-SPResourceSecurity Set-SPBrowserCustomerExperienceImprovementProgramTurns on or off the browser Customer Experience Improvement Program.SetSPBrowserCustomerExperienceImprovementProgramSet-SPBrowserCustomerExperienceImprovementProgramFarmSwitchParameterAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterEnableSwitchParameterWhatIfSwitchParameterSet-SPBrowserCustomerExperienceImprovementProgramWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterEnableSwitchParameterWhatIfSwitchParameterSet-SPBrowserCustomerExperienceImprovementProgramSiteSubscriptionSPSiteSubscriptionPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterEnableSwitchParameterWhatIfSwitchParameterFarmSwitchParameterSwitchParameter SiteSubscriptionSets the Customer Experience Improvement Program opt-in state for the specified site subscription.The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscription1); or an instance of a valid SiteSubscription object.SPSiteSubscriptionPipeBindSPSiteSubscriptionPipeBind WebApplicationSets the Customer Experience Improvement Program opt-in state for the specified SharePoint Web application.The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter EnableTurns on the browser Customer Experience Improvement Program. The default value is True.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPBrowserCustomerExperienceImprovementProgram cmdlet turns on or off the browser Customer Experience Improvement Program for collecting software quality metrics.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1----------------------- C:\PS>Set-SPBrowserCustomerExperienceImprovementProgram -Farm -EnableThis example turns on the browser Customer Experience Improvement Program for the farm.------------------EXAMPLE 2----------------------- C:\PS>Set-SPBrowserCustomerExperienceImprovementProgram -Farm -Enable:$FalseThis example turns off the browser Customer Experience Improvement Program for the farm.------------------EXAMPLE 3----------------------- C:\PS>Set-SPWebApplication http://MyOfficeApp1 | Get- SPBrowserCustomerExperienceImprovementProgram -EnableThis example turns on the browser Customer Experience Improvement Program for the Web application, MyOfficeApp1.Get-SPBrowserCustomerExperienceImprovementProgram Set-SPBrowserCustomerExperienceImprovementProgram Get-SPClaimProviderManagerReturns a claim provider manager.GetSPClaimProviderManagerGet-SPClaimProviderManagerAssignmentCollectionSPAssignmentCollectionAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPClaimProviderManager cmdlet reads a claim provider manager.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). Add code example. C:\PS>Get-SPClaimProviderNew-SPClaimProviderSet-SPClaimProvider Get-SPClaimProviderManager New-SPTrustedRootAuthorityCreates a trusted root authority.NewSPTrustedRootAuthorityNew-SPTrustedRootAuthorityNameStringCertificateX509Certificate2AssignmentCollectionSPAssignmentCollectionNameSpecifies the name of the trusted root authority to create.The type must be a valid name of a trusted root authority; for example, WFEFarm1.StringString CertificateSpecifies the X.509 certificate of the trusted root authority.The type must be a name of a valid X.509 certificate; for example, Certificate1.X509Certificate2X509Certificate2 AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The New-SPTrustedRootAuthority cmdlet creates a trusted root authority. If a certificate file is used, it must have only one X509 certificate without private keys, otherwise an exception is raised.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx New - SPTrustedRootAuthority -Name "WFEFarm1" -Certificate $certThis example creates a new trusted root authority, WFEFarm1.Get-SPTrustedRootAuthoritySet-SPTrustedRootAuthorityRemove-SPTrustedRootAuthority New-SPTrustedRootAuthority Remove-SPAlternateUrlCompletely deletes the specified alternate URL.RemoveSPAlternateUrlRemove-SPAlternateUrlIdentitySPAlternateUrlPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the identity of the alternate URL to delete. The identity can be either a valid URL, in the form http://server_name, or a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh. SPAlternateUrlPipeBindSPAlternateUrlPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPAlternateUrl cmdlet completely deletes the alternate URL specified by the Identity parameter.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1----------------------- C:\PS>Remove-SPAlternateURL -WebApplication http://sitename -Zone ExtranetThis example deletes the extranet URL for the given Web application.------------------EXAMPLE 2----------------------- C:\PS>Get-SPWebApplication |%{ Get-SPAlternateURL -WebApplication $_ -Zone "Extranet" } | Remove-SPAlternateURLThis example removes all extranet alternate URLs in the farm. New-SPAlternateUrlGet-SPAlternateURLSet-SPAlternateUrl Remove-SPAlternateUrl Add-SPServiceApplicationProxyGroupMemberAdds a member to the service application proxy group.AddSPServiceApplicationProxyGroupMemberAdd-SPServiceApplicationProxyGroupMemberIdentitySPServiceApplicationProxyGroupPipeBindMemberSPServiceApplicationProxyPipeBind[]AssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the service application proxy group to which to add the member.SPServiceApplicationProxyGroupPipeBindSPServiceApplicationProxyGroupPipeBind MemberSpecifies an array of members to add to the service application proxy group.SPServiceApplicationProxyPipeBind[]SPServiceApplicationProxyPipeBind[] AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Add-SPServiceApplicationProxyGroupMember cmdlet adds a member to the service application proxy group.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185).------------------EXAMPLE----------------------- C:\PS>Add-SPServiceApplicationProxyGroupMember RemoteProxyGroup -Member babab30e-8e3a-428b-8ff4-4d5c8f455e6dThis example adds a select service application proxy to the service application proxy group named RemoteProxyGroup.The service application proxy group GUID is unique to every farm. You can run Get-SPServiceApplicationProxyGroup | Select Name,Id to see the GUID of the serviceapplication proxy groups. Use this result for any other SPServiceApplicationProxyGroup cmdlets.Remove-SPServiceApplicationProxyGroupMember Add-SPServiceApplicationProxyGroupMember Get-SPLogEventReturns results from a Unified Logging Service (ULS) trace log.GetSPLogEventGet-SPLogEventAssignmentCollectionSPAssignmentCollectionAsStringSwitchParameterContextKeyString[]DirectoryStringEndTimeDateTimeMinimumLevelStringStartTimeDateTimeGet-SPLogEventAssignmentCollectionSPAssignmentCollectionAsStringSwitchParameterContextKeyString[]EndTimeDateTimeFileStringMinimumLevelStringStartTimeDateTimeAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection AsStringReturns each record as a separate stringSwitchParameterSwitchParameter ContextKeySpecifies that context data should be added to the results for the specified Context Keys, for example: -ContextKey @("UserName", "SiteName").String[]String[] DirectoryLists log files from an alternate directory (any directory other than the configured LogLocation directory).StringString MinimumLevelReturns records at or above the specified level. The valid values are Error or Warning.StringString EndTimeThe type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US.DateTimeDateTime FileSpecifies a specific file to query records from.StringString StartTimeThe type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US.DateTimeDateTime The Get-SPLogEvent cmdlet returns records from a ULS trace log file that match the criteria. If no parameters are specified, all records from all log files are returned. Use the StartTime and EndTime parameters to filter on a time range. The use of these parameters is recommended to optimize performance of this cmdlet. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185.--------------EXAMPLE 1----------------- C:\PS>Get-SPLogEvent -MinimumLevel "Warning"This example returns all log entries equal to or more severe than Warning from the default log directory.--------------EXAMPLE 2----------------- C:\PS>Get-SPLogEvent -Directory "C:\Logs" | Where-Object {$_.Level -eq "Warning"}This example returns all warning entries from log files in the C:\Logs directory.--------------EXAMPLE 3----------------- C:\PS>Get-SPLogEvent -StartTime "12/04/2007 17:00" -EndTime "12/04/2007 18:00"This example returns error entries that occurred during a particular time range, which is culture-specific to the United States.--------------EXAMPLE 4----------------- C:\PS>Get-SPLogEvent -ContextKey @("UserName" ,"SiteName")This example returns the contents of the most recent log file and adds the specified context key data.--------------EXAMPLE 5----------------- C:\PS>Get-SPLogEvent | Where-Object {$_.Level -eq "Error" -and {$_.Area -eq "SharePoint Foundation "}This example returns all error entries related to SharePoint Foundation.--------------EXAMPLE 6----------------- C:\PS>Get-SPLogEvent -ContextKey @("Name") | %{$_.ToString() + "'t" + $_.Context["Name"]}This example returns the contents of the log file and adds context data.New-SPLogFileGet-SPLogLevel Get-SPLogEvent Get-SPDiagnosticConfigRetrieves ULS diagnostic configuration values of the farm.GetSPDiagnosticConfigGet-SPDiagnosticConfigAssignmentCollectionSPAssignmentCollectionAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPDiagnoticConfig cmdlet retrieves ULS diagnostic configuation values of the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE----------------- C:\PS>Get-SPDiagnosticConfigThis example returns all diagnostic configuration values.Set-SPDiagnosticConfig Get-SPDiagnosticConfig Backup-SPConfigurationDatabasePerforms a farm-level configuration-only backup.BackupSPConfigurationDatabaseBackup-SPConfigurationDatabaseDirectoryStringAssignmentCollectionSPAssignmentCollectionDatabaseCredentialsPSCredentialDatabaseNameStringDatabaseServerStringItemStringBackup-SPConfigurationDatabaseShowTreeSwitchParameterAssignmentCollectionSPAssignmentCollectionDatabaseCredentialsPSCredentialDatabaseNameStringDatabaseServerStringItemStringDirectorySpecifies the path where SharePoint 2010 Products stores the backup package it generates. If you have a computer on which Microsoft SQL Server 2008 and an instance of SharePoint 2010 Products are installed, you can use local drive paths. This includes a basic installation. However, if SQL Server 2008 and SharePoint 2010 Products are installed on multiple computers or if you have multiple servers running SharePoint 2010 Products, you must use Universal Naming Convention (UNC) share paths so that the SQL Server database and search components are written to the same location; for example, \\computer_name\volume\Backup).Multiple backup packages can be stored in the same location. This is the same path that you pass to the Directory parameter of the Restore-SPFarm cmdlet.The type must be either of the valid paths:- C:\folder_name- \\server_name\folder_nameThe spbr* folders are automatically created.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection DatabaseCredentialsSpecifies the ID and password that corresponds to the administrator user name for the SQL Server database.This parameter should only be specified if SQL authentication is used to connect to the database. If Windows authentication is used to connect to the database, then this parameter should not be specified.PSCredentialPSCredential DatabaseNameSpecifies the configuration database name.StringString DatabaseServerSpecifies the SQL database server that contains the configuration database. The default value is the local computer name.The type must be a valid database server; for example, DS.StringString ItemIndicates the part of the farm to back up. You may use the full farm path notation as displayed by the ShowTree parameter or the name of the target component in the path if the component has a unique name. If multiple items match the name, the full path must be provided. Surround the item or path in quotation marks if it contains a space. If the Item parameter is not specified, the entire farm configuration is backed up.StringString ShowTreeDisplays which objects in the farm will be backed up based on the other parameters passed to the backup cmdlet, namely the Item parameter. Items that will be excluded from the backup based on the other parameters passed to the Backup-SPConfigurationDatabase cmdlet will be preceded with an asterisk character (*). Items that cannot be backed up will be enclosed in square brackets ([ ]). A backup will not be performed if the ShowTree parameter is present.SwitchParameterSwitchParameter The Backup-SPConfigurationDatabase cmdlet performs a configuration-only backup of the current farm or a configuration-only backup of a separate configuration database which is not attached to the current farm. If you wish to perform a configuration-only backup of the current farm, there is no need to specify the DatabaseServer and DatabaseName parameters. However, using the Backup-SPFarm cmdlet with the ConfigurationOnly parameter is recommended for such a scenario.An example of a configuration backup is an administrator creates a farm configuration template which then can be applied to other SharePoint farms by performing a restore using the Restore-SPFarm cmdlet.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------EXAMPLE 1-------------------- C:\PS>Backup-SPConfigurationDatabase -DatabaseName SharePoint_Config -DatabaseServer SqlServer1 -Directory \\server\share\Backup -ShowTreeThis example displays components that are available for inclusion in a configuration-only backup.-------------------EXAMPLE 2-------------------- C:\PS>Backup-SPConfigurationDatabase -DatabaseName SharePoint_Config -DatabaseServer SqlServer1 -Directory \\server\share\Backup -VerboseThis example performs a configuration-only backup with verbose output.Connect-SPConfigurationDatabaseDisconnect-SPConfigurationDatabaseNew-SPConfigurationDatabaseRemove-SPConfigurationDatabaseRestore-SPFarm Backup-SPConfigurationDatabase Set-SPServiceApplicationSets properties of a service application.SetSPServiceApplicationSet-SPServiceApplicationIdentitySPServiceApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDefaultEndpointSPServiceEndpointPipeBindIisWebServiceApplicationPoolSPIisWebServiceApplicationPoolPipeBindServiceApplicationProxyGroupSPServiceApplicationProxyGroupPipeBindWhatIfSwitchParameterIdentitySpecifies the service application to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubSettingsApp1); or an instance of a valid SPServiceApplication object.SPServiceApplicationPipeBindSPServiceApplicationPipeBind DefaultEndpointSpecifies the address of the default endpoint of the service application.SPServiceEndpointPipeBindSPServiceEndpointPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection IisWebServiceApplicationPoolSpecifies the name or identity of the application pool used by the service application.The IisWebServiceApplicationPool parameter only applies to Web Service applications.SPIisWebServiceApplicationPoolPipeBindSPIisWebServiceApplicationPoolPipeBind ServiceApplicationProxyGroupSpecifies a custom service application proxy group for the Web application to use. The Web application will use the proxies in this proxy group to connect to service applications. If the ServiceApplicationProxyGroup parameter is not specified, the farm's default proxy group is used.SPServiceApplicationProxyGroupPipeBindSPServiceApplicationProxyGroupPipeBind ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Use the Set-SPServiceApplication cmdlet to set various properties of a service application such as the default endpoint, and the application pool used by the service application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ---------------------EXAMPLE---------------- C:\PS>$serviceapp = Get-SPServiceApplication "My Service App" C:\PS>Set-SPServiceApplication $serviceapp -DefaultEndpoint httpsThis example sets the default endpoint of the service application to be https.Get-SPServiceApplicationRevoke-SPServiceApplicationPublish-SPServiceApplicationRemove-SPServiceApplication Set-SPServiceApplication Update-SPFarmEncryptionKeyChanges the value of the farm encryption key and, using the new key, re-encrypts all the data.UpdateSPFarmEncryptionKeyUpdate-SPFarmEncryptionKeyAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterResumeSwitchParameterWhatIfSwitchParameterAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ResumeResumes re-encryption of data with the new farm encryption key if a previous attempt failed.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Update-SPFarmEncryptionKey cmdlet changes the farm encryption key to a new randomly generated value. When the new key is used, all the data is re-encrypted.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Update-SPFarmEncryptionKey -confirmThis example changes the farm encryption key to a new value and re-encrypts all the data. Update-SPFarmEncryptionKey New-SPServiceApplicationPoolCreates a new Web service application pool.NewSPServiceApplicationPoolNew-SPServiceApplicationPoolNameStringAccountSPProcessAccountPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterNameSpecifies the name of the new Web service application pool.StringString AccountSpecifies the credentials that will be the identity of the new application pool.SPProcessAccountPipeBindSPProcessAccountPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The New-SPServiceApplicationPool cmdlet creates a new Web service application pool in Internet Information Services (IIS).For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------------EXAMPLE----------------------- C:\PS>New-SPServiceApplicationPool -Name TestServiceWebApplicationPool -Account testdomain\testuser1This example creates a new Web service application pool. For the Account parameter, the name of a managed account in the farm can be given. Use the Get-SPManagedAccount cmdlet to view the existing managed account in the farm. Also, a process account from the output of the Get-SPProcessAccount cmdlet can be used.Get-SPServiceApplicationPoolSet-SPServiceApplicationPoolRemove-SPServiceApplicationPool New-SPServiceApplicationPool Add-SPShellAdminAdds a user to the SharePoint_Shell_Access role for the specified database.AddSPShellAdminAdd-SPShellAdminUserNameStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterdatabaseSPDatabasePipeBindWhatIfSwitchParameterUserNameSpecifies the name of the user to add to the SharePoint_Shell_Access role in the target database.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter databaseSpecifies the name of the database that includes the SharePoint_Shell_Access role to which you want to add the user. If the database parameter is not specified, the configuration database is used. The farm configuration database is always included, even if you specify another database.SPDatabasePipeBindSPDatabasePipeBind WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Use the Add-SPShellAdmin cmdlet to add a user to the SharePoint_Shell_Access role for a specified database. You must run the Add-SPShellAdmin cmdlet for all databases that you want to grant access to. If no database is specified, the farm configuration database is used. If you do specify a database, the farm content database will be included in addition to the farm configuration database you specify.A user cannot run Windows PowerShell cmdlets in a farm unless you have used this cmdlet to add the user to the SharePoint_Shell_Access role. When a user has been added to the SharePoint_Shell_Access role and is a member of the WSS_Admin_WPG group, then the user can run Windows PowerShell in a multiple-server farm environment. When you run this cmdlet to add a user to the SharePoint_Shell_Access role, the user must have the following security permissions: - Security_Admin role access on the SQL instance and the db_owner role in a database.- Administrative permission to the local computer. The user is added to the WSS_Admin_WPG group in all front-end Web servers when the user is added to the SharePoint_Shell_Access role. If the target database does not have a SharePoint_Shell_Access role, the role is automatically created. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------EXAMPLE 1------------------------- C:\PS>Add-SPShellAdmin -UserName CONTOSO\User1This example adds a new user named User1 to the SharePoint_Shell_Access role in the farm configuration database only, and also ensures the user is added to the WSS_Admin_WPG local group on each server in the farm.-------------------EXAMPLE 2------------------------- C:\PS>Add-SPShellAdmin -UserName CONTOSO\User1 -database WSS_ContentThis example adds a new user named User1 to the SharePoint_Shell_Access role in both the specified content database and the configuration database, and also ensures the user is added to the WSS_Admin_WPG local group on each farm server.Get-SPShellAdminRemove-SPShellAdmin Add-SPShellAdmin Import-SPWebImports a site collection, Web application, list, or library.ImportSPWebImport-SPWebIdentitySPWebPipeBindPathStringActivateSolutionsSwitchParameterAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterHaltOnErrorSwitchParameterHaltOnWarningSwitchParameterIncludeUserCustomActionNone | AllIncludeUserSecuritySwitchParameterNoFileCompressionSwitchParameterNoLogFileSwitchParameterUpdateVersionsAppend | Overwrite | IgnoreWhatIfSwitchParameterIdentitySpecifies the URL or GUID of the Web to import into.The type must be a valid URL, GUID, or object; for example, a valid URL, in the form http://server_name, or a GUID, in the form, 1234-4567-5678a.SPWebPipeBindSPWebPipeBind PathSpecifies the name of the import file.If the NoFileCompression parameter is used, a directory must be specified; otherwise, any file format is valid.StringString ActivateSolutionsSpecifies whether user solutions are activated during import.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceForcefully overwrites the export package if it already exists.The type must be either of the following values-True-FalseThe default value is False .SwitchParameterSwitchParameter HaltOnErrorStops the import process when an error occurs.SwitchParameterSwitchParameter HaltOnWarningStops the import process when a warning occurs.SwitchParameterSwitchParameter IncludeUserCustomActionSpecifies whether User Custom Actions are included during import.None | AllNone | All IncludeUserSecurityPreserves the user security settings.SwitchParameterSwitchParameter NoFileCompressionEither enables or disables file compression in the import package. The import package is stored in the folder specified by the Path parameter or Identity parameter. We recommend that you use this parameter for performance reasons. If compression is enabled, the import process can increase by approximately 30 percent.SwitchParameterSwitchParameter NoLogFileSuppresses the generation of an import log file. If this parameter is absent, the Import-SPWeb cmdlet will generate an export log file in the same location as the export package. The log file uses Unified Logging Service (ULS).We recommend that you use this parameter. However, for performance reasons, you might not want to generate a log file.SwitchParameterSwitchParameter UpdateVersionsIndicates how to resolve situations where a file to be imported to a site already exists in that site. If the UpdateVersions parameter is absent, the import operation by default uses a value of 1.The type must be any one of the following:-Add new versions to the current file-Overwrite the file and all of its versions (delete then insert)-Ignore the file if it exists on the destinationThe default value is Add new versions to the current file.Append | Overwrite | IgnoreAppend | Overwrite | Ignore WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Import-SPWeb cmdlet imports a site collection, Web application, list, or library. The capability to import from a library is a new feature in SharePoint 2010 Products.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ---------------------EXAMPLE---------------------- C:\PS>Import-SPWeb http://site -Path export.cmp -UpdateVersions -Overwrite This example imports the contents of export.cmp into a site at http://site, overwriting the versioned content on the site with the contents of the export.cmp file.Export-SPWebGet-SPWebNew-SPWebRemove-SPWebSet-SPWeb Import-SPWeb Uninstall-SPFeatureUninstalls an installed feature definition.UninstallSPFeatureUninstall-SPFeatureIdentitySPFeatureDefinitionPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterWhatIfSwitchParameterIdentitySpecifies the name of the feature or GUID to uninstall.The type must be the name of the feature folder located in the <drive>:\program files\common files\Microsoft Shared\Web server extensions\14\template\features folder, or must be a GUID, in the form 21d186e1-7036-4092-a825-0eb6709e9281.SPFeatureDefinitionPipeBindSPFeatureDefinitionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceForces the uninstallation of a feature that is already installed.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Uninstall-SPFeature cmdlet removes the specified feature definition from the collection of feature definitions in the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). none------------------EXAMPLE----------------------- C:\PS>Uninstall-SPFeature -path "MyCustomFeature"This example uninstalls the feature at $env:ProgramFiles\Common Files\Microsoft Shared Debug\Web Server Extensions\14\TEMPLATE\FEATURES\MyCustomFeature/feature.xml.Get-SPFeatureEnable-SPFeatureDisable-SPFeatureInstall-SPFeature Uninstall-SPFeature New-SPLogFileCreates a new log file.NewSPLogFileNew-SPLogFileAssignmentCollectionSPAssignmentCollectionAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The New-SPLogFile cmdlet ends the current log file and starts a new log file.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE----------------- C:\PS>New-SPLogFileThis example ends the current log file and starts a new log file.Merge-SPLogFile New-SPLogFile New-SPClaimProviderRegisters a new claim provider in the farm.NewSPClaimProviderNew-SPClaimProviderAssemblyNameStringDescriptionStringDisplayNameStringTypeStringAssignmentCollectionSPAssignmentCollectionDefaultSwitchParameterEnabledSwitchParameterAssemblyNameThe type must be a valid name of an assembly; for example, ClaimAssembly1.Specifies the name of the assembly with the claim provider.StringString DescriptionSpecifies the description of the claim provider.The type must be a valid name of an assembly; for example, ClaimAssembly1.StringString DisplayNameSpecifies the display name of the new claim provider.The type must be a valid name of a claim provider; for example, ClaimProvider1.StringString TypeSpecifies the type of the claim.The type must be a valid name of a claim type; for example MyClaimProvider.Providers.CustomProvider.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection DefaultSpecifies that the claim provider applies to all Web applications and zones.SwitchParameterSwitchParameter EnabledTurns on the claim provider.SwitchParameterSwitchParameter The New-SPClaimProvider cmdlet registers a new claim provider in the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1------------------ C:\PS>New - SPClaimProvider -Name "MyClaimProvider" -Type "MyClaimProvider.Providers.CustomProvider" -AllWebApplicationsThis example registers a claim provider in the farm.------------------EXAMPLE 2------------------ C:\PS>New - SPClaimProvider -Name "MyClaimProvider" -Type "MyClaimProvider.Providers.CustomProvider" -Scope (get-SPWebApplication http://office)This example registers a claim provider scoped to a given Web application.Get-SPClaimProviderSet-SPClaimProviderRemove-SPClaimProvider New-SPClaimProvider Set-SPManagedAccountConfigures the managed account.SetSPManagedAccountSet-SPManagedAccountIdentitySPManagedAccountPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterEmailNotificationInt32PreExpireDaysInt32ScheduleStringWhatIfSwitchParameterSet-SPManagedAccountIdentitySPManagedAccountPipeBindAssignmentCollectionSPAssignmentCollectionAutoGeneratePasswordSwitchParameterConfirmSwitchParameterEmailNotificationInt32PreExpireDaysInt32ScheduleStringWhatIfSwitchParameterSet-SPManagedAccountIdentitySPManagedAccountPipeBindPasswordSecureStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterEmailNotificationInt32PreExpireDaysInt32ScheduleStringWhatIfSwitchParameterSet-SPManagedAccountIdentitySPManagedAccountPipeBindConfirmPasswordSecureStringNewPasswordSecureStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterEmailNotificationInt32PreExpireDaysInt32ScheduleStringSetNewPasswordSwitchParameterWhatIfSwitchParameterSet-SPManagedAccountIdentitySPManagedAccountPipeBindExistingPasswordSecureStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterEmailNotificationInt32PreExpireDaysInt32ScheduleStringUseExistingPasswordSwitchParameterWhatIfSwitchParameterIdentitySpecifies the full name or partial name of the managed accounts to retrieve.The type must be a valid account name, in the form Domain\User, or a GUID, in the form 1234-3456-09876.SPManagedAccountPipeBindSPManagedAccountPipeBind ConfirmPasswordConfirms the new password for this managed account.SecureStringSecureString ExistingPasswordSets the password for this managed account to an existing value that has already been changed in Active Directory Domain Services (AD DS).SecureStringSecureString NewPasswordSets a new password for the managed accountSecureStringSecureString PasswordSets a password for the managed account.SecureStringSecureString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection AutoGeneratePasswordAutomatically generates a new password.The type must be either of the following values:- True- FalseThe default value is False .SwitchParameterSwitchParameter ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter EmailNotificationSpecifies the number of days before password change to begin e-mail notifications.The default value is 5 .Int32Int32 PreExpireDaysSpecifies the number of days before expiration to schedule password change.The default value is 2 .Int32Int32 ScheduleSpecifies the new schedule on which the password change job is to run.StringString SetNewPasswordSets the password to the new value that is passed in, and changes the value in AD DS.The type must be either of the following values:- True- FalseThe default value is False .SwitchParameterSwitchParameter UseExistingPasswordSets the password to a new value passed in where the value is already changed in AD DS.The type must be either of the following values:- True- FalseThe default value is False .SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPManagedAccount cmdlet sets the properties on the given managed account.You can use this cmdlet to change the password expiration and notification settings for the managed account: Use the default parameter set. Additionally, you can use this cmdlet to change the password for the managed account to automatically generated passwords on a set schedule: Use the parameter set that includes the AutoGeneratePassword parameter. You can also use this cmdlet to change the password for the managed account to a new value, known to the administrator: Use the parameter set that includes the SetNewPassword parameter. Finally, you can use this cmdlet to change the password for the managed account to an existing value that has been already been changed in Active Directory Domain Services (AD DS): Use the parameter set that includes the UseExistingPassword parameter.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>$m = Get-SPManagedAccount -Identity "DOMAINx\UserY" C:\PS>Set-SPManagedAccount -Identity $m -AutoGeneratePassword true This example displays an explicit managed account if it exists, and then attempts to update it to use automatically generated passwords.Get-SPManagedAccountNew-SPManagedAccountRemove-SPManagedAccount Set-SPManagedAccount Set-SPDiagnosticsProviderEnables a diagnostics provider and updates its retention policy.SetSPDiagnosticsProviderSet-SPDiagnosticsProviderIdentitySPDiagnosticsProviderPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDaysRetainedInt32EnableSwitchParameterMaxTotalSizeInBytesInt64WhatIfSwitchParameterIdentitySpecifies the diagnostics provider to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a diagnostic provider (for example, DiagnosticProv1); or an instance of a valid SPDiagnosticsProvider object.SPDiagnosticsProviderPipeBindSPDiagnosticsProviderPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DaysRetainedSpecifies the number of days to retain the data collected by a diagnostics provider.The type must be a valid integer value in the range of 1 to 14.Int32Int32 EnableTurns on or off the specified diagnostics provider.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPDiagnosticsProvider cmdlet enables a diagnostics provider and updates its retention policy.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1----------------------- C:\PS>Get-SPDiagnosticsProvider job-diagnostics-event-log-provider | Set-SPDiagnosticsProvider -Enable:$false C:\PS>Get-SPDiagnosticsProvider job-diagnostics-event-log-providerThis example disables the event log diagnostics provider.------------------EXAMPLE 2----------------------- C:\PS>Get-SPDiagnosticsProvider job-diagnostics-event-log-provider | Set-SPDiagnosticsProvider -Enable -DaysRetained 10 C:\PS>Get-SPDiagnosticsProvider job-diagnostics-event-log-providerThis example enables the event log diagnostics provider and changes its retention policy to 10 days.Get-SPDiagnosticsProvider Set-SPDiagnosticsProvider Set-SPSiteAdministrationAllows farm administrators to configure any site collection.SetSPSiteAdministrationSet-SPSiteAdministrationIdentitySPSiteAdministrationPipeBindAdministrationSiteTypeNone | TenantAdministrationAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterLockStateStringMaxSizeInt64OwnerAliasSPUserPipeBindSecondaryOwnerAliasSPUserPipeBindTemplateSPWebTemplatePipeBindWarningSizeInt64WhatIfSwitchParameterSet-SPSiteAdministrationIdentitySPSiteAdministrationPipeBindAdministrationSiteTypeNone | TenantAdministrationAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterSiteSubscriptionSPSiteSubscriptionPipeBindWhatIfSwitchParameterIdentitySpecifies the URL (full or partial) or GUID of the site collection.The type must be a valid URL, in the form http://server_name, or a GUID, in the form 1234-456-987fg.SPSiteAdministrationPipeBindSPSiteAdministrationPipeBind AdministrationSiteTypeSpecifies the site type.Valid values are None or TentantAdministration.None | TenantAdministrationNone | TenantAdministration AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceSuppresses confirmation messages involved in setting the site subscription. This parameter is used in conjunction with the SiteSubscription parameter.SwitchParameterSwitchParameter LockStateSpecifies the lock state for the given site collection.The type must be any of the following values:- Unlock : Sets the site collection to unlock.- Content : No new content can be added. Updates and deletions are allowed. - Readonly : Sets the site collection to read-only.- Noaccess : Sets the site collection to unavailable to all users.StringString MaxSizeSets the maximum storage size of the site collection.The type must be a valid number greater than or equal to 0. .Set to 0 for unlimited.Int64Int64 OwnerAliasSets the owner of this site collection. The type must be a valid user alias.SPUserPipeBindSPUserPipeBind SecondaryOwnerAliasSets the secondary owner of this site collection.The type must be a valid user alias.SPUserPipeBindSPUserPipeBind SiteSubscriptionSpecifies the Site Group to get site collections.SPSiteSubscriptionPipeBindSPSiteSubscriptionPipeBind TemplateSpecifies the Web template for the top-level Web site of this site collection. This can only be given if the template has not already been configured.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef, or an SPWebTemplate object.SPWebTemplatePipeBindSPWebTemplatePipeBind WarningSizeSpecifies the site collection warning size limit. The type must be a valid number greater than or equal to 0. Set to 0 for unlimited.Int64Int64 WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPSiteAdministration cmdlet allows a farm administrator to configure particular settings on a site collection even if the farm administrator is not granted explicit permissions. Any parameter that is not provided is not changed.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Set-SPSiteAdministration http://sitename -OwnerAlias "DOMAIN\NewOwner"This example allows farm administrators to change the ownership of a site collection to which they do not have access.Get-SPSiteAdministrationGet-SPSite Set-SPSiteAdministration Revoke-SPServiceApplicationRevokes a user's access to a service application.RevokeSPServiceApplicationIdentitySpecifies the GUID of the service application to which to revoke access.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh.UserPrincipalSpecifies the identity to revoke access to the service application.The type must be a valid user principal name, in the form DOMAIN\user, or a claim, in the form CA:NTLM:Identity-username:domain\user.TypeSpecifies the type of rights to revoke.The type must be either Admin or Access.AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersWhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersThe Revoke-SPServiceApplication cmdlet revokes the specified user's access to the specified service application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Revoke-SPServiceAppliaion 053c34be-d251-488c-8e94-644eae94da26 -UserPrincipal testdomin\tester1 -Type AdminThis example revokes the administrative access given to the specified user for the selected service application.The service application GUID is unique to every farm. You can run the Get-SPServiceApplication cmdlet to see the GUID of the service applications, and then use the result from the Get-SPServiceApplication cmdlet for other SPServiceApplication cmdlets; for example, Grant-SPServiceApplication or Publish-SPServiceApplication.Get-SPServiceApplicationSet-SPServiceApplicationPublish-SPServiceApplicationGrant-SPServiceApplication Revoke-SPServiceApplication Set-SPSiteSubscriptionConfigSets the configuration properties of a site subscription.SetSPSiteSubscriptionConfigSet-SPSiteSubscriptionConfigIdentitySPSiteSubscriptionPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterFeaturePackSPSiteSubscriptionFeaturePackPipeBindPassThruSwitchParameterUserAccountDirectoryPathStringWhatIfSwitchParameterIdentitySpecifies the site subscription configuration to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; an SPSite (object or URL) of a site collection that is a member of the site subscription; or an instance of a valid SiteSubscription object.SPSiteSubscriptionPipeBindSPSiteSubscriptionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter PassThruSpecifies the output object can be passed through the pipeline.SwitchParameterSwitchParameter FeatureSetSpecifies the feature set that is associated with the site subscription.Specifies a null value to clear the current association.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPFeatureSet object.UserAccountDirectoryPathSets the site user account directory path to a specific organizational unit (OU) that is in the same domain as the site subscription.The type must be a name of a distinguished OU; for example, OU=Contoso1, DC=OSGCorp,DC=local.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPSiteSubscriptionConfig cmdlet sets the configuration properties of a site subscription.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------EXAMPLE--------------- C:\PS>Set-SPSiteSubscription http://contoso.com -FeatureSet 12345678-90ab-cdef-1234-567890abcdefThis example sets the Feature set of the entire site subscription that contains http://contoso.com with a Feature set GUID. Set-SPSiteSubscriptionConfig Get-SPTrustedRootAuthorityReturns a trusted root authority.GetSPTrustedRootAuthorityGet-SPTrustedRootAuthorityIdentitySPTrustedRootAuthorityPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the trusted root authority to get.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted root authority (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object.SPTrustedRootAuthorityPipeBindSPTrustedRootAuthorityPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPTrustedRootAuthority cmdlet returns a trusted root authority. If a certificate file is used, it must have only one X509 certificate without private keys, otherwise an exception is raised.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$rootauthority = Get - SPTrustedRootAuthority -Name "WFEFarm1"This example creates a new trusted root authority, WFEFarm1.New-SPTrustedRootAuthoritySet-SPTrustedRootAuthorityRemove-SPTrustedRootAuthority Get-SPTrustedRootAuthority Remove-SPSiteSubscriptionSettingsRemoves the settings service data for a specified site subscription, or finds and removes orphaned data.RemoveSPSiteSubscriptionSettingsRemove-SPSiteSubscriptionSettingsIdentitySPServiceApplicationPipeBindSiteSubscriptionsGuid[]AssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterRemove-SPSiteSubscriptionSettingsIdentitySPServiceApplicationPipeBindFindAllOrphansSwitchParameterAlternativeSiteSubscriptionsGuid[]AssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterWhatIfSwitchParameterIdentitySpecifies the site subscription settings service application that contains the service data to delete.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPSubscriptionSettingsServiceApplication object.SPServiceApplicationPipeBindSPServiceApplicationPipeBind FindAllOrphansSpecifies that orphaned settings stores in the service application are deleted.SwitchParameterSwitchParameter SiteSubscriptionsSpecifies the site subscriptions with the settings service data to delete.The type must be an array of valid GUIDs.Guid[]Guid[] AlternativeSiteSubscriptionsSpecifies the complete collection or comma-separated list of site subscriptions that should exist in the settings service application. Any data not matching the items in this list will be removed.This parameter is important when the FindAllOrphans parameter is used. The value specified for AlternativeSiteSubscriptions parameter is stating that any site subscriptions not on the local farm will be deleted, unless an alternate list of site subscriptions is given.The type must be an array of valid GUIDs.Guid[]Guid[] AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceAutomatically bypasses the secondary warning provided by the cmdlet prior to the operation.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPSiteSubscriptionSettings cmdlet deletes site subscription stored data for the specified site subscription. If the FindAllOrphans parameter is specified, this cmdlet locates any data in the service application that does not exist in the list of local site subscriptions or the alternate list of subscriptions.The set of site subscriptions can be specified directly, or discovered by comparing data in the service application to the set of existing site subscriptions which finds the data set that corresponds to nonexistent site subscriptions.If this cmdlet is run on a federated service application without specifying the complete list of site subscription IDs for the AlternativeSiteSubscriptions parameter, data loss can result.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------EXAMPLE 1-------------- C:\PS>Remove-SPSiteSubscriptionSettings -FindAllOrphans -WhatifThis example finds all orphans and displays them on the screen. Remove the WhatIf parameter to remove these extra settings.------------EXAMPLE 2-------------- C:\PS>Remove-SPSubscriptionSettingsServiceApplication -FindAllOrphans -AlternativeSiteSubscriptions $SubscriptionListUse this example if the service application is consumed by a remote farm and you want the clean orphaned site subscription settings data (an array of all site subscriptions whose data must remain in the service application is assigned to the $SubscriptionList variable.Import-SPSiteSubscriptionSettingsExport-SPSiteSubscriptionSettings Remove-SPSiteSubscriptionSettings Remove-SPDiagnosticsPerformanceCounterRemoves an instance of a performance counter. RemoveSPDiagnosticsPerformanceCounterRemove-SPDiagnosticsPerformanceCounterCategoryStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterCounterStringDatabaseServerSwitchParameterInstanceStringWebFrontEndSwitchParameterWhatIfSwitchParameterCategorySpecifies the category of performance counters to remove.The type must be a valid name of a category of performance counters; for example, ASP.NET, PhysicalDisk, or Processor.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter CounterSpecifies the type of counter to remove. If this parameter is not specified, this cmdlet removes all performance counters of the specified category.The type must be a valid name of counter type; for example, Requests Queued, Avg. Disk Queue Length, and % Processor Time.StringString DatabaseServerRemoves the specified performance counters that are collected on the database servers in the farm.SwitchParameterSwitchParameter InstanceSpecifies the instance name of the performance counter to remove. If this parameter is not specified, this cmdlet removes all instances of the specified performance counter.The type must be a valid name of a performance counter instance; for example Total_PerfCounter.StringString WebFrontEndRemoves performance counters that are collected on the Web front end computers in the farm.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPDiagnosticsPerformanceCounter cmdlet removes performance counters from the collection of performance counters that are read and recorded in the Usage Database. This cmdlet can also be used to remove entire categories and types of counters from the collection as well. If either the DatabaseServer or WebFrontEnd parameters are not specified, this cmdlet removes the specified performance counters on the Web front end computers in the farm.The Remove-SPDiagnosticsPerformanceCounter cmdlet is only available using Windows PowerShell. There is no User Interface.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1------------------ C:\PS>Remove-SPDiagnosticsPerformanceCounter -category ASP.NETThis example removes all the counters in the category ASP.NET on Web front end computers.------------------EXAMPLE 2------------------ C:\PS>Remove-SPDiagnosticsPerformanceCounter -category ASP.NET -Counter "Requests Queued"This example removes the counters in the category ASP.NET that have requests queued on Web front end computers.------------------EXAMPLE 3------------------ C:\PS>Remove-SPDiagnosticsPerformanceCounter -category Processor -counter "% Processor Time" -instance "_Total" -databaseserverThis example removes the counters of the _Total instance, with the counter % Processor Time in the category Processor on database servers.Add-SPDiagnosticsPerformanceCounterGet-SPDiagnosticsPerformanceCounter Remove-SPDiagnosticsPerformanceCounter Repair-SPManagedAccountDeploymentRepairs the local managed account credential deployment.RepairSPManagedAccountDeploymentRepair-SPManagedAccountDeploymentAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Use the Repair-SPManagedAccountDeployment cmdlet to repair the local deployment of managed account credentials deployment on a server for the rare cases that the managed accounts service credentials are in a broken state. It re-deploys each local service and Web applications credentials and also determines if the passphrase is not correct on the server and repairs provides warnings accordingly. The Repair-SPManagedAccountDeployment cmdlet should not be used as part of the regular credential update process, but should be one of the first troubleshooting steps, specifically if a servers' services are failing to start when other servers' services are working correctly.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ----------EXAMPLE----------- C:\PS>Repair-SPManagedAccountDeploymentThis example repairs the deployment of credentials on all services and Web application associated with managed account (s) on the local server. Repair-SPManagedAccountDeployment New-SPTrustedIdentityTokenIssuerCreates an identity provider in the farm.NewSPTrustedIdentityTokenIssuerNew-SPTrustedIdentityTokenIssuerClaimsMappingsSPClaimMappingPipeBind[]DescriptionStringIdentifierClaimStringNameStringRealmStringSignInUrlStringAssignmentCollectionSPAssignmentCollectionClaimProviderSPClaimProviderPipeBindImportTrustCertificateX509Certificate2UseWReplySwitchParameterClaimsMappingsSpecifies the mapping of the claims from the original token to the SharePoint token.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, Email); or an instance of a valid SPClaimMapping object.SPClaimMappingPipeBind[]SPClaimMappingPipeBind[] DescriptionSpecifies a description for the new identity provider.The type must be a valid string; for example, LiveID STS.StringString IdentifierClaimSpecifies which claim type from the trusted STS will be used for the new identity provider.The type must be a valid claim type from the trusted STS; for example, http://schemas.microsoft.com/2007/05/Claims/Puid.StringString NameSpecifies the name of the new identity provider.The type must be a valid name of an identity provider; for example, LiveIDSTS.StringString RealmSpecifies the realm, or resource partition, associated with this trust.The type must be a name of a valid realm; for example, MD_REALM.StringString SignInUrlSpecifies the sign-in URLs for this trusted STS identity provider.The type must be a valid URL, in the form http://int.live.com/.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ClaimProviderSpecifies the IP STS that can resolve and search claims for claims people picker.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, MyIDprovider1); or an instance of a valid SPIdentityProvider object.SPClaimProviderPipeBindSPClaimProviderPipeBind ImportTrustCertificateSpecifies the X.509 certificate object from trusted authentication provider farm.The type must be a name of a valid X.509 certificate; for example, Certificate1.X509Certificate2X509Certificate2 UseWReplyIncludes a WReply with the token request. WReply is a URL at the relying party to which the requestor is redirected once sign-out processing is complete.SwitchParameterSwitchParameter The New-SPTrustedIdentityTokenIssuer cmdlet creates an identity provider in the farm. This object is created and used only for setting this type of identity provider in a Web application. The specified claim type cannot be NTLM, Classic NTLM, Negotiate, or Classic Negotiate. For ASP.NET Membership provider or Role providers, no objects are persisted. For security token service (STS) identity providers, this cmdlet creates and persists the identity provider object in the SPFarm object.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ----------------------- EXAMPLE--------------------------- C:\PS>New-SPTrustedIdentityTokenIssuer -Name "LiveIDSTS" - Description "LiveID STS" -Certificate (Get-ChildItem"cert:Certificates (LocalComputer)\Personal\Certificates -Name "LiveID Cert") -SignInUrl http://int.contoso.com/ -IdentifierClaim "http://schemas.contoso.com/2007/05/Claims/Puid" C:\PS>Set -SPWebApplication http://contoso.com -IdentityProvider (Get-SPTrustedIdentityTokenIssuer "LiveIDSTS")This example creates a new identity provider in the farm named LiveIDSTS.Get-SPTrustedIdentityTokenIssuerSet-SPTrustedIdentityTokenIssuerRemove-SPTrustedIdentityTokenIssuer New-SPTrustedIdentityTokenIssuer Get-SPClaimProviderReturns a claim provider.GetSPClaimProviderGet-SPClaimProviderIdentitySPClaimProviderPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the claim provider to get.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a claim provider (for example, MyClaimProvider1); or an instance of a valid SPClaimProvider object.SPClaimProviderPipeBindSPClaimProviderPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPClaimProvider cmdlet returns a claim provider.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Get - SPClaimProvider -Identity "MyClaimProvider" | Set-SPClaimProvider -Enabled $falseThis example disables the claim provider MyClaimProvider.New-SPClaimProviderSet-SPClaimProviderRemove-SPClaimProviderGet-SPClaimProviderManager Get-SPClaimProvider Set-SPBusinessDataCatalogThrottleConfigSets the throttling configuration for a Business Data Connectivity Service application.SetSPBusinessDataCatalogThrottleConfigSet-SPBusinessDataCatalogThrottleConfigDefaultInt32IdentityThrottleConfigMaximumInt32AssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterSet-SPBusinessDataCatalogThrottleConfigEnforcedSwitchParameterIdentityThrottleConfigAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterDefaultSpecifies the default setting of the throttle configuration.Int32Int32 EnforcedSpecifies that the throttle configuration setting cannot be overridden.SwitchParameterSwitchParameter IdentitySpecifies the throttle configuration to update.ThrottleConfigThrottleConfig MaximumSpecifies the maximum value of the throttling configuration setting.Int32Int32 AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPBusinessDataCatalogThrottleConfig cmdlet sets the throttling configuration for a Business Data Connectivity Service application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Get-SPBusinessDataCatalogThrottleConfig -Scope Database -ThrottleType Items -ServiceApplicationProxy $contosoServAppProxy | Set-SPBusinessDataCatalogThrottleConfig -Maximum 1000000000 -Default 500000This example sets the database item throttling to values of 1000000000 maximum and 500000 default for the given service application. Get-SPBusinessDataCatalogThrottleConfigRemove-SPBusinessDataCatalogThrottleConfig Set-SPBusinessDataCatalogThrottleConfig Connect-SPConfigurationDatabaseConnects the local server computer to a farm.ConnectSPConfigurationDatabaseConnect-SPConfigurationDatabaseDatabaseNameStringPassphraseSecureStringDatabaseServerStringAssignmentCollectionSPAssignmentCollectionDatabaseCredentialsPSCredentialDatabaseNameSpecifies the name of the configuration database to which to connect the server.The type must be a valid database name; for example, DB1.StringString DatabaseServerSpecifies the server on which to create the configuration database. The default value is the local computer name.StringString PassphraseSpecifies the secure password phrase for connecting the current server to the configuration database.The type must be a valid secure string; for example, MyBDCApp1serverkey.SecureStringSecureString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection DatabaseCredentialsSpecifies the PSCredential object that contains the user name and password to be used for database SQL authentication. If this parameter is not specified, the current user is used.The type must be a valid PSCredential object.PSCredentialPSCredential The Connect-SPConfigurationDatabase cmdlet connects the current server to the specified configuration database.Essentially, this cmdlet connects the server to the farm. If the current computer cannot be connected to a farm, the following error message is displayed: "This machine is already connected to a SharePoint farm. See: Dismount-SPConfigurationDatabase"If the DatabaseName and Passphrase parameters are not specified, Windows authentication is used.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Connect-SPConfigurationDatabase -DatabaseServer "ServerName\InstanceName" -DatabaseName "SharePointConfigurationDatabaseName" -Passphrase (ConvertTo-SecureString "MyP@ssw0rd" -AsPlainText -Force C:\PS>Start-Service SPTimerv4This example joins the local server computer to a farm that is configured to use the database SharePointConfigurationDatabase on a SQL Server instance by using the name ServerName\InstanceName with the passphrase MyP@ssw0rd. Backup-SPConfigurationDatabaseDisconnect-SPConfigurationDatabaseNew-SPConfigurationDatabaseRemove-SPConfigurationDatabaseDismount-SPConfigurationDatabase Connect-SPConfigurationDatabase New-SPAlternateUrlCreates a new public or internal URL for the specified Web application zone or resource.NewSPAlternateUrlNew-SPAlternateUrlUrlStringWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterInternalSwitchParameterWhatIfSwitchParameterZoneDefault | Intranet | Internet | Custom | ExtranetNew-SPAlternateUrlUrlStringResourceNameStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterInternalSwitchParameterWhatIfSwitchParameterZoneDefault | Intranet | Internet | Custom | ExtranetUrlSpecifies the public URL that users access to sign in to the Web application.The type must be a valid URL, in the form http://server_name.StringString WebApplicationSpecifies the name, URL, or GUID of the Web application for which to create the mapping. The type must be a valid name, URL, in the form WebApplication-1212, http://server_name, or GUID, in the form 1234-5678-9876-0987.SPWebApplicationPipeBindSPWebApplicationPipeBind ResourceNameSpecifies the resource name, if the alternate URL is for an external resource. If no value is specified, the value is left blank.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter InternalMakes this alternate URL an internal URL. If this parameter is not provided, the URL is a public URL.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ZoneSpecifies one of the five zones with which the alternate URL is associated.The type must be a valid zone: Default, Intranet, Internet, Extranet, or Custom.Default | Intranet | Internet | Custom | ExtranetDefault | Intranet | Internet | Custom | Extranet The New-SPAlternateUrl cmdlet creates a new public or internal URL for the specified Web application zone or resource. Use the ResourceName parameter if the alternate URL is for an external resource.Each Web application can be associated with a collection of mappings between internal and public URLs. Both internal and public URLs consist of the protocol and domain portion of the full URL; for example, https://www.fabrikam.com. Users type a public URL to get to the SharePoint site, and that URL appears in the links on the pages. Internal URLs are in the URL requests that are sent to the SharePoint site. Many internal URLs can be associated with a single public URL in multiserver farms; for example, when a load balancer routes requests to specific IP addresses to various servers in the load-balancing cluster.Each Web application supports five collections of mappings per URL; the five collections correspond to five zones (default, intranet, extranet, Internet, and custom). When the Web application receives a request for an internal URL in a particular zone, links on the pages returned to the user have the public URL for that zone.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>#create the public URL New-SPAlternateURL https://www.contoso.com -Zone "Internet" C:\PS>#create the internal URL New-SPAlternateURL http://sharepoint.contoso.com -Zone "Internet" -internalThis example translates incoming requests for https://www.contoso.com into http://sharepoint.contoso.com (on the Internet zone).When a reverse proxy is being set up to handle public URL SSL termination, alternate access mappings must be configured to handle the URL translation. Set-SPAlternateUrlGet-SPAlternateURLRemove-SPAlternateUrl New-SPAlternateUrl Export-SPSiteSubscriptionBusinessDataCatalogConfigExports all data from the Business Data Connectivity Metadata Store associated with a partition.ExportSPSiteSubscriptionBusinessDataCatalogConfigExport-SPSiteSubscriptionBusinessDataCatalogConfigPathStringServiceContextSPServiceContextPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterLocalizedNamesIncludedSwitchParameterModelsIncludedSwitchParameterPermissionsIncludedSwitchParameterPropertiesIncludedSwitchParameterProxiesIncludedSwitchParameterWhatIfSwitchParameterPathSpecifies the path and name to use to create the export file.The type must be a valid path in either of the following forms:- C:\folder_name\file.xml- \\server_name\folder_name\file.xml- …\folder_name\file.xmlStringString ServiceContextSpecifies the service context of the data to be exported.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service context (for example, http://ServiceContext1); or an instance of a valid SPServiceContext object.SPServiceContextPipeBindSPServiceContextPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceOverwrites the output file if the file exists.SwitchParameterSwitchParameter LocalizedNamesIncludedSpecifies that names for business data fields in multiple languages are exported.SwitchParameterSwitchParameter ModelsIncludedSpecifies that Business Data Connectivity models are included in the exported file.SwitchParameterSwitchParameter PermissionsIncludedSpecifies that permissions from the Business Data Connectivity Models are exported.SwitchParameterSwitchParameter PropertiesIncludedSpecifies that properties from the Business Data Connectivity Models are exported.SwitchParameterSwitchParameter ProxiesIncludedSpecifies that proxies for Business Data Connectivity Service applications are exported.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The SPSiteSubscriptionBusinessDataCatalogConfig cmdlet exports all data from the Business Data Connectivity Metadata Store associated with a specified partition.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Export-SPSiteSubscriptionBusinessDataCatalogConfig -ServiceContext http://contoso -Path "C:\folder\exportedFile.xml"This example exports the data file named exportedFile.xml.Clear-SPSiteSubscriptionBusinessDataCatalogConfigImport-SPSiteSubscriptionBusinessDataCatalogConfig Export-SPSiteSubscriptionBusinessDataCatalogConfig Set-SPSubscriptionSettingsServiceApplicationSets properties of a subscription settings service application.SetSPSubscriptionSettingsServiceApplicationSet-SPSubscriptionSettingsServiceApplicationIdentitySPServiceApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDatabaseCredentialsPSCredentialDatabaseNameStringDatabaseServerStringFailoverDatabaseServerStringWhatIfSwitchParameterIdentitySpecifies the settings service application to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPSubscriptionSettingsServiceApplication object.SPServiceApplicationPipeBindSPServiceApplicationPipeBind ApplicationPoolSpecifies the Internet Information Services (IIS) application pool to use for the new subscription settings application.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object.AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DatabaseCredentialsSpecifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication .The type must be a valid PSCredential object.PSCredentialPSCredential DatabaseNameSpecifies the name of the subscription settings database.The type must be a valid name of a SQL Server database; for example, SubscriptionSettingsAppDB1.StringString DatabaseServerSpecifies the name of the host SQL Server instance for the database specified in DatabaseName parameter.The type must be a valid SQL Server instance name; for example, SQLServerHost1.StringString FailoverDatabaseServerSpecifies the name of the host SQL Server instance for the failover database server.The type must be a valid SQL Server instance name; for example, SQLServerHost1.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Use the Set-SPSubscriptionSettingsServiceApplication cmdlet to set properties on a subscription settings service application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ---------------------EXAMPLE-------------------------- C:\PS>$applicationPool = GetSPIisWebServiceApplicationPool SettingsApplicationPool C:\PS>Get-SPServiceApplication -Name SettingsServiceApp | Set-SPSubscriptionSettingsServiceApplication -ApplicationPool $applicationPoolThis example changes the application pool of the subscription settings service application. This command assumes that a subscription settings service application named SettingsServiceApp exists and that an application pool named SettingsApplicationPool existsNew-SPSubscriptionSettingsServiceApplicationNew-SPSubscriptionSettingsServiceApplicationProxy Set-SPSubscriptionSettingsServiceApplication Set-SPTopologyServiceApplicationSets the properties on the topology service application of the local farm.SetSPTopologyServiceApplicationSet-SPTopologyServiceApplicationIdentitySPTopologyWebServiceApplicationPipeBindLoadBalancerUrlStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the GUID of the application to be set.The type must be a valid GUID, in the form 1234-456-854gh.SPTopologyWebServiceApplicationPipeBindSPTopologyWebServiceApplicationPipeBind LoadBalancerUrlSpecifies an external physical load balancer.The type must be a valid URL, in the form http://search.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPTopologyServiceApplication cmdlet sets the advanced properties of an application when the Identity parameter is used.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Set-SPTopologyServiceApplication 67877d63-bff4-4521-867a-ef4979ba07ce -LoadBalancedURL "https://testurl"This example sets the load-balanced URL for the topology service application.The topology service application GUID is unique to every farm. You can run the Get-SPTopologyServiceApplication cmdlet to retrieve the GUID.Get-SPTopologyServiceApplicationSet-SPTopologyServiceApplicationProxy Set-SPTopologyServiceApplication Get-SPTopologyServiceApplicationProxyRetrieves the topology service application proxy.GetSPTopologyServiceApplicationProxyGet-SPTopologyServiceApplicationProxyIdentitySPTopologyWebServiceProxyPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the GUID of the application proxy.The type must be a valid GUID, in the form 1234-4567-098jhj.SPTopologyWebServiceProxyPipeBindSPTopologyWebServiceProxyPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPTopologyServiceApplicationProxy cmdlet retrieves the local topology service application proxy.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE----------------- C:\PS>Get-SPTopologyServiceApplicationProxyThis example displays the topology service application proxy in the farm. Set-SPTopologyServiceApplicationProxySet-SPTopologyServiceApplication Get-SPTopologyServiceApplicationProxy Install-SPHelpCollectionInstalls the provided Help site collection files in the current farm.InstallSPHelpCollectionInstall-SPHelpCollectionLiteralPathStringAssignmentCollectionSPAssignmentCollectionInstall-SPHelpCollectionAllSwitchParameterAssignmentCollectionSPAssignmentCollectionAllIf the LiteralPath parameter is not specified, specifies that all Help Collection CABs under %Program Files%\Common Files\Microsoft Shared\Web Server Extensions\14\HCCab\<LCID> in the Help site collection are installed, and existing Help collections are overwritten.SwitchParameterSwitchParameter LiteralPathSpecifies the exact path to a specific custom Help file in the Help site collection cab file. The type must be a valid path in either of the following forms:- C:\folder_name- \\server_name\folder_nameStringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Install-SPHelpCollection cmdlet installs the Help site collection files for SharePoint 2010 Products in the current farm. Use the LiteralPath parameter to install specific custom Help collection files. If the LiteralPath parameter is not specified, all available Help in the Help site collection is installed and existing Help collection files are overwritten.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Install-SPHelpCollection -LiteralPath 'C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\HCCab\1033\OSSAdmin.cab' This example installs the specified help collection in the current farm.Get-SPHelpCollectionUninstall-SPHelpCollection Install-SPHelpCollection Grant-SPObjectSecurityAdds a new security principal to an SPObjectSecurity object.GrantSPObjectSecurityGrant-SPObjectSecurityIdentitySPObjectSecurityPrincipalSPClaimRightsString[]AssignmentCollectionSPAssignmentCollectionReplaceSwitchParameterIdentity Specifies the SPObjectSecurity object to which the new security principal is added. You can use the Get-SPServiceApplicationSecurity cmdlet to get a SPObjectSecurity object . SPObjectSecuritySPObjectSecurity PrincipalSpecifies the principal to whom the rights apply.The type must a valid name a principal; for example, Full Control.SPClaimSPClaim RightsSpecifies the rights granted to the principal.The type must a valid array of strings that represents the rights granted to the principal.String[]String[] AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ReplaceReplaces the existing rights on the SPObjectSecurity object with the new rights specified. If this parameter is not specified, the new rights are added to the existing rights.SwitchParameterSwitchParameter The Grant-SPObjectSecurity cmdlet adds a new security principal, such as a user, to a SPObjectSecurity object. An SPObjectSecurity object is a common object that is used to represent the security access control list (ACL) of SharePoint administrative objects, in particular, service applications.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$security = Get-SPServiceApplicationSecurity $serviceApp -Admin Grant-SPObjectSecurity $security $principal "Full Control" Set-SPServiceApplicationSecurity $serviceApp -Admin $securityThis example retrieves the SPObjectSecurity object corresponding to the administrator ACL on a service application, and adds a new user principal to that ACL. The new user is an administrator for the service application $serviceApp.Revoke-SPObjectSecurityGet-SPServiceApplicationSecurity Grant-SPObjectSecurity Set-SPTrustedRootAuthorityCreates a new trusted root authority.SetSPTrustedRootAuthoritySet-SPTrustedRootAuthorityIdentitySPTrustedRootAuthorityPipeBindAssignmentCollectionSPAssignmentCollectionCertificateX509Certificate2IdentitySpecifies the trusted root authority to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted root authority (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object.SPTrustedRootAuthorityPipeBindSPTrustedRootAuthorityPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection CertificateSpecifies the X.509 certificate of the trusted root authority.The type must be a name of a valid X.509 certificate; for example, Certificate1.X509Certificate2X509Certificate2 The Set-SPTrustedRootAuthority cmdlet creates a new trusted root authority. If a certificate file is used, the certificate must be an X509 certificate with private keys, otherwise an exception is raised.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx Get - SPTrustedRootAuthority -Name "WFEFarm1" | Set- SPTrustedRootAuthority -Certificate $certThis example updates the certificate of the trusted root authority WFEFarm1.Remove-SPTrustedRootAuthorityNew-SPTrustedRootAuthorityGet-SPTrustedRootAuthority Set-SPTrustedRootAuthority Get-SPProcessAccountReturns a system account or a managed account.GetSPProcessAccountGet-SPProcessAccountAssignmentCollectionSPAssignmentCollectionNetworkServiceSwitchParameterGet-SPProcessAccountAssignmentCollectionSPAssignmentCollectionLocalSystemSwitchParameterGet-SPProcessAccountAssignmentCollectionSPAssignmentCollectionLocalServiceSwitchParameterAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersLocalServiceReturns the LocalService account.SwitchParameterSwitchParameter LocalSystemReturns the LocalSystem account.SwitchParameterSwitchParameter NetworkServiceReturns the NetworkService account.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersThe Get-SPProcessAccount cmdlet returns a system account or a managed account and creates the SPProcessAccountPipeBind object. All operations that can accept an account can accept the SPProcessAccountPipeBind in place of the SPManagedAccountPipeBind.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1----------------------- C:\PS>Get-SPProcessAccount -NetworkServiceThis example creates the SPProcessAccountPipeBind type by using the NetworkService account.------------------EXAMPLE 2----------------------- C:\PS>Get-SPProcessAccount -NetworkService | New-SPIisWebServiceApplicationPool -Account $_This example creates an SPIisWebServiceApplicationPool account by using the NetworkService account returned by the Get-SPProcessAccount cmdlet. Get-SPProcessAccount Set-SPUsageApplicationSets properties of a usage application.SetSPUsageApplicationSet-SPUsageApplicationIdentitySPUsageApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDatabaseNameStringDatabasePasswordSecureStringDatabaseServerStringDatabaseUsernameStringEnableLoggingSwitchParameterFailoverDatabaseServerStringUsageServiceSPUsageServicePipeBindWhatIfSwitchParameterIdentitySpecifies the usage application to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a usage application (for example; UsageApp1); or an instance of a valid SPServiceApplication object.SPUsageApplicationPipeBindSPUsageApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DatabaseNameSpecifies the name of the logging database.The type must be a valid name of a SQL Server database; for example, UsageLogDB1.If the logging database does not exist, a logging database will be automatically created.StringString DatabasePasswordSpecifies the password for the user specified in DatabaseUserName . Use this parameter only if SQL Server Authentication is used to access the logging database.The type must be a valid password.SecureStringSecureString DatabaseServerSpecifies the name of the host server for the database specified in DatabaseName .The type must be a valid SQL Server host name; for example, SQLServerHost1.StringString DatabaseUsernameSpecifies the user name to use for connecting to the logging database. Use this parameter only if SQL Server Authentication is used to access the logging database.The type must be a valid user name; for example, UserName1.StringString EnableLoggingSpecifies that this usage application collects usage data.SwitchParameterSwitchParameter FailoverDatabaseServerStringString UsageServiceSpecifies the SPUsageService object that is the parent of the usage application.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object.SPUsageServicePipeBindSPUsageServicePipeBind WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPUsageApplication cmdlet sets properties of a usage application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------EXAMPLE---------------------- C:\PS>Set-SPUsageApplication -Identity "Usage and Health data collection" -DatabaseServer "Server Name" -DatabaseName "New Logging DBThis example changes the database server and database name used by the usage logging service to store logging data.Get-SPUsageApplicationNew-SPUsageApplicationRemove-SPUsageApplication Set-SPUsageApplication Get-SPSecurityTokenServiceConfigReturns the security token service (STS) for the farm.GetSPSecurityTokenServiceConfigGet-SPSecurityTokenServiceConfigAssignmentCollectionSPAssignmentCollectionAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPSecurityTokenServiceConfig cmdlet reads the security token service (STS) for the farm. An STS authenticates security tokens in incoming SOAP messages.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Get - SPSecurityTokenServiceConfig | Set -SPSecurityTokenServiceConfig -ServiceTokenLifetime 1000This example gets the security token service (STS) for the farm and sets the expiration for the service token cache to 1000 minutes.Set-SPSecurityTokenServiceConfig Get-SPSecurityTokenServiceConfig Revoke-SPObjectSecurityRemoves a security principal from a SPObjectSecurity object.RevokeSPObjectSecurityRevoke-SPObjectSecurityIdentitySPObjectSecurityPrincipalSPClaimRightsString[]AssignmentCollectionSPAssignmentCollectionRevoke-SPObjectSecurityIdentitySPObjectSecurityAllSwitchParameterAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the SPObjectSecurity object from which the security principal is removed. You can use the Get-SPServiceApplicationSecurity cmdlet to get a SPObjectSecurity object .SPObjectSecuritySPObjectSecurity PrincipalSpecifies the principal for whom the rights are removed.The type must a valid name a principal; for example, Full Control.SPClaimSPClaim RightsSpecifies the rights of the principal to revoke.The type must a valid array of strings that represents the rights of the principal to revoke.String[]String[] AllSpecifies that all security principals are removed from the specified SPObjectSecurity object.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Revoke-SPObjectSecurity cmdlet to remove a security principal, such as a user, from a SPObjectSecurity object. An SPObjectSecurity object is a common object that is used to represent the security access control list (ACL) of SharePoint administrative objects, in particular service applications.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$security = Get-SPServiceApplicationSecurity $serviceApp -Admin Revoke-SPObjectSecurity $security "domain\user" Set-SPServiceApplicationSecurity $serviceApp -Admin $securityThis example retrieves the SPObjectSecurity object corresponding to the administrator ACL on a service application, and removes a user from that ACL. The removed an administrator for the service application $serviceApp.Grant-SPObjectSecurityGet-SPServiceApplicationSecurity Revoke-SPObjectSecurity Enable-SPWebApplicationHttpThrottlingTurns on network throttling for a Web application.EnableSPWebApplicationHttpThrottlingEnable-SPWebApplicationHttpThrottlingIdentitySPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentityTurns on network throttling on the specified SharePoint Web application.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Enable-SPWebApplicationHttpThrottling cmdlet turns on network throttling for a Web application. This operation prompts you to confirm that you want to turn on network throttling.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Enable-SPWebApplicationHttpThrottling http://sitenameThis example enables network throttling on the http://sitename Web application.Get-SPWebApplicationHttpThrottlingMonitorDisable-SPWebApplicationHttpThrottlingSet-SPWebApplicationHttpThrottlingMonitor Enable-SPWebApplicationHttpThrottling Get-SPServiceApplicationSecurityReturns the SPObjectSecurity object for a service application.GetSPServiceApplicationSecurityGet-SPServiceApplicationSecurityIdentitySPServiceApplicationPipeBindAdminSwitchParameterAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the service application to get.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application (for example, SearchServiceApp1); or an instance of a valid SPServiceApplication object.SPServiceApplicationPipeBindSPServiceApplicationPipeBind AdminReturns the access control list (ACL) that contains the administrators list of the service application.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPServiceApplicationSecurity cmdlet returns a security object for the specified service application. Use this cmdlet with the Grant-SPObjectSecurity and Set-SPServiceApplicationSecurity cmdlets to manage security for a service application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$security = Get-SPServiceApplicationSecurity $serviceApp -Admin Grant-SPObjectSecurity $security $principal "Full Control" Set-SPServiceApplicationSecurity $serviceApp -Admin $securityThis example retrieves the SPObjectSecurity object corresponding to the administrator ACL on a service application, and adds a new user principal to that ACL. The new user is an administrator for the service application $serviceApp.Set-SPServiceApplicationSecurityGrant-SPObjectSecurityRevoke-SPObjectSecurity Get-SPServiceApplicationSecurity Disable-SPBusinessDataCatalogEntityDeactivates an External Content type in the Business Data Connectivity Metadata Store.DisableSPBusinessDataCatalogEntityDisable-SPBusinessDataCatalogEntityIdentityEntityAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the External Content type in the Business Data Connectivity Metadata Store to deactivate.EntityEntity AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Disable-SPBusinessDataCatalogEntity cmdlet deactivates an External Content type in the Business Data Connectivity Metadata Store.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$entityToDisable = Get-SPBusinessDataCatalogMetadataObject -Namespace "Contoso" -Name "Customer" -BdcObjectType "Entity" -ServiceContext http://contosoThis example deactivates the External Content type of the name Customer in the Contoso. Note that the terms External Content type and Entity refer to the same object type, and the term Disable refers to the same action as the Business Data Connectivity term Deactivate. Enable-SPBusinessDataCatalogEntity Disable-SPBusinessDataCatalogEntity Get-SPDiagnosticsProviderReturns a diagnostics provider.GetSPDiagnosticsProviderGet-SPDiagnosticsProviderIdentitySPDiagnosticsProviderPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the diagnostics provider to get.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a diagnostic provider (for example, DiagnosticsProv1); or an instance of a valid SPDiagnosticsProvider object.SPDiagnosticsProviderPipeBindSPDiagnosticsProviderPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPDiagnosticsProvider cmdlet reads the specified diagnostics provider. If the Identity parameter is not specified, this cmdlet returns the collection diagnostics providers in the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Get-SPDiagnosticsProviderThis example returns all the diagnostics providers in the farm.------------------EXAMPLE 2----------------------- C:\PS>Get-SPDiagnosticsProvider job-diagnostics-event-log-providerThis example returns the event log diagnostics provider.Set-SPDiagnosticsProvider Get-SPDiagnosticsProvider Remove-SPUsageApplicationRemoves a usage application from the local farm.RemoveSPUsageApplicationRemove-SPUsageApplicationIdentitySPUsageApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterRemoveDataSwitchParameterUsageServiceSPUsageServicePipeBindWhatIfSwitchParameterIdentitySpecifies the usage application to delete.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage application (for example, UsageApplication1); or an instance of a valid SPUsageApplication object.SPUsageApplicationPipeBindSPUsageApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter RemoveDataSpecifies that the logging database is also removed.SwitchParameterSwitchParameter UsageServiceReserved for future use.SPUsageServicePipeBindSPUsageServicePipeBind WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPUsageApplication cmdlet deletes a usage application from the local farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------EXAMPLE-------------------- C:\PS>Remove-SPUsageApplication -Identity "Usage and Health data collection" -RemoveDataThis example removes the existing usage application and the associated logging DB.Get-SPUsageApplicationSet-SPUsageApplicationNew-SPUsageApplication Remove-SPUsageApplication Revoke-SPBusinessDataCatalogMetadataObjectRevokes a right to a principal in the specified Business Data Connectivity Metadata Store metadata object.RevokeSPBusinessDataCatalogMetadataObjectRevoke-SPBusinessDataCatalogMetadataObjectIdentityMetadataObjectPrincipalSPClaimRightExecute | Edit | SetPermissions | SelectableInClientsAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterSettingIdStringWhatIfSwitchParameterIdentitySpecifies the Business Data Connectivity Metadata Store metadata object that contains the principal.MetadataObjectMetadataObject PrincipalSpecifies the principal to whom the rights apply.The type must be a claim.SPClaimSPClaim RightSpecifies the right to revoke the principal.The type must be one of the following valid PSBdcRight object types: All, Execute, Edit, SetPermissions, or SelectableInClients.Execute | Edit | SetPermissions | SelectableInClientsExecute | Edit | SetPermissions | SelectableInClients AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter SettingIdSpecifies the custom environment settings model slice for which to revoke the right.The type must be a valid string that identifies a model slice; for example, ModelSlice1.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Revoke-SPBusinessDataCatalogMetadataObject cmdlet revokes a right granted to a principal user in the specified Business Data Connectivity Metadata Store metadata object.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$claimJohn = New-SPClaimObject -User "CONTOSO\johndoe" -Type windowssamaccountname $MetadataObject = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "LobSystem" -ServiceContext http://contoso -Name "ContosoDatabase" Revoke-SPBusinessDataCatalogMetadataObject -Identity $MetadataObject -Principal $claimJohn -Right "Execute"This example removes the execute right from the External System with the name ContosoDatabase for the user with the identity of johndoe on the domain CONTOSO.Set-SPBusinessDataCatalogMetadataObjectGet-SPBusinessDataCatalogMetadataObjectGrant-SPBusinessDataCatalogMetadataObject Revoke-SPBusinessDataCatalogMetadataObject New-SPClaimTypeMappingCreates a claim mapping rule for a security token service (STS) identity provider.NewSPClaimTypeMappingNew-SPClaimTypeMappingIncomingClaimTypeStringIncomingClaimTypeDisplayNameStringLocalClaimTypeStringAssignmentCollectionSPAssignmentCollectionSameAsIncomingSwitchParameterIncomingClaimTypeSpecifies the URI of the incoming claim type.The type must be a valid URI, in the form http://schemas.microsoft.com/email.StringString IncomingClaimTypeDisplayNameSpecifies the display name of the incoming claim type.The type must be a valid name of an incoming claim type; for example, Email.StringString LocalClaimTypeSpecifies the URI of the local claim type. If the SameAsIncoming parameter is False, this is a required parameter.The type must be a valid URI, in the form http://schemas.microsoft.com/email.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection SameAsIncomingSpecifies that the claim type specified in the IncomingClaimType parameter is used for the LocalClaimType parameter.SwitchParameterSwitchParameter The New-SPClaimTypeMapping cmdlet creates a claim mapping rule for a security token service (STS) identity provider.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------------EXAMPLE 1---------------------------- C:\PS>$map1 = New-SPClaimTypeMapping -IncomingClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" -IncomingClaimTypeDisplayName "EmailAddress" -SameAsIncoming C:\PS>$map2 = New-SPClaimTypeMapping -IncomingClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier" -IncomingClaimTypeDisplayName "PUID" -LocalClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/thumbprint" C:\PS>New-SPTrustedIdentityTokenIssuer -Name "LiveIDSTS" -Description "LiveID Provider" -Realm "urn:domain.company.com" -ImportTrustCertificate $cert -ClaimsMappings $map1[,$map2..] -SignInUrl "https://login.live.com/login.srf" -IdentifierClaim $map2.InputClaimTypeThis example creates a claim map from an incoming token to a SharePoint token.Add-SPClaimTypeMappingRemove-SPClaimTypeMapping New-SPClaimTypeMapping Update-SPInfoPathUserFileUrlUpdates InfoPath form templates (.xsn files) and universal data connections (.udcx files).UpdateSPInfoPathUserFileUrlUpdate-SPInfoPathUserFileUrlWebApplicationSPWebApplicationPipeBindFindUriReplaceUriAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterScanSwitchParameterWhatIfSwitchParameterUpdate-SPInfoPathUserFileUrlContentDatabaseSPContentDatabasePipeBindFindUriReplaceUriAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterScanSwitchParameterWhatIfSwitchParameterUpdate-SPInfoPathUserFileUrlSiteSPSitePipeBindFindUriReplaceUriAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterScanSwitchParameterWhatIfSwitchParameterContentDatabaseSpecifies the parent content database where the update will start.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a content database (for example, SPContent DB1); or an instance of a valid SPContentDatabase object.SPContentDatabasePipeBindSPContentDatabasePipeBind SiteSpecifies the parent site collection where the update will start.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://sites/example; or an instance of a valid SPSite object.SPSitePipeBindSPSitePipeBind WebApplicationSpecifies the parent SharePoint Web application where the update will start.The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication objectSPWebApplicationPipeBindSPWebApplicationPipeBind FindSpecifies the URL to find.The type must be a valid URL, in the form http://previous_server_name.UriUri ReplaceSpecifies the URL to find.The type must be a valid URL, in the form http://server_name.UriUri AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ScanRun the tool and log the actions that can be taken. No content is changed as a result of the scan.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Update-SPInfoPathAdminFileUrl cmdlet updates data connections in InfoPath form templates (.xsn files) and universal data connections (.udcx files). This allows for InfoPath data connections that reference the current farm to be updated when content is migrated to a different farm URL.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Get-SPWebApplication http://contoso2010 | Update-SPInfoPathUserFileUrl -find "http://contoso2007" -replace "http://contoso2010"This example updates data connections in InfoPath form templates and universal data connection files, for all content under the Web application http://contoso2010. Data connections that reference http://contoso2007 are updated to reference http://contoso2010. Update-SPInfoPathUserFileUrl Install-SPWebTemplateInstalls the given site template.InstallSPWebTemplateInstall-SPWebTemplatePathStringNameStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDescriptionStringWhatIfSwitchParameterPathSpecifies the path to the site template package.The type must be a valid path; for example, <example of path>.StringString NameSpecifies the name of the template.The type must be a valid name; for example, MyTemplate.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DescriptionSpecifies the template description.The type must be a valid description; for example, Joe's Template.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Install-SPWebTemplate cmdlet installs the given site template using the name provided (title) as the unique ID.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE----------------- C:\PS>Install-SPSiteTemplate -path "mytemplate.cab" -name "My Template" -description "TestFarm"This example installs the mytemplate.cab file as My Template with the description "TestFarm" on the farm.Get-SPWebTemplateSet-SPWebTemplateUninstall-SPWebTemplate Install-SPWebTemplate Install-SPUserSolutionActivates a sandboxed solution in a site collection.InstallSPUserSolutionInstall-SPUserSolutionIdentitySPUserSolutionPipeBindSiteSPSitePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the sandboxed solution to activate.The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object.SPUserSolutionPipeBindSPUserSolutionPipeBind SiteActivates the sandboxed solution for the specified site collection.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object.SPSitePipeBindSPSitePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Install-SPUserSolution cmdlet activates a sandboxed solution in a site collection. A user solution is a sandboxed solution.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185).-------------------EXAMPLE--------------------- C:\PS>Install-SPUserSolution -Identity contoso_solution.wsp -Site http://sitenameThis example activates the sandboxed solution contoso_solution.wsp in the site http://sitename.Update-SPUserSolutionUninstall-SPUserSolutionRemove-SPUserSolutionGet-SPUserSolutionAdd-SPUserSolution Install-SPUserSolution Remove-SPTrustedIdentityTokenIssuerDeletes a security token service (STS) identity provider from the farm.RemoveSPTrustedIdentityTokenIssuerRemove-SPTrustedIdentityTokenIssuerIdentitySPTrustedIdentityTokenIssuerPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the identity provider to remove.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, LiveID STS); or an instance of a valid SPIdentityProvider object.SPTrustedIdentityTokenIssuerPipeBindSPTrustedIdentityTokenIssuerPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPTrustedIdentityTokenIssuer cmdlet deletes a security token service (STS) identity provider from the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -----------------------------EXAMPLE---------------------------- C:\PS>Remove-SPTrustedIdentityTokenIssuer "LiveIDSTS"This example removes an identity provider named LiveIDSTS from the farm.Get-SPTrustedIdentityTokenIssuerSet-SPTrustedIdentityTokenIssuerNew-SPTrustedIdentityTokenIssuer Remove-SPTrustedIdentityTokenIssuer Get-SPBrowserCustomerExperienceImprovementProgramReturns the current opt-in state for the browser Customer Experience Improvement Program.GetSPBrowserCustomerExperienceImprovementProgramGet-SPBrowserCustomerExperienceImprovementProgramFarmSwitchParameterAssignmentCollectionSPAssignmentCollectionGet-SPBrowserCustomerExperienceImprovementProgramWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionGet-SPBrowserCustomerExperienceImprovementProgramSiteSubscriptionSPSiteSubscriptionPipeBindAssignmentCollectionSPAssignmentCollectionFarmSpecifies that the opt-in state for the farm is returned by this cmdlet.SwitchParameterSwitchParameter SiteSubscriptionReturns the opt-in state for the specified site subscription.The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscription1); or an instance of a valid SiteSubscription object.SPSiteSubscriptionPipeBindSPSiteSubscriptionPipeBind WebApplicationReturns the opt-in state for the specified SharePoint Web application.The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPBrowserCustomerExperienceImprovementProgram cmdlet reads the current opt-in state for the browser Customer Experience Improvement Program.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1----------------------- C:\PS>Get-SPBrowserCustomerExperienceImprovementProgram -WebApplication http://WebAppexample1This example returns the current Customer Experience Improvement Program opt-in state for the Web application, WebAppexample1.------------------EXAMPLE 2----------------------- C:\PS>Get-SPSiteSubscription http://SiteSubscription1 | Get- SPBrowserCustomerExperienceImprovementProgramThe following example returns the Customer Experience Improvement Program opt-in state for the site subscription, SiteSubscription1.Set-SPBrowserCustomerExperienceImprovementProgram Get-SPBrowserCustomerExperienceImprovementProgram New-SPServiceApplicationProxyGroupCreates a new service application proxy group.NewSPServiceApplicationProxyGroupNew-SPServiceApplicationProxyGroupNameStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterNameSpecifies the name of the new service application proxy group.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The New-SPServiceApplicationProxyGroup cmdlet creates a new service application proxy group specified by the Name parameter.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>New-SPServiceApplicationProxyGroup -Name RemoteProxyGroupThis example creates a new service application proxy with the name RemoteProxyGroup.Get-SPServiceApplicationProxyGroupAdd-SPServiceApplicationProxyGroupMemberRemove-SPServiceApplicationProxyGroup New-SPServiceApplicationProxyGroup Start-SPAssignmentInitiates a new assignment store.StartSPAssignmentStart-SPAssignmentAssignmentCollectionSPAssignmentCollectionGlobalSwitchParameterAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection GlobalIf you use this parameter, all objects are assigned to the lifetime of the script and are disposed of when the Stop-SPAssignment cmdlet is called.If you do not use this parameter, you must assign the output of this cmdlet to a variable and then dispose of objects by using the Identity parameter of the Stop-SPAssignment cmdlet.SwitchParameterSwitchParameter The Start-SPAssignment cmdlet properly disposes of objects used with variable assignments.Large amounts of memory are often required when SPWeb, SPSite, or SPSiteAdminsitration objects are used. So the use of these objects, or lists of these objects, in Windows PowerShell scripts requires proper memory management. By default, all Get commands dispose of these objects immediately after the pipeline finishes, but by using SPAssignment, you can assign the list of objects to a variable and dispose of the objects after they are no longer needed. You can also ensure that the objects remain as long as you need them, even throughout multiple iterations of commands.There are three levels of assignment:-- No assignment -- The object is not assigned to a variable and is disposed of after each iteration of the command.-- Simple assignment -- All objects are assigned to the global assignment store. This is done by using the Global parameter. When using this level, all objects are assigned to a global store and are disposed of when the Stop-SPAssignment cmdlet is called. -- Advanced assignment -- Objects are assigned to named stores for disposal. You can dispose of objects by using the Identity parameter with the Stop-SPAssignment cmdlet. Regardless of the assignment level used, all objects are disposed of when the PowerShell runspace is closed.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185).SPAssignmentCollection------------------EXAMPLE 1----------------------- C:\PS>Start-SPAssignment -global C:\PS>$w = Get-SPWeb http://MyWeb C:\PS>$w | Set-SPWeb -title "Accounting" C:\PS>Stop-SPAssignment -globalThis example uses simple assignment. While easier to use simple assignment, running commands that iterate through multiple SPSite or SPWeb objects while simple assignment is enabled is not recommended. Ensure that Stop-SPAssignment is run before attempting any interations of multiple objects.------------------EXAMPLE 2----------------------- C:\PS>$gc = Start-SPAssignment C:\PS>$web = $gc | Get-SPWeb http://MyWeb C:\PS>$web | Set-SPWeb -title "Accounting" C:\PS>Stop-SPAssignment -Identity $gcThis example sets the title of the SPWeb object in multiple lines and controls the rate of disposal. This is an advanced example. Only developers are advised to use it.Stop-SPAssignment Start-SPAssignment Get-SPSiteSubscriptionFeaturePackRetrieves available SharePoint Feature sets or the Feature set assigned to a given site subscription.GetSPSiteSubscriptionFeaturePackGet-SPSiteSubscriptionFeaturePackIdentitySPSiteSubscriptionFeaturePackPipeBindAssignmentCollectionSPAssignmentCollectionGet-SPSiteSubscriptionFeaturePackAssignmentCollectionSPAssignmentCollectionSiteSubscriptionSPSiteSubscriptionPipeBindIdentitySpecifies a valid name or GUID of the Feature set. SPSiteSubscriptionFeaturePackPipeBindSPSiteSubscriptionFeaturePackPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection SiteSubscriptionIf provided, ensures that the returned Feature set is the Feature set that is currently assigned to the given site subscription .SPSiteSubscriptionPipeBindSPSiteSubscriptionPipeBind The Get-SPSiteSubscriptionFeaturePack cmdlet retrieves available SharePoint Feature sets or the Feature set assigned to a given site subscription.Be careful when you assign Feature sets to variables because changes to the Feature set are not reflected until the variable is refreshed.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1------------------ C:\PS>Get- SPSiteSubscriptionFeaturePackThis example returns all defined Feature sets in the local farm.------------------EXAMPLE 2------------------ C:\PS>Get-SPSiteSubscriptionFeaturePack -SiteSubscription http://contoso.com | ForEach{ $_.FeatureDefinitions }This example returns the list (name, ID, and scope) of all Features allowed in the Feature set that is currently assigned to the site subscription of http://contoso.com.New-SPSiteSubscriptionFeaturePackRemove-SPSiteSubscriptionFeaturePackAdd-SPSiteSubscriptionFeaturePackMember Get-SPSiteSubscriptionFeaturePack Move-SPBlobStorageLocationCopies a Windows SharePoint Services 3.0 database by using Remote BLOB Storage (RBS).MoveSPBlobStorageLocationMove-SPBlobStorageLocationSourceDatabaseStringAssignmentCollectionSPAssignmentCollectionBackupDatabaseStringBackupFileNameStringConfirmSwitchParameterDebugMod$true | $falseDestDatabaseFilesBaseNameStringDestinationDatabaseStringDestinationDataSourceInstanceStringDirStringMasterPasswordStringVerboseMod$true | $falseWhatIfSwitchParameterSourceDatabaseSpecifies the name of the Windows Internal Database.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection BackupDatabaseSpecifies the name of the database to be temporarily used during this process. The source database with the temporary name is copied to the Windows Internal Database. If the BackupDatabase parameter is not specified, a name is generated from the source database name and a random GUID is created.StringString BackupFileNameSpecifies the name of the backup file that will be used to make a copy of original database. If the BackupFileName parameter is not specified, a file name is generated from the source database name and a random GUID is created.StringString ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DestDatabaseFilesBaseNameSpecifies the base name to use to generate file names for the destination database (that is, *.mdf or *.ldf files). If the DestDatabaseFilesBaseName parameter is not specified, the name specified in the DestinationDatabase parameter is used to create a value.StringString DestinationDatabaseSpecifies the name of the migrated database. If the DestinationDatabase parameter is not specified, the SourceDatabase parameter is used.StringString DestinationDataSourceInstanceSpecifies the destination database instance name. The value in the SourceDatabase parameter is migrated to this instance. The database instance name should be Microsoft SQL Server 2008 with Service Pack 1 (SP1) version or higher. If the DestinationDataSourceInstance parameter is not specified, the local host name is used.StringString DirUsed for all disk operations, including storing temporary backups and database (.mdf) files of a migrated database. If the Dir parameter is not specified, a default directory of the destination SQL Server instance is used. The free space in this directory should be at least two times the size of the source database.StringString MasterPasswordSpecifies the master password for the destination database instance for the RBS installation. If the master password does not exist, the value specified is used to create a master password. If the MasterPassword parameter is not specified, a random value is used.StringString VerboseModGenerates verbose log output to be displayed in the Command Prompt window. If the VerboseMod parameter is not specified, no output is displayed.$true | $false$true | $false WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Use the Move-SPBlobStorageLocation cmdlet to copy a Windows SharePoint Services 3.0 database into a Microsoft SQL Server 2008 with Service Pack 1 (SP1) database instance by using Remote BLOB Storage (RBS). The database size limitation for SQL Server 2008 with SP1 is 4 gigabyes (GB). If a Windows SharePoint Services 3.0 database is greater than 4 GB, the database cannot be copied directly into a SQL Server 2008 with SP1 database instance. The Move-SPBlobStorageLocation cmdlet uses the advantage of RBS and copies databases larger than 4 GB. RBS stores the data on the local hard disk and keeps the links to the data in the database, which results in a smaller database.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185).-------------------EXAMPLE 1----------------------- C:\PS>Move-SPBlobStorageLocation WSS_ContentThis example copies the content database named WSS_Content from the Windows Internal Database to the same database name in Microsoft SQL Server 2008 Express by using RBS. -------------------EXAMPLE 2----------------------- C:\PS>Move-SPBlobStorageLocation WSS_Content -DestinationDatabase WSS_V4_Content -BackupDatabase WSSBackupDB -VerboseMod:$trueThis example copies the content database named WSS_Content from the Windows Internal Database to a database in SQL Server 2008 Express. The name of the new database will be WSS_V4_Content. During the move, the backup file name will be WSSBackupDB. The output of this command displays log information to the Command Prompt window. Move-SPBlobStorageLocation New-SPManagedPathCreates a new managed path for the given Web application for all host header site collections.NewSPManagedPathNew-SPManagedPathRelativeURLStringWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterExplicitSwitchParameterWhatIfSwitchParameterNew-SPManagedPathRelativeURLStringHostHeaderSwitchParameterAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterExplicitSwitchParameterWhatIfSwitchParameterRelativeURLSpecifies the relative URL for the new managed path.The type must be a valid partial URL such as site or sites/teams/.StringString HostHeaderIf this parameter is provided, this managed path applies to all host header site collections.SwitchParameterSwitchParameter WebApplicationSpecifies the Web application group to add this path.The type must be a valid URL, in the form http://server_name, or a GUID, in the form 1234-5678-0987645a.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ExplicitSpecifies whether the managed path is explicit or wildcard.If not provided, the managed path is a wildcard path.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The New-SPManagedPath cmdlet adds a new managed path to a given Web application or for use with all host header site collections. If the HostHeader switch is provided, the managed path is shared among all host header site collections; otherwise, a Web application must be specified to create this managed path within. The relative URL is a partial URL that represents the managed path. When the slash mark (/) is used, the root is defined. If the Explicit parameter is not provided, the new managed path is a wildcard path.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>New-SPManagedPath "Teams" -WebApplication "http://somesite"This example creates a Teams managed path for a given Web application (http://somesite). Get-SPManagedPathRemove-SPManagedPath New-SPManagedPath Get-SPServerReturns the server or servers in the farm that match the given identity.GetSPServerGet-SPServerIdentitySPServerPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the address of the server to return.SPServerPipeBindSPServerPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPServer cmdlet returns the SPServer object for the given identity (if it exists in the farm). If no parameters are specified, the cmdlet returns all servers in the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185. --------------EXAMPLE 1----------------- C:\PS>Get-SPServerThis example returns all servers in the local farm in a list.--------------EXAMPLE 2----------------- C:\PS>Get-SPServer | Where{ $_.NeedsUpgrade -eq $TRUE}This example returns a list of all servers in the farm that need an upgrade.Rename-SPServer Get-SPServer Export-SPBusinessDataCatalogModelExports a Business Data Connectivity Model.ExportSPBusinessDataCatalogModelExport-SPBusinessDataCatalogModelIdentityMetadataObjectPathStringAssignmentCollectionSPAssignmentCollectionForceSwitchParameterLocalizedNamesIncludedSwitchParameterModelsIncludedSwitchParameterPermissionsIncludedSwitchParameterPropertiesIncludedSwitchParameterProxiesIncludedSwitchParameterSettingIdStringIdentitySpecifies the Business Data Connectivity Metadata Store metadata object from which to export the Business Data Connectivity Model.MetadataObjectMetadataObject PathSpecifies the path and name to use to create the export file.The type must be a valid path in either of the following forms:- C:\folder_name \file.bdcm- \\server_name\folder_name \file.bdcm- …\folder_name\file.bdcmStringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ForceOverwrites the output file if the file exists.SwitchParameterSwitchParameter LocalizedNamesIncludedSpecifies that names for business data fields in multiple languages are exported.SwitchParameterSwitchParameter ModelsIncludedSpecifies that models are included in the exported Business Data Connectivity Model file. A model contains the base XML metadata for a system.SwitchParameterSwitchParameter PermissionsIncludedSpecifies that permissions from the Business Data Connectivity Model are exported.SwitchParameterSwitchParameter PropertiesIncludedSpecifies that properties from the application definition are exported.SwitchParameterSwitchParameter ProxiesIncludedSpecifies that proxies for Business Data Connectivity Service applications are exported.SwitchParameterSwitchParameter SettingIdSpecifies the custom environment settings model slice to export.The type must be a valid string that identifies a model slice; for example, ModelSlice1.StringString The Export-SPBusinessDataCatalogModel cmdlet exports a Business Data Connectivity Model. There are two types of Business Data Connectivity models: Model type (.bdcm) and Resource type (.bdcr). The Model type contains the base XML metadata, and can also include resource properties. The Resource type includes only resource properties.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$Model = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Model" -Name "ContosoModel" -ServiceConext http://contoso Export-SPBusinessDataCatalogModel -Identity $Model -Path "C:\folder\model.bdcm"This example gets a Business Data Connectivity Model from the Business Data Connectivity Metadata Store and exports it to the location specified with the name model and using the bdcm file extension.Import-SPBusinessDataCatalogModelRemove-SPBusinessDataCatalogModel Export-SPBusinessDataCatalogModel Remove-SPManagedAccountRemoves a managed account registration from the farm.RemoveSPManagedAccountRemove-SPManagedAccountIdentitySPManagedAccountPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterRemove-SPManagedAccountIdentitySPManagedAccountPipeBindNewPasswordSecureStringAssignmentCollectionSPAssignmentCollectionChangePasswordSwitchParameterConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the full name or partial name of the managed accounts to retrieve.The type must be a valid account name, in the form Domain\User, or a GUID, in the form 1234-3456-09876.SPManagedAccountPipeBindSPManagedAccountPipeBind NewPasswordSpecifies a secure string for the new password (that is, $MySecureString).Works in conjunction with the ChangePassword parameter.SecureStringSecureString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ChangePasswordSpecifies whether a password is to be changed. Works in conjunction with the NewPassword parameter. When the ChangePassword value is set, a secure string value is required for the NewPassword parameter (that is, $MySecureString).SwitchParameterSwitchParameter ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPManagedAccount cmdlet removes account registration from the configuration database within the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ----------------------EXAMPLE------------------- C:\PS>Remove-SPManagedAccount -Identity DOMAIN\ServiceAcctThis example removes the DOMAIN\ServiceAcct managed account from the farm.Get-SPManagedAccountNew-SPManagedAccountSet-SPManagedAccount Remove-SPManagedAccount Remove-SPSiteSubscriptionFeaturePackRemoves a SharePoint Feature set from a site subscription.RemoveSPSiteSubscriptionFeaturePackRemove-SPSiteSubscriptionFeaturePackIdentitySPSiteSubscriptionFeaturePackPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the Feature set object to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a feature set (for example, FeatureSet1); or an instance of a valid SPFeatureSet object.SPSiteSubscriptionFeaturePackPipeBindSPSiteSubscriptionFeaturePackPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove- SPSiteSubscriptionFeaturePack cmdlet removes a SharePoint Feature set by specifying the GUID or Feature set object.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -----------------EXAMPLE------------------------ C:\PS>Remove-SPFeatureSet -Identity "30daa535-b0fe-4d10-84b0-fb04029d161a"This example removes a SharePoint Feature set that has the ID 30daa535-b0fe-4d10-84b0-fb04029d161a.Get-SPSiteSubscriptionFeaturePackNew-SPSiteSubscriptionFeaturePackRemove-SPSiteSubscriptionFeaturePackAdd-SPSiteSubscriptionFeaturePackMember Remove-SPSiteSubscriptionFeaturePack New-SPUsageApplicationCreates a new usage application.NewSPUsageApplicationNew-SPUsageApplicationNameStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDatabaseNameStringDatabasePasswordSecureStringDatabaseServerStringDatabaseUsernameStringFailoverDatabaseServerStringUsageServiceSPUsageServicePipeBindWhatIfSwitchParameterNameSpecifies the friendly name of the new usage application.The type must be a valid name of a usage application; for example, UsageApplication1.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DatabaseNameSpecifies the name of the logging database. If the logging database does not exist, a logging database is automatically created.The type must be a valid name of a SQL Server database; for example, UsageLogDB1.StringString DatabasePasswordSpecifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL Server Authentication is used to access the logging database.The type must be a valid password.SecureStringSecureString DatabaseServerSpecifies the SPServer object where the logging database is created.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; the IP address of a server computer, in the form 208.77.188.166; a valid name of a SQL Server host service (for example, SQLServerHost1); or an instance of a valid SPServer object.StringString DatabaseUsernameSpecifies the user name to use for connecting to the logging database. Use this parameter only if SQL Server Authentication is used to access the logging database.The type must be a valid user name; for example, UserName1.StringString FailoverDatabaseServerSpecifies the name of the host SQL Server instance for the failover database server.The type must be a valid SQL Server instance name; for example, SQLServerHost1.StringString UsageServiceFilters to return the usage application with the specified parent SPUsageService object.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object.SPUsageServicePipeBindSPUsageServicePipeBind WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The New-SPUsageApplication cmdlet creates a new usage application in the local farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------EXAMPLE------------------------- C:\PS>New-SPUsageApplication -Name "Usage Application For Farm ABC"This example creates a new usage application for the specified name. New-SPUsageApplication Export-SPSiteSubscriptionSettingsCreates a backup file of site subscription data.ExportSPSiteSubscriptionSettingsExport-SPSiteSubscriptionSettingsIdentitySPSiteSubscriptionPipeBindPathStringAdminPropertiesSwitchParameterAssignmentCollectionSPAssignmentCollectionForceSwitchParameterIdentitySpecifies the ID of the site subscription from which to back up data.The type must be a valid URL, in the form http://server_name or a GUID in the form 1234-4567-985tg.SPSiteSubscriptionPipeBindSPSiteSubscriptionPipeBind PathSpecifies the location of the output file.The type must be a valid path; for example, C:/backupfile.back. .StringString AdminPropertiesSpecifies that only administrator subscription properties are exported. If this parameter is not set, only non-administrator subscription properties are exported.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ForceForces the output backup file (if provided) to overwrite any existing file at the given path.SwitchParameterSwitchParameter The Export-SPSiteSubscriptionSettings cmdlet generates a backup file of all settings in the subscription data store for the given site subscription.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185).--------------EXAMPLE----------------- C:\PS>Get-SPSiteSubscription http://contoso.com | Backup-SPSiteSubscriptionSettings -path "c:/backups"The example backs up the subscription settings store of http://www.contoso.com.Import-SPSiteSubscriptionSettingsRemove-SPSiteSubscriptionSettings Export-SPSiteSubscriptionSettings Get-SPUsageDefinitionReturns a usage definition object.GetSPUsageDefinitionGet-SPUsageDefinitionIdentitySPUsageDefinitionPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the usage definition object to get.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage definition (for example, SiteSubscriptionConfig1); or an instance of a valid SPUsageDefinition object.SPUsageDefinitionPipeBindSPUsageDefinitionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPUsageDefinition cmdlet reads a usage definition object. If the Identity parameter is not specified, this cmdlet returns the collection of usage definitions in the farm. A usage definition object defines a specific type of usage.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -----------------EXAMPLE----------------- C:\PS>Get-SPUsageDefinition -Identity "Page Requests"This example returns the SPRequestUsage provider on the local farm.Set-SPUsageDefinition Get-SPUsageDefinition Disconnect-SPConfigurationDatabaseDisconnects the local server computer from the farm.DisconnectSPConfigurationDatabaseDisconnect-SPConfigurationDatabaseAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Disconnect-SPConfigurationDatabase cmdlet disconnects the active server computer from the SharePoint configuration database. This operation removes the server computer from the farm. The configuration database must be disconnected before the database can be removed.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Disconnect-SPConfigurationDatabase -Confirm:$falseThis example removes the local server computer from a farm without prompting for user confirmation.New-SPConfigurationDatabaseRemove-SPConfigurationDatabaseConnect-SPConfigurationDatabaseBackup-SPConfigurationDatabase Disconnect-SPConfigurationDatabase Set-SPDesignerSettingsSets Microsoft SharePoint Designer 2010 features.SetSPDesignerSettingsSet-SPDesignerSettingsWebApplicationSPWebApplicationPipeBindAllowDesigner$true | $falseAllowMasterPageEditing$true | $falseAllowRevertFromTemplate$true | $falseAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterShowURLStructure$true | $falseWhatIfSwitchParameterWebApplicationSpecifies the Web application in which the settings will apply.SPWebApplicationPipeBindSPWebApplicationPipeBind AllowDesignerSpecifies whether to allow users to edit sites in a web application by using Microsoft SharePoint Designer 2010. The default value is True $true | $false$true | $false AllowMasterPageEditingSpecifies whether to allow site administrators to customize master pages and layout pages using Microsoft SharePoint Designer 2010. The default value is True. $true | $false$true | $false AllowRevertFromTemplateSpecifies whether to allow site administrators to detach pages from the original site definition using Microsoft SharePoint Designer 2010. The default value is True.$true | $false$true | $false AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ShowURLStructureSpecifies whether to allow site administrators to manage the URL structure of their Web sites by using Microsoft SharePoint Designer 2010. The default value is True.$true | $false$true | $false WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPDesignerSettings cmdlet sets SharePoint Designer 2010 features on a specified Web application when the WebApplicaton is used.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------EXAMPLE-------------------- C:\PS>Set-SPDesignerSettings -WebApplication http://constoso -AllowRevertFromTemplate $False -AllowMasterPageEditing $FalseThis example disables the ability to detach pages from existing site definitions and to edit master pages and page layouts.Get-SPDesignerSettings Set-SPDesignerSettings Add-SPDiagnosticsPerformanceCounterAdds a new instance of a performance counter to a Web front end computer or a database server.AddSPDiagnosticsPerformanceCounterAdd-SPDiagnosticsPerformanceCounterCategoryStringCounterStringAllInstancesSwitchParameterAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDatabaseServerSwitchParameterWebFrontEndSwitchParameterWhatIfSwitchParameterAdd-SPDiagnosticsPerformanceCounterCategoryStringInstanceStringAllInstancesSwitchParameterAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterCounterStringDatabaseServerSwitchParameterWebFrontEndSwitchParameterWhatIfSwitchParameterCategorySpecifies the category of performance counter to add to the target Web front end computer or database server.The type must be a valid name of a category of performance counters; for example, ASP.NET, PhysicalDisk, or Processor.StringString CounterSpecifies the type of counter to add to the target Web front end computer or database server.The type must be a valid name of counter type; for example, Requests Queued, Avg. Disk Queue Length, and % Processor Time.StringString InstanceSpecifies the display name of the new performance counter.The type must be a valid name of a performance counter instance; for example Total_PerfCounter.StringString AllInstancesCollects all instances of a counter category and type on the target Web front end computer or database server.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DatabaseServerAdds the specified performance counter to all database servers in the farm.SwitchParameterSwitchParameter WebFrontEndAdds the specified performance counter to all Web front end computers in the farm.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Add-SPDiagnosticsPerformanceCounter cmdlet adds a performance counter to a Web front end computer on a database server. A performance counter is read and recorded in the Usage Database. By default, the new performance counter is added to the database servers in the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1------------------ C:\PS>Add-SPDiagnosticsPerformanceCounter -category ASP.NET -Counter "Requests Queued"This example adds the counter with the name ASP.NET\Requests Queued on Web front end computers.------------------EXAMPLE 2------------------ C:\PS>Add-SPDiagnosticsPerformanceCounter -category PhysicalDisk -counter "Avg. Disk Queue Length" -allinstancesThis example adds all instances of the counter PhysicalDisk in the category Avg. Disk Queue Length on Web front ends computers.------------------EXAMPLE 3------------------ C:\PS>Add-SPDiagnosticsPerformanceCounter -category Processor -counter "% Processor Time" -instance "_Total" -databaseserverThis example adds the _Total instance of the counter % Processor Time in the category Processor on database servers.Get-SPDiagnosticsPerformanceCounterRemove-SPDiagnosticsPerformanceCounter Add-SPDiagnosticsPerformanceCounter Install-SPServiceInstalls and provisions services on a farm.InstallSPServiceInstall-SPServiceAssignmentCollectionSPAssignmentCollectionProvisionSwitchParameterAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ProvisionSpecifies default settings when installing a standalone service application. SwitchParameterSwitchParameter The Install-SPService cmdlet installs and optionally provisions services on a farm. This cmdlet installs all services, service instances, and service proxies specified in the registry on the local server computer. Use this cmdlet in a script that you build to install and deploy a SharePoint farm or to install a custom developed service.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Install-SPServiceThis example installs all services, service instances and service proxies specified in the registry on the local server computer. Install-SPService Remove-SPManagedPathDeletes the specified managed path from the specified host header or Web application.RemoveSPManagedPathRemove-SPManagedPathIdentitySPPrefixPipeBindWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterRemove-SPManagedPathIdentitySPPrefixPipeBindHostHeaderSwitchParameterAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the name of the managed path to delete. For example, in the URL http://sitename/sites/site1, "sites" is the name of the managed path.SPPrefixPipeBindSPPrefixPipeBind HostHeaderSpecifies that the Identity is a host header managed path.SwitchParameterSwitchParameter WebApplicationSpecifies the identity of the Web application that hosts the managed path to delete. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Web application name (for example, WebApplication1212); or a valid name, in the form WebApp2423.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPManagedPath cmdlet deletes the managed path specified by the Identity parameter from the host header or the Web application. The Identity must be the partial URL of the managed path to be deleted.If you are using host headers, specify the HostHeader parameter. To delete a HostHeader managed path, provide the HostHeader switch. Otherwise, you must specify the Web Application that contains the managed path to be deleted.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ----------------------EXAMPLE 1---------------------------- C:\PS>Remove-SPManagedPath "sites" -HostHeaderThis example removes the sites managed path from the list of HostHeader managed paths.Depending on the confirmation level of the local system, the preceding example can prompt prior to execution.------------------EXAMPLE 2----------------------- C:\PS>Get-SPWebApplication | Remove-SPManagedPath "personal" -confirm:$falseThis example removes the personal managed path from all Web applications in the farm. This command does not prompt for confirmation.Get-SPManagedPathNew-SPManagedPath Remove-SPManagedPath Remove-SPBusinessDataCatalogModelDeletes a Business Data Connectivity Model.RemoveSPBusinessDataCatalogModelRemove-SPBusinessDataCatalogModelIdentityMetadataObjectAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the Business Data Connectivity Metadata Store metadata object to remove.MetadataObjectMetadataObject AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPBusinessDataCatalogModel cmdlet deletes a Business Data Connectivity Model.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$modelFile = Get-SPBusinessDataCatalogMetadataObject -Name "ContosoModel" -BdcObjectType Model -ServiceContext http://contoso Remove-SPBusinessDataCatalogModel -Identity $modelFileThis example removes the Business Data Connectivity Model file named ContosoModel.Import-SPBusinessDataCatalogModelExport-SPBusinessDataCatalogModel Remove-SPBusinessDataCatalogModel Remove-SPUserSolutionRemoves a sandboxed solution from the solution gallery.RemoveSPUserSolutionRemove-SPUserSolutionIdentityStringSiteSPSitePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the sandboxed solution to remove.The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object.StringString SiteRemove the sandboxed solution from the specified site collection.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object.SPSitePipeBindSPSitePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPUserSolution cmdlet completely removes a sandboxed solution from the solution gallery. Before you can remove the sandboxed solution from the solution gallery, you must deactivate it by using the Uninstall-SPUserSolution cmdlet.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ----------------EXAMPLE---------------------- C:\PS>Remove-SPUserSolution -Identity contoso_solution.wsp -Site http://sitenameThis example removes the sandboxed solution contoso_solution.wsp from the site http://sitename.Update-SPUserSolutionInstall-SPUserSolutionUninstall-SPUserSolutionGet-SPUserSolutionAdd-SPUserSolution Remove-SPUserSolution Disable-SPWebApplicationHttpThrottlingTurns off network throttling for a Web application.DisableSPWebApplicationHttpThrottlingDisable-SPWebApplicationHttpThrottlingIdentitySPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentityTurns off network throttling on the specified SharePoint Web application.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Disable-SPWebApplicationHttpThrottling cmdlet turns off network throttling for a Web application. This operation prompts you to confirm that you want to turn off network throttling.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Disable-SPWebApplicationHTTPThrottling http://sitenameThis example disables network throttling on the Web application http://sitename.Get-SPWebApplicationHttpThrottlingMonitorEnable-SPWebApplicationHttpThrottlingSet-SPWebApplicationHttpThrottlingMonitor Disable-SPWebApplicationHttpThrottling Get-SPServiceApplicationReturns the specified service application.GetSPServiceApplicationGet-SPServiceApplicationIdentitySPServiceApplicationPipeBindAssignmentCollectionSPAssignmentCollectionNameStringIdentitySpecifies the GUID of the service application to get.SPServiceApplicationPipeBindSPServiceApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPServiceApplication cmdlet returns the service application specified by the Identity parameter. If no parameter is specified, the cmdlet returns all service applications in the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE---------------------- C:\PS>Get-SPServiceApplicationThis example returns all service applications in the farm.Set-SPServiceApplicationGrant-SPServiceApplicationRevoke-SPServiceApplicationGet-SPServiceApplicationProxy Get-SPServiceApplication Add-SPUserSolutionUploads a new sandboxed solution to the solution gallery.AddSPUserSolutionAdd-SPUserSolutionLiteralPathStringSiteSPSitePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterLiteralPathSpecifies the path to the sandboxed solution package.The type must be a valid path in either of the following forms:- C:\folder_name- \\server_name\folder_nameStringString SiteSpecifies the site collection where the sandboxed solution is to be added.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSiteobject.SPSitePipeBindSPSitePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Add-SPUserSolution cmdlet uploads a new sandboxed solution package to the solution gallery. This cmdlet does not activate the uploaded sandboxed solution; to activate the solution in the site collection, use the Install-SPUserSolution cmdlet.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------EXAMPLE--------------------- C:\PS>Add-SPUserSolution -LiteralPath c:\contoso_solution.wsp -Site http://sitenameThis example adds the sandboxed solution c:\contoso_solution.wsp to the site http://sitename.Update-SPUserSolutionInstall-SPUserSolutionUninstall-SPUserSolutionRemove-SPUserSolutionGet-SPUserSolution Add-SPUserSolution Get-SPServiceContextReturns a service context.GetSPServiceContextGet-SPServiceContextSiteSPSitePipeBindAssignmentCollectionSPAssignmentCollectionGet-SPServiceContextSiteSubscriptionSPSiteSubscriptionPipeBindAssignmentCollectionSPAssignmentCollectionSiteReturns the service context for only the Web application that contains the specified site collection.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object.SPSitePipeBindSPSitePipeBind SiteSubscriptionReturns all of the service contexts for all Web applications in which the specified site subscription has site collections.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a site subscription (for example, SiteSubscriptionConfig1); or an instance of a valid SiteSubscription object.SPSiteSubscriptionPipeBindSPSiteSubscriptionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPServiceContext cmdlet returns a service context or a collection of service contexts. Specify the Site parameter to return an individual service context, or specify the SiteSubscription parameter to return a collection of service contexts.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ----------------EXAMPLE--------------- C:\PS>$sitesub = Get-SPSiteSubscription http://my.contoso.com/ C:\PS>Get-SPServiceContext $sitesubThis example returns the service context for a site in a hosted environment. Get-SPServiceContext Receive-SPSharedServiceApplicationInfoConfigures this farm to receive service information from another farm.ReceiveSPSharedServiceApplicationInfoFarmUrlSpecifies the URL of the farm from which to receive service application information.The type must be a valid URL, in the form http://server_name.AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.FilterThe Receive-SPSharedServiceApplicationInfo cmdlet retrieves the list of service applications published by another farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Receive-SPSharedServiceApplicationInfo -FarmUrl http://FarmB/topology/topology.svcThis example retreives a list of service applications published by a given farm.The FarmURL parameter can be obtained by the Get-SPTopologyWebServiceApplication cmdlet. Receive-SPSharedServiceApplicationInfo Merge-SPLogFileCombines trace log entries from all farm computers into a single log file on the local computer.MergeSPLogFileMerge-SPLogFilePathStringAreaString[]AssignmentCollectionSPAssignmentCollectionCategoryString[]ContextFilterString[]CorrelationGuid[]EndTimeDateTimeEventIDString[]ExcludeNestedCorrelationSwitchParameterLevelStringMessageString[]OverwriteSwitchParameterProcessString[]StartTimeDateTimeThreadIDUInt32[]PathSpecifies the path and file name to which to write the merged log file. Relative paths are supported.StringString AreaSpecifies the area name to filter on.The type must be a valid name; for example, SharePoint Foundation.The use of wildcards is supported.String[]String[] AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection CategorySpecifies the category ID to filter on.The type must be a valid category name; for example, category1.The use of wildcards is supported.String[]String[] ContextFilterSpecifies a filter for trace entries in a particular context in the form key=value, for example, user=contoso\joeuser.String[]String[] CorrelationSpecifies the correlation ID to filter on. The type must be a valid GUID, in the form F0BB0790-4323-A153-096F-ABCDC80E24D4.Guid[]Guid[] EndTimeSpecifies the end time of the log entries returned.The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US.DateTimeDateTime EventIDSpecifies the Event ID to filter on. The use of wildcards is supported.String[]String[] ExcludeNestedCorrelationExcludes nested correlation values in the results. This parameter is only used when filtering results by using the ContextFilter parameterBy default, records returned from the ContextFilter parameter include all related records in addition to the records that match the filter. Specifying this option includes only the records that match the filter and excludes any related records.SwitchParameterSwitchParameter LevelSpecifies the level name to filter on.Results include the specified level and everything more severe.StringString MessageSpecifies the message text to filter on.The type must be valid text. Text with spaces should be enclosed with quotation marks; for example, "This is a test."The use of wildcards is supported.String[]String[] OverwriteOverwrites the log file if it already exists at the specified path.The type must be either of the following values:- $True- $FalseThe default value is $False.SwitchParameterSwitchParameter ProcessSpecifies the process name to filter on.The use of wildcards is supported.String[]String[] StartTimeSpecifies the start time of the log entries returned.The type must be a valid DateTime format that is culture-specific to the administrative language, such as 2/16/2007 12:15:12 for English-US.The default is one hour prior to the current time on the local computer.DateTimeDateTime ThreadIDSpecifies the thread ID to filter on.The type must be a valid integer from 0 through 4,294,967,295.UInt32[]UInt32[] The Merge-SPLogFile cmdlet returns records from Unified Logging Service (ULS) trace log files on each farm server that match the criteria, and writes the results to a new log file on the local computer. If no results are returned, a warning is written to the Windows PowerShell console window.We recommend that you filter by using the StartTime and EndTime parameters to optimize performance of this cmdlet. Some filtering parameters such as Process, Area, Category, EventID and Message support wildcards. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE 1----------------- C:\PS>Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -OverwriteThis example merges the last hour of log data from all farm computers with no filtering.--------------EXAMPLE 2----------------- C:\PS>Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Area SearchThis example merges the last hour of log data from the Search area.--------------EXAMPLE 3----------------- C:\PS>Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Area "SharePoint Foundation","Web Analytics Services"This example merges the last hour of log data from the SharePoint Foundation and Web Analytics Services areas.--------------EXAMPLE 4----------------- C:\PS>Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Level HighThis example merges the log data of level High or higher.--------------EXAMPLE 5----------------- C:\PS>Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -StartTime "06/09/2008 16:00" - EndTime "06/09/2008 16:15"This example merges the log data for events in a particular time range, which is culture-specific to the United States.--------------EXAMPLE 6----------------- C:\PS>Merge-SPLogFile -Path "C:\Logs\FarmMergedLog.log" -Overwrite -Message "*permission changed*"This example merges the log data for events with permission changed in the message text.--------------EXAMPLE 7----------------- C:\PS>Merge-SPLogFile -Overwrite -Path d:\1.log -ContextFilter "name=timer job*" -Area "*search*"This example merges the log data for all search timer jobs.--------------EXAMPLE 8----------------- C:\PS>Merge-SPLogFile -Overwrite -Path d:\2.log -ContextFilter "user=contoso?joeuser"This example shows how to merge the log data for all user names that have a contoso\joeuser or Contoso/joeuser format.New-SPLogFile Merge-SPLogFile Update-SPSolutionUpgrades a deployed SharePoint solution.UpdateSPSolutionUpdate-SPSolutionIdentitySPSolutionPipeBindLiteralPathStringAssignmentCollectionSPAssignmentCollectionCASPoliciesSwitchParameterConfirmSwitchParameterForceSwitchParameterGACDeploymentSwitchParameterLocalSwitchParameterTimeStringWhatIfSwitchParameterIdentitySpecifies the SharePoint solution to deploy.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object.SPSolutionPipeBindSPSolutionPipeBind LiteralPathSpecifies the path to the solution package.The type must be a valid path in either of the following forms:- C:\folder_name- \\server_name\folder_nameStringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection CASPoliciesSpecifies that Code Access Security (CAS) policies can be deployed for the new SharePoint solution.SwitchParameterSwitchParameter ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceForces the deployment of the new SharePoint solution.SwitchParameterSwitchParameter GACDeploymentSpecifies that global assembly cache (GAC) can be deployed for the new SharePoint solution.SwitchParameterSwitchParameter LocalDeploys the solution on the local computer only.SwitchParameterSwitchParameter TimeSpecifies when the solution will be deployed. The default value is immediate deployment.The type must be a valid DateTime value, in the form 2010, 5, 1.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Install-SPSolution cmdlet upgrades a deployed SharePoint solution in the farm. Use this cmdlet only if a new solution contains the same set of files and features as the deployed solution. If files and features are different, the solution must be retracted and redeployed by using the Uninstall-SPSolution and Install-SPSolution cmdlets, respectively.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Update-SPSolution -Identity contoso_solution.wsp -LiteralPath c:\contoso_solution_v2.wsp -GACDeploymentThis example upgrades the deployed SharePoint solution contoso_solution.wsp to the solution c:\contoso_solution_v2.wsp.Get-SPSolutionAdd-SPSolutionUninstall-SPSolutionRemove-SPSolutionInstall-SPSolutionRemove-SPSolutionDeploymentLock Update-SPSolution Get-SPDiagnosticsPerformanceCounterReturns a collection of performance counters.GetSPDiagnosticsPerformanceCounterGet-SPDiagnosticsPerformanceCounterAssignmentCollectionSPAssignmentCollectionDatabaseServerSwitchParameterWebFrontEndSwitchParameterAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection DatabaseServerReturns performance counters collected for the database servers in the farm.SwitchParameterSwitchParameter WebFrontEndReturns performance counters collected for the Web front end computers in the farm.SwitchParameterSwitchParameter The Get-SPDiagnosticsPerformanceCounter cmdlet returns the collection of performance counters that are read and recorded in the Usage Database. If the neither the DatabaseServer or WebFrontEnd parameters are specified, this cmdlet returns the performance counters on the Web front end computes on a database servers in the farm.To distinguish counters that are collected on database servers and counters that are collected on Web front end computers, note that counters that are collected on database servers have a Provider Name of job-diagnostics-performance-counter-sql-provider, and counters that are collected on Web front end computers have a Provider Name of job-diagnostics-performance-counter-wfe-provider.The Get-SPDiagnosticsPerformanceCounter cmdlet is only available using Windows PowerShell. There is no User Interface.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1------------------ C:\PS>Get- SPDiagnosticsPerformanceCounterThis example gets the performance counter settings for Web front end computers and database servers.------------------EXAMPLE 2------------------ C:\PS>Get- SPDiagnosticsPerformanceCounter -WebFrontEndThis example gets the performance counter settings for Web front end computers.------------------EXAMPLE 3------------------ C:\PS>Get- SPDiagnosticsPerformanceCounter -DatabaseServerThis example gets the performance counter settings for database servers.Add-SPDiagnosticsPerformanceCounterRemove-SPDiagnosticsPerformanceCounter Get-SPDiagnosticsPerformanceCounter Get-SPServiceApplicationProxyReturns an instance of the specified service application proxy.GetSPServiceApplicationProxyGet-SPServiceApplicationProxyIdentitySPServiceApplicationProxyPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the GUID of the service application proxy to return.SPServiceApplicationProxyPipeBindSPServiceApplicationProxyPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPServiceApplicationProxy cmdlet returns an instance of the service application proxy specified by the Identity parameter.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE----------------- C:\PS>Get-SPServiceApplicationProxyThis example retrieves all the service application proxies in the farm.Remove-SPServiceApplicationProxyNew-SPServiceApplicationProxyGroupRemove-SPServiceApplicationProxyGroupGet-SPServiceApplicationProxyGroup Get-SPServiceApplicationProxy Move-SPUserMigrates a user account in SharePoint 2010 Products.MoveSPUserMove-SPUserIdentitySPUserPipeBindNewAliasStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterIgnoreSIDSwitchParameterWhatIfSwitchParameterIdentitySpecifies the GUID or login name of the user to be returned.The type must be a valid GUID of the user, in the form 1234-5678-9876-0987.SPUserPipeBindSPUserPipeBind NewAliasSpecifies the name of the URL or GUID that to be used as a scope.The type must be a valid URL and GUID, in the form http://server_name or 1234-5678-9807.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter IgnoreSIDIndicates (if present) that Active Directory will not be queried for the SID history attribute to ensure that the new login name is correspondent to the old login name.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Move-SPUser cmdlet migrates user access from one domain user account to another. If an entry for the new login name already exists, the entry is marked for deletion to make way for the migration.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Move-SPUser -Identity "DOMAIN\JaneDoe" -NewAlias "Domain\JaneSmith"This example migrates DOMAIN\JaneDoe to the new account of DOMAIN\JaneSmith.New-SPUserSet-SPUserRemove-SPUserGet-SPUser Move-SPUser Set-SPWebConfigures the specified subsite.SetSPWebSet-SPWebIdentitySPWebPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDescriptionStringRelativeUrlStringTemplateSPWebTemplatePipeBindThemeStringWhatIfSwitchParameterIdentityThe URL of the Web or SPWeb object that represents the Web.The type must be a valid URL, in the form http://server_name, or an SPWeb object.SPWebPipeBindSPWebPipeBind NameSpecifies the new name of the Web.DescriptionSpecifies the new description of the Web.StringString RelativeUrlSpecifies the new relative URL for the Web. This is the URL path after the site collection URL.StringString ThemeSpecifies the new theme to apply to the Web.StringString TemplateSpecifies the new template to apply to the Web. This cannot be done if the template is already applied.SPWebTemplatePipeBindSPWebTemplatePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPWeb cmdlet configures the subsite specified by the Identity parameter. Settings for any parameters that are not provided are not changed.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). one------------------EXAMPLE----------------------- C:\PS>Get-SPWeb http://sitename/subweb | Set-SPWeb -Title "My Site Title"This example sets the title of an existing subsite.Get-SPWebNew-SPWebRemove-SPWebExport-SPWebImport-SPWeb Set-SPWeb Install-SPApplicationContentCopies shared application data to existing Web application folders.InstallSPApplicationContentInstall-SPApplicationContentAssignmentCollectionSPAssignmentCollectionAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Install-SPApplicationContent cmdlet copies shared application data to existing Web application folders.This cmdlet does not take any parameters.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ---------------------EXAMPLE-------------------- C:\PS>Install-SPApplicationContentThis example copies data to a Web application in the existing folders. Install-SPApplicationContent Uninstall-SPHelpCollectionRemoves Help collection files.UninstallSPHelpCollectionUninstall-SPHelpCollectionNameStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterNameSpecifies the name of the Help collection files to uninstall.The type must be a valid name of a Help collection; for example, HelpDocs1.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Uninstall-SPHelpCollection cmdlet removes the specified Help collection files from the product Help library in the current farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Uninstall-SPHelpCollection - Name "OSSAdmin.1033"This example uninstalls a Help collection. The folder name of the Help collection to uninstall is OSSAdmin.1033.Get-SPHelpCollectionInstall-SPHelpCollection Uninstall-SPHelpCollection Remove-SPTrustedRootAuthorityDeletes a trusted root authority.RemoveSPTrustedRootAuthorityRemove-SPTrustedRootAuthorityIdentitySPTrustedRootAuthorityPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the trusted root authority to delete.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted root authority (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object.SPTrustedRootAuthorityPipeBindSPTrustedRootAuthorityPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Remove-SPTrustedRootAuthority cmdlet deletes a trusted root authority from a signing certificate store.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Remove - SPTrustedRootAuthority -Name "WFEFarm1"This example removes the trusted root authority WFEFarm1.New-SPTrustedRootAuthorityGet-SPTrustedRootAuthoritySet-SPTrustedRootAuthority Remove-SPTrustedRootAuthority Uninstall-SPWebPartPackUninstalls the specified Web Part package.UninstallSPWebPartPackUninstall-SPWebPartPackIdentityStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterLanguageUInt32WebApplicationSPWebApplicationPipeBindWhatIfSwitchParameterIdentitySpecifies the Web Part package in the farm's configuration database.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter LanguageSpecifies the language ID of the Web Part package to delete. If no language is specified, the Web Part package is uninstalled for all languages.The type must be a valid language identifier, in the form 1033.UInt32UInt32 WebApplicationSpecifies the Web application from which to uninstall the Web Part package. If no Web application is specified, the Web Part package is uninstalled from all Web applications.The type must be a valid name, in the form WebApplication-1212, or a URL, in the form http://server_name/WebApplication-1212.SPWebApplicationPipeBindSPWebApplicationPipeBind WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Uninstall-SPWebPartPack cmdlet uninstalls the Web Part package specified by the Identity parameter.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). None------------------EXAMPLE1------------------ C:\PS>Uninstall-SPWebPartPack "mypart.wpp" -WebApplication http://portalThis example uninstalls mypart.wpp to from the Web application http://portal.------------------EXAMPLE2------------------ C:\PS>Get-SPWebPartPack -WebApplication http://portal | Uninstall-SPWebPartPackThis example uninstalls all Web part packages from the Web application http://portal.Get-SPWebPartPackInstall-SPWebPartPack Uninstall-SPWebPartPack Get-SPFarmConfigReturns a global property or a collection of global properties for the local farm.GetSPFarmConfigGet-SPFarmConfigAssignmentCollectionSPAssignmentCollectionServiceConnectionPointSwitchParameterAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ServiceConnectionPointGets the information stored in the current farm's service connection point in Active Directory.SwitchParameterSwitchParameter The Get-SPFarmConfig cmdlet retrieves global settings for the local farm that are not members of the SPFarm object. This cmdlet creates a new PSCustomObject object from the collection of properties returned from the local farm, and then adds this object to the pipeline. The PSCustomObject object can be read, or modified and passed to the Set-SPFarmConfig cmdlet to change parameter values.The properties collected in the PSCustomObject object must be farm-wide settings, and must be configurable only once for the entire farm. The parameter name added to the PSCustomObject object must match exactly the input parameter name for the Set-the SPFarmConfig cmdlet.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------EXAMPLE---------------- C:\PS>$a = Get-SPFarmConfigPS> $a.AjaxTimeout = 200PS> $a | Set-SPFarmConfigThis example uses the Get-SPFarmConfig cmdlet to add the Ajax Timeout setting to the PSCustomObject object, sets the value for Ajax Timeout, and then passes PSCustomObject to the Set-SPFarmConfig cmdlet to change the Ajax Timeout setting. Ajax Timeout, a farm-wide setting, is a member of the SPWebService object and cannot be accessed with a PowerShell cmdlet.You can perform the same operations with either of the following commands. C:\PS>Set-SPFarmConfig -AjaxTimeout 200 C:\PS>Get-SPFarmConfig | Select AjaxTimeout 200Set-SPFarmConfig Get-SPFarmConfig Set-SPAlternateUrlConfigures the specified alternate URL.SetSPAlternateUrlSet-SPAlternateUrlIdentitySPAlternateUrlPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterUrlStringWhatIfSwitchParameterZoneDefault | Intranet | Internet | Custom | ExtranetIdentitySpecifies the URL or GUID of the alternate URL to change.The type must be a valid URL, in the form http://server_name/WebApplication/site, or a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh.SPAlternateUrlPipeBindSPAlternateUrlPipeBind UrlSpecifies the new alternate URL.StringString ZoneSets the supplied alternate URL as one of the five zones. The type must be any one of the following values: Default , Intranet , Internet , Extranet , or Custom .Default | Intranet | Internet | Custom | ExtranetDefault | Intranet | Internet | Custom | Extranet AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPAlternateUrl cmdlet changes the URL or zone of the alternate URL specified by the Identity parameter. This cmdlet can be used to change only the zone of internal URLs, and cannot be used to change the zone of public URLs.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1------------------ C:\PS>Set-SPAlternateURL -Identity https://www.contoso.com -Zone "Internet"This example changes the zone of the alternate URL https://www.contoso.com.------------------EXAMPLE 2------------------ C:\PS>Set-SPAlternateURL -Identity https://www.contoso.com -Url https://sharepoint.contoso.com -Zone "Default"This example changes the URL and zone of the alternate URL https://www.contoso.com.------------------EXAMPLE 3------------------ C:\PS>Get-SPAlternateURL https://www.contoso.com | Set-SPAlternateURL -Zone "Internet"This example changes the zone of the alternate URL https://www.contoso.com.------------------EXAMPLE 4------------------ C:\PS>Get-SPWebApplication |%{ Get-SPAlternateURL -WebApplication $_ -Zone "Extranet" } | Set-SPAlternateURL -Zone "Intranet"This example changes the zone of the alternate URL for the specified Web application from Extranet to Intranet. Get-SPAlternateURLNew-SPAlternateUrlRemove-SPAlternateUrl Set-SPAlternateUrl Remove-SPSolutionRemoves a SharePoint solution from a farm.RemoveSPSolutionRemove-SPSolutionIdentitySPSolutionPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterLanguageUInt32WhatIfSwitchParameterIdentitySpecifies the SharePoint solution to remove.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object.SPSolutionPipeBindSPSolutionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceForces the removal of the SharePoint solution. You can use this parameter to remove SharePoint solutions that have been added to the server, even if they have not been deployed by using the Install-SPSolution cmdlet.SwitchParameterSwitchParameter LanguageRemoves the language pack for the specified language.The type must be a valid language identifier; for example, 1033.UInt32UInt32 WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPSolution cmdlet deletes a SharePoint solution from a farm. Before you use this cmdlet, you must use the Uninstall-SPSolution cmdlet to retract the solution files from the front-end Web server.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Remove-SPSolution -Identity contoso_solution.wspThis example removes the SharePoint solution contoso_solution.wsp.Get-SPSolutionAdd-SPSolutionUpdate-SPSolutionUninstall-SPSolutionInstall-SPSolution Remove-SPSolution Remove-SPSolutionDeploymentLockRemoves the solution deployment lock for a server.RemoveSPSolutionDeploymentLockRemove-SPSolutionDeploymentLockIdentitySPServerPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the server for which the solution deployment lock is to be removed.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; the IP address of a server computer, in the form 208.77.188.166; a valid name of a SQL Server host service (for example, SQLServerHost1); or an instance of a valid SPServer object.SPServerPipeBindSPServerPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPSolutionDeploymentLock cmdlet removes the solution deployment lock for a server. If the Identity parameter is not specified, this cmdlet removes the solution deployment lock for all servers in the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Remove-SPSolutionDeploymentLockThis example removes the solution deployment lock for all servers in the farm.Remove-SPSolutionGet-SPSolutionAdd-SPSolutionUpdate-SPSolutionUninstall-SPSolutionInstall-SPSolution Remove-SPSolutionDeploymentLock Set-SPWorkflowConfigConfigures the workflow settings for the specified Web application.SetSPWorkflowConfigSet-SPWorkflowConfigWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionDeclarativeWorkflowsEnabled$true | $falseEmailNoPermissionParticipantsEnabled$true | $falseSendDocumentToExternalParticipants$true | $falseSet-SPWorkflowConfigSiteCollectionSPSitePipeBindAssignmentCollectionSPAssignmentCollectionDeclarativeWorkflowsEnabled$true | $falseEmailNoPermissionParticipantsEnabled$true | $falseSendDocumentToExternalParticipants$true | $falseSiteCollectionSpecifies the name or URL of the site collection.The only other parameter that is used with the SiteCollection parameter is the DeclarativeWorkflowsEnabled parameter. No other parameters are used. SPSitePipeBindSPSitePipeBind WebApplicationSpecifies the name or URL of the Web application.The type must be a valid name or GUID, in the form WebApplication-1212, or a URL, in the form http://server_name/WebApplication-1212.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersDeclarativeWorkflowsEnabledSets whether declarative workflows are allowed to run in the Web application.The type must be either 1 for True or 0 for False .$true | $false$true | $false EmailNoPermissionParticipantsEnabledSets whether workflows send task e-mail messages to users who do not have permissions to the site in which the workflows are running.The type must be either 1 for True or 0 for False .$true | $false$true | $false SendDocumentToExternalParticipantsSets whether workflows automatically send a copy of the document as an e-mail attachment to participants who do not have access to the site or who are not in any linked directory other than Active Directory Domain Services (AD DS).The type must be either 1 for True or 0 for False .$true | $false$true | $false WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersUse the Set-SPWorkflowConfig cmdlet to configure the workflow settings for the specified Web application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Set-SPWorkflowConfig -webapplication http://sitename DeclarativeWorkflowsEnabled $true -EmailNoPermissionParticipantsEnabled $true -SendDocumentToExternalParticipants $falseThis example sets the workflow settings for the specified Web application to turn on declarative workflows, turn on e-mail to participants who do not have permissions to the site, and turn off the functionality to send e-mail messages as attachments to external participants.No return values. Use the Get-SPWorkflowConfig cmdlet to see values. To set farm-level workflow settings for event-delivery time-out and to postpone threshold and batch size, use Set-SPFarmConfig. Get-SPWorkflowConfig Set-SPWorkflowConfig Get-SPSolutionReturns a specified SharePoint solution.GetSPSolutionGet-SPSolutionIdentitySPSolutionPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the SharePoint solution to get.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object.SPSolutionPipeBindSPSolutionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPSolution cmdlet returns a specified SharePoint solution. If the Identity parameter is not specified, this cmdlet returns the collection of all installed SharePoint solutions in the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Get-SPSolutionThis example returns the collection of all installed SharePoint solutions in the farm.Get-SPSolutionAdd-SPSolutionUpdate-SPSolutionUninstall-SPSolutionRemove-SPSolutionInstall-SPSolutionRemove-SPSolutionDeploymentLock Get-SPSolution Import-SPBusinessDataCatalogModelImports a Business Data Connectivity Model.ImportSPBusinessDataCatalogModelImport-SPBusinessDataCatalogModelIdentityMetadataObjectPathStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterLocalizedNamesIncludedSwitchParameterModelsIncludedSwitchParameterPermissionsIncludedSwitchParameterPropertiesIncludedSwitchParameterSettingIdStringWhatIfSwitchParameterIdentitySpecifies the Business Data Connectivity Metadata Store metadata object to import to.MetadataObjectMetadataObject PathSpecifies the path and name to use.The type must be a valid path in either of the following forms:- C:\folder_name\file.bdcm- \\server_name\folder_name\file.bdcm- …\folder_name\file.bdcmStringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceOverwrites the Business Data Connectivity Model if the file exists.SwitchParameterSwitchParameter LocalizedNamesIncludedSpecifies that names for business data fields in multiple languages are imported.SwitchParameterSwitchParameter ModelsIncludedSpecifies that models are included in the imported Business Data Connectivity Model file. A model contains the base XML metadata for a system.SwitchParameterSwitchParameter PermissionsIncludedSpecifies that permissions from the Business Data Connectivity Model are imported.SwitchParameterSwitchParameter PropertiesIncludedSpecifies that properties from the Business Data Connectivity Model are imported.SwitchParameterSwitchParameter SettingIdSpecifies the custom environment settings model slice to import.The type must be a valid string that identifies a model slice; for example, ModelSlice1.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Import-SPBusinessDataCatalogModel cmdlet imports a Business Data Connectivity Model. There are two types of Business Data Connectivity models: Model type (.bdcm) and Resource type (.bdcr). The Model type contains the base XML metadata, and can also include resource properties. The Resource type includes only resource properties.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$MetadataStore = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Catalog" -ServiceConext http://contoso Import-SPBusinessDataCatalogModel -Path "C:\folder\model.bdcm" -Identity $MetadataStoreThis example gets the Business Data Connectivity Metadata Store and then imports a Business Data Connectivity Model of Model type to it from the path specified with the name model.Export-SPBusinessDataCatalogModelRemove-SPBusinessDataCatalogModel Import-SPBusinessDataCatalogModel Dismount-SPContentDatabaseDetaches a content database from its currently associated Web application.DismountSPContentDatabaseDismount-SPContentDatabaseIdentitySPContentDatabasePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the content database to detach.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object.SPContentDatabasePipeBindSPContentDatabasePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Use the Dismount-SPContentDatabase cmdlet to detatch the given content database from its currently associated Web application. This cmdlet will not delete the content database. Use the Remove-SPContentDatabase cmdlet to delete a content database.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE 1------------ C:\PS>Dismount-SPContentDatabase 12345678-90ab-cdef-1234-567890abcdefThis example detaches the content database with the GUID 12345678-90ab-cdef-1234-567890abcdef from its current parent Web application.--------------EXAMPLE 2------------ C:\PS>Get-SPContentDatabase -WebApplication http://sitename | Dismount-SPContentDatabase -WhatIfThis example detaches all content databases from the Web application on port 80 of the local machine. Remove the WhatIf parameter to perform the operation.Get-SPContentDatabaseSet-SPContentDatabaseNew-SPContentDatabaseRemove-SPContentDatabaseMount-SPContentDatabaseTest-SPContentDatabaseInitialize-SPContentDatabase Dismount-SPContentDatabase Set-SPCustomLayoutsPageMaps a new path for a custom layout page.SetSPCustomLayoutsPageSet-SPCustomLayoutsPageIdentityNone | AccessDenied | Confirmation | Error | Login | RequestAccess | Signout | WebDeletedRelativePathStringWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterSet-SPCustomLayoutsPageIdentityNone | AccessDenied | Confirmation | Error | Login | RequestAccess | Signout | WebDeletedResetSwitchParameterWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the custom layout page to set.The type must be one of the following: None, AccessDenied, Confirmation, Error, Login, RequestAccess, Signout, or WebDeleted.None | AccessDenied | Confirmation | Error | Login | RequestAccess | Signout | WebDeletedNone | AccessDenied | Confirmation | Error | Login | RequestAccess | Signout | WebDeleted RelativePathSpecifies the path of the custom layout page.The type must be a valid path of a layout page, in the form _layouts/custompages/myaccessdenied.aspx.StringString ResetResets the mapping of a custom layouts page.SwitchParameterSwitchParameter WebApplicationSpecifies the SharePoint Web application that contains the custom layout page.The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPCustomLayoutsPage cmdlet maps a new path for a custom layouts page in a Web application. To remove the mapping for a custom layouts page, use the Reset parameter instead of the RelativePath parameter.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Set-SPCustomLayoutsPage -Identity "_layouts/accessdenied.aspx" -RelativePath "/_layouts/custompages/myaccessdenied.aspx" -WebApplication "http://server_name/mywebapp"This example maps the specified path for the AccessDenied layout page in the Web application "http://server_name/mywebapp".Get-SPCustomLayoutsPage Set-SPCustomLayoutsPage Set-SPServiceApplicationSecurityUpdates the SPObjectSecurity object for a service application.SetSPServiceApplicationSecuritySet-SPServiceApplicationSecurityIdentitySPServiceApplicationPipeBindObjectSecuritySPObjectSecurityAdminSwitchParameterAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the service application that contains the SPObjectSecurity object to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application (for example, ServiceApp1); or an instance of a valid SPServiceApplication object.SPServiceApplicationPipeBindSPServiceApplicationPipeBind ObjectSecuritySpecifies the SPObjectSecurity object to update.SPObjectSecuritySPObjectSecurity AdminUpdates the access control list (ACL) that contains the administrators list of the service application.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Set-SPServiceApplicationSecurity cmdlet updates a security object for the specified service application. Use this cmdlet with the Grant-SPObjectSecurity and Get-SPServiceApplicationSecurity cmdlets to manage security for a service application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$security = Get-SPServiceApplicationSecurity $serviceApp -Admin Grant-SPObjectSecurity $security $principal "Full Control" Set-SPServiceApplicationSecurity $serviceApp -Admin $securityThis example retrieves the SPObjectSecurity object corresponding to the administrator ACL on a service application, and adds a new user principal to that ACL. The new user is an administrator for the service application $serviceApp.Get-SPServiceApplicationSecurityGrant-SPObjectSecurityRevoke-SPObjectSecurity Set-SPServiceApplicationSecurity Disable-SPTimerJobDisables a timer job.DisableSPTimerJobDisable-SPTimerJobIdentitySPTimerJobPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the timer job to disable.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object.SPTimerJobPipeBindSPTimerJobPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Disable-SPTimerJob cmdlet disables a timer job.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------------EXAMPLE----------------------- C:\PS>Get-SPTimerJob job-ceip-datacollection | Disable-SPTimerJobThis example disables the timer job named job-ceip-datacollection.Get-SPTimerJobEnable-SPTimerJobSet-SPTimerJobStart-SPTimerJob Disable-SPTimerJob Restore-SPFarmRestores one or more items from a backup.RestoreSPFarmRestore-SPFarmDirectoryStringRestoreMethodStringAssignmentCollectionSPAssignmentCollectionBackupIdGuidConfigurationOnlySwitchParameterConfirmSwitchParameterFarmCredentialsPSCredentialForceSwitchParameterItemStringNewDatabaseServerStringPercentageInt32RestoreThreadsInt32WhatIfSwitchParameterRestore-SPFarmDirectoryStringShowTreeSwitchParameterAssignmentCollectionSPAssignmentCollectionBackupIdGuidConfigurationOnlySwitchParameterConfirmSwitchParameterItemStringWhatIfSwitchParameterDirectorySpecifies the path where SharePoint 2010 Products stored the backup package. If you have a computer on which Microsoft SQL Server 2008 and an instance of SharePoint 2010 Products are installed, you can use local drive paths. This includes a basic installation. However, if SQL Server 2008 and SharePoint 2010 Products are installed on multiple computers, you must use Universal Naming Convention (UNC) share paths so that the SQL Server 2008 and SharePoint 2010 Products can read from the same location (for example, \\computer_name \volume\Backup).The type must be either of the valid paths:- C:\ folder_name- \\ server_name\folder_nameThe spbr* folders are created automatically.StringString RestoreMethodSpecifies the method of restore to perform.The valid values are: - New; Specifies a new location to restore the content and is intended to be used when restoring to a different farm. Additional prompts will be presented to specify the new settings.- Overwrite; Restores content and settings to their original locations and is intended to be used when restoring to the same farm it was backed up from. If the Overwrite parameter is used, a confirmation prompt is displayed. If you want the confirmation prompt suppressed, use the Force parameter.StringString ShowTreeDisplays which objects in the farm will be restored based on the other parameters passed to the Restore-SPFarm cmdlet namely the Item and ConfigurationOnly parameters. Items that will be excluded from the restore based on the other parameters passed to the Restore-SPFarm cmdlet will be preceded with an asterisk (*). Items that cannot be restored will be enclosed in square brackets ([ ]). A restore operation will not be performed if the ShowTree parameter is present. SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection BackupIdSpecifies the GUID of the backup package that is to be restored. Each backup package has a unique GUID associated with it. The GUID can be seen by using the Get-SPBackupHistory cmdlet to view the backup history. If this parameter is not specified, the most recent backup package in the path that is specified with the Directory parameter is used.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef.GuidGuid ConfigurationOnlySpecifies settings only (no data) will be restored from the backup package and applied to objects on the destination farm.SwitchParameterSwitchParameter ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter FarmCredentialsSpecifies the credentials that will be used for all components being restored. For example, the application pool credentials for Web applications being restored. If an application pool being restored already exists in the farm, the credentials specified by the FarmCredentials parameter is ignored when restoring that application pool.PSCredentialPSCredential ForceSuppresses the prompt warning that you will overwrite components when you perform an overwrite restore operation.SwitchParameterSwitchParameter ItemIndicates the part of the backup package to be restored. You can use the full farm path notation as displayed by the ShowTree parameter or the name of the target component in the path if it has a unique name. If multiple items match the name, the full path must be provided. Surround the item or path in double quotation marks if it contains a space. If this parameter is absent, the entire backup package is restored.The type must be a valid item, such as:Farm\Microsoft SharePoint Foundation Web Application\SharePoint - 80StringString NewDatabaseServerSpecifies a valid SQL Database Server name. If specified, will be used as a default Database Server name for all databases within the restore operation.This parameter is only valid when restoring as new. It is not valid for overwrite restores.StringString PercentageRequests that progress updates about the restore operation be displayed in increments of that percentage. For example, a value of 5 displays restore progress updates at every 5 percent completed, and a value of 10 displays restore progress updates at every 10 percent completed.Note: Progress will only be displayed in the output if the -Verbose parameter is specified. Otherwise, you may see the progress in the restore log file.This percentage is not precise and the actual progress updates might be lower or higher than requested.For a very large database, 1 is the recommended value.The type must be an integer value between 1 and 100.The default value is 5.Int32Int32 RestoreThreadsThe number of threads that should be used during the restore.The fewer the restore threads, the easier it is to understand the restore log. However, the more restore threads, the more components can be restored in parallel, potentially resulting in a faster restore.The valid range is between 1 and 10. The default value is 3.Int32Int32 WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Restore-SPFarm cmdlet restores one or more items from a backup such as an individual database, Web application, or the entire farm. This cmdlet can also be used to apply a farm template to the entire farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------EXAMPLE 1----------------------- C:\PS>Restore-SPFarm -Directory \\file_server\share\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -RestoreMethod new -ConfigurationOnlyThis example restores the configuration settings from the backup package in the \\file_server\share\Backup directory to the farm.-------------------EXAMPLE 2----------------------- C:\PS>Restore-SPFarm -ShowTree -Directory \\file_server\share\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -Item "Microsoft SharePoint Foundation Web Application" -VerboseThis example show which components of the farm would be restored under the Microsoft SharePoint Foundation Web Application node, but does not actually restore them.-------------------EXAMPLE 3----------------------- C:\PS>Restore-SPFarm -Directory C:\Backup -BackupId 12345678-90ab-cdef-1234-567890abcdef -RestoreMethod overwrite -RestoreThreads 10 -ForceThis example restores a farm by using 10 threads and suppresses the overwrite warning.Backup-SPFarmBackup-SPConfigurationDatabaseGet-SPBackupHistory Restore-SPFarm Restore-SPSiteRestores a site collection.RestoreSPSiteRestore-SPSiteIdentityStringPathStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterContentDatabaseSPContentDatabasePipeBindForceSwitchParameterGradualDeleteSwitchParameterHostHeaderWebApplicationStringWhatIfSwitchParameterRestore-SPSiteIdentityStringPathStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDatabaseNameStringDatabaseServerStringForceSwitchParameterGradualDeleteSwitchParameterHostHeaderWebApplicationStringWhatIfSwitchParameterIdentity Specifies the URL location to which the site collection is restored. A site collection does not have to already exist at the URL location to perform a restore. However, you must specify a valid URL location that a site collection can be created. If a site collection already exists at the specified URL location, you must specify the Force parameter to overwrite it.The type must be a valid URL, in the form http://server_name/sites/site_name.StringString PathSpecifies a valid path to the location of the backup. For example, C:\Backup\site_name.bak.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ContentDatabaseSpecifies the SQL Server content database where the site collection data will be stored. If no content database is specified, the content database with the greatest unused site collection capacity and whose database status is ready will be used. SPContentDatabasePipeBindSPContentDatabasePipeBind DatabaseName Specifies the SQL Server content database where the site collection data will be stored. If no content database is specified, the content database with the greatest unused site collection capacity and whose database status is ready will be used.The type must be a valid database name, in the form SQLDB1.StringString DatabaseServer Specifies the name of the SQL Server containing the content database specified by the DatabaseName parameter.The type must be a valid database server name, in the form SQLBE1 and needs to be used in conjunction with the DatabaseName parameter.StringString Force Specifies that the existing site collection at the URL location is to be overwritten by this restoration.SwitchParameterSwitchParameter GradualDelete Specifies that the site collection being overwritten with the Force parameter should be gradually deleted over time by a timer job instead of all at once, which reduces its impact on SharePoint 2010 Products and SQL Server performance. This option is recommended for large site collections.SwitchParameterSwitchParameter HostHeaderWebApplicationA valid URL assigned to the Web application by using alternate access mapping, such as http://server_name Restores a site collection as a host-named site collection instead of a path-based site collection. When the HostHeaderWebApplication parameter is present, the value of the Identity parameter is the URL of the host-named site collection and the value of the HostHeaderWebApplication parameter is the URL of the Web application that will hold the host-named site collection.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Restore-SPSite cmdlet performs a restoration of the site collection to a location specified by the Identity parameter. A content database may only contain one copy of a site collection. If a site collection is backed up and restored to a different URL location within the same Web application, an additional content database must be available to hold the restored copy of the site collection.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ----------------------EXAMPLE 1---------------------- C:\PS>Restore-SPSite http://server_name/sites/site_name -Path C:\Backup\site_name.bakThis example restores a site collection from the backup file C:\Backup\site_name.bak to the site collection URL http://server_name/sites/site_name.----------------------EXAMPLE 2---------------------- C:\PS>Restore-SPSite http://server_name/sites/site_name -Path C:\Backup\site_name.bak -Force -DatabaseServer SQLBE1 -DatabaseName SQLDB1This example restores a site collection backup from the backup file C:\Backup\site_name.bak, but overwrites the existing site collection at http://server_name/sites/site_name while specifying that the site collection must be stored in a specific content database.----------------------EXAMPLE 3---------------------- C:\PS>Restore-SPSite http://www.example.com -Path \\file_server\share\site_name.bak -HostHeaderWebApplication http://server_name This example restores a site collection backup from the backup file \\file_server\share\site_name.bak to the host-named site collection http://www.example.com on the Web application http://server_name.Backup-SPSiteGet-SPSiteMove-SPSiteNew-SPSiteRemove-SPSiteSet-SPSite Restore-SPSite Get-SPHelpCollectionReturns Help collection files.GetSPHelpCollectionGet-SPHelpCollectionAssignmentCollectionSPAssignmentCollectionNameStringAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection NameSpecifies the name of the Help collection files to get.The type must be a valid name of a Help collection folder; for example, HelpDocs1.StringString The Get-SPHelpCollection cmdlet reads the specified Help collection files. If the Name parameter is not specified, this cmdlet returns all installed Help collection files.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Get-SPHelpCollectionThis example gets all installed Help collection files.Install-SPHelpCollectionUninstall-SPHelpCollection Get-SPHelpCollection Set-SPTrustedIdentityTokenIssuerSets the identity providers of a Web application.SetSPTrustedIdentityTokenIssuerSet-SPTrustedIdentityTokenIssuerIdentitySPTrustedIdentityTokenIssuerPipeBindAssignmentCollectionSPAssignmentCollectionClaimProviderSPClaimProviderPipeBindClaimsMappingsSPClaimMappingPipeBind[]DescriptionStringImportTrustCertificateX509Certificate2RealmStringSignInUrlStringUseWReplySwitchParameterIdentitySpecifies the identity provider to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, LiveID STS); or an instance of a valid SPIdentityProvider object.SPTrustedIdentityTokenIssuerPipeBindSPTrustedIdentityTokenIssuerPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ClaimProviderSpecifies the IP STS that can resolve and search claims for claims people picker.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim provider (for example, MyIDprovider1); or an instance of a valid SPClaimProvider object.SPClaimProviderPipeBindSPClaimProviderPipeBind ClaimsMappingsSpecifies the mapping of the claims from the original token to the SharePoint token.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, Email); or an instance of a valid SPClaimMapping object.SPClaimMappingPipeBind[]SPClaimMappingPipeBind[] DescriptionSpecifies a description for the new identity provider.The type must be a valid string; for example, LiveID STS.StringString ImportTrustCertificateSpecifies the X.509 certificate object from trusted authentication provider farm.The type must be a name of a valid X.509 certificate; for example, Certificate1.X509Certificate2X509Certificate2 RealmSpecifies the realm, or resource partition, associated with this trust.The type must be a name of a valid realm; for example, MD_REALM.StringString SignInUrlSpecifies the sign-in URLs for this trusted identity provider STS.The type must be a valid URL, in the form http://int.live.com/.StringString UseWReplyIncludes a WReply with the token request. Wreply is a URL at the relying party to which the requestor is redirected once sign-out processing is complete.SwitchParameterSwitchParameter The Set-SPTrustedIdentityTokenIssuer cmdlet sets the identity providers of a Web application or extended Web application. For the ASP.NET Membership provider and Role provider, this cmdlet changes the identity provider only if the result is piped to a variable and passed to a Web application. For security token service (STS) identity providers, this cmdlet changes the persisted identity provider object in the SPFarm object.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------------EXAMPLE 1---------------------- C:\PS>Set-SPTrustedIdentityTokenIssuer "LiveIDSTS" -Certificate (Get-ChildItem"cert:Certificates (LocalComputer)\Personal\Certificates -Name "LiveID Cert")This example sets the identity provider to LiveIDSTS.-------------------------EXAMPLE 2---------------------- C:\PS>$ip = @( (Get-SPTrustedIdentityTokenIssuer "LiveID STS"), (New-SPTrustedIdentityTokenIssuer -ASPNetMembershipProvider "myMembershipProvider" -ASPNetRoleProvider "myRoleProvider"), (Get-SPTrustedIdentityTokenIssuer "NTLM")) ) New-SPWebApplication http://contoso.com -IdentityProvider $ipThis example sets the identity provider using the .ASPNetMembership and Role parameters. When these parameters are used, a variable must be set; otherwise, the values do not take effect.Get-SPTrustedIdentityTokenIssuerNew-SPTrustedIdentityTokenIssuerRemove-SPTrustedIdentityTokenIssuer Set-SPTrustedIdentityTokenIssuer Get-SPServiceHostConfigReturns the common Web service settings.GetSPServiceHostConfigGet-SPServiceHostConfigAssignmentCollectionSPAssignmentCollectionDefaultSwitchParameterAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection DefaultThis parameter has no effect.SwitchParameterSwitchParameter The Get-SPServiceHostConfig returns the common Web service settings.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE------------------- C:\PS>Get- SPServiceHostConfigThis example displays the Web service settings.Set-SPServiceHostConfig Get-SPServiceHostConfig Grant-SPBusinessDataCatalogMetadataObjectGrants a right to a principal for the specified Business Data Connectivity Metadata Store metadata object.GrantSPBusinessDataCatalogMetadataObjectGrant-SPBusinessDataCatalogMetadataObjectIdentityMetadataObjectPrincipalSPClaimRightExecute | Edit | SetPermissions | SelectableInClientsAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterSettingIdStringWhatIfSwitchParameterIdentitySpecifies the Business Data Connectivity Metadata Store metadata object that contains the principal.MetadataObjectMetadataObject PrincipalSpecifies the principal to whom the rights apply.The type must be a claim.SPClaimSPClaim RightSpecifies the right to grant the principal.The type must be one of the following valid PSBdcRight object types: All, Execute, Edit, SetPermissions, or SelectableInClients.Execute | Edit | SetPermissions | SelectableInClientsExecute | Edit | SetPermissions | SelectableInClients AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter SettingIdSpecifies the model slice for which to grant the right.The type must be a valid string that identifies a model slice; for example, ModelSlice1.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Grant-SPBusinessDataCatalogMetadataObject cmdlet grants the right to a specified principal (user) for a Business Data Connectivity Metadata Store metadata object. This cmdlet checks to verify that the Identity parameter is a valid IndividuallySecurableMetadata object.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$claimJohn = New-SPClaimObject -User "CONTOSO\johndoe" -Type windowssamaccountname $Model = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Model" -ServiceContext http://contoso -Name "ContosoModel" Grant-SPBusinessDataCatalogMetadataObject -Identity $Model -Principal $claimJohn -Right EditThis example gives Edit permissions to the user with the identity johndoe on domain CONTOSO, for the model metadata object with the name ContosoModel.Set-SPBusinessDataCatalogMetadataObjectGet-SPBusinessDataCatalogMetadataObjectRevoke-SPBusinessDataCatalogMetadataObject Grant-SPBusinessDataCatalogMetadataObject Enable-SPFeatureEnables an installed SharePoint Feature at the given scope.EnableSPFeatureEnable-SPFeatureIdentitySPFeatureDefinitionPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterPassThruSwitchParameterUrlStringWhatIfSwitchParameterIdentitySpecifies the name of the Feature or GUID to uninstall.The type must be the name of the Feature folder located in the 14\Template\Features folder or GUID, in the form 21d186e1-7036-4092-a825-0eb6709e9281.SPFeatureDefinitionPipeBindSPFeatureDefinitionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceForces the activation of a Feature. This causes any custom code associated with the Feature to rerun.SwitchParameterSwitchParameter PassThruIf provided, the cmdlet outputs the Feature definition object after enable .SwitchParameterSwitchParameter UrlSpecifies the URL of the Web application, site collection, or Web site for which the Feature is being activated.The type must be a valid URL; for example, http://server_name.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Enable-SPFeature cmdlet enables an installed feature at the given scope. If the feature is a farm feature, no URL is needed. Otherwise, provide the URL where the feature is to be enabled and it will be enabled at the proper scope based on the Feature definition.This cmdlet has no output unless the PassThru parameter is provided, in which case the SPFeatureDefinition object for the newly enabled feature is returned.If you try to use the Url parameter on a farm-scoped feature, you receive the following error message: The feature '<feature name>' applies to the entire farm; the Url parameter cannot be used with farm-scoped features.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185).--------------EXAMPLE 1----------------- C:\PS>Enable-SPFeature -identity "MyCustom" -URL http://somesiteThis example enables the "MyCustom" site scoped SharePoint Feature at http://somesite.--------------EXAMPLE 2----------------- C:\PS>$w = Get-SPWeb http://somesite/myweb | ForEach{ $_.URL } C:\PS>Get-SPFeature -Web $w |%{ Enable-SPFeature -Identity $_ -URL $w}This example enables all SharePoint Features in the subsite at http://somesite/myweb.Disable-SPFeatureInstall-SPFeatureUninstall-SPFeatureGet-SPFeature Enable-SPFeature Get-SPWebReturns all subsites that match the given criteria.GetSPWebGet-SPWebIdentitySPWebPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterFilterScriptBlockLimitStringRegexSwitchParameterSiteSPSitePipeBindWhatIfSwitchParameterIdentitySpecifies the name or full or partial URL of the subsite. If you use a relative path, you must specify the Site parameter.A valid URL in the form http://server_name or a relative path in the form of /SubSites/MySubSite.SPWebPipeBindSPWebPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter FilterSpecifies the server-side filter to use for the specified scope.The type must be a valid filter in the form {filterName <operator> "filterValue"}.ScriptBlockScriptBlock LimitLimits the maximum number of subsites to return. The default value is 200. To return all sites, enter ALLThe type must be a valid number greater than 0 or ALL.StringString RegexSpecifies the URL that is provided by the Identity parameter is treated as a regular expression.SwitchParameterSwitchParameter SiteSpecifies the URL or GUID of the site collection from which to list subsites.The type must be a valid URL, in the form of http://server_name; a GUID, in the form 1234-5678-9807, or an SPSite object.SPSitePipeBindSPSitePipeBind WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Get-SPWeb cmdlet returns all subsites that match the scope given by the Identity parameter. All subsites that meet the criteria are returned.The Identity can be either the full URL or a relative path. If you specify a relative path, you must also specify the Site parameter to identify the site collection from which to return the subsite. The Identity parameter also supports providing a partial URL that ends in a wildcard character (*). All subsites that match this partial URL for the specified scope are returned. Additionally, if the Regex parameter is provided, the Identity parameter is treated as a regular expression and any subweb with a URL provided in the given scope that matches the expression is returned.The Filter parameter is a server-side filter for certain subsite properties that are stored in the content database; without the Filter parameter, filtering on these properties is a slow process. These subsite properties are Template and Title. The Filter parameter is a script block that uses the same syntax as a Where-Object statement, but is run server-side for faster results.It is important to note that every site collection returned by the Get-SPWeb cmdlet is automatically disposed of at the end of the pipeline. To store the results of Get-SPWeb in a local variable, the Start-SPAssignment and Stop-SPAssignment cmdlets must be used to avoid memory leaks.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------------EXAMPLE 1---------------------- C:\PS>Get-SPWeb -site http://sitename/sites/site1This example returns all the subwebs in a given site collection.--------------------EXAMPLE 2---------------------- C:\PS>Get-SPWeb -filter {$_.Template -eq "STS#0"}This example displays all subsites that use the "STS#0" template.--------------------EXAMPLE 3---------------------- C:\PS>Start-SPAssignment -Global C:\PS>$w = Get-SPWeb http://sitename C:\PS>$w.set_SiteLogoUrl("http://PathToImage/test.jpg") C:\PS>$w.Update() C:\PS>Stop-SPAssignment -GlobalThis example demonstrates how to save a subsite as a variable and to call object model methods on the SPAssignment object.New-SPWebSet-SPWebRemove-SPWebImport-SPWeb Get-SPWeb Upgrade-SPContentDatabaseUpgrades a content database.UpgradeSPContentDatabaseUpgrade-SPContentDatabaseIdentitySPContentDatabasePipeBindForceDeleteLockSwitchParameterAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterServerInstanceSPDatabaseServiceInstancePipeBindUpdateUserExperienceSwitchParameterWhatIfSwitchParameterUpgrade-SPContentDatabaseForceDeleteLockSwitchParameterNameStringWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterServerInstanceSPDatabaseServiceInstancePipeBindUpdateUserExperienceSwitchParameterWhatIfSwitchParameterIdentitySpecifies the content database to upgrade.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh or an instance of a valid SPContentDatabase object.SPContentDatabasePipeBindSPContentDatabasePipeBind ForceDeleteLockForces deletion of locks on the database before the upgrade starts.SwitchParameterSwitchParameter NameSpecifies the name of attached content database.StringString WebApplicationSpecifies the Web application hosting the attached content database.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ServerInstanceThe SQL Server instance hosting the attached content database.SPDatabaseServiceInstancePipeBindSPDatabaseServiceInstancePipeBind UpdateUserExperienceDetermines whether the content databases should upgrade to the latest user interface. By default, the user interface will not change during upgrade. SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Upgrade-SPContentDatabase cmdlet upgrades a SharePoint content database. When the Upgrade-SPContentDatabase cmdlet is run, an upgrade of an existing content database attached to the current farm is intiated. This cmdlet begins a new upgrade session, which can be used either to resume a failed version-to-version or build-to-build upgrade of a content database or to begin a build-to-build upgrade of a content database.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------------------EXAMPLE------------------------------ C:\PS>$contentdb = Get-SPContentDatabase | Where-Object {$_.Name -match "SQLSERVER1\WSS_Content"} C:\PS>Upgrade-SPContentDatabase -Identity $contentdbThis example selects a specific content database that is currently attached to the farm, and then initiates an upgrade session. This process continues until the upgrade is complete and might take some time, depending upon the amount of changes that have to be made during the upgrade.Dismount-SPContentDatabaseGet-SPContentDatabaseMount-SPContentDatabaseNew-SPContentDatabaseRemove-SPContentDatabaseSet-SPContentDatabaseTest-SPContentDatabaseInitialize-SPContentDatabase Upgrade-SPContentDatabase Get-SPBusinessDataCatalogMetadataObjectReturns a Business Data Connectivity Metadata Store metadata object.GetSPBusinessDataCatalogMetadataObjectGet-SPBusinessDataCatalogMetadataObjectBdcObjectTypeCatalog | Model | LobSystem | LobSystemInstance | EntityServiceContextSPServiceContextPipeBindAssignmentCollectionSPAssignmentCollectionContainingLobSystemStringNameStringNamespaceStringBdcObjectTypeSpecifies the type of the metadata object to return.The type must be one of the following valid metadata object types: BdcCatalog, Model, LobSystem, LobSystemInstance, or Entity.Catalog | Model | LobSystem | LobSystemInstance | EntityCatalog | Model | LobSystem | LobSystemInstance | Entity ServiceContextSpecifies the service context of the Business Data Connectivity Metadata Store metadata object to return.SPServiceContextPipeBindSPServiceContextPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection NameSpecifies the name of the metadata object.StringString NamespaceSpecifies the namespace of the metadata object.StringString The Get-SPBusinessDataCatalogMetadataObject cmdlet reads a Business Data Connectivity Metadata Store metadata object from a Business Data Connectivity Service application. Output for this cmdlet can be a series of objects. For example, you can specify a wildcard character (*) for the BdcObjectType parameter to return all metadata objects except Catalog and LobSystemInstance.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$Model = Get-SPBusinessDataCatalogMetadataObject -BdcObjectType "Model" -Name "ContosoModel" -ServiceConext http://contosoThis example gets a metadata object of type Model with the name ContosoModel from the Business Data Connectivity Metadata Store on the given site.Set-SPBusinessDataCatalogMetadataObjectGrant-SPBusinessDataCatalogMetadataObjectRevoke-SPBusinessDataCatalogMetadataObject Get-SPBusinessDataCatalogMetadataObject Add-SPClaimTypeMappingAdds a claim mapping to a trusted security token service (STS) identity provider.AddSPClaimTypeMappingAdd-SPClaimTypeMappingIdentitySPClaimMappingPipeBindTrustedIdentityTokenIssuerSPTrustedIdentityTokenIssuerPipeBindAssignmentCollectionSPAssignmentCollectionForceSwitchParameterIdentitySpecifies the STS for the farm that will issue the security token for the identity provider.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, ClaimMap1); or an instance of a valid SPClaimMapping object.SPClaimMappingPipeBindSPClaimMappingPipeBind TrustedIdentityTokenIssuerSpecifies the farm trust Token Issuer (STS authentication provider).The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of an authentication provider (for example, MyIDprovider1); or an instance of a valid SPTrustedIdentityTokenIssuer object.SPTrustedIdentityTokenIssuerPipeBindSPTrustedIdentityTokenIssuerPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ForceOverwrites the claim mapping rule if it exists.SwitchParameterSwitchParameter The Add-SPClaimTypeMapping cmdlet adds a claim type mapping rule to a security token service (STS) identity provider from a farm trust STS authentication provider.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Get-SPTrustedIdentityProvider -Name "LiveIDSTS" | Add-SPClaimTypeMapping -IncomingClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier" -IncomingClaimTypeDisplayName "PUID" -LocalClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/thumbprint"This example adds a claim mapping to a trusted identity token issuer.New-SPClaimTypeMappingRemove-SPClaimTypeMapping Add-SPClaimTypeMapping Publish-SPServiceApplicationShares the specified local service application outside the farm.PublishSPServiceApplicationPublish-SPServiceApplicationIdentitySPServiceApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDescriptionStringInfoLinkUriWhatIfSwitchParameterIdentitySpecifies the GUID of the service application to share outside the farm.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh.SPServiceApplicationPipeBindSPServiceApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DescriptionDescribes the service application to share outside the farm. If no value is specified, the value is left blank.StringString InfoLinkSpecifies the link to more information about the service application to share outside the farm. If no link is specified, no link is made available.The type must be a valid URL, in the form http://server_name/Site_Name/page_name.UriUri WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Publish-SPServiceApplication cmdlet publishes the local service application, specified by the Identity parameter, outside the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Publish-SPServiceApplication 053c34be-d251-488c-8e94-644eae94da26 -Description "Connect to this TestServiceApplcation of you want to use FeatureA in your farm" -InfoLink http://testurl This example publishes a service application to another farm.The service application GUID is unique to every farm. You can run the Get-SPServiceApplication cmdlet to see the GUID of the service applications, and then use the result from the Get-SPServiceApplication cmdlet for other SPServiceApplication cmdlets; for example, Grant-SPServiceApplication.Get-SPServiceApplicationSet-SPServiceApplicationRemove-SPServiceApplicationGrant-SPServiceApplication Publish-SPServiceApplication Get-SPSiteSubscriptionConfig Returns the configuration properties of a site subscription.GetSPSiteSubscriptionConfigGet-SPSiteSubscriptionConfigIdentitySPSiteSubscriptionPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the site subscription configuration to get.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; an SPSite (object or URL) of a site collection that is a member of the site subscription; or an instance of a valid SiteSubscription object.SPSiteSubscriptionPipeBindSPSiteSubscriptionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPSiteSubscriptionConfig cmdlet returns the configuration properties of a site subscription.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ---------------EXAMPLE--------------- C:\PS>Get-SPSiteSubscriptionConfig http://contoso.com | Select FeatureSetThis example gets the feature set ID for the site subscription that contains the Web site http://contoso.com. Get-SPSiteSubscriptionConfig Grant-SPServiceApplicationGrants a user account access to the service application.GrantSPServiceApplicationIdentitySpecifies the GUID of the service application to which to grant access.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh.UserPrincipalSpecifies the identity to grant access to the service application.The type must be a valid user principal name, in the form DOMAIN\user, or a claim, in the form CA:NTLM:Identity-username:domain\user.RightsSpecifies the rights to grant the user. By default, the following right exists - 'full' for both the admin and access types. Service applications can define their own rights.The type must be a string array with valid user rights entries.TypeSpecifies whether to grant the principal administrator rights or access rights.Either Admin or Access.AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersWhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersThe Grant-SPServiceApplication cmdlet grants the specified level of access to the specified user accounts to the specified service application with the specified permissions.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE--------------------- C:\PS>Grant-SPServiceApplication 053c34be-d251-488c-8e94-644eae94da26 -UserPrincipal testdomin\tester1 -Rights Full Control -Type AdminThis example grants Full Control administrative access to the given user principal for the selected service application.The service application GUID is unique to every farm. You can run the Get-SPServiceApplication cmdlet to see the GUID of the service applications, and then use the result from the Get-SPServiceApplication cmdlet for other SPServiceApplication cmdlets; for example, Grant-SPServiceApplication or Publish-SPServiceApplication.Set-SPServiceApplicationGet-SPServiceApplicationPublish-SPServiceApplicationRevoke-SPServiceApplicationRemove-SPServiceApplication Grant-SPServiceApplication Get-SPCustomLayoutsPageReturns a mapping to a custom layout page.GetSPCustomLayoutsPageGet-SPCustomLayoutsPageWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionIdentityNone | AccessDenied | Confirmation | Error | Login | RequestAccess | Signout | WebDeletedWebApplicationSpecifies the SharePoint Web application that contains the custom layout page.The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection IdentitySpecifies the custom layout page to get.The type must be one of the following: None, AccessDenied, Confirmation, Error, Login, RequestAccess, Signout, or WebDeleted.None | AccessDenied | Confirmation | Error | Login | RequestAccess | Signout | WebDeletedNone | AccessDenied | Confirmation | Error | Login | RequestAccess | Signout | WebDeleted The Get-SPCustomLayoutsPagecmdlet cmdlet returns a mapping to a custom layout page in a Web application. If the Identity parameter is not specified, this cmdlet returns the collection of mappings for all custom layout pages.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Get-SPCustomLayoutsPage -Identity "_layouts/accessdenied.aspx" -WebApplication "http://server_name/mywebapp"This example returns the mapping of the AccessDenied layout page in the Web application. Get-SPCustomLayoutsPage Get-SPWebPartPackReturns the Web Part packages that were installed for the specified scope.GetSPWebPartPackGet-SPWebPartPackIdentityStringAssignmentCollectionSPAssignmentCollectionGlobalOnlySwitchParameterWebApplicationSPWebApplicationPipeBindIdentitySpecifies the full or partial name of the Web Part package from the configuration database.The type must be a valid name of a Web Part package; for example, MyWebPartPackage. StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection GlobalOnlyReturns only Web Part packages that are installed in the global assembly cache (GAC).SwitchParameterSwitchParameter WebApplicationSpecifies the Web application from which to list Web Part packages. If no Web application is specified, the specified Web Part packages will be returned from all Web applications.SPWebApplicationPipeBindSPWebApplicationPipeBind The Get-SPWebPartPack cmdlet returns the installed Web Part packages that match the Identity parameter. The scope of results can be narrowed by using the optional WebApplication parameter. The scope does not include any Web Part packages installed in the global assembly cache (GAC) unless the GlobalOnly parameter is used. If this parameter is used, only Web Part packages that have been installed in the GAC are returned.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Get-SPWebPartPack -WebApplication http://zsharepoint2:80This example returns all Web Part packages that have been installed on the Web application on port 80 in local farm.Install-SPWebPartPackUninstall-SPWebPartPack Get-SPWebPartPack New-SPSubscriptionSettingsServiceApplicationCreates a new subscription settings service application.NewSPSubscriptionSettingsServiceApplicationNew-SPSubscriptionSettingsServiceApplicationApplicationPoolSPIisWebServiceApplicationPoolPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDatabaseCredentialsPSCredentialDatabaseNameStringDatabaseServerStringFailoverDatabaseServerStringNameStringWhatIfSwitchParameterApplicationPoolSpecifies the IIS application pool to use for the new subscription settings application.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an application pool (for example, AppPoolName1); or an instance of a valid IISWebServiceApplicationPool object.SPIisWebServiceApplicationPoolPipeBindSPIisWebServiceApplicationPoolPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DatabaseCredentialsSpecifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication.The type must be a valid PSCredential object.PSCredentialPSCredential DatabaseNameSpecifies the name of the subscription settings database.If not provided, one will be generated.The type must be a valid name of a SQL Server database; for example, SubscriptionSettingsApp1.StringString DatabaseServerSpecifies the name of the host SQL Server instance for the database specified in the DatabaseName parameter. If not provided, the default database server will be used The type must be a valid SQL Server instance name; for example, SQLServerHost1.The type must be a valid name of a SQL Server database; for example, SubscriptionSettingsApp1.StringString FailoverDatabaseServerSpecifies the name of the host SQL Server instance for the failover database server.The type must be a valid SQL Server instance name; for example, SQLServerHost1.StringString NameSpecifies the friendly name of the new subscription settings service.The type must be a valid name of a subscription settings service application; for example, SubscriptionSettingsApp1.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Use the New-SPSubscriptionSettingsServiceApplication cmdlet to create a subscription settings service application that can be used to store settings that are shared across all site collections in a single site subscription. This cmdlet is used only in an environment where site subscriptions are used to delegate administration or partition services that are used for storing settings that are shared across all site collections in a single site subscription. This cmdlet is used only in an environment where site subscriptions are used to delegate administration or partition services.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------EXAMPLE--------------- C:\PS>$AppPool = New-SPIisWebServiceApplicationPool -Name SettingsServiceAppPool -Account (Get-SPManagedAccount DOMAIN\jdoe) C:\PS>$App = New-SPSubscriptionSettingsServiceApplication -ApplicationPool $appPool -Name SettingsServiceApp -DatabaseName SettingsServiceDB C:\PS>$proxy = New-SPSubscriptionSettingsServiceApplicationProxy -ServiceApplication $App C:\PS>Get-SPServiceInstance | where{$_.TypeName -eq "Windows SharePoint Services Subscription Settings Service"} | Start-SPServiceInstanceThis example creates an application pool, a new subscription settings service application, a subscription settings service application proxy, and starts the service instance on the local machine. This example assumes that a managed account for DOMAIN\jdoe already exists.Set-SPSubscriptionSettingsServiceApplicationNew-SPSubscriptionSettingsServiceApplicationProxy New-SPSubscriptionSettingsServiceApplication Get-SPSiteAdministrationReturns a site administration object that allows farm administrators to view certain information about site collections to which they might not have access.GetSPSiteAdministrationGet-SPSiteAdministrationAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterFilterScriptBlockLimitStringWebApplicationSPWebApplicationPipeBindWhatIfSwitchParameterGet-SPSiteAdministrationIdentitySPSiteAdministrationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterFilterScriptBlockLimitStringRegexSwitchParameterWhatIfSwitchParameterGet-SPSiteAdministrationContentDatabaseSPContentDatabasePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterFilterScriptBlockLimitStringWhatIfSwitchParameterGet-SPSiteAdministrationSiteSubscriptionSPSiteSubscriptionPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterFilterScriptBlockLimitStringWhatIfSwitchParameterIdentitySpecifies the URL (full or partial) or GUID of the site collection to retrieve.The type must be a valid URL, in the form http://server_name, or a GUID, in the form 1234-456-987fg.SPSiteAdministrationPipeBindSPSiteAdministrationPipeBind ContentDatabaseSpecifies the URL (full or partial) or GUID of the site collection to retrieve.The type must be a valid URL, in the form http://server_name, or a GUID, in the form, 1234-456-987fg.SPContentDatabasePipeBindSPContentDatabasePipeBind SiteSubscriptionSpecifies the site group from which to get site collections.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; an SPSite (object or URL) of a site collection that is a member of the site subscription; or an instance of a valid SiteSubscription object. SPSiteSubscriptionPipeBindSPSiteSubscriptionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter FilterSpecifies the script block of the server-side filter to apply.The type must be a valid filter name and a value in the form { $_ PropertyName <operator > "filterValue"}}ScriptBlockScriptBlock LimitLimits the maximum number of site collections to return. The default value is 200.The type must be a valid non-negative number. Provide ALL to return all site collections for the given scope.StringString RegexEnabling this switch causes the URL provided for the Identity parameter to be treated as a regular expression .SwitchParameterSwitchParameter WebApplicationSpecifies the URL, GUID, or name of the Web application from which to list sites.The type must be a valid URL, in the form http://server_name; a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh); or the Web application name (for example, WebApplication1212).SPWebApplicationPipeBindSPWebApplicationPipeBind WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Get-SPSiteAdminitration cmdlet returns a site administration object that allows farm administrators to view certain information about site collections to which they might not have access.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1------------------ C:\PS>Get-SPSiteAdministration | Select -Property Url, OwnerLoginName, @{Name="Storage";Expression={$_.Quota.StorageMaximumLevel}}This example gets a subset of data from all of the sites in the content database with the URL b399a366-d899-4cff-8a9b-8c0594ee755f (farm administrator does not require access). This command uses the calculated property Storage to display the maximum storage value for the content database.------------------EXAMPLE 2------------------ C:\PS>Start-SPAssignment -Global $s = Get-SPSiteAdministration -Identity http://MyApp/Sites/Site1 $s.Url Stop-SPAssignment -GlobalThis example gets the site collections specified by the Identity parameter and inserts the results into the variable s. This example uses the Global method of garbage collection. This method is easier to use but grows quickly. Do not run a Get-SPSite command that returns many results while global assignment is on.------------------EXAMPLE 3------------------ C:\PS>$GC = Start-SPAssignment $Sites = $GC | Get-SPSiteAdministration -Filter {$_.Owner -eq "DOMAIN\JDoe"} -Limit 50 Stop-SPAssignment $GCThis example gets the first 50 sites owned by user DOMAIN\JDoe by using a server-side query, and assigns the returned sites to a local variable. This command uses advanced assignment collection methods.------------------EXAMPLE 4------------------ C:\PS>Get-SPWebApplication http://sitename | Get-SPSiteAdministration -Limit All |ForEach-Object {$sum=0}{ $sum+=$_.DiskUsed }{$sum}This command returns the sum of the disk space usage for all sites in the specified Web application.------------------EXAMPLE 5------------------ C:\PS>Get-SPWebApplication http://sitename | Get-SPSiteAdministration -Limit ALL | Select URLThis example gets the URLs for all site collections in a Web application.------------------EXAMPLE 6------------------ C:\PS>Get-SPSiteAdministration -identity "http://localserver/(my|personal)/sites" -RegexThis example returns all sites that match the given regular expression. The quotation marks around the value specified for the Identity parameter are required when using the Regex flag.------------------EXAMPLE 7------------------ C:\PS>Get-SPSite "http://sitename/sites/teams/*" -Limit 100This example gets up to 100 of the sites under the URL http://sitename/sites/teams.Set-SPSiteAdministration Get-SPSiteAdministration Install-SPFeatureInstalls a SharePoint Feature by using the Feature.xml file.InstallSPFeatureInstall-SPFeaturePathStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterWhatIfSwitchParameterInstall-SPFeatureAllExistingFeaturesSwitchParameterAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterSolutionIdStringWhatIfSwitchParameterInstall-SPFeatureScanForFeaturesSwitchParameterAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterSolutionIdStringWhatIfSwitchParameterPathSpecifies a valid file path; for example, MyFeature.Path to feature must be a literal path to the 14\Template\Features directory. Can be any standard character that the Windows system supports for a file name. The feature.xml filename is implied and does not need to be provided.If the feature file is not found on disk, the following error message is displayed: "Failed to find the XML file at location 14\Template\Features\<file path>."StringString AllExistingFeaturesScans for existing, but unregistered features, and then registers them with the farm.SwitchParameterSwitchParameter ScanForFeaturesScans and then displays a feature. The ScanForFeatures parameter does not install a feature.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceForces the installation of an already installed feature.SwitchParameterSwitchParameter SolutionIdSpecifies the solution id of the features. If the SolutionId parameter is not provided, all solution ids are scanned.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Install-SPFeature cmdlet installs a specific SPFeature object by providing in the Identity parameter the relative path from the folder "$env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\FEATURES\ to the feature. The SharePoint Feature's files must already be put in the proper directory, either manually or by using a solution installer.If the AllExistingFeatures parameter is provided, the file system is scanned and any new features are installed. This is generally only used during deployment and upgrade.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE 1----------------- C:\PS>Install-SPFeature -path "MyCustomFeature"This example installs a new feature at $env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\FEATURES\MyCustomFeature/feature.xml.--------------EXAMPLE 2----------------- C:\PS>Install-SPFeature -AllExistingFeatures -WhatifThis example shows the unregistered features, available on the file system, that are installed if this command is run without the WhatIf parameter. This is commonly done after an upgrade process.Get-SPFeatureEnable-SPFeatureDisable-SPFeatureUninstall-SPFeature Install-SPFeature Set-SPUserConfigures properties on an existing user.SetSPUserSet-SPUserIdentitySPUserPipeBindAddPermissionLevelString[]AssignmentCollectionSPAssignmentCollectionClearPermissionsSwitchParameterConfirmSwitchParameterDisplayNameStringEmailStringGroupSPGroupPipeBindIsSiteCollectionAdminSwitchParameterMobileNumberStringPassThruSwitchParameterRemovePermissionLevelString[]SyncFromADSwitchParameterWebSPWebPipeBindWhatIfSwitchParameterIdentitySpecifies the GUID, login name, or SPUser object of the user to be returned.The type must be a valid GUID of the user, in the form 1234-5678-9876-0987.SPUserPipeBindSPUserPipeBind AddPermissionLevelSpecifies the permission level to add to the user.The type must be any one of the following types: -- Contribute - Can view, add, update, and delete list items and documents.-- Design - Can view, add, update, delete, approve, and customize documents.-- Full Control - Has full control to all documents.-- Limited Access - Can view specific lists, document libraries, list items, folders, or documents when permissions are granted.-- Read - Can view pages and list items and download documents.String[]String[] AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ClearPermissionsClears all given permissions from the user. If Clear and Add values are given, the permissions are first cleared, then the new permissions are given.SwitchParameterSwitchParameter ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DisplayNameSpecifies the new display name of the user.The type must be a valid name.StringString EmailSpecifies the new e-mail address of the user.StringString GroupAdds the user to the specified named group of the given site.SPGroupPipeBindSPGroupPipeBind IsSiteCollectionAdminSpecifies whether to set the user as a site collection administrator.SwitchParameterSwitchParameter MobileNumberSets the new mobile number for the user.StringString PassThruIf not provided, indicates that this cmdlet has no output. If provided, this parameter indicates that the SPUser object for this user is to be returned.SwitchParameterSwitchParameter RemovePermissionLevelRemoves the permission level from the user.String[]String[] SyncFromADIf provided, specifies that user information will be synchronized from the user directory store .SwitchParameterSwitchParameter WebSpecifies the name of the URL or GUID to be used as a scope. This parameter is not needed if the SPUser object is provided as the identity.The type must be a valid URL, in the form http://server_name, or GUID, in the form 1234-5678-9807.SPWebPipeBindSPWebPipeBind WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPUser cmdlet configures properties on an existing user.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Set-SPUser -Identity 'Contoso\jdoe' -Web http://test -AddPermissionLevel "Contributor"This example sets a user (Contoso\jdoe) to be a contributor on http://test.Get-SPUserNew-SPUserRemove-SPUserMove-SPUser Set-SPUser Get-SPContentDatabaseReturns one or more content databases.GetSPContentDatabaseGet-SPContentDatabaseIdentitySPContentDatabasePipeBindAssignmentCollectionSPAssignmentCollectionGet-SPContentDatabaseWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionGet-SPContentDatabaseSiteSPSitePipeBindAssignmentCollectionSPAssignmentCollectionGet-SPContentDatabaseConnectAsUnattachedDatabaseSwitchParameterDatabaseNameStringDatabaseServerStringAssignmentCollectionSPAssignmentCollectionDatabaseCredentialsPSCredentialIdentitySpecifies a specific content database to get.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object.SPContentDatabasePipeBindSPContentDatabasePipeBind SiteReturns the content database for the specified site collection.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object.SPSitePipeBindSPSitePipeBind WebApplicationReturns the content databases for the specified Web application.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConnectAsUnattachedDatabaseSpecifies that only unattached databases in the farm are returned.SwitchParameterSwitchParameter The Get-SPContentDatabase cmdlet returns the specified content databases.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ----------------EXAMPLE 1------------ C:\PS>Get-SPContentDatabase -webapplication http://sitenameThis example returns all content databases used by the sitename Web application.----------------EXAMPLE 2------------ C:\PS>Get-SPContentDatabase -site http://contoso.comThis example returns the content database that contains the site collection at http://contoso.com.Set-SPContentDatabaseNew-SPContentDatabaseRemove-SPContentDatabaseMount-SPContentDatabaseTest-SPContentDatabaseUpgrade-SPContentDatabaseInitialize-SPContentDatabase Get-SPContentDatabase Get-SPTrustedIdentityTokenIssuerReturns an identity provider.GetSPTrustedIdentityTokenIssuerGet-SPTrustedIdentityTokenIssuerIdentitySPTrustedIdentityTokenIssuerPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the identity provider to get.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, LiveID STS); or an instance of a valid SPIdentityProvider object.SPTrustedIdentityTokenIssuerPipeBindSPTrustedIdentityTokenIssuerPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPTrustedIdentityTokenIssuer cmdlet returns an identity provider.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------------------EXAMPLE 1------------------------ C:\PS>$trustedsts = get - SPTrustedIdentityTokenIssuer "LiveIDSTS"This example gets a trusted identity token issuer.Set-SPTrustedIdentityTokenIssuerNew-SPTrustedIdentityTokenIssuerRemove-SPTrustedIdentityTokenIssuer Get-SPTrustedIdentityTokenIssuer Get-SPShellAdminReturns the names of all users who have the SharePoint_Shell_Access role.GetSPShellAdminGet-SPShellAdmindatabaseSPDatabasePipeBindAssignmentCollectionSPAssignmentCollectiondatabaseSpecifies the name of the database that includes the SharePoint_Shell_Access role whose user names you want to display. If the database parameter is not specified, the configuration database is used.SPDatabasePipeBindSPDatabasePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection Use the Get-SPShellAdmin cmdlet to return the names of all users who have the SharePoint_Shell_Access role in a database.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------------EXAMPLE---------------------- C:\PS>Get-SPShellAdmin -database WSS_ContentThis example returns the name of each user who has the SharePoint_Shell_Access role in the WSS_Content database.Add-SPShellAdminRemove-SPShellAdmin Get-SPShellAdmin New-SPManagedAccountRegisters a new managed account.NewSPManagedAccountNew-SPManagedAccountCredentialPSCredentialAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterCredentialIndicates the Credential object that specifies the credentials of the new managed account. If you use Credential, you cannot specify Username and Password.PSCredentialPSCredential PasswordSpecifies the password for the user specified in Username. If you use Credential, you cannot specify Username and Password.UsernameSpecifies the user name of the new managed account. If you use Credential, you cannot specify Username and Password.The type must be a valid user name, in the form domain\username.AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The New-SPManagedAccount cmdlet registers a new managed account for the specified Credential or Username, and Password.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>$cred = Get-Credential C:\PS>New-SPManagedAccount -Credential $credThis example adds a new managed account to the farm by using credentials that are prompted.Get-SPManagedAccountSet-SPManagedAccountRemove-SPManagedAccount New-SPManagedAccount Set-SPCentralAdministrationSets the port for the SharePoint Central Administration Web site.SetSPCentralAdministrationSet-SPCentralAdministrationPortInt32AssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterPortSpecifies the administration port for the Central Administration site. The type must be a valid port number; for example, 8080.Int32Int32 AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPCentralAdministration cmdlet sets the port for the Central Administration site.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Set-SPCentralAdministration -Port 8282This example sets the port for the Central Administration web application on the local farm to 8282.New-SPCentralAdministration Set-SPCentralAdministration Start-SPAdminJobImmediately starts any waiting administrative job on the local computer.StartSPAdminJobStart-SPAdminJobAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Use the Start-SPAdminJob cmdlet to execute all administrative timer jobs immediately rather than waiting for the timer job to run.When the process account for the SharePoint 2010 Administration service (SPAdminV4)) is disabled (necessary in some installations for security reasons), the Start-SPAdminJob cmdlet must be run on all computers to perform provisioning and other administrative tasks that SPAdmin ordinarily handles.When you run this cmdlet in person (not in script), use the Verbose parameter to see the individual administrative operations that are run.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). none------------------EXAMPLE----------------------- C:\PS>Start-SPAdminJob -VerboseThis example runs all waiting administrative jobs and shows verbose output to the administrator.Get-SPTimerJobSet-SPTimerJobEnable-SPTimerJobDisable-SPTimerJob Start-SPAdminJob Get-SPWebApplicationHttpThrottlingMonitorReturns all counters and their associated Health Score bucket values for network throttling on a Web application.GetSPWebApplicationHttpThrottlingMonitorGet-SPWebApplicationHttpThrottlingMonitorIdentitySPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionIdentityReturns throttling performance counter settings for the specified SharePoint Web application.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPWebApplicationHttpThrottlingMonitor cmdlet reads all counters for network throttling on a Web application. This cmdlet returns a list that contains all of the performance counters and their associated Health Score bucket values.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$s = get-SPWebApplicationHTTPThrottlingMonitors http://sharepoint This example gets all performance counters that are being read in the network throttling monitor for the http://sharepoint Web application.Set-SPWebApplicationHttpThrottlingMonitorEnable-SPWebApplicationHttpThrottlingDisable-SPWebApplicationHttpThrottling Get-SPWebApplicationHttpThrottlingMonitor Get-SPManagedAccountRetrieves accounts registered in the configuration database.GetSPManagedAccountGet-SPManagedAccountIdentitySPManagedAccountPipeBindAssignmentCollectionSPAssignmentCollectionServiceSPServicePipeBindGet-SPManagedAccountIdentitySPManagedAccountPipeBindAssignmentCollectionSPAssignmentCollectionWebApplicationSPWebApplicationPipeBindGet-SPManagedAccountIdentitySPManagedAccountPipeBindAssignmentCollectionSPAssignmentCollectionServerSPServerPipeBindIdentitySpecifies the full name or partial name of the managed accounts to retrieve.The type must be a valid account name, in the form Domain\User, or a GUID, in the form 1234-3456-09876.SPManagedAccountPipeBindSPManagedAccountPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ServerSpecifies the scope to a server.SPServerPipeBindSPServerPipeBind ServiceSpecifies the scope to a service.SPServicePipeBindSPServicePipeBind WebApplicationSpecifies the scope to a Web application.SPWebApplicationPipeBindSPWebApplicationPipeBind The Get-SPManagedAccount cmdlet participates in a parameter set. It returns the managed accounts that match the given scope. The scope can be any one of the following values: Web application, service, or server.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE----------------- C:\PS>Get-SPManagedAccountThis example displays all the managed accounts in the farm.New-SPManagedAccountSet-SPManagedAccountRemove-SPManagedAccount Get-SPManagedAccount Unpublish-SPServiceApplicationStops sharing the specified service application outside the farm.UnpublishSPServiceApplicationUnpublish-SPServiceApplicationIdentitySPServiceApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the GUID of the service application to stop sharing outside the farm.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh.SPServiceApplicationPipeBindSPServiceApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Use the Unpublish-SPServiceApplication cmdlet to stop publishing the service application, specified by the Identity parameter, outside the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>UnPublish-SPServiceApplication 053c34be-d251-488c-8e94-644eae94da26This example stops publishing of the specified service application outside the farm.The service application GUID is unique to every farm. You can run the Get-SPServiceApplication cmdlet to see the GUID of the service applications, and then use the result from the Get-SPServiceApplication cmdlet for other SPServiceApplication cmdlets; for example, Grant-SPServiceApplication or Publish-SPServiceApplication.Get-SPServiceApplicationSet-SPServiceApplicationPublish-SPServiceApplicationRevoke-SPServiceApplicationGrant-SPServiceApplication Unpublish-SPServiceApplication New-SPConfigurationDatabase Creates a new configuration database.NewSPConfigurationDatabaseNew-SPConfigurationDatabaseDatabaseNameStringDatabaseServerStringDirectoryDomainStringDirectoryOrganizationUnitStringAdministrationContentDatabaseNameStringDatabaseCredentialsPSCredentialFarmCredentialsPSCredentialPassphraseSecureStringAssignmentCollectionSPAssignmentCollectionDatabaseNameSpecifies the name of the new configuration database.StringString DatabaseServerSpecifies the database server on which to create the configuration database. If no value is specified, the default value is used.StringString DirectoryDomainSpecifies the directory domain for the new farm. If no domain is specified, the domain in which the local computer is located is used.StringString DirectoryOrganizationUnitSpecifies the directory organizational unit for the new configuration database. If no organizational unit is specified, the organizational unit in which the local computer is located is used.StringString AdministrationContentDatabaseNameSpecifies the name for the Central Administration content database for the new farm. If no name is specified, a default name is used.StringString DatabaseCredentialsSpecifies the Credential object for the database user. Use this parameter if you use SQL Server Authentication. If no database credentials are provided, Windows authentication is used.PSCredentialPSCredential FarmCredentialsSpecifies credentials for the Farm Administrator account.PSCredentialPSCredential PassphraseSpecifies the secure password phrase for the new farm. This passphrase is used to join other machines to this farm.SecureStringSecureString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The New-SPConfigurationDatabase cmdlet creates a new configuration database on the specified database server. This is the central database for a new SharePoint farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>New-SPConfigurationDatabase -DatabaseName "SharePointConfigDB1" -DatabaseServer "SQL-01" -Passphrase (ConvertTo-SecureString "MyPassword" -AsPlainText -force) -FarmCredentials (Get-Credential)This example prompts the user to provide user credentials for the default Farm Administrator account. Backup-SPConfigurationDatabaseDisconnect-SPConfigurationDatabaseConnect-SPConfigurationDatabaseRemove-SPConfigurationDatabaseDismount-SPConfigurationDatabase New-SPConfigurationDatabase Remove-SPSiteSubscriptionBusinessDataCatalogConfigRemoves the Business Data Connectivity Metadata Store for a partition.RemoveSPSiteSubscriptionBusinessDataCatalogConfigRemove-SPSiteSubscriptionBusinessDataCatalogConfigServiceContextSPServiceContextPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterServiceContextSpecifies the service context of the Business Data Connectivity Metadata Store to remove.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service context (for example, http://ServiceContext1); or an instance of a valid SPServiceContext object.SPServiceContextPipeBindSPServiceContextPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPBusinessDataCatalogSiteSubscriptionConfig cmdlet removes the Business Data Connectivity Metadata Store and all associated data for a specified partition. To completely remove a partition and the data that it contains, run the Clear-SPSiteSubscriptionBusinessDataCatalogConfig cmdlet to remove the data from the Business Data Connectivity Metadata Store, and then run the Remove-SPBusinessDataCatalogSiteSubscriptionConfig cmdlet.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185).------------------EXAMPLE------------------ C:\PS>Remove-SPBusinessDataCatalogSiteSubscriptionConfig -ServiceContext http://contosoThis example removes the Business Data Connectivity Metadata Store for the partition http://contoso.Export-SPSiteSubscriptionBusinessDataCatalogConfigImport-SPSiteSubscriptionBusinessDataCatalogConfig Remove-SPSiteSubscriptionBusinessDataCatalogConfig Install-SPWebPartPackInstalls the specified Web Part package to the specified location.InstallSPWebPartPackInstall-SPWebPartPackLiteralPathStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterGlobalInstallSwitchParameterLanguageUInt32WebApplicationSPWebApplicationPipeBindWhatIfSwitchParameterInstall-SPWebPartPackNameStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterGlobalInstallSwitchParameterLanguageUInt32WebApplicationSPWebApplicationPipeBindWhatIfSwitchParameterLiteralPathSpecifies the exact path to the Web Part package.StringString NameSpecifies the name of the Web Part package to install. StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceOverwrites any existing Web Part package with the same name or installed in the same location.SwitchParameterSwitchParameter GlobalInstallInstalls the Web Part package in the global assembly cache (GAC) rather than in the /bin directory of each Web application. This installation makes the Web Part globally accessible on the servers. SwitchParameterSwitchParameter LanguageSpecifies the language ID for the Web Part package.UInt32UInt32 WebApplicationSpecifies the Web application on which to install the Web Part pack. If no Web application is specified, the Web Part pack is installed on all Web applications.SPWebApplicationPipeBindSPWebApplicationPipeBind WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Install-SPWebPartPack cmdlet installs the Web Part package, at the LiteralPath parameter location, in the local farm. The Web Part package can be installed in a specific Web application by using the WebApplication parameter. If a Web application is not specified, the Web Part package is installed in all Web applications.Use the Language parameter to specify a package language.Use the GlobalInstall parameter to install the package to the global assembly cache (GAC). Assemblies in the GAC are granted FullTrust permission, which gives this package full access to all system-wide resources.Use the Force parameter to install the package to overwrite any existing Web Part package with the same name or installed in the same location.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Install-SPWebPartPack "MyCustomWebPartPack" -LiteralPath "c:/mywebpart.wpp" -GlobalInstallThis example installs the Web Part Package with the name MyCustomWebPartPack globally in the farm from the path c:/mywebpart.wpp.Uninstall-SPWebPartPackGet-SPWebPartPack Install-SPWebPartPack New-SPCentralAdministrationCreates a new SharePoint Central Administration Web application.NewSPCentralAdministrationNew-SPCentralAdministrationPortInt32WindowsAuthProviderStringAssignmentCollectionSPAssignmentCollectionPortSpecifies the port number for Central Administration. If no port is specified, a nonconflicting port number is auto-generated.The type must be a valid port number.If you specify a port number that has already been assigned, IIS does not start the new site until you change either the port number of the new site or the port number of the old site.Int32Int32 WindowsAuthProviderSpecifies the authorization provider for this Web application. If no authentication provider is specified, the default value NTLM is used.The type must be one of two values: Kerberos , or NTLM.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The New-SPCentralAdministration cmdlet creates a new Central Administration Web application and starts the central administration service on the local machine. Central Administration is available only on computers where this service runs.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). None.------------------EXAMPLE----------------------- C:\PS>New-SPCentralAdministration -Port 3000This example creates the Central Administration site at port 3000 on the local farm.Set-SPCentralAdministration New-SPCentralAdministration New-SPUserAdds an existing user to a SharePoint site with the designated permissions.NewSPUserNew-SPUserUserAliasStringWebSPWebPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDisplayNameStringEmailStringGroupSPGroupPipeBindMobileNumberStringPermissionLevelString[]SiteCollectionAdminSwitchParameterWhatIfSwitchParameterUserAliasStringString WebSpecifies the URL or GUID of the Web on which to create this user.The type must be a valid URL, in the form http://server_name, or a GUID, in the form 1234-5678-9876-0987.SPWebPipeBindSPWebPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DisplayNameSpecifies a string that contains the display name of the user.The type must be a valid user name; for example, Joe.StringString EmailSpecifies the e-mail address of the new user.The type must be a valid e-mail address, in the form someone@example.com.StringString GroupSpecifies the user group to which the new user belongs.SPGroupPipeBindSPGroupPipeBind MobileNumberSpecifies the user e-mail address of the new user.The type must be a valid e-mail address, in the form someone@example.com.StringString PermissionLevelAdds a user to a permission policy level.The type must be a valid permission policy level for the user; for example, Full , Read , Contribute , or All.String[]String[] SiteCollectionAdminSpecifies whether to add the user as an administrator to the site collection.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The New-SPUser cmdlet adds an existing user to a SharePoint Web site with the designated permissions. This user has the given permissions in all subsites that inherit permissions. The user account must already exist in the user directory.If your environment is in Active Directory mode, the user must already exist in Active Directory Domain Services (AD DS) and only the UserAlias parameter is required; all other fields are pulled from AD DS. If only an alias is given and the farm is in Active Directory Account Create mode, the Email parameter is also required.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1---------------------- C:\PS>PS> New-SPUser - UserAlias 'Contoso\Jdoe'-displayname 'John Doe' -web http://contoso.comThis example adds a new user named John Doe to the Contoso domain.------------------EXAMPLE 2---------------------- C:\PS>Get-SPWeb http://sitename | New-SPUser -UserAlias Contoso\JdoeThis example adds Contoso\Jdoe to all Webs in the http://sitename site collection. Because this site collection uses inherited permissions, only the top-level Web site needs to be touched.Get-SPUserSet-SPUserMove-SPUserRemove-SPUser New-SPUser Stop-SPAssignmentDisposes of objects in the provided assignment collection.StopSPAssignmentStop-SPAssignmentSemiGlobalSPAssignmentCollectionAssignmentCollectionSPAssignmentCollectionGlobalSwitchParameterSemiGlobalProvides the assignment collector from which to dispose of objects.SPAssignmentCollectionSPAssignmentCollection AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection GlobalStops the global assignment collector from storing objects, and disposes of any objects contained by the global assignment collector.SwitchParameterSwitchParameter The Stop-SPAssignment cmdlet disposes of objects in the provided assignment collection. Use the Global parameter to dispose of all objects in the global assignment collector and to stop the global store from collecting additional objects. Provide a SemiGlobal assignment collector to dispose of all contained objects.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Start-SPAssignment -global C:\PS>$w = Get-SPWeb http://MyWeb C:\PS>$w | Set-SPWeb -title "Accounting" C:\PS>Stop-SPAssignment -globalThis example uses simple assignment. While easier to use simple assignment, running commands that iterate through multiple SPSite or SPWeb objects while simple assignment is enabled is not recommended. Ensure that Stop-SPAssignment is run before attempting any iterations of multiple objects.Start-SPAssignment Stop-SPAssignment Get-SPBackupHistoryReturns a history of backup and restore operations.GetSPBackupHistoryGet-SPBackupHistoryDirectoryStringAssignmentCollectionSPAssignmentCollectionShowBackupSwitchParameterShowRestoreSwitchParameterDirectorySpecifies the path where the SharePoint 2010 Products backup packages generated from a farm backup have been stored.The type must be a valid path in either of the following forms:- C:\folder_name - \\server_name\folder_name StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ShowBackupFilters the output so that the history of backup operations only is displayed. If both the ShowBackup and the ShowRestore parameters are not specified, the history of both backup and restore operations is displayed.SwitchParameterSwitchParameter ShowRestoreFilters the output so that the history of restore operations only is displayed. If both the ShowBackup and the ShowRestore parameters are absent, the history of both backup and restore operations is displayed.SwitchParameterSwitchParameter The Get-SPBackupHistory cmdlet reads a history of backup and restore operations that have been run. Specifies whether you want to display only the backup history, only the restore history, or all of the history.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1----------------- C:\PS>Get-SPBackupHistory -Directory \\file_server\share\BackupThis example returns all farm backup and restore operations that have been run for the \\file_server\share\Backup directory.------------------EXAMPLE 2----------------- C:\PS>Get-SPBackupHistory -Directory C:\Backup -ShowBackupThis example returns all of the farm backup operations that have been run for the C:\Backup directory.------------------EXAMPLE 3----------------- C:\PS>(Get-SPBackupHistory -Directory C:\Backup -ShowBackup)[0].SelfId | Restore-SPFarm -Directory C:\Backup -RestoreMethod overwriteThis example gets all of the farm backup operations that have been run for the C:\Backup directory, finds the most recent backup, and then passes its backup GUID to the Restore-SPFarm cmdlet. The Restore-SPFarm cmdlet will then perform an overwrite restore from that backup package.Backup-SPFarmBackup-SPConfigurationDatabaseRestore-SPFarm Get-SPBackupHistory Uninstall-SPSolutionRetracts a deployed SharePoint solution.UninstallSPSolutionUninstall-SPSolutionIdentitySPSolutionPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterLanguageUInt32LocalSwitchParameterTimeStringWhatIfSwitchParameterUninstall-SPSolutionIdentitySPSolutionPipeBindWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterLanguageUInt32LocalSwitchParameterTimeStringWhatIfSwitchParameterUninstall-SPSolutionIdentitySPSolutionPipeBindAllWebApplicationsSwitchParameterAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterLanguageUInt32LocalSwitchParameterTimeStringWhatIfSwitchParameterIdentitySpecifies the SharePoint solution to uninstall.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint solution (for example, SPSolution1); or an instance of a valid SPSolution object.SPSolutionPipeBindSPSolutionPipeBind AllWebApplicationsSpecifies that the new SharePoint solution will be uninstalled for all SharePoint Web applications in the farm.SwitchParameterSwitchParameter WebApplicationUninstalls the SharePoint solution for the specified SharePoint Web application.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter LanguageUninstalls the language pack for the specified language.The type must be a valid language identifier; for example, 1033.UInt32UInt32 LocalUninstalls the solution from the active server computer.SwitchParameterSwitchParameter TimeSpecifies when the solution will be uninstalled. The default value is immediate retraction.The type must be a valid DateTime value, in the form 2010,12,05.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Uninstall-SPSolution cmdlet retracts a deployed SharePoint solution in preparation for removing it from the farm entirely. This cmdlet removes files from the front-end Web server. Use the Remove-SPSolution cmdlet to delete the solution package from the solution store of the farm; be sure to use the Remove-SPSolution cmdlet only after you have run Uninstall-SPSolution.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Uninstall-SPUserSolution -Identity contoso_solution.wspThis example retracts the deployed SharePoint solution contoso_solution.wsp.Get-SPSolutionAdd-SPSolutionUpdate-SPSolutionRemove-SPSolutionInstall-SPSolutionRemove-SPSolutionDeploymentLock Uninstall-SPSolution Remove-SPServiceApplicationDeletes the specified service application on the local server.RemoveSPServiceApplicationRemove-SPServiceApplicationIdentitySPServiceApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterRemoveDataSwitchParameterWhatIfSwitchParameterIdentitySpecifies the GUID of the service application to remove.SPServiceApplicationPipeBindSPServiceApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter RemoveDataDeletes all databases and other data associated with the service application.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPServiceApplication cmdlet deletes the specified service application from the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------------EXAMPLE--------------------------- C:\PS>Remove-SPServiceApplication 053c34be-d251-488c-8e94-644eae94da26 -removedataThis example deletes the service application and its database.The service application GUID is unique to every farm. You can run the Get-SPServiceApplication cmdlet to see the GUID of the service applications, and then use the result from the Get-SPServiceApplication cmdlet for other SPServiceApplication cmdlets; for example, Grant-SPServiceApplication or Publish-SPServiceApplication.Get-SPServiceApplicationSet-SPServiceApplicationPublish-SPServiceApplicationGrant-SPServiceApplication Remove-SPServiceApplication Get-SPUsageServiceReturns a usage service.GetSPUsageServiceGet-SPUsageServiceIdentitySPUsageServicePipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the usage service to get. If the Identity parameter is not specified, the cmdlet returns the local usage service.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object.SPUsageServicePipeBindSPUsageServicePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPUsageService cmdlet returns the specified usage service. If the Identity parameter is not specified, the cmdlet returns the local usage service.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------EXAMPLE------------------------- C:\PS>Get-SPUsageService -Identity 57055d99-9914-4af6-a3bf-7b76e3f231c2This example returns a SPUsageService object of the specified ID.Set-SPUsageService Get-SPUsageService Remove-SPServiceApplicationProxyDeletes the specified service application proxy.RemoveSPServiceApplicationProxyRemove-SPServiceApplicationProxyIdentitySPServiceApplicationProxyPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterRemoveDataSwitchParameterWhatIfSwitchParameterIdentitySpecifies the GUID of the service application proxy to remove.The type must be a GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh.SPServiceApplicationProxyPipeBindSPServiceApplicationProxyPipeBind RemoveDataDeletes all databases and other data associated with the service application proxy.SwitchParameterSwitchParameter AssignmentColletionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPServiceApplicationProxy cmdlet deletes the service application proxy specified by the Identity parameter.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Remove-SPServiceApplicationProxy babab30e-8e3a-428b-8ff4-4d5c8f455e6dThis example deletes the given service application proxy.The service application GUID is unique to every farm. You can run the Get-SPServiceApplication cmdlet to see the GUID of the service applications, and then use the result from the Get-SPServiceApplication cmdlet for other SPServiceApplication cmdlets; for example, Grant-SPServiceApplication or Publish-SPServiceApplication.Get-SPServiceApplicationProxyNew-SPServiceApplicationProxyGroupRemove-SPServiceApplicationProxy Remove-SPServiceApplicationProxy Get-SPAuthenticationProviderReturns an authentication provider.GetSPAuthenticationProviderGet-SPAuthenticationProviderIdentitySPAuthenticationProviderPipeBindWebApplicationSPWebApplicationPipeBindZoneDefault | Intranet | Internet | Custom | ExtranetAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the authentication provider to get.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint authentication provider (for example, NTLM); or an instance of a valid SPAuthenticationProvider object.SPAuthenticationProviderPipeBindSPAuthenticationProviderPipeBind WebApplicationReturns the content databases for the specified Web application.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind ZoneSpecifies the Web application zone or zones for which to return the authentication provider.The type must be any one of the valid zones: Default, Intranet, Internet, Extranet, or Custom.Default | Intranet | Internet | Custom | ExtranetDefault | Intranet | Internet | Custom | Extranet AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPAuthenticationProvider cmdlet returns an authentication provider on a specified Web application zone. The following are the standard authentication providers available for SharePoint 2010 Products: NTLM, Classic NTLM, Negotiate, and Classic Negotiate.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -----------------EXAMPLE1----------------- C:\PS>New-SPWebApplication http://sharepointonline.com -AuthenticationProvider (Get- SPAuthenticationProvider "LiveID STS")This example registers the LiveID STS authentication provider for the new Web application.-----------------EXAMPLE2----------------- C:\PS>New-SPWebApplication http://contoso.com -AuthenticationProvider (New- SPAuthenticationProvider -ASPNetMembershipProvider "myMembershipProvider" -ASPNetRoleProvider "myRoleProvider")This example registers ASPNet for the new Web application. Note that ASPNET memberships are not persisted and must be re-created every use.-----------------EXAMPLE3----------------- C:\PS>New-SPWebApplication http://contoso.com -AuthenticationProvider (Get- SPAuthenticationProvider "NTLM")This example registers the NTLM authentication provider for the new Web application. This command is equivalent to the command New-SPWebApplication http://contoso.com; NTLM is default authentication provider.-----------------EXAMPLE4----------------- C:\PS>$ip = @( (Get- SPAuthenticationProvider "LiveID STS"), (New- SPAuthenticationProvider -ASPNetMembershipProvider "myMembershipProvider" -ASPNetRoleProvider "myRoleProvider"), (Get-SPAuthenticationProvider "NTLM")) ) New-SPWebApplication http://contoso.com -AuthenticationProvider $ipThis example registers the NTLM, ASPNet, and LiveID STS authentication providers for the new Web application.-----------------EXAMPLE5----------------- C:\PS>New-SPWebApplication http://contoso.com -AuthenticationProvider (Get- SPAuthenticationProvider "Legacy NTLM")This example registers the Legacy NTLM authentication provider for the new Web application.New-SPAuthenticationProvider Get-SPAuthenticationProvider New-SPAuthenticationProviderCreates a new Authentication provider in the farm.NewSPAuthenticationProviderNew-SPAuthenticationProviderAllowAnonymousSwitchParameterAssignmentCollectionSPAssignmentCollectionDisableKerberosSwitchParameterUseBasicAuthenticationSwitchParameterUseWindowsIntegratedAuthenticationSwitchParameterNew-SPAuthenticationProviderASPNETMembershipProviderStringASPNETRoleProviderNameStringAssignmentCollectionSPAssignmentCollectionNew-SPAuthenticationProviderTrustedIdentityTokenIssuerSPTrustedIdentityTokenIssuerPipeBindAssignmentCollectionSPAssignmentCollectionASPNETMembershipProviderSpecifies the name of the membership provider.The type must be a valid name of an ASPNet membership provider; for example, myMembershipProvider. StringString ASPNETRoleProviderNameSpecifies the name of the role provider.The type must be a valid name of an ASPNet role provider; for example, myRoleProvider. StringString TrustedIdentityTokenIssuerSpecifies the identity of the authentication provider.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a TrustedIdentityTokenIssuer (for example, myRoleProvider); or an instance of a valid SPTrustedIdentityTokenIssuer object.SPTrustedIdentityTokenIssuerPipeBindSPTrustedIdentityTokenIssuerPipeBind AllowAnonymousSpecifies whether the Web application allows anonymous access.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection DisableKerberosSpecifies whether the Web application disables Kerberos authentication.SwitchParameterSwitchParameter UseBasicAuthenticationSpecifies whether the Web application uses basic authentication.SwitchParameterSwitchParameter UseWindowsIntegratedAuthenticationSpecifies whether the Web application uses Windows Integrated Authentication.SwitchParameterSwitchParameter The New-SPAuthenticationProvider cmdlet creates a new Authentication provider in the farm. NTLM, Classic NTLM, Negotiate, and Classic Negotiate can be set only in a Web Application.For ASP.NET Membership Provider or Role providers, no objects are persisted. The object is created and used for setting this type of Authentication provider in a Web application.For STS Authentication providers, an object is created and persisted in the SPFarm object.Using classic NTLM with any claims based authentication type is not allowed.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ---------------------------EXAMPLE1------------------ C:\PS>$ap = New - SPAuthenticationProvider -UseWindowsIntegratedAuthentication C:\PS>Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App Pool" -ApplicationPoolAccount "redmond\appool" -Url http://servername -Port 80 -AuthenticationProvider $apThis example creates a Windows-claims authentication provider---------------------------EXAMPLE2------------------ C:\PS>$ap = New-SPAuthenticationProvider -ASPNETMembershipProvider "membership" -ASPNETRoleProviderName "rolemanager" C:\PS>Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App Pool" -ApplicationPoolAccount "redmond\appool" -Url http://servername -Port 80 -AuthenticationProvider $apThis example creates an ASP.net membership role provider authentication provider.---------------------------EXAMPLE3------------------ C:\PS>$ap = New - SPAuthenticationProvider -TrustedIdentityTokenIssuer | Get-SPTrustedIdentityTokenIssuer "LiveIDSTS" C:\PS>Set-SPWebApplication -Name "Claims Windows Web App" -ApplicationPool "Claims App Pool" -ApplicationPoolAccount "redmond\appool" -Url http://servername -Port 80 -AuthenticationProvider $apThis example creates a trusted token issuer authentication provider.New-SPAuthenticationProvider New-SPAuthenticationProvider Disable-SPFeatureDisables an installed SharePoint Feature at a given scope.DisableSPFeatureDisable-SPFeatureIdentitySPFeatureDefinitionPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterUrlStringWhatIfSwitchParameterIdentitySpecifies the name of the Feature or GUID to disable.The type must be the name of the Feature folder located in the 14\Template\Features folder or GUID, in the format 21d186e1-7036-4092-a825-0eb6709e9281.SPFeatureDefinitionPipeBindSPFeatureDefinitionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceForces a Feature to be disabled.SwitchParameterSwitchParameter UrlSpecifies the URL of the Web application, site collection, or Web site to which the Feature is being disabled.The type must be a valid URL, such as http://server_name.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Disable-SPFeature cmdlet disables a SharePoint Feature at the given scope. If the scope of the Feature is the farm, the URL is not needed. Otherwise, provide the URL at which this Feature is to be deactivated (explicit scope is not needed).For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185).none--------------EXAMPLE 1----------------- C:\PS>Disable-SPFeature -identity "MyCustom" -URL http://somesiteThis example disables the "MyCustom" Web site scoped feature at http://somesite.--------------EXAMPLE 2----------------- C:\PS>$w = Get-SPWeb http://somesite/myweb | ForEach{ $_.URL } C:\PS>Get-SPFeature -Web $w |%{ Disable-SPFeature -Identity $_ -URL $w}This example disables all features in the subsite at http://somesite/myweb.You do not need to use the SPAssignment cmdlets in this case because the Web object is not stored-- only the string value for the URL.Install-SPFeatureEnable-SPFeatureGet-SPFeatureUninstall-SPFeature Disable-SPFeature Clear-SPLogLevelResets the Windows trace logging and event logging levels to their default values.ClearSPLogLevelClear-SPLogLevelAssignmentCollectionSPAssignmentCollectionIdentityString[]InputObjectPSObjectAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection IdentitySpecifies the name(s) of the category or set of categories to set the throttle for; for example, "Unified Logging Service". If the Identity parameter is not specified, the event throttling setting is applied to all categories in the farm.Providing an invalid category is a non-terminating error and will be ignored.String[]String[] InputObjectSpecifies the result of the InputObject parameter to be piped. The value can be a string in a format identical to the Identity parameter, or can be an SPDiagnosticsCategory object. The user can retrieve one or more categories from the Get-SPLogLevel cmdlet, modify their values, and then pipe the results to the Set-SPLogLevel cmdlet.PSObjectPSObject The Clear-SPLogLevel cmdlet resets the Windows event logging and trace logging levels for the specified categories to the default values. If the Identity parameter is not provided, all categories are affected.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185).--------------EXAMPLE 1----------------- C:\PS>Clear-SPLogLevel -Identity Cat1This example resets the log levels for a single category.--------------EXAMPLE 2----------------- C:\PS>"Cat1", "Cat2", "Cat3" | Clear-SPLogLevelThis example resets the log levels for multiple categories.--------------EXAMPLE 3----------------- C:\PS>Get-SPLogLevel | Clear-SPLogLevelThis example resets the log levels for all categories.Get-SPLogLevelSet-SPLogLevel Clear-SPLogLevel Backup-SPFarmCreates a backup of an individual database, Web application, or the entire farm.BackupSPFarmBackup-SPFarmBackupMethodStringDirectoryStringAssignmentCollectionSPAssignmentCollectionBackupThreadsInt32ConfigurationOnlySwitchParameterConfirmSwitchParameterForceSwitchParameterItemStringPercentageInt32WhatIfSwitchParameterBackup-SPFarmShowTreeSwitchParameterAssignmentCollectionSPAssignmentCollectionConfigurationOnlySwitchParameterConfirmSwitchParameterItemStringWhatIfSwitchParameterBackupMethodSpecifies the type of backup file to be created.If a backup is performed with the -ShowTree parameter, then the BackupMethod parameter is not used.A full backup is a backup of all the selected data. A differential backup is a backup of all the selected data that has changed since the last full backup. If an item does not support differential backup, then a full backup is performed for that item instead.The type must be either of the following:- Full- DifferentialStringString DirectorySpecifies the path where SharePoint 2010 Products stores the backup package it generates. If you have a computer on which Microsoft SQL Server 2008 and an instance of SharePoint 2010 Products are installed, you can use local drive paths. This includes a basic installation. However, if SQL Server 2008 and SharePoint 2010 Products are installed on multiple computers or if you have multiple servers running SharePoint 2010 Products, you must use Universal Naming Convention (UNC) share paths so that the SQL Server database and search components are written to the same location; for example, \\computer_name\volume\Backup).Multiple backup packages can be stored in the same location. This is the same path that you pass to the Directory parameter of the Restore-SPFarm cmdlet.The type must be either of the valid paths:- C:\ folder_name- \\server_name\folder_name The spbr* folders are automatically created.StringString ShowTreeDisplays which objects in the farm will be backed up based on the other parameters passed to the Backup-SPFarm cmdelt, namely the Item parameter. Items that will be excluded from the backup based on the other parameters passed to the Backup-SPFarm cmdlet will be preceded with an asterisk character (*). Items that cannot be backed up will be enclosed in square brackets ([ ]). A backup will not be performed if the ShowTree parameter is present.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection BackupThreadsSpecifies the number of threads to be used during the backup. The fewer the threads, the easier the backup log file is to read and understand. The more the threads, the more components that can be backed up in parallet, potentially resulting in a faster backup operation. The minimum value is 1 and the maximum value is 10.The default value is 3. If a backup is performed with the -ShowTree parameter, then the BackupMethod parameter is not used.Int32Int32 ConfigurationOnlyIf set, the backup will contain configuration settings only (no data) for each of the objects to be backed up.SwitchParameterSwitchParameter ForceSpecifies to proceed with a backup operation even if the estimation is that the backup directory does not have sufficient space to hold the entire backup.If a backup is performed with the ShowTree parameter, then the Force parameter is not used.SwitchParameterSwitchParameter ItemIndicates the part of the farm to back up. You might use the full farm path notation as displayed by the ShowTree parameter or the name of the target component in the path if the component has a unique name. If multiple items are included in the same match, the full path must be provided. By default, the top node is selected. Surround the item or path in quotation marks if it contains a space. If this parameter is not specified, the entire farm is backed up.The type must be a valid item; for example, Farm\Microsoft SharePoint Foundation Web Application\SharePoint - 80.StringString PercentageRequests progress updates about the backup operation to be displayed in increments of that percentage; for example, a value of 5 displays backup progress updates at every 5 percent completed, and a value of 10 displays backup progress updates at every 10 percent completed. To have progress outputs displayed, you must specify the Verbose parameter.This percentage is not precise and the actual progress updates might be lower or higher than requested. Progress updates are always recorded in the backup log file.The percentage value is not prcesie and the actual progress updates might be lower or higher than requested.The default value is 5. For a very large database, 1 is the recommended value.Valid values are an integer value between 1 and 100.Int32Int32 WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Backup-SPFarm cmdlet creates a backup for the entire farm or individual components within the farm. It can also be used to back up just the configuration settings of a farm to be used as a farm template for other SharePoint farms.If you want to back up a single site collection, use the Backup-SPSite cmdlet.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185).--------------------EXAMPLE 1--------------------- C:\PS>Backup-SPFarm -Directory \\file_server\share\Backup -BackupMethod full -ConfigurationOnlyThis example backs up the configuration settings of the farm to the \\file_server\share\Backup directory.--------------------EXAMPLE 2--------------------- C:\PS>Backup-SPFarm -ShowTree -Item "Microsoft SharePoint Foundation Web Application" -VerboseThis example shows which components of the farm would be backed up under the "Microsoft SharePoint Foundation Web Application" node, but do not actually back them up.--------------------EXAMPLE 3--------------------- C:\PS>Backup-SPFarm -Directory C:\Backup -BackupMethod full -BackupThreads 10 -ForceThis example performs a backup of a farm using 10 threads and forces the backup to be saved to the C:\Backup directory even though SharePoint estimates that it does not have sufficient space available.Backup-SPConfigurationDatabaseGet-SPBackupHistoryRestore-SPFarm Backup-SPFarm Remove-SPClaimTypeMappingDeletes a claim type mapping rule for a security token service (STS) identity provider.RemoveSPClaimTypeMappingRemove-SPClaimTypeMappingIdentitySPClaimMappingPipeBindTrustedIdentityTokenIssuerSPTrustedIdentityTokenIssuerPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the claim mapping to delete.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, Email); or an instance of a valid SPClaimMapping object.SPClaimMappingPipeBindSPClaimMappingPipeBind IdentityProviderSpecifies the farm trust identity provider STS that contains the claim mapping rule.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, LiveIDSTS); or an instance of a valid SPIdentityProvider object.AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Remove-SPClaimMapping cmdlet deletes a claim type mapping rule from a farm trust STS identity provider.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------------EXAMPLE------------------------- C:\PS>Remove-SPClaimMapping "Email" | Get-SPIdentityProvider "LiveIDSTS"This example removes an identity provider named LiveIDSTS.Add-SPClaimTypeMappingNew-SPClaimTypeMapping Remove-SPClaimTypeMapping New-SPSiteSubscriptionFeaturePackCreates a new SharePoint Feature set that can be used to limit the features available to a site subscription.NewSPSiteSubscriptionFeaturePackNew-SPSiteSubscriptionFeaturePackAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Use the New- SPSiteSubscriptionFeaturePack cmdlet to create a new SharePoint Feature set that limits the Features available to a specified site subscription.SharePoint Feature sets are on an Allow List of SharePoint Features that can be associated with any site subscription. If a Feature set is assigned to a site subscription, only SPFeatures objects in that Feature set are available for use on the site collections and Webs that are members of the site subscription. Feature sets contain a list of the GUIDs of each Feature that is on an Allow List for associated site subscriptions.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>$fs = New- SPSiteSubscriptionFeaturePackThis example creates a new SharePoint Feature set and stores it in a variable.Get-SPSiteSubscriptionFeaturePackAdd-SPSiteSubscriptionFeaturePackMemberNew-SPSiteSubscriptionFeaturePackAdd-SPSiteSubscriptionFeaturePackMember New-SPSiteSubscriptionFeaturePack Get-SPProductReturns a list of the SharePoint-related products installed in the farm and the versions of all updates installed for each product.GetSPProductGet-SPProductAssignmentCollectionSPAssignmentCollectionLocalSwitchParameterGet-SPProductAssignmentCollectionSPAssignmentCollectionServerSPServerPipeBindAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection LocalReturns product and update information for only the local computer. If you use the Local parameter, you cannot use the Server parameter.SwitchParameterSwitchParameter ServerReturns product and update information for a specified server. If you use the Server parameter, you cannot use the Local parameter.SPServerPipeBindSPServerPipeBind The Get-SPProduct cmdlet returns a list of the SharePoint-related products installed in the farm and the versions of all updates installed for each product. By default this cmdlet returns the list of SharePoint-related products installed in the farm. Use the Local parameter to get only information about the local server or for a specific server to get the list, use the Server parameter.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE----------------- C:\PS>Get-SPProduct -LocalThis example displays the SharePoint-related products installed on the local server. Get-SPProduct Set-SPUsageServiceSets the properties of a usage service.SetSPUsageServiceSet-SPUsageServiceIdentitySPUsageServicePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterLoggingEnabledNullableUsageLogCutTimeUInt32UsageLogLocationStringUsageLogMaxSpaceGBUInt32WhatIfSwitchParameterIdentitySpecifies the usage service to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object.SPUsageServicePipeBindSPUsageServicePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter LoggingEnabledSpecifies that usage data is logged to usage files.NullableNullable UsageLogCutTimeSpecifies the time, in minutes, of usage data collected per usage log file. The default time is 30 minutes.The type must be an integer in the range of 1 to 1440 .UInt32UInt32 UsageLogLocationSpecifies the path on every computer in the farm where usage log files are created.The type must be a valid path in either of the following forms:- C:\folder_name- \\server_name\folder_nameStringString UsageLogMaxSpaceGBSpecifies the amount in megabytes (MB) of space that can be used by usage log files. The valid range is 500 to 20,000 MB.The default value is 5,000.UInt32UInt32 WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPUsageService cmdlet updates the properties of a usage service. If the Identity parameter is not specified, the cmdlet applies the changes to the local usage service.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------------EXAMPLE----------------- C:\PS>Set-SPUsageService -LoggingEnabled $false C:\PS>Set-SPUsageService -UsageLogLocation "d:\\testusagelogdir C:\PS>Set-SPUsageService -UsageLogCutTime 5The examples disable usage logging, change the directory where usage files are stored, and creates a new usage log file every 5 minutes.Get-SPUsageService Set-SPUsageService Set-SPLogLevelSets the trace and event level for a set of categories.SetSPLogLevelSet-SPLogLevelAssignmentCollectionSPAssignmentCollectionEventSeverityStringIdentityString[]InputObjectPSObjectTraceSeverityStringAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection EventSeveritySpecifies the category level to be set. The category level is any one of the following values:- None - ErrorCritical- Error- Warning- Information- VerboseStringString IdentitySpecifies the name(s) of the category or set of categories to set the throttle for; for example, "Unified Logging Service". If the Identity parameter is not specified, the event-throttling setting is applied to all categories in the farm.String[]String[] InputObjectThe InputObject is pipelined to the cmdlet and can be a string in a format identical to the Identity parameter, or can be an SPDiagnosticsCategory object. The user can retrieve one or more categories from the Get-SPLogLevel cmdlet, modify the category values, and then pipeline them into the Set-SPLogLevel cmdlet.PSObjectPSObject TraceSeveritySpecifies trace throttle to set the specified categor(ies) to. The trace log files are text files that are written to the trace log path that is defined on the Diagnostic Logging Settings page on the SharePoint Central Administration site. The type must be any one of the following values:- None (no traces are written to the trace log)- Unexpected- Monitorable- High- Medium- Verbose- VerboseExStringString The Set-SPLogLevel cmdlet sets the Windows event logging and trace logging levels for one or more diagnostic logging categories registered in the farm. If an event or trace associated with a category occurs, but is less severe than that category's logging level, the event or trace is not written to the event log or the trace log. If an event or trace associated with a category occurs and is equally severe or more severe than that category's logging level, the event or trace is written to the event log or the trace log.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1----------------------- C:\PS>set-sploglevel -TraceSeverity MonitorableThis example sets the TraceSeverity values for all categories to Monitorable.------------------EXAMPLE 2----------------------- C:\PS>Set-SPLogLevel -TraceSeverity High -EventSeverity Warning -Identity "Cat1"This example sets the EventSeverity and TraceSeverity values for a single category.------------------EXAMPLE 3----------------------- C:\PS>"Cat1", "Cat2", "Cat3" | Set-SPLogLevel -EventSeverity ErrorThis example sets the EventSeverity values for multiple categories.------------------EXAMPLE 4----------------------- C:\PS>Set-SPLogLevel -EventSeverity Warning -Identity "AreaName:*"This example sets the EventSeverity values for all categories in the same area.Get-SPLogLevelClear-SPLogLevel Set-SPLogLevel Get-SPDatabaseRetrieves all properties of a database.GetSPDatabaseGet-SPDatabaseIdentitySPDatabasePipeBindAssignmentCollectionSPAssignmentCollectionGet-SPDatabaseServerInstanceSPDatabaseServiceInstancePipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the name of the database to display public properties.The type must be a valid GUID, in the form 1234-3456-567kg.SPDatabasePipeBindSPDatabasePipeBind ServerInstanceSpecifies the name of the SQL instance that contains the database in either the form "Server" for a default SQL instance or "Server\Instance" for a named SQL instance.SPDatabaseServiceInstancePipeBindSPDatabaseServiceInstancePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPDatabase cmdlet displays all public properties of a database to the current window. If the Identity parameter is specified, only properties of that ID are displayed.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185. --------------------EXAMPLE--------------------- C:\PS>Get-SPDatabase -ServerInstance "ServerA\SharePoint"This example gets all databases on a specific named SQL Server Express instance.Get-SPContentDatabaseNew-SPContentDatabaseSet-SPContentDatabase Get-SPDatabase Remove-SPWebCompletely deletes the specified Web.RemoveSPWebRemove-SPWebIdentitySPWebPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the identity of the Web to delete.The type must be a valid full URL, in the form http://server_name/site_name, or an SPWeb object.SPWebPipeBindSPWebPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPWeb cmdlet completely deletes the Web specified by the Identity parameter.Deleting the top level Web site of a site collection causes the entire site collection to be removed.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Remove-SPWeb http://sitename/subsiteThis example completely deletes a subsite.Get-SPWebSet-SPWebRemove-SPWebNew-SPWebImport-SPWeb Remove-SPWeb Remove-SPWebApplicationDeletes the specified Web application.RemoveSPWebApplicationRemove-SPWebApplicationIdentitySPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDeleteIISSiteSwitchParameterRemoveContentDatabasesSwitchParameterWhatIfSwitchParameterRemove-SPWebApplicationIdentitySPWebApplicationPipeBindZoneDefault | Intranet | Internet | Custom | ExtranetAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDeleteIISSiteSwitchParameterWhatIfSwitchParameterIdentitySpecifies the URL or name of the Web application to delete.The type must be a valid URL, in the form http://server_name, or a valid name, in the form WebApplication-1212.SPWebApplicationPipeBindSPWebApplicationPipeBind ZoneSpecifies o ne of the five zones to be removed. If this parameter is not provided, all Web application zones are removed. The type must be any one of the following values: Default , Intranet , Internet , Extranet , or Custom .Default | Intranet | Internet | Custom | ExtranetDefault | Intranet | Internet | Custom | Extranet AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DeleteIISSiteDeletes the associated IIS Web sites. If this parameter is not provided, the IIS site is not removed.SwitchParameterSwitchParameter RemoveContentDatabasesPermanently deletes all associated content databases. If this parameter is not provided, no content databases are removed.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPWebApplication cmdlet deletes the Web application specified by the Identity and Zone parameters. If no zone is provided, the entire Web application and all zones are removed.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1----------------------- C:\PS>Get-SPWebApplication http://sitename | Remove-SPWebApplication -Zone "Internet" -ConfirmThis example prompts and then removes the Internet zone Web application extension on the Web application at http://sitename. This command does not remove the content databases or the IIS Web site.------------------EXAMPLE 2----------------------- C:\PS>Remove-SPWebApplication http://sitename -Confirm -DeleteIISSite -RemoveContentDatabasesThis example permanently removes the Web application, all content databases, and the IIS Web site at http://sitename Get-SPWebApplicationSet-SPWebApplicationNew-SPWebApplication Remove-SPWebApplication Enable-SPTimerJobEnables a timer job.EnableSPTimerJobEnable-SPTimerJobIdentitySPTimerJobPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the timer job to enable. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object.SPTimerJobPipeBindSPTimerJobPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Enable-SPTimerJob cmdlet enables a timer job. A timer job must be enabled before it can be started.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------EXAMPLE--------------------- C:\PS>Get-SPTimerJob job-ceip-datacollection | Enable-SPTimerJobThis example enables the timer job named job-ceip-datacollection.Get-SPTimerJobSet-SPTimerJobStart-SPTimerJobDisable-SPTimerJob Enable-SPTimerJob Set-SPMobileMessagingAccountConfigures the specified mobile messaging account.SetSPMobileMessagingAccountSet-SPMobileMessagingAccountIdentitySPMobileMessagingAccountPipeBindWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionPasswordStringServiceNameStringServiceUrlStringUserIdStringIdentitySpecifies whether to return either Short Message Service (SMS) or Multimedia Messaging Service (MMS) account information. Valid values are SMS and MMS . If you do not specify this parameter account, information is returned for both SMS and MMS.SPMobileMessagingAccountPipeBindSPMobileMessagingAccountPipeBind WebApplicationSpecifies the identity of the Web application that hosts the managed path to delete . The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid Web application name (for example, WebApplication1212); or a valid name (for example, WebApp2423).You either must specify WebApplication or must use the HostHeader switch and specify the full URL in the Identity parameter.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection PasswordSpecifies the password, if credentials are required for the account.StringString ServiceNameSpecifies the name of the SMS service.StringString ServiceUrlSpecifies the URL of the SMS service.StringString UserIdSpecifies the user name, if credentials are required for the account.StringString The Set-SPMobileMessagingAccount cmdlet configures the specified mobile messaging account.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Set-SPMobileMessagingAccount -WebApplication http://sitename -Identity SMS -ServiceName SMSLink -ServiceUrl https://www.adatum.com/Service/MessagingService.asmx-UserId someone@example.com -Password password1This example changes the SMS mobile account settings of the Web application, http://sitename, to the following values: service name: SMSLink; service URL: https://www.adatum.com/Service/MessagingService.asmx; user ID: someone@example.com; and password: password1. Get-SPMobileMessagingAccount Set-SPMobileMessagingAccount Remove-SPUserRemoves a user from a Web site.RemoveSPUserRemove-SPUserIdentitySPUserPipeBindWebSPWebPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterGroupSPGroupPipeBindWhatIfSwitchParameterIdentitySpecifies the GUID, the user name, or SPUser object to remove.The type must be a valid GUID of the user, in the form 1234-5678-9876-0987.SPUserPipeBindSPUserPipeBind WebSpecifies the name of the URL or GUID from which the user is to be removed. This parameter is needed only if the identity provided is the user name.The type must be a valid URL, in the form http://server_name, or a GUID, in the form 1234-5678-9807.SPWebPipeBindSPWebPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter GroupThe user only gets removed from that group. Otherwise, the user gets removed from the site.SPGroupPipeBindSPGroupPipeBind WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPUser cmdlet specifies the identity and user group from which a user is to be removed. The Remove-SPUser cmdlet does not remove the user from Active Directory Domain Services (AD DS).For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1----------------------- C:\PS>Remove-SPUser "Contoso \jdoe" -web http://test/web1 C:\PS>Get-SPWeb "http://test/web1" | Remove-SPUser "Contoso\jdoe"This example removes the user (Contoso\jdoe) from the Web application http://test/web1.------------------EXAMPLE 2----------------------- C:\PS>Get-SPSite http://contoso.com |Get-SPWeb |Remove-SPUser "Contoso\jdoe"This syntax removes the user (Contoso\Jdoe) from every Web in a site collection located at http://contoso.com.Get-SPUserSet-SPUserNew-SPUserRemove-SPUser Remove-SPUser Export-SPWebExports a site collection, Web application, list, or library.ExportSPWebExport-SPWebIdentitySPWebPipeBindPathStringAssignmentCollectionSPAssignmentCollectionCompressionSizeInt32ConfirmSwitchParameterForceSwitchParameterHaltOnErrorSwitchParameterHaltOnWarningSwitchParameterIncludeUserSecuritySwitchParameterIncludeVersionsLastMajor | CurrentVersion | LastMajorAndMinor | AllItemUrlStringNoFileCompressionSwitchParameterNoLogFileSwitchParameterUseSqlSnapshotSwitchParameterWhatIfSwitchParameterIdentitySpecifies the URL or GUID of the Web to be exported.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of Microsoft SharePoint Foundation 2010 Web site (for example, MySPSite1); or an instance of a valid SPWeb object.SPWebPipeBindSPWebPipeBind PathSpecifies the name of the export file.If the NoFileCompression parameter is used, a directory must be specified; otherwise, any file format is valid.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection CompressionSizeSets the maximum file size for the compressed export files. If the total size of the exported package is greater than this size, the exported package will be split into multiple files.Int32Int32 ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceForcefully overwrites the export package if it already exists.The type must be either of the following values:-True-FalseThe default value is False.SwitchParameterSwitchParameter HaltOnErrorStops the export process when an error occurs.SwitchParameterSwitchParameter HaltOnWarningStops the export process when a warning occurs.SwitchParameterSwitchParameter IncludeUserSecurityPreserves the user security settings.SwitchParameterSwitchParameter IncludeVersionsIndicates the type of file and list item version history to be included in the export operation. If the IncludeVersions parameter is absent, the Export-SPWeb cmdlet by default uses a value of 1 .The type must be any one of the following versions:-Last major version for files and list items (default)-The current version, either the last major version or the last minor version-Last major and last minor version for files and list items-All versions for files and list itemsLastMajor | CurrentVersion | LastMajorAndMinor | AllLastMajor | CurrentVersion | LastMajorAndMinor | All ItemUrlSpecifies the URL of the Web application, GUID, or object to be exported.The type must be a valid URL; for example, http://server_name.StringString NoFileCompressionEither enables or disables file compression in the export package. The export package is stored in the folder specified by the Path parameter or Identity parameter. We recommend that you use this parameter for performance reasons. If compression is enabled, the export process can increase by approximately 30 percent.SwitchParameterSwitchParameter NoLogFileSuppresses the generation of an export log file. If this parameter is not specified, the Export-SPWeb cmdlet will generate an export log file in the same location as the export package. The log file uses Unified Logging Service (ULS).It is recommended to use this parameter. However, for performance reasons, you might not want to generate a log file.SwitchParameterSwitchParameter UseSqlSnapshotSpecifies a SQL Database Snapshot will be created when the export process begins, and all exported data will be retrieved directly from the database snapshot. This snapshot will be automatically deleted when export completes.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Export-SPWeb cmdlet exports a site collection, Web application, list, or library. The capability to export from a library is a new feature in SharePoint 2010 Products.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------------EXAMPLE-----------------------. C:\PS>Export-SPWeb http://site -Path "site export.cmp"This example exports the site at http://site/ to a file called site export.cmp in the current directory.Get-SPWebNew-SPWebSet-SPWebImport-SPWebRemove-SPWeb Export-SPWeb New-SPTrustedServiceTokenIssuerCreates a trust with a SharePoint farm.NewSPTrustedServiceTokenIssuerNew-SPTrustedServiceTokenIssuerNameStringCertificateX509Certificate2AssignmentCollectionSPAssignmentCollectionDescriptionStringNameSpecifies the name of the trust.The type must be a valid name of a trusted service issuer; for example, WFEFarmTrust1.StringString CertificateThe type must be a name of a valid X.509 certificate; for example, Certificate1.Specifies the X.509 certificate object from trusted authentication provider farm.X509Certificate2X509Certificate2 AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection DescriptionSpecifies a description for the trust.The type must be a valid string; for example, WFE Farm Trust1.StringString The New-SPTrustedServiceTokenIssuer cmdlet creates a trust with a SharePoint farm. If a certificate file is used, it must have only one X509 certificate without private keys, otherwise an exception is raised.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1------------------ C:\PS>$cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx New - SPTrustedServiceTokenIssuer -Name "WFEFarm1" - Description "WFE Farm 1" - ImportTrustCertificate $certThis example shows how to create a new SharePoint Farm trust using the trust certificate from a file.------------------EXAMPLE 2------------------ C:\PS>New - SPTrustedServiceTokenIssuer -Name "WFEFarm1" - Description "WFE Farm 1" -FederationMetadataUrl "https://liveid.com/STS/2007/03/fedmetadata.xml"This example shows how to create a SharePoint farm trust using the trust certificate from the federation metadata endpoint Url.Get-SPTrustedServiceTokenIssuerSet-SPTrustedServiceTokenIssuerRemove-SPTrustedServiceTokenIssuer New-SPTrustedServiceTokenIssuer New-SPUsageLogFileStarts a new usage log file on the current server computer.NewSPUsageLogFileNew-SPUsageLogFileAssignmentCollectionSPAssignmentCollectionAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The New-SPUsageLogFile cmdlet starts a new usage log file on the current server computer. The usage data in memory is flushed to the current usage log file before the new log file is created.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------EXAMPLE------------------- C:\PS>New-SPUsageLogFileThis example terminates the current usage log file and creates a new one. New-SPUsageLogFile Get-SPUserSolutionReturns a specified sandboxed solution.GetSPUserSolutionGet-SPUserSolutionIdentitySPUserSolutionPipeBindSiteSPSitePipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the sandboxed solution to get.The type must be a valid name of a user solution (for example, UserSolution1); or an instance of a valid SPUserSolution object.SPUserSolutionPipeBindSPUserSolutionPipeBind SiteSpecifies the site collection that contains the sandboxed solution.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object.SPSitePipeBindSPSitePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPUserSolution cmdlet returns a specified sandboxed solution. If the Identity parameter is not specified, this cmdlet returns the collection of sandboxed solutions in the SharePoint farm. A user solution is a sandboxed solution.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -----------------EXAMPLE--------------------- C:\PS>Get-SPUserSolution -Site http://sitenameThis example displays information about sandboxed solutions in the site http://sitename.Update-SPUserSolutionInstall-SPUserSolutionUninstall-SPUserSolutionRemove-SPUserSolutionAdd-SPUserSolution Get-SPUserSolution New-SPBusinessDataCatalogServiceApplicationCreates a new Business Data Connectivity service application in the farm.NewSPBusinessDataCatalogServiceApplicationNew-SPBusinessDataCatalogServiceApplicationApplicationPoolSPIisWebServiceApplicationPoolPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDatabaseCredentialsPSCredentialDatabaseNameStringDatabasePasswordSecureStringDatabaseServerStringDatabaseUsernameStringFailoverDatabaseServerStringNameStringPartitionModeSwitchParameterSharingSwitchParameterWhatIfSwitchParameterApplicationPoolSpecifies the IIS application pool to use for the new Business Data Connectivity service application.SPIisWebServiceApplicationPoolPipeBindSPIisWebServiceApplicationPoolPipeBind DatabaseNameSpecifies the name for the Business Data Connectivity database.StringString DatabaseServerSpecifies the name of the host server for the database specified in DatabaseName .The type must be a valid SQL Server host name; for example, SERVER\Database.StringString NameSpecifies a display name for the new Business Data Connectivity service application. StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DatabaseCredentialsSpecifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication.The type must be a valid PSCredential object.PSCredentialPSCredential DatabasePasswordSpecifies the password for the user specified in DatabaseUserName . Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database.The type must be a valid password.SecureStringSecureString DatabaseUsernameSpecifies the user name to use for connecting to the database. Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database.StringString FailoverDatabaseServerSpecifies the name of the host server for the failover database server.StringString PartitionModeSpecifies that the service application restricts data by subscription ID. This property cannot be changed after the service application is created.SwitchParameterSwitchParameter SharingSpecifies that the Business Data Connectivity application is published and shared across the farm.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The New-SPBusinessDataCatalogServiceApplication cmdlet creates a new Business Data Connectivity service application in the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>New-SPBusinessDataCatalogServiceApplication -ApplicationPool "SharePoint Web Services Default" -DatabaseName "ContosoBdcDB" -DatabaseServer "CONTOSO\SharePoint" -Name "ContosoServiceApp"This example creates a Business Data Connectivity service application named ContosoServiceApp. In this process it uses the SharePoint Web Services Default application pool and creates a database named ContosoBdcDB.Set-SPBusinessDataCatalogServiceApplicationNew-SPBusinessDataCatalogServiceApplicationProxy New-SPBusinessDataCatalogServiceApplication Set-SPServiceApplicationEndpointSets the host of an endpoint for a service application.SetSPServiceApplicationEndpointSet-SPServiceApplicationEndpointIdentitySPServiceEndpointPipeBindHostNameStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterSet-SPServiceApplicationEndpointIdentitySPServiceEndpointPipeBindResetHostNameSwitchParameterAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the service endpoint to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URI of an endpoint address, in the form http://sitename:8003/servicemodelsamples/service; or an instance of a valid SPServiceEndpoint object.SPServiceEndpointPipeBindSPServiceEndpointPipeBind HostNameSpecifies the default host of the service endpoint.The type must be a valid full load balanced URL, in the form http://server_name.StringString ResetHostNameRemoves the current host of the service endpoint and uses the default host.SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set- SPServiceApplicationEndpoint cmdlet sets the host of a service endpoint. Use the second parameter set to reset the host of the service endpoint to use the default endpoint.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------------EXAMPLE------------------- C:\PS>Set-SPServiceApplicationEndpoint -Identity "ServiceApp1" -HostName http://sitename -ResetHostName $trueThis example associates the SPServiceEndpoint object with the specified identity and resets the hostname.Get-SPServiceApplicationEndpoint Set-SPServiceApplicationEndpoint Backup-SPSitePerforms a backup of a site collection.BackupSPSiteBackup-SPSiteIdentitySPSitePipeBindPathStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterNoSiteLockSwitchParameterUseSqlSnapshotSwitchParameterWhatIfSwitchParameterIdentitySpecifies the URL or GUID of the site collection to be backed up.For example, a valid URL, such as http://server_name/sites/site_name or a GUID such as, "01234567-89ab-cdef-0123-456789abcdef" SPSitePipeBindSPSitePipeBind PathSpecifies the full path to the backup file (that is, C:\Backup\site_name.bak.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceSpecify to overwrite an existing backup file if it already exists.SwitchParameterSwitchParameter NoSiteLockSpecifies the site collection to remain read and write during the backup.If the NoSiteLock parameter is not specified, then a site collection that has a site collection lock setting of "none" or "no additions" will be temporarily set to "read only" while the site collection backup is performed. Once the backup has completed, the site collection lock will return to its original state. The backup package will record the original site collection lock state so that it is restored to that state.If users are writing to the site collection while the site collection is being backed up, then the NoSiteLock parameter is not recommended for potential impact to backup integrity SwitchParameterSwitchParameter UseSqlSnapshotSpecifies a SQL Database Snapshot will be created when the backup begins, and all site collection data will be retrieved directly from the database snapshot. This snapshot will be deleted automatically when the backup completes The UseSqlSnapshot parameter is recommended if the database server hosting your content database supports database snapshots such as such as SQL Server Enterprise Edition and SQL Server Developer Edition. This is because it will ensure a valid backup while allowing users to continue reading and writing to the site collection during the backup. It is not necessary to specify the NoSiteLock parameter when specifying the UseSqlSnapshot parameter.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Backup-SPSite cmdlet performs a backup of the site collection when the Identity parameter is used. By default, the site collection will be set to read-only for the duration of the backup to reduce the potential for user activity during the backup operation to corrupt the backup. If you have SQL Server Enterprise Edition, we recommend that UseSqlSnapshot parameter be used because this ensures a valid backup while it allows users to continue reading and writing to the site collection during the backup.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------EXAMPLE 1-------------------- C:\PS>Backup-SPSite http://server_name/sites/site_name -Path C:\Backup\site_name.bakThis example backs up a site collection at http://server_name/sites/site_name to the C:\Backup\site_name.bak file.-------------------EXAMPLE 2-------------------- C:\PS>Get-SPSiteAdministration http://server_name/sites/site_name | Backup-SPSite -Path C:\Backup\site_name.bakThis example backs up a site collection at http://server_name/sites/site_name to the C:\Backup\site_name.bak file. Same result as Example 1, but a different way of performing the operation.-------------------EXAMPLE 3-------------------- C:\PS>Backup-SPSite http://server_name/sites/site_name -Path C:\Backup\site_name.bak -UseSqlSnapshotThis example backs up a site collection using database snapshots to ensure backup integrity.Get-SPSiteMove-SPSiteRestore-SPSiteSet-SPSiteGet-SPSiteAdministration Backup-SPSite Update-SPUserSolutionUpgrades an activated sandboxed solution in a farm.UpdateSPUserSolutionUpdate-SPUserSolutionIdentitySPUserSolutionPipeBindSiteSPSitePipeBindToSolutionSPUserSolutionPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the sandboxed solution to upgrade.The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object.SPUserSolutionPipeBindSPUserSolutionPipeBind SiteUpgrade the sandboxed solution for the specified site collection.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object.SPSitePipeBindSPSitePipeBind ToSolutionSpecifies the sandboxed solution you want to upgrade to.The type must be a valid name of a sandboxed solution (for example, UserSolution1); or an instance of a valid SPUserSolution object.SPUserSolutionPipeBindSPUserSolutionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Update-SPUserSolution cmdlet upgrades a sandboxed solution that has already been activated in a farm. A user solution is a sandboxed solution. Before you use this cmdlet to upgrade the activated solution, use the Add-SPUserSolution cmdlet to upload the upgraded solution to the solution gallery.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE--------------------- C:\PS>Update-SPUserSolution -Identity contoso_solution.wsp -Site http://sitename -ToSolution contoso_solution_v2.wspThis example upgrades the sandboxed solution contoso_solution.wsp in the site http://sitename to the sandboxed solution contoso_solution_v2.wsp.Install-SPUserSolutionUninstall-SPUserSolutionRemove-SPUserSolutionGet-SPUserSolutionAdd-SPUserSolution Update-SPUserSolution Get-SPSiteSubscriptionReturns the site subscription for the given URL or all site subscriptions in the local farm.GetSPSiteSubscriptionGet-SPSiteSubscriptionIdentitySPSiteSubscriptionPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the ID of the subscription.The type must be a valid URL, in the form http://server_name.SPSiteSubscriptionPipeBindSPSiteSubscriptionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPSiteSubscription cmdlet returns the site subscription for the given URL when the Identity parameter is used. If no parameter is specified, all unique site subscriptions in the farm are listed.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE---------------------- C:\PS>$SiteSub = Get-SPSiteSubscription http://Contoso.com C:\PS>$SiteSub = Get-SPSite http://contoso.com | Get-SPSiteSubscriptionThis example retrieves the site subscription for http://Contoso.com.New-SPSiteSubscriptionRemove-SPSiteSubscription Get-SPSiteSubscription Get-SPBusinessDataCatalogThrottleConfigReturns the throttling configuration for a Business Data Connectivity Service application.GetSPBusinessDataCatalogThrottleConfigGet-SPBusinessDataCatalogThrottleConfigScopeGlobal | Database | WebService | Wcf | CustomServiceApplicationProxySPServiceApplicationProxyPipeBindThrottleTypeNone | Items | Size | Connections | TimeoutAssignmentCollectionSPAssignmentCollectionGet-SPBusinessDataCatalogThrottleConfigFileBackedSwitchParameterScopeGlobal | Database | WebService | Wcf | CustomThrottleTypeNone | Items | Size | Connections | TimeoutAssignmentCollectionSPAssignmentCollectionFileBackedRequests the throttling configuration for file backed metadata catalogs.SwitchParameterSwitchParameter ScopeReturns the throttling configuration for the specified the scope.The type must be one of the following: Wcf, WebService, Database, Global, or Custom.Global | Database | WebService | Wcf | CustomGlobal | Database | WebService | Wcf | Custom ServiceApplicationProxySpecifies the Business Data Connectivity Service application proxy that contains the throttling configuration to get.SPServiceApplicationProxyPipeBindSPServiceApplicationProxyPipeBind ThrottleTypeReturns the throttling configuration for the specified throttle type.The type must be one of the following: None, Items, Size, Connections, or Timeout.None | Items | Size | Connections | TimeoutNone | Items | Size | Connections | Timeout AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPBusinessDataCatalogThrottleConfig cmdlet reads the throttling configuration for a Business Data Connectivity Service application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Get-SPBusinessDataCatalogThrottleConfig -Scope Database -ThrottleType Items -ServiceApplicationProxy $contosoServAppProxyThis example returns the throttling information that is related to database items for the given service application.Set-SPBusinessDataCatalogThrottleConfigRemove-SPBusinessDataCatalogThrottleConfig Get-SPBusinessDataCatalogThrottleConfig Add-SPSiteSubscriptionFeaturePackMemberAdds a feature to a SharePoint Feature set.AddSPSiteSubscriptionFeaturePackMemberAdd-SPSiteSubscriptionFeaturePackMemberIdentitySPSiteSubscriptionFeaturePackPipeBindFeatureDefinitionSPFeatureDefinitionPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the Feature set object or GUID to which the given SharePoint Feature is added.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a Feature set (for example, FeatureSet1); or an instance of a valid SPFeatureSet object.SPSiteSubscriptionFeaturePackPipeBindSPSiteSubscriptionFeaturePackPipeBind FeatureDefinitionSpecifies the Feature definition, name, or GUID to add to the Feature set.SPFeatureDefinitionPipeBindSPFeatureDefinitionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Add- SPSiteSubscriptionFeaturePackMember cmdlet adds features to the provided SharePoint Feature set. Feature sets are an Allow List of SharePoint Features that can be associated with any site subscription. If a Feature set is assigned to a site subscription, only the SPFeatures object in that Feature set are available for use on the site collections and Web sites that are members of the site subscription. Feature sets contain a list of the GUIDs of each Feature that are on the Allow List for associated site subscriptions.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------EXAMPLE---------------- C:\PS>$fs = New-SPFeatureSet C:\PS>Get-SPFeature -limit all | Where{ $_.Scope -eq "WEB" } | Add-SPFeatureSetMember -id $fs C:\PS>$fs = Get-SPFeatureSet $fsThis example creates a Feature set and adds all Web site scoped Features to the set.The Feature set is refreshed in the last line so that the local object has the correct values.Remove-SPSiteSubscriptionFeaturePackMember Add-SPSiteSubscriptionFeaturePackMember Set-SPServiceApplicationPoolChanges the account used for the Identity of the specified application pool.SetSPServiceApplicationPoolSet-SPServiceApplicationPoolIdentitySPIisWebServiceApplicationPoolPipeBindAccountSPProcessAccountPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the identity of the Web service application pool to configure.SPIisWebServiceApplicationPoolPipeBindSPIisWebServiceApplicationPoolPipeBind AccountSpecifies the credentials that will be the new Identity of the application pool.SPProcessAccountPipeBindSPProcessAccountPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPServiceApplicationPool cmdlet changes the account used for the Identity of the specified application pool.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Set-SPServiceApplicationPool TestServiceWebApplicationPool -Account testdomain\testuser1This example changes the identity of the selected service application pool.For the Account parameter, the name of a managed account in the farm can be given. Use the Get-SPManagedAccount cmdlet to view the existing managed account in the farm. Also, a process account from the output of the Get-SPProcessAccount cmdlet can be used.Get-SPServiceApplicationPoolNew-SPServiceApplicationPoolRemove-SPServiceApplicationPool Set-SPServiceApplicationPool Get-SPTrustedServiceTokenIssuerReturns the object that represents the farm trust.GetSPTrustedServiceTokenIssuerGet-SPTrustedServiceTokenIssuerIdentitySPTrustedServiceTokenIssuerPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the trusted service token issuer to get.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted service token issuer (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object.SPTrustedServiceTokenIssuerPipeBindSPTrustedServiceTokenIssuerPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPTrustedServiceTokenIssuer cmdlet returns the object that represents the farm trust.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Get - SPTrustedServiceTokenIssuer "WFEFarm1"This example gets the trusted services token issuer WFEFarm1.Set-SPTrustedServiceTokenIssuerNew-SPTrustedServiceTokenIssuerRemove-SPTrustedServiceTokenIssuer Get-SPTrustedServiceTokenIssuer Remove-SPShellAdminRemoves a user from the SharePoint_Shell_Access role.RemoveSPShellAdminRemove-SPShellAdminUserNameStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterdatabaseSPDatabasePipeBindWhatIfSwitchParameterUserNameSpecifies the name of the user you want to remove from the SharePoint_Shell_Access role in the specified database.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter databaseSpecifies the name of the database that includes the SharePoint_Shell_Access role from which the user is to be removed. If the database parameter is not specified, the configuration database is used.SPDatabasePipeBindSPDatabasePipeBind WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Use the Remove-SPShellAdmin cmdlet to remove a user from the SharePoint_Shell_Access role in a specified database.When you use this cmdlet to remove a user from the role, you do not remove the user from the WSS_ADMIN_WPG group in the target database.When you run this cmdlet to add a user to the SharePoint_Shell_Access role, the user must have the following security permissions: - Security_Admin role access on the SQL instance and the db_owner role in the database.- Administrative permission to the local computer. For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -----------------------EXAMPLE----------------------------- C:\PS>Remove-SPShellAdmin -UserName CONTOSO\User1 -database WSS_ContentThis example removes an existing user named User1 from the SharePoint_Shell_Access role in the WSS_Content database.Add-SPShellAdminGet-SPShellAdmin Remove-SPShellAdmin Import-SPSiteSubscriptionSettingsRestores a backup of subscription site settings to the given subscription identifier.ImportSPSiteSubscriptionSettingsImport-SPSiteSubscriptionSettingsIdentitySPSiteSubscriptionPipeBindPathStringAdminPropertiesSwitchParameterAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterWhatIfSwitchParameterIdentitySpecifies the ID of the subscription to restore .The type must be a valid URL, in the form http://server_name, or a GUID, in the form 1234-4567-985tg.SPSiteSubscriptionPipeBindSPSiteSubscriptionPipeBind PathSpecifies the location of the input file.The type must be a valid path, in the form C:\filename.bak.StringString AdminPropertiesSpecifies that only administrator subscription properties are imported. If this parameter is not set, only non-administrator subscription properties are imported. SwitchParameterSwitchParameter AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceIf a setting key already exists, determines whether the value must be overwritten with the value in the backup file.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Import-SPSiteSubscriptionSettings cmdlet restores a backup of subscription site settings to the given subscription identifier when the Identity parameter is used. To overwrite existing settings, use the Force parameter.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE----------------- C:\PS>Get-SPSiteSubscription http://contoso.com | Import-SPSiteSubscriptionSettings -path "c:/backups/contoso_settings_file.bak" -forceThis example restores the subscription settings store of contoso.com.Export-SPSiteSubscriptionSettingsRemove-SPSiteSubscriptionSettings Import-SPSiteSubscriptionSettings Get-SPWebTemplateDisplays all globally installed site templates that match the given identity.GetSPWebTemplateGet-SPWebTemplateIdentitySPWebTemplatePipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the name of the Web template to display.The type must be the ID or full or partial name of the Web template.SPWebTemplatePipeBindSPWebTemplatePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPWebTemplate cmdlet displays all installed site templates that match the full or partial identity that was given.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE 1----------------- C:\PS>$template = Get-SPWebTemplate "STS#0" C:\PS>New-SPSite http://contoso.com -OwnerAlias "DOMAIN\JDOE" -Template $templateThis example creates a site collection by using the team site Web template (ID=STS#0).--------------EXAMPLE 2----------------- C:\PS>Get-SPWebTemplate "STS*"This example displays basic information about all the STS templates.Set-SPWebTemplateInstall-SPWebTemplateUninstall-SPWebTemplate Get-SPWebTemplate Get-SPManagedPathReturns all managed paths that match the given criteria.GetSPManagedPathGet-SPManagedPathIdentitySPPrefixPipeBindWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionGet-SPManagedPathIdentitySPPrefixPipeBindHostHeaderSwitchParameterAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the URL or GUID of the managed path to return. The type must be a valid URL, in the http://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh).SPPrefixPipeBindSPPrefixPipeBind HostHeaderIf provided, the managed paths returned are for the HostHeader sites in the farm.SwitchParameterSwitchParameter WebApplicationSpecifies the URL or GUID of the Web application from which to get the managed path.The type must be a valid URL, in the form http://server_name, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh).SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPManagedPath cmdlet returns the SharePoint managed path that matches the provided Identity for either a Web Application, site collection or for all HostHeader site collections. If an Identity parameter is not provided, all managed paths for the given scope are returned.HostHeader sites (no matter the Web application in which they are contained) share a single set of managed paths. Use the HostHeader parameter to return host header managed paths.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185. --------------EXAMPLE 1----------------- C:\PS>Get-SPManagedPath -WebApplication http://sitenameThis example returns all managed paths for the specified Web application.--------------EXAMPLE 2----------------- C:\PS>Get-SPManagedPath -identity "Sites" -HostHeaderThis example gets the Sites managed path from the HostHeader managed paths.New-SPManagedPathRemove-SPManagedPath Get-SPManagedPath Set-SPContentDatabaseSets global properties of a SharePoint content database.SetSPContentDatabaseSet-SPContentDatabaseIdentitySPContentDatabasePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterMaxSiteCountInt32StatusOnline | Disabled | Offline | Unprovisioning | Provisioning | UpgradingWarningSiteCountInt32WhatIfSwitchParameterIdentitySpecifies the content database to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object.SPContentDatabasePipeBindSPContentDatabasePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter MaxSiteCountSpecifies the maximum number of site collections that this database can host.The type must be a positive integer. Set to $null to clear this value.Int32Int32 StatusSpecifies the status of the SQL Server database. Set this parameter to Ready to make the database available to host new sites. Set this parameter to Offline to make the database unavailable to host new sites.The type must be either of the following: Ready or OfflineOnline | Disabled | Offline | Unprovisioning | Provisioning | UpgradingOnline | Disabled | Offline | Unprovisioning | Provisioning | Upgrading WarningSiteCountSpecifies the number of site collections that can be created before a warning event is generated and the owner of the site collection is notified.The type must be a positive integer. Set to $null to clear this value.Int32Int32 WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPContentDatabase cmdlet sets global properties of a SharePoint content database.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ---------------EXAMPLE 1--------------- C:\PS>Get-SPContentDatabase http://contoso.com | Set-SPContentDatabase -MaxSiteCount 1This example sets the MaxSiteCount for the content database that contains contoso.com to 1.---------------EXAMPLE 2--------------- C:\PS>Get-SPContentDatabase -WebApplication http://sitename | Set-SPContentDatabase -WarningSiteCount $nullThis example clears the WarningSiteCount for all databases in the sitename Web application.Get-SPContentDatabaseNew-SPContentDatabaseRemove-SPContentDatabaseUpgrade-SPContentDatabaseDismount-SPContentDatabaseTest-SPContentDatabaseInitialize-SPContentDatabase Set-SPContentDatabase Stop-SPServiceInstanceStops the service instance for a service.StopSPServiceInstanceStop-SPServiceInstanceIdentitySPServiceInstancePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the GUID of the service instance to get.SPServiceInstancePipeBindSPServiceInstancePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Stops the service instance for a service on the specified server or for the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Stop-SPServiceInstance 67877d63-bff4-4521-867a-ef4979ba07ceThis example stops the service instance in the given server.The service instance GUID is unique to every farm. You can run the Get-SPServiceInstance cmdlet to see the GUID of the service instances, and then use the result from the SPServiceInstance cmdlet for other cmdlets.Get-SPServiceInstanceStart-SPServiceInstance Stop-SPServiceInstance Get-SPTimerJobReturns timer jobs.GetSPTimerJobGet-SPTimerJobIdentitySPTimerJobPipeBindAssignmentCollectionSPAssignmentCollectionTypeStringWebApplicationSPWebApplicationPipeBindIdentitySpecifies the timer job to get.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object.SPTimerJobPipeBindSPTimerJobPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection TypeFilters to return timer jobs of a specified type.The type must be a name of a valid timer job type; for example, TimerJob1.StringString WebApplicationFilters to return timer jobs defined for the scope of a specified SharePoint Web application.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind The Get-SPTimerJob cmdlet reads a specified timer job, timer jobs of a specified type, or timer jobs defined for a specified scope. If no parameters are specified, this cmdlet returns all timer job definitions for the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ---------------------EXAMPLE--------------------- C:\PS>Get-SPTimerJob -WebApplication "http://servername" | select Name, DisplayNameThis example displays all timer jobs for a specified Web application.Set-SPTimerJobStart-SPTimerJobDisable-SPTimerJobEnable-SPTimerJob Get-SPTimerJob Move-SPSiteMoves site collections from one content database to another.MoveSPSiteMove-SPSiteIdentitySPSitePipeBindDestinationDatabaseSPContentDatabasePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the identity of the site collection to be moved. For example, http://servername/sites/sitename.SPSitePipeBindSPSitePipeBind DestinationDatabaseSpecifies the content database that the site collection should be moved to. For example, ContentDB2.SPContentDatabasePipeBindSPContentDatabasePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Move-SPSite cmdlet moves the data in the specified site collection from its current content database to the content database specified by the DestinationDatabase parameter. A read-only lock is applied to the site collection to prevent users from altering data within the site collection while the move is taking place. Once the move is complete, the site collection is returned to its original lock state. The destination content database specified must already exist, must be attached to the same SQL Server as the site collection's current content database, and must be attached to the site collection's current Web application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ---------------------EXAMPLE 1----------------------- C:\PS>Move-SPSite http://servername/sites/sitename -DestinationDatabase ContentDb2This example moves the site collection http://servername/sites/sitename to the content database ContentDb2.---------------------EXAMPLE 2----------------------- C:\PS>Get-SPSite -ContentDatabase ContentDb1 | Move-SPSite -DestinationDatabase ContentDb2This example moves all site collections in ContentDb1 to ContentDb2.---------------------EXAMPLE 3----------------------- C:\PS>Get-SPSiteAdministration | where { $_.OwnerLoginName -eq "DOMAIN\username" } | Move-SPSite -DestinationDatabase ContentDb2 This example moves all site collections where DOMAIN\username is the site collection owner to ContentDb2. The Get-SPSiteAdministration cmdlet is used instead of the Get-SPSite cmdlet because you must have permission within the site collection to access the properties of the SPSite object. You can access the properties of the SPSiteAdministration object as a SharePoint farm administrator.Backup-SPSiteGet-SPSiteRestore-SPSiteGet-SPSiteAdministration Move-SPSite Set-SPTimerJobSets the schedule for running a timer job.SetSPTimerJobSet-SPTimerJobIdentitySPTimerJobPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterScheduleStringWhatIfSwitchParameterIdentitySpecifies the timer job to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a timer job (for example, TimerJob1); or an instance of a valid SPTimerJob object.SPTimerJobPipeBindSPTimerJobPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ScheduleSpecifies the schedule for running the timer job.The type must be a valid SharePoint Timer service (SPTimer) schedule in the form of any one of the following schedules:- Every 5 minutes between 0 and 59- Hourly between 0 and 59- Daily at 15:00:00- Weekly between Fri 22:00:00 and Sun 06:00:00- Monthly at 15 15:00:00- Yearly at Jan 1 15:00:00StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPTimerJob cmdlet sets the schedule for running a specified timer job.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------EXAMPLE------------------------ C:\PS>Get-SPTimerJob job-recycle-bin-cleanup | Set-SPTimerJob -Schedule "weekly at sat 5:00"This example sets the schedule to run the job-recylce-bin-cleanup timer job to weekly at sat 5:00.Get-SPTimerJobStart-SPTimerJobDisable-SPTimerJobEnable-SPTimerJob Set-SPTimerJob Set-SPClaimProviderUpdates registration of a claims provider.SetSPClaimProviderSet-SPClaimProviderIdentitySPClaimProviderPipeBindAssignmentCollectionSPAssignmentCollectionDefaultSwitchParameterEnabledSwitchParameterIdentitySpecifies the claim provider to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a claim provider (for example, MyClaimProvider1); or an instance of a valid SPClaimProvider object.SPClaimProviderPipeBindSPClaimProviderPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection DefaultSpecifies that the claim provider applies to all Web applications and zones.SwitchParameterSwitchParameter EnabledTurns on the claim provider.SwitchParameterSwitchParameter The Set-SPClaimProvider cmdlet updates registration of a claims provider.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Set-SPClaimProvider -Identity "12345678-90ab-cdef-1234-567890bcdefgh"This example turns off the specified claim provider.Get-SPClaimProviderRemove-SPClaimProviderNew-SPClaimProvider Set-SPClaimProvider Set-SPBusinessDataCatalogMetadataObjectSets the value of a property or attribute of a Business Data Connectivity Metadata Store metadata object.SetSPBusinessDataCatalogMetadataObjectSet-SPBusinessDataCatalogMetadataObjectIdentityMetadataObjectAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterPropertyNameStringPropertyValuePSObjectRemoveSwitchParameterSettingIdStringWhatIfSwitchParameterSet-SPBusinessDataCatalogMetadataObjectIdentityMetadataObjectAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDisplayNameStringRemoveSwitchParameterSettingIdStringWhatIfSwitchParameterSet-SPBusinessDataCatalogMetadataObjectIdentityMetadataObjectAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterPropertyNameStringRemoveSwitchParameterRemoveSwitchParameterSettingIdStringWhatIfSwitchParameterIdentitySpecifies the Business Data Connectivity Metadata Store metadata object to update.MetadataObjectMetadataObject AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DisplayNameSpecifies the display name of the Business Data Connectivity Metadata Store metadata object.StringString PropertyNameSpecifies the name of the property to update.StringString PropertyValueSets the new value of the property specified in the PropertyName parameter.PSObjectPSObject RemoveRemoves the property specified in the PropertyName parameter.SwitchParameterSwitchParameter SettingIdSpecifies the custom environment settings model slice for which the property applies.The type must be a valid string that identifies a model slice; for example, ModelSlice1.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPBusinessDataCatalogMetadataObject cmdlet sets the value of a property or attribute of a Business Data Connectivity Metadata Store metadata object.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1------------------ C:\PS>$objectToSetOn = Get-SPBusinessDataCatalogMetadataObject -Namespace "ContosoDatabase" -Name "ContosoDatabase" -BdcObjectType "LobSystemInstance" -ServiceContext http://contosoThis example creates a property on the LobSystemInstance (External System Instance) of name ContosoDatabase. The property has the name ShowInSearchUI and a value of True.------------------EXAMPLE 2------------------ C:\PS>Set-SPBusinessDataCatalogMetadataObject -Identity $objectToSetOn -PropertyName "ShowInSearchUI" -PropertyValue "True"This example creates a property on the LobSystemInstance (External System Instance). The namespace parameter must be the name of the instance's LobSystem (External System). In this example, they share the same name.Get-SPBusinessDataCatalogMetadataObjectRevoke-SPBusinessDataCatalogMetadataObjectGrant-SPBusinessDataCatalogMetadataObject Set-SPBusinessDataCatalogMetadataObject Remove-SPContentDatabaseDeletes a content database.RemoveSPContentDatabaseRemove-SPContentDatabaseIdentitySPContentDatabasePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterWhatIfSwitchParameterIdentitySpecifies the content database to delete.The type must be a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint content database (for example, SPContentDB1); or an instance of a valid SPContentDatabase object.SPContentDatabasePipeBindSPContentDatabasePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPContentDatabase cmdlet deletes a content database permanently from Microsoft SQL Server 2008 R2, SQL Server 2008 with Service Pack 1 (SP1), or SQL Server 2005 with SP3. In situations where data needs to be persisted, use the Dismount-SPContentDatabase cmdlet. This will remove the content database from SharePoint 2010 Products but not from SQL Server 2008 R2, SQL Server 2008 with SP1, or SQL Server 2005 with SP3.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -----------------EXAMPLE--------------------- C:\PS>Get-SPContentDatabase 12345678-90ab-cdef-1234-567890abcdef | Remove-SPContentDatabaseThis example deletes the specified content database.Get-SPContentDatabaseNew-SPContentDatabaseSet-SPContentDatabaseUpgrade-SPContentDatabaseTest-SPContentDatabase Remove-SPContentDatabase Remove-SPServiceApplicationPoolCompletely deletes the specified Web service application pool.RemoveSPServiceApplicationPoolRemove-SPServiceApplicationPoolIdentitySPIisWebServiceApplicationPoolPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the identity of the Web service application pool to delete.SPIisWebServiceApplicationPoolPipeBindSPIisWebServiceApplicationPoolPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPServiceApplicationPool cmdlet completely deletes the specified Web service application pool.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Remove-SPServiceApplicationPool TestServiceWebApplicationPoolThis example deletes the selected service application pool.Get-SPServiceApplicationPoolSet-SPServiceApplicationPoolRemove-SPServiceApplicationPool Remove-SPServiceApplicationPool Set-SPServiceHostConfigConfigures one or more common settings for all Web services.SetSPServiceHostConfigSet-SPServiceHostConfigIdentitySPIisWebServiceSettingsAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterHttpPortInt32HttpsPortInt32ImportSslCertificateX509Certificate2NetTcpPortInt32NoWaitSwitchParameterWhatIfSwitchParameterSet-SPServiceHostConfigIdentitySPIisWebServiceSettingsSslCertificateThumbprintStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterHttpPortInt32HttpsPortInt32NetTcpPortInt32NoWaitSwitchParameterSslCertificateStoreNameStringWhatIfSwitchParameterIdentitySpecifies the identity of the Web service application to configure.SPIisWebServiceSettingsSPIisWebServiceSettings SslCertificateThumbprintSpecifies the thumbprint of the SSL certificate to retrieve for secure protocols.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter HttpPortSpecifies the new port for the Web service.Int32Int32 HttpsPortSpecifies the new secure port for the Web service.Int32Int32 ImportSslCertificateSpecifies the SSL Certificate to use for secure protocols.X509Certificate2X509Certificate2 NetTcpPortSets the TCP port for the Web service.Int32Int32 NoWaitFor more information, see TechNet.SwitchParameterSwitchParameter SslCertificateStoreNameSpecifies the thumbprint of the SSL certificate to retrieve for secure protocols.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set- SPServiceHostConfig cmdlet configures one or more common settings for all Web services.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Set-SPServiceHostConfig -Port 12345This example sets the HTTP port for the Web services. Get-SPServiceHostConfig Set-SPServiceHostConfig Get-SPAlternateURLReturns all alternate URLs that match a given set of criteria.GetSPAlternateURLGet-SPAlternateURLIdentitySPAlternateUrlPipeBindAssignmentCollectionSPAssignmentCollectionZoneDefault | Intranet | Internet | Custom | ExtranetGet-SPAlternateURLIdentitySPAlternateUrlPipeBindWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionZoneDefault | Intranet | Internet | Custom | ExtranetGet-SPAlternateURLIdentitySPAlternateUrlPipeBindResourceNameStringAssignmentCollectionSPAssignmentCollectionZoneDefault | Intranet | Internet | Custom | ExtranetIdentitySpecifies the URL or GUID of the alternate URL to get.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh, or a valid URL, in the form http://server_name.SPAlternateUrlPipeBindSPAlternateUrlPipeBind ResourceNameSpecifies the name of the resource from which to list alternate URLs.StringString WebApplicationSpecifies the Web application from which to list alternate URLs.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ZoneSpecifies one of the five zones with which the alternate URLs is associated.Must be a valid zone: Default, Intranet, Internet, Extranet, or CustomDefault | Intranet | Internet | Custom | ExtranetDefault | Intranet | Internet | Custom | Extranet The Get-SPAlternateURL cmdlet participates in a parameter set. The Get-SPAlternateURL cmdlet returns all alternate URLs that match the scope given by either the optional Identity parameter or by a combination of the optional WebApplication, Zone, or Resource parameters. Each criterion that is added narrows the scope. If no criteria are specified then all alternate URLs are returned.If the Identity parameter is used, only the specific matching alternate URL is returned. If no alternate URL with the given identity exists at the given scope, nothing is returned.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE 1----------------- C:\PS>Get-SPAlternateURL -WebApplication http://sitenameThis example displays all the alternate URLs on a given Web application.--------------EXAMPLE 2----------------- C:\PS>Get-SPAlternateURL -ResourceName "MyResource"This example displays all the alternate URLs for a given resource. New-SPAlternateUrlSet-SPAlternateUrlRemove-SPAlternateUrl Get-SPAlternateURL Set-SPTrustedServiceTokenIssuerUpdates a trust with the farm.SetSPTrustedServiceTokenIssuerSet-SPTrustedServiceTokenIssuerIdentitySPTrustedServiceTokenIssuerPipeBindAssignmentCollectionSPAssignmentCollectionCertificateX509Certificate2DescriptionStringIdentitySpecifies the trusted service token issuer to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted service token issuer (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object.SPTrustedServiceTokenIssuerPipeBindSPTrustedServiceTokenIssuerPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection CertificateSpecifies the X.509 certificate object from trusted authentication provider farm.The type must be a name of a valid X.509 certificate; for example, Certificate1.X509Certificate2X509Certificate2 DescriptionSpecifies a description for the trust.The type must be a valid string; for example, WFE Farm Trust1.StringString The Set-SPTrustedServiceTokenIssuer cmdlet updates a trust with a SharePoint farm. If a certificate file is used, it must have only one X509 certificate without private keys, otherwise an exception is raised.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1------------------ C:\PS>$cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx Set - SPTrustedServiceTokenIssuer "WFEFarm1" - Description "WFE Farm 1" - ImportTrustCertificate $certThis example updates a SharePoint Farm trust using the trust certificate from a file.------------------EXAMPLE 2------------------ C:\PS>Set - SPTrustedServiceTokenIssuer "WFEFarm1" - Description "WFE Farm 1" -FederationMetadataUrl "https://liveid.com/STS/2007/03/fedmetadata.xml"This example updates a SharePoint farm trust using the trust certificate from the federation metadata endpoint URL.Get-SPTrustedServiceTokenIssuerNew-SPTrustedServiceTokenIssuerRemove-SPTrustedServiceTokenIssuer Set-SPTrustedServiceTokenIssuer Get-SPServiceApplicationEndpointReturns the endpoint of a service application.GetSPServiceApplicationEndpointGet-SPServiceApplicationEndpointIdentitySPServiceEndpointPipeBindAssignmentCollectionSPAssignmentCollectionGet-SPServiceApplicationEndpointServiceApplicationSPServiceApplicationPipeBindAssignmentCollectionSPAssignmentCollectionNameStringIdentitySpecifies the service endpoint to get.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URI of an endpoint address, in the form http://sitename:8003/servicemodelsamples/service; or an instance of a valid SPServiceEndpoint object.SPServiceEndpointPipeBindSPServiceEndpointPipeBind ServiceApplicationSpecifies the service application to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPServiceApplication object.SPServiceApplicationPipeBindSPServiceApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection NameSpecifies the name of the service application endpoint.The type must be a valid name of an service application endpoint; for example, SvcAppEndpoint1.StringString The Get-SPServiceApplicationEndpoint cmdlet sets the host of a service endpoint. Use the second parameter set and do not specify the Name parameter to return a collection of all endpoints for the specified service application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). -------------------EXAMPLE-------------------- C:\PS>Get- SPServiceApplicationEndpoint -ServiceApplication "ServiceSubApp1"This example returns the SPServiceEndpoint object based on the specified service application.Set-SPServiceApplicationEndpoint Get-SPServiceApplicationEndpoint Get-SPDesignerSettingsDisplays Microsoft SharePoint Designer 2010 features.GetSPDesignerSettingsGet-SPDesignerSettingsWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionWebApplicationSpecifies the Web application in which the settings apply.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPDesignerSettings cmdlet determines whether SharePoint Designer 2010 features are enabled on the specified Web application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ---------------------EXAMPLE------------------------ C:\PS>Get-SPDesignerSettings -webapplication http://contosoThis example retrieves the SharePoint Designer 2010 settings for the Web application, http://contoso.Set-SPDesignerSettings Get-SPDesignerSettings New-SPWebApplicationCreates a new Web application within the local farm.NewSPWebApplicationNew-SPWebApplicationApplicationPoolStringNameStringAdditionalClaimProviderSPClaimProviderPipeBind[]AllowAnonymousAccessSwitchParameterApplicationPoolAccountSPProcessAccountPipeBindAssignmentCollectionSPAssignmentCollectionAuthenticationMethodStringAuthenticationProviderSPAuthenticationProviderPipeBind[]ConfirmSwitchParameterDatabaseCredentialsPSCredentialDatabaseNameStringDatabaseServerStringHostHeaderStringPathStringPortUInt32SecureSocketsLayerSwitchParameterServiceApplicationProxyGroupSPServiceApplicationProxyGroupPipeBindSignInRedirectProviderSPTrustedIdentityTokenIssuerPipeBindSignInRedirectURLStringUrlStringWhatIfSwitchParameterApplicationPoolSpecifies the name of an application pool to use; for example, SharePoint - 1213. If an application pool with the name provided does not exist, the ApplicationPoolAccount parameter must be provided and a new application pool will be created. If no value is specified, the default application pool will be used.StringString NameSpecifies the name of the new Web application.StringString AdditionalClaimProviderAdds a specific claim provider to the defined Web application.SPClaimProviderPipeBind[]SPClaimProviderPipeBind[] AllowAnonymousAccessAllows anonymous access to the Web application.SwitchParameterSwitchParameter ApplicationPoolAccountSpecifies the user account that this application pool will run as. Use the Get-SPIisWebServicApplicationPool cmdlet to use a system account.SPProcessAccountPipeBindSPProcessAccountPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection AuthenticationMethodUses Kerberos or NTLM to specify the authentication method. If no value is specified, the default NTLM is applied.StringString AuthenticationProviderSpecifies the authentication provider or providers that apply to a Web application.SPAuthenticationProviderPipeBind[]SPAuthenticationProviderPipeBind[] ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DatabaseCredentialsSpecifies the Windows PowerShell Credential object for the database user account.PSCredentialPSCredential DatabaseNameSpecifies the name of the initial content database for the new Web application.The type must be a valid database name; for example, ContentDB1. If no value is specified, a value in the format WSS_Content_<GUID> is auto-generated.StringString DatabaseServerSpecifies the database server name. The type must be a valid database server name, in the form SQL1; where named instances are used, the format can appear as server\server. The default SQL server instance is used if a value is not provided.StringString HostHeaderSpecifies a valid URL assigned to the Web application that must correlate to the alternate access mapping configuration, in the form http://server_name.When the HostHeader parameter is present, the value of this field is the internal URL for the Web application. The Url parameter is used to specify the public URL. If no value is specified, the value is left blank.StringString PathSpecifies the physical directory for the new Web application in the virtual directories folder. The type is a valid path, in the form C:\Inutepub\wwwroot\MyWebApplication. If no value is specified, the value %wwwroot%\wss\VirtualDirectories\<portnumber> is applied.StringString PortSpecifies the port on which this Web application can be accessed. This can be any valid port number. If no port is specified, a nonconflicting port number is automatically generated.If you specify a port number that has already been assigned, IIS does not start the new site until you change either the port number of the new site or the port number of the old site.UInt32UInt32 SecureSocketsLayerEnables Secure Sockets Layer (SSL) encryption for this Web application. If you choose to use SSL, you must add the certificate on each server by using the IIS administration tools. Until this is done, the Web application will be inaccessible from this IIS Web site.SwitchParameterSwitchParameter ServiceApplicationProxyGroupSpecifies a custom service application proxy group for the Web application to use. The Web application will use the proxies in this proxy group to connect to service applications. If this parameter is not specified, the default proxy group for the farm is used.SPServiceApplicationProxyGroupPipeBindSPServiceApplicationProxyGroupPipeBind SignInRedirectProviderSets the sign-in redirect URL to point to the URL that is defined in the specified authentication provider.SPTrustedIdentityTokenIssuerPipeBindSPTrustedIdentityTokenIssuerPipeBind SignInRedirectURLSpecifies the sign-in redirect URL for the Web application.StringString UrlSpecifies the load-balanced URL for the Web application.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Creates a new Web application specified by the Name parameter. The user specified by the DatabaseCredentials parameter must be a member of the dbcreator fixed server role on the database server.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>New-SPWebApplication -Name "Contoso Internet Site" -Port 80 -HostHeader "http://sharepoint.contoso.com" -URL "https://www.contoso.com" -ApplicationPool "ContosoAppPool" -ApplicationPoolAccount (Get-SPManagedAccount "DOMAIN\jdoe")This example creates a new Web application by using an internal host header of sharepoint.contoso.com and a public URL of https://www.contoso.com.Get-SPWebApplicationSet-SPWebApplicationGet-SPWebApplication New-SPWebApplication Set-SPTopologyServiceApplicationProxySets the proxy properties of the topology service application.SetSPTopologyServiceApplicationProxySet-SPTopologyServiceApplicationProxyIdentitySPTopologyWebServiceProxyPipeBindBadListPeriodStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the GUID of the application proxy.The type must be a valid GUID, in the form 1234-4567-098jhj.SPTopologyWebServiceProxyPipeBindSPTopologyWebServiceProxyPipeBind BadListPeriodSpecifies the time period that a node is kept in a bad list.The type must be a valid value between 1 and 480 (in minutes).The default value is 10 .StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPTopologyServiceApplicationProxy cmdlet sets the properties of the local topology service application proxy and the default load balancer.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Set-SPTopologyServiceApplicationProxy 67877d63-bff4-4521-867a-ef4979ba07ce -BadListPeriod 1234This example sets the bad list period for the given topology service application proxy.The topology service application GUID is unique to every farm. You can run the Get-SPTopologyServiceApplication cmdlet to retrieve the GUID.Get-SPTopologyServiceApplicationProxyGet-SPTopologyServiceApplication Set-SPTopologyServiceApplicationProxy Set-SPBusinessDataCatalogServiceApplicationSets global properties for a Business Data Connectivity service application in the farm.SetSPBusinessDataCatalogServiceApplicationSet-SPBusinessDataCatalogServiceApplicationIdentitySPServiceApplicationPipeBindApplicationPoolSPIisWebServiceApplicationPoolAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDatabaseCredentialsPSCredentialDatabaseNameStringDatabasePasswordSecureStringDatabaseServerStringDatabaseUsernameStringFailoverDatabaseServerStringNameStringSharingSwitchParameterWhatIfSwitchParameterApplicationPoolSpecifies the IIS application pool to use for the new Business Data Connectivity service application.SPIisWebServiceApplicationPoolSPIisWebServiceApplicationPool DatabaseCredentialsSpecifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication.The type must be a valid PSCredential object.PSCredentialPSCredential DatabaseNameSpecifies the name of the Business Data Connectivity database.The type must be a valid name of a SQL Server database; for example, UsageLogDB1.StringString DatabasePasswordSpecifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database.The type must be a valid password.SecureStringSecureString DatabaseServerSpecifies the name of the Business Data Connectivity database.The type must be a valid name of a SQL Server database; for example, UsageLogDB1.StringString DatabaseUsernameSpecifies the user name to use for connecting to the catalog database. Use this parameter only if SQL Server Authentication is used to access the Business Data Connectivity database.The type must be a valid user name; for example, UserName1.StringString FailoverDatabaseServerSpecifies the name of the host server for the failover database server.The type must be a valid SQL Server host name; for example, SQLServerHost1.StringString IdentitySpecifies the Business Data Connectivity service application associated with the new proxy.SPServiceApplicationPipeBindSPServiceApplicationPipeBind NameSpecifies a display name for the new Business Data Connectivity service application proxy.StringString SharingSpecifies that the Business Data Connectivity service application is published and shared across the farm.SwitchParameterSwitchParameter AssignmentColletionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPBusinessDataCatalogServiceApplication cmdlet sets global properties for a Business Data Connectivity service application in the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>Set-SPBusinessDataCatalogServiceApplication -Identity $serviceApplication -FailoverDatabaseServer "CONTOSO\Backup"This example sets the failover database server to CONTOSO\Backup for the given service application.New-SPBusinessDataCatalogServiceApplicationNew-SPBusinessDataCatalogServiceApplicationProxy Set-SPBusinessDataCatalogServiceApplication New-SPSiteCreates a new site collection at the specified URL.NewSPSiteNew-SPSiteUrlStringOwnerAliasSPUserPipeBindAdministrationSiteTypeNone | TenantAdministrationAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterContentDatabaseSPContentDatabasePipeBindDescriptionStringHostHeaderWebApplicationSPWebApplicationPipeBindLanguageUInt32NameStringOwnerEmailStringQuotaTemplateSPQuotaTemplatePipeBindSecondaryEmailStringSecondaryOwnerAliasSPUserPipeBindSiteSubscriptionSPSiteSubscriptionPipeBindTemplateSPWebTemplatePipeBindWhatIfSwitchParameterUrlSpecifies the URL that the new site collection uses. If the URL is not a host header site, the URL must start with the the Web application URL.StringString OwnerAliasSpecifies the user login name of the site owner.The type must be a valid user alias, in the form Domain\username.SPUserPipeBindSPUserPipeBind AdministrationSiteTypeSpecifies the site type.Valid values are None or TentantAdministration.None | TenantAdministrationNone | TenantAdministration AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ContentDatabaseSpecifies the name or GUID of the content database in which to create the new site. If no content database is specified, the site collection is selected automatically. The type must be a valid database name, in the form SiteContent1212, or a GUID, in the form 1234-5678-9807.SPContentDatabasePipeBindSPContentDatabasePipeBind DescriptionDescribes the new site. If no value is specified, the value is left blank.StringString HostHeaderWebApplicationSpecifies that if the URL provided is a host header, the HostHeaderWebApplication parameter must be the name, URL, GUID, or SPWebApplication object for the Web application in which this site collection is created. If no value is specified, the value is left blank.The type must be a valid name, in the form WebApplication-1212; a URL (for example, http://server_name); or a GUID (for example, 1234-5678-9876-0987).SPWebApplicationPipeBindSPWebApplicationPipeBind LanguageSpecifies the language ID for the new site collection. If no language is specified, the site collection is created with the same language that was specified when the product was installed.This must be a valid language identifier (LCID).UInt32UInt32 NameSpecifies the title of the new site collection. If no name is specified, the default name is applied.StringString OwnerEmailSpecifies the e-mail address of site owner. If no value is specified, the value is left blank.The type must be a valid e-mail address in the form, someone@example.com.StringString QuotaTemplateSpecifies the quota template for the new site. The template must exist already. If no template is specified, no quota is applied.SPQuotaTemplatePipeBindSPQuotaTemplatePipeBind SecondaryEmailSpecifies the e-mail address of the secondary site owner. If no value is specified, the value is left blank.The type must be a valid e-mail address, in the form someone@example.com.StringString SecondaryOwnerAliasSpecifies the user login credentials of the secondary site owner. If no value is specified, the value is left blank.The type must be a valid user alias, in the form Domain\username.SPUserPipeBindSPUserPipeBind SiteSubscriptionSpecifies the Site Group to get site collections.SPSiteSubscriptionPipeBindSPSiteSubscriptionPipeBind TemplateSpecifies the Web template for the root Web of the new site collection. The template must be already installed. If no template is specified, no template is provisioned.SPWebTemplatePipeBindSPWebTemplatePipeBind WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The New-SPSite cmdlet creates a new site collection with the URL and owner specified by the Url and OwnerAlias parameters.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1----------------------- C:\PS>New-SPSite http://sitename/sites/test -OwnerAlias "DOMAIN\JDoe" -Language 1033This example creates an English site collection at http://sitename/sites/test that is owned by user DOMAIN\Jdoe.------------------EXAMPLE 2----------------------- C:\PS>$w = Get-SPWebApplication http://sitename C:\PS>New-SPSite http://www.contoso.com -OwnerAlias "DOMAIN\jdoe" -HostHeaderWebApplication $w -Title "Contoso" -Template "STS#0"This example creates a host header site collection. Because the template is provided, the root Web of this site collection will be created.------------------EXAMPLE 3----------------------- C:\PS>Get-SPWebTemplate | Where{ $_.Title -eq "Team Site" } | ForEach-Object{ New-SPSite http://sitename/sites/test -OwnerAlias DOMAIN\jdoe -Template $_ }This example creates a site collection by using the "Team Site" Web template.Get-SPSiteSet-SPSiteBackup-SPSiteMove-SPSiteRestore-SPSite New-SPSite Get-SPCertificateAuthorityReturns the SharePoint certificate authority (CA).GetSPCertificateAuthorityGet-SPCertificateAuthorityAssignmentCollectionSPAssignmentCollectionAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPCertificateAuthority cmdlet returns the SharePoint certificate authority (CA).For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>$signingCert = (Get-SPServiceApplication | where $_.Name -eq 'SecurityTokenServiceApplication').SigningCertificateThis example gets the security token service (STS) identity provider signing certificate. Get-SPCertificateAuthority Test-SPContentDatabaseTests a content database.TestSPContentDatabaseTest-SPContentDatabaseIdentitySPContentDatabasePipeBindAssignmentCollectionSPAssignmentCollectionDatabaseCredentialsPSCredentialServerInstanceSPDatabaseServiceInstancePipeBindShowRowCountsSwitchParameterTest-SPContentDatabaseNameStringWebApplicationSPWebApplicationPipeBindAssignmentCollectionSPAssignmentCollectionDatabaseCredentialsPSCredentialServerInstanceSPDatabaseServiceInstancePipeBindShowRowCountsSwitchParameterIdentitySPContentDatabasePipeBindSPContentDatabasePipeBind NameSpecifies the existing content database to test.The type must be a valid name of a SharePoint content database; for example, SPContentDB1.StringString WebApplicationSpecifies the SharePoint Web application to use to test the content database.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection DatabaseCredentialsSpecifies the PSCredential object that contains the user name and password to be used for database SQL Server Authentication.The type must be a valid PSCredential object.PSCredentialPSCredential ServerInstanceSpecifies the instance of the database service to use to test the specified content database.The type must be a valid GUID, such as 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SQL Server instance (for example, DBSvrInstance1); or an instance of a valid SPDatabaseServiceInstance object.SPDatabaseServiceInstancePipeBindSPDatabaseServiceInstancePipeBind ShowRowCountsSwitchParameterSwitchParameter Use the Test-SPContentDatabase cmdlet to test a content database against a Web application to verify all customizations referenced within the content database are also installed in the web application. This cmdlet can be issued against a content database currently attached to the farm, or a content database that is not connected to the farm. It can be used to test content databases from SharePoint 2010 Products and from SharePoint Products and Technologies.The Test-SPContentDatabase cmdlet does not change any of the data or structure of the content database, but can cause load on the database while the checks are in progress, which could temporarily block use of the content database. This cmdlet should only be used against a content database that is currently under low or no usage.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ----------------------------EXAMPLE 1----------------------- C:\PS>Test-SPContentDatabase -name WSS_Content_DB -webapplication http://sitenameThis example tests the WSS_Content_DB content database against the sitename Web application, and returns a list of issues.----------------------------EXAMPLE 2----------------------- C:\PS>$DB = Get-SPContentDatabase -site http://contoso.com C:\PS>Test-SPContentDatabase $DB -showrowcountsThis example gets the content database that contains the site collection at http://contoso.com, and then tests the database against the Web application that hosts it to determine issues. Together with displaying the list of issues, by specifying the ShowRowCounts parameter, this also returns the table size metrics from the content database.Get-SPContentDatabaseNew-SPContentDatabaseSet-SPContentDatabaseRemove-SPContentDatabaseMount-SPContentDatabaseUpgrade-SPContentDatabaseInitialize-SPContentDatabase Test-SPContentDatabase Set-SPWebTemplateChanges the title and description of an installed site template.SetSPWebTemplateSet-SPWebTemplateIdentitySPWebTemplatePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDescriptionStringNameStringWhatIfSwitchParameterIdentitySpecifies the name of the Web template to be changed.The type must the ID or full name of the Web template.SPWebTemplatePipeBindSPWebTemplatePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DescriptionSpecifies the new description.The type must be a valid description; for example, This is template.StringString NameSpecifies the new name for the template.StringString WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPWebTemplate cmdlet changes the title and description of an installed site template.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Get-SPSiteTemplate "ATH#0" | Set-SPSiteTemplate -name "Athletics Site" C:\PS>Set-SPSiteTemplate "ATH#0" -name "Athletics Site"This examples change the ATH#0 template title to Athletics Site.Get-SPWebTemplateInstall-SPWebTemplateUninstall-SPWebTemplate Set-SPWebTemplate Set-SPWebApplicationHttpThrottlingMonitorSets the Health Score bucket values for an existing network throttling performance counter for a specified Web application.SetSPWebApplicationHttpThrottlingMonitorSet-SPWebApplicationHttpThrottlingMonitorIdentitySPWebApplicationPipeBindCategoryStringCounterStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterHealthScoreBucketsDouble[]InstanceStringIsDESCSwitchParameterLowerLimitDoubleUpperLimitDoubleWhatIfSwitchParameterIdentitySpecifies the SharePoint Web application to update.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a SharePoint Web application (for example, MyOfficeApp1); or an instance of a valid SPWebApplication object.SPWebApplicationPipeBindSPWebApplicationPipeBind CategorySpecifies the name of the performance counter category.The type must be a valid performance counter category in the throttling monitor. Use the Get-SPWebApplicationHttpThrottlingMonitor cmdlet to return a list of performance counter categories in the throttling monitor.StringString CounterSpecifies the name of the performance counter.The type must be a valid performance counter in the throttling monitor. Use the Get-SPWebApplicationHttpThrottlingMonitor cmdlet to return a list of performance counters in the throttling monitor.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter HealthScoreBucketsSpecifies bucket ranges to use in determining the calculation of the server Health Score for this counter.Double[]Double[] InstanceSpecifies the instance of the performance counter. The default value is empty. If the specified value is invalid, this cmdlet will not run.StringString IsDESCSpecifies that this counter is interpreted in descending order. If this parameter is set, Health Score bucket values are interpreted in descending order; for example, set this parameter by using the Memory category and Available Mbytes counter to monitor available memory.SwitchParameterSwitchParameter LowerLimitSpecifies the lower limit of the numerical threshold of the specified performance counter. The lower limit is the lowest value in the Health Score bucket values.DoubleDouble UpperLimitSpecifies the upper limit of the numerical threshold of the specified performance counter. The upper limit is the highest value in the Health Score bucket values.DoubleDouble WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPWebApplicationHttpThrottlingMonitor cmdlet sets the Health Score bucket values for an existing network throttling performance counter for a specified Web application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1------------------ C:\PS>$buckets=(2000,1000,500,300,200,100,50,30,20,10) Set-SPWebApplicationHttpThrottlingMonitor http://sharepoint - Category Memory -Counter 'Available Mbytes' -IsDesc -HealthScoreBuckets $bucketsThis example sets the Health Score bucket values for the Memory\Available Mbytes counter to the array listed for the http://sharepoint Web application.------------------EXAMPLE 2------------------ C:\PS>Set-SPWebApplicationHttpThrottlingMonitor http://sharepoint 0 -Category Memory -Counter 'Available Mbytes' -IsDesc -UpperLimit 3000This example sets the upper limit for the Memory\Available Mbytes counter, the highest value in the Health Score buckets, to 3000 for the the http://sharepoint Web application.Get-SPWebApplicationHttpThrottlingMonitorEnable-SPWebApplicationHttpThrottlingDisable-SPWebApplicationHttpThrottling Set-SPWebApplicationHttpThrottlingMonitor Get-SPFeatureReturns the SharePoint Features based on a given scope.GetSPFeatureGet-SPFeatureIdentitySPFeatureDefinitionPipeBindAssignmentCollectionSPAssignmentCollectionLimitStringGet-SPFeatureIdentitySPFeatureDefinitionPipeBindAssignmentCollectionSPAssignmentCollectionFarmSwitchParameterLimitStringGet-SPFeatureIdentitySPFeatureDefinitionPipeBindAssignmentCollectionSPAssignmentCollectionLimitStringSandboxedSwitchParameterSiteSPSitePipeBindGet-SPFeatureIdentitySPFeatureDefinitionPipeBindAssignmentCollectionSPAssignmentCollectionLimitStringWebSPWebPipeBindGet-SPFeatureIdentitySPFeatureDefinitionPipeBindAssignmentCollectionSPAssignmentCollectionLimitStringWebApplicationSPWebApplicationPipeBindIdentitySpecifies the name of the Feature to retrieve.The type must be the full or partial name, in the form Feature1, or a GUID, in the form 1234-4567-9879, of the Feature to get .SPFeatureDefinitionPipeBindSPFeatureDefinitionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection FarmSpecifies that if this parameter is used, only enabled farm Features are displayed.SwitchParameterSwitchParameter LimitLimits the display results. If "All " is specified, all Features are displayed.The type must be a valid number greater than 0. The default value is 200.StringString SiteSpecifies the name of the site collection from which to get enabled Features.The type must be a valid URL for a site collection, in the form http://server_name .SPSitePipeBindSPSitePipeBind WebSpecifies the URL or GUID of the Web.The type must be a valid URL, in the form http://server_name , or a GUID, in the form 1234-5678-9876-0987.SPWebPipeBindSPWebPipeBind WebApplicationSpecifies the name of the Web application from which to get enabled Features.The type must be a valid URL to the Web application in the form http://server_name .SPWebApplicationPipeBindSPWebApplicationPipeBind The SPFeature cmdlet participates in a parameter set. All parameter sets take the Identity parameter, which can be either the relative path of the SharePoint Feature (considered the feature name) or the GUID of a Feature definition. If the Identity parameter is provided, the cmdlets attempt to find the given Feature definition or instance for the given scope. If no parameters are specified, all installed features are returned.The Get-SPFeature cmdlet behaves differently at each scope, returning the enabled Features at each level. If no scope is provided, all installed Features are returned.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE 1----------------- C:\PS>Get-SPFeature -Limit ALL | Where-Object {$_.Scope -eq "SITE"}This example returns a list of all installed SITE scoped Features.--------------EXAMPLE 2----------------- C:\PS>Get-SPSite http://somesite | Get-SPWeb -Limit ALL |%{ Get-SPFeature -Web $_ } | Select DisplayName,ID -UniqueThis example returns the name and identifier (ID) of each uniquely enabled Feature on every SPWeb object in the site collection at http://somesite.Install-SPFeatureEnable-SPFeatureDisable-SPFeatureUninstall-SPFeature Get-SPFeature Remove-SPSiteCompletely deletes an existing site collection and all subsites.RemoveSPSiteRemove-SPSiteIdentitySPSitePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDeleteADAccountsSwitchParameterGradualDeleteSwitchParameterWhatIfSwitchParameterIdentitySpecifies the identity of the site to delete. The identity can be either a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPSite object.SPSitePipeBindSPSitePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DeleteADAccountsForces deletion of user accounts from Active Directory Domain Services (AD DS). This applies when in AD DS account creation mode and the value of this parameter is True, AD DS accounts associated with the site collection are also deleted from AD DS.SwitchParameterSwitchParameter GradualDeleteIf provided, occurs gradually to use less system load. This operation is strongly recommended for deleting very large sites.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPSite cmdlet completely deletes an existing site collection and all subsites. This operation cannot be undone.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Remove-SPSite -Identity "http://sitename" -GradualDelete -Confirm:$FalseThis example removes the given site collection and all included sites by using GradualDelete; confirmation has been suppressed.Get-SPSiteSet-SPSiteNew-SPSiteBackup-SPSiteRemove-SPSiteMove-SPSiteRestore-SPSite Remove-SPSite Get-SPSiteReturns all site collections that match the given criteria.GetSPSiteGet-SPSiteAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterFilterScriptBlockLimitStringWebApplicationSPWebApplicationPipeBindWhatIfSwitchParameterGet-SPSiteIdentitySPSitePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterFilterScriptBlockLimitStringRegexSwitchParameterWhatIfSwitchParameterGet-SPSiteContentDatabaseSPContentDatabasePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterFilterScriptBlockLimitStringWhatIfSwitchParameterGet-SPSiteSiteSubscriptionSPSiteSubscriptionPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterFilterScriptBlockLimitStringWhatIfSwitchParameterIdentitySpecifies t he URL or GUID of the site collection to get. The type must be a valid URL, in the form http://server_name or http://server_name/sites/sitename, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh).SPSitePipeBindSPSitePipeBind ContentDatabaseSpecifies the GUID of the content database from which to list site collections.The type must be a valid database name, in the form SPContentDB01, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh). SPContentDatabasePipeBindSPContentDatabasePipeBind SiteSubscriptionSpecifies the site subscription from which to get site collections.The type must be a valid URL, in the form http://server_name or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh).SPSiteSubscriptionPipeBindSPSiteSubscriptionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter FilterSpecifies the script block of the server-side filter to apply.The type must be a valid filter name and value in the form {$_PropertyName <operator> "filterValue"}.Valid operators are: EQ, NE, LIKE, NOTLIKE.ScriptBlockScriptBlock LimitLimits the maximum number of site collections to return. The default value is 200.The type must be a valid non-negative number. Specify ALL to return all site collections for the given scope.StringString RegexWhen used, the URL provided for the Identity parameter to be treated as a regular expression.The type must be a valid number between 0 and ?? SwitchParameterSwitchParameter WebApplicationSpecifies the URL, GUID, or name of the Web application from which to list sites.The type must be a valid URL, in the form http://server_name, a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh); or the Web application name (for example, WebApplication1212).SPWebApplicationPipeBindSPWebApplicationPipeBind WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Get-SPSite cmdlet returns either a single site that matches the Identity parameter, or all the sites that match the Filter parameter for the specified scope. The scopes are the WebApplication, ContentDatabase , and SiteSubscription parameters. If none of these scopes is provided, the scope is the farm. If the scope is specified with no Filter parameter, all sites in that scope are returned.The Identity parameter supports providing a partial URL that ends in a wildcard character (*). All site collections that match this partial URL for the specified scope are returned. Additionally, if the Regex parameter is provided, the Identity parameter is treated as a regular expression and any site collection with a URL provided in the given scope that matches the expression is returned.The Filter parameter is a server-side filter for certain site collection properties that are stored in the content database; without the Filter parameter, filtering on these properties is a slow process. These site collection properties are Owner, SecondaryOwner, and LockState. The Filter parameter is a script block that uses the same syntax as a Where-Object statement, but is run server-side for faster results.Valid values for LockState are, Unlock, NoAdditions, ReadOnly, NoAccess.It is important to note that every site collection returned by the Get-SPSite cmdlet is automatically disposed of at the end of the pipeline. To store the results of Get-SPSite in a local variable, the Start-SPAssignment and Stop-SPAssignment cmdlets must be used to avoid memory leaks.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). None------------------EXAMPLE 1--------------------- C:\PS>Get-SPSite 'http://sitename' | Get-SPWeb -Limit All | Select TitleThis example gets the collection of subweb titles in site collection at http://sitename.------------------EXAMPLE 2--------------------- C:\PS>Get-SPSite -ContentDatabase "b399a366-d899-4cff-8a9b-8c0594ee755f" | Format-Table -Property Url, Owner, SecondaryOwnerThis example gets a subset of data from all of the sites in the content database b399a366-d899-4cff-8a9b-8c0594ee755f.------------------EXAMPLE 3--------------------- C:\PS>Start-SPAssignment -Global C:\PS>$s = Get-SPSite -Identity http://MyApp/Sites/Site1 C:\PS>$s.Url C:\PS>Stop-SPAssignment -GlobalThis example gets the sites specified by the Identity parameter and inserts the results in the variable sThe previous example uses the Global method of assignment collection. The Global method is easier to use but the contents of this object grows quickly. Be careful not to run a Get-SPSite command that returns many results while global assignment is enabled.------------------EXAMPLE 4--------------------- C:\PS>$GC = Start-SPAssignment C:\PS>$Sites = $GC | Get-SPSite -Filter {$_.Owner -eq "DOMAIN\JDoe"} -Limit 50 C:\PS>Stop-SPAssignment $GCThis example gets the first 50 sites owned by user DOMAIN\JDoe by using a server-side query, and assigns them to a local variable.This example uses advanced assignment collection methods.------------------EXAMPLE 5--------------------- C:\PS>Get-SPWebApplication http://sitename | Get-SPSite -Limit All |ForEach-Object {$sum=0}{ $sum+=$_.Usage.Storage }{$sum}This example shows a command that returns the sum of the disk space usage for all sites in a given Web application.------------------EXAMPLE 6--------------------- C:\PS>Get-SPSite -identity "http://localserver/(my|personal)/sites" -RegexThis example returns all sites that match the given regular expression.The Quotes on the Identity parameter are required when the Regex parameter is used.------------------EXAMPLE 7--------------------- C:\PS>Get-SPSite http://sitename/sites/teams/* -Limit 100This example gets up to 100 of the sites under the URL http://sitename/sites/teams.------------------EXAMPLE 8--------------------- C:\PS>Get-SPSite | select url, @{Expression={$_.Usage.Storage}}This example gets the amount of storage used by a site collection, by using the storage field of the .UsageInfo property.Backup-SPSiteMove-SPSiteNew-SPSiteRemove-SPSiteRestore-SPSiteSet-SPSite Get-SPSite New-SPBusinessDataCatalogServiceApplicationProxyCreates a new Business Data Connectivity service application proxy in the farm.NewSPBusinessDataCatalogServiceApplicationProxyNew-SPBusinessDataCatalogServiceApplicationProxyUriUriAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDefaultProxyGroupSwitchParameterNameStringPartitionModeSwitchParameterWhatIfSwitchParameterNew-SPBusinessDataCatalogServiceApplicationProxyServiceApplicationSPServiceApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDefaultProxyGroupSwitchParameterNameStringWhatIfSwitchParameterNameSpecifies a display name for the new Business Data Connectivity service application proxy. StringString ServiceApplicationSpecifies the Business Data Connectivity service application associated with the new proxy.SPServiceApplicationPipeBindSPServiceApplicationPipeBind UriSpecifies the URI of a remote service application to which to connect.The type must be a valid URI, in the form file:\\server_name\sitedocs.UriUri AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DefaultProxyGroupSpecifies that the service application proxy is added to the default proxy group for the farm.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The New-SPBusinessDataCatalogServiceApplicationProxy cmdlet creates a new Business Data Connectivity service application proxy for a Business Data Connectivity service application in the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE------------------ C:\PS>New-SPBusinessDataCatalogServiceApplicationProxy -Name "ContosoServiceAppProxy" -ServiceApplication $serviceApplicationThis example creates a new Business Data Connectivity service application proxy with the name ContosoServiceAppProxy for the given service application.New-SPBusinessDataCatalogServiceApplicationSet-SPBusinessDataCatalogServiceApplication New-SPBusinessDataCatalogServiceApplicationProxy Uninstall-SPWebTemplateUninstalls the given site template.UninstallSPWebTemplateUninstall-SPWebTemplateIdentitySPWebTemplatePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterLanguageUInt32WhatIfSwitchParameterIdentitySpecifies the ID or full name of the site template to remove.A valid site template; for example, MYTEMP#0.SPWebTemplatePipeBindSPWebTemplatePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter LanguageSpecifies the language of the file to remove. If this parameter is not provided, all the languages of given template are removed . The default value is ALL.The type must be a valid language locale ID. For English, use 1033 .UInt32UInt32 WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Uninstall-SPWebTemplate cmdlet uninstalls the given site template by providing a full identity.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). None.------------------EXAMPLE----------------------- C:\PS>Uninstall-SPWebTemplate "mytemplate" C:\PS>Get-SPWebTemplate "mytemplate" | Uninstall-SPWebTemplateThis example removes a site template named mytemplate.Get-SPWebTemplateInstall-SPWebTemplateSet-SPWebTemplate Uninstall-SPWebTemplate New-SPSubscriptionSettingsServiceApplicationProxyCreates an application proxy to a subscription settings service application.NewSPSubscriptionSettingsServiceApplicationProxyNew-SPSubscriptionSettingsServiceApplicationProxyUriStringAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterNew-SPSubscriptionSettingsServiceApplicationProxyServiceApplicationSPServiceApplicationPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterServiceApplicationSpecifies the subscription settings service application associated with the new proxy.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPServiceApplication object.SPServiceApplicationPipeBindSPServiceApplicationPipeBind UriSpecifies the address of the subscription settings service application to associate the new application proxy with.The type must be a valid URI, in the form file:\\server_name\sitedocs.StringString AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Use the New-SPSubscriptionSettingsServiceApplicationProxy cmdlet to create an application proxy to a subscription settings service application. This is required for the local farm to consume a subscription settings service application.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185).--------------------EXAMPLE--------------------------- C:\PS>$AppPool = New-SPIisWebServiceApplicationPool -Name SettingsServiceAppPool -Account (Get-SPManagedAccount DOMAIN\jdoe) C:\PS>$App = New-SPSubscriptionSettingsServiceApplication -ApplicationPool $appPool -Name SettingsServiceApp -DatabaseName SettingsServiceDB C:\PS>$proxy = New-SPSubscriptionSettingsServiceApplicationProxy -ServiceApplication $App C:\PS>Get-SPServiceInstance | where{$_.TypeName -eq "Windows SharePoint Services Subscription Settings Service"} | Start-SPServiceInstanceThis example creates an application pool, a new settings service application, a settings service application proxy, and then starts the service instance on the local machine. This example assumes that a managed account for DOMAIN\jdoe already exists.New-SPSubscriptionSettingsServiceApplicationSet-SPSubscriptionSettingsServiceApplication New-SPSubscriptionSettingsServiceApplicationProxy Set-SPSiteConfigures the specified sites.SetSPSiteSet-SPSiteIdentitySPSitePipeBindAdministrationSiteTypeNone | TenantAdministrationAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterLockStateStringMaxSizeInt64OwnerAliasSPUserPipeBindQuotaTemplateSPQuotaTemplatePipeBindSecondaryOwnerAliasSPUserPipeBindTemplateSPWebTemplatePipeBindUrlStringUserAccountDirectoryPathStringWarningSizeInt64WhatIfSwitchParameterSet-SPSiteIdentitySPSitePipeBindAdministrationSiteTypeNone | TenantAdministrationAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterSiteSubscriptionSPSiteSubscriptionPipeBindWhatIfSwitchParameterIdentitySpecifies the URL or GUID of the site collection to configure, or refers to an SPSite object that contains sites to configure.The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPSite object.SPSitePipeBindSPSitePipeBind AdministrationSiteTypeSpecifies the site type.Valid values are None or TentantAdministration.None | TenantAdministrationNone | TenantAdministration AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceSuppresses confirmation messages involved in setting the site subscription. This parameter is used in conjunction with the SiteSubscription parameter.SwitchParameterSwitchParameter LockStateSets the lock state of this site collection. The valid lock states are Unlock, Content, ReadOnly, or NoAccess.StringString MaxSizeSets the maximum storage size for the site collection in megabytes.The integer value must be larger than the WarningSize value. You cannot use this parameter if the site collection is using a quota template.Int64Int64 OwnerAliasSpecifies the owner's name of the site collection.SPUserPipeBindSPUserPipeBind QuotaTemplateSpecifies the new quota template for this site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef.SPQuotaTemplatePipeBindSPQuotaTemplatePipeBind SecondaryOwnerAliasSets the secondary owner.The type must be a valid e-mail alias, in the form domain\username.SPUserPipeBindSPUserPipeBind SiteSubscriptionSpecifies the Site Group to get site collections.SPSiteSubscriptionPipeBindSPSiteSubscriptionPipeBind TemplateSpecifies the template for this site collection. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef.SPWebTemplatePipeBindSPWebTemplatePipeBind UrlSpecifies the URL name of the new site.StringString UserAccountDirectoryPathSets an organization unit to which to scope user accounts.StringString WarningSizeSets the storage warning level for the site collection.The integer value must be between 0 and the MaxSize value. You cannot use this parameter if the site collection is using a quota template.Int64Int64 WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Set-SPSite cmdlet configures the site collection that is specified by the Identity parameter. If a parameter is not used, the value is not changed.The QuotaTemplate parameter is mutually exclusive to the MaxSize parameter and WarningSize parameter.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE 1--------------------- C:\PS>Get-SPSite http://sitename/sites/teams/* | Set-SPSite -SecondaryOwner "DOMAIN\Jdoe"This example sets the secondary owner on a set of site collections to DOMAIN\Jdoe.------------------EXAMPLE 2--------------------- C:\PS>Set-SPSite -identity "http://sitename" -MaxSize 4000000 -WarningSize 2000000This example configures the Quota settings for the site collection http://sitename.Get-SPSiteNew-SPSiteRestore-SPSiteRemove-SPSiteMove-SPSiteRestore-SPSite Set-SPSite Get-SPTopologyServiceApplicationDisplays properties of the topology service application for the current farm.GetSPTopologyServiceApplicationGet-SPTopologyServiceApplicationIdentitySPTopologyWebServiceApplicationPipeBindAssignmentCollectionSPAssignmentCollectionIdentitySpecifies the GUID of the application.The type must be a valid GUID, in the form 1234-4567-098jhj.SPTopologyWebServiceApplicationPipeBindSPTopologyWebServiceApplicationPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPTopologyServiceApplication cmdlet displays the advanced properties of an application when the Identity parameter is used.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). --------------EXAMPLE----------------- C:\PS>Get-SPTopologyServiceApplicationThis example displays properties of the topology service application for the current farm.Set-SPTopologyServiceApplicationGet-SPTopologyServiceApplicationProxy Get-SPTopologyServiceApplication Set-SPFarmConfigSets a global property or a collection of global properties for the local farm.SetSPFarmConfigSet-SPFarmConfigAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterDataFormWebPartAutoRefreshEnabled$true | $falseForceSwitchParameterInstalledProductsRefreshSwitchParameterServiceConnectionPointBindingInformationStringServiceConnectionPointDeleteSwitchParameterWhatIfSwitchParameterWorkflowBatchSizeInt32WorkflowEventDeliveryTimeoutInt32WorkflowPostponeThresholdInt32AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter DataFormWebPartAutoRefreshEnabledSpecifies whether any DataFormWebPart on any page in this farm is allowed to periodically refresh its contents asynchronously (after the page has finished rendering). When set to false, all DataFormWebParts will ignore the automatic refresh interval provided in Web Part properties.$true | $false$true | $false ForceForces the deletion or updating of the service connection point.SwitchParameterSwitchParameter InstalledProductsRefreshUpdates the current machine license state with the list of products that are installed in the farm.SwitchParameterSwitchParameter ServiceConnectionPointBindingInformationAdds or updates the service connection point for the current farm in Active Directory Domain Service (AD DS).The type must be an array of strings that are key value pairs that will be added to the service connection point.StringString ServiceConnectionPointDeleteDelete the service connection point for the current farm in AD DS.SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WorkflowBatchSizeSpecifies the paging size for events delivered to a single workflow instance. For each request, the events are streamed out 100 at a time.Batch size is the number of events processed for a single workflow instance, which can have many events queued at the same time. Throttle will override batch size; if the workflow instance cannot be started or restarted because there are too many instances running across all front-end Web servers, none of the events will be fetched, regardless of the batch size.Int32Int32 WorkflowEventDeliveryTimeoutSpecifies the time as an integer in which a workflow job must run without the job timing out. If the workflow job does time out, it gets put back in the queue to be run again. For example, if the value is set to 5, the workflow job must run within 5 minutes are the workflow job will time out. Any workflow job that does time out is placed back in the queue to run again. The default value is 5. Int32Int32 WorkflowPostponeThresholdSpecifies the number of workflows that can be running in IIS against a content database at a time before new workflow instances get postponed into a queue.Int32Int32 The Set-SPFarmConfig cmdlet updates a collection of global settings for the local farm that are not members of the SPFarm object. Use the Get-SPFarmConfig cmdlet to read global settings for the local farm and to create a new PSCustomObject object from the collection of properties returned from the local farm, and then add this object to the pipeline. Modify the PSCustomObject object and pass it to the Set-SPFarmConfig cmdlet to change the parameter values.The properties collected in the PSCustomObject object must be farm-wide settings, and must be configurable only once for the entire farm. The parameter name added to the PSCustomObject object must match exactly the input parameter name for the Set-the SPFarmConfig cmdlet.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ---------------------EXAMPLE-------------------------- C:\PS>$a = Get-SPFarmConfigPS> $a.AjaxTimeout = 200PS> $a | Set-SPFarmConfigThis example uses the Get-SPFarmConfig cmdlet to add the Ajax Timeout setting to the PSCustomObject object, sets the value for Ajax Timeout, and then passes PSCustomObject to the Set-SPFarmConfig cmdlet to change the Ajax Timeout setting. Ajax Timeout, a farm-wide setting, is a member of the SPWebService object and cannot be accessed by using a Windows PowerShell cmdlet.You can perform the same operations with either of the following commands. C:\PS>Set-SPFarmConfig -AjaxTimeout 200Get-SPFarmConfig Set-SPFarmConfig Start-SPServiceInstanceStarts the service instance for a service on a specific server or the farm.StartSPServiceInstanceStart-SPServiceInstanceIdentitySPServiceInstancePipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterWhatIfSwitchParameterIdentitySpecifies the GUID of the service instance to get.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh.SPServiceInstancePipeBindSPServiceInstancePipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter Use the Start-SPServiceInstance cmdlet to start the service instance for a service on a specific server or on the farm.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Start-SPServiceInstance 67877d63-bff4-4521-867a-ef4979ba07ceThis example starts the given service instance on the server.The service instance GUID is unique to every farm. You can run the Get-SPServiceInstance cmdlet to see the GUID of the service instances, and then use the result from the SPServiceInstance cmdlet for other cmdlets.Get-SPServiceInstance Start-SPServiceInstance Get-SPFarmReturns the local SharePoint farm.GetSPFarmGet-SPFarmAssignmentCollectionSPAssignmentCollectionAssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection The Get-SPFarm cmdlet returns the local SharePoint farm. No parameters are used.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). SPFarm C:\PS>$f = Get-SPFarmThis example stores the local farm in a variable.Get-SPFarmConfigSet-SPFarmConfigBackup-SPFarmRestore-SPFarm Get-SPFarm Remove-SPSiteSubscriptionRemoves data stored in a subscription settings service application for a set of site subscriptions.RemoveSPSiteSubscriptionRemove-SPSiteSubscriptionIdentitySPSiteSubscriptionPipeBindAssignmentCollectionSPAssignmentCollectionConfirmSwitchParameterForceSwitchParameterWhatIfSwitchParameterIdentitySpecifies the site subscription settings service application that contains the service data to delete.The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a subscription settings service application (for example, SubscriptionSettingsApp1); or an instance of a valid SPSubscriptionSettingsServiceApplication object.SPSiteSubscriptionPipeBindSPSiteSubscriptionPipeBind AssignmentCollectionManages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.SPAssignmentCollectionSPAssignmentCollection ConfirmPrompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter ForceForces the removal of a site subscription and is the only way to stop this command from prompting for confirmation.The type must be either of the following values:- True- FalseThe default value is False .SwitchParameterSwitchParameter WhatIfDisplays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparametersSwitchParameterSwitchParameter The Remove-SPSiteSubscription cmdlet removes a site subscription along with all contained site collections and settings.For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation (http://go.microsoft.com/fwlink/?LinkId=163185). ------------------EXAMPLE----------------------- C:\PS>Remove-SPSiteSubscription "http://contoso.com"This example removes all data for the contoso.com site subscription (site collections, site subscription, and settings).Get-SPSiteSubscriptionNew-SPSiteSubscriptionRemove-SPSiteSubscription Remove-SPSiteSubscription