*Get local farm information using PowerShell
Using\u00a0 the Get-SPFarm cmdlet, you can retrieve information, including\u00a0 the name of the Config database, version number, and servers in the farm\u00a0 that can be useful when creating scripts for your SharePoint farm.<\/p>\n
You can open up the SharePoint 2010 Management Shell on your SharePoint server to view the settings of your farm and type:<\/p>\n
PS > Get-SPFarm
You will\u00a0 only see the name of the configuration database. You can get more detailed information if you pipe the cmdlet to the format list:<\/p>\n
PS > Get-SPFarm | Format-List<\/p>\n
* Quickly Access the SharePoint Hive<\/p>\n
If you use SharePoint on a daily basis, you are probably familiar with the SharePoint hive. In SharePoint 2010, the hive is called the SharePoint root. The SharePoint root is used by SharePoint to store features, logs, binary files, templates and much more. It\u2019s commonly used when performing administrative tasks in SharePoint. Changing location to the path is fun, the first time, but after typing the path 100 times, it gets a bit tedious. In Windows PowerShell you can solve this by adding a new PSDrive that points to the SharePoint Root.<\/p>\n
New-PSDrive -Name SharePoint -Root “C:Program FilesCommon FilesMicrosoft SharedWeb Server Extensions14” -PSProvider FileSystem<\/p>\n
If you place the command in your profile it will always be loaded when you start PowerShell.<\/p>\n
Now you can change location to the SharePoint Root using a simple command:<\/p>\n
cd SharePoint:
If you want to open the folder in explorer, simply type:<\/p>\n
explorer (Convert-Path SharePoint:)<\/p>\n
<\/p>\n
* Find information about your SharePoint databases<\/p>\n
You can use the Get-SPDatabase cmdlet to display information about the SharePoint databases.<\/p>\n
PS > Get-SPDatabase<\/p>\n
The example above displays all SharePoint databases. If you want to display a specific Database, use the identity parameter followed by the database ID.<\/p>\n
PS > Get-SPDatabase -Identity<\/p>\n
* Hide a list in SharePoint 2010<\/p>\n
You can use Windows PowerShell to hide a list in SharePoint 2010. Simply store an instance of an SPList Object, set the Hidden property to $true and update the SPList object.<\/p>\n
PS > $spWeb = Get-SPWeb http:\/\/sp01\/site<\/a> * Remove a list in SharePoint 2010 from the Quick Launch toolbar<\/p>\n You can use Windows PowerShell to remove a list in SharePoint 2010 from the Quick Launch toolbar. Simply store an instance of an SPList Object, set the OnQuickLaunch property to $false, and update the SPList object.<\/p>\n PS > $spWeb = Get-SPWeb http:\/\/sp01\/site<\/a> * Enable folder creation on a list<\/p>\n You can enable folder creation on a list in SharePoint 2010 using PowerShell. Simply store an instance of an SPList Object, set the EnableFolderCreation property to $true, and update the SPList object.<\/p>\n PS > $spWeb = Get-SPWeb http:\/\/sp01\/site<\/a> * PowerShell commands for SharePoint 2010<\/p>\n SOS Member santhiswaroop<\/p>\n To find the PowerShell commands n SharePoint 2010, try these:<\/p>\n >Get-Command -Noun SPSite<\/p>\n You can get the all PowerShell commands:<\/p>\n >Get-Help Get-SPSite<\/p>\n You can get the Name, Syntax, Description, Related Links, Remarks<\/p>\n To Retrieve content database for a specific site collection:<\/p>\n >Get-SPContentDatabase -Site http:\/\/SPServer01<\/a><\/p>\n Results:<\/p>\n ID\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 :96dfa345-43df-3edg-bbc6-1l4e8ee105le To retrieve the content database for a specific Web Application:<\/p>\n >Get-SPContentDatabase -WebApplication “Sharepoint – 80”<\/p>\n Results:<\/p>\n ID\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 :96dfa345-43df-3edg-bbc6-1l4e8ee105le * Quickly Access the SharePoint Hive<\/p>\n If you use SharePoint on a daily basis, you are probably familiar with the SharePoint hive. In SharePoint 2010, the hive is called the SharePoint root. The SharePoint root is used by SharePoint to store features, logs, binary files, templates and much more. It\u2019s commonly used when performing administrative tasks in SharePoint. Changing location to the path is fun, the first time, but after typing the path 100 times, it gets a bit tedious. In Windows PowerShell you can solve this by adding a new PSDrive that points to the SharePoint Root.<\/p>\n New-PSDrive -Name SharePoint -Root “C:Program FilesCommon FilesMicrosoft SharedWeb Server Extensions14” -PSProvider FileSystem<\/p>\n If you place the command in your profile it will always be loaded when you start PowerShell.<\/p>\n Now you can change location to the SharePoint Root using a simple command:<\/p>\n cd SharePoint: explorer (Convert-Path SharePoint:)<\/p>\n * Adding List Items using PowerShell<\/p>\n SharePoint 2010 offers over 500 new cmdlets that we can use to automate the SharePoint 2010 environment through Windows PowerShell. The cmdlets go as deep as SPWeb, everything beyond SPWeb requires additional scripting, such as adding fields, views and items. Here\u2019s an example showing how to add an item to the Announcements list in SharePoint 2010:<\/p>\n $spWeb = Get-SPWeb -identity http:\/\/SP<\/a><\/p>\n $spList = $spWeb.GetList(\u201cLists\/Announcements”) In the example we use the Get-SPWeb cmdlet to bind to a specific site. Next we use the GetList() method to retrieve a list. The method accepts a lists relative URL as input. We then use the AddItem() method to create a new item in SharePoint 2010. Finally we use the Dispose() method on the SPWeb object to make sure that the object is disposed of correctly.<\/p>\n * Managing sites in SharePoint 2010 Using PowerShell cmdlets<\/p>\n In SharePoint 2010 you can manage sites through Windows PowerShell. You can create new sites in a site collection using the New-SPWeb cmdlet:<\/p>\n New-SPWeb http:\/\/SP\/TeamSite<\/a> -Template “STS#0” \u2013Name “Team Site” ` You can retrieve an existing site using the Get-SPWeb cmdlet:<\/p>\n Get-SPWeb http:\/\/SP\/TeamSite<\/a><\/p>\n You can configure a site through the Set-SPWeb cmdlet:<\/p>\n Get-SPWeb http:\/\/SP\/TeamSite<\/a> | Set-SPWeb -Description “New Description”<\/p>\n And finally, you can remove a site using the Remove-SPWeb cmdlet:<\/p>\n Remove-SPWeb http:\/\/SP\/TeamSite<\/a> -Confirm:$false<\/p>\n Setting the \u2013Confirm switch parameter to $false omits the confirmation returned from PowerShell.<\/p>\n Backup and Restore Site Collections in SharePoint 2010 using PowerShell<\/p>\n Backup-SPSite http:\/\/SP<\/a> \u2013Path C:BackupsiteCollection.bak<\/p>\n Restoring a site collection in SharePoint 2010 is just as simple:<\/p>\n Restore-SPSite http:\/\/SP<\/a> \u2013Path C:BackupsiteCollection.bak<\/p>\n * User Management in SharePoint 2010 with PowerShell<\/p>\n SharePoint 2010 includes three cmdlets that you can use to manage users in SharePoint 2010. Here\u2019s an example on adding a new user:<\/p>\n New-SPUser “XYZdavid” -Web http:\/\/SP<\/a> -PermissionLevel “Contribute”<\/p>\n <\/p>\n The example above adds the user \u201cdavid\u201d to the specified site and sets the user permissions to contribute.<\/p>\n You can retrieve an existing user through the Get-SPUser cmdlet:<\/p>\n Get-SPUser \u201cXYZdavid\u201d \u2013Web http:\/\/SP<\/a><\/p>\n <\/p>\n If you pipe the object to the Format-List cmdlet you can list all properties.<\/p>\n Get-SPUser \u201cXYZdavid\u201d \u2013Web http:\/\/SP<\/a> | Format-List *<\/p>\n <\/p>\n You can modify users through the Set-SPUser cmdlet:<\/p>\n Set-SPUser \u201cXYZdavid\u201d -Web http:\/\/SP<\/a> -Email mail@XYZ.com<\/a><\/p>\n <\/p>\n And finally, you can remove a user through the Remove-SPUser cmdlet:<\/p>\n Remove-SPUser \u201cXYZdavid\u201d -Web http:\/\/SP<\/a><\/p>\n * Add Managed Paths to Web Applications using PowerShell<\/p>\n You can use the New-SPManagedPath cmdlet to add managed paths to a given Web application:<\/p>\n PS > New-SPManagedPath -RelativeURL MyPath ` The example above creates a \u201cMyPath\u201d managed path for the Web application http:\/\/SP01.powershell.nu<\/a>.<\/p>\n * Adding Alternate Access Mappings using PowerShell<\/p>\n Adding Alternate Access Mappings is a simple task using Windows PowerShell. You can simply use the New-SPAlternateUrl cmdlet, which supports the creation of internal or public URLs for a given Web application. The examples below demonstrate how to create both a public and internal URL:<\/p>\n # Public # Internal * Adding Managed Accounts using PowerShell<\/p>\n You can add SharePoint 2010 managed accounts by using New-SPManagedAccount in Windows PowerShell. When creating automated scripts, you may want to check if an account is already a managed account. Simply use Get-SPManagedAccount and a simple if\/else statement to determine if the managed account already exists. Here\u2019s a short code example:<\/p>\n $userName = “domainuser” * Adding Solutions<\/p>\n Did you know that when you upload solution packages to a farm, you can use the Add-SPSolution cmdlet? Simply:<\/p>\n # Adding a Solution PS > Get-SPSolution | Where-Object { $_.Name -eq “MySolution.wsp” } | * Changing Custom Master Page<\/p>\n You can use Windows PowerShell to change a Web\u2019s custom master page. Simply point the CustomMasterUrl to a new master page:<\/p>\n PS > $spWeb = Get-SPWeb http:\/\/SP01.powershell.nu<\/a> * Create Default Associated Groups<\/p>\n When creating Web site using PowerShell, you may encounter situations where you\u2019re missing the site\u2019s default groups. A simple solution to this is using the CreateDefaultAssociatedGroups method. The example below demonstrates how you can use the method:<\/p>\n PS > $spWeb = Get-SPWeb http:\/\/SP01.powershell.nu<\/a> * Changing Locale<\/p>\n You can change a Web site\u2019s locale setting using Windows PowerShell. Simply replace the value of the locale property by using an object of the type System.Globalization.CultureInfo. The example below shows how to set the locale to Swedish:<\/p>\n PS > $culture = [System.Globalization.CultureInfo]::CreateSpecificCulture(\u201csv-SE\u201d) * Enable Auditing<\/p>\n You can enable site audit using Windows PowerShell. The example below demonstrates how to add specific audit flags on a site collection and enable auditing:<\/p>\n PS > $spSite = Get-SPSite http:\/\/SP01.powershell.nu<\/a> * Handling Errors in Your Scripts $url = “http:\/\/SP01.powershell.nu<\/a>“ * Removing Nodes from the QuickLaunch<\/p>\n You can use Windows PowerShell when removing one (or more) nodes from a Web site\u2019s QuickLaunch. The example below shows\u00a0 how you can remove everything except for nodes under the lists heading:<\/p>\n PS > $spWeb = Get-SPWeb http:\/\/SP01.powershell.nu<\/a> -ErrorAction Stop * Remove Group Permissions PS > $spWeb = Get-SPWeb http:\/\/SP01.powershell.nu<\/a>
PS > $spList = $spWeb.GetList(“http:\/\/sp01\/site\/Lists\/MyList<\/a>“)
PS > $spList.Hidden = $true
PS > $spList.Update()<\/p>\n
PS > $spList = $spWeb.GetList(“http:\/\/sp01\/site\/Lists\/MyList<\/a>“)
PS > $spList.OnQuickLaunch = $false
PS > $spList.Update()<\/p>\n
PS > $spList = $spWeb.GetList(“http:\/\/sp01\/site\/Lists\/MyList<\/a>“)
PS > $spList.EnableFolderCreation = $true
PS > $spList.Update()<\/p>\n
Name\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 :WSS_content
Web Application\u00a0\u00a0\u00a0\u00a0 :SPWeb Application Name=Sharepoint – 80
Server\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 :SPServer01
CurrentSiteCount\u00a0\u00a0\u00a0 :2<\/p>\n
Name\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 :WSS_content
Web Application\u00a0\u00a0\u00a0\u00a0 :SPWeb Application Name=Sharepoint – 80
Server\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 :SPServer01
CurrentSiteCount\u00a0\u00a0\u00a0 :2<\/p>\n
If you want to open the folder in explorer, simply type:<\/p>\n
$newItem = $spList.AddItem()
$newItem[“Title”] = “My First Announcement”
$newItem[“Body”] = “<h2>PowerShell Magic<\/h2>”
$newItem[“Expires”] = “5\/5\/2010”
$newItem.Update()
$spWeb.Dispose()<\/p>\n
-Description “Description of Site” \u2013AddToTopNav \u2013UseParentTopNav<\/p>\n
>> -WebApplication http:\/\/SP01.powershell.nu<\/a><\/p>\n
PS > New-SPAlternateURL -Url http:\/\/public.powershell.nu<\/a> `
>> -Zone “Internet” -WebApplication http:\/\/sp01.powershell.nu<\/a><\/p>\n
PS > New-SPAlternateURL -Url http:\/\/internal.powershell.nu<\/a> `
-Zone Default -WebApplication http:\/\/sp01.powershell.nu<\/a> -Internal<\/p>\n
if(Get-SPManagedAccount | Where-Object { $_.UserName -eq $userName }){
# Managed Account Already exists
Write-Host \u201cManaged Account: $userName exists\u201d
} else {
# Get User Credentials
$credential = Get-Credential -Credential $userName
# Create New Managed Account
New-SPManagedAccount -Credential $credential
}<\/p>\n
Add-SPSolution \u2013LiteralPath C:StuffMySolution.wsp
After you\u2019ve uploaded a solution package, you can use the Install-SPSolution cmdlet. The example below will get you all solutions and then filter out the solution where the name is equal to MySolution.wsp. Finally, the solution is installed using the Install-SPSolution cmdlet.<\/p>\n
>> Install-SPSolution \u2013GACDeployment<\/p>\n
PS > $spWeb.CustomMasterUrl = “\/_catalogs\/masterpage\/myNew.master”
PS > $spWeb.Update()
PS > $spWeb.Dispose()<\/p>\n
PS > $spWeb.CreateDefaultAssociatedGroups(“powershellspAdmin”,””,””)
PS > $spWeb.Update()
PS > $spWeb.Dispose()<\/p>\n
PS > $spWeb = Get-SPWeb http:\/\/SP01.powershell.nu<\/a>
PS > $spWeb.Locale = $culture
PS > $spWeb.Update()
PS > $spWeb.Dispose()<\/p>\n
PS > $spSite.Audit.AuditFlags =
>> ([Microsoft.SharePoint.SPAuditMaskType]::All `
>> -bxor[Microsoft.SharePoint.SPAuditMaskType]::View)
PS > $spSite.Audit.Update()
PS > $spSite.Dispose()<\/p>\n
When creating automated SharePoint scripts using Windows PowerShell, it\u2019s a good idea to add some form of error handling. A typical example is when you try to access a non-existent site collection. By default, Windows PowerShell displays an error message. You can use a Try\/Catch statement if you want to handle this. Note that the \u2013ErrorAction is set to stop on the cmdlet:<\/p>\n
try {
# Trying to get the Site Collection
# ErrorAction is set to Stop
Get-SPSite $url -ErrorAction Stop
}
catch {
# If the Command in the Try block fails,
# The code in the Catch block is executed
Write-Host \u201cThat didn\u2019t work..\u201d
}<\/p>\n
PS > foreach($node in ($spWeb.Navigation.QuickLaunch |
>> Where-Object { $_.Title -ne “Lists” })) {
>> $node.Delete()
>> }
PS > $spWeb.Dispose()<\/p>\n
You can remove a group\u2019s permissions on a specific Web site with\u00a0 Windows PowerShell. Simply remove the group from the role assignment collection:<\/p>\n
PS > $spPrincipal = [Microsoft.SharePoint.SPPrincipal]$spWeb.SiteGroups[“Site Members”]
PS > $spWeb.RoleAssignments.Remove($spPrincipal)
PS > $spWeb.Dispose()<\/p>\n