Try SpotterInstalls/uninstalls an installable package
Authors: Trond Hindenes (@trondhindenes), Jordan Borean (@jborean93)
Install with ansible-galaxy collection install ansible.windows:==2.3.0
collections:
- name: ansible.windows
version: 2.3.0Installs or uninstalls software packages for Windows.
Supports C(.exe), C(.msi), C(.msp), C(.appx), C(.appxbundle), C(.msix), and C(.msixbundle).
These packages can be sourced from the local file system, network file share or a url.
See I(provider) for more info on each package type that is supported.
- name: Install the Visual C thingy
ansible.windows.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
ansible.windows.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 MSBuild thingy with arguments split to prevent quotes
ansible.windows.win_package:
path: https://download.visualstudio.microsoft.com/download/pr/9665567e-f580-4acd-85f2-bc94a1db745f/vs_BuildTools.exe
product_id: '{D1437F51-786A-4F57-A99C-F8E94FBA1BD8}'
arguments:
- --norestart
- --passive
- --wait
- --add
- Microsoft.Net.Component.4.6.1.TargetingPack
- --add
- Microsoft.Net.Component.4.6.TargetingPack
- name: Install Remote Desktop Connection Manager from msi with a permanent log
ansible.windows.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
log_path: D:\logs\vcredist_x64-exe-{{lookup('pipe', 'date +%Y%m%dT%H%M%S')}}.log
- name: Install Application from msi with multiple properties for installer
ansible.windows.win_package:
path: C:\temp\Application.msi
state: present
arguments: >-
SERVICE=1
DBNAME=ApplicationDB
DBSERVER=.\SQLEXPRESS
INSTALLDIR="C:\Program Files (x86)\App lication\App Server"
- name: Install Microsoft® SQL Server® 2019 Express (DPAPI example)
ansible.windows.win_package:
path: C:\temp\SQLEXPR_x64_ENU\SETUP.EXE
product_id: Microsoft SQL Server SQL2019
arguments:
- SAPWD=VeryHardPassword
- /ConfigurationFile=C:\temp\configuration.ini
become: true
vars:
ansible_become_method: runas
ansible_become_user: "{{ user }}"
ansible_become_pass: "{{ password }}"
- name: Uninstall Remote Desktop Connection Manager
ansible.windows.win_package:
product_id: '{0240359E-6A4C-4884-9E94-B397A02D893C}'
state: absent
- name: Install Remote Desktop Connection Manager locally omitting the product_id
ansible.windows.win_package:
path: C:\temp\rdcman.msi
state: present
- name: Uninstall Remote Desktop Connection Manager from local MSI omitting the product_id
ansible.windows.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 with specific credentials
ansible.windows.win_package:
path: \\domain\programs\7z.exe
product_id: 7-Zip
arguments: /S
state: present
become: true
become_method: runas
become_flags: logon_type=new_credential logon_flags=netcredentials_only
vars:
ansible_become_user: DOMAIN\User
ansible_become_password: Password
- name: Install 7zip and use a file version for the installation check
ansible.windows.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
ansible.windows.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
ansible.windows.win_package:
product_id: 7-Zip
arguments: /S
state: absent
- name: Install application and override expected return codes
ansible.windows.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]
- name: Install a .msp patch
ansible.windows.win_package:
path: C:\Patches\Product.msp
state: present
- name: Remove a .msp patch
ansible.windows.win_package:
product_id: '{AC76BA86-A440-FFFF-A440-0C13154E5D00}'
state: absent
- name: Enable installation of 3rd party MSIX packages
ansible.windows.win_regedit:
path: HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\AppModelUnlock
name: AllowAllTrustedApps
data: 1
type: dword
state: present
- name: Install an MSIX package for the current user
ansible.windows.win_package:
path: C:\Installers\Calculator.msix # Can be .appx, .msixbundle, or .appxbundle
state: present
- name: Uninstall an MSIX package using the product_id
ansible.windows.win_package:
product_id: InputApp
state: absent
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.
- When C(state=present), C(product_id) is not set and the path is a URL, this file
will always be downloaded to a temporary directory for idempotency checks, otherwise
the file will only be downloaded if the package has not been installed based on
the C(product_id) checks.
- 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.
- This is only used for the C(msi), C(msp), and C(registry) providers.
type: path
state:
choices:
- absent
- present
default: present
description:
- Whether to install or uninstall the package.
- The module uses I(product_id) to determine whether the package is installed or not.
- For all providers but C(auto), the I(path) can be used for idempotency checks if
it is locally accesible filesystem path.
type: str
headers:
description:
- Extra headers to set on the request.
- This should be a dictionary where the key is the header name and the value is the
value for that header.
type: dict
log_path:
description:
- Specifies the path to a log file that is persisted after a package is installed
or uninstalled.
- This is only used for the C(msi) or C(msp) provider.
- When omitted, a temporary log file is used instead for those providers.
- This is only valid for MSI files, use C(arguments) for the C(registry) provider.
type: path
provider:
choices:
- auto
- msi
- msix
- msp
- registry
default: auto
description:
- Set the package provider to use when searching for a package.
- The C(auto) provider will select the proper provider if I(path) otherwise it scans
all the other providers based on the I(product_id).
- The C(msi) provider scans for MSI packages installed on a machine wide and current
user context based on the C(ProductCode) of the MSI.
- The C(msix) provider is used to install C(.appx), C(.msix), C(.appxbundle), or C(.msixbundle)
packages. These packages are only installed or removed on the current use. The host
must be set to allow sideloaded apps or in developer mode. See the examples for
how to enable this. If a package is already installed but C(path) points to an updated
package, this will be installed over the top of the existing one.
- The C(msp) provider scans for all MSP patches installed on a machine wide and current
user context based on the C(PatchCode) of the MSP. A C(msp) will be applied or removed
on all C(msi) products that it applies to and is installed. If the patch is obsoleted
or superseded then no action will be taken.
- The C(registry) provider is used for traditional C(exe) installers and uses the
following registry path to determine if a product was installed; C(HKLM:\Software\Microsoft\Windows\CurrentVersion\Uninstall),
C(HKLM:\Software\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall), C(HKCU:\Software\Microsoft\Windows\CurrentVersion\Uninstall),
and C(HKCU:\Software\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall).
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.
- This is only used for the C(msi), C(msp), and C(registry) providers.
- 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.
- When using a list of arguments each item in the list is considered to be a single
argument. As such, if an argument in the list contains a space then Ansible will
quote this to ensure that this is seen by Windows as a single argument. Should this
behaviour not be what is required, the argument should be split into two separate
list items. See the examples section for more detail.
type: raw
proxy_url:
description:
- An explicit proxy to use for the request.
- By default, the request will use the IE defined proxy unless I(use_proxy) is set
to C(no).
type: str
use_proxy:
default: true
description:
- If C(no), it will not use the proxy defined in IE for the current user.
type: bool
http_agent:
default: ansible-httpget
description:
- Header to identify as, generally appears in web server logs.
- This is set to the C(User-Agent) header on a HTTP request.
type: str
product_id:
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).
- For msi packages, this is the C(ProductCode) (GUID) of the package. This can be
found under the same registry paths as the C(registry) provider.
- For msp packages, this is the C(PatchCode) (GUID) of the package which can found
under the C(Details -> Revision number) of the file's properties.
- For msix packages, this is the C(Name) or C(PackageFullName) of the package found
under the C(Get-AppxPackage) cmdlet.
- For registry (exe) packages, this is the registry key name under the registry paths
specified in I(provider).
- This value is ignored if C(path) is set to a local accesible file path and the package
is not an C(exe).
- This SHOULD be set when the package is an C(exe), 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
url_method:
description:
- The HTTP Method of the request.
type: str
client_cert:
description:
- The path to the client certificate (.pfx) that is used for X509 authentication.
This path can either be the path to the C(pfx) on the filesystem or the PowerShell
certificate path C(Cert:\CurrentUser\My\<thumbprint>).
- The WinRM connection must be authenticated with C(CredSSP) or C(become) is used
on the task if the certificate file is not password protected.
- Other authentication types can set I(client_cert_password) when the cert is password
protected.
type: str
url_timeout:
default: 30
description:
- Specifies how long the request can be pending before it times out (in seconds).
- Set to C(0) to specify an infinite timeout.
type: int
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
url_password:
description:
- The password for I(url_username).
type: str
url_username:
description:
- The username to use for authentication.
type: str
proxy_password:
description:
- The password for I(proxy_username).
type: str
proxy_username:
description:
- The username to use for proxy authentication.
type: str
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.
type: bool
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
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
follow_redirects:
choices:
- all
- none
- safe
default: safe
description:
- Whether or the module should follow redirects.
- C(all) will follow all redirect.
- C(none) will not follow any redirect.
- C(safe) will follow only "safe" redirects, where "safe" means that the client is
only doing a C(GET) or C(HEAD) on the URI to which it is being redirected.
- When following a redirected URL, the C(Authorization) header and any credentials
set will be dropped and not redirected.
type: str
force_basic_auth:
default: false
description:
- By default the authentication header is only sent when a webservice responses to
an initial request with a 401 status. Since some basic auth services do not properly
send a 401, logins will fail.
- This option forces the sending of the Basic authentication header upon the original
request.
type: bool
wait_for_children:
default: false
description:
- The module will wait for the process it spawns to finish but any processes spawned
in that child process as ignored.
- Set to C(true) to wait for all descendent processes to finish before the module
returns.
- This is useful if the install/uninstaller is just a wrapper which then calls the
actual installer as its own child process. When this option is C(true) then the
module will wait for both processes to finish before returning.
- This should not be required for most installers and setting to C(true) could result
in the module not returning until the process it is waiting for has been stopped
manually.
- Requires Windows Server 2012 or Windows 8 or newer to use.
type: bool
version_added: 1.3.0
version_added_collection: ansible.windows
maximum_redirection:
default: 50
description:
- Specify how many times the module will redirect a connection to an alternative URI
before the connection fails.
- If set to C(0) or I(follow_redirects) is set to C(none), or C(safe) when not doing
a C(GET) or C(HEAD) it prevents all redirection.
type: int
client_cert_password:
description:
- The password for I(client_cert) if the cert is password protected.
type: str
expected_return_code:
default:
- 0
- 3010
description:
- One or more return codes from the package installation that indicates success.
- The return codes are read as a signed integer, any values greater than 2147483647
need to be represented as the signed equivalent, i.e. C(4294967295) is C(-1).
- To convert a unsigned number to the signed equivalent you can run "[Int32]("0x{0:X}"
-f ([UInt32]3221225477))".
- 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).
- This is only used for the C(msi), C(msp), and C(registry) providers.
elements: int
type: list
use_default_credential:
default: false
description:
- Uses the current user's credentials when authenticating with a server protected
with C(NTLM), C(Kerberos), or C(Negotiate) authentication.
- Sites that use C(Basic) auth will still require explicit credentials through the
I(url_username) and I(url_password) options.
- The module will only have access to the user's credentials if using C(become) with
a password, you are connecting with SSH using a password, or connecting with WinRM
using C(CredSSP) or C(Kerberos with delegation).
- If not using C(become) or a different auth method to the ones stated above, there
will be no default credentials available and no authentication will occur.
type: bool
proxy_use_default_credential:
default: false
description:
- Uses the current user's credentials when authenticating with a proxy host protected
with C(NTLM), C(Kerberos), or C(Negotiate) authentication.
- Proxies that use C(Basic) auth will still require explicit credentials through the
I(proxy_username) and I(proxy_password) options.
- The module will only have access to the user's credentials if using C(become) with
a password, you are connecting with SSH using a password, or connecting with WinRM
using C(CredSSP) or C(Kerberos with delegation).
- If not using C(become) or a different auth method to the ones stated above, there
will be no default credentials available and no proxy authentication will occur.
type: bool
log:
description: The contents of the MSI or MSP log.
returned: installation/uninstallation failure for MSI or MSP 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