4. Справочная система PowerShell

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

1. Получение справки о командлетах

Краткую справку по какому-либо одному командлету можно получить с помощью параметра -? (вопросительный знак), указанного после имени этого командлета. Например, для получения справки по командлету Get-Process нужно выполнить следующую команду:

PS C:\> Get-Process -?

ИМЯ

Get-Process

ОПИСАНИЕ

Отображает процессы, выполняющиеся на локальном компьютере.

СИНТАКСИС

Get-Process [[-name] <string[]>] [<CommonParameters>]

Get-Process –id <Int32[]> [<CommonParameters>]

Get-Process –inputObject <Process[]> [<CommonParameters>]

ПОДРОБНОЕ ОПИСАНИЕ

Командлет Get-Process извлекает объект-процесс для каждого процесса. При использовании командлета “Get-Process” без указания параметров происходит отображение всех процессов, выполняющихся на компьютере, что эквивалентно команде “Get-Process *”. Процесс можно определить по имени или индетификатору (PID) или передав объект по конвейеру в командлет Get-Process. Для Get-Process по умолчанию передаётся имя процесса. Для Stop-Process по умолчанию передаётся индетификатор процесса.

ССЫЛКИ ПО ТЕМЕ

Stop-Process

ЗАМЕЧАНИЕ

Для получения дополнительных сведений введите: ”get-help Get-Process -detailed”.

Для получения технических сведений введите: ”get-help Get-Process -full”.

Как видите, в этой справке кратко описываются интересующий нас командлет и приводятся допустимые варианты его синтаксиса. Необязательные параметры выводятся в квадратных скобках. Если для параметра необходимо указывать аргумент определённого типа, то после имени такого параметра в угловых скобках приводится название этого типа.

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

PS C:\ > Get-Help Get-Process -Full

ИМЯ

Get-Process

ОПИСАНИЕ

Отображаетпроцессы, выполняющиеся на локальном компьютере.

СИНТАКСИС

Get-Process [[-name] <string[]>] [<CommonParameters>]

Get-Process –id <Int32[]> [<CommonParameters>]

Get-Process –inputObject <Process[]> [<CommonParameters>]

ПОДРОБНОЕ ОПИСАНИЕ

Командлет Get-Process извлекает объект-процесс для каждого процесса. При использовании командлета “Get-Process” без указания параметров происходит отображение всех процессов, выполняющихся на компьютере, что эквивалентно команде “Get-Process *”. Процесс можно определить по имени или индетификатору (PID) или передав объект по конвейеру в командлет Get-Process. Для Get-Process по умолчанию передаётся имя процесса. Для Stop-Process по умолчанию передаётся индетификатор процесса.

ПАРАМЕТРЫ Name <string[]>

Задаёт один или несколько процессов, используя их имена. Можно ввести несколько имён процессов, разделяя их запятыми, либо использовать подставочные знаки. Параметр (“-Name”), задающий имя, является необязательным.

Требуется? False

Позиция? 1

Значение по умолчанию Null

Принимать входные данные конвейера? True (ByPropertyName)

Принимать подстановочные знаки? True

Как видите, в описании параметра Name даются сведения о ряти атрибутах (таблица 15). Эти атрибуты характерны для большинства параметров командлетов.

Таблица 15. Возможности редактирования в командной строке PowerShell

Параметр	Описание
Требуется?	Указывает, будет ли командлет выполняться при отсутствии этого параметра. Если настройке присвоено значение True, то при запуске данного командлета необходимо указывать параметр. Если параметр не задан, система запросит его значение.
Позиция?	Определяет, можно ли задавать значение параметра без указания его имени и позицию, в которой он должен быть указан, если это возможно. Если атрибут имеет значение 0 или named, то при задании значения параметра необходимо указывать его имя. Именованные параметры могут перечисляться после имени командлета в любом порядке. Если атрибут “Позиция?” имеет целое ненулевое значение, то имя параметра указывать не обязательно. Значение атрибута ”Позиция?” определяет порядковый номер параметра в списке других позиционных параметров. При указании имени позиционные параметры могут перечисляться после имени командлета в любом порядке.
Значение по умолчанию?	Содержит значение по умолчанию, которого используется в том случае, когда никакого иного значения не указано. Обязательным параметрам, так же как и многим необязательным, никогда не присваивается значение по умолчанию.
Принимать входные данные конвейера?	Определяет, может ли параметр получать своё значение из объекта в конвейере. Чтобы команду можно было включить в конвейер, соответствующая настройка её входного параметра должна иметь значение True, что даёт возможность принимать конвейерный ввод.
Принимать подстановочные знаки?	Показывает, может ли значение параметра содержать подстановочные знаки, что даёт возможность сопоставлять его с несколькими существующими в целевом конвейере элементами.