PowerShell - How to Import-Module in a Runspace

Question

I am trying to create a cmdlet in C#. The code looks something like this:

[Cmdlet(VerbsCommon.Get, "HeapSummary")]
public class Get_HeapSummary : Cmdlet
{
    protected override void ProcessRecord()
    {
        RunspaceConfiguration config = RunspaceConfiguration.Create();
        Runspace myRs = RunspaceFactory.CreateRunspace(config);
        myRs.Open();

        RunspaceInvoke scriptInvoker = new RunspaceInvoke(myRs);
        scriptInvoker.Invoke("Set-ExecutionPolicy Unrestricted");

        Pipeline pipeline = myRs.CreatePipeline();
        pipeline.Commands.Add(@"Import-Module G:\PowerShell\PowerDbg.psm1");
        //...
        pipeline.Invoke();

        Collection<PSObject> psObjects = pipeline.Invoke();
        foreach (var psObject in psObjects)
        {
            WriteObject(psObject);
        }
    }
}

But trying to execute this CmdLet in PowerShell gives me this error: The term Import-Module is not recognized as the name of a cmdlet. The same command in PowerShell doesn't give me this error. If I execute 'Get-Command' instead, I can see that 'Invoke-Module' is listed as a CmdLet.

Is there a way to do an 'Import-Module' in a Runspace?

Thanks!

xorinzor · Accepted Answer · 2020-11-13 15:07:58Z

25

There are two ways to import modules programmatically, but I'll address your method first. Your line pipeline.Commands.Add("...") should only be adding the command, not the command AND the parameter. The parameter is added separately:

# argument is a positional parameter
pipeline.Commands.Add("Import-Module");
var command = pipeline.Commands[0];
command.Parameters.Add("Name", @"G:\PowerShell\PowerDbg.psm1")

The above pipeline API is a bit clumsy to use and is informally deprecated for many uses although it's at the base of many of the higher level APIs. The best way to do this in powershell v2 or higher is by using the System.Management.Automation.PowerShell Type and its fluent API:

# if Create() is invoked, a runspace is created for you
var ps = PowerShell.Create(myRS);
ps.Commands.AddCommand("Import-Module").AddArgument(@"g:\...\PowerDbg.psm1")
ps.Invoke()

Another way when using the latter method is to preload modules using InitialSessionState, which avoids the need to seed the runspace explictly with Import-Module.

InitialSessionState initial = InitialSessionState.CreateDefault();
    initialSession.ImportPSModule(new[] { modulePathOrModuleName1, ... });
    Runspace runspace = RunspaceFactory.CreateRunspace(initial);
    runspace.Open();
    RunspaceInvoke invoker = new RunspaceInvoke(runspace);
    Collection<PSObject> results = invoker.Invoke("...");

Hope this helps.

edited Nov 13, 2020 at 15:07

xorinzor

6,49410 gold badges48 silver badges76 bronze badges

answered Jun 7, 2011 at 15:20

x0n

52.6k8 gold badges97 silver badges116 bronze badges

Sign up to request clarification or add additional context in comments.

7 Comments

Absolom Over a year ago

Thanks! But the method Add() returns void. I guess that you need to use a Command object and add a the parameter to it and pass it to the method Add. You are talking about two ways to do it programmatically, what is the second way?

Absolom Over a year ago

I also found out that if you get "AuthorizationManager check failed" exception when trying to import your module, make sure sure your .psm1 file is saved in UTF8 and not in ASCII.

CB. Over a year ago

@x0n Oops.. The link is dead (?)

x0n Over a year ago

blog upgrade broke links - sigh.

Thomas Jones Over a year ago

web.archive.org/web/20190330193827/http://nivot.org/blog/post/…

|

Venkatesh Dharavath · Accepted Answer · 2020-05-22 00:40:56Z

0

The simplest way that you can do this is by using AddScript() method. You can do:

pipeline.AddScript("Import-Module moduleName").Invoke();

If you want to add another import in the same line

pipeline.AddScript("Import-Module moduleName \n Import-Module moduleName2").Invoke();

Its not mandatory to .Invoke() right ofter you add the script to the pipeline, you can add more scripts and invoke later.

pipeline.AddScript("Import-Module moduleName");
pipeline.AddCommand("pwd");
pipeline.Invoke();

For more information visit Microsoft Official website

edited May 22, 2020 at 0:40

answered May 19, 2020 at 21:13

Venkatesh Dharavath

5301 gold badge6 silver badges22 bronze badges

Collectives™ on Stack Overflow

PowerShell - How to Import-Module in a Runspace

2 Answers 2

7 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

7 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related