Module creation basics in PowerShell

Introduction

Modules help you organize your PowerShell scripts into reusable packages. They make sharing and using your code easier.

You want to reuse the same functions in different scripts without copying code.

You want to share your scripts with friends or coworkers in a clean way.

You want to keep your scripts organized and easy to maintain.

You want to load only the code you need when you start PowerShell.

You want to create a library of tools for your daily tasks.

Syntax

PowerShell

New-Module -ScriptBlock { <commands> }
# Or create a .psm1 file with functions and import it using Import-Module

A module is usually a .psm1 file containing functions and code.

Use Import-Module to load your module into the current session.

Examples

This example shows how to write a function in a module file and then import and use it.

PowerShell

# Create a simple module file
function Get-Hello {
    "Hello, world!"
}

# Save this as HelloModule.psm1

# Then import it
Import-Module ./HelloModule.psm1

# Use the function
Get-Hello

This example creates a module in memory, which loads it automatically into the session.

PowerShell

# Create a module on the fly
$mod = New-Module -ScriptBlock {
    function Get-Time {
        Get-Date
    }
    Export-ModuleMember -Function Get-Time
}

# The module is loaded automatically

# Use the function
Get-Time

Sample Program

This script shows how to create a simple module with a greeting function, import it, and call the function with a parameter.

PowerShell

# Create a module file named MyTools.psm1
function Get-Greeting {
    param([string]$Name = "Friend")
    "Hello, $Name!"
}

# Save the above in MyTools.psm1

# Now in PowerShell session:
Import-Module ./MyTools.psm1

# Call the function
Get-Greeting -Name "Alice"

Important Notes

Module files must have the extension .psm1 to be recognized as modules.

Place your module files in a folder named after the module for better organization.

Use Export-ModuleMember inside your .psm1 file to control which functions are visible outside.

Summary

Modules package your PowerShell functions for reuse and sharing.

Create a .psm1 file with your functions and import it using Import-Module.

Modules keep your scripts clean and easy to manage.

Practice

1. What is the main purpose of creating a PowerShell module?

easy

A. To store variables permanently

B. To run scripts faster

C. To create graphical user interfaces

D. To package functions for reuse and sharing

Solution

1. Step 1: Understand module purpose

   PowerShell modules are designed to group functions and scripts for reuse.

2. Step 2: Identify correct purpose

   Among the options, only packaging functions for reuse and sharing matches the module's main goal.

3. Final Answer:

   To package functions for reuse and sharing -> Option D

4. Quick Check:

   Module purpose = Package functions [OK]

Hint: Modules bundle functions to reuse easily [OK]

Common Mistakes:

• Thinking modules speed up script execution
• Confusing modules with GUI tools
• Believing modules store variables permanently

2. Which file extension is used for a PowerShell module file containing functions?

easy

A. .psm1

B. .dll

C. .exe

D. .ps1

Solution

1. Step 1: Recall PowerShell module file types

   PowerShell modules that contain functions use the .psm1 extension.

2. Step 2: Compare options

   .ps1 is a script file, .exe and .dll are binary files, so .psm1 is correct.

3. Final Answer:

   .psm1 -> Option A

4. Quick Check:

   Module file extension = .psm1 [OK]

Hint: Modules use .psm1 files, not .ps1 scripts [OK]

Common Mistakes:

• Using .ps1 instead of .psm1 for modules
• Confusing .dll or .exe as module files
• Thinking .psm1 is a script file

3. Given this module file MyModule.psm1 with function Get-Greeting defined as:

function Get-Greeting { "Hello, World!" }

What is the output after running these commands?

Import-Module .\MyModule.psm1
Get-Greeting

medium

A. Import-Module : Cannot find path

B. Get-Greeting : The term 'Get-Greeting' is not recognized

C. Hello, World!

D. Hello World!

Solution

1. Step 1: Understand Import-Module effect

   Import-Module loads functions from the .psm1 file, making Get-Greeting available.

2. Step 2: Check function output

   Get-Greeting returns Hello, World! exactly as defined.

3. Final Answer:

   Hello, World! -> Option C

4. Quick Check:

   Import-Module loads function, output = Hello, World! [OK]

Hint: Import module first, then call function for output [OK]

Common Mistakes:

• Forgetting to import the module before calling function
• Expecting 'Hello World!' without comma
• Typos in function name causing errors

4. You wrote a module file Utils.psm1 with a function but when you run Import-Module .\Utils.psm1, you get an error: "Cannot load module because of a syntax error." What is a common cause?

medium

A. The module file has a missing closing brace '}' in the function

B. The module file is saved with .ps1 extension

C. You forgot to run PowerShell as administrator

D. The function name is too long

Solution

1. Step 1: Identify syntax error causes in module files

   Missing closing braces in functions cause syntax errors preventing module import.

2. Step 2: Evaluate other options

   .ps1 extension is wrong but causes different error; admin rights or function name length do not cause syntax errors.

3. Final Answer:

   The module file has a missing closing brace '}' in the function -> Option A

4. Quick Check:

   Syntax error = missing brace [OK]

Hint: Check braces and syntax carefully in .psm1 files [OK]

Common Mistakes:

• Confusing file extension errors with syntax errors
• Assuming admin rights fix syntax errors
• Ignoring missing braces or parentheses

5. You want to create a PowerShell module that contains two functions: Get-DateInfo and Get-UserInfo. Which is the correct way to organize and import these functions?

hard

A. Create separate .ps1 files for each function and run them directly

B. Put both functions in a single .psm1 file and import it with Import-Module

C. Put both functions in a .psm1 file but call them without importing the module

D. Create a .dll file containing the functions and import it with Import-Module

Solution

1. Step 1: Understand module organization

   PowerShell modules typically group related functions in one .psm1 file for easy import.

2. Step 2: Evaluate import method

   Import-Module loads the .psm1 file, making all functions available; running .ps1 files directly is not modular.

3. Final Answer:

   Put both functions in a single .psm1 file and import it with Import-Module -> Option B

4. Quick Check:

   Functions grouped in .psm1, import module [OK]

Hint: Group functions in one .psm1 file, then import [OK]

Common Mistakes:

• Running .ps1 files instead of importing modules
• Calling functions without importing module first
• Trying to use .dll files without compiling