This is the built-in help made by Microsoft for the command 'New-Module', in PowerShell version 2 - as retrieved from
Windows version 'Microsoft® Windows Vista™ Ultimate ' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Creates a new dynamic module that exists only in memory.
New-Module [-Name] <string> [-ScriptBlock] <scriptblock> [-ArgumentList <Object[]>] [-AsCustomObject] [-Cmdlet <string[]>] [-Function <string[]>]
[-ReturnResult] [<CommonParameters>]
New-Module [-ScriptBlock] <scriptblock> [-ArgumentList <Object[]>] [-AsCustomObject] [-Cmdlet <string[]>] [-Function <string[]>] [-ReturnResult]
[<CommonParameters>]
The New-Module cmdlet creates a dynamic module from a script block. The members of the dynamic module, such as functions and variables, are immed
iately available in the session and remain available until you close the session.
Like static modules, by default, the cmdlets and functions in a dynamic module are exported and the variables and aliases are not. However, you c
an use the Export-ModuleMember cmdlet and the parameters of New-Module to override the defaults.
Dynamic modules exist only in memory, not on disk. Like all modules, the members of dynamic modules run in a private module scope that is a chil
d of the global scope. Get-Module cannot get a dynamic module, but Get-Command can get the exported members.
To make a dynamic module available to Get-Module, pipe a New-Module command to Import-Module, or pipe the module object that New-Module returns t
o Import-Module. This action adds the dynamic module to the Get-Module list, but it does not save the module to disk or make it persistent.
<
Online version: http://go.microsoft.com/fwlink/?LinkID=141554
Get-Module
Import-Module
Remove-Module
Export-ModuleMember
about_Modules
<
-------------------------- EXAMPLE 1 --------------------------
C:\PS>new-module -scriptblock {function Hello {"Hello!"}}
Name : __DynamicModule_2ceb1d0a-990f-45e4-9fe4-89f0f6ead0e5
Path : 2ceb1d0a-990f-45e4-9fe4-89f0f6ead0e5
Description :
Guid : 00000000-0000-0000-0000-000000000000
Version : 0.0
ModuleBase :
ModuleType : Script
PrivateData :
AccessMode : ReadWrite
ExportedAliases : {}
ExportedCmdlets : {}
ExportedFunctions : {[Hello, Hello]}
ExportedVariables : {}
NestedModules : {}
Description
-----------
This command creates a new dynamic module with a function called "Hello". The command returns a module object that represents the new dynamic mod
ule.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>new-module -scriptblock {function Hello {"Hello!"}}
Name : __DynamicModule_2ceb1d0a-990f-45e4-9fe4-89f0f6ead0e5
Path : 2ceb1d0a-990f-45e4-9fe4-89f0f6ead0e5
Description :
Guid : 00000000-0000-0000-0000-000000000000
Version : 0.0
ModuleBase :
ModuleType : Script
PrivateData :
AccessMode : ReadWrite
ExportedAliases : {}
ExportedCmdlets : {}
ExportedFunctions : {[Hello, Hello]}
ExportedVariables : {}
NestedModules : {}
C:\PS> get-module
C:\PS>
C:\PS> get-command Hello
CommandType Name Definition
----------- ---- ----------
Function Hello "Hello!"
Description
-----------
This example demonstrates that dynamic modules are not returned by the Get-Module cmdlet, but the members that they export are returned by the Ge
t-Command cmdlet.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>New-Module -scriptblock {$SayHelloHelp="Type 'SayHello', a space, and a name."; function SayHello ($name) { "Hello, $name" }; Export-Module
Member -function SayHello -Variable SayHelloHelp}
C:\PS> $SayHelloHelp
Type 'SayHello', a space, and a name.
C:\PS> SayHello Jeffrey
Hello, Jeffrey
Description
-----------
This command uses the Export-ModuleMember cmdlet to export a variable into the current session. Without the Export-ModuleMember command, only the
function is exported.
The output shows that both the variable and the function were exported into the session.
-------------------------- EXAMPLE 4 --------------------------
C:\PS>new-module -scriptblock {function Hello {"Hello!"}} -name GreetingModule | import-module
C:\PS> get-module
Name : GreetingModule
Path : d54dfdac-4531-4db2-9dec-0b4b9c57a1e5
Description :
Guid : 00000000-0000-0000-0000-000000000000
Version : 0.0
ModuleBase :
ModuleType : Script
PrivateData :
AccessMode : ReadWrite
ExportedAliases : {}
ExportedCmdlets : {}
ExportedFunctions : {[Hello, Hello]}
ExportedVariables : {}
NestedModules : {}
C:\PS> get-command hello
CommandType Name Definition
----------- ---- ----------
Function Hello "Hello!"
Description
-----------
This command demonstrates that you can make a dynamic module available to the Get-Module cmdlet by piping the dynamic module to the Import-Module
cmdlet.
The first command uses a pipeline operator (|) to send the module object that New-Module generates to the Import-Module cmdlet. The command uses
the Name parameter of New-Module to assign a friendly name to the module. Because Import-Module does not return any objects by default, there is
no output from this command.
The second command uses the Get-Module cmdlet to get the modules in the session. The result shows that Get-Module can get the new dynamic module.
The third command uses the Get-Command cmdlet to get the Hello function that the dynamic module exports.
-------------------------- EXAMPLE 5 --------------------------
C:\PS>$m = new-module -scriptblock {function Hello ($name) {"Hello, $name"}; function Goodbye ($name) {"Goodbye, $name"}} -AsCustomObject
C:\PS> $m
C:\PS> $m | get-member
TypeName: System.Management.Automation.PSCustomObject
Name MemberType Definition
---- ---------- ----------
Equals Method bool Equals(System.Object obj)
GetHashCode Method int GetHashCode()
GetType Method type GetType()
ToString Method string ToString()
Goodbye ScriptMethod System.Object Goodbye();
Hello ScriptMethod System.Object Hello();
PS C:\ps-test> $m.goodbye("Jane")
Goodbye, Jane
PS C:\ps-test> $m.hello("Manoj")
Hello, Manoj
PS C:\ps-test> goodbye Jane
Goodbye, Jane
PS C:\ps-test> hello Manoj
Hello, Manoj
Description
-----------
This example shows how to use the AsCustomObject parameter of New-Module to generate a custom object with script methods that represent the expor
ted functions.
The first command uses the New-Module cmdlet to generate a dynamic module with two functions, Hello and Goodbye. The command uses the AsCustomObj
ect parameter to generate a custom object instead of the PSModuleInfo object that New-Module generates by default. The command saves the custom o
bject in the $m variable.
The second command attempts to display the value of the $m variable. No content appears.
The third command uses a pipeline operator (|) to send the custom object to the Get-Member cmdlet, which displays the properties and methods of t
he custom object. The output shows that the object has script methods that represent the Hello and Goodbye functions.
The fourth and fifth commands use the script method format to call the Hello and Goodbye functions.
The sixth and seventh commands call the functions by specifying the function name and parameter value.
-------------------------- EXAMPLE 6 --------------------------
C:\PS>new-module -scriptblock {function SayHello {"Hello, World!"}; SayHello} -returnResult
Hello, World!
Description
-----------
This command uses the ReturnResult parameter to request the results of running the script block instead of requesting a module object.
The script block in the new module defines the SayHello function and then calls the function.