about_WorkflowCommonParameters

Назначение: Windows PowerShell 3.0

РАЗДЕЛ

about_Workflow_Common_Parameters

КРАТКОЕ ОПИСАНИЕ

В этом разделе описываются параметры, которые допускается использовать во всех командах рабочего процесса Windows PowerShell®. Так как обработчик Windows PowerShell добавляет эти параметры в рабочие процессы, их можно использовать в любом рабочем процессе и они автоматически включаются для создаваемых вами рабочих процессов.

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

Общие параметры рабочего процесса Windows PowerShell — это набор параметров командлетов, которые можно использовать со всеми рабочими процессами и действиями Windows PowerShell. Они добавляются обработчиком рабочих процессов Windows PowerShell, а не создателем рабочего процесса, и доступны автоматически для всех рабочих процессов и действий. Однако рабочие процессы на третьем уровне вложения не поддерживают общие параметры, включая общие параметры рабочих процессов.

Все параметры рабочих процессов являются необязательными и именованными (то есть не позиционными). Они не принимают входные данные из конвейера.

Большинство общих параметров рабочих процессов имеют префикс PS, например PSComputerName и PSCredential. Параметры с префиксом PS настраивают подключение и среду выполнения для конечных компьютеров (удаленных узлов).

Многие общие параметры рабочих процессов, такие как PSAllowRedirection и AsJob, имеют имена, которые похожи на имена параметров, используемых для удаленного взаимодействия и фоновых заданий Windows PowerShell. Эти параметры работают так же, как параметры удаленного взаимодействия и заданий с аналогичными именами, так что вы можете применять знания, полученные при работе с удаленным взаимодействием и заданиями, для управления рабочими процессами.

Рабочие процессы появились в версии Windows PowerShell 3.0.

ОПИСАНИЕ ПАРАМЕТРОВ

В этом разделе описываются общие параметры рабочих процессов.

AsJob <Параметр-переключатель>

Выполняет рабочий процесс как задание рабочего процесса. Команда рабочего процесса немедленно возвращает объект, представляющий родительское задание. Родительское задание содержит дочерние задания, выполняющиеся на каждом конечном компьютере. Для управления заданием используйте командлеты Job. Чтобы получить результаты выполнения задания, используйте командлет Receive-Job (https://go.microsoft.com/fwlink/?LinkID=113372).

JobName <Строка>

Указывает понятное имя для задания рабочего процесса. По умолчанию задания называются «Job<n>», где <n> — порядковый номер.

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

Подробнее о фоновых заданиях Windows PowerShell см. в разделе about_Jobs (https://go.microsoft.com/fwlink/?LinkID=113251).

PSAllowRedirection <Параметр-переключатель>

Разрешает перенаправление подключения к конечным компьютерам.

При использовании параметра PSConnectionURI удаленный компьютер может вернуть инструкцию для перенаправления на другой универсальный код ресурса (URI). По умолчанию Windows PowerShell не перенаправляет подключения, но вы можете использовать параметр PSAllowRedirection, чтобы разрешить перенаправление подключения к целевому компьютеру.

Вы также можете ограничить число перенаправлений подключения, задав свойство MaximumConnectionRedirectionCount привилегированной переменной $PSSessionOption или свойство MaximumConnectionRedirectionCount параметра PSSessionOption. Значение по умолчанию — 5. Подробнее см. в описании параметра PSSessionOption и командлета New-PSSessionOption (https://go.microsoft.com/fwlink/?LinkID=135237).

PSApplicationName <Строка>

Указывает сегмент имени приложения в коде URI подключения, используемом для подключения к конечным компьютерам. Этот параметр позволяет указать имя приложения, если в команде не используется параметр ConnectionURI.

По умолчанию используется значение привилегированной переменной $PSSessionApplicationName на локальном компьютере. Если привилегированная переменная не определена, значение по умолчанию — WSMAN. Это значение подходит для большинства случаев. Подробнее см. в разделе about_Preference_Variables (https://go.microsoft.com/fwlink/?LinkID=113248).

Служба удаленного управления Windows (WinRM) использует имя приложения для выбора прослушивателя для обслуживания запроса на подключение. Значение этого параметра должно совпадать со значением свойства URLPrefix прослушивателя на удаленном компьютере.

PSAUTHENTICATION <Способ_аутентификации>

Задает механизм, используемый для аутентификации учетных данных пользователя при подключении к конечным компьютерам. Допустимые значения: Default, Basic, Credssp, Digest, Kerberos, Negotiate и NegotiateWithImplicitCredential. Значение по умолчанию — Default.

Подробнее о значениях этого параметра см. в описании перечисления System.Management.Automation.Runspaces.AuthenticationMechanism в библиотеке MSDN.

ВНИМАНИЕ!

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

PSAUTHENTICATIONLEVEL <Уровень_аутентификации>

Задает уровень аутентификации для подключений к конечным компьютерам. Значение по умолчанию — Default.

Допустимые значения:

Unchanged:

уровень проверки подлинности совпадает с предыдущей командой.

Default:

проверка подлинности Windows.

None:

без проверки подлинности COM.

Connect:

проверка подлинности COM на уровне подключения.

Call:

проверка подлинности COM на уровне вызова.

Packet:

проверка подлинности COM на уровне пакетов.

PacketIntegrity:

проверка подлинности COM на уровне целостности пакета.

PacketPrivacy:

проверка подлинности COM на уровне конфиденциальности пакета.

PSCERTIFICATETHUMBPRINT <Строка>

Задает цифровой сертификат с открытым ключом (X509) учетной записи пользователя, который располагает разрешением для выполнения этого действия. Введите отпечаток сертификата.

Сертификаты используются при проверке подлинности на основе сертификата клиента. Они могут быть сопоставлены только с локальными учетными записями пользователей; они не работают с учетными записями домена.

Чтобы получить сертификат, используйте командлет Get-Item (https://go.microsoft.com/fwlink/?LinkID=113319) или Get-ChildItem (https://go.microsoft.com/fwlink/?LinkID=113308) на диске Windows PowerShell Cert:.

PSCOMPUTERNAME <Строка[]>

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

Введите имя NETBIOS, IP-адрес или полное доменное имя одного или нескольких компьютеров в списке с разделителями-запятыми. Чтобы указать локальный компьютер, введите имя компьютера, localhost или точку (.).

Чтобы включить локальный компьютер в значение параметра PSComputerName, запустите Windows PowerShell в режиме «Запуск от имени администратора».

Если этот параметр не указан в команде либо если его значение равно $null или содержит пустую строку, целевым объектом рабочего процесса является локальный компьютер и удаленное взаимодействие Windows PowerShell не используется для выполнения команды.

Чтобы использовать IP-адрес в значении параметра ComputerName, команда должна включать параметр PSCredential. Кроме того, компьютер должен быть настроен для транспорта HTTPS или IP-адрес удаленного компьютера должен быть включен в список TrustedHosts службы WinRM на локальном компьютере. Инструкции по добавлению имени компьютера в список TrustedHosts см. в разделе «Добавление компьютера в список доверенных узлов» описания about_Remote_Troubleshooting (https://go.microsoft.com/fwlink/?LinkID=135188).

PSCONFIGURATIONNAME <Строка>

Указывает конфигурации сеансов, которые используются для настройки сеансов на конечных компьютерах. Введите конфигурацию сеанса на конечных компьютерах (не на сервере рабочего процесса). Значение по умолчанию — Microsoft.PowerShell.Workflow.

PSCONNECTIONRETRYCOUNT <UInt>

Задает максимальное количество попыток подключения к каждому конечному компьютеру, если первая попытка завершается неудачно. Введите число от 1 до 4 294 967 295 (UInt.MaxValue). Значение по умолчанию, равное нулю (0), означает, что повторные попытки не выполняются.

PSCONNECTIONRETRYINTERVALSEC <UInt>

Задает задержку между повторными попытками подключения в секундах. Значение по умолчанию — ноль (0). Этот параметр действует только в том случае, если значение PSConnectionRetryCount не меньше 1.

PSCONNECTIONURI <System.Uri>

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

Строка имеет следующий формат:

           <Transport>://<ComputerName>:<Port>/<ApplicationName>

Значение по умолчанию — https://localhost:5985/WSMAN.

Если параметр PSConnectionURI не указан, для указания значений PSConnectionURI можно использовать параметры PSUseSSL, PSComputerName, PSPort и PSApplicationName.

Допустимые значения для сегмента транспорта URI — HTTP и HTTPS. Если указать URI подключения с сегментом Transport, но не указать порт, сеанс будет создан со стандартными портами: 80 для HTTP и 443 для HTTPS. Чтобы использовать порты по умолчанию для удаленного взаимодействия Windows PowerShell, укажите порт 5985 для протокола HTTP и 5986 для протокола HTTPS.

PSCREDENTIAL <PSCredential>

Указывает учетную запись пользователя, имеющую разрешение на выполнение рабочего процесса на конечном компьютере. По умолчанию используется текущий пользователь. Этот параметр допустим только в том случае, если в команде используется параметр PSComputerName.

Введите имя пользователя, например «User01» или «Domain01\User01», или введите переменную, которая содержит объект PSCredential, например возвращенный командлетом Get-Credential. Если ввести только имя пользователя, появится приглашение ввести пароль.

PSELAPSEDTIMEOUTSEC <UInt32>

Определяет срок сохранения рабочего процесса и всех связанных с ним ресурсов в системе. По истечении этого срока рабочий процесс удаляется, даже если он все еще обрабатывается. Введите значение от 10 до 4 294 967 295. Значение по умолчанию, равное 0 (нулю), указывает на отсутствие времени ожидания.

PSPARAMETERCOLLECTION <Hashtable[]>

Задает разные значения общих параметров рабочего процесса для разных конечных компьютеров.

Введите разделенный запятыми список хэш-таблиц (по одной хэш-таблице для каждого конечного компьютера). В каждой хэш-таблице первый ключ — это свойство PSComputerName, а его значение представляет имя конечного компьютера. В именах компьютеров можно использовать подстановочные знаки. Остальные ключи в хэш-таблице представляют имена параметров, а их значения — значения параметров.

Например:

          -PSParameterCollection @{PSComputerName="Server01";
              PSElapsedTimeoutSec=10; PSConnectionRetryCount=6}, 
              @{PSComputerName="*"; PSElapsedTimeoutSec=20}

PSPERSIST <Boolean>

Добавляет в рабочий процесс контрольные точки в дополнение к контрольным точкам, заданным в рабочем процессе.

Этот параметр не отключает контрольные точки в рабочем процессе, например, указанные с помощью общего параметра действий PSPersist, действия Checkpoint-Workflow или переменной $PSPersistPreference.

Контрольная точка (точка сохранения) — это моментальный снимок состояния рабочего процесса и данных, который создается во время выполнения рабочего процесса и сохраняется в хранилище сохраняемости на диске или в базе данных SQL. Рабочий процесс Windows PowerShell использует сохраненные данные для возобновления приостановленного или прерванного рабочего процесса с момента последней точки сохранения, а не с самого начала.

Допустимые значения:

(По умолчанию)

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

$True

Добавляет контрольные точки в начало и конец рабочего процесса, а также после каждого действия, в дополнение ко всем контрольным точкам, заданным в рабочем процессе.

$False

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

PSPORT <Int32>

Задает сетевой порт на конечных компьютерах. Порты по умолчанию: 5985 (порт службы удаленного управления Windows для HTTP) и 5986 (порт службы удаленного управления Windows для HTTPS).

Не используйте параметр PSPort без крайней необходимости. Порт, который задается в команде, применяется ко всем компьютерам или сеансам, в которых выполняется команда. Альтернативный порт может помешать выполнению команды на всех компьютерах. Прежде чем использовать альтернативный порт, необходимо настроить прослушиватель WinRM на удаленном компьютере для прослушивания по этому порту.

PSPRIVATEMETADATA <Хэш-таблица>

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

Этот параметр не обрабатывается обработчиком рабочих процессов Windows PowerShell. Вместо этого обработчик передает хэш-таблицу непосредственно в рабочий процесс.

PSRUNNINGTIMEOUTSEC <UInt32>

Задает время выполнения рабочего процесса в секундах, исключая время, в течение которого рабочий процесс приостановлен. Если выполнение рабочего процесса не завершено по истечении этого времени, обработчик рабочих процессов Windows PowerShell принудительно останавливает его.

PSSESSIONOPTION <PSSessionOption>

Задает дополнительные параметры для сеансов на конечных компьютерах. Введите объект PSSessionOption, например, созданный с помощью командлета New-PSSessionOption.

Значения по умолчанию для параметров сеанса определяются значением привилегированной переменной $PSSessionOption, если оно задано. В противном случае сеанс использует значения, указанные в конфигурации сеанса.

Описание параметров сеанса, включая значения по умолчанию, см. в разделе справки по командлету New-PSSessionOption (https://go.microsoft.com/fwlink/?LinkID=144305). Информацию о привилегированной переменной $PSSessionOption см. в разделе about_Preference_Variables (https://go.microsoft.com/fwlink/?LinkID=113248).

PSUSESSL <Параметр-переключатель>

Использует протокол SSL для установки подключения к конечному компьютеру. По умолчанию SSL не используется.

WS-Management шифрует все содержимое Windows PowerShell, передаваемое по сети. UseSSL является дополнительной защитой, которая отправляет данные по HTTPS вместо HTTP. Если вы используете этот параметр, но SSL не доступен для порта, указанного в команде, она завершается ошибкой.

КЛЮЧЕВЫЕ СЛОВА

about_Workflow_Common_Parameters

about_Workflow_CommonParameters

СМ. ТАКЖЕ

about_ActivityCommonParameters

about_Workflows

Invoke-AsWorkflow

New-PSWorkflowExecutionOption

New-PSWorkflowSession