community.cassandra.cassandra_garbagecollect (1.3.3) — module

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

Removes deleted data from one or more tables.

Requirements

• nodetool

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove deleted data from a table
  community.cassandra.cassandra_garbagecollect:
    keyspace: mykeyspace
    tables: mytable

Inputs

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

jobs:
    default: 2
    description:
    - Number of SSTables affected simultaneously.
    - Set to 0 to use all compaction threads.
    type: int

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

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

table:
    description:
    - Table to clean up deleted data from.
    type: str

keyspace:
    description:
    - Keyspace to clean up data from.
    type: str

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

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

granularity:
    choices:
    - ROW
    - CELL
    default: ROW
    description:
    - ROW (default) removes deleted partitions and rows.
    - CELL also removes overwritten or deleted cells.
    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

msg:
  description: A brief description of what happened.
  returned: success
  type: str