nodesync help

Displays usage information for nodesync commands.

Displays usage information for nodesync commands. Use nodesync help to display a synopsis and brief description for a specific nodesync command.

Synopsis

[dse] nodesync help 
[command_name [subcommand_name]]

Validation options

command_name: Name of nodesync command.
subcommand_name: Name of nodesync subcommand.

Examples

Display top-level help

nodesync help

usage: nodesync [(-js | --jmx-ssl)] [(-p <cqlPort> | --port <cqlPort>)]
  [(-cu <cqlUsername> | --cql-username <cqlUsername>)]
  [(-jp <jmxPassword> | --jmx-password <jmxPassword>)]
  [(-jpf <jmxPasswordFile> | --jmx-password-file <jmxPasswordFile>)]
  [(-ca <cqlAuthProvider> | --cql-auth-provider <cqlAuthProvider>)]
  [(-ju <jmxUsername> | --jmx-username <jmxUsername>)]
  [(-cp <cqlPassword> | --cql-password <cqlPassword>)] [(-cs | --cql-ssl)]
  [(-h <cqlHost> | --host <cqlHost>)] <command> [<args>]
  
The most commonly used nodesync commands are:
  disable      Disable nodesync on the specified tables
  enable       Enable nodesync on the specified tables
  help         Display help information
  tracing      Enable/disable tracing for NodeSync
  validation   Monitor/manage user-triggered validations
  
See 'nodesync help <command>' for more information on a specific command.

Display help for specific nodesync command

nodesync help validation

NAME
    nodesync validation - Monitor/manage user-triggered validations

SYNOPSIS
    nodesync validation
    nodesync [(-ju <jmxUsername> | --jmx-username <jmxUsername>)]
        [(-cp <cqlPassword> | --cql-password <cqlPassword>)]
        [(-p <cqlPort> | --port <cqlPort>)]
        [(-jp <jmxPassword> | --jmx-password <jmxPassword>)]
        [(-jpf <jmxPasswordFile> | --jmx-password-file <jmxPasswordFile>)]
        [(-ca <cqlAuthProvider> | --cql-auth-provider <cqlAuthProvider>)]
        [(-cu <cqlUsername> | --cql-username <cqlUsername>)] [(-js | --jmx-ssl)]
        [(-h <cqlHost> | --host <cqlHost>)] [(-cs | --cql-ssl)] validation
        cancel [--quiet] [(-v | --verbose)]
    nodesync [(-ju <jmxUsername> | --jmx-username <jmxUsername>)]
        [(-cp <cqlPassword> | --cql-password <cqlPassword>)]
        [(-p <cqlPort> | --port <cqlPort>)]
        [(-jp <jmxPassword> | --jmx-password <jmxPassword>)]
        [(-jpf <jmxPasswordFile> | --jmx-password-file <jmxPasswordFile>)]
        [(-ca <cqlAuthProvider> | --cql-auth-provider <cqlAuthProvider>)]
        [(-cu <cqlUsername> | --cql-username <cqlUsername>)] [(-js | --jmx-ssl)]
        [(-h <cqlHost> | --host <cqlHost>)] [(-cs | --cql-ssl)] validation list
        [--quiet] [(-v | --verbose)] [(-a | --all)]
    nodesync [(-ju <jmxUsername> | --jmx-username <jmxUsername>)]
        [(-cp <cqlPassword> | --cql-password <cqlPassword>)]
        [(-p <cqlPort> | --port <cqlPort>)]
        [(-jp <jmxPassword> | --jmx-password <jmxPassword>)]
        [(-jpf <jmxPasswordFile> | --jmx-password-file <jmxPasswordFile>)]
        [(-ca <cqlAuthProvider> | --cql-auth-provider <cqlAuthProvider>)]
        [(-cu <cqlUsername> | --cql-username <cqlUsername>)] [(-js | --jmx-ssl)]
        [(-h <cqlHost> | --host <cqlHost>)] [(-cs | --cql-ssl)] validation
        submit [--quiet] [(-v | --verbose)]
        [(-r <rateInKB> | --rate <rateInKB>)]

OPTIONS
    -ca <cqlAuthProvider>, --cql-auth-provider <cqlAuthProvider>
        CQL auth provider class name
    -cp <cqlPassword>, --cql-password <cqlPassword>
        CQL password
    -cs, --cql-ssl
        Enable SSL for CQL
    -cu <cqlUsername>, --cql-username <cqlUsername>
        CQL username
    -h <cqlHost>, --host <cqlHost>
        CQL contact point address
    -jp <jmxPassword>, --jmx-password <jmxPassword>
        JMX password
    -jpf <jmxPasswordFile>, --jmx-password-file <jmxPasswordFile>
        Path to the JMX password file
    -js, --jmx-ssl
        Enable SSL for JMX
    -ju <jmxUsername>, --jmx-username <jmxUsername>
        JMX username
    -p <cqlPort>, --port <cqlPort>
        CQL port number

COMMANDS
    With no arguments, Display help information
    submit
        Submit a forced user validation
        With --quiet option, Quiet output; don't print warnings
        With --verbose option, Verbose output
        With --rate option, Rate to be used just for this validation, in KB per second
    cancel
        Cancel a user-triggered validation
        With --quiet option, Quiet output; don't print warnings
        With --verbose option, Verbose output
    list
        List user validations. By default, only running validations are
        displayed.
        With --quiet option, Quiet output; don't print warnings
        With --verbose option, Verbose output
        With --all option, List all either running or finished validations since less then 1 day

Display help for specific nodesync command with a subcommand

nodesync help validation submit

NAME
    nodesync validation submit - Submit a forced user validation

SYNOPSIS
    nodesync
        [(-ca <cqlAuthProvider> | --cql-auth-provider <cqlAuthProvider>)]
        [(-cp <cqlPassword> | --cql-password <cqlPassword>)] [(-cs | --cql-ssl)]
        [(-cu <cqlUsername> | --cql-username <cqlUsername>)]
        [(-h <cqlHost> | --host <cqlHost>)]
        [(-jp <jmxPassword> | --jmx-password <jmxPassword>)]
        [(-jpf <jmxPasswordFile> | --jmx-password-file <jmxPasswordFile>)]
        [(-js | --jmx-ssl)] [(-ju <jmxUsername> | --jmx-username <jmxUsername>)]
        [(-p <cqlPort> | --port <cqlPort>)] validation submit [(-q | --quiet)]
        [(-r <rateInKB> | --rate <rateInKB>)] [(-v | --verbose)] [--] <table>
        [<range>...]

OPTIONS
    -ca <cqlAuthProvider>, --cql-auth-provider <cqlAuthProvider>
        CQL auth provider class name
    -cp <cqlPassword>, --cql-password <cqlPassword>
        CQL password
    -cs, --cql-ssl
        Enable SSL for CQL
    -cu <cqlUsername>, --cql-username <cqlUsername>
        CQL username
    -h <cqlHost>, --host <cqlHost>
        CQL contact point address
    -jp <jmxPassword>, --jmx-password <jmxPassword>
        JMX password
    -jpf <jmxPasswordFile>, --jmx-password-file <jmxPasswordFile>
        Path to the JMX password file
    -js, --jmx-ssl
        Enable SSL for JMX
    -ju <jmxUsername>, --jmx-username <jmxUsername>
        JMX username
    -p <cqlPort>, --port <cqlPort>
        CQL port number
    -q, --quiet
        Quiet output; don't print warnings
    -r <rateInKB>, --rate <rateInKB>
        Rate to be used just for this validation, in KB per second
    -v, --verbose
        Verbose output
    --
        This option can be used to separate command-line options from the
        list of argument, (useful when arguments might be mistaken for
        command-line options
    <table> [<range>...]
        The qualified table name, optionally followed by token ranges of the
        form (x, y]. If no token ranges are specified, then all the tokens
        will be validated.