Class: Ansible::Ruby::Modules::Win_chocolatey_source

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

Overview

Used to managed Chocolatey sources configured on the client. Requires Chocolatey to be already installed on the remote host.

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

#admin_only ⇒ Symbol?

Returns Makes the source visible to Administrators only.,Requires Chocolatey >= 0.10.8.,When creating a new source, this defaults to C(False).

Returns:

  • (Symbol, nil) —

    Makes the source visible to Administrators only.,Requires Chocolatey >= 0.10.8.,When creating a new source, this defaults to C(False).



13
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey_source.rb', line 13

attribute :admin_only

#allow_self_service ⇒ Symbol?

Returns Allow the source to be used with self-service,Requires Chocolatey >= 0.10.4.,When creating a new source, this defaults to C(False).

Returns:

  • (Symbol, nil) —

    Allow the source to be used with self-service,Requires Chocolatey >= 0.10.4.,When creating a new source, this defaults to C(False).



17
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey_source.rb', line 17

attribute :allow_self_service

#bypass_proxy ⇒ Symbol?

Returns Bypass the proxy when using this source.,Requires Chocolatey >= 0.10.4.,When creating a new source, this defaults to C(False).

Returns:

  • (Symbol, nil) —

    Bypass the proxy when using this source.,Requires Chocolatey >= 0.10.4.,When creating a new source, this defaults to C(False).



21
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey_source.rb', line 21

attribute :bypass_proxy

#certificate ⇒ Object?

Returns The path to a .pfx file to use for X509 authenticated feeds.,Requires Chocolatey >= 0.9.10.

Returns:

  • (Object, nil) —

    The path to a .pfx file to use for X509 authenticated feeds.,Requires Chocolatey >= 0.9.10.



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

attribute :certificate

#certificate_password ⇒ Object?

Returns The password for I(certificate) if required.,Requires Chocolatey >= 0.9.10.

Returns:

  • (Object, nil) —

    The password for I(certificate) if required.,Requires Chocolatey >= 0.9.10.



28
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey_source.rb', line 28

attribute :certificate_password

#name ⇒ String

Returns The name of the source to configure.

Returns:

  • (String) —

    The name of the source to configure.



31
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey_source.rb', line 31

attribute :name

#priority ⇒ Integer?

Returns The priority order of this source compared to other sources, lower is better.,All priorities above C(0) will be evaluated first, then zero-based values will be evaluated in config file order.,Requires Chocolatey >= 0.9.9.9.,When creating a new source, this defaults to C(0).

Returns:

  • (Integer, nil) —

    The priority order of this source compared to other sources, lower is better.,All priorities above C(0) will be evaluated first, then zero-based values will be evaluated in config file order.,Requires Chocolatey >= 0.9.9.9.,When creating a new source, this defaults to C(0).



35
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey_source.rb', line 35

attribute :priority

#source ⇒ String?

Returns The file/folder/url of the source.,Required when I(state) is C(present) or C(disabled).

Returns:

  • (String, nil) —

    The file/folder/url of the source.,Required when I(state) is C(present) or C(disabled).



39
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey_source.rb', line 39

attribute :source

#source_password ⇒ String?

Returns The password for I(source_username).,Required if I(source_username) is set.

Returns:

  • (String, nil) —

    The password for I(source_username).,Required if I(source_username) is set.



47
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey_source.rb', line 47

attribute :source_password

#source_username ⇒ String?

Returns The username used to access I(source).

Returns:

  • (String, nil) —

    The username used to access I(source).



43
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey_source.rb', line 43

attribute :source_username

#state ⇒ :absent, ...

Returns When C(absent), will remove the source.,When C(disabled), will ensure the source exists but is disabled.,When C(present), will ensure the source exists and is enabled.

Returns:

  • (:absent, :disabled, :present, nil) —

    When C(absent), will remove the source.,When C(disabled), will ensure the source exists but is disabled.,When C(present), will ensure the source exists and is enabled.



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

attribute :state

#update_password ⇒ :always, ...

Returns When C(always), the module will always set the password and report a change if I(certificate_password) or I(source_password) is set.,When C(on_create), the module will only set the password if the source is being created.

Returns:

  • (:always, :on_create, nil) —

    When C(always), the module will always set the password and report a change if I(certificate_password) or I(source_password) is set.,When C(on_create), the module will only set the password if the source is being created.



55
 
# File 'lib/ansible/ruby/modules/generated/windows/win_chocolatey_source.rb', line 55

attribute :update_password