about_WorkflowCommonParameters

  • Статья

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

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

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

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

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

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

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

Рабочие процессы представлены в Windows PowerShell 3.0.

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

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

-AsJob <SwitchParameter>

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

-JobName <String>

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

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

Дополнительные сведения о фоновых заданиях Windows PowerShell см. в about_Jobs.

-PSAllowRedirection <SwitchParameter>

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

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

Кроме того, можно ограничить время перенаправления подключения, задав свойство Maximum Подключение ionRedirectionCount переменной $PSSessionOption предпочтения или свойство Maximum Подключение ionRedirectionCount значения параметра PSSessionOption. Значение по умолчанию — 5. Дополнительные сведения см. в описании параметра PSSessionOption и New-PSSessionOption.

-PSApplicationName <String>

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

Значение по умолчанию — это значение переменной $PSSessionApplicationName предпочтения на локальном компьютере. Если эта переменная предпочтения не определена, значение по умолчанию равно WSMAN. Это значение подходит для большинства случаев Дополнительные сведения см. в about_Preference_Variables.

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

-PSAuthentication <AuthenticationMechanism>

Указывает механизм, используемый для проверки подлинности учетных данных пользователя при подключении к целевым компьютерам.

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

  • Default
  • Basic
  • Credssp
  • Digest
  • Kerberos
  • Negotiate
  • NegotiateWithImplicitCredential

Значение по умолчанию — Default.

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

Предупреждение

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

-PSAuthenticationLevel <AuthenticationLevel>

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

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

Имя Описание
Unchanged Уровень проверки подлинности совпадает с предыдущей командой.
Default Проверка подлинности Windows.
None Нет проверки подлинности COM.
Connect Подключение аутентификация COM на уровне.
Call Проверка подлинности COM на уровне вызова.
Packet Проверка подлинности COM на уровне пакетов.
PacketIntegrity Проверка подлинности COM уровня целостности пакетов.
PacketPrivacy Проверка подлинности COM уровня конфиденциальности пакетов.

-PSCertificateThumbprint <String>

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

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

Чтобы получить сертификат, используйте командлеты Get-Item или Get-ChildItem на диске Windows PowerShell Cert: .

-PSComputerName <String[]>

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

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

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

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

Чтобы использовать IP-адрес в значении параметра ComputerName , команда должна включать параметр PSCredential . Кроме того, компьютер должен быть настроен для транспорта HTTPS или IP-адрес удаленного компьютера должен быть включен в список TrustedHosts службы WinRM на локальном компьютере. Инструкции по добавлению имени компьютера в список TrustedHosts см. в разделе "Добавление компьютера в список доверенных узлов" в about_Remote_Troubleshooting.

-PSConfigurationName <String>

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

-PS Подключение ionRetryCount <UInt>

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

-PS Подключение ionRetryIntervalSec <UInt>

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

-PS Подключение ionURI System.Uri <>

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

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

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

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

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

Допустимые значения для сегмента транспорта URI: HTTP и HTTPS. Если указать универсальный код ресурса (URI) подключения с сегментом транспорта, но не указать порт, сеанс создается с помощью портов стандартов: 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 , а его значение — имя целевого компьютера. В имени компьютера разрешены символы Wild карта. Для оставшихся ключей в хэш-таблице ключ — это имя параметра, а значение — значение параметра.

Например:

-PSParameterCollection @{PSComputerName="*"; PSElapsedTimeoutSec=20},
@{PSComputerName="Server02"},
@{PSComputerName="Server03"},
@{PSComputerName="Server01"; PSElapsedTimeoutSec=10}

В приведенном выше примере все подключения будут иметь значение по умолчанию PSElapsedTimeoutSec секунд, за исключением Server01, который переопределяет значение по умолчанию, указав собственное время ожидания 10 секунд.20

-PSPersist <Boolean>

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

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

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

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

  • (по умолчанию) Если этот параметр опущен, точка проверка добавляется в начало и конец рабочего процесса, помимо всех проверка точек, указанных в рабочем процессе.

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

  • $False. Никакие проверка точки не добавляются. Контрольные точки принимаются только при указании в рабочем процессе.

-PSPort <Int32>

Указывает сетевой порт на целевых компьютерах. По умолчанию используются 5985 порты (порт WinRM для HTTP) и 5986 (порт WinRM для HTTPS).

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

-PSPrivateMetadata <Hashtable>

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

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

-PSRunningTimeoutSec <UInt32>

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

-PSSessionOption <PSSessionOption>

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

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

Описание параметров сеанса, включая значения по умолчанию, см. в разделе New-PSSessionOption. Сведения о переменной $PSSessionOption предпочтения см. в about_Preference_Variables.

-PSUseSSL <SwitchParameter>

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

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

См. также