Module manifest (.psd1) in PowerShell - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a PowerShell module manifest (.psd1 file)?

A module manifest is a special file in PowerShell that describes the contents and settings of a module. It helps PowerShell know what files belong to the module, its version, author, and other important details.

beginner

Which cmdlet is used to create a new module manifest in PowerShell?

The cmdlet <code>New-ModuleManifest</code> is used to create a new module manifest file (.psd1). It guides you to specify details like module version, author, and required modules.

intermediate

Name three key properties you can define in a PowerShell module manifest.

Three key properties are:

• ModuleVersion: The version number of the module.
• Author: The creator of the module.
• FunctionsToExport: The list of functions the module makes available to users.

intermediate

Why should you use a module manifest instead of just a script file for your PowerShell module?

A module manifest helps organize your module by listing all parts, controlling what is visible to users, specifying dependencies, and providing metadata. This makes your module easier to maintain and share.

advanced

What happens if you set FunctionsToExport to @() in a module manifest?

Setting FunctionsToExport to an empty array @() means no functions will be exported from the module. Users won’t be able to call any functions directly from the module.

What file extension does a PowerShell module manifest use?

A .ps1

B .psd1

C .psm1

D .psm

A PowerShell module manifest file always uses the .psd1 extension.

Which cmdlet creates a new module manifest?

A New-ModuleManifest

B New-Module

C New-ScriptManifest

D New-ManifestFile

The cmdlet New-ModuleManifest is designed to create a new module manifest file.

What does the RequiredModules property in a manifest specify?

A Functions to export

B The version of PowerShell required

C The author of the module

D Modules that must be installed before this module works

RequiredModules lists other modules that need to be present for this module to function properly.

If you want to hide all functions from users, what should you set FunctionsToExport to?

A @()

B $null

C '*'

D Leave it empty

Setting FunctionsToExport to an empty array @() exports no functions, hiding them from users.

Which property in a manifest file specifies the module's version?

A ManifestVersion

B Version

C ModuleVersion

D ModuleNumber

ModuleVersion is the property used to specify the version of the module.

Explain what a PowerShell module manifest (.psd1) file is and why it is useful.

Think about how a manifest helps PowerShell understand your module.

List and describe at least three important properties you can set in a PowerShell module manifest.

Focus on properties that control module info and behavior.

Practice

1. What is the primary purpose of a PowerShell module manifest (.psd1)?

easy

A. To store user credentials for the module

B. To execute the module's main script

C. To describe the module's metadata and control its behavior

D. To compile the module into an executable file

Solution

1. Step 1: Understand what a module manifest is

   A module manifest is a file that contains metadata about the module, such as version, author, and dependencies.

2. Step 2: Identify the manifest's role

   It controls what parts of the module are visible and required, helping users understand and use the module properly.

3. Final Answer:

   To describe the module's metadata and control its behavior -> Option C

4. Quick Check:

   Manifest = metadata and control [OK]

Hint: Manifest files describe modules, not run code [OK]

Common Mistakes:

• Thinking the manifest runs the module code
• Confusing manifest with script files
• Assuming manifest stores credentials

2. Which of the following is the correct syntax to specify the module version in a .psd1 manifest file?

easy

A. 'ModuleVersion' = '1.0.0'

B. ModuleVersion: 1.0.0

C. ModuleVersion = 1.0.0

D. "ModuleVersion" : "1.0.0"

Solution

1. Step 1: Recall .psd1 file syntax

   A .psd1 file uses a hashtable syntax with key-value pairs, where keys are strings in quotes and values are assigned with '='.

2. Step 2: Match correct syntax for version

   The correct syntax is a string key in quotes, an equals sign, and the version string in quotes: 'ModuleVersion' = '1.0.0'

3. Final Answer:

   'ModuleVersion' = '1.0.0' -> Option A

4. Quick Check:

   Hashtable key-value with '=' and quotes [OK]

Hint: Use quotes and '=' for keys and values in .psd1 [OK]

Common Mistakes:

• Using colon instead of equals sign
• Omitting quotes around keys or values
• Using JSON style syntax

3. Given this snippet from a module manifest (.psd1):

@{
  RootModule = 'MyModule.psm1'
  ModuleVersion = '2.1.0'
  FunctionsToExport = @('Get-Data', 'Set-Data')
}

What will happen when you import this module?

medium

A. Only the functions 'Get-Data' and 'Set-Data' will be available to the user

B. All functions in MyModule.psm1 will be available regardless of FunctionsToExport

C. The module will fail to import due to syntax error

D. The module version will be ignored during import

Solution

1. Step 1: Understand FunctionsToExport key

   The FunctionsToExport key lists which functions are visible outside the module when imported.

2. Step 2: Analyze the effect on import

   Only 'Get-Data' and 'Set-Data' will be exported and accessible to users after import.

3. Final Answer:

   Only the functions 'Get-Data' and 'Set-Data' will be available to the user -> Option A

4. Quick Check:

   FunctionsToExport limits visible functions [OK]

Hint: FunctionsToExport controls visible functions [OK]

Common Mistakes:

• Assuming all functions export by default
• Thinking syntax error exists here
• Ignoring FunctionsToExport effect

4. You wrote this in your module manifest (.psd1):

@{
  RootModule = 'MyModule.psm1'
  FunctionsToExport = 'Get-Data', 'Set-Data'
}

When importing the module, you get an error. What is the problem?

medium

A. The manifest file must not contain RootModule key

B. RootModule must be a script file, not a module file

C. FunctionsToExport cannot contain more than one function

D. FunctionsToExport should be an array, not a list of strings without @()

Solution

1. Step 1: Check FunctionsToExport syntax

   FunctionsToExport expects an array of strings, which requires the @() syntax in PowerShell.

2. Step 2: Identify the error cause

   Writing 'Get-Data', 'Set-Data' without @() is invalid in a hashtable value and causes an error.

3. Final Answer:

   FunctionsToExport should be an array, not a list of strings without @() -> Option D

4. Quick Check:

   Use @() for arrays in manifest [OK]

Hint: Use @() to define arrays in .psd1 manifest [OK]

Common Mistakes:

• Omitting @() for arrays
• Misunderstanding RootModule usage
• Assuming single string can list multiple functions

5. You want your PowerShell module to automatically import a required module and only export one function named 'Invoke-Task'. Which manifest entries should you include?

hard

A. @{ RequiredModules = 'HelperModule'; FunctionsToExport = @('Invoke-Task') }

B. @{ RequiredModules = @('HelperModule'); FunctionsToExport = @('Invoke-Task') }

C. @{ RequiredModules = @('HelperModule'); FunctionsToExport = 'Invoke-Task' }

D. @{ RequiredModules = 'HelperModule'; FunctionsToExport = 'Invoke-Task' }

Solution

1. Step 1: Define RequiredModules correctly

   RequiredModules must be an array of module names, so use @('HelperModule').

2. Step 2: Define FunctionsToExport correctly

   FunctionsToExport must be an array of function names, so use @('Invoke-Task').

3. Final Answer:

   @{ RequiredModules = @('HelperModule'); FunctionsToExport = @('Invoke-Task') } -> Option B

4. Quick Check:

   Use arrays (@()) for RequiredModules and FunctionsToExport [OK]

Hint: Always use @() arrays for RequiredModules and FunctionsToExport [OK]

Common Mistakes:

• Using strings instead of arrays for RequiredModules
• Using strings instead of arrays for FunctionsToExport
• Mixing array and string syntax