Synopsis

Flushes all memtables from the node to SSTables on disk.

Cassandra stops listening for connections from the client and other nodes.

Restart Cassandra after running nodetool drain.

Use this command before upgrading a node to a new version of Cassandra.

Requirements

The below requirements are needed on the host that executes this module.

• nodetool

Parameters

host (optional, str, 127.0.0.1)

The hostname.

port (optional, int, 7199)

The Cassandra TCP port.

password (optional, str, None)

The password to authenticate with.

password_file (optional, str, None)

Path to a file containing the password.

username (optional, str, None)

The username to authenticate with.

nodetool_path (optional, str, None)

The path to nodetool.

nodetool_flags (optional, str, -Dcom.sun.jndi.rmiURLParsing=legacy)

Flags to pass to nodetool.

debug (optional, bool, False)

Enable additional debug output.

Examples

- name: Drain Cassandra Node
  cassandra_drain:

Return Values

community.cassandra.cassandra_drain (success, str, )

The return state of the executed command.

Status