Skip to content

Latest commit

 

History

History
86 lines (67 loc) · 2.23 KB

help.md

File metadata and controls

86 lines (67 loc) · 2.23 KB

Docs home

Help commands

Command list

Top-level commands

Get help on top-level commands.

% aerolab help
Usage:
  aerolab [OPTIONS] <command>

Available commands:
  config     Show or change aerolab configuration
  cluster    Create and manage Aerospike clusters and nodes
  aerospike  Aerospike daemon controls
  attach     Attach to a node and run a command
  net        Firewall and latency simulation
  conf       Manage Aerospike configuration on running nodes
  tls        Create or copy TLS certificates
  data       Insert/delete Aerospike data
  template   Manage or delete template images
  installer  List or download Aerospike installer versions
  logs       show or download logs
  files      Upload/Download files to/from clients or clusters
  xdr        Manage clusters' xdr configuration
  roster     Show or apply strong-consistency rosters
  version    Print AeroLab version
  help       Print help

Sub-commands

Get help on sub-commands of each top-level command.

% aerolab cluster help
Usage:
  aerolab [OPTIONS] cluster [command]

Available commands:
  create   Create a new cluster
  list     List clusters
  start    Start cluster
  stop     Stop cluster
  grow     Add nodes to cluster
  destroy  Destroy cluster
  help     Print help

Command-specific help

Get help on a specific command.

% aerolab cluster stop help
Usage:
  aerolab [OPTIONS] cluster stop [stop-OPTIONS] [help]

[stop command options]
      -n, --name=  Cluster names, comma separated OR 'all' to affect all clusters (default: mydc)
      -l, --nodes= Nodes list, comma separated. Empty=ALL

Available commands:
  help  Print help

Command-specific help midway through typing the command

Get help on a specific without executing the command by appending help as the last parameter.

% aerolab cluster create -n test -c 4 help
Usage:
  aerolab [OPTIONS] cluster create [create-OPTIONS] [help]

[create command options]
      -n, --name=                     Cluster name (default: mydc)
      -c, --count=                    Number of nodes (default: 1)
      -o, --customconf=               Custom config file path to install
      -f, --featurefile=              Features file to install
...