about_CommonParameters
업데이트 날짜: 2014년 5월
적용 대상: Windows PowerShell 2.0, Windows PowerShell 3.0, Windows PowerShell 4.0
여기에 소개를 삽입합니다.
항목
about_CommonParameters
간단한 설명
모든 cmdlet에 사용할 수 있는 매개 변수에 대해 설명합니다.
자세한 설명
일반 매개 변수는 모든 cmdlet에서 사용할 수 있는 cmdlet 매개 변수 집합입니다. 이러한 매개 변수는 cmdlet 개발자가 아닌 Windows PowerShell®에 의해 구현되며 모든 cmdlet에서 자동으로 사용할 수 있습니다.
모든 cmdlet에서 일반 매개 변수를 사용할 수 있지만 일부 cmdlet에는 영향을 주지 않을 수 있습니다. 예를 들어 cmdlet에서 자세한 정보 출력을 생성하지 않는 경우 Verbose 일반 매개 변수를 사용해도 효과가 없습니다.
또한 일반 매개 변수는 CmdletBinding 특성이나 Parameter 특성을 사용하는 고급 함수 및 모든 워크플로에서 사용할 수 있습니다.
일부 일반 매개 변수는 Windows PowerShell 기본 설정 변수를 사용하여 설정한 시스템 기본값이나 기본 설정을 재정의합니다. 기본 설정 변수와 달리 일반 매개 변수는 해당 매개 변수가 사용되는 명령에만 영향을 줍니다.
일반 매개 변수 외에도 많은 cmdlet에서 WhatIf 및 Confirm 위험 완화 매개 변수를 제공합니다. 시스템 또는 사용자의 위험을 수반하는 cmdlet은 일반적으로 이러한 매개 변수를 제공합니다.
다음 목록에서는 일반 매개 변수를 보여 줍니다. 별칭은 괄호 안에 나열됩니다.
-Debug (db)
-ErrorAction (ea)
-ErrorVariable (ev)
-OutVariable (ov)
-OutBuffer (ob)
-PipelineVariable (pv)
-Verbose (vb)
-WarningAction (wa)
-WarningVariable (wv
위험 완화 매개 변수는 다음과 같습니다.
-WhatIf (wi)
-Confirm (cf)
기본 설정 변수에 대한 자세한 내용을 보려면 다음을 입력합니다.
help about_Preference_Variables
일반 매개 변수 설명
-DEBUG[:{$TRUE | $FALSE}]
별칭: db
명령에 의해 수행되는 작업에 대한 프로그래머 수준의 자세한 정보를 표시합니다. 이 매개 변수는 명령에서 디버깅 메시지를 생성하는 경우에만 작동합니다. 예를 들어 이 매개 변수는 명령에 Write-Debug cmdlet이 포함된 경우 작동합니다.
Debug 매개 변수는 현재 명령에 대한 $DebugPreference 변수의 값을 재정의하여 $DebugPreference 값을 Inquire로 설정합니다. $DebugPreference 변수의 기본값은 SilentlyContinue이므로 기본적으로 디버깅 메시지가 표시되지 않습니다.
유효한 값:
$true (-Debug:$true). Has the same effect as -Debug.
$false (-Debug:$false). Suppresses the display of debugging
messages when the value of the $DebugPreference is not
SilentlyContinue (the default).
-ERRORACTION[:{CONTINUE | IGNORE | INQUIRE | SILENTLYCONTINUE | STOP |SUSPEND }]
별칭: ea
cmdlet이 명령에서 종료되지 않은 오류에 응답하는 방법을 결정합니다. 이 매개 변수는 명령이 Write-Error cmdlet의 오류와 같이 종료되지 않는 오류를 생성하는 경우에만 작동합니다.
ErrorAction 매개 변수는 현재 명령에 대한 $ErrorActionPreference 변수의 값을 재정의합니다. $ErrorActionPreference 변수의 기본값은 Continue이므로 오류 메시지가 표시되며 ErrorAction 매개 변수를 사용하지 않는 한 계속 실행됩니다.
ErrorAction 매개 변수는 명령이 성공적으로 완료될 수 없도록 하는 종료 오류(예: 데이터 누락, 잘못된 매개 변수 또는 사용 권한 부족)에는 영향을 주지 않습니다.
유효한 값:
Continue. 오류 메시지를 표시하고 명령 실행을 계속합니다. "Continue"가 기본값입니다.
Ignore. 오류 메시지를 표시하지 않고 명령 실행을 계속합니다. SilentlyContinue와 달리 Ignore는 $Error 자동 변수에 오류 메시지를 추가하지 않습니다. Ignore 값은 Windows PowerShell 3.0에서 도입되었습니다.
Inquire. 오류 메시지를 표시하고 실행을 계속하기 전에 확인 메시지를 표시합니다. 이 값은 거의 사용되지 않습니다.
SilentlyContinue. 오류 메시지를 표시하지 않고 명령 실행을 계속합니다.
Stop. 오류 메시지를 표시하고 명령 실행을 중지합니다.
Suspend. 이 값은 Windows PowerShell 워크플로에서만 사용할 수 있습니다. 워크플로에서 종료 오류가 발생하면 이 작업 기본 설정에서 자세히 조사할 수 있도록 작업을 자동으로 일시 중단합니다. 조사 후 워크플로를 다시 시작할 수 있습니다.
-ERRORVARIABLE [+]<VARIABLE-NAME>
별칭: ev
지정된 변수 및 $Error 자동 변수에 명령에 대한 오류 메시지를 저장합니다. 자세한 내용을 보려면 다음 명령을 입력하세요.
get-help about_Automatic_Variables
기본적으로 새 오류 메시지가 변수에 이미 저장된 오류 메시지를 덮어씁니다. 변수 내용에 오류 메시지를 추가하려면 변수 이름 앞에 더하기 기호(+)를 입력합니다.
예를 들어 다음 명령은 $a 변수를 만든 다음 오류를 저장합니다.
Get-Process -Id 6 -ErrorVariable a
다음 명령은 모든 오류 메시지를 $a 변수에 추가합니다.
Get-Process -Id 2 -ErrorVariable +a
다음 명령은 $a의 내용을 표시합니다.
$a
이 매개 변수를 사용하여 특정 명령에서 발생하는 오류 메시지만 포함하는 변수를 만들 수 있습니다. $Error 자동 변수에는 세션의 모든 명령에서 발생한 오류 메시지가 포함됩니다. $a[0] 또는 $error[1,2]와 같은 배열 표기법을 사용하여 변수에 저장된 특정 오류를 나타낼 수 있습니다.
-OUTBUFFER <INT32>
별칭: ob
개체가 파이프라인을 통해 전송되기 전에 버퍼에 누적되는 개체 수를 결정합니다. 이 매개 변수를 생략하면 개체는 생성되는 즉시 전송됩니다.
이 리소스 관리 매개 변수는 고급 사용자용입니다. 이 매개 변수를 사용하면 Windows PowerShell에서는 생성된 개체 수가 OutBuffer + 1이 될 때까지 파이프라인에서 다음 cmdlet이 호출되지 않습니다. 그때부터 생성되는 모든 개체가 전송됩니다.,
-OUTVARIABLE [+]<VARIABLE-NAME>
별칭: ov
명령에서 출력 개체를 지정된 변수에 저장하고 명령줄에 표시합니다.
변수에 이미 저장된 출력을 바꾸는 대신 변수에 출력을 추가하려면 변수 이름 앞에 더하기 기호(+)를 입력합니다.
예를 들어 다음 명령은 $out 변수를 만든 다음 변수에 프로세스 개체를 저장합니다.
Get-Process PowerShell -OutVariable out
다음 명령은 프로세스 개체를 $out 변수에 추가합니다.
Get-Process iexplore -OutVariable +out
다음 명령은 $out 변수의 내용을 표시합니다.
$out
-PIPELINEVARIABLE <STRING>
별칭: pv
PipelineVariable은 파이프라인을 통해 전달되는 모든 명명된 명령에 대해 현재 파이프라인 요소의 값을 변수로 저장합니다.
유효한 값은 문자열이며 모든 변수 이름의 값과 동일합니다.
다음은 PipelineVariable의 작동 방식에 대한 예제입니다. 이 예제에서는 PipelineVariable 매개 변수를 Foreach-Object 명령에 추가하여 명령의 결과를 변수에 저장합니다. 1에서 10 사이의 숫자가 첫 번째 Foreach-Object 명령으로 파이프되며 결과는 Left라는 변수에 저장됩니다.
첫 번째 Foreach-Object 명령의 결과는 두 번째 Foreach-Object 명령으로 파이프되며, 이 명령은 첫 번째 Foreach-Object 명령에서 반환된 개체를 필터링합니다. 두 번째 명령의 결과는 Right라는 변수에 저장됩니다.
세 번째 Foreach-Object 명령에서는 Left 및 Right 변수로 표시되는, 파이프된 처음 두 Foreach-Object 명령의 결과가 곱하기 연산자를 사용하여 처리됩니다. 이 명령은 Left 및 Right 변수에 저장된 개체를 곱하도록 지시하고 결과가 "Left range member * Right range member = 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[:{$TRUE | $FALSE}]
별칭: vb
명령에 의해 수행되는 작업에 대한 자세한 정보를 표시합니다. 이 정보는 추적 또는 트랜잭션 로그의 정보와 유사합니다. 이 매개 변수는 명령이 자세한 메시지를 생성하는 경우에만 작동합니다. 예를 들어 이 매개 변수는 명령에 Write-Verbose cmdlet이 포함된 경우 작동합니다.
Verbose 매개 변수는 현재 명령에 대한 $VerbosePreference 변수의 값을 재정의합니다. $VerbosePreference 변수의 기본값은 SilentlyContinue이므로 기본적으로 자세한 정보 메시지가 표시되지 않습니다.
유효한 값:
$true (-Verbose:$true) has the same effect as -Verbose.
$false (-Verbose:$false) suppresses the display of verbose
messages. Use this parameter when the value of $VerbosePreference
is not SilentlyContinue (the default).
-WARNINGACTION[:{CONTINUE | INQUIRE | SILENTLYCONTINUE | STOP}]
별칭: wa
cmdlet이 명령에서 발생한 경고에 반응하는 방법을 결정합니다. "Continue"가 기본값입니다. 이 매개 변수는 명령이 경고 메시지를 생성하는 경우에만 작동합니다. 예를 들어 이 매개 변수는 명령에 Write-Warning cmdlet이 포함된 경우 작동합니다.
WarningAction 매개 변수는 현재 명령에 대한 $WarningPreference 변수의 값을 재정의합니다. $WarningPreference 변수의 기본값은 Continue이므로 경고가 표시되며 WarningAction 매개 변수를 사용하지 않는 한 계속 실행됩니다.
유효한 값:
Continue. 경고 메시지를 표시하고 명령 실행을 계속합니다. "Continue"가 기본값입니다.
Inquire. 경고 메시지를 표시하고 실행을 계속하기 전에 확인 메시지를 표시합니다. 이 값은 거의 사용되지 않습니다.
SilentlyContinue. 경고 메시지를 표시하지 않고 명령 실행을 계속합니다.
Stop. 경고 메시지를 표시하고 명령 실행을 중지합니다.
참고: WarningAction 매개 변수는 매개 변수가 명령에서 스크립트나 함수를 실행하는 데 사용되는 경우 $WarningAction 기본 설정 변수 값을 재정의하지 않습니다.
-WARNINGVARIABLE [+]<VARIABLE-NAME>
별칭: wv
지정된 변수에 명령에 대한 경고를 저장합니다.
생성된 모든 경고는 사용자에게 표시되지 않는 경우에도 변수에 저장됩니다.
변수에 이미 저장된 경고를 바꾸는 대신 변수 내용에 경고를 추가하려면 변수 이름 앞에 더하기 기호(+)를 입력합니다.
예를 들어 다음 명령은 $a 변수를 만든 다음 경고를 저장합니다.
Get-Process -Id 6 -WarningVariable a
다음 명령은 모든 경고를 $a 변수에 추가합니다.
Get-Process -Id 2 -WarningVariable +a
다음 명령은 $a의 내용을 표시합니다.
$a
이 매개 변수를 사용하여 특정 명령에서 발생하는 경고만 포함하는 변수를 만들 수 있습니다. $a[0] 또는 $warning[1,2]와 같은 배열 표기법을 사용하여 변수에 저장된 특정 경고를 나타낼 수 있습니다.
참고: WarningVariable 매개 변수는 함수나 스크립트의 중첩된 호출에서 발생한 경고를 캡처하지 않습니다.
위험 관리 매개 변수 설명
-WHATIF[:{$TRUE | $FALSE}]
별칭: wi
명령을 실행하는 대신 명령의 효과를 설명하는 메시지를 표시합니다.
WhatIf 매개 변수는 현재 명령에 대한 $WhatIfPreference 변수의 값을 재정의합니다. $WhatIfPreference 변수의 기본값은 0(사용 안 함)이므로 WhatIf 매개 변수가 없으면 WhatIf 동작이 수행되지 않습니다. 자세한 내용을 보려면 다음 명령을 입력하세요.
Get-Help about_Preference_Variables
유효한 값:
$true (-WhatIf:$true). Has the same effect as -WhatIf.
$false (-WhatIf:$false). Suppresses the automatic WhatIf behavior
that results when the value of the $WhatIfPreference variable
is 1.
예를 들어 다음 명령은 Remove-Item 명령에서 WhatIf 매개 변수를 사용합니다.
PS> Remove-Item Date.csv -WhatIf
Windows PowerShell에서는 항목을 제거하는 대신 수행되는 작업과 영향을 받는 항목을 나열합니다. 이 명령을 실행하면 다음과 같은 출력이 생성됩니다.
What if: Performing operation "Remove File" on
Target "C:\ps-test\date.csv".
-CONFIRM[:{$TRUE | $FALSE}]
별칭: cf
명령을 실행하기 전에 확인을 요청하는 메시지가 표시됩니다.
Confirm 매개 변수는 현재 명령에 대한 $ConfirmPreference 변수의 값을 재정의합니다. 기본값은 High입니다. 자세한 내용을 보려면 다음 명령을 입력하세요.
Get-Help about_Preference_Variables
유효한 값:
$true (-Confirm:$true). Has the same effect as -Confirm.
$false(-Confirm:$false). Suppresses automatic confirmation,
which occurs when the value of $ConfirmPreference is less than
or equal to the estimated risk of the cmdlet.
예를 들어 다음 명령은 Remove-Item 명령에서 Confirm 매개 변수를 사용합니다. Windows 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"):
Confirm 응답 옵션은 다음과 같습니다.
Yes (Y) Perform the action.
Yes to All (A) Perform all actions and suppress subsequent
Confirm queries for this command.
No (N): Do not perform the action.
No to All (L): Do not perform any actions and suppress subsequent
Confirm queries for this command.
Suspend (S): Pause the command and create a temporary session.
Help (?) Display help for these options.
Suspend 옵션은 명령을 보류 상태로 전환하고 Confirm 옵션을 선택할 수 있을 때까지 작업할 수 있는 임시 중첩된 세션을 만듭니다. 중첩된 세션에 대한 명령 프롬프트에는 이 명령이 원래 부모 명령의 자식 작업임을 나타내는 두 개의 추가 캐럿(>>)이 있습니다. 중첩된 세션에서 명령 및 스크립트를 실행할 수 있습니다. 중첩된 세션을 종료하고 원래 명령에 대한 Confirm 옵션으로 돌아가려면 "exit"를 입력합니다.
다음 예제에서는 Suspend 옵션(S)을 사용하여 사용자가 명령 매개 변수에 대한 도움말을 확인하는 동안 일시적으로 명령을 중단합니다. 필요한 정보를 가져온 후 사용자는 "exit"를 입력하여 중첩된 프롬프트를 종료한 다음 Confirm 쿼리에 대해 Yes(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 (default 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