Class: Ansible::Ruby::Modules::Win_package

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Win_package

Defined in:

lib/ansible/ruby/modules/generated/windows/win_package.rb

Overview

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.

Instance Method Summary

• #arguments ⇒ Array<String>, ...

  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.

• #creates_path ⇒ String^?

  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 C(product_id) and other C(creates_*).

• #creates_service ⇒ Object^?

  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_*).

• #creates_version ⇒ Float^?

  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_*).

• #expected_return_code ⇒ Array<String>, ...

  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 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).

• #password ⇒ Object^?

  The password for C(user_name), must be set when C(user_name) is.

• #path ⇒ String^?

  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.

• #product_id ⇒ String^?

  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:SoftwareMicrosoftWindowsCurrentVersionUninstall) or for 32 bit programs at C(HKLM:SoftwareWow6432NodeMicrosoftWindowsCurrentVersionUninstall).,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.

• #state ⇒ String^?

  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.

• #username ⇒ Object^?

  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.

• #validate_certs ⇒ :yes, ...

  If C(no), SSL certificates will not be validated.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#arguments ⇒ Array<String>, ...

Returns 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.

Returns:

• (Array<String>, String, nil) —

  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.

# File 'lib/ansible/ruby/modules/generated/windows/win_package.rb', line 14

attribute :arguments

#creates_path ⇒ String^?

Returns 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 C(product_id) and other C(creates_*).

Returns:

• (String, nil) —

  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 C(product_id) and other C(creates_*).

# File 'lib/ansible/ruby/modules/generated/windows/win_package.rb', line 18

attribute :creates_path

#creates_service ⇒ Object^?

Returns 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_*).

Returns:

• (Object, nil) —

  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_*).

# File 'lib/ansible/ruby/modules/generated/windows/win_package.rb', line 22

attribute :creates_service

#creates_version ⇒ Float^?

Returns 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_*).

Returns:

• (Float, nil) —

  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_*).

# File 'lib/ansible/ruby/modules/generated/windows/win_package.rb', line 25

attribute :creates_version

#expected_return_code ⇒ Array<String>, ...

Returns 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 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).

Returns:

• (Array<String>, String, nil) —

  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 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).

# File 'lib/ansible/ruby/modules/generated/windows/win_package.rb', line 29

attribute :expected_return_code

#password ⇒ Object^?

Returns The password for C(user_name), must be set when C(user_name) is.

Returns:

• (Object, nil) —

  The password for C(user_name), must be set when C(user_name) is.

# File 'lib/ansible/ruby/modules/generated/windows/win_package.rb', line 33

attribute :password

#path ⇒ String^?

Returns 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.

Returns:

• (String, nil) —

  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.

# File 'lib/ansible/ruby/modules/generated/windows/win_package.rb', line 36

attribute :path

#product_id ⇒ String^?

Returns 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:SoftwareMicrosoftWindowsCurrentVersionUninstall) or for 32 bit programs at C(HKLM:SoftwareWow6432NodeMicrosoftWindowsCurrentVersionUninstall).,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.

Returns:

• (String, nil) —

  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:SoftwareMicrosoftWindowsCurrentVersionUninstall) or for 32 bit programs at C(HKLM:SoftwareWow6432NodeMicrosoftWindowsCurrentVersionUninstall).,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.

# File 'lib/ansible/ruby/modules/generated/windows/win_package.rb', line 40

attribute :product_id

#state ⇒ String^?

Returns 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.

Returns:

• (String, nil) —

  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.

# File 'lib/ansible/ruby/modules/generated/windows/win_package.rb', line 44

attribute :state

#username ⇒ Object^?

Returns 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.

Returns:

• (Object, nil) —

  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.

# File 'lib/ansible/ruby/modules/generated/windows/win_package.rb', line 48

attribute :username

#validate_certs ⇒ :yes, ...

Returns 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).

Returns:

• (:yes, :no, nil) —

  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).

# File 'lib/ansible/ruby/modules/generated/windows/win_package.rb', line 51

attribute :validate_certs