Save-Help

참조

모듈:: Microsoft.PowerShell.Core

최신 도움말 파일을 다운로드하여 파일 시스템 디렉터리에 저장합니다.

구문

Save-Help
    [-DestinationPath] <String[]>
    [[-Module] <PSModuleInfo[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [[-UICulture] <CultureInfo[]>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-Force]
    [-Scope <UpdateHelpScope>]
    [<CommonParameters>]

Save-Help
    -LiteralPath <String[]>
    [[-Module] <PSModuleInfo[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [[-UICulture] <CultureInfo[]>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-Force]
    [-Scope <UpdateHelpScope>]
    [<CommonParameters>]

Description

cmdlet은 Save-Help PowerShell 모듈에 대한 최신 도움말 파일을 다운로드하여 지정한 디렉터리에 저장합니다. 이 기능을 사용하면 인터넷에 액세스할 수 없는 컴퓨터의 도움말 파일을 업데이트할 수 있으며 여러 컴퓨터에서 도움말 파일을 더 쉽게 업데이트할 수 있습니다.

Windows PowerShell 3.0 Save-Help 에서는 로컬 컴퓨터에 설치된 모듈에 대해서만 작동했습니다. 원격 컴퓨터에서 모듈을 가져오거나 PowerShell 원격을 사용하여 원격 컴퓨터에서 PSModuleInfo 개체에 대한 참조를 가져올 수 있었지만 HelpInfoUri 속성은 유지되지 Save-Help 않았으며 원격 모듈 도움말에서는 작동하지 않습니다.

Windows PowerShell 4.0 에서 HelpInfoUri 속성은 원격 컴퓨터에 설치된 모듈에서 작동할 수 있도록 Save-Help 하는 PowerShell 원격을 통해 유지됩니다. 인터넷 액세스 권한이 없는 컴퓨터에서 실행하여 PSModuleInfo 개체를 디스크 또는 이동식 미디어에 저장하고, 인터넷에 액세스할 수 있는 컴퓨터에서 개체를 가져온 다음, PSModuleInfo 개체에서 실행할 Save-Help 수도 있습니다.Export-Clixml 저장된 도움말은 USB 드라이브와 같은 이동식 스토리지 미디어를 사용하여 원격 컴퓨터로 전송할 수 있습니다. 도움말을 실행 Update-Help하여 원격 컴퓨터에 설치할 수 있습니다. 이 프로세스를 사용하여 네트워크 액세스 권한이 없는 컴퓨터에 도움말을 설치할 수 있습니다.

저장된 도움말 파일을 설치하려면 cmdlet을 Update-Help 실행합니다. SourcePath 매개 변수를 추가하여 도움말 파일을 저장한 폴더를 지정합니다.

매개 변수 Save-Help 가 없으면 명령은 세션의 모든 모듈 및 PSModulePath 환경 변수에 나열된 위치에 있는 컴퓨터에 설치된 모듈에 대한 최신 도움말을 다운로드합니다. 이 작업은 업데이트 가능한 도움말을 경고 없이 지원하지 않는 모듈을 건너뜁니다.

cmdlet은 Save-Help 대상 폴더에 있는 도움말 파일의 버전을 확인합니다. 최신 도움말 파일을 사용할 수 있는 경우 이 cmdlet은 인터넷에서 최신 도움말 파일을 다운로드한 다음 폴더에 저장합니다. cmdlet은 Save-Help 캐비닛 파일에서 도움말 파일을 추출하고 컴퓨터에 설치하는 대신 다운로드한 캐비닛(.cab) 파일을 저장한다는 점을 제외하고 cmdlet처럼 작동 Update-Help 합니다.

각 모듈에 대해 저장된 도움말은 도움말 정보(HelpInfo XML) 파일 1개와 도움말 파일 각 UI 문화권에 대한 하나의 캐비닛(.cab) 파일로 구성됩니다. 캐비닛 파일에서 도움말 파일을 추출할 필요가 없습니다. cmdlet은 Update-Help 도움말 파일을 추출하고, XML의 안전성을 검사한 다음, 모듈 폴더의 언어별 하위 폴더에 도움말 파일 및 도움말 정보 파일을 설치합니다.

PowerShell 설치 폴더($pshome\Modules)에 모듈에 대한 도움말 파일을 저장하려면 관리자 권한으로 실행 옵션을 사용하여 PowerShell을 시작합니다. 이러한 모듈에 대한 도움말 파일을 다운로드하려면 컴퓨터에서 Administrators 그룹의 구성원이어야 합니다.

이 cmdlet은 Windows PowerShell 3.0에서 도입되었습니다.

예제

예제 1: DhcpServer 모듈에 대한 도움말 저장

# Option 1: Run Invoke-Command to get the PSModuleInfo object for the remote DHCP Server module,
# save the PSModuleInfo object in the variable $m, and then run Save-Help.

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


# Option 2: Open a PSSession--targeted at the remote computer that is running the DhcpServer
# module--to get the PSModuleInfo object for the remote module, and then run Save-Help.

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


# Option 3: Open a CIM session--targeted at the remote computer that is running the DhcpServer
# module--to get the PSModuleInfo object for the remote module, and then run Save-Help.

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

이 예제에서는 로컬 컴퓨터에 DhcpServer 모듈 또는 DHCP 서버 역할을 설치하지 않고 인터넷에 연결된 클라이언트 컴퓨터에서 DhcpServer 모듈에 대한 도움말을 저장하는 데 사용할 Save-Help 수 있는 세 가지 방법을 보여줍니다.

예제 2: DhcpServer 모듈에 대한 도움말 설치

# First, run Export-CliXml to export the PSModuleInfo object to a shared folder or to removable media.

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

# Next, transport the removable media to a computer that has Internet access, and then import the
# PSModuleInfo object with Import-CliXml. Run Save-Help to save the Help for the imported DhcpServer
# module PSModuleInfo object.

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

# Finally, transport the removable media back to the computer that does not have network access, and
# then install the help by running Update-Help.

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

이 예제에서는 인터넷에 액세스할 수 없는 컴퓨터의 DhcpServer 모듈에 대한 예제 1에 저장한 도움말을 설치하는 방법을 보여 주었습니다.

예제 3: 모든 모듈에 대한 도움말 저장

Save-Help -DestinationPath "\\Server01\FileShare01"

이 명령은 로컬 컴퓨터에서 Windows용으로 설정된 UI 문화권의 모든 모듈에 대한 최신 도움말 파일을 다운로드합니다. 이 파일은 도움말 파일을 폴더에 \\Server01\Fileshare01 저장합니다.

예제 4: 컴퓨터의 모듈에 대한 도움말 저장

Save-Help -Module ServerManager -DestinationPath "\\Server01\FileShare01" -Credential Domain01/Admin01

이 명령은 ServerManager 모듈에 대한 최신 도움말 파일을 다운로드한 다음 폴더에 \\Server01\Fileshare01 저장합니다.

모듈이 컴퓨터에 설치된 경우 모듈을 현재 세션으로 가져오지 않더라도 모듈 이름을 모듈 매개 변수 값으로 입력할 수 있습니다.

이 명령은 자격 증명 매개 변수를 사용하여 파일 공유에 쓸 수 있는 권한이 있는 사용자의 자격 증명을 제공합니다.

예제 5: 다른 컴퓨터의 모듈에 대한 도움말 저장

Invoke-Command -ComputerName Server02 {Get-Module -Name CustomSQL -ListAvailable} | Save-Help -DestinationPath \\Server01\FileShare01 -Credential Domain01\Admin01

이러한 명령은 CustomSQL 모듈에 대한 최신 도움말 파일을 다운로드하여 폴더에 \\Server01\Fileshare01 저장합니다.

CustomSQL 모듈이 컴퓨터에 설치되어 있지 않으므로 시퀀스에는 Server02 컴퓨터에서 CustomSQL 모듈의 모듈 개체를 가져오고 모듈 개체를 cmdlet으로 파이프하는 Save-Help 명령이 포함 Invoke-Command 됩니다.

모듈이 컴퓨터에 Save-Help 설치되지 않은 경우 최신 도움말 파일의 위치에 대한 정보를 포함하는 모듈 개체가 필요합니다.

예제 6: 모듈에 대한 도움말을 여러 언어로 저장

Save-Help -Module Microsoft.PowerShell* -UICulture de-DE, en-US, fr-FR, ja-JP -DestinationPath "D:\Help"

이 명령은 네 가지 UI 문화권에서 핵심 PowerShell 모듈에 대한 도움말을 저장합니다. 이러한 로캘의 언어 팩은 컴퓨터에 설치할 필요가 없습니다.

Save-Help 는 모듈 소유자가 번역된 파일을 인터넷에서 사용할 수 있도록 하는 경우에만 다른 UI 문화권의 모듈에 대한 도움말 파일을 다운로드할 수 있습니다.

예제 7: 매일 두 번 이상 도움말 저장

Save-Help -Force -DestinationPath "\\Server3\AdminShare\Help"

이 명령은 컴퓨터에 설치된 모든 모듈을 대한 도움말을 저장합니다. 이 명령은 각 24시간 동안 cmdlet이 도움말을 두 번 이상 다운로드하지 못하도록 하는 Save-Help 규칙을 재정의하는 Force 매개 변수를 지정합니다.

Force 매개 변수는 또한 1GB 제한을 재정의하고 버전 검사를 우회합니다. 따라서 버전이 대상 폴더의 버전보다 늦지 않은 경우에도 파일을 다운로드할 수 있습니다.

이 명령은 cmdlet을 Save-Help 사용하여 도움말 파일을 다운로드하고 지정된 폴더에 저장합니다. Force 매개 변수는 매일 두 번 이상 명령을 실행 Save-Help 해야 하는 경우에 필요합니다.

매개 변수

-Credential

사용자 자격 증명을 지정합니다. 이 cmdlet은 DestinationPath 매개 변수로 지정된 파일 시스템 위치에 액세스할 수 있는 권한이 있는 사용자의 자격 증명을 사용하여 명령을 실행합니다. 이 매개 변수는 DestinationPath 또는 LiteralPath 매개 변수가 명령에 사용되는 경우에만 유효합니다.

이 매개 변수를 사용하면 원격 컴퓨터에서 DestinationPath 매개 변수를 사용하는 명령을 실행할 Save-Help 수 있습니다. 명시적 자격 증명을 제공하면 액세스 거부 오류가 발생하거나 CredSSP 인증을 사용하여 자격 증명을 위임하지 않고 원격 컴퓨터에서 명령을 실행하고 세 번째 컴퓨터의 파일 공유에 액세스할 수 있습니다.

User01 또는 Domain01\User01과 같은 사용자 이름을 입력하거나 cmdlet에서 생성된 PSCredential 개체를 Get-Credential 입력합니다. 사용자 이름을 입력하면 암호를 입력하라는 메시지가 표시됩니다.

자격 증명은 PSCredential 개체에 저장되고 암호는 SecureString 으로 저장됩니다.

참고 항목

SecureString 데이터 보호에 대한 자세한 내용은 SecureString이 얼마나 안전한가요?를 참조하세요.

형식:	PSCredential
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-DestinationPath

도움말 파일이 저장되는 폴더의 경로를 지정합니다. 파일 이름 또는 파일 이름 확장명을 지정하지 마세요.

형식:	String[]
별칭:	Path
Position:	0
Default value:	None
필수:	True
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-Force

이 cmdlet은 하루에 한 번 제한 사항을 따르지 않고 버전 검사를 건너뛰고 1GB 제한을 초과하는 파일을 다운로드합니다.

이 매개 변수가 없으면 각 24시간 동안 각 모듈에 대해 하나의 Save-Help 명령만 허용되고, 다운로드는 모듈당 1GB의 압축되지 않은 콘텐츠로 제한되며, 모듈의 도움말 파일은 컴퓨터의 파일보다 최신인 경우에만 설치됩니다.

하루에 한 번 제한은 도움말 파일을 호스트하는 서버를 보호하고 PowerShell 프로필에 명령을 추가하는 Save-Help 것이 실용적입니다.

Force 매개 변수가 없는 여러 UI 문화권에서 모듈에 대한 도움말을 저장하려면 다음과 같은 동일한 명령에 모든 UI 문화권을 포함합니다.Save-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR

형식:	SwitchParameter
Position:	Named
Default value:	False
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-FullyQualifiedModule

값은 모듈 이름, 전체 모듈 사양 또는 모듈 파일 경로일 수 있습니다.

값이 경로인 경우 경로는 정규화되거나 상대적일 수 있습니다. 상대 경로는 using 문을 포함하는 스크립트를 기준으로 확인됩니다.

값이 이름 또는 모듈 사양인 경우 PowerShell은 PSModulePath에서 지정된 모듈을 검색합니다.

모듈 사양은 다음 키가 있는 해시 테이블입니다.

ModuleName - 필수 모듈 이름을 지정합니다.
GUID - 선택 사항 모듈의 GUID를 지정합니다.
또한 아래 세 가지 키 중 하나 이상을 지정해야 합니다 .
- ModuleVersion - 모듈의 허용 가능한 최소 버전을 지정합니다.
- MaximumVersion - 모듈의 허용되는 최대 버전을 지정합니다.
- RequiredVersion - 모듈의 정확한 필수 버전을 지정합니다. 다른 버전 키에는 사용할 수 없습니다.

Module 매개 변수와 동일한 명령에는 FullyQualifiedModule 매개 변수를 지정할 수 없습니다. 두 매개 변수는 상호 배타적입니다.

형식:	ModuleSpecification[]
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	True
와일드카드 문자 허용:	False

-LiteralPath

대상 폴더의 경로를 지정합니다. DestinationPath 매개 변수의 값과 달리 LiteralPath 매개 변수의 값은 입력된 대로 정확하게 사용됩니다. 와일드카드 문자로 해석되는 문자는 없습니다. 경로에 이스케이프 문자가 포함된 경우 작은따옴표로 묶습니다. 작은따옴표는 PowerShell에 문자를 이스케이프 시퀀스로 해석하지 않도록 지시합니다.

형식:	String[]
별칭:	PSPath, LP
Position:	Named
Default value:	None
필수:	True
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-Module

이 cmdlet이 도움말을 다운로드하는 모듈을 지정합니다. 쉼표로 구분된 목록이나 각 줄에 하나의 모듈 이름이 있는 파일에 하나 이상의 모듈 이름 또는 이름 패터를 입력합니다. 와일드카드 문자를 사용할 수 있습니다. 모듈 개체를 cmdlet에서 Get-Module .로 파이프할 Save-Help수도 있습니다.

기본적으로 Save-Help 업데이트 가능한 도움말을 지원하고 PSModulePath 환경 변수에 나열된 위치에 로컬 컴퓨터에 설치되는 모든 모듈에 대한 도움말을 다운로드합니다.

컴퓨터에 설치되지 않은 모듈에 대한 도움말을 저장하려면 원격 컴퓨터에서 Get-Module 명령을 실행합니다. 그런 다음 결과 모듈 개체를 cmdlet에 Save-Help 파이프하거나 모듈 개체를 Module 또는 InputObject 매개 변수의 값으로 제출합니다.

지정한 모듈이 컴퓨터에 설치된 경우 모듈 이름 또는 모듈 개체를 입력할 수 있습니다. 모듈이 컴퓨터에 설치되어 있지 않은 경우 cmdlet에서 반환된 모듈 개체와 같은 모듈 개체를 Get-Module 입력해야 합니다.

cmdlet의 Save-Help Module 매개 변수는 모듈 파일 또는 모듈 매니페스트 파일의 전체 경로를 허용하지 않습니다. PSModulePath 위치에 없는 모듈에 대한 도움말을 저장하려면 명령을 실행 Save-Help 하기 전에 모듈을 현재 세션으로 가져옵니다.

"*"(모두) 값은 컴퓨터에 설치된 모든 모듈에 대한 도움말을 업데이트하려고 시도합니다. 여기에는 업데이트 가능한 도움말을 지원하지 않는 모듈이 포함됩니다. 이 값은 명령이 업데이트 가능한 도움말을 지원하지 않는 모듈을 발견할 때 오류를 생성할 수 있습니다.

형식:	PSModuleInfo[]
별칭:	Name
Position:	1
Default value:	None
필수:	False
파이프라인 입력 허용:	True
와일드카드 문자 허용:	True

-Scope

이 매개 변수는 이 cmdlet에서 아무 작업도 수행하지 않습니다.

형식:	UpdateHelpScope
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	True
와일드카드 문자 허용:	False

-UICulture

이 cmdlet이 업데이트된 도움말 파일을 가져오는 UI 문화권 값을 지정합니다. 문화권 개체를 포함하는 변수 또는 문화권 개체(예: 명령)를 가져오는 명령과 같은 es-ESGet-Culture Get-UICulture 하나 이상의 언어 코드를 입력합니다. 와일드카드 문자는 허용되지 않습니다.

기본적으로 Save-Help 운영 체제 또는 대체 문화권에 대해 설정된 UI 문화권의 도움말 파일을 가져옵니다. UICulture 매개 변수 Save-Help 를 지정하는 경우 지정된 언어에 대한 도움말만 찾습니다.

PowerShell 7.4부터 모든 지역에 대해 영어로 도움말을 다운로드하는 등의 en 부분 언어 코드를 사용할 수 있습니다.

형식:	CultureInfo[]
Position:	2
Default value:	Current UI culture
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-UseDefaultCredentials

이 cmdlet은 현재 사용자의 자격 증명을 사용하여 웹 다운로드를 포함한 명령을 실행한다는 것을 나타냅니다. 기본적으로 명령은 명시적 자격 증명 없이 실행됩니다.

이 매개 변수는 웹 다운로드에서 NTLM, 협상 또는 kerberos 기반 인증을 사용하는 경우에만 유효합니다.

형식:	SwitchParameter
Position:	Named
Default value:	False
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

입력

PSModuleInfo

모듈 개체를 이 cmdlet으로 파이프할 수 있습니다.

출력

None

이 cmdlet은 출력을 반환하지 않습니다.

참고

$pshome\Modules 폴더에 모듈에 대한 도움말을 저장하려면 관리자 권한으로 실행 옵션을 사용하여 PowerShell을 시작합니다. 컴퓨터의 Administrators 그룹 구성원만 $pshome\Modules 폴더의 모듈에 대한 도움말을 다운로드할 수 있습니다.
각 모듈에 대해 저장된 도움말은 도움말 정보(HelpInfo XML) 파일 1개와 도움말 파일 각 UI 문화권에 대한 하나의 캐비닛(.cab) 파일로 구성됩니다. 캐비닛 파일에서 도움말 파일을 추출할 필요가 없습니다. cmdlet은 Update-Help 도움말 파일을 추출하고 XML의 유효성을 검사한 다음 도움말 파일 및 도움말 정보 파일을 모듈 폴더의 언어별 하위 폴더에 설치합니다.
cmdlet은 Save-Help 컴퓨터에 설치되지 않은 모듈에 대한 도움말을 저장할 수 있습니다. 그러나 도움말 파일이 모듈 폴더 Update-Help 에 설치되므로 cmdlet은 컴퓨터에 설치된 모듈에 대해서만 업데이트된 도움말 파일을 설치할 수 있습니다.
모듈에 대한 업데이트된 도움말 파일을 찾을 수 없거나 지정된 언어로 업데이트된 도움말 파일을 찾을 수 없는 경우 Save-Help 오류 메시지를 표시하지 않고 자동으로 계속됩니다. 명령에서 저장한 파일을 확인하려면 Verbose 매개 변수를 지정합니다.
모듈은 최신 도움말의 가장 작은 단위입니다. 모듈의 모든 cmdlet에 대해서만 특정 cmdlet에 대한 도움말을 저장할 수 없습니다. 특정 cmdlet이 포함된 모듈을 찾으려면 ModuleName 속성을 cmdlet과 Get-Command 함께 사용합니다. 예를 들면 다음과 같습니다.(Get-Command \<cmdlet-name\>).ModuleName
Save-Help 는 모든 모듈 및 핵심 PowerShell 스냅인을 지원합니다. 다른 스냅인은 지원하지 않습니다.
및 Save-Help cmdlet은 Update-Help 다음 포트를 사용하여 도움말 파일을 다운로드합니다. HTTP용 포트 80 및 HTTPS용 포트 443.
Update-Help Windows PE(Windows 사전 설치 환경)에서는 및 Save-Help cmdlet이 지원되지 않습니다.

다음을 통해 공유

Save-Help

구문

Description

예제

예제 1: DhcpServer 모듈에 대한 도움말 저장

예제 2: DhcpServer 모듈에 대한 도움말 설치

예제 3: 모든 모듈에 대한 도움말 저장

예제 4: 컴퓨터의 모듈에 대한 도움말 저장

예제 5: 다른 컴퓨터의 모듈에 대한 도움말 저장

예제 6: 모듈에 대한 도움말을 여러 언어로 저장

예제 7: 매일 두 번 이상 도움말 저장

매개 변수

-Credential

-DestinationPath

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Scope

-UICulture

-UseDefaultCredentials

입력

출력

참고

추가 리소스

다음을 통해 공유

Save-Help

구문

Description

예제

예제 1: DhcpServer 모듈에 대한 도움말 저장

예제 2: DhcpServer 모듈에 대한 도움말 설치

예제 3: 모든 모듈에 대한 도움말 저장

예제 4: 컴퓨터의 모듈에 대한 도움말 저장

예제 5: 다른 컴퓨터의 모듈에 대한 도움말 저장

예제 6: 모듈에 대한 도움말을 여러 언어로 저장

예제 7: 매일 두 번 이상 도움말 저장

매개 변수

-Credential

-DestinationPath

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Scope

-UICulture

-UseDefaultCredentials

입력

출력

참고

관련 링크

추가 리소스