community.cassandra.cassandra_timeout (1.3.3) — module

Manages the timeout on the 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

Manages the timeout.

Set the specified timeout in ms, or 0 to disable timeout.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set read timeout to 1000 ms
  community.cassandra.cassandra_timeout:
    timeout: 1000
    timeout_type: read
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Disable write timeout
  community.cassandra.cassandra_timeout:
    timeout: 0
    timeout_type: write

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

timeout:
    description:
    - Timeout in milliseconds.
    required: true
    type: int

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

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

timeout_type:
    choices:
    - read
    - range
    - write
    - counterwrite
    - cascontention
    - truncate
    - internodeconnect
    - internodeuser
    - internodestreaminguser
    - misc
    default: read
    description:
    - Type of timeout.
    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

cassandra_timeout:
  description: The return state of the executed command.
  returned: success
  type: str