salt.modules.win_dism module¶

Install features/packages for Windows using DISM, which is useful for minions not running server versions of Windows. Some functions are only available on Windows 10.

salt.modules.win_dism.add_capability(capability, source=None, limit_access=False, image=None, restart=False)¶

Install a capability

Args:

capability (str): The capability to install source (Optional[str]): The optional source of the capability. Default

is set by group policy and can be Windows Update.

limit_access (Optional[bool]): Prevent DISM from contacting Windows

Update for the source package

image (Optional[str]): The path to the root directory of an offline

Windows image. If None is passed, the running operating system is targeted. Default is None.

restart (Optional[bool]): Reboot the machine if required by the install

Raises:

NotImplementedError: For all versions of Windows that are not Windows 10 and later. Server editions of Windows use ServerManager instead.

Returns:

dict: A dictionary containing the results of the command

CLI Example:

salt '*' dism.add_capability Tools.Graphics.DirectX~~~~0.0.1.0

salt.modules.win_dism.add_feature(feature, package=None, source=None, limit_access=False, enable_parent=False, image=None, restart=False)¶

Install a feature using DISM

Args:

feature (str): The feature to install package (Optional[str]): The parent package for the feature. You do not

have to specify the package if it is the Windows Foundation Package. Otherwise, use package to specify the parent package of the feature

source (Optional[str]): The optional source of the capability. Default

is set by group policy and can be Windows Update

limit_access (Optional[bool]): Prevent DISM from contacting Windows

Update for the source package

enable_parent (Optional[bool]): True will enable all parent features of

the specified feature

image (Optional[str]): The path to the root directory of an offline

Windows image. If None is passed, the running operating system is targeted. Default is None.

restart (Optional[bool]): Reboot the machine if required by the install

Returns:

dict: A dictionary containing the results of the command

CLI Example:

salt '*' dism.add_feature NetFx3

salt.modules.win_dism.add_package(package, ignore_check=False, prevent_pending=False, image=None, restart=False)¶

Install a package using DISM

Args:

package (str): The package to install. Can be a .cab file, a .msu file,

or a folder

ignore_check (Optional[bool]): Skip installation of the package if the

applicability checks fail

prevent_pending (Optional[bool]): Skip the installation of the package

if there are pending online actions

image (Optional[str]): The path to the root directory of an offline

Windows image. If None is passed, the running operating system is targeted. Default is None.

restart (Optional[bool]): Reboot the machine if required by the install

Returns:

dict: A dictionary containing the results of the command

CLI Example:

salt '*' dism.add_package C:\Packages\package.cab

salt.modules.win_dism.available_capabilities(image=None)¶

List the capabilities available on the system

Args:

image (Optional[str]): The path to the root directory of an offline

Windows image. If None is passed, the running operating system is targeted. Default is None.

Raises:

NotImplementedError: For all versions of Windows that are not Windows 10 and later. Server editions of Windows use ServerManager instead.

Returns:

list: A list of available capabilities

CLI Example:

salt '*' dism.installed_capabilities

salt.modules.win_dism.available_features(image=None)¶

List the features available on the system

Args:

image (Optional[str]): The path to the root directory of an offline

Windows image. If None is passed, the running operating system is targeted. Default is None.

Returns:

list: A list of available features

CLI Example:

salt '*' dism.available_features

salt.modules.win_dism.get_capabilities(image=None)¶

List all capabilities on the system

Args:

image (Optional[str]): The path to the root directory of an offline

Windows image. If None is passed, the running operating system is targeted. Default is None.

Raises:

NotImplementedError: For all versions of Windows that are not Windows 10 and later. Server editions of Windows use ServerManager instead.

Returns:

list: A list of capabilities

CLI Example:

salt '*' dism.get_capabilities

salt.modules.win_dism.get_features(package=None, image=None)¶

List features on the system or in a package

Args:

package (Optional[str]): The full path to the package. Can be either a

.cab file or a folder. Should point to the original source of the package, not to where the file is installed. You cannot use this command to get package information for .msu files

This can also be the name of a package as listed in dism.installed_packages

image (Optional[str]): The path to the root directory of an offline

Windows image. If None is passed, the running operating system is targeted. Default is None.

Returns:

list: A list of features

CLI Example:

# Return all features on the system
salt '*' dism.get_features

# Return all features in package.cab
salt '*' dism.get_features C:\packages\package.cab

# Return all features in the calc package
salt '*' dism.get_features Microsoft.Windows.Calc.Demo~6595b6144ccf1df~x86~en~1.0.0.0

salt.modules.win_dism.installed_capabilities(image=None)¶

List the capabilities installed on the system

Args:

image (Optional[str]): The path to the root directory of an offline

Windows image. If None is passed, the running operating system is targeted. Default is None.

Raises:

NotImplementedError: For all versions of Windows that are not Windows 10 and later. Server editions of Windows use ServerManager instead.

Returns:

list: A list of installed capabilities

CLI Example:

salt '*' dism.installed_capabilities

salt.modules.win_dism.installed_features(image=None)¶

List the features installed on the system

Args:

image (Optional[str]): The path to the root directory of an offline

Windows image. If None is passed, the running operating system is targeted. Default is None.

Returns:

list: A list of installed features

CLI Example:

salt '*' dism.installed_features

salt.modules.win_dism.installed_packages(image=None)¶

List the packages installed on the system

Args:

image (Optional[str]): The path to the root directory of an offline

Windows image. If None is passed, the running operating system is targeted. Default is None.

Returns:

list: A list of installed packages

CLI Example:

salt '*' dism.installed_packages

salt.modules.win_dism.package_info(package, image=None)¶

Display information about a package

Args:

package (str): The full path to the package. Can be either a .cab file

or a folder. Should point to the original source of the package, not to where the file is installed. You cannot use this command to get package information for .msu files

image (Optional[str]): The path to the root directory of an offline

Windows image. If None is passed, the running operating system is targeted. Default is None.

Returns:

dict: A dictionary containing the results of the command

CLI Example:

salt '*' dism. package_info C:\packages\package.cab

salt.modules.win_dism.remove_capability(capability, image=None, restart=False)¶

Uninstall a capability

Args:

capability(str): The capability to be removed image (Optional[str]): The path to the root directory of an offline

Windows image. If None is passed, the running operating system is targeted. Default is None.

restart (Optional[bool]): Reboot the machine if required by the install

Raises:

NotImplementedError: For all versions of Windows that are not Windows 10 and later. Server editions of Windows use ServerManager instead.

Returns:

dict: A dictionary containing the results of the command

CLI Example:

salt '*' dism.remove_capability Tools.Graphics.DirectX~~~~0.0.1.0

salt.modules.win_dism.remove_feature(feature, remove_payload=False, image=None, restart=False)¶

Disables the feature.

Args:

feature (str): The feature to uninstall remove_payload (Optional[bool]): Remove the feature's payload. Must

supply source when enabling in the future.

image (Optional[str]): The path to the root directory of an offline

Windows image. If None is passed, the running operating system is targeted. Default is None.

restart (Optional[bool]): Reboot the machine if required by the install

Returns:

dict: A dictionary containing the results of the command

CLI Example:

salt '*' dism.remove_feature NetFx3

salt.modules.win_dism.remove_package(package, image=None, restart=False)¶

Uninstall a package

Args:

package (str): The full path to the package. Can be either a .cab file

or a folder. Should point to the original source of the package, not to where the file is installed. This can also be the name of a package as listed in dism.installed_packages

image (Optional[str]): The path to the root directory of an offline

Windows image. If None is passed, the running operating system is targeted. Default is None.

restart (Optional[bool]): Reboot the machine if required by the install

Returns:

dict: A dictionary containing the results of the command

CLI Example:

# Remove the Calc Package
salt '*' dism.remove_package Microsoft.Windows.Calc.Demo~6595b6144ccf1df~x86~en~1.0.0.0

# Remove the package.cab (does not remove C:\packages\package.cab)
salt '*' dism.remove_package C:\packages\package.cab