Skip to main content

Dot sourcing a PowerShell script.

PowerShell works in scopes.  At the very top layer, you have a global scope.  When you run a script, it is ran in a script scope inside the global.  If you run any functions inside that script, they run in their own function scope inside the script scope, which is inside the global scope.

When the function is finished and it exits its scope, all the data in the function is lost.  When the script ends, all of its data and the knowledge of the existence of the scripts functions are also lost.  What if you wanted to keep the functions from the script available to the shell?  That is where dot sourcing comes into play.

 

Let’s take a look at this simple function:

 

Function Display-Info
{
Write-Host (Get-WmiObject Win32_OperatingSystem).Caption
}

Display-Info

 

The output of this function, which changes depending on the client it is ran on, is:

Microsoft Windows 7 Ultimate

I know, this is a very simple function.  the problem is, after the execution is completed, I cannot use the function again in the shell.  To help solve this, I’m going to save this function as Library.ps1.  You can name it anything that you want.  I’m creating Library.ps1 to hold all the functions that I create and want to use in the shell or to make them available to my other PowerShell scripts.

I’m going to run this program in my shell environment.

image

I’m now going to attempt to execute the function directly from my shell.

No luck.

image

When I execute the command Dir Function: I can see that my function, Display-Info, is not listed.

image

I’m going to next dot source my library.ps1 script into the shell so that I can use its functions from within the shell and all scripts that I run in that shell session.

To do this, I execute the command . ./library.ps1.  Just so we are clear, the command is: Period – Space – Period – forward slash – library.ps1.

image

Now when I execute Dir Function:  I can see my function is listed.

image

I can now also execute it directly in the shell.

image

Just remember that once you close the shell, you will need to dot source your PowerShell script back in.  The dot sourcing puts the functions in the global scope.  When you close the global scope, you lose everything in it.

Comments

Popular posts from this blog

Adding a Comment to a GPO with PowerShell

As I'm writing this article, I'm also writing a customization for a PowerShell course I'm teaching next week in Phoenix.  This customization deals with Group Policy and PowerShell.  For those of you who attend my classes may already know this, but I sit their and try to ask the questions to myself that others may ask as I present the material.  I finished up my customization a few hours ago and then I realized that I did not add in how to put a comment on a GPO.  This is a feature that many Group Policy Administrators may not be aware of. This past summer I attended a presentation at TechEd on Group Policy.  One organization in the crowd had over 5,000 Group Policies.  In an environment like that, the comment section can be priceless.  I always like to write in the comment section why I created the policy so I know its purpose next week after I've completed 50 other tasks and can't remember what I did 5 minutes ago. In the Group Policy module for PowerShell V3, th

Return duplicate values from a collection with PowerShell

If you have a collection of objects and you want to remove any duplicate items, it is fairly simple. # Create a collection with duplicate values $Set1 = 1 , 1 , 2 , 2 , 3 , 4 , 5 , 6 , 7 , 1 , 2   # Remove the duplicate values. $Set1 | Select-Object -Unique 1 2 3 4 5 6 7 What if you want only the duplicate values and nothing else? # Create a collection with duplicate values $Set1 = 1 , 1 , 2 , 2 , 3 , 4 , 5 , 6 , 7 , 1 , 2   #Create a second collection with duplicate values removed. $Set2 = $Set1 | Select-Object -Unique   # Return only the duplicate values. ( Compare-Object -ReferenceObject $Set2 -DifferenceObject $Set1 ) . InputObject | Select-Object – Unique 1 2 This works with objects as well as numbers.  The first command creates a collection with 2 duplicates of both 1 and 2.   The second command creates another collection with the duplicates filtered out.  The Compare-Object cmdlet will first find items that are diffe

How to list all the AD LDS instances on a server

AD LDS allows you to provide directory services to applications that are free of the confines of Active Directory.  To list all the AD LDS instances on a server, follow this procedure: Log into the server in question Open a command prompt. Type dsdbutil and press Enter Type List Instances and press Enter . You will receive a list of the instance name, both the LDAP and SSL port numbers, the location of the database, and its status.