Class: Ansible::Ruby::Modules::Manageiq_user

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_user.rb

Overview

The manageiq_user module supports adding, updating and deleting users in ManageIQ.

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

#email ⇒ String?

Returns The users’ E-mail address.

Returns:

  • (String, nil) —

    The users’ E-mail address.



32
 
# File 'lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_user.rb', line 32

attribute :email

#group ⇒ String?

Returns The name of the group to which the user belongs.

Returns:

  • (String, nil) —

    The name of the group to which the user belongs.



28
 
# File 'lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_user.rb', line 28

attribute :group

#name ⇒ String?

Returns The users’ full name.

Returns:

  • (String, nil) —

    The users’ full name.



20
 
# File 'lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_user.rb', line 20

attribute :name

#password ⇒ String?

Returns The users’ password.

Returns:

  • (String, nil) —

    The users’ password.



24
 
# File 'lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_user.rb', line 24

attribute :password

#state ⇒ :absent, ...

Returns absent - user should not exist, present - user should be.

Returns:

  • (:absent, :present, nil) —

    absent - user should not exist, present - user should be.



12
 
# File 'lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_user.rb', line 12

attribute :state

#update_password ⇒ :always, ...

Returns C(always) will update passwords unconditionally. C(on_create) will only set the password for a newly created user.

Returns:

  • (:always, :on_create, nil) —

    C(always) will update passwords unconditionally. C(on_create) will only set the password for a newly created user.



36
 
# File 'lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_user.rb', line 36

attribute :update_password

#userid ⇒ String

Returns The unique userid in manageiq, often mentioned as username.

Returns:

  • (String) —

    The unique userid in manageiq, often mentioned as username.



16
 
# File 'lib/ansible/ruby/modules/generated/remote_management/manageiq/manageiq_user.rb', line 16

attribute :userid