Class: Ansible::Ruby::Modules::Win_user

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

Overview

Manages local Windows user accounts. For non-Windows targets, use the M(user) module instead.

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

#account_disabled ⇒ Symbol?

Returns C(yes) will disable the user account.,C(no) will clear the disabled flag.

Returns:

  • (Symbol, nil) —

    C(yes) will disable the user account.,C(no) will clear the disabled flag.



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

attribute :account_disabled

#account_locked ⇒ :no?

Returns C(no) will unlock the user account if locked.

Returns:

  • (:no, nil) —

    C(no) will unlock the user account if locked.



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

attribute :account_locked

#description ⇒ Object?

Returns Description of the user.

Returns:

  • (Object, nil) —

    Description of the user.



20
 
# File 'lib/ansible/ruby/modules/generated/windows/win_user.rb', line 20

attribute :description

#fullname ⇒ Object?

Returns Full name of the user.

Returns:

  • (Object, nil) —

    Full name of the user.



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

attribute :fullname

#groups ⇒ Array<String>, ...

Returns Adds or removes the user from this comma-separated lis of groups, depending on the value of I(groups_action). When I(groups_action) is C(replace) and I(groups) is set to the empty string (‘groups=’), the user is removed from all groups.

Returns:

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

    Adds or removes the user from this comma-separated lis of groups, depending on the value of I(groups_action). When I(groups_action) is C(replace) and I(groups) is set to the empty string (‘groups=’), the user is removed from all groups.



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

attribute :groups

#groups_action ⇒ :add, ...

Returns If C(add), the user is added to each group in I(groups) where not already a member.,If C(replace), the user is added as a member of each group in I(groups) and removed from any other groups.,If C(remove), the user is removed from each group in I(groups).

Returns:

  • (:add, :replace, :remove, nil) —

    If C(add), the user is added to each group in I(groups) where not already a member.,If C(replace), the user is added as a member of each group in I(groups) and removed from any other groups.,If C(remove), the user is removed from each group in I(groups).



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

attribute :groups_action

#name ⇒ String

Returns Name of the user to create, remove or modify.

Returns:

  • (String) —

    Name of the user to create, remove or modify.



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

attribute :name

#password ⇒ String?

Returns Optionally set the user’s password to this (plain text) value.

Returns:

  • (String, nil) —

    Optionally set the user’s password to this (plain text) value.



23
 
# File 'lib/ansible/ruby/modules/generated/windows/win_user.rb', line 23

attribute :password

#password_expired ⇒ Symbol?

Returns C(yes) will require the user to change their password at next login.,C(no) will clear the expired password flag.

Returns:

  • (Symbol, nil) —

    C(yes) will require the user to change their password at next login.,C(no) will clear the expired password flag.



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

attribute :password_expired

#password_never_expires ⇒ Symbol?

Returns C(yes) will set the password to never expire.,C(no) will allow the password to expire.

Returns:

  • (Symbol, nil) —

    C(yes) will set the password to never expire.,C(no) will allow the password to expire.



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

attribute :password_never_expires

#state ⇒ :absent, ...

Returns When C(absent), removes the user account if it exists.,When C(present), creates or updates the user account.,When C(query) (new in 1.9), retrieves the user account details without making any changes.

Returns:

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

    When C(absent), removes the user account if it exists.,When C(present), creates or updates the user account.,When C(query) (new in 1.9), retrieves the user account details without making any changes.



59
 
# File 'lib/ansible/ruby/modules/generated/windows/win_user.rb', line 59

attribute :state

#update_password ⇒ :always, ...

Returns C(always) will update passwords if they differ. C(on_create) will only set the password for newly created users.

Returns:

  • (:always, :on_create, nil) —

    C(always) will update passwords if they differ. C(on_create) will only set the password for newly created users.



27
 
# File 'lib/ansible/ruby/modules/generated/windows/win_user.rb', line 27

attribute :update_password

#user_cannot_change_password ⇒ Symbol?

Returns C(yes) will prevent the user from changing their password.,C(no) will allow the user to change their password.

Returns:

  • (Symbol, nil) —

    C(yes) will prevent the user from changing their password.,C(no) will allow the user to change their password.



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

attribute :user_cannot_change_password