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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/messaging/rabbitmq_user.rb

Overview

Add or remove users to RabbitMQ and assign permissions

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

#configure_priv ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



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

attribute :configure_priv

#force ⇒ :yes, ...

Returns Deletes and recreates the user.

Returns:

  • (:yes, :no, nil) —

    Deletes and recreates the user.



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

attribute :force

#node ⇒ String?

Returns erlang node name of the rabbit we wish to configure.

Returns:

  • (String, nil) —

    erlang node name of the rabbit we wish to configure



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

attribute :node

#password ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :password

#permissions ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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.



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

attribute :permissions

#read_priv ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



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

attribute :read_priv

#state ⇒ :present, ...

Returns Specify if user is to be added or removed.

Returns:

  • (:present, :absent, nil) —

    Specify if user is to be added or removed



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

attribute :state

#tags ⇒ Object?

Returns User tags specified as comma delimited.

Returns:

  • (Object, nil) —

    User tags specified as comma delimited



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

attribute :tags

#update_password ⇒ :on_create, ...

Returns C(on_create) will only set the password for newly created users. C(always) will update passwords if they differ.

Returns:

  • (:on_create, :always, nil) —

    C(on_create) will only set the password for newly created users. C(always) will update passwords if they differ.



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

attribute :update_password

#user ⇒ String

Returns Name of user to add.

Returns:

  • (String) —

    Name of user to add



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

attribute :user

#vhost ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :vhost

#write_priv ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



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

attribute :write_priv