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

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.

How to run GPResult on a remote client with PowerShell

In the past, to run the GPResult command, you would need to either physically visit this client, have the user do it, or use and RDP connection.  In all cases, this will disrupt the user.  First, you need PowerShell remoting enabled on the target machine.  You can do this via Group Policy . Open PowerShell and type this command. Invoke-Command –ScriptBlock {GPResult /r} –ComputerName <ComputerName> Replace <ComputerName> with the name of the target.  Remember, the target needs to be online and accessible to you.

Error icon when creating a GPO Preference drive map

You may not have an error at all.  Take a look at the drive mapping below. The red triangle is what threw us off.  It is not an error.  It is simply a color representation of the Replace option of the Action field in the properties of the drive mappings. Create action This give you a green triangle. The Create action creates a new mapped drive for users. Replace Action The Replace action gives you a red triangle.  This action will delete and recreate mapped drives for users. The net result of the Replace action is to overwrite all existing settings associated with the mapped drive. If the drive mapping does not exist, then the Replace action creates a new drive mapping. Update Action The Update action will have a yellow triangle. Update will modify settings of an existing mapped drive for users. This action differs from Replace in that it only updates settings defined within the preference item. All other settings remain as configured on the ma...