Вывод информации об успешном выполнении команды powershell. Out-Null или подавление вывода информации в Windows PowerShell. Кодирование с помощью PowerShell

Во время написания программы или скрипта любой начинающий программист столкнется с проблемой где ему нужно повторить код дважды и в этот могут помочь функции в Powershell . Функции так же называют методами и процедурами. Кроме многократного использования они так же полезны для выделения одной части скрипта от другой, хоть она и выполняется один раз. Методы описанные ниже существуют во множестве языках и работают по похожему сценарию.

Создание

Представим, что каждое утро вы проверяете 50 последних логов за 14 часов журнала Application с помощью этой команды:

Get-EventLog -LogName Application -Newest 50 | where TimeWritten -ge (Get-Date).AddHours(-14)

Команда не очень сложная, но в скором времени ее надоест писать. Для сокращения этой работы ее можно выделить в отдельную функцию:

Function Get-DayLog { Get-EventLog -LogName Application -Newest 50 | where TimeWritten -ge (Get-Date).AddHours(-14) }

Любая функция обязательно должна состоять из трех вещей:

• function - объявляет и говорит что после нее будет название;
• имя функции - название, по которому мы будем ее вызывать. В нашем случае имя Get-DayLog;
• скобки - обозначают начало и конец выражения.

После написания функции она вызывается по имени:

Get-DayLog

Учитывая, что нам может потребоваться получить данные не за последние 14 часов и более чем за 50 дней нам может потребуется изменить ее передав параметры.

Именование

Не обязательно использовать имя такого же плана, как принято в Powershell, то есть вместо "Get-DayLog" можно писать "daylog". Такой подход рекомендуем и является распространенной практикой, который поможет отличить запуск сторонней программы от функции.

Функции в Powershell всегда именуются по следующему признаку. Первое слово это глаголы типа:

• Get - получить;
• Set - изменить;
• Install - установить;
• New - создать.

Второе имя - это существительное, как в случае выше DayLog(дневной лог). У Microsoft есть утвержденный список глаголов, который доступен по ссылке на английском языке. Если вы не будете придерживаться этих правил и захотите добавить свою функцию (командлет или модуль) в один из репозиториев, то он может не пройти модерацию.

Передача параметров

Чаще всего функции принимают какой-то объект и возвращают. Для примера может потребоваться изменить время, когда эти логи созданы и их количество. В существующей функции такой возможности нет. Вы можете править код каждый раз, но это не подход программиста. Что бы такая возможность появилась в функции нужно добавить параметры, которая она будет принимать:

Function Get-DayLog ($param1,$param2) { Get-EventLog -LogName Application -Newest $param1 | where TimeWritten -ge (Get-Date).AddHours($param2) }

Параметры функции обозначаются в круглые скобки и пишутся после названия функции и до выражения.

Теперь, для вызова функции, требуется передавать два параметра:

Get-DayLog -param1 50 -param2 -14

При вызове функции мы передаем два обязательных параметра со значениями. Эти значения, внутри функции, будут доступны под названиями $param1 и $param2. Эти переменные мы передаем в команду получения и фильтрации логов.

Установка значений по умолчанию

В нашей задаче, чаще всего, мы получаем только 50 последних логов и нам не хочется указывать их каждый раз. Если мы не будем указывать этот параметр в существующей функции, то получим ошибку. Что бы этого избежать нужно указать значение по умолчанию. На примере ниже я присвоил $param1 значение 50. Оно будет использоваться только в том случае, если мы не используем этот параметр при вызове:

Function Get-DayLog ($param1=50,$param2) { Get-EventLog -LogName Application -Newest $param1 | where TimeWritten -ge (Get-Date).AddHours($param2) } Get-DayLog -param2 -7

Мы должны всегда указывать ключ param2, что добавляет немного работы. Что бы это исправить достаточно поменять их местами:

Function Get-DayLog ($param2,$param1=50) { Get-EventLog -LogName Application -Newest $param1 | where TimeWritten -ge (Get-Date).AddHours($param2) } Get-DayLog -7 1 Get-DayLog -7

Как видно на примере, если мы не указываем ключи param1 и param2 важна последовательность, так как именно в такой последовательности они будут присвоены переменным внутри функций.

Возвращение значений

В отличие от других языков, если мы присвоим переменной $result результат функции Get-DayLog, то она будет содержать значения:

$result = Get-DayLog -7 1

Это будет работать до тех пор, пока мы не решим изменить функцию присвоив переменные:

Function Get-DayLog ($param2,$param1=50) { $events = Get-EventLog -LogName Application -Newest $param1 | where TimeWritten -ge (Get-Date).AddHours($param2) } $result = Get-DayLog -7 $result $events

Мы не можем получить результат используя переменную $result, так как функция не выводит информацию, а хранит ее в переменной $events. Вызывая $events мы тоже не получаем информацию, так как тут работает понятие "область видимости переменных".

Так как функции это отдельная часть программы вся логика и ее переменные не должны касаться другой ее части. Область видимости переменных подразумевает это же. Все переменные, созданные внутри функции остаются в ней же. Эту ситуацию можно исправить с помощью return:

Function Get-DayLog ($param2,$param1=50) { $events = Get-EventLog -LogName Application -Newest $param1 | where TimeWritten -ge (Get-Date).AddHours($param2) return $events } $result = Get-DayLog -7 $result

Я бы рекомендовал всегда возвращать значения через return, а не использовать вывод используя команды типа Write-Output внутри функции. Использование return останавливает работу функции и возвращает значение, а это значит что его не стоит ставить по середине логики если так не планировалось.

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

Function Get-Salary ($Zarplata) { $nalog = $Zarplata * 0.13 $zarplata_bez_nds = $Zarplata - $nalog return $nalog,$zarplata_bez_nds } Get-Salary -Zarplata 100000

Я вернул оба значения разделив их запятой. По умолчанию всегда возвращается массив. это набор не именованных параметров. Более подробно о них мы уже писали.

В случае с массивами, что бы добавит надпись о зарплате, и налоге нужно использовать индексы:

$result = Get-Salary -Zarplata 100000 # Определяем тип данных $result.GetType() Write-Host "это зарплата" $result Write-Host "это налог" $result

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

Function Get-Salary ($Zarplata) { $nalog = $Zarplata * 0.13 $zarplata_bez_nds = $Zarplata - $nalog return @{"Налог"=$nalog;"Зарплата"=$zarplata_bez_nds;} } Get-Salary -Zarplata 100000

Использование массивов

Передача массивов в виде параметров

В предыдущих статьях было множество примеров по работе с массивами и хэш таблицами. Их же, как и любой другой тип данных, мы можем передавать в функцию. Для примера все команды Powershell, которые имеют ключ ComputerName, могут выполняться удаленно. Большинство таких команд могут принимать в виде значений массивы, то есть нам не обязательно передавать поочередно имена компьютеров.

Функция будет принимать массив с именами компьютеров и возвращать все остановленные сервисы. Я так же объявлю этот тип строгим, для наглядности, хотя и без этого в любом случае сработает:

Function Get-ServiceStopped ($Computers){ $services = Get-Service -ComputerName $Computers | where Status -eq Stopped return $services } Get-ServiceStopped "127.0.0.1","localhost"

Массивы так же работают по индексам, что позволяет передавать больше параметров. Такой способ не релевантный, но может когда-то пригодиться.

Function Get-ServiceStopped ($Computers){ $services = Get-Service -ComputerName $Computers | where Status -eq $Computers[-1] return $services } Get-ServiceStopped "127.0.0.1","localhost","Stopped"

Хэш таблицы

Параметры хэш таблиц и могут передаваться не просто в функцию, а как параметры командлетов. Добавим в нашу функцию запуск сервиса, если он остановлен:

Function Get-ServiceStopped ($Params){ $services = Get-Service @Params | where Status -eq Stopped $services = Start-Service $services return $services } Get-ServiceStopped @{Name="WinRM";ComputerName=@("127.0.0.1","localhost")}

Знак @ в команде объявляет, что данные хэш таблицы будут использоваться как параметры команды. Важно, чтобы их имена соответствовали настоящим параметрам.

Условия

Нет никаких ограничений на использования условий. Это бывает достаточно удобно, когда функция должна вернуть разные значения.

Ниже приведен пример, где в зависимости от скорости загрузки основной части сайта будет возвращен разный ответ. Если скорость ответа меньше 76 миллисекунды нормальная, в случае если более долгого ответа вернется другой результат:

Function Get-SiteResponse { # Начало отсчета $start_time = Get-Date # Выполнение запроса $request = Invoke-WebRequest -Uri "https://сайт" # Фиксирование окончания выполнения $end_time = Get-Date # Высчитываем разницу во времени $result = $end_time - $start_time # Проверка и возвращение результата if ($result.Milliseconds -lt 76) { return "Скорость ответа нормальная " + $result.Milliseconds} else{ return "Сайт отвечает долго " + $result.Milliseconds } } Get-SiteResponse

Switch

Мы уже говорили про в предыдущих статьях. Если коротко, то это более удобные условия. Используя предыдущий пример, но со Switch, это будет выглядеть так:

Function Get-SiteResponse { # Начало отсчета $start_time = Get-Date # Выполнение запроса $request = Invoke-WebRequest -Uri "https://сайт" # Фиксирование окончания выполнения $end_time = Get-Date # Высчитываем разницу во времени $result = $end_time - $start_time # Проверка и возвращение результата switch($result.Milliseconds) { {$PSItem -le 76} { return "Скорость ответа нормальная " + $result.Milliseconds} default { return "Сайт отвечает долго " + $result.Milliseconds } } } Get-SiteResponse

Другой пример Switch это вызов функции в зависимости от переданных параметров. На примере ниже я вызываю функцию, в которой находится Switch. В эту функцию я передаю имя компьютера, которое проверяется на упоминание указанных фраз и вызывает соответствующую функцию. Каждая функция, которая устанавливает обновления, возвращает значение в Switch, а затем происходит return внутри нее:

Function Install-SQLUpdates { # делаем установку return "Установка обновлений на SQL сервер прошла успешно" } function Install-ADUpdates { # делаем установку return "Установка обновлений на сервер AD прошла успешно" } function Install-FileServerUpdates { # делаем установку return "Установка обновлений на файловый сервер прошла успешно" } function Make-Switch ($computer) { # Проверка имени компьютера $result = switch($computer){ {$computer -like "SQL*"} {Install-SqlUpdates} {$computer -like "AD*"} {Install-ADUpdates} {$computer -like "FileServer*"} {Install-FileServerUpdates} default {"Такого типа компьютеров нет"} } return $result } Make-Switch "AD1"

Со switch так же удобно передавать булевы значения. В примере ниже если указан ключ -On сервис включится, а если его нет выключится:

Function Switch-ServiceTest ($on) { if ($on) {Write-Output "Сервис включен"} else {"Сервис выключен"} } Switch-ServiceTest -On Switch-ServiceTest

Передача через конвейер или Pipeline

Вы наверняка работали через команды Powershell, которые позволяли использовать конвейер следующим образом:

Get-Process -Name *TestProc* | Stop-Process

Если мы захотим использовать подход описанный выше, создав новые команды в виде функций, то конвейер не будет работать:

Function Get-SomeNum { # Генерация числа $num = Get-Random -Minimum 5 -Maximum 10 return $num } function Plus-SomeNum ($num) { Write-Host "Прибавление числа " $num $num += $num return $num } Get-SomeNum Plus-SomeNum 5 Get-SomeNum | Plus-SomeNum

Выполнив следующую команду мы сможем увидеть, что значения, которые могут приниматься через конвейер помечаются специальным атрибутом:

Get-Help Stop-Process -Parameter Name

Таких атрибутов всего два:

• ValueFromPipelineByPropertyName - получение значения из конвейера по имени;
• ValueFromPipeline - получение через конвейер только значения.

Кроме этого, внутри нашей функции, мы должны добавить специальный блок Process. Наш скрипт в итоге будет выглядеть так:

Function Get-SomeNum { $num = Get-Random -Minimum 5 -Maximum 10 return $num } function Plus-SomeNum { Param ( $num) process { Write-Host "Прибавление числа " $num $num += $num return $num } } 1..5 | Plus-SomeNum Get-SomeNum | Plus-SomeNum

Атрибут расширения функции, который добавляет некоторые возможности в функции позволяя им работать как команду.

Если бы мы не указали блок Process функция бы вернула только последней результат из массива 1..5:

Если наши команды будут иметь критический характер, такой как удаление, или через конвейер может передаваться несколько значений, то стоит использовать атрибут ValueFromPipelineByPropertyName. Таким образом мы исключим попадания через конвейер случайного значения. На примере ниже я изменил

Function Get-SomeNum { $num = Get-Random -Minimum 5 -Maximum 10 $object = @{num=$num} return $object } function Plus-SomeNum { Param ( $num) process { Write-Host "Прибавление числа " $num $num += $num return $num } } Get-SomeNum | Plus-SomeNum @{num=5} | Plus-SomeNum @{bad=5} | Plus-SomeNum

Как уже писалось ValueFromPipelineByPropertyName принимает только именованные параметры и в случае с именем "bad" мы получаем ошибку:

• Не удается привязать объект ввода к любым параметрам команды, так как команда не принимает входные данные конвейера
• The input object cannot be bound to any parameters for the command either because the command does not take pipeline input or the input and its properties do not match any of the parameters that take pipeline input.

Причем передавать именованные параметры через хэш таблицы мы не можем, только через pscustomobject.

Вы можете указывать сразу два атрибута таким образом:

Это позволит использовать и значение с именем, если оно указано либо без него. Это не спасет вас от ситуации, если вы передаете параметр с другим именем:

Передача через конвейер нескольких значений

Для примера рассмотрим ситуацию, где нам нужно передать через конвейер два значения. Если Get-SomeNum будет возвращать массив, то через конвейер у нас будет проходить каждое число по отдельности. Это еще один повод использовать именованные параметры:

Function Get-SomeNum { $number1 = Get-Random -Minimum 5 -Maximum 10 $number2 = Get-Random -Minimum 1 -Maximum 5 $object = @{num1=$number1;num2=$number2} return $object } function Plus-SomeNum { Param ( $num1, $num2) begin {$num1 += $num1 $num2 = $num2 * $num2} process { return @{"Результат сложения"=$num1; "Результат умножения"=$num2} } } Get-SomeNum | Plus-SomeNum

Закончим работу с выводом данных.

В том случае, если нам не нужен вывод информации на экран консоли (допустим, она просто для нас лишняя, и нам просто нужно, чтобы определенные команды отработали без вывода результатов на экран), мы можем воспользоваться командлетом Out-Null .

Что будет, если к хорошо известному командлету Get-Process добавить Out-Null ?

Get-Process | Out-Null
Пример действия Out-Null в PowerShell

Как видим, не произошло ровным счетом ничего. А, точнее будет сказать, ничего видимого для наших глаз. Командлет Get-Process отработал, но мы не захотели ознакомиться с результатами его работы. Конечно, данное действие было бессмысленным.

Можно привести пример более осмысленного действия. Перейдем в корень диска C и создадим там каталог primer.

cd c:\ mkdir primer

Как видим, PowerShell вывел нам содержимое только что созданного каталога. Если нам это не нужно, можно использовать Out-Null .

mkdir primer | Out-Null

Итак, Out-Null это полезный инструмент для совершения тех действий, которые должны выполняться что называется «под капотом».

Несмотря на то, что PowerShell консольный язык, иногда необходимо из скрипта PowerShell оповестить пользователя об определенном событии или необходимости выполнить определенное действие. Например, вывести уведомление о завершении какого-либо длительного PoSh скрипта, или об наступлении какого-то важного события.

Самый простой способ вывести окошко с произвольным тестом через подсистему сценариев Windows – Wscript.

Следующий код выведет обычное текстовое окно с необходимым текстом и кнопкой OK.

$wshell = New-Object -ComObject Wscript.Shell
$Output = $wshell.Popup("Скрипт формирования отчета выполнен")

С помощью различных свойств метода Popup вы можете настроить вид модального окна сообщения. В том числе можно вернуть в скрипт результаты ответа пользователя на вопрос (Да / Нет).

$Output = $wshell.Popup("Скрипт формирования отчета завершен! Хотите вывести его на экран?",0,"Отчет готов",4+32)

Общий синтаксис и параметры метода Popup:

Popup(,,