Operating System Module Servicing Command-Line Options (Standard 8)

7/8/2014

Review the operating system module servicing command-line options for Deployment Image Servicing and Management (DISM) in Windows Embedded 8 Standard (Standard 8).

Operating system module-servicing commands can be used to add embedded modules to an image, remove them from an image, or list the modules in an image or catalog. Embedded modules can contain CBS packages, custom payloads, applications, and other modules from Microsoft or third-party vendors.

The following is the base syntax for servicing a Windows image using DISM:

DISM {**/Image:**path_to_image_directory | /Online} [dism_options] {servicing_command} [servicing_argument]

The following operating system module-servicing options are available for use with an offline image:

DISM/Image:path_to_image_directory [/Add-Module | /Get-Modules | /Remove-Module]

The following operating system module-servicing options are available for use with a running operating system:

DISM/Online [/Add-Module | /Get-Modules | /Remove-Module]

The following table provides a description of how each operating system module-servicing option can be used. These options are not case sensitive.

Option

Argument

Description

/Get-Help

/?

Displays information about available DISM command-line options and arguments. When used immediately after a command-line option, information about the option and its arguments is displayed.

Additional topics might become available when an image is specified.

/Add-Module

/ModulePath:path_to_module(s)

/IgnoreSignatures

/IgnoreCheck

Adds one or more modules to an image. Use the /ModulePath argument to point to a single .emd file or a directory that contains multiple .emd files.

Use the /IgnoreSignatures argument to allow unsigned modules to be added when servicing an online image.

Use the /IgnoreCheck flag if you want to bypass the default check for modules that might be required by the added module.

JJ963321.note(en-us,WinEmbedded.81).gifNote:
The inclusion of a module in an image without resolving any required dependencies is not supported. The functionality of the module might be partially or completely compromised, and could cause the system to become corrupted.

/Get-Modules

/Format:List | Table

Displays information about the modules in an image. Use the optional /Format argument to specify whether the results should be displayed as the default list or as a table.

/Remove-Module

/Module-Path:path_to_module

/Module-Name:module_name

This functionality is not yet implemented.

Removes a module from an image.

Use the /Module-Path argument to point to the location of an .emd file.

Use the /Module-Name argument to specify the module by name. You can use the /Get-Modules option to find the name of the module in the image.

Limitations

  • When you install a module in an offline image, the module is in an installation pending state because there are online actions that have not yet been completed. In other words, the module is installed when the image is booted and the online actions are processed. If subsequent actions are requested, they cannot be processed until the previous pending online action is completed.
  • Some modules require additional modules to be installed first. You should not assume that dependencies will be satisfied when the image is booted and the online actions are processed. If there are dependency requirements, you should use a configuration file to install the necessary modules. By passing a configuration file to DISM, multiple modules can be installed in the correct order. This is the preferred method for installing multiple modules.
  • Modules are installed in the order that they are listed in the command line.
  • Modules cannot be removed from an image as long as that image has online pending actions. Modules that are to be removed remain in the image until it is restarted and the pending actions can be processed, at which time the requested modules are removed.
  • Files and folders copied to a device as the payload of a custom module are marked as hidden in Windows Explorer.

See Also

Reference

Modules

Concepts

Deployment Image Servicing and Management (DISM) Command-Line Options
What Is Deployment Image Servicing and Management?
How Deployment Image Servicing and Management (DISM) Works
Windows PE Servicing Command-Line Options
Unattended Servicing Command-Line Options
Driver Servicing Command-Line Options
Operating System Package Servicing Command-Line Options
International Servicing Command-Line Options