Try SpotterInstalls/uninstalls an installable package
| "added in version" 1.7 of ansible.builtin"
Authors: Trond Hindenes (@trondhindenes), Jordan Borean (@jborean93)
preview | supported by core
pipInstall with pip install ansible==2.9.27
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.
- 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, and permanent log
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
log_path: D:\logs\vcredist_x64-exe-{{lookup('pipe', 'date +%Y%m%dT%H%M%S')}}.log
- 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]
path:
description:
- 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 C(user_name) and C(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 C(state=present) then this value MUST be set.
- If C(state=absent) then this value does not need to be set if C(product_id) is.
type: str
chdir:
description:
- Set the specified path as the current working directory before installing or uninstalling
a package.
type: path
version_added: '2.8'
version_added_collection: ansible.builtin
state:
aliases:
- ensure
choices:
- absent
- present
default: present
description:
- Whether to install or uninstall the package.
- The module uses C(product_id) and whether it exists at the registry path to see
whether it needs to install or uninstall the package.
type: str
log_path:
description:
- Specifies the path to a log file that is persisted after an MSI package is installed
or uninstalled.
- When omitted, a temporary log file is used for MSI packages.
- This is only valid for MSI files, use C(arguments) for other package types.
type: path
version_added: '2.8'
version_added_collection: ansible.builtin
password:
aliases:
- user_password
description:
- The password for C(user_name), must be set when C(user_name) is.
type: str
username:
aliases:
- user_name
description:
- 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.
type: str
arguments:
description:
- Any arguments the installer needs to either install or uninstall the package.
- If the package is an MSI do not supply the C(/qn), C(/log) or C(/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.
type: str
product_id:
aliases:
- productid
description:
- The product id of the installed packaged.
- This is used for checking whether the product is already installed and getting the
uninstall information if C(state=absent).
- You can find product ids for installed programs in the Windows registry editor either
at C(HKLM:Software\Microsoft\Windows\CurrentVersion\Uninstall) or for 32 bit programs
at C(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 C(creates_*) options can
be used instead but is not recommended.
type: str
creates_path:
description:
- Will check the existence of the path specified and use the result to determine whether
the package is already installed.
- You can use this in conjunction with C(product_id) and other C(creates_*).
type: path
version_added: '2.4'
version_added_collection: ansible.builtin
validate_certs:
default: true
description:
- If C(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 C(no).
type: bool
version_added: '2.4'
version_added_collection: ansible.builtin
creates_service:
description:
- 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 C(product_id) and other C(creates_*).
type: str
version_added: '2.4'
version_added_collection: ansible.builtin
creates_version:
description:
- Will check the file version property of the file at C(creates_path) and use the
result to determine whether the package is already installed.
- C(creates_path) MUST be set and is a file.
- You can use this in conjunction with C(product_id) and other C(creates_*).
type: str
version_added: '2.4'
version_added_collection: ansible.builtin
expected_return_code:
default:
- 0
- 3010
description:
- One or more return codes from the package installation that indicates success.
- Before Ansible 2.4 this was just 0 but since Ansible 2.4 this is both C(0) and C(3010).
- A return code of C(3010) usually means that a reboot is required, the C(reboot_required)
return value is set if the return code is C(3010).
type: list
log:
description: The contents of the MSI log.
returned: installation/uninstallation failure for MSI packages
sample: Installation completed successfully
type: str
rc:
description: The return code of the package process.
returned: change occurred
sample: 0
type: int
reboot_required:
description: Whether a reboot is required to finalise package. This is set to true
if the executable return code is 3010.
returned: always
sample: true
type: bool
stderr:
description: The stderr stream of the package process.
returned: failure during install or uninstall
sample: Failed to install program
type: str
stdout:
description: The stdout stream of the package process.
returned: failure during install or uninstall
sample: Installing program
type: str