Update-ModuleManifest

Updates a module manifest file.
Update-ModuleManifest [-Path*] <String> [-AliasesToExport [<String[]>]] [-Author [<String>]] [-ClrVersion[<Version>]] [-CmdletsToExport [<String[]>]] [-CompanyName [<String>]] [-Copyright [<String>]][-DefaultCommandPrefix [<String>]] [-Description [<String>]] [-DotNetFrameworkVersion [<Version>]][-DscResourcesToExport [<String[]>]] [-ExternalModuleDependencies [<String[]>]] [-FileList [<String[]>]][-FormatsToProcess [<String[]>]] [-FunctionsToExport [<String[]>]] [-Guid [<Guid>]] [-HelpInfoUri [<Uri>]][-IconUri [<Uri>]] [-LicenseUri [<Uri>]] [-ModuleList [<Object[]>]] [-ModuleVersion [<Version>]] [-NestedModules[<Object[]>]] [-PackageManagementProviders [<String[]>]] [-PassThru] [-PowerShellHostName [<String>]][-PowerShellHostVersion [<Version>]] [-PowerShellVersion [<Version>]] [-PrivateData [<Hashtable>]][-ProcessorArchitecture {None | MSIL | X86 | IA64 | Amd64 | Arm}] [-ProjectUri [<Uri>]] [-ReleaseNotes[<String[]>]] [-RequiredAssemblies [<String[]>]] [-RequiredModules [<Object[]>]] [-RootModule [<String>]][-ScriptsToProcess [<String[]>]] [-Tags [<String[]>]] [-TypesToProcess [<String[]>]] [-VariablesToExport[<String[]>]] [-Confirm] [-WhatIf] [<CommonParameters>]

The Update-ModuleManifest cmdlet updates a module manifest (.psd1) file.

Parameters
-AliasesToExport [<String[]>]

Specifies the aliases that the module exports. Wildcards are permitted.

You can use this parameter to restrict the aliases that are exported by the module. It can remove aliases from the list of exported aliases, but it cannot add aliases to the list.

-Author [<String>]

Specifies the module author.

-ClrVersion [<Version>]

Specifies the minimum version of the Common Language Runtime (CLR) of the Microsoft .NET Framework that the module requires.

-CmdletsToExport [<String[]>]

Specifies the cmdlets that the module exports. Wildcards are permitted.

You can use this parameter to restrict the cmdlets that are exported by the module. It can remove cmdlets from the list of exported cmdlets, but it cannot add cmdlets to the list.

-CompanyName [<String>]

Specifies the company or vendor who created the module.

-Copyright [<String>]

Specifies a copyright statement for the module.

-DefaultCommandPrefix [<String>]

Specifies the default command prefix.

-Description [<String>]

Specifies a description of the module.

-DotNetFrameworkVersion [<Version>]

Specifies the minimum version of the Microsoft .NET Framework that the module requires.

-DscResourcesToExport [<String[]>]

Specifies the DSC resources that the module exports. Wildcards are permitted.

-ExternalModuleDependencies [<String[]>]

Specifies an array of external module dependencies.

-FileList [<String[]>]

Specifies all items that are included in the module.

-FormatsToProcess [<String[]>]

Specifies the formatting files (.ps1xml) that run when the module is imported.

When you import a module, Windows PowerShell runs the Update-FormatData cmdlet with the specified files. Because formatting files are not scoped, they affect all session states in the session.

-FunctionsToExport [<String[]>]

Specifies the functions that the module exports. Wildcards are permitted.

You can use this parameter to restrict the functions that are exported by the module. It can remove functions from the list of exported aliases, but it cannot add functions to the list.

-Guid [<Guid>]

Specifies a unique identifier for the module. The GUID can be used to distinguish among modules with the same name.

-HelpInfoUri [<Uri>]

Specifies the Internet address of the HelpInfo XML file for the module. Enter a Uniform Resource Identifier (URI) that begins with http or https.

The HelpInfo XML file supports the Updatable Help feature that was introduced in Windows PowerShell version 3.0. It contains information about the location of downloadable help files for the module and the version numbers of the newest help files for each supported locale. For information about Updatable Help, see about_Updatable_Help (http://go.microsoft.com/fwlink/?LinkID=235801). For information about the HelpInfo XML file, see Supporting Updatable Help (https://msdn.microsoft.com/en-us/expression/hh852754(v=vs.85)) in MSDN.

-IconUri [<Uri>]

Specifies the URL of an icon for the module. The specified icon is displayed on the gallery web page for the module.

-LicenseUri [<Uri>]

Specifies the URL of licensing terms for the module.

-ModuleList [<Object[]>]

Specifies an array of modules that are included in the module.

Enter each module name as a string or as a hash table with ModuleName and ModuleVersion keys. The hash table can also have an optional GUID key. You can combine strings and hash tables in the parameter value.

This key is designed to act as a module inventory. The modules that are listed in the value of this key are not automatically processed.

-ModuleVersion [<Version>]

Specifies the version of the module.

-NestedModules [<Object[]>]

Specifies script modules (.psm1) and binary modules (.dll) that are imported into the module’s session state. The files in the NestedModules key run in the order in which they are listed in the value.

Enter each module name as a string or as a hash table with ModuleName and ModuleVersion keys. The hash table can also have an optional GUID key. You can combine strings and hash tables in the parameter value.

-PackageManagementProviders [<String[]>]

Specifies an array of package management providers.

-PassThru [<SwitchParameter>]

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

-Path <String>

Specifies the path and file name of the module manifest. Enter a path and file name with a .psd1 file name extension, such as $pshomeModulesMyModuleMyModule.psd1.

If you specify the path to an existing file, Update-ModuleManifest replaces the file without warning unless the file has the read-only attribute.

The manifest should be located in the module’s directory, and the manifest file name should be the same as the module directory name, but with a .psd1 extension.

Note: You cannot use variables, such as $pshome or $home, in response to a prompt for a Path parameter value. To use a variable, include the Path parameter in the command.

-PowerShellHostName [<String>]

Specifies the name of the Windows PowerShell host program that the module requires. Enter the name of the host program, such as Windows PowerShell ISE Host or ConsoleHost. Wildcards are not permitted.

To find the name of a host program, in the program, type $host.name.

-PowerShellHostVersion [<Version>]

Specifies the minimum version of the Windows PowerShell host program that works with the module. Enter a version number, such as 1.1.

-PowerShellVersion [<Version>]

Specifies the minimum version of Windows PowerShell that will work with this module. For example, you can specify 3.0, 4.0, or 5.0 as the value of this parameter.

-PrivateData [<Hashtable>]

Specifies data that is passed to the module when it is imported.

-ProcessorArchitecture [<ProcessorArchitecture>]

Specifies the processor architecture that the module requires. The acceptable values for this parameter are:

— None (unknown or unspecified)– MSIL– X86– IA64– Amd64– Arm

-ProjectUri [<Uri>]

Specifies the URL of a web page about this project.

-ReleaseNotes [<String[]>]

Specifies a string array that contains release notes or comments that you want to be available to users of this version of the script.

-RequiredAssemblies [<String[]>]

Specifies the assembly (.dll) files that the module requires. Enter the assembly file names. Windows PowerShell loads the specified assemblies before updating types or formats, importing nested modules, or importing the module file that is specified in the value of the RootModule key.

Use this parameter to specify all of the assemblies that the module requires, including assemblies that must be loaded to update any formatting or type files that are listed in the FormatsToProcess or TypesToProcess keys, even if those assemblies are also listed as binary modules in the NestedModules key.

-RequiredModules [<Object[]>]

Specifies modules that must be in the global session state. If the required modules are not in the global session state, Windows PowerShell imports them. If the required modules are not available, the Import-Module command fails.

-RootModule [<String>]

Specifies the primary or root file of the module. Enter the file name of a script (.ps1), a script module (.psm1), a module manifest (.psd1), an assembly (.dll), a cmdlet definition XML file (.cdxml), or a workflow (.xaml). When the module is imported, the members that are exported from the root module file are imported into the caller’s session state.

If a module has a manifest file and no root file has been designated in the RootModule key, the manifest becomes the primary file for the module, and the module becomes a manifest module (ModuleType = Manifest).

To export members from .psm1 or .dll files in a module that has a manifest, the names of those files must be specified in the values of the RootModule or NestedModules keys in the manifest. Otherwise, their members are not exported.

Note: In Windows PowerShell 2.0, this key was called ModuleToProcess.

-ScriptsToProcess [<String[]>]

Specifies script (.ps1) files that run in the caller’s session state when the module is imported. You can use these scripts to prepare an environment, just as you might use a login script.

To specify scripts that run in the module’s session state, use the NestedModules key.

-Tags [<String[]>]

Specifies an array of tags.

-TypesToProcess [<String[]>]

Specifies the type files (.ps1xml) that run when the module is imported.

When you import the module, Windows PowerShell runs the Update-TypeData cmdlet with the specified files. Because type files are not scoped, they affect all session states in the session.

-VariablesToExport [<String[]>]

Specifies the variables that the module exports. Wildcards are permitted.

You can use this parameter to restrict the variables that are exported by the module. It can remove variables from the list of exported variables, but it cannot add variables to the list.

-Confirm [<SwitchParameter>]

  • Default value is false

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

-WhatIf [<SwitchParameter>]

  • Default value is false

Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Examples
  1. Update a module manifest:
    PS C:> Update-ModuleManifest -Path "C:tempTestManifest.psd1" -Author"TestUser1" -CompanyName "Contoso Corporation" -Copyright "(c) 2015 Contoso Corporation. All rights reserved."
    

    This command updates the module manifest TestManifest.psd1 with updated Author, CompanyName, and Copyright fields.