about_WorkflowCommonParameters

適用於: Windows PowerShell 3.0

主題

about_Workflow_Common_Parameters

簡短描述

本主題描述所有 Windows PowerShell® 工作流程命令中的有效參數。由於 Windows PowerShell 引擎會將這些參數新增至工作流程，因此您可以在任何工作流程中使用這些參數，而且這些參數會在您撰寫的工作流程中自動啟用。

詳細描述

Windows PowerShell 工作流程一般參數是您可以搭配所有 Windows PowerShell 工作流程和活動使用的一組 Cmdlet 參數。這些參數是透過 Windows PowerShell 工作流程引擎 (而非工作流程作者) 來新增，而且會在每個工作流程和活動中自動啟用。不過，三層深的巢狀工作流程不支援任何一般參數，包括工作流程一般參數。

所有工作流程參數都是選擇性且具名 (而非位置性) 的。不接受來自管線的輸入。

大部分工作流程一般參數都有 PS 首碼，例如 PSComputerName 和 PSCredential。具有 PS 首碼的參數可設定目標電腦 (又稱為「遠端節點」) 的連線和執行環境。

許多工作流程一般參數 (例如 PSAllowRedirection 和 AsJob) 都有類似 Windows PowerShell 遠端和背景工作所使用的參數。這些參數的運作方式與名稱類似的遠端和工作參數相同，因此您可以運用在遠端和工作中發展的知識，來管理工作流程。

工作流程是在 Windows PowerShell 3.0 中引進的。

參數描述

本節描述工作流程一般參數。

AsJob <切換參數>

以工作流程工作方式來執行工作流程。工作流程命令會立即傳回代表父工作的物件。父工作包含每部目標電腦上所執行的子工作。若要管理工作，請使用各項 Job Cmdlet。若要取得工作結果，請使用 Receive-Job Cmdlet (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 參數允許重新導向目標電腦的連線。

您也可以設定 $PSSessionOption 喜好設定變數的 MaximumConnectionRedirectionCount 屬性或 PSSessionOption 參數值的 MaximumConnectionRedirectionCount 屬性，來限制重新導向連線的次數。預設值為 5。如需詳細資訊，請參閱 PSSessionOption 參數和 New-PSSessionOption Cmdlet 的說明 (https://go.microsoft.com/fwlink/?LinkID=135237)。

PSApplicationName <字串>

指定用以連線到目標電腦之連線 URI 的應用程式名稱區段。當您沒有在命令中使用 ConnectionURI 參數時，請使用這個參數來指定應用程式名稱。

預設值是本機電腦上 $PSSessionApplicationName 喜好設定變數的值。若未定義此喜好設定變數，則預設值是 WSMAN。這個值適用於大部分用途。如需詳細資訊，請參閱 about_Preference_Variables (https://go.microsoft.com/fwlink/?LinkID=113248)。

WinRM 服務會使用應用程式名稱來選取要用來為連線要求提供服務的接聽程式。此參數的值應該符合遠端電腦上接聽程式之 URLPrefix 屬性的值。

PSAUTHENTICATION <驗證機制>

指定連線到目標電腦時，用來驗證使用者認證的機制。有效值為 Default、Basic、Credssp、Digest、Kerberos、Negotiate 與 NegotiateWithImplicitCredential。預設值為 Default。

如需此參數值的資訊，請參閱 MSDN 中 System.Management.Automation.Runspaces.AuthenticationMechanism 列舉的說明。

注意：

使用者認證會傳遞至要驗證之遠端電腦的「認證安全性服務提供者 (CredSSP)」驗證，是設計用於需要在一個以上資源進行驗證的命令，例如存取遠端網路共用。此機制會使得遠端作業的安全性風險變高。若遠端電腦遭到入侵，傳遞給它的認證便可用來控制網路工作階段。

PSAUTHENTICATIONLEVEL <驗證等級>

指定目標電腦連線的驗證等級。預設值為 Default。

有效值為：

Unchanged：

驗證等級與前一個命令相同。

Default：

Windows 驗證。

None：

沒有 COM 驗證。

Connect：

連線等級 COM 驗證。

Call：

呼叫等級 COM 驗證。

Packet：

封包等級 COM 驗證。

PacketIntegrity：

封包完整性等級 COM 驗證。

PacketPrivacy：

封包私密性等級 COM 驗證。

PSCERTIFICATETHUMBPRINT <字串>

對於具有執行此動作之權限的使用者帳戶，指定其數位公開金鑰憑證 (X509)。請輸入憑證的憑證指紋。

憑證將用於用戶端憑證式驗證。這些憑證只能對應至本機使用者帳戶，無法用於網域帳戶。

若要取得憑證，請使用 Windows PowerShell Cert: 磁碟機中的 Get-Item (https://go.microsoft.com/fwlink/?LinkID=113319) 或 Get-ChildItem (https://go.microsoft.com/fwlink/?LinkID=113308) Cmdlet。

PSCOMPUTERNAME <String[]>

指定做為工作流程目標節點的電腦清單。工作流程中的命令或活動會在使用這個參數指定的電腦上執行。預設是本機電腦。

請輸入 NETBIOS 名稱、IP 位址或是一部或多部電腦的完整網域名稱 (以逗號分隔的清單方式)。若要指定本機電腦，請輸入電腦名稱、"localhost" 或句點 (.)。

若要在 PSComputerName 參數值中包含本機電腦，請使用 [以系統管理員身分執行] 選項開啟 Windows PowerShell。

如果命令中省略此參數，或其值為 $null 或空字串，則工作流程目標為本機電腦，且不會使用 Windows PowerShell 遠端功能來執行命令。

若要在 ComputerName 參數的值中使用 IP 位址，則命令必須包含 PSCredential 參數。此外，必須將電腦設定為使用 HTTPS 傳輸，或必須在本機電腦的 WinRM TrustedHosts 清單中包含遠端電腦的 IP 位址。如需將電腦名稱新增到 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 必須是完整的 URI。

這個字串的格式如下所示：

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

預設值為 https://localhost:5985/WSMAN。

如果未指定 PSConnectionURI，您可以使用 PSUseSSL、PSComputerName、PSPort 和 PSApplicationName 參數來指定 PSConnectionURI 值。

URI 的 Transport 區段有效值為 HTTP 與 HTTPS。若指定含傳輸區段的連線 URI，但未指定連接埠，將會以標準連接埠建立工作階段：HTTP 使用 80，HTTPS 使用 443。若要使用預設連接埠來執行 Windows PowerShell 遠端功能，請為 HTTP 指定連接埠 5985，或是為 HTTPS 指定連接埠 5986。

PSCREDENTIAL <PS 認證>

指定具有在目標電腦上執行工作流程之權限的使用者帳戶。預設為目前使用者。只有當命令中包含 PSComputerName 參數時，此參數才有效。

輸入使用者名稱 (例如 "User01" 或 "Domain01\User01")，或輸入包含 PSCredential 物件的變數 (例如 Get-Credential Cmdlet 傳回的物件)。若您只輸入使用者名稱，將會提示您輸入密碼。

PSELAPSEDTIMEOUTSEC <UInt32>

判斷在系統中維護工作流程和所有相關資源的時間。如果發生逾時，則會刪除工作流程，即使工作流程仍在處理中亦然。輸入介於 10 和 4,294,967,295 之間的值。預設值為 0 (零)，表示未發生逾時。

PSPARAMETERCOLLECTION <Hashtable[]>

為不同的目標電腦指定不同的工作流程一般參數值。

輸入雜湊表的逗號分隔清單，其中每個雜湊表各代表一部目標電腦。在每個雜湊表中，第一個索引鍵是 PSComputerName，其值是目標電腦的名稱。電腦名稱允許使用萬用字元。至於雜湊表中的其餘索引鍵，索引鍵是參數名稱，其值是參數值。

例如：

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

PSPERSIST <布林值>

除了在工作流程中指定的任何檢查點之外，新增檢查點到工作流程。

這個參數無法隱藏工作流程中的檢查點，例如使用 PSPersist 活動一般參數、Checkpoint-Workflow 活動或 $PSPersistPreference 變數所指定的檢查點。

「檢查點」或「持續點」是工作流程狀態快照及工作流程執行時所擷取的資料，會儲存至磁碟上或 SQL 資料庫中的持續性儲存區。Windows PowerShell 工作流程會使用所儲存的資料，從上次的持續點繼續已暫止或中斷的工作流程，而不是重新啟動工作流程。

有效值：

(預設)

如果您省略這個參數，除了在工作流程中指定的任何檢查點之外，還會新增一個檢查點到工作流程的開頭和結尾。

$True

除了在工作流程中指定的任何檢查點之外，新增一個檢查點到工作流程的開頭和結尾，並在每個活動之後新增一個檢查點。

$False

不會新增任何檢查點。僅接受在工作流程中指定的檢查點。

PSPORT <Int32>

指定目標電腦上的網路連接埠。預設連接埠是 5985 (用於 HTTP 的 WinRM 連接埠) 和 5986 (用於 HTTPS 的 WinRM 連接埠)。

除非必要，否則請勿使用 PSPort 參數。命令中設定的連接埠會套用到命令執行所在的所有電腦或工作階段。替代的連接埠設定可能使得命令無法在全部電腦上執行。使用替代連接埠之前，必須先將遠端電腦上的 WinRM 接聽程式設定為在該連接埠進行接聽。

PSPRIVATEMETADATA <雜湊表>

提供自訂資訊給工作流程工作。輸入雜湊表。系統會為每個工作流程自訂索引鍵和值。如需工作流程之私用中繼資料的相關資訊，請參閱工作流程的說明主題。

Windows PowerShell 工作流程引擎不會處理這個參數。相反地，該引擎會將雜湊表直接傳遞至工作流程。

PSRUNNINGTIMEOUTSEC <UInt32>

指定工作流程的執行時間 (秒)，但不包括工作流程暫停的任何時間。如果時間已到，而工作流程執行未完成，Windows PowerShell 工作流程引擎會強制停止執行工作流程。

PSSESSIONOPTION <PSSession 選項>

為連線到目標電腦的工作階段設定進階選項。輸入 PSSessionOption 物件，例如使用 New-PSSessionOption Cmdlet 所建立的物件。

工作階段選項的預設值取決於 $PSSessionOption 喜好設定變數的值 (如果有設定)。否則，工作階段會使用工作階段組態中指定的值。

如需工作階段選項 (包括預設值) 的說明，請參閱 New-PSSessionOption Cmdlet 的說明主題 (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