CommonParameters 정보

간단한 설명

모든 cmdlet과 함께 사용할 수 있는 매개 변수에 대해 설명합니다.

자세한 설명

일반적인 매개 변수는 cmdlet과 함께 사용할 수 있는 cmdlet 매개 변수 집합입니다. cmdlet 개발자가 아닌 PowerShell에 의해 구현되며 모든 cmdlet에서 자동으로 사용할 수 있습니다.

모든 cmdlet에서 공통 매개 변수를 사용할 수 있지만 모든 cmdlet에 영향을 주지 않을 수 있습니다. 예를 들어 cmdlet이 자세한 정보 표시 출력을 생성하지 않는 경우 Verbose 공통 매개 변수를 사용하면 아무런 효과가 없습니다.

일반적인 매개 변수는 CmdletBinding 특성 또는 Parameter 특성을 사용하는 고급 함수와 모든 워크플로에서도 사용할 수 있습니다.

몇 가지 일반적인 매개 변수는 PowerShell 기본 설정 변수를 사용하여 설정한 시스템 기본값 또는 기본 설정을 재정의합니다. 기본 설정 변수와 달리 공통 매개 변수는 사용되는 명령에만 영향을 줍니다.

일반적인 매개 변수 외에도 많은 cmdlet은 WhatIf 및 Confirm 위험 완화 매개 변수를 제공합니다. 시스템 또는 사용자 데이터에 대한 위험을 수반하는 Cmdlet은 일반적으로 이러한 매개 변수를 제공합니다.

다음 목록에는 일반적인 매개 변수가 표시됩니다. 별칭은 괄호 안에 나열됩니다.

• Debug(db)
• ErrorAction (ea)
• ErrorVariable (ev)
• InformationAction (infa)
• InformationVariable (iv)
• OutVariable (ov)
• OutBuffer (ob)
• PipelineVariable (pv)
• 자세한 정보 표시(vb)
• WarningAction (wa)
• WarningVariable (wv)

위험 완화 매개 변수는 다음과 같습니다.

• WhatIf (wi)
• 확인 (cf)

자세한 내용은 about_Preference_Variables 참조하세요.

일반적인 매개 변수 설명

디버그

디버그의 별칭은 db입니다.

명령에서 수행한 작업에 대한 프로그래머 수준 세부 정보를 표시합니다. 이 매개 변수는 명령이 디버깅 메시지를 생성하는 경우에만 작동합니다. 예를 들어 이 매개 변수는 명령에 cmdlet이 포함된 경우 작동합니다 Write-Debug .

Debug 매개 변수는 현재 명령에 대한 변수 값을 재정의 $DebugPreference 하여 값을 $DebugPreferenceContinue로 설정합니다. 변수의 $DebugPreference 기본값은 SilentlyContinue이므로 디버깅 메시지는 기본적으로 표시되지 않습니다.

-Debug:$true 와 같은 효과가 있습니다 -Debug. 기본값인 SilentlyContinue가 아닌 경우 $DebugPreference 를 사용하여 -Debug:$false 디버깅 메시지 표시를 표시하지 않습니다.

ErrorAction

ErrorAction의 별칭은 ea입니다.

명령에서 종료하지 않는 오류에 cmdlet이 응답하는 방법을 결정합니다. 이 매개 변수는 명령이 종료하지 않는 오류(예: cmdlet의 Write-Error 오류)를 생성하는 경우에만 작동합니다.

ErrorAction 매개 변수는 현재 명령에 대한 변수 값을 재정의 $ErrorActionPreference 합니다. 변수의 $ErrorActionPreference 기본값은 Continue이므로 ErrorAction 매개 변수를 사용하지 않는 한 오류 메시지가 표시되고 실행이 계속됩니다.

ErrorAction 매개 변수는 명령이 성공적으로 완료되지 않도록 하는 오류(예: 데이터 누락, 유효하지 않은 매개 변수 또는 권한 부족)를 종료하는 데 영향을 주지 않습니다.

-ErrorAction:Continue 오류 메시지를 표시하고 명령을 계속 실행합니다. 기본값은 Continue입니다.

-ErrorAction:Ignore 오류 메시지를 표시하지 않고 명령을 계속 실행합니다. SilentlyContinue와 달리 Ignore는 자동 변수에 $Error 오류 메시지를 추가하지 않습니다. 무시 값은 PowerShell 3.0에 도입되었습니다.

-ErrorAction:Inquire 는 오류 메시지를 표시하고 실행을 계속하기 전에 확인을 요청하는 메시지를 표시합니다. 이 값은 거의 사용되지 않습니다.

-ErrorAction:SilentlyContinue 오류 메시지를 표시하지 않고 명령을 계속 실행합니다.

-ErrorAction:Stop 는 오류 메시지를 표시하고 명령 실행을 중지합니다.

-ErrorAction:Suspend 는 워크플로에만 사용할 수 있으므로 PowerShell Core에서 지원되지 않습니다.

참고

ErrorAction 매개 변수는 를 재정의하지만 매개 변수가 명령에서 스크립트 또는 함수를 실행하는 데 사용될 때 기본 설정 변수의 $ErrorAction 값을 대체하지는 않습니다.

ErrorVariable

ErrorVariable의 별칭은 ev입니다.

ErrorVariable 은 명령에 대한 오류 메시지를 지정된 변수 및 자동 변수에 $Error 저장합니다. 자세한 내용은 다음 명령을 입력합니다.

Get-Help about_Automatic_Variables

기본적으로 새 오류 메시지는 변수에 이미 저장된 오류 메시지를 덮어씁 수 있습니다. 변수 콘텐츠에 오류 메시지를 추가하려면 변수 이름 앞에 더하기 기호(+)를 입력합니다.

예를 들어 다음 명령은 변수를 $a 만든 다음 오류를 저장합니다.

Get-Process -Id 6 -ErrorVariable a

다음 명령은 변수에 $a 오류 메시지를 추가합니다.

Get-Process -Id 2 -ErrorVariable +a

다음 명령은 의 $a내용을 표시합니다.

$a

이 매개 변수를 사용하여 특정 명령의 오류 메시지만 포함하는 변수를 만들 수 있습니다. 자동 변수에는 $Error 세션의 모든 명령에서 발생한 오류 메시지가 포함됩니다. 또는 $error[1,2] 와 같은 $a[0] 배열 표기법을 사용하여 변수에 저장된 특정 오류를 참조할 수 있습니다.

InformationAction

InformationAction의 별칭은 ia입니다.

PowerShell 5.0에 도입되었습니다. 사용되는 명령 또는 스크립트 내에서 InformationAction 공통 매개 변수는 기본적으로 SilentlyContinue로 설정된 기본 설정 변수의 값을 재정의 $InformationPreference 합니다. InformationAction이 있는 스크립트에서 를 사용하면 Write-InformationInformationActionWrite-Information 매개 변수의 값에 따라 값이 표시됩니다. 에 대한 $InformationPreference자세한 내용은 about_Preference_Variables 참조하세요.

-InformationAction:Stop 는 명령이 발생할 때 명령 또는 스크립트를 중지합니다 Write-Information .

-InformationAction:Ignore 는 정보 메시지를 표시하지 않으며 명령을 계속 실행합니다. SilentlyContinue와 달리 무시는 정보 메시지를 완전히 잊어버립니다. 정보 스트림에 정보 메시지를 추가하지 않습니다.

-InformationAction:Inquire 는 명령에 지정한 정보 메시지를 표시한 Write-Information 다음 계속할지 여부를 묻습니다.

-InformationAction:Continue 는 정보 메시지를 표시하고 계속 실행됩니다.

-InformationAction:Suspend 는 워크플로에만 사용할 수 있으므로 PowerShell Core에서 지원되지 않습니다.

-InformationAction:SilentlyContinue 정보 메시지(기본값)가 표시되지 않고 스크립트가 중단 없이 계속되기 때문에 효과가 없습니다.

참고

InformationAction 매개 변수는 재정의하지만 매개 변수가 명령에서 스크립트 또는 함수를 실행하는 데 사용될 때 기본 설정 변수의 $InformationAction 값을 대체하지는 않습니다.

InformationVariable

InformationVariable의 별칭은 iv입니다.

PowerShell 5.0에 도입되었습니다. 사용되는 명령 또는 스크립트 내에서 InformationVariable 공통 매개 변수는 명령을 추가하여 지정한 문자열을 변수에 Write-Information 저장합니다. Write-Information 값은 InformationAction 공통 매개 변수의 값에 따라 표시됩니다. InformationAction 공통 매개 변수 Write-Information 를 추가하지 않으면 기본 설정 변수의 값에 따라 문자열이 $InformationPreference 표시됩니다. 에 대한 $InformationPreference자세한 내용은 about_Preference_Variables 참조하세요.

OutBuffer

OutBuffer의 별칭은 ob이며 System.Int32 값을 사용합니다.

파이프라인을 통해 개체를 보내기 전에 버퍼에 누적할 개체 수를 결정합니다. 이 매개 변수를 생략하면 개체가 생성될 때 전송됩니다.

이 리소스 관리 매개 변수는 고급 사용자를 위해 설계되었습니다. 이 매개 변수를 사용하는 경우 PowerShell은 의 일괄 처리로 다음 cmdlet에 데이터를 보냅니다 OutBuffer + 1.

다음 예제에서는 를 번갈아 표시하여 cmdlet을 ForEach-Object 사용하는 Write-Host 블록을 처리합니다. 디스플레이는 2 또는 OutBuffer + 1의 일괄 처리로 대체됩니다.

1..4 | ForEach-Object {
        Write-Host "$($_): First"; $_
      } -OutBuffer 1 | ForEach-Object {
                        Write-Host "$($_): Second" }

1: First
2: First
1: Second
2: Second
3: First
4: First
3: Second
4: Second

OutVariable

OutVariable의 별칭은 ov입니다.

파이프라인을 따라 출력을 보내는 것 외에도 명령의 출력 개체를 지정된 변수에 저장합니다.

변수에 출력을 추가하려면 이미 저장되어 있을 수 있는 출력을 바꾸는 대신 변수 이름 앞에 더하기 기호(+)를 입력합니다.

예를 들어 다음 명령은 변수를 $out 만들고 프로세스 개체를 해당 변수에 저장합니다.

Get-Process PowerShell -OutVariable out

다음 명령은 프로세스 개체를 변수에 $out 추가합니다.

Get-Process iexplore -OutVariable +out

다음 명령은 변수의 $out 내용을 표시합니다.

$out

참고

OutVariable 매개 변수에서 만든 변수는 입니다[System.Collections.ArrayList].

PipelineVariable

PipelineVariable의 별칭은 pv이며 문자열 값을 사용합니다.

PipelineVariable 은 파이프라인을 통해 흐르는 명명된 명령에 대해 현재 파이프라인 요소의 값을 변수로 저장합니다.

유효한 값은 모든 변수 이름과 동일한 문자열입니다.

다음은 PipelineVariable 작동 방식의 예입니다. 이 예제에서는 PipelineVariable 매개 변수가 명령에 추가 Foreach-Object 되어 명령 결과를 변수에 저장합니다. 숫자 범위(1~10)는 첫 번째 Foreach-Object 명령에 파이프되며, 그 결과는 Left라는 변수에 저장됩니다.

첫 번째 Foreach-Object 명령의 결과는 첫 번째 명령에서 반환 Foreach-Object 된 개체를 필터링하는 두 번째 Foreach-Object 명령으로 파이프됩니다. 두 번째 명령의 결과는 Right라는 변수에 저장됩니다.

세 번째 Foreach-Object 명령에서 왼쪽 및 오른쪽 변수로 표시되는 처음 두 Foreach-Object 개의 파이프된 명령의 결과는 곱하기 연산자를 사용하여 처리됩니다. 명령은 왼쪽 및 오른쪽 변수에 저장된 개체를 곱하도록 지시하고 결과를 "왼쪽 범위 멤버 * 오른쪽 범위 멤버 = product"로 표시하도록 지정합니다.

1..10 | Foreach-Object -PipelineVariable Left -Process { $_ } |
  Foreach-Object -PV Right -Process { 1..10 } |
  Foreach-Object -Process { "$Left * $Right = " + ($Left*$Right) }

1 * 1 = 1
1 * 2 = 2
1 * 3 = 3
1 * 4 = 4
1 * 5 = 5
...

자세히

Verbose의 별칭은 vb입니다.

명령에서 수행한 작업에 대한 자세한 정보를 표시합니다. 이 정보는 추적 또는 트랜잭션 로그의 정보와 유사합니다. 이 매개 변수는 명령이 자세한 메시지를 생성하는 경우에만 작동합니다. 예를 들어 이 매개 변수는 명령에 cmdlet이 포함된 경우에 작동합니다 Write-Verbose .

Verbose 매개 변수는 현재 명령에 대한 변수 값을 재정의 $VerbosePreference 합니다. 변수의 $VerbosePreference 기본값은 SilentlyContinue이므로 자세한 내용은 기본적으로 표시되지 않습니다.

-Verbose:$true 와 같은 효과가 있습니다. -Verbose

-Verbose:$false 자세한 정보 표시 메시지를 표시하지 않습니다. 값 $VerbosePreference 이 SilentlyContinue (기본값)가 아닌 경우 이 매개 변수를 사용합니다.

WarningAction

WarningAction의 별칭은 wa입니다.

cmdlet이 명령의 경고에 응답하는 방법을 결정합니다. Continue 가 기본값입니다. 이 매개 변수는 명령이 경고 메시지를 생성하는 경우에만 작동합니다. 예를 들어 이 매개 변수는 명령에 cmdlet이 포함된 경우에 작동합니다 Write-Warning .

WarningAction 매개 변수는 현재 명령에 대한 변수 값을 재정의 $WarningPreference 합니다. 변수의 $WarningPreference 기본값은 Continue이므로 WarningAction 매개 변수를 사용하지 않는 한 경고가 표시되고 실행이 계속됩니다.

-WarningAction:Continue 는 경고 메시지를 표시하고 명령을 계속 실행합니다. 기본값은 Continue입니다.

-WarningAction:Inquire 는 경고 메시지를 표시하고 실행을 계속하기 전에 확인 메시지를 표시합니다. 이 값은 거의 사용되지 않습니다.

-WarningAction:SilentlyContinue 는 경고 메시지를 표시하지 않고 명령을 계속 실행합니다.

-WarningAction:Stop 는 경고 메시지를 표시하고 명령 실행을 중지합니다.

참고

WarningAction 매개 변수는 재정의되지만 명령에서 매개 변수를 $WarningAction 사용하여 스크립트 또는 함수를 실행할 때 기본 설정 변수의 값을 대체하지는 않습니다.

WarningVariable

WarningVariable의 별칭은 wv입니다.

지정된 변수에 명령에 대한 경고를 저장합니다.

생성된 모든 경고는 사용자에게 경고가 표시되지 않더라도 변수에 저장됩니다.

변수 콘텐츠에 경고를 추가하려면 이미 저장되어 있을 수 있는 경고를 바꾸는 대신 변수 이름 앞에 더하기 기호(+)를 입력합니다.

예를 들어 다음 명령은 변수를 $a 만든 다음 경고를 저장합니다.

Get-Process -Id 6 -WarningVariable a

다음 명령은 변수에 $a 경고를 추가합니다.

Get-Process -Id 2 -WarningVariable +a

다음 명령은 의 $a내용을 표시합니다.

$a

이 매개 변수를 사용하여 특정 명령의 경고만 포함하는 변수를 만들 수 있습니다. 또는 $warning[1,2] 와 같은 $a[0] 배열 표기법을 사용하여 변수에 저장된 특정 경고를 참조할 수 있습니다.

참고

WarningVariable 매개 변수는 함수 또는 스크립트의 중첩된 호출에서 경고를 캡처하지 않습니다.

위험 관리 매개 변수 설명

WhatIf

WhatIf의 별칭은 wi입니다.

명령을 실행하는 대신 명령의 효과를 설명하는 메시지를 표시합니다.

WhatIf 매개 변수는 현재 명령에 대한 변수 값을 재정의 $WhatIfPreference 합니다. 변수의 $WhatIfPreference 기본값은 0(사용 안 함)이므로 WhatIf 매개 변수가 없으면 WhatIf 동작이 수행되지 않습니다. 자세한 내용은 다음 명령을 입력합니다.

Get-Help about_Preference_Variables

-WhatIf:$true 은 와 동일한 효과를 가 있습니다 -WhatIf.

-WhatIf:$false 는 변수 값이 1일 때 발생하는 자동 WhatIf 동작을 $WhatIfPreference 표시하지 않습니다.

예를 들어 다음 명령은 명령에서 -WhatIf 매개 변수를 사용합니다.Remove-Item

Remove-Item Date.csv -WhatIf

항목을 제거하는 대신 PowerShell은 수행할 작업과 영향을 받을 항목을 나열합니다. 이 명령에서 생성되는 출력은 다음과 같습니다.

What if: Performing operation "Remove File" on
Target "C:\ps-test\date.csv".

확인

Confirm의 별칭은 cf입니다.

명령을 실행하기 전 확인 메시지를 표시합니다.

Confirm 매개 변수는 현재 명령에 대한 변수 값을 재정의 $ConfirmPreference 합니다. 기본값은 true입니다. 자세한 내용은 다음 명령을 입력합니다.

Get-Help about_Preference_Variables

-Confirm:$true 은 와 동일한 효과를 가 있습니다 -Confirm.

-Confirm:$false 값이 cmdlet의 $ConfirmPreference 예상 위험보다 작거나 같을 때 발생하는 자동 확인을 표시하지 않습니다.

예를 들어 다음 명령은 명령과 함께 Confirm 매개 변수를 Remove-Item 사용합니다. 항목을 제거하기 전에 PowerShell은 수행할 작업과 영향을 받을 항목을 나열하고 승인을 요청합니다.

PS C:\ps-test> Remove-Item tmp*.txt -Confirm

Confirm
Are you sure you want to perform this action?
Performing operation "Remove File" on Target " C:\ps-test\tmp1.txt
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend
[?] Help (default is "Y"):

응답 확인 옵션은 다음과 같습니다.

응답	결과
예(Y)	작업을 수행합니다.
모두에 예(A)	모든 작업을 수행하고 후속 Confirm 쿼리를 표시하지 않습니다.
	이 명령의 경우
아니요(N):	작업을 수행하지 마세요.
모두 아니요(L):	작업을 수행하지 않고 후속 Confirm를 표시하지 않습니다.
	이 명령에 대한 쿼리입니다.
일시 중단(S):	명령을 일시 중지하고 임시 세션을 만듭니다.
도움말(?)	이러한 옵션에 대한 도움말을 표시합니다.

일시 중단 옵션은 명령을 보류하고 확인 옵션을 선택할 준비가 될 때까지 작업할 수 있는 임시 중첩 세션을 만듭니다. 중첩된 세션에 대한 명령 프롬프트에는 원래 부모 명령의 자식 작업임을 나타내는 두 개의 추가 캐럿(>>)이 있습니다. 중첩된 세션에서 명령 및 스크립트를 실행할 수 있습니다. 중첩된 세션을 종료하고 원래 명령에 대한 확인 옵션으로 돌아가려면 "exit"를 입력합니다.

다음 예제에서는 사용자가 명령 매개 변수에 대한 도움말을 확인하는 동안 일시 중단 옵션(S)을 사용하여 명령을 일시적으로 중지합니다. 필요한 정보를 얻은 후 사용자는 "exit"를 입력하여 중첩된 프롬프트를 종료한 다음 확인 쿼리에 대한 예(y) 응답을 선택합니다.

PS C:\ps-test> New-Item -ItemType File -Name Test.txt -Confirm

Confirm
Are you sure you want to perform this action?

Performing operation "Create File" on Target "Destination:
C:\ps-test\test.txt".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default
is "Y"): s

PS C:\ps-test> Get-Help New-Item -Parameter ItemType

-ItemType <string>
Specifies the provider-specified type of the new item.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       true (ByPropertyName)
Accept wildcard characters?  false

PS C:\ps-test> exit

Confirm
Are you sure you want to perform this action?
Performing operation "Create File" on Target "Destination: C:\ps-test\test
.txt".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (defau
lt is "Y"): y

Directory: C:\ps-test

Mode                LastWriteTime     Length Name
----                -------------     ------ ----
-a---         8/27/2010   2:41 PM          0 test.txt

키워드

about_Common_Parameters

참고 항목

about_Preference_Variables

Write-Debug

Write-Warning

Write-Error

Write-Verbose