Documentation

win_msi - Installs and uninstalls Windows MSI files

New in version 1.7.

DEPRECATED

Removed in Ansible:
 version: 2.8
Why:The win_msi module has a number of issues, the win_package module is easier to maintain and use.
Alternative:Use win_package instead.

Synopsis

  • Installs or uninstalls a Windows MSI file that is already located on the target server.

Parameters

Parameter Choices/Defaults Comments
creates
Path to a file created by installing the MSI to prevent from attempting to reinstall the package on every run.
extra_args
Additional arguments to pass to the msiexec.exe command.
path
required
File system path to the MSI file to install.
removes
(added in 2.4)
Path to a file removed by uninstalling the MSI to prevent from attempting to re-uninstall the package on every run.
state
    Choices:
  • absent
  • present ←
Whether the MSI file should be installed or uninstalled.
wait
(added in 2.1)
    Choices:
  • no ←
  • yes
Specify whether to wait for install or uninstall to complete before continuing.

Notes

Note

  • This module is not idempotent and will report a change every time. Use the creates and removes options to your advantage.
  • Please look into win_package instead, this package will be deprecated in the future.

Examples

- name: Install an MSI file
  win_msi:
    path: C:\7z920-x64.msi

- name: Install an MSI, and wait for it to complete before continuing
  win_msi:
    path: C:\7z920-x64.msi
    wait: yes

- name: Uninstall an MSI file
  win_msi:
    path: C:\7z920-x64.msi
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
log
string
 always
The logged output from the installer

Sample:
N/A


Status

This module is flagged as deprecated and will be removed in version 2.8. For more information see DEPRECATED.

Author

  • Matt Martz (@sivel)

Hint

If you notice any issues in this documentation you can edit this document to improve it.