Bagikan melalui

New-PSWorkflowExecutionOption

Modul:
PSWorkflow Module

Membuat objek yang berisi opsi konfigurasi sesi untuk sesi alur kerja.

Sintaks

Default (Default) 

New-PSWorkflowExecutionOption
    [-PersistencePath <String>]
    [-MaxPersistenceStoreSizeGB <Int64>]
    [-PersistWithEncryption]
    [-MaxRunningWorkflows <Int32>]
    [-AllowedActivity <String[]>]
    [-OutOfProcessActivity <String[]>]
    [-EnableValidation]
    [-MaxDisconnectedSessions <Int32>]
    [-MaxConnectedSessions <Int32>]
    [-MaxSessionsPerWorkflow <Int32>]
    [-MaxSessionsPerRemoteNode <Int32>]
    [-MaxActivityProcesses <Int32>]
    [-ActivityProcessIdleTimeoutSec <Int32>]
    [-RemoteNodeSessionIdleTimeoutSec <Int32>]
    [-SessionThrottleLimit <Int32>]
    [-WorkflowShutdownTimeoutMSec <Int32>]
    [<CommonParameters>]

Deskripsi

cmdlet New-PSWorkflowExecutionOption membuat objek yang berisi opsi tingkat lanjut untuk konfigurasi sesi alur kerja, yaitu konfigurasi sesi yang dirancang untuk menjalankan alur kerja Windows PowerShell Workflow.

Anda dapat menggunakan objek PSWorkflowExecutionOption yang hasilkan sebagai nilai parameter cmdlet SessionTypeOption yang membuat atau mengubah konfigurasi sesi, seperti cmdlet dan .

Setiap parameter cmdlet New-PSWorkflowExecutionOption mewakili properti objek opsi konfigurasi sesi alur kerja yang dikembalikan cmdlet. Jika Anda menghilangkan parameter, cmdlet membuat objek dengan nilai default untuk properti .

cmdlet New-PSWorkflowExecutionOption adalah bagian dari fitur Windows PowerShell Workflow.

Anda juga dapat menambahkan parameter umum alur kerja ke perintah ini. Untuk informasi selengkapnya tentang parameter umum alur kerja, lihat about_WorkflowCommonParameters.

Cmdlet ini diperkenalkan di Windows PowerShell 3.0.

Contoh

Contoh 1: Membuat Objek Opsi Alur Kerja

New-PSWorkflowExecutionOption -MaxSessionsPerWorkflow 10 -MaxDisconnectedSessions 200

SessionThrottleLimit                       : 100
PersistencePath                            : C:\Users\User01\AppData\Local\Microsoft\Windows\PowerShell\WF\PS
MaxPersistenceStoreSizeGB                  : 10
PersistWithEncryption                      : False
MaxRunningWorkflows                        : 30
AllowedActivity                            : {PSDefaultActivities}
OutOfProcessActivity                       : {InlineScript}
EnableValidation                           : True
MaxDisconnectedSessions                    : 200
MaxConnectedSessions                       : 100
MaxSessionsPerWorkflow                     : 10
MaxSessionsPerRemoteNode                   : 5
MaxActivityProcesses                       : 5
ActivityProcessIdleTimeoutSec              : 60
RemoteNodeSessionIdleTimeoutSec            : 60
WorkflowShutdownTimeoutMSec                : 500

Perintah ini menggunakan cmdlet untuk meningkatkan nilai MaxSessionsPerWorkflow menjadi 10 dan mengurangi nilai MaxDisconnectedSessions menjadi 200.

Output menunjukkan objek yang dikembalikan cmdlet.

Contoh 2: Menggunakan Objek Opsi Alur Kerja

# Create a Workflow Options object and save it in a variable
$wo = New-PSWorkflowExecutionOption -MaxSessionsPerWorkflow 10 -MaxDisconnectedSessions 200
# Create the ITWorkflow session configuration
Register-PSSessionConfiguration -Name ITWorkflows -SessionTypeOption $wo -Force

    WSManConfig: Microsoft.WSMan.Management\WSMan::localhost\Plugin

Type            Keys                                Name
----            ----                                ----
Container       {Name=ITWorkflows}                  ITWorkflows

Get-PSSessionConfiguration ITWorkflows | Format-List -Property *

Architecture                  : 64
Filename                      : %windir%\system32\pwrshplugin.dll
ResourceUri                   : http://schemas.microsoft.com/powershell/ITWorkflows
MaxConcurrentCommandsPerShell : 1000
allowedactivity               : PSDefaultActivities
UseSharedProcess              : false
ProcessIdleTimeoutSec         : 0
xmlns                         : http://schemas.microsoft.com/wbem/wsman/1/config/PluginConfiguration
MaxConcurrentUsers            : 5
maxsessionsperworkflow        : 10
lang                          : en-US
sessionconfigurationdata      : <SessionConfigurationData>
                                    <Param Name='PrivateData'>
                                        <PrivateData>
                                            <ParamName='enablevalidation' Value='True'/>
                                            <Param Name='allowedactivity'Value='PSDefaultActivities' />
                                            <Param Name='outofprocessactivity' Value='InlineScript'/>
                                            <Param Name='maxdisconnectedsessions' Value='200' />
                                            <ParamName='maxsessionsperworkflow' Value='10'/>
                                        </PrivateData>
                                    </Param>
                                </SessionConfigurationData>
SupportsOptions               : true
ExactMatch                    : true
RunAsUser                     :
IdleTimeoutms                 : 7200000
PSVersion                     : 3.0
OutputBufferingMode           : Block
AutoRestart                   : false
MaxShells                     : 25
MaxMemoryPerShellMB           : 1024
MaxIdleTimeoutMs              : 43200000
outofprocessactivity          : InlineScript
SDKVersion                    : 2
Name                          : ITWorkflows
XmlRenderingType              : text
Capability                    : {Shell}
RunAsPassword                 :
MaxProcessesPerShell          : 15
enablevalidation              : True
Enabled                       : True
maxdisconnectedsessions       : 200
MaxShellsPerUser              : 25
Permission                    :

Dua perintah pertama membuat objek konfigurasi sesi baru dan mendaftarkannya.

Perintah ketiga menggunakan cmdlet Get-PSSessionConfiguration untuk mendapatkan konfigurasi sesi ITWorkflows dan Format-List untuk menampilkan semua properti konfigurasi sesi dalam daftar. Output menunjukkan bahwa opsi alur kerja dalam konfigurasi sesi. Secara khusus, konfigurasi sesi memiliki properti MaxSessionsPerWorkflow dengan nilai 10 dan properti MaxDisconnectedSessions dengan nilai 200.

Parameter

-ActivityProcessIdleTimeoutSec

Menentukan berapa lama setiap proses host aktivitas dipertahankan setelah proses menjadi menganggur. Ketika interval kedaluwarsa, proses ditutup.

Masukkan nilai dalam detik. Nilai defaultnya adalah 60.

Properti parameter

Jenis:Int32
Nilai default:60
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-AllowedActivity

Menentukan aktivitas yang diizinkan untuk dijalankan dalam sesi.

Masukkan nama aktivitas yang memenuhi syarat namespace, seperti Microsoft.PowerShell.HyperV.Activities.*. Karakter kartubebas didukung. Nilai default, PSDefaultActivities, mencakup aktivitas Windows Workflow Foundation bawaan dan aktivitas yang mewakili cmdlet Windows PowerShell inti.

Properti parameter

Jenis:

String[]

Nilai default:PSDefaultActivities
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-EnableValidation

Memverifikasi bahwa semua aktivitas alur kerja dalam sesi disertakan dalam daftar aktivitas yang diizinkan.

Nilai defaultnya adalah True. Untuk menonaktifkan validasi, gunakan format perintah berikut: -EnableValidation:$false.

Properti parameter

Jenis:SwitchParameter
Nilai default:True
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-MaxActivityProcesses

Menentukan jumlah maksimum proses yang dapat dibuat dalam sesi untuk mendukung aktivitas alur kerja. Nilai defaultnya adalah 5.

Properti parameter

Jenis:Int32
Nilai default:5
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-MaxConnectedSessions

Menentukan jumlah maksimum sesi jarak jauh yang berada dalam status operasional. Kuota ini diterapkan ke sesi yang terhubung ke semua simpul jarak jauh (komputer target). Nilai default adalah 100.

Properti parameter

Jenis:Int32
Nilai default:100
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-MaxDisconnectedSessions

Menentukan jumlah maksimum sesi jarak jauh yang dalam keadaan terputus. Kuota ini diterapkan ke sesi yang terhubung ke semua simpul jarak jauh (komputer target). Nilai defaultnya adalah 1000.

Properti parameter

Jenis:Int32
Nilai default:1000
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-MaxPersistenceStoreSizeGB

Menentukan ukuran maksimum, dalam gigabyte, dari penyimpanan persistensi yang dialokasikan untuk alur kerja yang berjalan dalam sesi. Ketika ukuran terlampaui, penyimpanan persistensi diperluas untuk menyimpan semua data yang bertahan, tetapi peringatan ditampilkan dan pesan ditulis ke log peristiwa alur kerja. Nilai defaultnya adalah 10.

Penyimpanan persistensi berisi data untuk semua pekerjaan alur kerja. Kemampuan untuk menyimpan data memungkinkan pekerjaan dilanjutkan tanpa kehilangan status.

Properti parameter

Jenis:Int64
Nilai default:10
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-MaxRunningWorkflows

Menentukan bahwa jumlah maksimum alur kerja yang dapat berjalan dalam sesi secara bersamaan. Nilai defaultnya adalah 30.

Properti parameter

Jenis:Int32
Nilai default:30
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-MaxSessionsPerRemoteNode

Menentukan jumlah maksimum sesi yang dapat disambungkan ke setiap simpul jarak jauh (komputer target). Nilai defaultnya adalah 5.

Properti parameter

Jenis:Int32
Nilai default:5
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-MaxSessionsPerWorkflow

Menentukan jumlah maksimum sesi yang dapat dibuat untuk mendukung setiap alur kerja. Nilai defaultnya adalah 5.

Properti parameter

Jenis:Int32
Nilai default:5
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-OutOfProcessActivity

Menentukan aktivitas mana yang diizinkan (ditentukan oleh parameter Aktivitas yang Diizinkan ) berjalan di luar proses. Nilai defaultnya adalah InlineScript.

Properti parameter

Jenis:

String[]

Nilai default:InlineScript
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-PersistencePath

Menentukan lokasi pada disk tempat status alur kerja dan data disimpan. Menyimpan status alur kerja dan data memungkinkan alur kerja ditangguhkan dan dilanjutkan, dan untuk pulih dari gangguan dan kegagalan jaringan.

Nilai defaultnya adalah $Env:LOCALAPPDATA\Microsoft\Windows\PowerShell\WF\PS.

Properti parameter

Jenis:String
Nilai default:False
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-PersistWithEncryption

Menunjukkan bahwa alur kerja mengenkripsi data di penyimpanan persistensi. Pertimbangkan untuk menggunakan fitur ini saat menyimpan data persistensi dalam berbagi jaringan.

Properti parameter

Jenis:SwitchParameter
Nilai default:$Env:LOCALAPPDATA\Microsoft\Windows\PowerShell\WF\PS
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-RemoteNodeSessionIdleTimeoutSec

Menentukan berapa lama sesi yang tersambung ke simpul jarak jauh (komputer target) dipertahankan jika diam.

Masukkan nilai dalam detik. Nilai defaultnya adalah 60.

Properti parameter

Jenis:Int32
Nilai default:60
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-SessionThrottleLimit

Menentukan berapa banyak operasi yang dibuat untuk mendukung semua alur kerja yang dimulai dalam sesi. Nilai default adalah 100.

Properti parameter

Jenis:Int32
Nilai default:100
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-WorkflowShutdownTimeoutMSec

Menentukan berapa lama sesi dipertahankan setelah semua alur kerja dalam sesi ditangguhkan secara paksa. Ketika batas waktu berakhir, Windows PowerShell menutup sesi, bahkan jika semua alur kerja belum ditangguhkan.

Masukkan nilai dalam milidetik. Nilai defaultnya adalah 500.

Properti parameter

Jenis:Int32
Nilai default:500
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

None

Anda tidak dapat menyalurkan objek ke cmdlet ini.

Output

PSWorkflowExecutionOption

Catatan

Ketika nilai maksimum yang ditetapkan oleh opsi terlampaui, perintah untuk membuat instans lain dalam sesi gagal, kecuali disebutkan dalam deskripsi parameter. Misalnya, jika nilai MaxConnectedSessions adalah 100. Perintah untuk membuat sesi ke-101 ke simpul jarak jauh (komputer target) gagal.

Properti objek konfigurasi sesi bervariasi menurut opsi yang diatur untuk konfigurasi sesi dan nilai opsi tersebut. Selain itu, konfigurasi sesi yang menggunakan file konfigurasi sesi memiliki properti tambahan.

Secara khusus, properti konfigurasi sesi yang menyertakan objek PSWorkflowExecutionOptions bervariasi berdasarkan nilai opsi alur kerja. Misalnya, jika konfigurasi sesi menyertakan objek PSWorkflowExecutionOptions yang menetapkan nilai non-default untuk properti SessionThrottleLimit, konfigurasi sesi memiliki properti SessionThrottleLimit. Jika tidak, itu tidak.