Skip to main content

Command line

When to use​

When cluster operations are easier to perform from a terminal or scripts than through the web UI.

Methods​

vStack Center has no command-line utility of its own. Scripts interact with it through the JSON-RPC API: each method is called with a standard HTTP request and requires the same privileges as the action in the web UI.

Command-line utilities are available on cluster nodes as part of vStack OS:

  • vstack-cluster — cluster nodes and services: status, taking a node out of service, and moving a pool to another node;
  • vStack.update.sh — node update.

They are described in the vStack OS documentation: Node CLI.

Example​

Cluster composition and node status through the vStack Center API, using the get-statusmap method:

{
  "jsonrpc": "2.0",
  "method": "get-statusmap",
  "params": {
    "auth": { "cookie": "..." }
  },
  "id": "1"
}

The same on a node, using vStack OS tools:

vstack-cluster status