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

Inherits:

Base

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

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

• #account_disabled ⇒ Symbol^?

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

• #account_locked ⇒ :no^?

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

• #description ⇒ Object^?

  Description of the user.

• #fullname ⇒ Object^?

  Full name of the user.

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

  Adds or removes the user from this comma-separated lis of groups, depending on the value of I(groups_action).

• #groups_action ⇒ :add, ...

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

• #name ⇒ String

  Name of the user to create, remove or modify.

• #password ⇒ String^?

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

• #password_expired ⇒ Symbol^?

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

• #password_never_expires ⇒ Symbol^?

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

• #state ⇒ :absent, ...

  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.

• #update_password ⇒ :always, ...

  C(always) will update passwords if they differ.

• #user_cannot_change_password ⇒ Symbol^?

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

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, #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^?

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

attribute :account_disabled

#account_locked ⇒ :no^?

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

attribute :account_locked

#description ⇒ Object^?

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

attribute :description

#fullname ⇒ Object^?

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

attribute :fullname

#groups ⇒ Array<String>, ...

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

attribute :groups

#groups_action ⇒ :add, ...

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

attribute :groups_action

#name ⇒ String

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

attribute :name

#password ⇒ String^?

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

attribute :password

#password_expired ⇒ Symbol^?

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

attribute :password_expired

#password_never_expires ⇒ Symbol^?

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

attribute :password_never_expires

#state ⇒ :absent, ...

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

attribute :state

#update_password ⇒ :always, ...

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

attribute :update_password

#user_cannot_change_password ⇒ Symbol^?

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

attribute :user_cannot_change_password