Class: Ansible::Ruby::Modules::Win_domain_user

Inherits:

Base

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

Defined in:

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

Overview

Manages Windows Active Directory user accounts.

Instance Method Summary

• #account_locked ⇒ :no^?

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

• #attributes ⇒ Hash^?

  A dict of custom LDAP attributes to set on the user.,This can be used to set custom attributes that are not exposed as module parameters, e.g.

• #city ⇒ String^?

  Configures the user’s city.

• #company ⇒ String^?

  Configures the user’s company name.

• #country ⇒ String^?

  Configures the user’s country code.,Note that this is a two-character ISO 3166 code.

• #description ⇒ Object^?

  Description of the user.

• #domain_password ⇒ String^?

  The password for I(username).

• #domain_server ⇒ String^?

  Specifies the Active Directory Domain Services instance to connect to.,Can be in the form of an FQDN or NetBIOS name.,If not specified then the value is based on the domain of the computer running PowerShell.

• #domain_username ⇒ String^?

  The username to use when interacting with AD.,If this is not set then the user Ansible used to log in with will be used instead when using CredSSP or Kerberos with credential delegation.

• #email ⇒ Object^?

  Configures the user’s email address.,This is a record in AD and does not do anything to configure any email servers or systems.

• #enabled ⇒ :yes, ...

  C(yes) will enable the user account.,C(no) will disable the account.

• #firstname ⇒ String^?

  Configures the user’s first name (given name).

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

  Adds or removes the user from this list 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(remove), the user is removed from each group in I(groups).,If C(replace), the user is added as a member of each group in I(groups) and removed from any other 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.,This is mutually exclusive with I(password_never_expires).

• #password_never_expires ⇒ Symbol^?

  C(yes) will set the password to never expire.,C(no) will allow the password to expire.,This is mutually exclusive with I(password_expired).

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

  Container or OU for the new user; if you do not specify this, the user will be placed in the default container for users in the domain.,Setting the path is only available when a new user is created; if you specify a path on an existing user, the user’s path will not be updated - you must delete (e.g., state=absent) the user and then re-add the user with the appropriate path.

• #postal_code ⇒ Integer^?

  Configures the user’s postal code / zip code.

• #state ⇒ :absent, ...

  When C(present), creates or updates the user account.

• #state_province ⇒ String^?

  Configures the user’s state or province.

• #street ⇒ String^?

  Configures the user’s street address.

• #surname ⇒ String^?

  Configures the user’s last name (surname).

• #update_password ⇒ :always, ...

  C(always) will update passwords if they differ.,C(on_create) will only set the password for newly created users.,Note that C(always) will always report an Ansible status of ‘changed’ because we cannot determine whether the new password differs from the old password.

• #upn ⇒ Object^?

  Configures the User Principal Name (UPN) for the account.,This is not required, but is best practice to configure for modern versions of Active Directory.,The format is C(<username>@<domain>).

• #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_locked ⇒ :no^?

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 24

attribute :account_locked

#attributes ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 101

attribute :attributes

#city ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 81

attribute :city

#company ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 67

attribute :company

#country ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 93

attribute :country

#description ⇒ Object^?

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

attribute :description

#domain_password ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 109

attribute :domain_password

#domain_server ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 113

attribute :domain_server

#domain_username ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 105

attribute :domain_username

#email ⇒ Object^?

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

attribute :email

#enabled ⇒ :yes, ...

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

attribute :enabled

#firstname ⇒ String^?

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

attribute :firstname

#groups ⇒ Array<String>, ...

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

attribute :groups

#groups_action ⇒ :add, ...

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

attribute :groups_action

#name ⇒ String

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 12

attribute :name

#password ⇒ String^?

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

attribute :password

#password_expired ⇒ Symbol^?

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

attribute :password_expired

#password_never_expires ⇒ Symbol^?

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

attribute :password_never_expires

#path ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 97

attribute :path

#postal_code ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 89

attribute :postal_code

#state ⇒ :absent, ...

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 16

attribute :state

#state_province ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 85

attribute :state_province

#street ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 77

attribute :street

#surname ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 63

attribute :surname

#update_password ⇒ :always, ...

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

attribute :update_password

#upn ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/windows/win_domain_user.rb', line 71

attribute :upn

#user_cannot_change_password ⇒ Symbol^?

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

attribute :user_cannot_change_password