salt.modules.rabbitmq

### Navigation

- index
- modules |
- next |
- previous |
- « SaltStack.org |
- Documentation home
- Full list of builtin execution modules »

# salt.modules.rabbitmq

Module to provide RabbitMQ compatibility to Salt. Todo: A lot, need to add cluster support, logging, and minion configuration data.

`salt.modules.rabbitmq.` `add_user`(name, password, runas=None)

  Add a rabbitMQ user via rabbitmqctl user_add <user> <password>

  CLI Example:

      salt '*' rabbitmq.add_user rabbit_user password

`salt.modules.rabbitmq.` `add_vhost`(vhost, runas=None)

  Adds a vhost via rabbitmqctl add_vhost.

  CLI Example:

      salt '*' rabbitmq add_vhost '<vhost_name>'

`salt.modules.rabbitmq.` `change_password`(name, password, runas=None)

  Changes a user's password.

  CLI Example:

      salt '*' rabbitmq.change_password rabbit_user password

`salt.modules.rabbitmq.` `clear_password`(name, runas=None)

  Removes a user's password.

  CLI Example:

      salt '*' rabbitmq.clear_password rabbit_user

`salt.modules.rabbitmq.` `delete_user`(name, runas=None)

  Deletes a user via rabbitmqctl delete_user.

  CLI Example:

      salt '*' rabbitmq.delete_user rabbit_user

`salt.modules.rabbitmq.` `delete_vhost`(vhost, runas=None)

  Deletes a vhost rabbitmqctl delete_vhost.

  CLI Example:

      salt '*' rabbitmq.delete_vhost '<vhost_name>'

`salt.modules.rabbitmq.` `list_user_permissions`(name, user=None)

  List permissions for a user via rabbitmqctl list_user_permissions

  Example:

      salt '*' rabbitmq.list_user_permissions 'user'.

`salt.modules.rabbitmq.` `list_users`(runas=None)

  Return a list of users based off of rabbitmqctl user_list.

  CLI Example:

      salt '*' rabbitmq.list_users

`salt.modules.rabbitmq.` `list_vhosts`(runas=None)

  Return a list of vhost based of of rabbitmqctl list_vhosts.

  CLI Example:

      salt '*' rabbitmq.list_vhosts

`salt.modules.rabbitmq.` `set_permissions`(vhost, user, conf='.*', write='.*', read='.*', runas=None)

  Sets permissions for vhost via rabbitmqctl set_permissions

  CLI Example:

      salt '*' rabbitmq.set_permissions 'myvhost' 'myuser'

`salt.modules.rabbitmq.` `user_exists`(name, runas=None)

  Return whether the user exists based on rabbitmqctl list_users.

  CLI Example:

      salt '*' rabbitmq.user_exists rabbit_user

`salt.modules.rabbitmq.` `vhost_exists`(name, runas=None)

  Return whether the vhost exists based on rabbitmqctl list_vhosts.

  CLI Example:

      salt '*' rabbitmq.vhost_exists rabbit_host

## Comments

comments powered by Disqus

### Navigation

- index
- modules |
- next |
- previous |
- « SaltStack.org |
- Documentation home
- Full list of builtin execution modules »