Script modules vs binary modules in PowerShell

Introduction

Modules help organize and reuse code in PowerShell. Script modules and binary modules are two ways to package code for easy sharing and use.

When you want to share reusable PowerShell functions with others.

When you need to organize your scripts into a neat package.

When you want to use compiled code for better performance.

When you want to extend PowerShell with custom commands written in .NET.

When you want to quickly write and share simple scripts without compiling.

Syntax

PowerShell

Script Module: A .psm1 file containing PowerShell functions and scripts.
Binary Module: A compiled .dll file containing cmdlets written in a .NET language.

Script modules are easy to create and edit because they are plain text files.

Binary modules require compiling code but can offer faster execution and more complex features.

Examples

This is a simple script module with one function that returns a greeting.

PowerShell

# Script Module example
function Get-Greeting {
    param([string]$Name)
    "Hello, $Name!"
}

Export-ModuleMember -Function Get-Greeting

Binary modules are compiled and loaded as DLL files. You cannot see the code directly in PowerShell.

PowerShell

# Binary Module example
# This is a compiled DLL, so no direct code here.
# You load it with Import-Module MyBinaryModule.dll

Sample Program

This example shows how to create and use a simple script module that greets a person by name.

PowerShell

# Create a script module file named GreetingModule.psm1 with this content:
function Get-Greeting {
    param([string]$Name)
    "Hello, $Name!"
}

Export-ModuleMember -Function Get-Greeting

# Then in PowerShell, run:
Import-Module ./GreetingModule.psm1
Get-Greeting -Name "Friend"

Important Notes

Script modules are great for quick development and easy sharing.

Binary modules are better when you need performance or want to use .NET features.

You can use both types together in your PowerShell environment.

Summary

Script modules are plain text files with PowerShell code.

Binary modules are compiled DLLs with cmdlets written in .NET.

Choose script modules for simplicity and binary modules for performance or advanced features.

Practice

1. Which statement best describes a PowerShell script module?

easy

A. It is a plain text file containing PowerShell functions and scripts.

B. It is a compiled DLL containing .NET cmdlets.

C. It requires Visual Studio to run.

D. It cannot be imported into a PowerShell session.

Solution

1. Step 1: Understand what a script module is

   A script module is a .psm1 file that contains PowerShell code in plain text format.

2. Step 2: Compare with other module types

   Binary modules are compiled DLLs, not plain text files, so they differ from script modules.

3. Final Answer:

   It is a plain text file containing PowerShell functions and scripts. -> Option A

4. Quick Check:

   Script module = plain text PowerShell code [OK]

Hint: Script modules are plain text files, binary are DLLs [OK]

Common Mistakes:

• Confusing script modules with binary DLL modules
• Thinking script modules require compilation
• Assuming script modules cannot be imported

2. Which of the following is the correct way to import a script module named MyModule.psm1 in PowerShell?

easy

A. Import-Module MyModule.psm1

B. Import-Module MyModule.dll

C. Load-Module MyModule.psm1

D. Add-Module MyModule.psm1

Solution

1. Step 1: Identify the correct cmdlet for importing modules

   PowerShell uses Import-Module to load both script and binary modules.

2. Step 2: Match the file extension with the module type

   Script modules use .psm1 extension, so Import-Module MyModule.psm1 is correct syntax.

3. Final Answer:

   Import-Module MyModule.psm1 -> Option A

4. Quick Check:

   Import-Module + .psm1 file = correct [OK]

Hint: Use Import-Module with .psm1 for script modules [OK]

Common Mistakes:

• Using Load-Module or Add-Module which don't exist
• Trying to import .dll as script module
• Omitting Import-Module cmdlet

3. Given the following PowerShell code, what will be the output?

Import-Module .\MyBinaryModule.dll
Get-Command -Module MyBinaryModule

medium

A. Lists all functions defined in the script module MyBinaryModule.psm1.

B. Throws an error because binary modules cannot be imported.

C. Lists all cmdlets exported by the binary module MyBinaryModule.

D. No output because Get-Command does not work with modules.

Solution

1. Step 1: Understand Import-Module with a DLL

   Importing a DLL file loads a binary module containing compiled cmdlets.

2. Step 2: Get-Command with -Module parameter

   Get-Command lists all commands exported by the specified module, here the binary module.

3. Final Answer:

   Lists all cmdlets exported by the binary module MyBinaryModule. -> Option C

4. Quick Check:

   Import DLL + Get-Command -Module = list cmdlets [OK]

Hint: Get-Command -Module lists commands from imported modules [OK]

Common Mistakes:

• Thinking binary modules cannot be imported
• Confusing script and binary module outputs
• Assuming Get-Command does not work with modules

4. You try to import a binary module using Import-Module MyModule.psm1 but get an error. What is the likely cause?

medium

A. Binary modules cannot be imported in PowerShell.

B. The module file is missing the .dll extension.

C. You must use Load-Module for binary modules.

D. The file extension .psm1 is for script modules, not binary modules.

Solution

1. Step 1: Recognize file extensions for module types

   Script modules use .psm1, binary modules use .dll files.

2. Step 2: Understand import errors

   Trying to import a binary module with a .psm1 extension causes errors because the file type is wrong.

3. Final Answer:

   The file extension .psm1 is for script modules, not binary modules. -> Option D

4. Quick Check:

   Wrong extension causes import error [OK]

Hint: Binary modules use .dll, script modules use .psm1 [OK]

Common Mistakes:

• Assuming binary modules can't be imported
• Using Load-Module instead of Import-Module
• Ignoring file extension importance

5. You want to create a PowerShell module that runs fast and includes advanced .NET features. Which module type should you choose and why?

hard

A. Script module, because it is easier to write and maintain.

B. Binary module, because it is compiled and supports advanced .NET features.

C. Script module, because it loads faster than binary modules.

D. Binary module, because script modules cannot be imported.

Solution

1. Step 1: Identify module types and their strengths

   Script modules are plain text and easy to write but slower and limited in features.

2. Step 2: Match requirements with module type

   Binary modules are compiled DLLs, run faster, and can use advanced .NET features.

3. Final Answer:

   Binary module, because it is compiled and supports advanced .NET features. -> Option B

4. Quick Check:

   Performance + advanced features = binary module [OK]

Hint: Use binary modules for speed and .NET features [OK]

Common Mistakes:

• Choosing script modules for performance needs
• Thinking script modules load faster
• Believing binary modules cannot be imported