New-ModuleManifest

구문

New-ModuleManifest
   [-Path] <String>
   [-NestedModules <Object[]>]
   [-Guid <Guid>]
   [-Author <String>]
   [-CompanyName <String>]
   [-Copyright <String>]
   [-RootModule <String>]
   [-ModuleVersion <Version>]
   [-Description <String>]
   [-ProcessorArchitecture <ProcessorArchitecture>]
   [-PowerShellVersion <Version>]
   [-CLRVersion <Version>]
   [-DotNetFrameworkVersion <Version>]
   [-PowerShellHostName <String>]
   [-PowerShellHostVersion <Version>]
   [-RequiredModules <Object[]>]
   [-TypesToProcess <String[]>]
   [-FormatsToProcess <String[]>]
   [-ScriptsToProcess <String[]>]
   [-RequiredAssemblies <String[]>]
   [-FileList <String[]>]
   [-ModuleList <Object[]>]
   [-FunctionsToExport <String[]>]
   [-AliasesToExport <String[]>]
   [-VariablesToExport <String[]>]
   [-CmdletsToExport <String[]>]
   [-DscResourcesToExport <String[]>]
   [-CompatiblePSEditions <String[]>]
   [-PrivateData <Object>]
   [-Tags <String[]>]
   [-ProjectUri <Uri>]
   [-LicenseUri <Uri>]
   [-IconUri <Uri>]
   [-ReleaseNotes <String>]
   [-Prerelease <String>]
   [-RequireLicenseAcceptance]
   [-ExternalModuleDependencies <String[]>]
   [-HelpInfoUri <String>]
   [-PassThru]
   [-DefaultCommandPrefix <String>]
   [-WhatIf]
   [-Confirm] 
   [<CommonParameters>]

Description

cmdlet은 New-ModuleManifest 새 모듈 매니페스트(.psd1) 파일을 만들고, 해당 값을 채우고, 매니페스트 파일을 지정된 경로에 저장합니다.

모듈 작성자는 이 cmdlet을 사용하여 모듈의 매니페스트를 만들 수 있습니다. 모듈 매니페스트는 .psd1 해시 테이블을 포함하는 파일입니다. 해시 테이블의 키와 값은 모듈의 내용 및 특성을 설명하고, 필수 구성 요소를 정의하고, 구성 요소의 처리 방법을 결정합니다. 매니페스트는 모듈에 필요하지 않습니다.

New-ModuleManifest 는 일반적으로 사용되는 모든 매니페스트 키를 포함하는 매니페스트를 만들므로 기본 출력을 매니페스트 템플릿으로 사용할 수 있습니다. 값을 추가하거나 변경하거나 이 cmdlet이 추가하지 않는 모듈 키를 추가하려면 결과 파일을 텍스트 편집기에서 엽니다.

Path 및 PassThru를 제외한 각 매개 변수는 모듈 매니페스트 키와 해당 값을 만듭니다. 모듈 매니페스트에서는 ModuleVersion 키만 필요합니다. 매개 변수 설명에 지정하지 않는 한 명령 New-ModuleManifest 에서 매개 변수를 생략하면 영향을 주지 않는 연결된 값에 대한 주석 문자열을 만듭니다.

PowerShell 2.0 New-ModuleManifest 에서는 필수 매개 변수 값 외에도 명령에 지정되지 않은 일반적으로 사용되는 매개 변수의 값을 묻는 메시지를 표시합니다. PowerShell 3.0 New-ModuleManifest 부터 필요한 매개 변수 값이 지정되지 않은 경우에만 프롬프트가 표시됩니다.

PowerShell 갤러리 모듈을 게시하려는 경우 매니페스트에 특정 속성에 대한 값이 포함되어야 합니다. 자세한 내용은 갤러리 설명서의 PowerShell 갤러리 게시된 항목에 대한 필수 메타데이터를 참조하세요.

예제

예제 1 - 새 모듈 매니페스트 만들기

이 예제에서는 Path 매개 변수로 지정된 파일에 새 모듈 매니페스트를 만듭니다. PassThru 매개 변수는 출력을 파이프라인 및 파일로 보냅니다.

출력에는 매니페스트에 있는 모든 키의 기본값이 표시됩니다.

New-ModuleManifest -Path C:\ps-test\Test-Module\Test-Module.psd1 -PassThru

#
# Module manifest for module 'Test-Module'
#
# Generated by: ContosoAdmin
#
# Generated on: 7/12/2019
#

@{

# Script module or binary module file associated with this manifest.
# RootModule = ''

# Version number of this module.
ModuleVersion = '0.0.1'

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = 'e1826c6e-c420-4eef-9ac8-185e3669ca6a'

# Author of this module
Author = 'ContosoAdmin'

# Company or vendor of this module
CompanyName = 'Unknown'

# Copyright statement for this module
Copyright = '(c) ContosoAdmin. All rights reserved.'

# Description of the functionality provided by this module
# Description = ''

# Minimum version of the PowerShell engine required by this module
# PowerShellVersion = ''

# Name of the PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# CLRVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @()

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = @()

# Variables to export from this module
VariablesToExport = '*'

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = @()

# DSC resources to export from this module
# DscResourcesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        # Tags = @()

        # A URL to the license for this module.
        # LicenseUri = ''

        # A URL to the main website for this project.
        # ProjectUri = ''

        # A URL to an icon representing this module.
        # IconUri = ''

        # ReleaseNotes of this module
        # ReleaseNotes = ''

        # Prerelease string of this module
        # Prerelease = ''

        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
        # RequireLicenseAcceptance = $false

        # External dependent modules of this module
        # ExternalModuleDependencies = @()

    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}

예제 2 - 미리 채워진 설정을 사용하여 새 매니페스트 만들기

이 예제에서는 새 모듈 매니페스트를 만듭니다. PowerShellVersion 및 AliasesToExport 매개 변수를 사용하여 해당 매니페스트 키에 값을 추가합니다.

$moduleSettings = @{
    PowerShellVersion = 1.0
    Path   = 'C:\ps-test\ManifestTest.psd1'
    AliasesToExport   = @(
      'JKBC'
      'DRC'
      'TAC'
    )
}
New-ModuleManifest @moduleSettings

예제 3 - 다른 모듈이 필요한 매니페스트 만들기

이 예제에서는 문자열 형식을 사용하여 BitsTransfer 모듈의 이름과 해시 테이블 형식을 지정하여 PSScheduledJob 모듈의 이름, GUID 및 버전을 지정합니다.

$moduleSettings = @{
  RequiredModules = ("BitsTransfer", @{
    ModuleName="PSScheduledJob"
    ModuleVersion="1.0.0.0";
    GUID="50cdb55f-5ab7-489f-9e94-4ec21ff51e59"
  })
  Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings

이 예제에서는 ModuleList, RequiredModules 및 NestedModules 매개 변수의 문자열 및 해시 테이블 형식을 사용하는 방법을 보여 줍니다. 문자열과 해시 테이블을 동일한 매개 변수 값으로 결합할 수 있습니다.

예제 4 - 업데이트 가능한 도움말을 지원하는 매니페스트 만들기

이 예제에서는 HelpInfoUri 매개 변수를 사용하여 모듈 매니페스트에서 HelpInfoUri 키를 만듭니다. 매개 변수 및 키의 값은 http 또는 https로 시작해야 합니다. 이 값은 업데이트할 수 있는 도움말 시스템에 모듈에 대한 HelpInfo XML 업데이트할 수 있는 도움말 정보 파일이 있는 위치를 알려줍니다.

$moduleSettings = @{
  HelpInfoUri = 'http://https://go.microsoft.com/fwlink/?LinkID=603'
  Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings

호환 가능한 도움말에 대한 자세한 내용은 about_Updatable_Help 참조하세요. HelpInfo XML 파일에 대한 자세한 내용은 Updatable 도움말 지원을 참조 하세요.

예제 5 - 모듈 정보 가져오기

이 예제에서는 모듈의 구성 값을 가져오는 방법을 보여줍니다. 모듈 매니페스트의 값은 모듈 개체의 속성 값에 반영됩니다.

이 Get-Module cmdlet은 List 매개 변수를 사용하여 Microsoft.PowerShell.Diagnostics 모듈을 가져오는 데 사용됩니다. 이 명령은 모듈 개체의 Format-List 모든 속성과 값을 표시하기 위해 모듈을 cmdlet으로 보냅니다.

Get-Module Microsoft.PowerShell.Diagnostics -List | Format-List -Property *

LogPipelineExecutionDetails : False
Name                        : Microsoft.PowerShell.Diagnostics
Path                        : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics\Micro
                              soft.PowerShell.Diagnostics.psd1
Definition                  :
Description                 :
Guid                        : ca046f10-ca64-4740-8ff9-2565dba61a4f
HelpInfoUri                 : https://go.microsoft.com/fwlink/?LinkID=210596
ModuleBase                  : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics
PrivateData                 :
Version                     : 3.0.0.0
ModuleType                  : Manifest
Author                      : Microsoft Corporation
AccessMode                  : ReadWrite
ClrVersion                  : 4.0
CompanyName                 : Microsoft Corporation
Copyright                   : Microsoft Corporation. All rights reserved.
DotNetFrameworkVersion      :
ExportedFunctions           : {}
ExportedCmdlets             : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
                              Import-Counter], [Export-Counter, Export-Counter]...}
ExportedCommands            : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
                              Import-Counter], [Export-Counter, Export-Counter]...}
FileList                    : {}
ModuleList                  : {}
NestedModules               : {}
PowerShellHostName          :
PowerShellHostVersion       :
PowerShellVersion           : 3.0
ProcessorArchitecture       : None
Scripts                     : {}
RequiredAssemblies          : {}
RequiredModules             : {}
RootModule                  :
ExportedVariables           : {}
ExportedAliases             : {}
ExportedWorkflows           : {}
SessionState                :
OnRemove                    :
ExportedFormatFiles         : {C:\Windows\system32\WindowsPowerShell\v1.0\Event.format.ps1xml,
                              C:\Windows\system32\WindowsPowerShell\v1.0\Diagnostics.format.ps1xml}
ExportedTypeFiles           : {C:\Windows\system32\WindowsPowerShell\v1.0\GetEvent.types.ps1xml}

매개 변수

-AliasesToExport

-Author

-ClrVersion

-CmdletsToExport

-CompanyName

-CompatiblePSEditions

-Confirm

-Copyright

-DefaultCommandPrefix

-Description

-DotNetFrameworkVersion

-DscResourcesToExport

-ExternalModuleDependencies

-FileList

-FormatsToProcess

-FunctionsToExport

-Guid

-HelpInfoUri

-IconUri

-LicenseUri

-ModuleList

-ModuleVersion

-NestedModules

-PassThru

-Path

-PowerShellHostName

-PowerShellHostVersion

-PowerShellVersion

-Prerelease

-PrivateData

-ProcessorArchitecture

-ProjectUri

-ReleaseNotes

-RequiredAssemblies

-RequiredModules

-RequireLicenseAcceptance

-RootModule

-ScriptsToProcess

-Tags

-TypesToProcess

-VariablesToExport

-WhatIf

입력

None

개체를 이 cmdlet으로 파이프할 수 없습니다.

출력

None

기본적으로 이 cmdlet은 출력을 반환하지 않습니다.

String

PassThru 매개 변수를 사용하는 경우 이 cmdlet은 모듈 매니페스트를 나타내는 문자열을 반환합니다.

참고

New-ModuleManifestWindows 및 비 Windows 플랫폼에서 실행하면 UTF8NoBOM으로 인코딩된 모듈 매니페스트(.psd1) 파일이 만들어집니다.

모듈 매니페스트는 일반적으로 선택 사항입니다. 그러나 전역 어셈블리 캐시에 설치된 어셈블리를 내보내려면 모듈 매니페스트가 필요합니다.

디렉터리에서 $pshome\Modules 파일을 추가하거나 변경하려면 관리자 권한으로 실행 옵션을 사용하여 PowerShell을 시작합니다.

PowerShell 2.0에서는 모듈 매니페스트에 필요하지 않았더라도 많은 매개 변수 New-ModuleManifest 가 필수였습니다. PowerShell 3.0부터는 Path 매개 변수만 필수입니다.

세션은 PowerShell 실행 환경의 인스턴스입니다. 세션에 하나 이상의 세션 상태가 있을 수 있습니다. 기본적으로 세션에는 하나의 전역 세션 상태만 있지만 가져온 각 모듈에 해당 세션 상태가 있습니다. 세션 상태를 사용하면 전역 세션 상태에 영향을 주지 않고 모듈의 명령을 실행할 수 있습니다.

호출자의 세션 상태는 모듈을 가져오는 세션 상태입니다. 일반적으로 전역 세션 상태를 참조하지만 모듈이 중첩된 모듈을 가져올 때 호출자는 모듈이고 호출자의 세션 상태는 모듈의 세션 상태입니다.

관련 링크

• Export-ModuleMember
• Get-Module
• Import-Module
• New-Module
• 모듈 제거
• Test-ModuleManifest
• about_Modules