Получение справки в Powershell Get-Help


31 августа 2019


Получение справки в Powershell Get-Help

Получение справки в Powershell выполняется через команду Get-Help. C помощью справочника мы можем вернуть ключи, описание и примеры использования команды, а так же многое другое.

Командлет содержит несколько алиасов и многим будет удобнее использовать один из них. Так я получаю справку по справке в Powershell:

Get-Help Get-Help
Get-Help -?
# Команды ниже будут выводить текст постранично, аналогично man ls | less в Linux
man man
help help

Если вам нужно найти пример использования командлета, то на примере Get-History (история выполненных команд в Powershell) нужно сделать:

Get-Help Get-History -Examples
# или 
man -Name Get-History -Examples

Для какой-то команды может не быть справочника и потребуется обновление. Обновление можно выполнить так:

Update-Help

Может возникнуть вопрос о русской справки в Powershell. Такого понятия у Microsoft нет. Во времена Windows 7 такая ситуация вроде и была, но не в редакциях Windows 10. В случаях русской локализации Windows какие-то команды имеют перевод. Кто-то рекомендует обновлять русскую справку так:

Update-Help -UICulture "ru-RU" -Force

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

Кроме справочника Powershell в консоли мы можем получить и в графическом окне или на сайте:

  • Online - откроется страница на сайте Microsoft
  • ShowWindow - откроется диалоговое окно

Выглядит это примерно так:

Get-Help Get-History -Online
Get-Help Get-History -ShowWindow

Получение справки онлайн Powershell

На сайте Microsoft примеры аналогичны встроенному справочнику Powershell, но немного удобнее читать и бывают статьи переведенные на русский язык.

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

Get-Help * | where -Property Synopsis -Like '*AD*group*'

Powershell Get-Help

Что бы область 1 была заполнена нужно обновить справку.

Я считаю такой метод не эффективны, так как он работает дольше. Если есть поверхностное понимание Powershell, то вы знаете, что первое слово в командлетах всегда глагол, а второе существительное. Добавление на английском Add и я использую другую команду для поиска командлетов:

# Verb- глагол, Noun - существительное
Get-Command -Verb 'Add' -Noun '*AD*Group*'

Get-Comman пример

Далее я уже получу справку по команде:

Get-Help Add-ADGroupMember -Full

Full выводит справку полностью. Обычно нужно вывести ключи и по ним мы можем понять что нам требуется для работы командлета. Таких вариантов два. Первый - это вывести ключи с их полным описанием:

# Вместо звездочки можно поставить название ключа
Get-Help Add-ADGroupMember -Parameter *

Может получиться достаточно сложное чтиво. Я, в основном, вывожу список ключей так:

Get-Command Add-ADGroupMember -Syntax

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

Get-Command -Module Hyper-V

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

help about_*

Справка ниже выведет информацию о подписи файлов со скриптами:

man about_signing

 

...

Теги: #powershell


Популярные тэги
О блоге
Этот блог представляет собой конспекты выученного материала, преобретенного опыта и лучшие практики в системном администрировании и программировании.