about_WorkflowCommonParameters

Artikel
10/04/2023

DESKRIPSI SINGKAT

Topik ini menjelaskan parameter yang valid pada semua perintah alur kerja Windows PowerShell. Karena mesin Windows PowerShell menambahkannya ke alur kerja, Anda dapat menggunakan parameter ini pada alur kerja apa pun dan secara otomatis diaktifkan pada alur kerja yang Anda buat.

DESKRIPSI PANJANG

Parameter umum Windows PowerShell Workflow adalah sekumpulan parameter cmdlet yang dapat Anda gunakan dengan semua alur kerja dan aktivitas Windows PowerShell. Mereka ditambahkan oleh mesin Windows PowerShell Workflow, bukan oleh penulis alur kerja, dan secara otomatis tersedia pada alur kerja dan aktivitas. Namun, alur kerja yang ditumpuk dalam tiga tingkat tidak mendukung parameter umum apa pun, termasuk parameter umum alur kerja.

Semua parameter alur kerja bersifat opsional dan bernama (bukan posisi). Mereka tidak mengambil input dari alur.

Sebagian besar parameter umum alur kerja memiliki PS awalan, seperti PSComputerName dan PSCredential. Parameter awalan PS mengonfigurasi koneksi dan lingkungan eksekusi untuk komputer target, juga dikenal sebagai "simpul jarak jauh."

Banyak parameter umum alur kerja, seperti PSAllowRedirection dan AsJob, memiliki nama yang mirip dengan parameter yang digunakan dalam pekerjaan jarak jauh dan latar belakang Windows PowerShell. Parameter ini bekerja dengan cara yang sama seperti parameter jarak jauh dan pekerjaan bernama serupa, sehingga Anda dapat menggunakan pengetahuan yang Anda kembangkan dalam jarak jauh dan pekerjaan untuk mengelola alur kerja.

Alur kerja diperkenalkan di Windows PowerShell 3.0.

DESKRIPSI PARAMETER

Bagian ini menjelaskan parameter umum alur kerja.

-AsJob <SwitchParameter>

Menjalankan alur kerja sebagai pekerjaan alur kerja. Perintah alur kerja segera mengembalikan objek yang mewakili pekerjaan induk. Pekerjaan induk berisi pekerjaan anak yang berjalan pada setiap komputer target. Untuk mengelola pekerjaan, gunakan cmdlet Pekerjaan. Untuk mendapatkan hasil pekerjaan, gunakan Receive-Job.

String -JobName <>

Menentukan nama yang mudah diingat untuk pekerjaan alur kerja. Secara default, pekerjaan diberi nama Job<n>, di mana <n> adalah angka ordinal.

Jika Anda menggunakan parameter JobName dalam perintah alur kerja, alur kerja dijalankan sebagai pekerjaan dan perintah alur kerja mengembalikan objek pekerjaan, bahkan jika Anda tidak menyertakan parameter AsJob dalam perintah.

Untuk informasi selengkapnya tentang pekerjaan latar belakang Windows PowerShell, lihat about_Jobs.

-PSAllowRedirection <SwitchParameter>

Memungkinkan pengalihan koneksi ke komputer target.

Saat Anda menggunakan parameter PS Koneksi ionURI, tujuan jarak jauh dapat mengembalikan instruksi untuk mengalihkan ke URI yang berbeda. Secara default, Windows PowerShell tidak mengalihkan koneksi, tetapi Anda dapat menggunakan parameter PSAllowRedirection untuk memungkinkan pengalihan koneksi ke komputer target.

Anda juga dapat membatasi berapa kali koneksi dialihkan dengan mengatur properti Maximum Koneksi ionRedirectionCount dari $PSSessionOption variabel preferensi, atau properti Maximum Koneksi ionRedirectionCount dari nilai parameter PSSessionOption. Nilai defaultnya adalah 5. Untuk informasi selengkapnya, lihat deskripsi parameter PSSessionOption dan New-PSSessionOption.

String -PSApplicationName <>

Menentukan segmen nama aplikasi dari URI koneksi yang digunakan untuk menyambungkan ke komputer target. Gunakan parameter ini untuk menentukan nama aplikasi saat Anda tidak menggunakan parameter Koneksi ionURI dalam perintah .

Nilai default adalah nilai $PSSessionApplicationName variabel preferensi di komputer lokal. Jika variabel preferensi ini tidak ditentukan, nilai defaultnya adalah WSMAN. Nilai ini sesuai untuk sebagian besar penggunaan. Untuk informasi selengkapnya, lihat about_Preference_Variables.

Layanan WinRM menggunakan nama aplikasi untuk memilih pendengar untuk melayani permintaan koneksi. Nilai parameter ini harus cocok dengan nilai properti URLPrefix pendengar di komputer jarak jauh.

-PSAuthentication <AuthenticationMechanism>

Menentukan mekanisme yang digunakan untuk mengautentikasi kredensial pengguna saat menyambungkan ke komputer target.

Nilai yang valid adalah:

Default
Basic
Credssp
Digest
Kerberos
Negotiate
NegotiateWithImplicitCredential

Nilai defaultnya adalah Default.

Untuk informasi tentang nilai parameter ini, lihat deskripsi enumerasi System.Management.Automation.Runspaces.AuthenticationMechanism di PowerShell SDK.

Peringatan

Autentikasi Penyedia Layanan Keamanan Kredensial (CredSSP), di mana kredensial pengguna diteruskan ke komputer jarak jauh untuk diautentikasi, dirancang untuk perintah yang memerlukan autentikasi pada lebih dari satu sumber daya, seperti mengakses berbagi jaringan jarak jauh. Mekanisme ini meningkatkan risiko keamanan operasi jarak jauh. Jika komputer jarak jauh disusupi, kredensial yang diteruskan ke komputer jarak jauh dapat digunakan untuk mengontrol sesi jaringan.

-PSAuthenticationLevel <AuthenticationLevel>

Menentukan tingkat autentikasi untuk sambungan ke komputer target. Nilai defaultnya adalah Default.

Nilai yang valid adalah:

Nama	Deskripsi
`Unchanged`	Tingkat autentikasi sama dengan perintah sebelumnya.
`Default`	Autentikasi Windows.
`None`	Tidak ada autentikasi COM.
`Connect`	autentikasi COM tingkat Koneksi.
`Call`	Autentikasi COM tingkat panggilan.
`Packet`	Autentikasi COM tingkat paket.
`PacketIntegrity`	Autentikasi COM tingkat Integritas Paket.
`PacketPrivacy`	Autentikasi COM tingkat privasi paket.

-PSCertificateThumbprint <String>

Menentukan sertifikat kunci publik digital (X509) dari akun pengguna yang memiliki izin untuk melakukan tindakan ini. Masukkan thumbprint sertifikat sertifikat.

Sertifikat digunakan dalam autentikasi berbasis sertifikat klien. Mereka hanya dapat dipetakan ke akun pengguna lokal; mereka tidak bekerja dengan akun domain.

Untuk mendapatkan sertifikat, gunakan cmdlet Get-Item atau Get-ChildItem di drive Windows PowerShell Cert: .

String -PSComputerName <[]>

Menentukan daftar komputer yang merupakan simpul target alur kerja. Perintah atau aktivitas dalam alur kerja dijalankan pada komputer yang ditentukan dengan menggunakan parameter ini. Defaultnya adalah komputer lokal.

Ketik nama NETBIOS, alamat IP, atau nama domain yang sepenuhnya memenuhi syarat dari satu atau beberapa komputer dalam daftar yang dipisahkan koma. Untuk menentukan komputer lokal, ketik nama komputer, localhost, atau titik (.).

Untuk menyertakan komputer lokal dalam nilai parameter PSComputerName , buka Windows PowerShell dengan opsi Jalankan sebagai administrator .

Jika parameter ini dihilangkan dari perintah, atau nilainya adalah $null atau string kosong, target alur kerja adalah komputer lokal dan jarak jauh Windows PowerShell tidak digunakan untuk menjalankan perintah.

Untuk menggunakan alamat IP dalam nilai parameter ComputerName , perintah harus menyertakan parameter PSCredential . Selain itu, komputer harus dikonfigurasi untuk transportasi HTTPS atau alamat IP komputer jarak jauh harus disertakan dalam daftar WinRM TrustedHosts di komputer lokal. Untuk instruksi menambahkan nama komputer ke daftar TrustedHosts, lihat "Cara Menambahkan Komputer ke Daftar Host Tepercaya" di about_Remote_Troubleshooting.

String -PSConfigurationName <>

Menentukan konfigurasi sesi yang digunakan untuk mengonfigurasi sesi pada komputer target. Masukkan konfigurasi sesi pada komputer target (bukan komputer server alur kerja). Defaultnya adalah Microsoft.PowerShell.Workflow.

-PS Koneksi ionRetryCount <UInt>

Menentukan jumlah maksimum upaya untuk menyambungkan ke setiap komputer target jika upaya koneksi pertama gagal. Masukkan angka antara 1 dan 4.294.967.295 (UInt.MaxValue). Nilai default, nol (0), tidak mewakili upaya coba lagi.

-PS Koneksi ionRetryIntervalSec <UInt>

Menentukan penundaan antara upaya coba lagi koneksi dalam hitungan detik. Nilai defaultnya adalah nol (0). Parameter ini hanya valid ketika nilai PS Koneksi ionRetryCount setidaknya 1.

-PS Koneksi ionURI <System.Uri>

Menentukan Pengidentifikasi Sumber Daya Seragam (URI) yang menentukan titik akhir koneksi untuk alur kerja pada komputer target. URI harus sepenuhnya memenuhi syarat.

Format string ini adalah sebagai berikut:

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

Nilai defaultnya adalah http://localhost:5985/WSMAN.

Jika Anda tidak menentukan PS Koneksi ionURI, Anda dapat menggunakan parameter PSUseSSL, PSComputerName, PSPort, dan PSApplicationName untuk menentukan nilai PS Koneksi ionURI.

Nilai yang valid untuk segmen Transportasi URI adalah HTTP dan HTTPS. Jika Anda menentukan URI koneksi dengan segmen Transportasi, tetapi jangan tentukan port, sesi dibuat dengan port standar: 80 untuk HTTP dan 443 untuk HTTPS. Untuk menggunakan port default untuk jarak jauh Windows PowerShell, tentukan port 5985 untuk HTTP atau 5986 untuk HTTPS.

-PSCredential <PSCredential>

Menentukan akun pengguna yang memiliki izin untuk menjalankan alur kerja pada komputer target. Defaultnya adalah pengguna saat ini. Parameter ini hanya valid ketika parameter PSComputerName disertakan dalam perintah .

Ketik nama pengguna, seperti User01 atau Domain01\User01, atau masukkan variabel yang berisi objek PSCredential , seperti Get-Credential yang dikembalikan cmdlet. Jika Anda hanya memasukkan nama pengguna, Anda akan dimintai kata sandi.

-PSElapsedTimeoutSec <UInt32>

Menentukan berapa lama alur kerja dan semua sumber daya terkait dipertahankan dalam sistem. Ketika waktu habis kedaluwarsa, alur kerja dihapus, meskipun masih diproses. Masukkan nilai antara 10 dan 4.294.967.295. Nilai default, 0 (nol), berarti bahwa tidak ada batas waktu yang berlalu.

-PSParameterCollection <Hashtable[]>

Menentukan nilai parameter umum alur kerja yang berbeda untuk komputer target yang berbeda.

Masukkan daftar tabel hash yang dipisahkan koma dengan satu tabel hash untuk setiap komputer target. Dalam setiap tabel hash, kunci pertama adalah PSComputerName dan nilainya adalah nama komputer target. Karakter kartubebas diizinkan dalam nama komputer. Untuk kunci yang tersisa dalam tabel hash, kuncinya adalah nama parameter dan nilainya adalah nilai parameter.

Contohnya:

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

Dalam contoh di atas, semua koneksi akan memiliki PSElapsedTimeoutSec default dari 20 detik, kecuali untuk Server01 yang mengambil alih nilai default dengan menentukan batas waktunya sendiri dari 10 detik.

-PSPersist <Boolean>

Menambahkan titik pemeriksaan ke alur kerja, selain titik pemeriksaan apa pun yang ditentukan dalam alur kerja.

Parameter ini tidak dapat menekan titik pemeriksaan dalam alur kerja, seperti yang ditentukan dengan menggunakan parameter umum aktivitas PSPersist , Checkpoint-Workflow aktivitas, atau $PSPersistPreference variabel.

"Titik pemeriksaan" atau "titik persistensi" adalah rekam jepret status alur kerja dan data yang diambil saat alur kerja berjalan dan disimpan ke penyimpanan persistensi pada disk atau dalam database SQL. Windows PowerShell Workflow menggunakan data yang disimpan untuk melanjutkan alur kerja yang ditangguhkan atau terganggu dari titik persistensi terakhir, daripada memulai ulang alur kerja.

Nilai yang valid:

(Default) Jika Anda menghilangkan parameter ini, titik pemeriksaan ditambahkan ke awal dan akhir alur kerja, selain titik pemeriksaan apa pun yang ditentukan dalam alur kerja.
$True. Menambahkan titik pemeriksaan ke awal dan akhir alur kerja dan titik pemeriksaan setelah setiap aktivitas, selain titik pemeriksaan apa pun yang ditentukan dalam alur kerja.
$False. Tidak ada titik pemeriksaan yang ditambahkan. Titik pemeriksaan hanya diambil ketika ditentukan dalam alur kerja.

-PSPort <Int32>

Menentukan port jaringan pada komputer target. Port default adalah 5985 (port WinRM untuk HTTP) dan 5986 (port WinRM untuk HTTPS).

Jangan gunakan parameter PSPort kecuali Anda harus. Port yang diatur dalam perintah berlaku untuk semua komputer atau sesi tempat perintah dijalankan. Pengaturan port alternatif mungkin mencegah perintah berjalan pada semua komputer. Sebelum menggunakan port alternatif, Anda harus mengonfigurasi pendengar WinRM di komputer jarak jauh untuk mendengarkan di port tersebut.

-PSPrivateMetadata <Hashtable>

Menyediakan informasi yang disesuaikan untuk pekerjaan alur kerja. Masukkan tabel hash. Kunci dan nilai disesuaikan untuk setiap alur kerja. Untuk informasi tentang metadata privat alur kerja, lihat topik bantuan untuk alur kerja.

Parameter ini tidak diproses oleh mesin Windows PowerShell Workflow. Sebagai gantinya, mesin meneruskan tabel hash langsung ke alur kerja.

-PSRunningTimeoutSec <UInt32>

Menentukan waktu berjalan alur kerja dalam hitungan detik, tidak termasuk kapan saja alur kerja ditangguhkan. Jika eksekusi alur kerja tidak selesai ketika waktu kedaluwarsa, mesin Windows PowerShell Workflow secara paksa menghentikan eksekusi alur kerja.

-PSSessionOption <PSSessionOption>

Mengatur opsi tingkat lanjut untuk sesi ke komputer target. Masukkan objek PSSessionOption, seperti objek yang Anda buat dengan menggunakan New-PSSessionOption cmdlet.

Nilai default untuk opsi sesi ditentukan oleh nilai $PSSessionOption variabel preferensi, jika diatur. Jika tidak, sesi menggunakan nilai yang ditentukan dalam konfigurasi sesi.

Untuk deskripsi opsi sesi, termasuk nilai default, lihat New-PSSessionOption. Untuk informasi tentang $PSSessionOption variabel preferensi, lihat about_Preference_Variables.

-PSUseSSL <SwitchParameter>

Menggunakan protokol Secure Sockets Layer (SSL) untuk membuat koneksi ke komputer target. Secara default, SSL tidak digunakan.

WS-Management mengenkripsi semua konten Windows PowerShell yang dikirimkan melalui jaringan. UseSSL adalah perlindungan tambahan yang mengirim data di seluruh HTTPS, bukan HTTP. Jika Anda menggunakan parameter ini, tetapi SSL tidak tersedia pada port yang digunakan untuk perintah , perintah gagal.