win_package - Installs/uninstalls an installable package¶

New in version 1.7.

Synopsis
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Support
- Author

Synopsis ¶

Installs or uninstalls a package in either an MSI or EXE format.
These packages can be sources from the local file system, network file share or a url.
Please read the notes section around some caveats with this module.

Parameters ¶

Parameter	Choices/Defaults	Comments
arguments		Any arguments the installer needs to either install or uninstall the package. If the package is an MSI do not supply the `/qn`, `/log` or `/norestart` arguments. As of Ansible 2.5, this parameter can be a list of arguments and the module will escape the arguments as necessary, it is recommended to use a string when dealing with MSI packages due to the unique escaping issues with msiexec.
creates_path path (added in 2.4)		Will check the existance of the path specified and use the result to determine whether the package is already installed. You can use this in conjunction with `product_id` and other `creates_*`.
creates_service (added in 2.4)		Will check the existing of the service specified and use the result to determine whether the package is already installed. You can use this in conjunction with `product_id` and other `creates_*`.
creates_version (added in 2.4)		Will check the file version property of the file at `creates_path` and use the result to determine whether the package is already installed. `creates_path` MUST be set and is a file. You can use this in conjunction with `product_id` and other `creates_*`.
expected_return_code list	Default: [0, 3010]	One or more return codes from the package installation that indicates success. Before Ansible 2.4 this was just 0 but since 2.4 this is both `0` and `3010`. A return code of `3010` usually means that a reboot is required, the `reboot_required` return value is set if the return code is `3010`.
password		The password for `user_name`, must be set when `user_name` is. aliases: user_password
path		Location of the package to be installed or uninstalled. This package can either be on the local file system, network share or a url. If the path is on a network share and the current WinRM transport doesn't support credential delegation, then `user_name` and `user_password` must be set to access the file. There are cases where this file will be copied locally to the server so it can access it, see the notes for more info. If `state=present` then this value MUST be set. If `state=absent` then this value does not need to be set if `product_id` is.
product_id		The product id of the installed packaged. This is used for checking whether the product is already installed and getting the uninstall information if `state=absent`. You can find product ids for installed programs in the Windows registry editor either at `HKLM:Software\Microsoft\Windows\CurrentVersion\Uninstall` or for 32 bit programs at `HKLM:Software\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall`. This SHOULD be set when the package is not an MSI, or the path is a url or a network share and credential delegation is not being used. The `creates_*` options can be used instead but is not recommended. aliases: productid
state	Default: present	Whether to install or uninstall the package. The module uses `product_id` and whether it exists at the registry path to see whether it needs to install or uninstall the package. aliases: ensure
username		Username of an account with access to the package if it is located on a file share. This is only needed if the WinRM transport is over an auth method that does not support credential delegation like Basic or NTLM. aliases: user_name
validate_certs bool (added in 2.4)	Choices: no yes ←	If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Before Ansible 2.4 this defaulted to `no`.

Notes ¶

Note

For non Windows targets, use the package module instead.
When state=absent and the product is an exe, the path may be different from what was used to install the package originally. If path is not set then the path used will be what is set under UninstallString in the registry for that product_id.
Not all product ids are in a GUID form, some programs incorrectly use a different structure but this module should support any format.
By default all msi installs and uninstalls will be run with the options /log, /qn, /norestart.
It is recommended you download the package first from the URL using the win_get_url module as it opens up more flexibility with what must be set when calling win_package.
Packages will be temporarily downloaded or copied locally when path is a network location and credential delegation is not set, or path is a URL and the file is not an MSI.
All the installation checks under product_id and creates_* add together, if one fails then the program is considered to be absent.

Examples ¶

- name: Install the Visual C thingy
  win_package:
    path: http://download.microsoft.com/download/1/6/B/16B06F60-3B20-4FF2-B699-5E9B7962F9AE/VSU_4/vcredist_x64.exe
    product_id: '{CF2BEA3C-26EA-32F8-AA9B-331F7E34BA97}'
    arguments: /install /passive /norestart

- name: Install Visual C thingy with list of arguments instead of a string
  win_package:
    path: http://download.microsoft.com/download/1/6/B/16B06F60-3B20-4FF2-B699-5E9B7962F9AE/VSU_4/vcredist_x64.exe
    product_id: '{CF2BEA3C-26EA-32F8-AA9B-331F7E34BA97}'
    arguments:
    - /install
    - /passive
    - /norestart

- name: Install Remote Desktop Connection Manager from msi
  win_package:
    path: https://download.microsoft.com/download/A/F/0/AF0071F3-B198-4A35-AA90-C68D103BDCCF/rdcman.msi
    product_id: '{0240359E-6A4C-4884-9E94-B397A02D893C}'
    state: present

- name: Uninstall Remote Desktop Connection Manager
  win_package:
    product_id: '{0240359E-6A4C-4884-9E94-B397A02D893C}'
    state: absent

- name: Install Remote Desktop Connection Manager locally omitting the product_id
  win_package:
    path: C:\temp\rdcman.msi
    state: present

- name: Uninstall Remote Desktop Connection Manager from local MSI omitting the product_id
  win_package:
    path: C:\temp\rdcman.msi
    state: absent

# 7-Zip exe doesn't use a guid for the Product ID
- name: Install 7zip from a network share specifying the credentials
  win_package:
    path: \\domain\programs\7z.exe
    product_id: 7-Zip
    arguments: /S
    state: present
    user_name: DOMAIN\User
    user_password: Password

- name: Install 7zip and use a file version for the installation check
  win_package:
    path: C:\temp\7z.exe
    creates_path: C:\Program Files\7-Zip\7z.exe
    creates_version: 16.04
    state: present

- name: Uninstall 7zip from the exe
  win_package:
    path: C:\Program Files\7-Zip\Uninstall.exe
    product_id: 7-Zip
    arguments: /S
    state: absent

- name: Uninstall 7zip without specifying the path
  win_package:
    product_id: 7-Zip
    arguments: /S
    state: absent

- name: Install application and override expected return codes
  win_package:
    path: https://download.microsoft.com/download/1/6/7/167F0D79-9317-48AE-AEDB-17120579F8E2/NDP451-KB2858728-x86-x64-AllOS-ENU.exe
    product_id: '{7DEBE4EB-6B40-3766-BB35-5CBBC385DA37}'
    arguments: '/q /norestart'
    state: present
    expected_return_code: [0, 666, 3010]

Return Values ¶

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

Key	Returned	Description
exit_code int	change occured	See rc, this will be removed in favour of rc in Ansible 2.6.
log str	change occured and package is an MSI	The contents of the MSI log. Sample: Installation completed successfully
rc int	change occured	The return code of the package process.
reboot_required bool	always	Whether a reboot is required to finalise package. This is set to true if the executable return code is 3010. Sample: True
restart_required bool	always	See reboot_required, this will be removed in favour of reboot_required in Ansible 2.6 Sample: True
stderr str	failure during install or uninstall	The stderr stream of the package process. Sample: Failed to install program
stdout str	failure during install or uninstall	The stdout stream of the package process. Sample: Installing program

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as core which means that it is maintained by the Ansible Core Team. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Core Team, see here.

Support ¶

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author ¶

Trond Hindenes (@trondhindenes)
Jordan Borean (@jborean93)

Hint

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