Rabbitmq Server

Learn about actions >

• check-queues

  Show current queues, optionally only show queues with more than N messages or queues from specified vhost.

  Params

  • queue-depth integer

    Only show queues with >= this many messages. -1 shows all. Note that if the result exceeds command line length (1/4 ulimit -s) on the target system this will fail (For ex; -1 in an openstack env) See lp:1437366, lp:1274460

  • vhost string

    Show queues from the specified vhost. Eg; "openstack".

• cluster-status

  Show the current cluster status.

• complete-cluster-series-upgrade

  Perform final operations post series upgrade. Inform all nodes in the cluster the upgrade is complete cluster wide. This action should be performed on the current leader. Note the leader may have changed during the series upgrade process.

• force-boot

  Set the force_boot flag and restart the RabbitMQ broker. This action should be performed if a unit in the RabbitMQ cluster is failing to boot after an uncontrolled shutdown of the cluster. Note that units of a RabbitMQ cluster have to be booted in reverse shutdown order. Also note that this potentially leads to a loss of messages, in particular if the cluster received messages after the unit was shut down. See https://www.rabbitmq.com/clustering.html#restarting and LP: #1828988

• forget-cluster-node

  Remove a dead node from the cluster mnesia db.

  Params

  • node string

    Node name i.e. rabbit@<hostname>

• list-service-usernames

  List the usernames of the passwords that have been provided on the amqp relations. The service username passed to 'rotate-service-user-password' needs to be on this list.

• list-unconsumed-queues

  list queues which currently have zero consumers, results are like: unconsumed-queue-count: "2" unconsumed-queues: $vhost: "0": queue_name1 - 0 "1": $queue_name - $num_messages

• pause

  Pause the rabbitmq unit.

• restart-services

  Restarts services this charm manages.

  Params

  • deferred-only boolean

    Restart all deferred services.

  • run-hooks boolean

    Run any hooks which have been deferred.

  • services string

    List of services to restart.

• resume

• rotate-service-user-password

  Rotate the specified rabbitmq-server user's password. The current password is replaced with a randomly generated password. The password is changed on the relation to the user's units. This may result in a control plane outage for the duration of the password changing process.

  Params

  • service-user string

    The username of the rabbitmq-server service as specified in list-service-usernames.

• run-deferred-hooks

  Run deferable hooks and restart services. . NOTE: Service will be restarted as needed irrespective of enable-auto-restarts

• show-deferred-events