Class: Ansible::Ruby::Modules::Cs_user

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_user.rb

Overview

Create, update, disable, lock, enable and remove users.

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 ⇒ String?

Returns Account the user will be created under.,Required on C(state=present).

Returns:

  • (String, nil) —

    Account the user will be created under.,Required on C(state=present).



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_user.rb', line 16

attribute :account

#domain ⇒ String?

Returns Domain the user is related to.

Returns:

  • (String, nil) —

    Domain the user is related to.



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_user.rb', line 43

attribute :domain

#email ⇒ String?

Returns Email of the user.,Required on C(state=present).

Returns:

  • (String, nil) —

    Email of the user.,Required on C(state=present).



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_user.rb', line 32

attribute :email

#first_name ⇒ String?

Returns First name of the user.,Required on C(state=present).

Returns:

  • (String, nil) —

    First name of the user.,Required on C(state=present).



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_user.rb', line 24

attribute :first_name

#keys_registered ⇒ Symbol?

Returns If API keys of the user should be generated.,Note: Keys can not be removed by the API again.

Returns:

  • (Symbol, nil) —

    If API keys of the user should be generated.,Note: Keys can not be removed by the API again.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_user.rb', line 39

attribute :keys_registered

#last_name ⇒ String?

Returns Last name of the user.,Required on C(state=present).

Returns:

  • (String, nil) —

    Last name of the user.,Required on C(state=present).



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_user.rb', line 28

attribute :last_name

#password ⇒ String?

Returns Password of the user to be created.,Required on C(state=present).,Only considered on creation and will not be updated if user exists.

Returns:

  • (String, nil) —

    Password of the user to be created.,Required on C(state=present).,Only considered on creation and will not be updated if user exists.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_user.rb', line 20

attribute :password

#poll_async ⇒ Boolean?

Returns Poll async jobs until job has finished.

Returns:

  • (Boolean, nil) —

    Poll async jobs until job has finished.



51
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_user.rb', line 51

attribute :poll_async

#state ⇒ :present, ...

Returns State of the user.,C(unlocked) is an alias for C(enabled).

Returns:

  • (:present, :absent, :enabled, :disabled, :locked, :unlocked, nil) —

    State of the user.,C(unlocked) is an alias for C(enabled).



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_user.rb', line 47

attribute :state

#timezone ⇒ Object?

Returns Timezone of the user.

Returns:

  • (Object, nil) —

    Timezone of the user.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_user.rb', line 36

attribute :timezone

#username ⇒ String

Returns Username of the user.

Returns:

  • (String) —

    Username of the user.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_user.rb', line 12

attribute :username