Class: Ansible::Ruby::Modules::Win_chocolatey

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb

Overview

Manage packages using Chocolatey (U(chocolatey.org/)). If Chocolatey is missing from the system, the module will install it. List of packages can be found at U(chocolatey.org/packages).

Instance Method Summary collapse

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

#allow_empty_checksums ⇒ :yes, ...

Returns Allow empty checksums to be used for downloaded resource from non-secure locations.,Use M(win_chocolatey_feature) with the name C(allowEmptyChecksums) to control this option globally.

Returns:

  • (:yes, :no, nil) —

    Allow empty checksums to be used for downloaded resource from non-secure locations.,Use M(win_chocolatey_feature) with the name C(allowEmptyChecksums) to control this option globally.



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

attribute :allow_empty_checksums

#allow_prerelease ⇒ :yes, ...

Returns Allow the installation of pre-release packages.,If I(state) is C(latest), the latest pre-release package will be installed.

Returns:

  • (:yes, :no, nil) —

    Allow the installation of pre-release packages.,If I(state) is C(latest), the latest pre-release package will be installed.



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

attribute :allow_prerelease

#architecture ⇒ :default, ...

Returns Force Chocolatey to install the package of a specific process architecture.,When setting C(x86), will ensure Chocolatey installs the x86 package even when on an x64 bit OS.

Returns:

  • (:default, :x86, nil) —

    Force Chocolatey to install the package of a specific process architecture.,When setting C(x86), will ensure Chocolatey installs the x86 package even when on an x64 bit OS.



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

attribute :architecture

#force ⇒ :yes, ...

Returns Forces the install of a package, even if it already is installed.,Using I(force) will cause Ansible to always report that a change was made.

Returns:

  • (:yes, :no, nil) —

    Forces the install of a package, even if it already is installed.,Using I(force) will cause Ansible to always report that a change was made.



26
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 26

attribute :force

#ignore_checksums ⇒ :yes, ...

Returns Ignore the checksums provided by the package.,Use M(win_chocolatey_feature) with the name C(checksumFiles) to control this option globally.

Returns:

  • (:yes, :no, nil) —

    Ignore the checksums provided by the package.,Use M(win_chocolatey_feature) with the name C(checksumFiles) to control this option globally.



34
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 34

attribute :ignore_checksums

#ignore_dependencies ⇒ :yes, ...

Returns Ignore dependencies, only install/upgrade the package itself.

Returns:

  • (:yes, :no, nil) —

    Ignore dependencies, only install/upgrade the package itself.



38
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 38

attribute :ignore_dependencies

#install_args ⇒ String?

Returns Arguments to pass to the native installer.,These are arguments that are passed directly to the installer the Chocolatey package runs, this is generally an advanced option.

Returns:

  • (String, nil) —

    Arguments to pass to the native installer.,These are arguments that are passed directly to the installer the Chocolatey package runs, this is generally an advanced option.



30
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 30

attribute :install_args

#name ⇒ Array<String>, String

Returns Name of the package(s) to be installed.,Set to C(all) to run the action on all the installed packages.

Returns:

  • (Array<String>, String) —

    Name of the package(s) to be installed.,Set to C(all) to run the action on all the installed packages.



42
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 42

attribute :name

#package_params ⇒ String?

Returns Parameters to pass to the package.,These are parameters specific to the Chocolatey package and are generally documented by the package itself.,Before Ansible 2.7, this option was just I(params).

Returns:

  • (String, nil) —

    Parameters to pass to the package.,These are parameters specific to the Chocolatey package and are generally documented by the package itself.,Before Ansible 2.7, this option was just I(params).



46
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 46

attribute :package_params

#proxy_password ⇒ String?

Returns Proxy password used to install Chocolatey and the package.,This value is exposed as a command argument and any privileged account can see this value when the module is running Chocolatey, define the password on the global config level with M(win_chocolatey_config) with name C(proxyPassword) to avoid this.

Returns:

  • (String, nil) —

    Proxy password used to install Chocolatey and the package.,This value is exposed as a command argument and any privileged account can see this value when the module is running Chocolatey, define the password on the global config level with M(win_chocolatey_config) with name C(proxyPassword) to avoid this.



58
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 58

attribute :proxy_password

#proxy_url ⇒ String?

Returns Proxy URL used to install chocolatey and the package.,Use M(win_chocolatey_config) with the name C(proxy) to control this option globally.

Returns:

  • (String, nil) —

    Proxy URL used to install chocolatey and the package.,Use M(win_chocolatey_config) with the name C(proxy) to control this option globally.



50
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 50

attribute :proxy_url

#proxy_username ⇒ String?

Returns Proxy username used to install Chocolatey and the package.,Before Ansible 2.7, users with double quote characters C(“) would need to be escaped with C() beforehand. This is no longer necessary.,Use M(win_chocolatey_config) with the name C(proxyUser) to control this option globally.

Returns:

  • (String, nil) —

    Proxy username used to install Chocolatey and the package.,Before Ansible 2.7, users with double quote characters C(“) would need to be escaped with C() beforehand. This is no longer necessary.,Use M(win_chocolatey_config) with the name C(proxyUser) to control this option globally.



54
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 54

attribute :proxy_username

#skip_scripts ⇒ :yes, ...

Returns Do not run I(chocolateyInstall.ps1) or I(chocolateyUninstall.ps1) scripts when installing a package.

Returns:

  • (:yes, :no, nil) —

    Do not run I(chocolateyInstall.ps1) or I(chocolateyUninstall.ps1) scripts when installing a package.



62
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 62

attribute :skip_scripts

#source ⇒ String?

Returns Specify the source to retrieve the package from.,Use M(win_chocolatey_source) to manage global sources.,This value can either be the URL to a Chocolatey feed, a path to a folder containing C(.nupkg) packages or the name of a source defined by M(win_chocolatey_source).,This value is also used when Chocolatey is not installed as the location of the install.ps1 script and only supports URLs for this case.

Returns:

  • (String, nil) —

    Specify the source to retrieve the package from.,Use M(win_chocolatey_source) to manage global sources.,This value can either be the URL to a Chocolatey feed, a path to a folder containing C(.nupkg) packages or the name of a source defined by M(win_chocolatey_source).,This value is also used when Chocolatey is not installed as the location of the install.ps1 script and only supports URLs for this case.



66
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 66

attribute :source

#source_password ⇒ String?

Returns The password for I(source_username).,This value is exposed as a command argument and any privileged account can see this value when the module is running Chocolatey, define the credentials with a source with M(win_chocolatey_source) to avoid this.

Returns:

  • (String, nil) —

    The password for I(source_username).,This value is exposed as a command argument and any privileged account can see this value when the module is running Chocolatey, define the credentials with a source with M(win_chocolatey_source) to avoid this.



74
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 74

attribute :source_password

#source_username ⇒ String?

Returns A username to use with I(source) when accessing a feed that requires authentication.,It is recommended you define the credentials on a source with M(win_chocolatey_source) instead of passing it per task.

Returns:

  • (String, nil) —

    A username to use with I(source) when accessing a feed that requires authentication.,It is recommended you define the credentials on a source with M(win_chocolatey_source) instead of passing it per task.



70
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 70

attribute :source_username

#state ⇒ String?

Returns State of the package on the system.,When C(absent), will ensure the package is not installed.,When C(present), will ensure the package is installed.,When C(downgrade), will allow Chocolatey to downgrade a package if I(version) is older than the installed version.,When C(latest), will ensure the package is installed to the latest available version.,When C(reinstalled), will uninstall and reinstall the package.

Returns:

  • (String, nil) —

    State of the package on the system.,When C(absent), will ensure the package is not installed.,When C(present), will ensure the package is installed.,When C(downgrade), will allow Chocolatey to downgrade a package if I(version) is older than the installed version.,When C(latest), will ensure the package is installed to the latest available version.,When C(reinstalled), will uninstall and reinstall the package.



78
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 78

attribute :state

#timeout ⇒ Integer?

Returns The time to allow chocolatey to finish before timing out.

Returns:

  • (Integer, nil) —

    The time to allow chocolatey to finish before timing out.



82
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 82

attribute :timeout

#validate_certs ⇒ :yes, ...

Returns Used when downloading the Chocolatey install script if Chocolatey is not already installed, this does not affect the Chocolatey package install process.,When C(no), no SSL certificates will be validated.,This should only be used on personally controlled sites using self-signed certificate.

Returns:

  • (:yes, :no, nil) —

    Used when downloading the Chocolatey install script if Chocolatey is not already installed, this does not affect the Chocolatey package install process.,When C(no), no SSL certificates will be validated.,This should only be used on personally controlled sites using self-signed certificate.



86
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 86

attribute :validate_certs

#version ⇒ String?

Returns Specific version of the package to be installed.,Ignored when I(state) is set to C(absent).

Returns:

  • (String, nil) —

    Specific version of the package to be installed.,Ignored when I(state) is set to C(absent).



90
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey.rb', line 90

attribute :version