about_Updatable_Help

업데이트 날짜: 2014년 5월

적용 대상: Windows PowerShell 2.0, Windows PowerShell 3.0, Windows PowerShell 4.0, Windows PowerShell 5.0

항목

About_Updatable_Help

간단한 설명

Windows PowerShell®의 업데이트 가능한 도움말 시스템에 대해 설명합니다.

자세한 설명

Windows PowerShell에서는 Windows PowerShell cmdlet 및 개념에 대한 최신 도움말 항목에 액세스할 수 있는 다양한 방법을 제공합니다.

Windows PowerShell 3.0에 도입된 업데이트 가능한 도움말 시스템은 로컬 컴퓨터에서 항상 최신 도움말 항목을 유지하여 해당 도움말 항목을 명령줄에서 읽을 수 있도록 디자인되었습니다. 이를 통해 도움말 파일을 쉽게 다운로드하여 설치하고 최신 도움말 파일을 사용할 수 있을 때마다 업데이트할 수 있습니다.

회사의 여러 컴퓨터 및 인터넷에 액세스할 수 없는 컴퓨터에 업데이트된 도움말을 제공하려면 업데이트 가능한 도움말을 통해 도움말 파일을 파일 시스템 디렉터리나 파일 공유로 다운로드하고 파일 공유에서 도움말 파일을 설치할 수 있습니다.

Windows PowerShell 4.0에서는 Windows PowerShell 원격 기능을 위해 HelpInfoUri 속성이 유지됩니다. 이 기능을 통해 원격 컴퓨터에 설치되었지만 로컬 컴퓨터에는 설치될 필요가 없는 모듈에서 Save-Help가 작동할 수 있습니다. 인터넷에 액세스할 수 없는 컴퓨터에서 Export-CliXml을 실행하고, PSModuleInfo 개체를 인터넷에 액세스할 수 없는 컴퓨터로 가져오고, PSModuleInfo 개체에서 Save-Help를 실행하는 방식으로 PSModuleInfo 개체를 디스크나 이동식 미디어(예: USB 드라이브)에 저장할 수 있습니다. 저장된 도움말은 이동식 미디어를 사용하여 연결이 끊어진 원격 컴퓨터로 복사하고 Update-Help를 실행하여 설치할 수 있습니다. Save-Help 기능의 이러한 개선 항목을 통해 네트워크에 액세스할 수 없는 컴퓨터에 도움말을 설치할 수 있습니다. 새 Save-Help 기능을 사용하는 방법에 대한 예제는 이 항목에서 "파일 공유에서 도움말을 업데이트하는 방법: SAVE-HELP" 를 참조하세요.

업데이트 가능한 도움말은 컴퓨터에 도움말 파일이 없어도 cmdlet에 대한 최신 도움말 항목과 기본 도움말에 온라인으로 액세스하도록 지원합니다.

Windows PowerShell 3.0에는 도움말 파일이 제공되지 않습니다. 업데이트 가능한 도움말 기능을 사용하여 기본적으로 Windows PowerShell에 포함된 모든 명령 및 모든 Windows 모듈에 대한 도움말 파일을 설치할 수 있습니다.

업데이트 가능한 도움말 CMDLET

Update-Help:

인터넷이나 파일 공유에서 최신 도움말 파일을 다운로드하여 로컬 컴퓨터에 설치합니다.

Save-Help:

인터넷에서 최신 도움말 파일을 다운로드하여 파일 시스템 디렉터리나 파일 공유에 저장합니다. 도움말 파일을 컴퓨터에 설치하려면 Update-Help를 사용합니다.

Get-Help:

명령줄에 도움말 항목을 표시합니다.

컴퓨터의 도움말 파일에서 도움말을 가져옵니다.

도움말 파일이 없는 cmdlet 및 함수에 대한 자동 생성 도움말을 표시합니다.

cmdlet, 함수, 스크립트 및 워크플로에 대한 온라인 도움말 항목을 기본 인터넷 브라우저에서 엽니다.

WINDOWS POWERSHELL ISE에서 도움말 업데이트

Windows PowerShell ISE(통합 스크립팅 환경)의 도움말 메뉴에서 "Windows PowerShell 도움말 업데이트" 항목을 사용하여 도움말을 업데이트할 수도 있습니다.

"Windows PowerShell 도움말 업데이트" 항목은 매개 변수 없이 Update-Help 명령을 실행합니다.

자동 생성된 도움말: 도움말 파일이 없는 도움말

cmdlet, 함수 또는 워크플로에 대한 도움말 파일이 컴퓨터에 없으면 Get-Help cmdlet이 자동 생성된 도움말을 표시하고 도움말 파일을 다운로드하거나 도움말을 온라인으로 읽을지 묻는 메시지가 표시됩니다.

자동 생성된 도움말에는 구문과 별칭이 들어 있고 업데이트 가능한 도움말 cmdlet을 사용하고 온라인 도움말 항목에 액세스하는 방법을 설명하는 설명이 포함됩니다.

예를 들어 다음 명령은 Get-Culture cmdlet에 대한 기본 도움말을 가져옵니다. 출력에서는 컴퓨터에 도움말 파일이 없을 때의 Get-Help 표시를 보여 줍니다.

         PS C:\> Get-Help Get-Culture

이름

Get-Culture

구문

Get-Culture [<CommonParameters>]

별칭

없음

설명

설명 및 예제를 포함한 최신 도움말 콘텐츠를 가져오려면 다음을 입력합니다. Update-Help.

모듈에 대한 도움말 파일

업데이트 가능한 도움말의 가장 작은 단위는 모듈에 대한 도움말입니다. 모듈 도움말에는 모듈의 모든 cmdlet, 함수, 워크플로, 공급자, 스크립트, 개념에 대한 도움말이 포함됩니다. 모듈을 현재 세션으로 가져오지 않아도 컴퓨터에 설치된 모든 모듈에 대한 도움말을 업데이트할 수 있습니다.

전체 모듈에 대한 도움말을 업데이트할 수 있지만 개별 cmdlet에 대한 도움말은 업데이트할 수 없습니다.

특정 cmdlet이 포함된 모듈을 찾으려면 다음 명령 형식을 사용합니다.

(Get-Command <cmdlet-name>).ModuleName

예를 들어 Set-ExecutionPolicy cmdlet이 포함된 모듈을 찾으려면 다음을 입력합니다.

(Get-Command Set-ExecutionPolicy).ModuleName

특정 모듈에 대한 도움말을 업데이트하려면 다음을 입력합니다.

        Update-Help -Module <ModuleName>

예를 들어 Set-ExecutionPolicy cmdlet이 포함된 모듈에 대한 도움말을 업데이트하려면 다음을 입력합니다.

        Update-Help -Module Microsoft.PowerShell.Security

업데이트 가능한 도움말에 대한 사용 권한

$pshome\Modules 디렉터리에서 모듈에 대한 도움말을 업데이트하려면 컴퓨터에서 Administrators 그룹의 멤버여야 합니다.

Administrators 그룹의 멤버가 아니면 이들 모듈에 대한 도움말을 업데이트할 수 없습니다. 하지만 인터넷에 액세스할 수 있으면 TechNet Library에서 온라인으로 도움말을 볼 수 있습니다.

$home\Documents\WindowsPowerShell\Modules 디렉터리의 모듈이나 $home 디렉터리의 다른 하위 디렉터리에 있는 모듈에 대한 도움말을 업데이트하는 데는 특수 권한이 필요하지 않습니다.

Update-Help 및 Save-Help cmdlet에는 현재 사용자의 명시적 자격 증명을 제공하는 UseDefaultCredentials 매개 변수가 있습니다. 이 매개 변수는 보안 인터넷 위치에 액세스하는 데 사용됩니다.

Update-Help 및 Save-Help cmdlet에는 원격 컴퓨터에서 명령을 실행하고 제3의 컴퓨터에서 파일 공유에 액세스하는 데 사용되는 Credential 매개 변수도 있습니다. Credential 매개 변수는 Update-Help의 SourcePath 또는 LiteralPath 매개 변수와 Save-Help의 DestinationPath 또는 LiteralPath parameters 매개 변수를 사용할 때만 유효합니다.

도움말 파일을 설치 및 업데이트하는 방법

도움말 파일을 처음 다운로드하여 설치하거나 컴퓨터에서 도움말 파일을 업데이트하려면 Update-Help cmdlet을 사용합니다.

Update-Help cmdlet은 다음 작업을 포함한 모든 어려운 작업을 수행합니다.

업데이트 가능한 도움말을 지원하는 모듈을 확인합니다.

각 모듈이 업데이트 가능한 도움말 파일을 저장하는 인터넷 위치를 찾습니다.

컴퓨터의 각 모듈에 대한 도움말 파일을 각 모듈에 대해 사용할 수 있는 최신 도움말 파일과 비교합니다.

인터넷에서 새 파일을 다운로드합니다.

도움말 파일 패키지의 래핑을 해제합니다.

파일이 유효한 도움말 파일인지 확인합니다.

모듈 디렉터리의 언어별 하위 디렉터리에 도움말 파일을 설치합니다.

새 도움말 항목에 액세스하려면 Get-Help cmdlet을 사용합니다. Windows PowerShell을 다시 시작할 필요가 없습니다.

업데이트 가능한 도움말을 지원하는 컴퓨터에서 모든 모듈에 대한 도움말을 설치하거나 업데이트하려면 다음을 입력합니다.

        Update-Help

특정 모듈에 대한 도움말을 업데이트하려면 Update-Help의 Module 매개 변수를 추가합니다. 모듈 이름에는 와일드카드 문자를 사용할 수 있습니다.

        Update-Help -Module ServerManager

참고

매개 변수를 사용하지 않으면 Update-Help는 세션의 모든 모듈 및 업데이트 가능한 도움말을 지원하는 설치된 모든 모듈에 대한 도움말을 업데이트합니다. 업데이트에 포함되는 모듈은 PSModulePath 환경 변수 값에 나열된 디렉터리에 설치되어 있어야 합니다. 이들 모듈은 "Get-Help -ListAvailable" 명령으로 반환된 모듈이기도 합니다.

Module 매개 변수 값이 *(모두)이면 Update-Help는 업데이트 가능한 도움말을 지원하지 않는 모듈을 포함하여 설치된 모든 모듈에 대한 업데이트를 시도합니다. 일반적으로 이 명령은 cmdlet이 업데이트 가능한 도움말 기능을 지원하지 않는 모듈을 발견하면 많은 오류를 생성합니다.

파일 공유에서 도움말을 업데이트하는 방법: SAVE-HELP

인터넷에 연결되지 않은 컴퓨터를 지원하거나 회사에서 도움말 업데이트를 제어 또는 간소화하려면 Save-Help cmdlet을 사용합니다. Save-Help cmdlet은 인터넷에서 도움말 파일을 다운로드하여 지정된 파일 시스템 디렉터리에 저장합니다.

Save-Help는 지정된 디렉터리에 있는 도움말 파일을 각 모듈에 대해 사용할 수 있는 최신 도움말 파일과 비교합니다. 디렉터리에 도움말 파일이 없거나 모듈에 대한 최신 도움말 파일을 사용할 수 있으면 Save-Help cmdlet은 인터넷에서 새 파일을 다운로드합니다. 그러나 도움말 파일을 래핑 해제하거나 설치하지 않습니다.

도움말 파일을 컴퓨터에 설치하거나 파일 시스템 디렉터리에 저장된 도움말 파일에서 업데이트하려면 Update-Help cmdlet의 SourcePath 매개 변수를 사용합니다. Update-Help cmdlet은 최신 도움말 파일을 식별하고, 해당 파일을 래핑 해제 및 유효성 검사하고, 모듈 디렉터리의 언어별 하위 디렉터리에 해당 파일을 설치합니다.

예를 들어 설치된 모든 모듈에 대한 도움말을 \\Server\Share 디렉터리에 저장하려면 다음을 입력합니다.

        Save-Help -DestinationPath \\Server\Share

그다음에 \\Server\Share 디렉터리에서 도움말을 업데이트하려면 다음을 입력합니다.

        Update-Help -SourcePath \\Server\Share  

다음 예제에서는 Save-Help를 사용하여 로컬 컴퓨터에 설치되지 않은 모듈에 대한 도움말을 저장하는 방법을 보여 줍니다. 이 예제에서는 관리자가 로컬 컴퓨터에 DhcpServer 모듈 또는 DHCP 서버 역할을 설치하지 않고 Save-Help를 실행하여 인터넷에 연결된 클라이언트 컴퓨터에서 DhcpServer 모듈의 도움말을 저장합니다.

옵션 1:

Invoke-Command를 실행하여 원격 모듈의 PSModuleInfo 개체를 가져오고, 개체를 $m 변수에 저장하고, $m 변수를 모듈 이름으로 지정하여 PSModuleInfo 개체에서 Save-Help를 실행합니다.

        $m = Invoke-Command -ComputerName RemoteServer -ScriptBlock
        { Get-Module -Name DhcpServer -ListAvailable }
        Save-Help -Module $m -DestinationPath C:\SavedHelp

옵션 2:

DHCP 서버 모듈을 실행하는 컴퓨터를 대상으로 PSSession을 열어 모듈의 PSModuleInfo 개체를 가져오고, 개체를 $m 변수에 저장하고, $m 변수에 저장된 개체에서 Save-Help를 실행합니다.

        $s = New-PSSession -ComputerName RemoteServer
        $m = Get-Module -PSSession $s -Name DhcpServer -ListAvailable
        Save-Help -Module $m -DestinationPath C:\SavedHelp

옵션 3:

DHCP 서버 모듈을 실행하는 컴퓨터를 대상으로 CIM 세션을 열어 모듈의 PSModuleInfo 개체를 가져오고, 개체를 $m 변수에 저장하고, $m 변수에 저장된 개체에서 Save-Help를 실행합니다.

$c = New-CimSession -ComputerName RemoteServer
        $m = Get-Module -CimSession $c -Name DhcpServer -ListAvailable
        Save-Help -Module $m -DestinationPath C:\SavedHelp

다음 예제에서는 관리자가 네트워크에 액세스할 수 없는 컴퓨터에 DHCP 서버 모듈의 도움말을 설치합니다.

# 먼저 Export-CliXml을 실행하여 PSModuleInfo 개체를 공유 폴더나 이동식 미디어로 내보냅니다.

        $m = Get-Module -Name DhcpServer –ListAvailable
        Export-CliXml –Path E:\UsbFlashDrive\DhcpModule.xml –InputObject $m

# 다음으로 이동식 미디어를 인터넷에 액세스할 수 있는 컴퓨터에 연결하고 Import-CliXml을 사용하여 PSModuleInfo 개체를 가져옵니다. Save-Help를 실행하여 가져온 DhcpServer 모듈 PSModuleInfo 개체에 대한 도움말을 저장합니다.

        $deserialized_m = Import-CliXml E:\UsbFlashDrive\DhcpModule.xml
        Save-Help -Module $deserialized_m –DestinationPath 
           E:\UsbFlashDrive\SavedHelp

# 마지막으로 이동식 미디어를 다시 네트워크에 액세스할 수 없는 컴퓨터에 연결하고 Update-Help를 실행하여 도움말을 설치합니다.

        Update-Help –Module DhcpServer –SourcePath 
           E:\UsbFlashDrive\SavedHelp

메모:

매개 변수를 사용하지 않으면 Save-Help는 세션의 모든 모듈 및 업데이트 가능한 도움말을 지원하는 설치된 모든 모듈에 대한 도움말을 다운로드합니다. 업데이트에 포함되는 모듈은 도움말을 저장할 로컬 컴퓨터 또는 원격 컴퓨터에서 PSModulePath 환경 변수 값에 나열된 디렉터리에 설치되어 있어야 합니다. 이들 모듈은 "Get-Help -ListAvailable" 명령을 실행하여 반환된 모듈이기도 합니다.

여러 언어로 도움말 파일을 업데이트하는 방법

기본적으로 Update-Help 및 Save-Help cmdlet은 로컬 컴퓨터의 Windows용으로 설정된 UI 문화권 및 언어로 도움말을 다운로드합니다. 지정된 모듈의 도움말 파일을 로컬 UI 문화권으로 사용할 수 없으면 Update-Help 및 Save-Help에서는 Windows 언어 폴백 규칙을 사용하여 가장 적합한 지원 언어를 찾습니다.

그러나 Update-Help 및 Save-Help cmdlet의 UICulture 매개 변수를 사용하여 도움말 파일을 사용할 수 있는 모든 UI 문화권으로 해당 파일을 다운로드하여 설치할 수 있습니다.

예를 들어 세션의 모든 모듈에 대한 최신 도움말 파일을 일본어(Ja-jp) 및 프랑스어(fr-FR)로 저장하려면 다음을 입력합니다.

      Save-Help -Path \\Server\Share -UICulture ja-jp, fr-fr

모듈의 도움말 파일을 지정한 언어로 사용할 수 없으면 Update-Help 및 Save-Help cmdlet은 필요에 가장 적합한 대체 언어를 선택할 수 있도록 각 모듈의 도움말을 사용할 수 있는 언어가 나열된 오류 메시지를 반환합니다.

도움말을 자동으로 업데이트하는 방법

도움말 파일을 항상 최신 상태로 유지하려면 Update-Help 명령을 Windows PowerShell 프로필에 추가합니다.

내부 할당량 때문에 Update-Help 명령은 하루에 두 번 이상 실행되지 않습니다. 매일 한 번이라는 최대값을 재정의하려면 Force 매개 변수를 사용합니다.

프로필에서 다음과 같은 명령을 사용합니다. 이 명령은 설치된 모든 모듈의 도움말을 백그라운드 작업으로 업데이트하므로 작업을 방해하지 않습니다. Out-Null 명령을 사용하여 반환된 작업과 명령을 하루에 두 번 이상 사용할 때 나타나는 오류 메시지를 표시하지 않을 수 있습니다.

        Start-Job {Update-Help} | Out-Null

Update-Help 또는 Save-Help cmdlet을 일정 간격으로 실행하는 예약된 작업을 만들 수도 있습니다.

예를 들어 다음 명령은 금요일마다 오전 5시에 Update-Help 도움말 명령을 실행하는 예약된 작업을 만듭니다. 이 명령을 실행하려면 "관리자 권한으로 실행" 옵션을 사용하여 Windows PowerShell을 시작합니다.

        Register-ScheduledJob -Name UpdateHelpJob -ScriptBlock {Update-Help} `
           -Trigger (New-JobTrigger -Weekly -DaysOfWeek Friday -At "5:00 AM")

예약된 작업에 대한 자세한 내용은 about_Scheduled_Jobs를 참조하세요.

온라인 도움말을 사용하는 방법

로컬 컴퓨터에서 도움말 파일을 업데이트할 수 없거나 업데이트하도록 선택하지 않은 경우에도 온라인으로 최신 도움말 파일을 얻을 수 있습니다.

cmdlet 또는 함수에 대한 온라인 도움말 항목을 열려면 Get-Help cmdlet의 Online 매개 변수를 사용합니다.

예를 들어 다음 명령은 Get-Job cmdlet의 온라인 도움말 항목을 기본 인터넷 브라우저에서 엽니다.

        Get-Help Get-Job -Online

또는

        Get-Help -on Get-Job

스크립트에 대한 온라인 도움말을 가져오려면 Online 매개 변수와 스크립트의 전체 경로를 사용합니다.

Online 매개 변수는 정보 항목에서 작동하지 않습니다. Windows PowerShell 언어에 대한 도움말 항목을 포함하여 Windows PowerShell 코어에 대한 정보 항목을 보려면 "Windows PowerShell 코어 모듈 정보 항목"(http://go.microsoft.com/fwlink/?LinkID=113206)을 참조하세요.

인터넷 다운로드를 최소화 또는 차단하는 방법

인터넷 다운로드를 최소화하고 업데이트 가능한 도움말을 인터넷에 연결되지 않은 사용자에게 제공하려면 Save-Help cmdlet을 사용합니다. 인터넷에서 도움말을 다운로드하여 네트워크 공유에 저장합니다. 그다음에 모든 컴퓨터에서 Update-Help 명령을 실행하는 그룹 정책 설정이나 예약된 작업을 만듭니다. Update-Help cmdlet의 SourcePath 매개 변수 값을 네트워크 공유로 설정합니다.

인터넷에 액세스할 수 있는 사용자가 업데이트 가능한 도움말을 인터넷에서 다운로드하지 못하게 하려면 "Update-Help의 기본 원본 경로 설정" 그룹 정책 설정을 사용합니다.

이 그룹 정책 설정은 SourcePath 매개 변수를 지정된 파일 시스템 위치와 함께 영향을 받는 모든 컴퓨터의 모든 Update-Help 명령에 암시적으로 추가합니다. 사용자는 SourcePath 매개 변수를 명시적으로 사용하여 다른 파일 시스템 위치를 지정할 수 있지만, SourcePath 매개 변수를 제외하고 인터넷에서 도움말을 다운로드할 수는 없습니다.

참고:

"Update-Help의 기본 원본 경로 설정" 그룹 정책 설정은 컴퓨터 구성 및 사용자 구성 아래에 표시됩니다. 그러나 컴퓨터 구성 아래 표시된 정책 설정만 유효합니다. 사용자 구성 아래 표시된 정책 설정은 무시됩니다.

자세한 내용은 about_Group_Policy_Settings를 참조하세요.

비표준 모듈에 대한 도움말을 업데이트하는 방법

Get-Module cmdlet의 ListAvailable 매개 변수에서 반환되지 않는 모듈에 대한 도움말을 업데이트하거나 저장하려면 Update-Help 또는 Save-Help 명령을 실행하기 전에 모듈을 현재 세션으로 가져옵니다. 원격 컴퓨터에서 Save-Help 명령을 실행하기 전에 원격 컴퓨터에 연결된 현재 CIM 또는 PSSession이나 Invoke-Command 스크립트 블록으로 모듈을 가져옵니다.

모듈이 현재 세션에 있으면 Update-Help 또는 Save-Help cmdlet을 매개 변수 없이 실행하거나 Module 매개 변수를 사용하여 모듈 이름을 지정합니다.

Update-Help 및 Save-Help cmdlet의 Module 매개 변수는 모듈 이름만 받아들입니다. 모듈 파일의 경로를 받아들이지 않습니다.

이 방법을 사용하여 Get-Module cmdlet의 ListAvailable 매개 변수에서 반환되지 않은 모듈에 대한 도움말을 업데이트하거나 저장합니다(예: PSModulePath 환경 변수에 나열되지 않은 위치에 설치된 모듈 또는 올바른 형식이 아닌 모듈(모듈 디렉터리에 기본 이름이 디렉터리 이름과 같은 하나 이상의 파일이 없음)).

업데이트 가능한 도움말을 지원하는 방법

모듈을 작성하면 모듈에 대한 온라인 도움말 및 업데이트 가능한 도움말을 지원할 수 있습니다. 자세한 내용은 MSDN Library에서 "업데이트 가능한 도움말 지원" 및 "온라인 도움말 지원"을 참조하세요.

Windows PowerShell 스냅인 또는 주석 기반 도움말에 대한 업데이트 가능한 도움말은 사용할 수 없습니다.

키워드

About_Updateable_Help

설명

Update-Help 및 Save-Help cmdlet은 Windows PE(Windows 사전 설치 환경)에서 지원되지 않습니다.

참고 항목

Get-Help

Save-Help

Update-Help

업데이트 가능한 도움말 상태 테이블

(http://go.microsoft.com/fwlink/?LinkID=270007)

커뮤니티 추가 항목

추가
표시: