Updated PowerShell Scripts to Manage Symbol Server and Source Server Settings

Back to all blogs

With Dev 11 Beta now in our hot little hands, I needed to update my symbol server and source server PowerShell scripts that automate setting up a developer machine. I’ve packaged up all the scripts previously published on this blog into a module, WintellectPowerShell, to make the cmdlets easier to use.

To set up a development machine to use a symbol server, use the Set-SymbolServer command. It takes care of setting the _NT_SYMBOL_PATH environment variable, as well as Visual Studio 2010 and Dev 11 Beta provided they are installed. The Set-SourceServer command sets up both VS 2010 and Dev 11, but also will set the _NT_SOURCE_PATH environment variable so WinDBG can pick up the source from your version control system as well. Yes, you C++ folks, these scripts support you as well!

I’ve also included an update version of my Get-SysinternalsSuite script that will download and extract all the wonderful Sysinternals tools. My previous version of the script relied on an external zip tool, but now used the Shell’s zip provider. There are a few other commands in the module for getting the current symbol server and source server values. The help is shown below and the download is here.

As always let me know if you find any bugs or have suggestions!

No discussion of PowerShell would be complete without a one-liner that does a lot. I wanted to show the help in this post so you could see all the commands. Once you have a module loaded, you can get the help simply by doing the following:

  1. (get-module WintellectPowerShell).ExportedFunctions.Keys | sort | foreach-object { Get-Help detailed $_}

I thought that was pretty cool!

  1. NAME
  2.     Expand-ZipFile
  3. SYNOPSIS
  4.     Expands a .ZIP file to the specified directory.
  5. SYNTAX
  6.     Expand-ZipFile [-ZipFile] <String> [-Destination] <String> [<CommonParameters>]
  7. DESCRIPTION
  8.     Using no external ZIP utilities, expands a .ZIP file to a specified directory.
  9. PARAMETERS
  10.     -ZipFile <String>
  11.         The .ZIP file to expand.
  12.     -Destination <String>
  13.         The output directory for the ZipFile. If this directory does not exist, it will
  14.         be created.
  15. NAME
  16.     Get-SourceServer
  17. SYNOPSIS
  18.     Returns a hashtable of the current source server settings..
  19. SYNTAX
  20.     Get-SourceServer [<CommonParameters>]
  21. DESCRIPTION
  22.     Returns a hashtable with the current source server directories settings
  23.     for VS 2010, Dev 11 Beta, and the _NT_SOURCE_PATH enviroment variable used
  24.     by WinDBG.
  26. NAME
  27.     Get-SourceServerFiles
  28. SYNOPSIS
  29.     Prepopulate your symbol cache with all your Source Server extracted source
  30.     code.
  31. SYNTAX
  32.     Get-SourceServerFiles [-CacheDirectory] <String> [[-SrcTool] <String>] [<CommonParameters>]
  33. DESCRIPTION
  34.     Recurses the specified symbol cache directory for PDB files with Source Server
  35.     sections and extracts the source code. This script is a simple wrapper around
  36.     SRCTOOl.EXE from the Debugging Tools for Windows (AKA WinDBG). If WinDBG is in
  37.     the PATH this script will find SRCTOOL.EXE. If WinDBG is not in your path, use
  38.     the SrcTool parameter to specify the complete path to the tool.
  39. PARAMETERS
  40.     -CacheDirectory <String>
  41.         The required cache directory for the local machine.
  42.     -SrcTool <String>
  43.         The optional parameter to specify where SRCTOOL.EXE resides.
  44. NAME
  45.     Get-SymbolServer
  46. SYNOPSIS
  47.     Returns a hashtable of the current symbol server settings.
  48. SYNTAX
  49.     Get-SymbolServer [<CommonParameters>]
  50. DESCRIPTION
  51.     Returns a hashtable with the current source server directories settings
  52.     for VS 2010, Dev 11 Beta, and the _NT_SYMBOL_PATH enviroment variable.
  53. NAME
  54.     Get-SysinternalsSuite
  55. SYNOPSIS
  56.     Gets all the wonderful Sysinternals tools
  57. SYNTAX
  58.     Get-SysinternalsSuite [-Extract] <String> [[-Save] <String>] [<CommonParameters>]
  59. DESCRIPTION
  60.     Downloads and extracts the Sysinternal tools to the directory you specify.
  61. PARAMETERS
  62.     -Extract <String>
  63.         The directory where you want to extract the Sysinternal tools.
  64.     -Save <String>
  65.         The default is to download the SysinternalsSuite.zip file and remove it after
  66.         extracting the contents. If you want to keep the file, specify the save
  67.         directory with this parameter.
  68. NAME
  69.     Get-Uptime
  70. SYNOPSIS
  71.     Returns how long a computer has been running.
  72. SYNTAX
  73.     Get-Uptime [[-computerName] <String>] [<CommonParameters>]
  74. DESCRIPTION
  75.     Returns the TimeSpan for how long a computer is running. If you’d like it
  76.     formatted you can use “Get-Uptime -f {0}”
  77. PARAMETERS
  78.     -computerName <String>
  79. NAME
  80.     Set-SourceServer
  81. SYNOPSIS
  82.     Sets the source server directory.
  83. SYNTAX
  84.     Set-SourceServer [-Directory] <String> [<CommonParameters>]
  85. DESCRIPTION
  86.     Sets the source server cache directory for VS 2010, Dev 11 Beta, and WinDBG
  87.     through the _NT_SOURCE_PATH environment variable to all reference the same
  88.     location. This ensures you only download the file once no matter which
  89.     debugger you use. Because this cmdlet sets an environment variable you
  90.     need to log off to ensure it’s properly set.
  91. PARAMETERS
  92.     -Directory <String>
  93.         The directory to use. If the directory does not exist, it will be created.
  94. NAME
  95.     Set-SymbolServer
  96. SYNOPSIS
  97.     Sets up a computer to use a symbol server.
  98. SYNTAX
  99.     Set-SymbolServer [-Internal] [-Public] [[-CacheDirectory] <String>] [[-SymbolServers] <String[]>] [-WhatIf] [-Confi
  100.     rm] [<CommonParameters>]
  101. DESCRIPTION
  102.     Sets up both the _NT_SYMBOL_PATH environment variable as well as Visual Studio
  103.     2010 and Dev 11 Beta (if installed) to use a common symbol cache directory as
  104.     well as common symbol servers.
  105. PARAMETERS
  106.     -Internal [<SwitchParameter>]
  107.         Sets the symbol server to use to http://SymWeb. Visual Studio will not use
  108.         the public symbol servers. This will turn off the .NET Framework Source
  109.         Stepping. This switch is intended for internal Microsoft use only.
  110.         You must specify either -Internal or -Public to the script.
  111.     -Public [<SwitchParameter>]
  112.         Sets the symbol server to use as the two public symbol servers from Microsoft.
  113.         All the appropriate settings are configured to properly have .NET Reference
  114.         Source stepping working.
  115.     -CacheDirectory <String>
  116.         Defaults to C:SYMBOLSPUBLICMicrosoftPublicSymbols for -Public and
  117.         C:SYMBOLSINTERNAL for -Internal.
  118.     -SymbolServers <String[]>
  119.         A string array of additional symbol servers to use. If -Internal is set, these
  120.         additional symbol servers will appear after HTTP://SYMWEB. If -Public is
  121.         set, these symbol servers will appear after the public symbol servers so both
  122.         the environment variable and Visual Studio have the same search order.
Stay Informed

Sign up for the latest blogs, events, and insights.

We deliver solutions that accelerate the value of Azure.
Ready to experience the full power of Microsoft Azure?
Start Today

Atmosera is thrilled to announce that we have been named GitHub AI Partner of the Year.

X