Module manifest (.psd1) in PowerShell - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to start a new module manifest with the correct command.

PowerShell

New-ModuleManifest -Path "MyModule.psd1" -RootModule [1]

Drag options to blanks, or click blank then click option'

AMyModule.psm1

BMyModule.psd1

CMyModule.psm2

DMyModule.psm0

Attempts:

3 left

💡 Hint

Common Mistakes

Using the manifest file (.psd1) as the root module.

Using incorrect file extensions like .psm2 or .psm0.

The -RootModule parameter should point to the main module file, which usually has the extension .psm1.

2fill in blank

medium

Complete the code to specify the module version in the manifest.

PowerShell

@{
  ModuleVersion = '[1]'
}

Drag options to blanks, or click blank then click option'

Aone

Bv1

Cversion1

D1.0

Attempts:

3 left

💡 Hint

Common Mistakes

Using non-numeric version strings.

Omitting the version or using invalid formats.

The ModuleVersion should be a string with a numeric version format like 1.0.

3fill in blank

hard

Fix the error in the manifest snippet by completing the key name correctly.

PowerShell

@{
  [1] = 'MyModule'
}

Drag options to blanks, or click blank then click option'

AModuleName

BNameModule

CModule_Name

DModName

Attempts:

3 left

💡 Hint

Common Mistakes

Using incorrect key names like 'NameModule' or 'ModName'.

Adding underscores in the key name.

The correct key for the module name in a manifest is ModuleName.

4fill in blank

hard

Fill both blanks to define the author and description in the manifest.

PowerShell

@{
  Author = '[1]'
  Description = '[2]'
}

Drag options to blanks, or click blank then click option'

AJohn Doe

BJane Smith

CSample module for automation

DTest module

Attempts:

3 left

💡 Hint

Common Mistakes

Swapping author and description values.

Using empty or too short descriptions.

The Author is usually a person's name, and Description is a short text about the module.

5fill in blank

hard

Fill all three blanks to create a hashtable with required fields: RootModule, ModuleVersion, and GUID.

PowerShell

@{
  RootModule = '[1]'
  ModuleVersion = '[2]'
  GUID = '[3]'
}

Drag options to blanks, or click blank then click option'

AMyModule.psm1

B1.0.0

C12345678-1234-1234-1234-123456789abc

DMyModule.psd1

Attempts:

3 left

💡 Hint

Common Mistakes

Using the manifest file as RootModule.

Using invalid version formats.

Using incorrect GUID format.

The RootModule points to the main script file, ModuleVersion is the version string, and GUID is a unique identifier in standard format.

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