How to read errors from Powershell pipeline in c#?

Question

I am using System.Management.Automation.Runspaces.Pipleline to create a powershell pipeline instance and execute my powershell scripts in c# console application, the problem is that if the script end up with an error, then i don't know how to print that error on the console screen.

This is my code,

System.Management.Automation.Runspaces.Runspace PowershellRunspace = System.Management.Automation.Runspaces.RunspaceFactory.CreateRunspace();
PowershellRunspace.Open();

System.Management.Automation.RunspacesPipeline PowershellPipeline = PowershellRunspace.CreatePipeline();
PowershellPipeline.Commands.AddScript(PowershellScript);
PowershellPipeline.Commands.AddScript("Out-String");
foreach (string IpAddress in ActiveSystemIPAddresses)
{

    PowershellPipeline.Commands.AddScript("Stop-Computer -ComputerName \"" + IpAddress + "\" -Credential $Credentials");
}
try
{
    Collection<PSObject> output = PowershellPipeline.Invoke();
    if (PowershellPipeline.HadErrors)
    {
        Console.WriteLine("Cannot shutdown this server IP");
    }
    PowershellPipeline.Stop();

    StringBuilder results = new StringBuilder();

    foreach (PSObject obj in output)
    {
        results.AppendLine(obj.ToString());
    }
    Console.WriteLine(results);
}
catch (Exception e)
{
    Console.WriteLine(e.Message);
}
PowershellRunspace.Close();

I can see the property Pipeline.HadErrors but it only rake me to the loop if there are errors detected, its doing anyhting to get the error message. My problem is how to get the actual error on the console screen?

Sani Huttunen · Accepted Answer · 2018-08-02 07:45:55Z

8

Something like this should get you the errors.

var rs = RunspaceFactory.CreateRunspace();
rs.Open();
var ps = rs.CreatePipeline();
ps.Commands.AddScript("Get-Member");
ps.Commands.AddScript("ps");

try
{
    var result = ps.Invoke();

    if (ps.HadErrors)
    {
        var errors = ps.Error.ReadToEnd();
        foreach (var error in errors)
        {
            Console.WriteLine(error);
        }
    }

    foreach (var r in result)
    {
        Console.WriteLine(r);
    }
}
catch (Exception ex)
{
    Console.WriteLine(ex.Message);
}
finally
{
    ps.Stop();
}

answered Aug 2, 2018 at 7:45

Sani Huttunen

24.4k7 gold badges78 silver badges82 bronze badges

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

Comments

Jawad · Accepted Answer · 2020-05-20 06:03:44Z

4

With the recent changes, following works with Microsoft.powershell.5.referenceAssemblies in C#

var result = ps.Invoke();

if (ps.HadErrors)
{
    foreach (ErrorRecord error in ps.Streams.Error.ReadAll())
    {
        Console.WriteLine(error.ToString());
        // You can access error.FullyQualifiedErrorId or error.Exception if you needed to 
        //   be specific in what you were looking for when it failed.
    }
}

answered May 20, 2020 at 6:03

Jawad

11.4k3 gold badges28 silver badges43 bronze badges

Comments

Henrik Stanley Mortensen · Accepted Answer · 2018-08-02 07:46:08Z

0

To see the errors you can look at the collection PowerShell.Streams.Error.

If you wanted to do this natively in a PowerShell script and return the error you could wrap it in a try/catch and return the $error variable.

$error is a PowerShell variable where all errors are automatically added in an array. The first item in the array is always the newest error.

answered Aug 2, 2018 at 7:46

Henrik Stanley Mortensen

1,0778 silver badges12 bronze badges

Collectives™ on Stack Overflow

How to read errors from Powershell pipeline in c#?

3 Answers 3

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related