Class: Ansible::Ruby::Modules::Os_user

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/openstack/os_user.rb

Overview

Manage OpenStack Identity users. Users can be created, updated or deleted using this module. A user will be updated if I(name) matches an existing user and I(state) is present. The value for I(name) cannot be updated without deleting and re-creating the user.

Instance Method Summary

• #availability_zone ⇒ Object^?

  Ignored.

• #default_project ⇒ String^?

  Project name or ID that the user should be associated with by default.

• #description ⇒ Object^?

  Description about the user.

• #domain ⇒ String^?

  Domain to create the user in if the cloud supports domains.

• #email ⇒ String^?

  Email address for the user.

• #enabled ⇒ :yes, ...

  Is the user enabled.

• #name ⇒ String

  Username for the user.

• #password ⇒ String^?

  Password for the user.

• #state ⇒ :present, ...

  Should the resource be present or absent.

• #update_password ⇒ :always, ...

  C(always) will attempt to update password.

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

#availability_zone ⇒ Object^?

Returns Ignored. Present for backwards compatibility.

Returns:

• (Object, nil) —

  Ignored. Present for backwards compatibility

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_user.rb', line 47

attribute :availability_zone

#default_project ⇒ String^?

Returns Project name or ID that the user should be associated with by default.

Returns:

• (String, nil) —

  Project name or ID that the user should be associated with by default

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_user.rb', line 31

attribute :default_project

#description ⇒ Object^?

Returns Description about the user.

Returns:

• (Object, nil) —

  Description about the user

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_user.rb', line 28

attribute :description

#domain ⇒ String^?

Returns Domain to create the user in if the cloud supports domains.

Returns:

• (String, nil) —

  Domain to create the user in if the cloud supports domains

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_user.rb', line 35

attribute :domain

#email ⇒ String^?

Returns Email address for the user.

Returns:

• (String, nil) —

  Email address for the user

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_user.rb', line 24

attribute :email

#enabled ⇒ :yes, ...

Returns Is the user enabled.

Returns:

• (:yes, :no, nil) —

  Is the user enabled

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_user.rb', line 39

attribute :enabled

#name ⇒ String

Returns Username for the user.

Returns:

• (String) —

  Username for the user

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_user.rb', line 12

attribute :name

#password ⇒ String^?

Returns Password for the user.

Returns:

• (String, nil) —

  Password for the user

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_user.rb', line 16

attribute :password

#state ⇒ :present, ...

Returns Should the resource be present or absent.

Returns:

• (:present, :absent, nil) —

  Should the resource be present or absent.

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_user.rb', line 43

attribute :state

#update_password ⇒ :always, ...

Returns C(always) will attempt to update password. C(on_create) will only set the password for newly created users.

Returns:

• (:always, :on_create, nil) —

  C(always) will attempt to update password. C(on_create) will only set the password for newly created users.

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_user.rb', line 20

attribute :update_password