community.cassandra.cassandra_drain (1.3.3) — module

Drains a Cassandra node.

Authors: Rhys Campbell (@rhysmeister)

Install collection

Install with ansible-galaxy collection install community.cassandra:==1.3.3


Add to requirements.yml

  collections:
    - name: community.cassandra
      version: 1.3.3

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Drain Cassandra Node
  cassandra_drain:

Inputs

    
host:
    aliases:
    - login_host
    default: 127.0.0.1
    description:
    - The hostname.
    type: str

port:
    aliases:
    - login_port
    default: 7199
    description:
    - The Cassandra TCP port.
    type: int

debug:
    default: false
    description:
    - Enable additional debug output.
    type: bool

password:
    aliases:
    - login_password
    description:
    - The password to authenticate with.
    type: str

username:
    aliases:
    - login_user
    description:
    - The username to authenticate with.
    type: str

nodetool_path:
    description:
    - The path to nodetool.
    type: str

password_file:
    aliases:
    - login_password_file
    description:
    - Path to a file containing the password.
    type: str

nodetool_flags:
    default: -Dcom.sun.jndi.rmiURLParsing=legacy
    description:
    - Flags to pass to nodetool.
    type: str

Outputs

community.cassandra.cassandra_drain:
  description: The return state of the executed command.
  returned: success
  type: str