Set-ModuleManifest¶
SYNOPSIS¶
Sets the values of a module manifest file.
SYNTAX¶
Set-ModuleManifest [-Path] <String> [[-RootModule] <String>] [[-ModuleVersion] <Version>]
[[-CompatiblePSEditions] <String[]>] [[-GUID] <Guid>] [[-Author] <String>] [[-CompanyName] <String>]
[[-Copyright] <String>] [[-Description] <String>] [[-PowerShellVersion] <Version>]
[[-PowerShellHostName] <String>] [[-PowerShellHostVersion] <Version>] [[-DotNetFrameworkVersion] <Version>]
[[-ClrVersion] <Version>] [[-ProcessorArchitecture] <ProcessorArchitecture>] [[-RequiredModules] <Object[]>]
[[-RequiredAssemblies] <String[]>] [[-ScriptsToProcess] <String[]>] [[-TypesToProcess] <String[]>]
[[-FormatsToProcess] <String[]>] [[-NestedModules] <Object[]>] [[-FunctionsToExport] <String[]>]
[[-CmdletsToExport] <String[]>] [[-VariablesToExport] <String[]>] [[-AliasesToExport] <String[]>]
[[-DscResourcesToExport] <String[]>] [[-ModuleList] <Object[]>] [[-FileList] <String[]>] [[-Tags] <String[]>]
[[-LicenseUri] <Uri>] [[-ProjectUri] <Uri>] [[-IconUri] <Uri>] [[-ReleaseNotes] <String>]
[[-Prerelease] <String>] [[-RequireLicenseAcceptance] <Boolean>] [[-ExternalModuleDependencies] <String[]>]
[[-HelpInfoURI] <String>] [[-DefaultCommandPrefix] <String>] [[-PrivateData] <Object>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION¶
This function sets the values of a module manifest file. Very much like the Update-ModuleManifest function, but allows values to be missing.
EXAMPLES¶
EXAMPLE 1¶
Set-ModuleManifest -Path 'C:\MyModule\MyModule.psd1' -ModuleVersion '1.0.0'
PARAMETERS¶
-Path¶
Path to the module manifest file.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-RootModule¶
Script module or binary module file associated with this manifest.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ModuleVersion¶
Version number of this module.
Type: Version
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CompatiblePSEditions¶
Supported PSEditions.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GUID¶
ID used to uniquely identify this module.
Type: Guid
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Author¶
Author of this module.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CompanyName¶
Company or vendor of this module.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Copyright¶
Copyright statement for this module.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description¶
Description of the functionality provided by this module.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PowerShellVersion¶
Minimum version of the PowerShell engine required by this module.
Type: Version
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PowerShellHostName¶
Name of the PowerShell host required by this module.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PowerShellHostVersion¶
Minimum version of the PowerShell host required by this module.
Type: Version
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DotNetFrameworkVersion¶
Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
Type: Version
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ClrVersion¶
Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
Type: Version
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProcessorArchitecture¶
Processor architecture (None,X86, Amd64) required by this module
Type: ProcessorArchitecture
Parameter Sets: (All)
Aliases:
Accepted values: None, MSIL, X86, IA64, Amd64, Arm
Required: False
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RequiredModules¶
Modules that must be imported into the global environment prior to importing this module.
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RequiredAssemblies¶
Assemblies that must be loaded prior to importing this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ScriptsToProcess¶
Script files (.ps1) that are run in the caller's environment prior to importing this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TypesToProcess¶
Type files (.ps1xml) to be loaded when importing this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 19
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FormatsToProcess¶
Format files (.ps1xml) to be loaded when importing this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NestedModules¶
Modules to import as nested modules of the module specified in RootModule/ModuleToProcess.
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 21
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FunctionsToExport¶
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.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 22
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CmdletsToExport¶
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.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 23
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VariablesToExport¶
Variables to export from this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 24
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AliasesToExport¶
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.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 25
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DscResourcesToExport¶
DSC resources to export from this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 26
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ModuleList¶
List of all modules packaged with this module.
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 27
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FileList¶
List of all files packaged with this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 28
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tags¶
Tags applied to this module. These help with module discovery in online galleries.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 29
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LicenseUri¶
A URL to the license for this module.
Type: Uri
Parameter Sets: (All)
Aliases:
Required: False
Position: 30
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProjectUri¶
A URL to the main site for this project.
Type: Uri
Parameter Sets: (All)
Aliases:
Required: False
Position: 31
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IconUri¶
A URL to an icon representing this module.
Type: Uri
Parameter Sets: (All)
Aliases:
Required: False
Position: 32
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ReleaseNotes¶
ReleaseNotes of this module.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 33
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Prerelease¶
Prerelease string of this module.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 34
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RequireLicenseAcceptance¶
Flag to indicate whether the module requires explicit user acceptance for install/update/save.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 35
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ExternalModuleDependencies¶
External dependent modules of this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 36
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HelpInfoURI¶
HelpInfo URI of this module.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 37
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DefaultCommandPrefix¶
Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 38
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PrivateData¶
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.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 39
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.