Import the SQLPS Module

Article
03/08/2017

The recommended way to manage SQL Server from PowerShell is to import the sqlps module into a Windows PowerShell 2.0 environment. The module loads and registers the SQL Server snap-ins and manageability assemblies.

Before You Begin: Security
To load the module: Load the sqlps Module

Before You Begin

After importing the sqlps module into Windows PowerShell, you can then:

Interactively run Windows PowerShell commands.
Run Windows PowerShell script files.
Run SQL Server cmdlets.
Use the SQL Server provider paths to navigate through the hierarchy of SQL Server objects.
Use the SQL Server manageability object models (such as Microsoft.SqlServer.Management.Smo) to manage SQL Server objects.

Note

The verbs used in the names of two SQL Server cmdlets (Encode-Sqlname and Decode-Sqlname) do not match the approved verbs for Windows PowerShell 2.0. This has no effect on their operation, but Windows PowerShell raises a warning when the sqlps module is imported to a session.

Security

By default, Windows PowerShell runs with the scripting execution policy set to Restricted, which prevents running any Windows PowerShell scripts. To load the sqlps module, you can use the Set-ExecutionPolicy cmdlet to enable running signed scripts, or any scripts. Only run scripts from trusted sources, and secure all input and output files using the appropriate NTFS permissions. For more information about enabling Windows PowerShell scripts, see Running Windows PowerShell Scripts.

Load the sqlps Module

To load the sqlps module in Windows PowerShell

Use the Set-ExecutionPolicy cmdlet to set the appropriate script execution policy.
Use the Import-Module cmdlet to import the sqlps module. Specify the DisableNameChecking parameter if you want to suppress the warning about Encode-Sqlname and Decode-Sqlname.

Example (PowerShell)

This example loads the sqlps module with name checking turned off.

## Import the SQL Server Module.  
  
Import-Module "sqlps" -DisableNameChecking

Share via