Windows PowerShell for SharePoint Command Builder

In this article, I will demonstrate a cool tool that hosted online by Microsoft to guide you to start working with SharePoint Command for SharePoint Versions (2010-2013-Online) and Office 365.It’s Windows PowerShell for SharePoint Command Builder

MainPage

I categorized this article to the following six questions:

  1. What’s Windows PowerShell?
  2. Windows PowerShell vs STSADM?
  3. What’s cmdlet?
  4. Is SharePoint Command builder cover all the cmdlet of SharePoint?
  5. How you could use SharePoint Command Builder?

  • What’s Windows PowerShell?
    • Command-Line interface and scripting language used for SharePoint Administration.
  • How is Windows PowerShell different from STSADM?
    • Unlike STSADM, which
      • Use XML & Objects.
      • Accept and return text.
      • Built on the Microsoft .NET Framework and accepts and returns .NET Framework objects.
      • Access to the file system on the computer so that you can access the registry, digital signature certificate etc..
      • Ability to run against SQL Snapshots.

STSADM still available to support backward compatibility.

  • What’s cmdlet?
    • Pronounced “Command-let” and it’s a single function that can be used separately or combined with other cmdlets to perform complex tasks and automate administration.
    • cmdlets = verbs (actions) – nouns (objects) which combined to build the command.
    • EX: Get-SPSite where Get is the verb and SPSite is the Noun.
  • Is it cover all the cmdlet of SharePoint?
    • No, it’s only cover the popular cmdlet especially for SharePoint Online and Office 365 and in this case, you need to use Get-Command & Get-Help in your Windows PowerShell or SharePoint Management PowerSell.
      • The cmdlet of SharePoint 2010 is about +500.
      • The cmdlet of SharePoint 2013 is 774.
      • The cmdlet of SharePoint online is about 30.
  • How you could use Windows PowerShell for SharePoint Command Builder?

MainPage

Command Builder is a simple tool that not needs the training to use it. meanwhile, it’s worth tool that guide you to work with the common Windows PowerShell command for SharePoint

  • Windows PowerShell for SharePoint Command Builder consist of 5 component:
    • Verbs: it’s the actions.verbs
    • Nouns: it’s the objects.Nouns
    • Design Surfaceconsist of 6 parts:Design Surface
      • The combination of verb and noun to build command.Verb-noun
      • The required parameters.Design Surface req
      • The optional parameters.Design Surface optional
      • The cmdlet description with the output of the final command.Design Surface desc
      • Copy to clipboard to copy the command to your PowerShell Window
      • Clear Design Surface to reset it and start a new command.
    • Products List: to filter your cmdlet based on your SharePoint Edition.ProductList
    • Quick Steps: to build the common cmdlet quickly.Quicksteps

Example: Add SharePoint solution package to your farm

  • Open Windows PowerShell for SharePoint Command Builder.
  • Select your product from the product list.
  • Click on the required action from verbs sections that lead to automatic filter for the related objects of this action, and click Send.
  • Click on the required object, and click Send.
  • Now you build your cmdlet and you need to fill all required parameters if exists, plus fill the optional parameters as you need.
  • In the third area box, you can see the output, description, and link for more details and examples for this cmdlet.
  • When you finish you can copy your cmdlet by clicking on Copy to clipboard.
  • When you need to build a new cmdlet you could click on Clear Design Surface.

Example

Enjoy 🙂

Advertisements

One thought on “Windows PowerShell for SharePoint Command Builder

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s