Class: Ansible::Ruby::Modules::Rabbitmq_user

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/messaging/rabbitmq_user.rb

Overview

Add or remove users to RabbitMQ and assign permissions

Instance Method Summary

• #configure_priv ⇒ String^?

  Regular expression to restrict configure actions on a resource for the specified vhost.,By default all actions are restricted.,This option will be ignored when permissions option is used.

• #force ⇒ :yes, ...

  Deletes and recreates the user.

• #node ⇒ String^?

  Erlang node name of the rabbit we wish to configure.

• #password ⇒ String^?

  Password of user to add.,To change the password of an existing user, you must also specify C(update_password=always).

• #permissions ⇒ Object^?

  A list of dicts, each dict contains vhost, configure_priv, write_priv, and read_priv, and represents a permission rule for that vhost.,This option should be preferable when you care about all permissions of the user.,You should use vhost, configure_priv, write_priv, and read_priv options instead if you care about permissions for just some vhosts.

• #read_priv ⇒ String^?

  Regular expression to restrict configure actions on a resource for the specified vhost.,By default all actions are restricted.,This option will be ignored when permissions option is used.

• #state ⇒ :present, ...

  Specify if user is to be added or removed.

• #tags ⇒ Object^?

  User tags specified as comma delimited.

• #update_password ⇒ :on_create, ...

  C(on_create) will only set the password for newly created users.

• #user ⇒ String

  Name of user to add.

• #vhost ⇒ String^?

  Vhost to apply access privileges.,This option will be ignored when permissions option is used.

• #write_priv ⇒ String^?

  Regular expression to restrict configure actions on a resource for the specified vhost.,By default all actions are restricted.,This option will be ignored when permissions option is used.

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

#configure_priv ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_user.rb', line 34

attribute :configure_priv

#force ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_user.rb', line 46

attribute :force

#node ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_user.rb', line 30

attribute :node

#password ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_user.rb', line 16

attribute :password

#permissions ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_user.rb', line 23

attribute :permissions

#read_priv ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_user.rb', line 42

attribute :read_priv

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_user.rb', line 50

attribute :state

#tags ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_user.rb', line 20

attribute :tags

#update_password ⇒ :on_create, ...

# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_user.rb', line 54

attribute :update_password

#user ⇒ String

# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_user.rb', line 12

attribute :user

#vhost ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_user.rb', line 26

attribute :vhost

#write_priv ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/messaging/rabbitmq_user.rb', line 38

attribute :write_priv