Class: Ansible::Ruby::Modules::Vultr_user

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/vultr/vr_user.rb,
lib/ansible/ruby/modules/generated/cloud/vultr/vultr_user.rb

Overview

Create, update 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

#acls ⇒ :manage_users, ...

Returns List of ACLs this users should have, see U(www.vultr.com/api/#user_user_list).,Required if C(state=present).,One or more of the choices list, some depend on each other.

Returns:

  • (:manage_users, :subscriptions, :provisioning, :billing, :support, :abuse, :dns, :upgrade, nil) —

    List of ACLs this users should have, see U(www.vultr.com/api/#user_user_list).,Required if C(state=present).,One or more of the choices list, some depend on each other.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_user.rb', line 32

attribute :acls

#api_enabled ⇒ Boolean?

Returns Whether the API is enabled or not.

Returns:

  • (Boolean, nil) —

    Whether the API is enabled or not.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_user.rb', line 28

attribute :api_enabled

#email ⇒ String?

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

Returns:

  • (String, nil) —

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



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_user.rb', line 16

attribute :email

#force ⇒ Symbol?

Returns Password will only be changed with enforcement.

Returns:

  • (Symbol, nil) —

    Password will only be changed with enforcement.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_user.rb', line 24

attribute :force

#name ⇒ String

Returns Name of the user.

Returns:

  • (String) —

    Name of the user



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_user.rb', line 12

attribute :name

#password ⇒ String?

Returns Password of the user.,Only considered while creating a user or when C(force=yes).

Returns:

  • (String, nil) —

    Password of the user.,Only considered while creating a user or when C(force=yes).



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_user.rb', line 20

attribute :password

#state ⇒ :present, ...

Returns State of the user.

Returns:

  • (:present, :absent, nil) —

    State of the user.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/vultr/vr_user.rb', line 36

attribute :state