Module to provide RabbitMQ compatibility to Salt. Todo: A lot, need to add cluster support, logging, and minion configuration data.
Add a rabbitMQ user via rabbitmqctl user_add <user> <password>
CLI Example:
salt '*' rabbitmq.add_user rabbit_user password
Adds a vhost via rabbitmqctl add_vhost.
CLI Example:
salt '*' rabbitmq add_vhost '<vhost_name>'
Changes a user's password.
CLI Example:
salt '*' rabbitmq.change_password rabbit_user password
New in version 2016.3.0.
Checks if a user's password is valid.
CLI Example:
salt '*' rabbitmq.check_password rabbit_user password
Removes a user's password.
CLI Example:
salt '*' rabbitmq.clear_password rabbit_user
return rabbitmq cluster_status
CLI Example:
salt '*' rabbitmq.cluster_status
Delete a policy based on rabbitmqctl clear_policy.
Reference: http://www.rabbitmq.com/ha.html
CLI Example:
salt '*' rabbitmq.delete_policy / HA
Deletes a user via rabbitmqctl delete_user.
CLI Example:
salt '*' rabbitmq.delete_user rabbit_user
Deletes a vhost rabbitmqctl delete_vhost.
CLI Example:
salt '*' rabbitmq.delete_vhost '<vhost_name>'
Disable a RabbitMQ plugin via the rabbitmq-plugins command.
CLI Example:
salt '*' rabbitmq.disable_plugin foo
Enable a RabbitMQ plugin via the rabbitmq-plugins command.
CLI Example:
salt '*' rabbitmq.enable_plugin foo
Forcefully Return a RabbitMQ node to its virgin state
CLI Example:
salt '*' rabbitmq.force_reset
Join a rabbit cluster
CLI Example:
salt '*' rabbitmq.join_cluster rabbit.example.com rabbit
Returns a list of the names of all available plugins (enabled and disabled).
CLI Example:
salt '*' rabbitmq.list_available_plugins
Returns a list of the names of the enabled plugins.
CLI Example:
salt '*' rabbitmq.list_enabled_plugins
Lists permissions for vhost via rabbitmqctl list_permissions
CLI Example:
salt '*' rabbitmq.list_permissions /myvhost
Return a dictionary of policies nested by vhost and name based on the data returned from rabbitmqctl list_policies.
Reference: http://www.rabbitmq.com/ha.html
CLI Example:
salt '*' rabbitmq.list_policies
Returns queue details of the / virtual host
CLI Example:
salt '*' rabbitmq.list_queues messages consumers
Returns queue details of specified virtual host. This command will consider first parameter as the vhost name and rest will be treated as queueinfoitem. For getting details on vhost /
, use list_queues
instead).
CLI Example:
salt '*' rabbitmq.list_queues messages consumers
List permissions for a user via rabbitmqctl list_user_permissions
CLI Example:
salt '*' rabbitmq.list_user_permissions user
Return a list of users based off of rabbitmqctl user_list.
CLI Example:
salt '*' rabbitmq.list_users
Return a list of vhost based on rabbitmqctl list_vhosts.
CLI Example:
salt '*' rabbitmq.list_vhosts
Return whether the plugin is enabled.
CLI Example:
salt '*' rabbitmq.plugin_is_enabled rabbitmq_plugin_name
Return whether the policy exists based on rabbitmqctl list_policies.
Reference: http://www.rabbitmq.com/ha.html
CLI Example:
salt '*' rabbitmq.policy_exists / HA
Return a RabbitMQ node to its virgin state
CLI Example:
salt '*' rabbitmq.reset
Sets permissions for vhost via rabbitmqctl set_permissions
CLI Example:
salt '*' rabbitmq.set_permissions myvhost myuser
Set a policy based on rabbitmqctl set_policy.
Reference: http://www.rabbitmq.com/ha.html
CLI Example:
salt '*' rabbitmq.set_policy / HA '.*' '{"ha-mode":"all"}'
Add user tags via rabbitmqctl set_user_tags
CLI Example:
salt '*' rabbitmq.set_user_tags myadmin administrator
Start the RabbitMQ application.
CLI Example:
salt '*' rabbitmq.start_app
return rabbitmq status
CLI Example:
salt '*' rabbitmq.status
Stops the RabbitMQ application, leaving the Erlang node running.
CLI Example:
salt '*' rabbitmq.stop_app
Return whether the user exists based on rabbitmqctl list_users.
CLI Example:
salt '*' rabbitmq.user_exists rabbit_user
Return whether the vhost exists based on rabbitmqctl list_vhosts.
CLI Example:
salt '*' rabbitmq.vhost_exists rabbit_host
© 2019 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.rabbitmq.html