Powershell вывод в таблицу excel

В это статье мы покажем, как получить доступ к данным в файлах Excel напрямую из PowerShell. Возможности прямого обращения к данным Excel из PowerShell открывает широкие возможности по инвентаризации и построению различных отчетов по компьютерам, серверам, инфраструктуре, Active Directory и т.д.

Обращение к Excel из PowerShell выполняется через отдельный Component Object Model (COM) объект. Это требует наличие установленного Excel на компьютере.

Прежде, чем показать, как обратиться к данным в ячейке файла Excel, необходимо рассмотреть архитектуру уровней представления в документе Excel. На следующем рисунке показаны 4 вложенных уровня в объектной модели Excel:

• Уровень приложения (Application Layer) – запущенное приложение Excel;
• Уровень книги (WorkBook Layer) – одновременно могут быть открыты несколько книг (документов Excel);
• Уровень листа (WorkSheet Layer) – в каждом xlsx файле может быть несколько листов;
• Ячейки (Range Layer) – здесь можно получить доступ к данным в конкретной ячейке или диапазонe ячеек.

Доступ к данным в Excel из консоли PowerShell

Рассмотрим на простом примере как получить доступ из PowerShell к данным в Excel файле со списком сотрудников.

Сначала нужно запустить на компьютере приложение Excel (application layer) через COM объект:

$ExcelObj = New-Object -comobject Excel.Application

После выполнения этой команды на компьютере запускается в фоновом режиме приложение Excel. Чтобы сделать окно Excel видимым, нужно изменить свойство Visible COM объекта:

$ExcelObj.visible=$true

Все свойства объекта Excel можно вывести так:
$ExcelObj| fl

Теперь можно открыть файл (книгу, workbook) Excel:

$ExcelWorkBook = $ExcelObj.Workbooks.Open("C:PSad_users.xlsx")

В каждом файле Excel может быть несколько листов (worksheets). Выведем список листов в текущей книге Excel:

$ExcelWorkBook.Sheets| fl Name, index

Теперь можно открыть конкретный лист (по имени или по индексу):

$ExcelWorkSheet = $ExcelWorkBook.Sheets.Item("AD_User_List")

Текущий (активный) лист Excel можно узнать командой:

$ExcelWorkBook.ActiveSheet | fl Name, Index

Теперь вы можете получить значения из ячеек документа Excel. Можно использовать различные способы адресации ячеек в книге Excel: через диапазон (Range), ячейку (Cell), столбец (Columns) или строку(Rows). Ниже я привел разные примеры получения данных из одной и той же ячейки:

$ExcelWorkSheet.Range("B2").Text
$ExcelWorkSheet.Range("B2:B2").Text
$ExcelWorkSheet.Range("B2","B2").Text
$ExcelWorkSheet.cells.Item(2, 2).text


$ExcelWorkSheet.cells.Item(2, 2).value2
$ExcelWorkSheet.Columns.Item(2).Rows.Item(2).Text
$ExcelWorkSheet.Rows.Item(2).Columns.Item(2).Text

Как получить данные из Active Directory и сохранить их в книге Excel?

Рассмотрим практический пример использования доступа к данным Excel из PowerShell. Например, нам нужно для каждого пользователя в Excel файле получить информацию из Active Directory. Например, его телефон (атрибут telephoneNumber), отдел (department) и email адрес (mail).

# Импорт модуля Active Directory в сессию PowerShell
import-module activedirectory
# Сначала откройте книгу Excel:
$ExcelObj = New-Object -comobject Excel.Application
$ExcelWorkBook = $ExcelObj.Workbooks.Open("C:PSad_users.xlsx")
$ExcelWorkSheet = $ExcelWorkBook.Sheets.Item("AD_User_List")
# Получаем количество заполненных строк в xlsx файле
$rowcount=$ExcelWorkSheet.UsedRange.Rows.Count
# Перебираем все строки в столбце 1, начиная со второй строки (в этих ячейках указано доменное имя пользователя)
for($i=2;$i -le $rowcount;$i++){
$ADusername=$ExcelWorkSheet.Columns.Item(1).Rows.Item($i).Text
# Получаем значение атрибутов пользователя в AD
$ADuserProp = Get-ADUser $ADusername -properties telephoneNumber,department,mail|select-object name,telephoneNumber,department,mail
#Заполняем ячейки данными из AD
$ExcelWorkSheet.Columns.Item(4).Rows.Item($i) = $ADuserProp.telephoneNumber


$ExcelWorkSheet.Columns.Item(5).Rows.Item($i) = $ADuserProp.department
$ExcelWorkSheet.Columns.Item(6).Rows.Item($i) = $ADuserProp.mail
}
#Сохраните xls файл и закройте Excel
$ExcelWorkBook.Save()
$ExcelWorkBook.close($true)

В результате в Excel файле для каждого пользователя были добавлены столбцы с информацией из AD.

Рассмотрим еще один пример построения отчета с помощью PowerShell и Excel. Допустим, вам нужно построить Excel отчет о состоянии службы Print Spooler на всех серверах домена.

# Создать объект Excel
$ExcelObj = New-Object -comobject Excel.Application
$ExcelObj.Visible = $true
# Добавить рабочую книгу
$ExcelWorkBook = $ExcelObj.Workbooks.Add()
$ExcelWorkSheet = $ExcelWorkBook.Worksheets.Item(1)
# Переименовывать лист
$ExcelWorkSheet.Name = 'Статус сервиса spooler'
# Заполняем шапку таблицы
$ExcelWorkSheet.Cells.Item(1,1) = 'Имя сервера'
$ExcelWorkSheet.Cells.Item(1,2) = 'Имя службы'
$ExcelWorkSheet.Cells.Item(1,3) = 'Статус службы'
# Выделить шапку таблицы жирным. задать размер шрифта и ширину столбцов
$ExcelWorkSheet.Rows.Item(1).Font.Bold = $true
$ExcelWorkSheet.Rows.Item(1).Font.size=14
$ExcelWorkSheet.Columns.Item(1).ColumnWidth=25
$ExcelWorkSheet.Columns.Item(2).ColumnWidth=25
$ExcelWorkSheet.Columns.Item(3).ColumnWidth=25
# получим список всех Windows Server в домене
$computers = (Get-ADComputer -Filter 'operatingsystem -like "*Windows server*" -and enabled -eq "true"').Name
$counter=2
# подключается к каждому компьютеру и получаем статус службы
foreach ($computer in $computers) {
$result = Invoke-Command -Computername $computer –ScriptBlock { Get-Service spooler | select Name, status }
#Заполняем ячейки Excel данными с сервера
$ExcelWorkSheet.Columns.Item(1).Rows.Item($counter) = $result.PSComputerName
$ExcelWorkSheet.Columns.Item(2).Rows.Item($counter) = $result.Name
$ExcelWorkSheet.Columns.Item(3).Rows.Item($counter) = $result.Status
$counter++
}
# сохраните полученный отчет и закройте Excel:
$ExcelWorkBook.SaveAs('C:psservice-report.xlsx')
$ExcelWorkBook.close($true)

Область применения возможностей доступа из PowerShell в Excel очень широка. Начиная от простого построения отчетов, например, из Active Directory, и заканчивая возможностью создания PowerShell скриптов для актуализации данных в AD из Excel.

Например, вы можете поручить сотруднику отдела кадров вести реестр пользователей в Excel. Затем с помощью PowerShell скрипта через Set-ADUser сотрудник может автоматически обновлять данные пользователей в AD (достаточно делегировать пользователю права на изменение этих атрибутов пользователей AD и показать как запускать PS скрипт). Таким образом можно вести актуальную адресную книгу с актуальными номерами телефонами и должностями.

As of now, there is no built-in command like CSV (Export-CSV) to export output to the excel file but we can use the Out-File command to export data to excel or any other file format.

Let’s use Out-File to export the output of the Get-Processes command to an excel file.

Get-Process | Out-File C:Tempprocesses.xls

The above command will get all the running processes on the local system to the excel file. Let’s check the output of the excel file. You can see that the output is not in the proper excel format.

One other way is to install the ImportExcel module for excel. It is a very popular module to work with excel files.

To install the ImportExcel module, you need to run the below command to get it installed from the PowerShell gallery.

Install-Module ImportExcel -AllowClobber -Force

Once you install it, you need to import the module in the current PowerShell session if not imported.

Get-Module ImportExcel -ListAvailable | Import-Module -Force -Verbose

Once you have this module loaded in PowerShell, you can run the below command to export output into the excel format.

Get-Process | Export-Excel -Path C:TempProcesses.xlsx

Output

January 10th, 2014

Summary: Microsoft PowerShell MVP, Tobias Weltner, talks about Windows PowerShell and Excel interaction.
Microsoft Scripting Guy, Ed Wilson, is here. Let’s welcome back guest blogger, Tobias Weltner…
Microsoft Excel is a great tool to share Windows PowerShell data. However, the scripting tactics have changed from the good old VBScript times. Let’s take a look at how Windows PowerShell can output data to Excel fast, safe, and reliably.

Out-GridView: Built-in “mini-Excel”

Before I touch Excel, let’s first look at its little cousin, which ships with Windows PowerShell: Out-GridView.
It’s trivial to use: simply pipe anything to Out-GridView, and it will happily display the content in a mini-spreadsheet:

Get-Process | Where-Object { $_.MainWindowTitle } | Out-GridView
You can even use Out-GridView as a generic selection dialog box. Add the parameter –passThru (added in PowerShell 3.0). This parameter adds two new buttons to the lower right area of the grid view, and when you select something, it will be returned to you.
Curious? This piece of script pipes all top-level applications to the grid view, and when you select one and click OK, it will be immediately deleted:

Get-Process |

  Where-Object MainWindowTitle |

  Out-GridView -Title ‘Select Program To Kill’ -PassThru |

  Stop-Process
That’s admittedly a bit rude (and dangerous, too, because you will lose all unsaved data). So here is a gentleman’s version that will actually ask if there is unsaved data. It also allows the program to clean up its resources before it closes.

Get-Process |

  Where-Object MainWindowTitle |

  Out-GridView -Title ‘Select Program To Kill’ -PassThru |

  ForEach-Object { $_.CloseMainWindow() } 

Excel: Out-GridView on steroids

So what about Excel? Why use it at all? Well, there are things that Out-GridView cannot do. You cannot save the data, and you cannot hand it over to someone else. And of course, you cannot use the many sophisticated formatting options that are found in Microsoft Excel spreadsheets.
Out-GridView can show a maximum of 30 columns. So if an object has more than 30 properties, Out-GridView silently suppresses the rest. I’d call this a bug, but maybe it’s a feature, too. Anyhow, here is a script to prove the point:

1..100 |

ForEach-Object { $hash = [Ordered]@{} }{$hash.”Column$_” = $_}{ New-Object PSObject -Property $hash} | Out-GridView
This creates an object with 100 properties. Out-GridView only displays the first 30. Time for Excel…the real thing.
Wouldn’t it be nice to be able to do this:

Get-Process | Where-Object { $_.MainWindowTitle } | Out-Excel
Or, for that matter, this (and finally get all object properties and not just the first 30):

1..100 |

ForEach-Object { $hash = [Ordered]@{} }{$hash.”Column$_” = $_}{ New-Object PSObject -Property $hash} |

Out-Excel
Well, you can.
Out-Excel actually is a ridiculously simple Windows PowerShell function:

function Out-Excel

{

  param($Path = “$env:temp$(Get-Date -Format yyyyMMddHHmmss).csv”)

  $input | Export-CSV -Path $Path -UseCulture -Encoding UTF8 -NoTypeInformation

  Invoke-Item -Path $Path

}

 Get-Process | Where-Object { $_.MainWindowTitle } | Out-Excel
You get a report that includes all the technical data from all of your running main applications. With all of the object properties—nothing is left out.
Basically, you can pipe anything into Out-Excel. It works pretty much like Out-GridView (except that you cannot turn Excel into a selection dialog, of course).
$input is an automatic Windows PowerShell variable. It delivers all data that is piped from the upstream cmdlet, and this data is then written to a CSV file and opened with Excel.
Because Excel always shows all properties, you may want to use Select-Object and select only the properties you really care about:

Get-Process |

  Where-Object { $_.MainWindowTitle } |

  Select-Object -Property Name, Company, Description, CPU |

  Out-Excel

Writing directly to Excel

Going the CSV route is fast and robust, but cannot use color in cells or apply any other formatting.
That’s why some years ago in VBScript, people started to use a COM object to access the Excel object model. Although this works in Windows PowerShell, too, it is not very reliable anymore. Excel lives in the old COM world, and Windows PowerShell lives in the modern .NET world.
The underlying .NET Framework needs extensive marshalling to access the COM objects (which makes it very slow). In some scenarios, it fails altogether, for example, when type libraries do not fit together because operating system and office binaries use different locales. Even if everything works, and you waited for the code to finish, Excel will continue to linger in memory because of leaking handles. It’s just too complicated.
Here is sample code that does access Excel’s object model directly. You have been warned. Don’t be mad at me if the code fails or is really, really slow:

$excel = New-Object -ComObject Excel.Application

$excel.Visible = $true

$workbook = $excel.Workbooks.Add()

$sheet = $workbook.ActiveSheet

$counter = 0

Get-Service |

ForEach-Object {

    $counter++

    $sheet.cells.Item($counter,1) = $_.Name

    $sheet.cells.Item($counter,2) = $_.DisplayName

    $sheet.cells.Item($counter,3) = $_.Status

}
Here is the fast and clean way that is used by Windows PowerShell to create the same report:

Get-Service |

    Select-Object -Property Name, DisplayName, Status |

    Export-Csv -Path $env:tempreport.csv -Encoding UTF8 -UseCulture -NoTypeInformation

Invoke-Item -Path $env:tempreport.csv
Actually, Windows PowerShell is not even touching the internals of Excel; but instead, it is producing CSV files that can then be opened by Excel.

Formatting data with colors

Unfortunately, importing CSV data is a black and white world. You cannot use color in cells or format the spreadsheet otherwise.
Well actually, you can. This will create the very same report of services. This time, running services will show in green and stopped services in red.

# write HTML intro code:

$begin =

{

    ‘<table>’

    ‘<tr>’

    ‘<th>DisplayName</th><th>Status</th><th>Required</th><th>Dependent</th>’

    ‘</tr>’

}

# this is executed for each data object:

$process =

{

    if ($_.Status -eq ‘Running’)

    {

        $style = ‘<td style=”color:green; ; font-family:Segoe UI; font-size:14pt”>’

    }

    else

    {

        $style = ‘<td style=”color:red; font-family:Segoe UI; font-size:14pt”>’

    }

      ‘<tr>’

    ‘{0}{1}</td><td>{2}</td><td>{3}</td><td>{4}</td>’ -f $style, $_.DisplayName, $_.Status, ($_.RequiredServices -join ‘,’), ($_.DependentServices -join ‘,’)

    ‘</tr>’

}

# finish HTML fragment:

$end =

{

    ‘</table>’

}

$Path = “$env:temptempfile.html”

# get all services and create custom HTML report:

Get-Service |

  ForEach-Object -Begin $begin -Process $process -End $end |

  Set-Content -Path $Path -Encoding UTF8

# feed HTML report into Excel:

Start-Process -FilePath ‘C:Program Files*Microsoft OfficeOffice*EXCEL.EXE’ -ArgumentList $Path
The trick is to create an HTML report that gives you all the formatting opportunities you need. To create a Excel spreadsheet with color, the HTML file needs to be fed directly into excel.exe.
Note how Windows PowerShell automatically identifies the Excel version you use. Start-Process accepts a file path that can contain wildcard characters. By replacing version numbers in the path, Windows PowerShell can launch any Excel version that happens to be installed.
If you wanted to know that path, too, then simply ask Resolve-Path:

Resolve-Path -Path ‘C:Program Files*Microsoft OfficeOffice*EXCEL.EXE’ |

   Select-Object -ExpandProperty Path -First 1

Turning arrays into string

Take a look at the Excel spreadsheet that uses color again. Look at the columns RequiredServices and DependentServices. They are just fine—which might surprise you. Because typically, when Windows PowerShell exports arrays of information, they do not display well in Excel.
Check this out, for example…
The next piece of script outputs the 10 newest error events from your System event log to Excel. When you look at the data, the columns Data and ReplacementStrings contain unreadable stuff.
To make array content display correctly in Excel, arrays need to be converted to strings. Here’s sample script that illustrates how easily that can be done:

$Path = “$env:temp$(Get-Date -Format yyyyMMddHHmmss)report.csv”

Get-EventLog -LogName System -EntryType Error -Newest 10 |

  Select-Object -Property * |

  ForEach-Object {

     $_.ReplacementStrings = $_.ReplacementStrings -join ‘,’

     $_.Data = $_.Data -join ‘,’

     $_    

  } |

  Export-CSV -Path $Path -UseCulture -Encoding UTF8 -NoTypeInformation

Invoke-Item -Path $Path
When you run the script, the columns now reveal their content. And here is why…
The script first piped the data to Select-Object –Property *. Typically, you would use Select-Object to select the columns you want to have in your report. Select-Object will also do another thing: It copies the data into a new object, and this new object is yours. You can do whatever you want with it.
That’s the prerequisite for the subsequent Foreach-Object loop. Inside of it, you can fine tune, change, or revise the data in any way you wish. So the script takes the properties that contain arrays, ReplacementStrings, and Data, and converts these arrays to strings by using the –join operator. That’s it. Just don’t forget to put back the $_ variable inside Foreach-Object so that the downstream cmdlets can receive it.
Thank you, Tobias. Awesome script as usual.
I invite you to follow me on Twitter and Facebook. If you have any questions, send email to me at scripter@microsoft.com, or post your questions on the Official Scripting Guys Forum. See you tomorrow. Until then, peace.
Ed Wilson, Microsoft Scripting Guy