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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/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 collapse

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

#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



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

attribute :default_project

#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



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

attribute :domain

#email ⇒ String?

Returns Email address for the user.

Returns:

  • (String, nil) —

    Email address for the user



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

attribute :email

#enabled ⇒ Boolean?

Returns Is the user enabled.

Returns:

  • (Boolean, nil) —

    Is the user enabled



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

attribute :enabled

#name ⇒ String

Returns Username for the user.

Returns:

  • (String) —

    Username for the user



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

attribute :name

#password ⇒ String?

Returns Password for the user,Required when I(state) is present.

Returns:

  • (String, nil) —

    Password for the user,Required when I(state) is present



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

attribute :password

#state ⇒ :present, ...

Returns Should the resource be present or absent.

Returns:

  • (:present, :absent, nil) —

    Should the resource be present or absent.



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

attribute :state