Export (0) Print
Expand All

Set-ExecutionPolicy

Set-ExecutionPolicy

Changes the user preference for the Windows PowerShell execution policy.

Syntax

Parameter Set: Default
Set-ExecutionPolicy [-ExecutionPolicy] <ExecutionPolicy> [[-Scope] <ExecutionPolicyScope> ] [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-ExecutionPolicy cmdlet changes the user preference for the Windows PowerShell execution policy.

The execution policy is part of the security strategy of Windows PowerShell. It determines whether you can load configuration files (including your Windows PowerShell profile) and run scripts, and it determines which scripts, if any, must be digitally signed before they will run. For more information, see about_Execution_Policies (http://go.microsoft.com/fwlink/?LinkID=135170).

To change the execution policy for the default (LocalMachine) scope, start Windows PowerShell with the "Run as administrator" option.

Parameters

-ExecutionPolicy<ExecutionPolicy>

Specifies the new execution policy. The acceptable values for this parameter are:

-- Restricted. Does not load configuration files or run scripts. Restricted is the default execution policy.
-- AllSigned. Requires that all scripts and configuration files be signed by a trusted publisher, including scripts that you write on the local computer.
-- RemoteSigned. Requires that all scripts and configuration files downloaded from the Internet be signed by a trusted publisher.
-- Unrestricted. Loads all configuration files and runs all scripts. If you run an unsigned script that was downloaded from the Internet, you are prompted for permission before it runs.
-- Bypass. Nothing is blocked and there are no warnings or prompts.
-- Undefined. Removes the currently assigned execution policy from the current scope. This parameter will not remove an execution policy that is set in a Group Policy scope.


Aliases

none

Required?

true

Position?

1

Default Value

None

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Force

Suppresses all prompts. By default, Set-ExecutionPolicy displays a warning whenever you change the execution policy.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Scope<ExecutionPolicyScope>

Specifies the scope of the execution policy. The default is LocalMachine. The acceptable values for this parameter are:

-- Process: The execution policy affects only the current Windows PowerShell process.
-- CurrentUser: The execution policy affects only the current user.
-- LocalMachine: The execution policy affects all users of the computer.

To remove an execution policy from a particular scope, set the execution policy for that scope to Undefined.

When the value of the Scope parameter is Process, the execution policy is saved in the PSExecutionPolicyPreference environment variable ($env:PSExecutionPolicyPreference), instead of the registry, and the variable is deleted when the process is closed. You cannot change the execution policy of the process by editing the variable.


Aliases

none

Required?

false

Position?

2

Default Value

LocalMachine

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Microsoft.PowerShell.ExecutionPolicy, System.String

    You can pipe an execution policy object or a string that contains the name of an execution policy to Set-ExecutionPolicy.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

    This cmdlet does not return any output.


Notes

  • When you use Set-ExecutionPolicy in any scope other than Process, the new user preference is saved in the registry and remains unchanged until you change it. When the value of the Scope parameter is Process, the user preference is stored in the PSExecutionPolicyPreference environment variable ($env:PSExecutionPolicyPreference), instead of the registry, and it is deleted when the session in which it is effective is closed.

    If the "Turn on Script Execution" group policy is enabled for the computer or user, the user preference is saved, but it is not effective, and Windows PowerShell displays a message explaining the conflict. You cannot use Set-ExecutionPolicy to override a Group Policy, even if the user preference is more restrictive than the policy.

Examples

Example 1: Set the shell execution policy

This command sets the user preference for the shell execution policy to RemoteSigned.


PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned

Example 2: Set a shell execution policy that conflicts with the group policy

This command attempts to set the execution policy for the shell to Restricted. The Restricted setting is written to the registry, but because it conflicts with a group policy, it is not effective, even though it is more restrictive than the group policy.


PS C:\> Set-ExecutionPolicy -ExecutionPolicy Restricted

Example 3: Apply the execution policy from a remote computer to the local computer

This command gets the execution policy from a remote computer and applies that execution policy to the local computer.

The command uses the Invoke-Command cmdlet to send the command to the remote computer. Because you can pipe an ExecutionPolicy (Microsoft.PowerShell.ExecutionPolicy) object to Set-ExecutionPolicy, the Set-ExecutionPolicy command does not require an ExecutionPolicy parameter.

The command uses the Force parameter to suppress the user prompt.


PS C:\> Invoke-Command -ComputerName "Server01" -ScriptBlock {Get-ExecutionPolicy} | Set-ExecutionPolicy -Force

Example 4: Set the scope for an execution policy

This example shows how to set an execution policy for a particular scope.

The first command uses the Set-ExecutionPolicy cmdlet to set an execution policy of AllSigned for the current user. It uses the Force parameter to suppress the user prompt.


 

PS C:\> Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy AllSigned -Force

 

The second command uses the List parameter of the Get-ExecutionPolicy cmdlet to get the execution policies set in each scope. The results show that the execution policy that is set for the current user differs from the execution policy set for all users of the computer.


PS C:\> Get-ExecutionPolicy -List

 

PS C:\> Get-ExecutionPolicy

Example 5: Remove the execution policy for the current user

This command uses an execution policy value of Undefined to effectively remove the execution policy that is set for the current user scope. As a result, the execution policy that is set in Group Policy or in the LocalMachine (all users) scope is effective.

If you set the execution policy in all scopes to Undefined and the Group Policy is not set, the default execution policy, Restricted, is effective for all users of the computer.


PS C:\> Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Undefined

Example 6: Set the execution policy for the current session

This command sets an execution policy of AllSigned for only the current Windows PowerShell session. This execution policy is saved in the PSExecutionPolicyPreference environment variable ($env:PSExecutionPolicyPreference), so it does not affect the value in the registry. The variable and its value are deleted when the current session is closed.


PS C:\> Set-ExecutionPolicy -Scope Process -ExecutionPolicy AllSigned

Example 7: Unblock a script to run it without changing the execution policy

This example shows the effect of the RemoteSigned execution policy, which prevents you from running unsigned scripts that were downloaded from the Internet. It also shows how to use the Unblock-File cmdlet to unblock scripts, so that you can run them without changing the execution policy.


 

The first command uses the Set-ExecutionPolicy cmdlet to change the execution policy to RemoteSigned.


PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned

 

The second command uses the Get-ExecutionPolicy cmdlet to get the effective execution policy in the session. The output shows that it is RemoteSigned.


PS C:\> Get-ExecutionPolicy

 

The third command shows what happens when you run a blocked script in a Windows PowerShell session in which the execution policy is RemoteSigned. The RemoteSigned policy prevents you from running scripts that are downloaded from the Internet unless they are digitally signed.


PS C:\> .\Start-ActivityTracker.ps1

 

The fourth command uses the Unblock-File cmdlet to unblock the script so it can run in the session.

Before running an Unblock-File command, read the script contents and verify that it is safe.


PS C:\> Unblock-File -Path "Start-ActivityTracker.ps1"

 

The fifth and sixth commands show the effect of the Unblock-File command. The Unblock-File command does not change the execution policy. However, it unblocks the script so it will run in Windows PowerShell.


PS C:\> Get-ExecutionPolicy
PS C:\> Start-ActivityTracker.ps1

Related topics

Community Additions

ADD
Show:
© 2016 Microsoft