Home > Articles

PowerShell Basics for SharePoint 2013

What is a Cmdlet? What does F3 do? What are console commands? This chapter explains some PowerShell basics, to help you acquire a general understanding. The sections and scenarios in this chapter help form a foundation for more more complex tasks.

Read PowerShell for SharePoint 2013 How-To or more than 24,000 other books and videos on Safari Books Online. Start a free trial today.

This chapter is from the book

In This Chapter

  • What Is a Cmdlet?
  • How Can I See the Possible Verbs for a Noun Command?
  • What Is a Parameter?
  • What Is a Switch Parameter?
  • How Can I See the Possible Parameters for a Cmdlet?
  • What Does F3 Do?
  • What Does F7 Do?
  • What Are Console Commands?
  • Path Environment Variable
  • Running Unsigned Scripts
  • Disabling the Confirmation Prompt
  • Generating Inline Credentials
  • Referencing an Assembly

This chapter explains some PowerShell basics, to help you acquire a general understanding. The sections and scenarios in this chapter help form a foundation for the tasks and solutions within this book.

What Is a Cmdlet?

PowerShell commands are called cmdlets. They are structured by a verb and noun concatenation in the form of verb-noun. So in the cmdlet Get-Help, Get is the verb and Help is the noun.

How Can I See the Possible Verbs for a Noun Command?

If you know the noun but are unsure of the possible verbs available, you can enter the noun with -? to display the available verb-noun combinations. This also displays additional nouns that are similar to the one you provided. For example, SPSite -? displays the available verbs not only for the SPSite noun, but also for SPSiteAdministration, SPSiteSubscription, and other cmdlets available beginning with SPSite.

What Is a Parameter?

Most cmdlets need values to perform the desired actions. These values are provided to the cmdlet using parameters in the following form:

-parametername <value>

What Is a Switch Parameter?

A switch parameter is a parameter used with a cmdlet that does not take a value (or that is Boolean in nature and can be set to a false setting). The fact that the switch parameter is present “switches on” that option (true setting) when executing the cmdlet.

Most of the time, switch parameters are optional, but in some cases, you need to provide a switch. This depends on the cmdlet being executed.

How Can I See the Possible Parameters for a Cmdlet?

Entering the cmdlet in the console with -? as a parameter displays information about that cmdlet, along with the available parameters. Listing 2.1 shows an example.

Listing 2.1. Getting Information About a Cmdlet

Get-SPSite -?

Some cmdlets, such as Get-SPSite, have different variations of parameters. These variations also are displayed within the information provided by the -? parameter, as Figure 2.1 shows.

Figure 2.1

Figure 2.1. Using -?with a cmdlet provides various syntax information.

What Does F3 Do?

Pressing the F3 function key in the console window displays the last-executed statement on the current prompt line. Using the up and down arrows, you can page through the other previous statements. This is useful for repeating or correcting previous command entries. Use the left and right arrow keys to place the cursor within the command text for corrections.

What Does F7 Do?

This is probably the best-kept secret in command consoles. Every time I show this to someone, they say they had no idea it was available. If you have been entering several commands in a console screen, pressing the F7 function key displays a menu of the previously executed commands, as Figure 2.2 shows.

Figure 2.2

Figure 2.2. Pressing the F7 function key presents a command history menu.

Use the arrow keys to change the selection in the menu. Pressing Enter executes the command selected. Pressing F9 on the menu enables you to enter the command number you want to re-execute but only places it on the line (the command is not executed automatically).

What Are Console Commands?

A handful of what I like to call console commands stem from the good ol’ DOS days. They have been available in command prompts since then, with the current PowerShell consoles included. These commands provide standard directory navigation, file handling, and screen handling.

Several common console commands follow:

  • cd: Changes the directory
  • cls: Clears the console screen
  • dir: Displays a listing of the current directory (folder)
  • type: Used with a text-based filename and displays the contents of a text file

Path Environment Variable

Solution: Add the local directory path to the PSModulePath variable.

You add the local folder’s path to the PSModule environment variable by entering the following command in the PowerShell command prompt (substituting <folder path> with the local directory path), as shown in Listing 2.2.

Listing 2.2. Adding a Folder Path to the PSModulePath

$env:PSModulePath = $env:PSModulePath + ";c:\<folder path>"

Running Unsigned Scripts

Solution: Use the Set-ExecutionPolicy command.

To run unsigned scripts, you must change the execution policy:

Set-ExecutionPolicy remotesigned

You are prompted with a confirmation. Enter Y and press Enter (or just press Enter—Y is the default).

In some cases, you must set the policy to Unrestricted:

Set-ExecutionPolicy unrestricted

Disabling the Confirmation Prompt

Solution: Include the -Confirm parameter with a $false setting.

When running cmdlets discussed in this book, you might receive a confirmation message to confirm the action being processed. If you use these cmdlets in scripts, the script will not run straight through without prompting for the confirmation.

The cmdlets that have a -Confirm optional parameter can be called in unattended mode by passing in -Confirm:$false to the cmdlet, as shown in Listing 2.3.

Listing 2.3. Suppressing the Confirmation Prompt Example

Remove-item *.png -Confirm:$false

Generating Inline Credentials

Solution: Create a new PSCredential object.

Various cmdlets discussed in this book require SharePoint and/or SQL Server account credentials for proper authentication when performing the desired operations. The examples include using (Get-Credential) as the parameter value, which prompts the user for credentials.

When running these cmdlets in scripts, the prompting for credentials pauses the execution. If you need the script to run straight through, instead of using Get-Credential, you can generate a new PSCredential object inline, as shown in Listing 2.4.

Listing 2.4. Generating Inline Credentials Example

(New-Object System.Management.Automation.PSCredential "domain\user",
(ConvertTo-SecureString "password" -AsPlainText -Force))

Therefore, simply substitute (Get-Credential) for the text shown in Listing 2.4 with the proper username and password when using a cmdlet with authentication requirements.

Referencing an Assembly

Solution: Use a reflection declaration, and then use a variable to instantiate an object.

You can reference an assembly in your PowerShell script and then use any objects available by assigning them to a variable. Then you can use any methods or properties within your script. No intellisense exists, so you need to know the object model beforehand. Listing 2.5 demonstrates an example assembly reference and usage.

Listing 2.5. Referencing and Using a SharePoint Assembly


$spFarm = [Microsoft.SharePoint.Administration.SPFarm]::Local
$spFarmSolutions = $spFarm.Solutions

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020