Console Overview

This section of HyperCloud Legacy documentation will outline the available commands that can be utilized on the dashboard or host's consoles.

Typing help into the dashboard console will bring up the HyperCloud Legacy Help Menu, which lists the dashboard and cluster commands available.

SoftIron:HCLegacy\dashboard> help
SoftIron Help Menu:
--------------------------------------------------------------------------------
Dashboard Commands: 
  cluster-reboot           - Reboot the entire cluster
  decom-node               - Decommission Node Tool
  hypercloud               - SoftIron Unified Command Line Tool
  install-ai-model         - Install a new AI model from the files datastore
  manage-admin-password    - Manage admin password for management frontend
  manage-catalyst-ssh-keys - Manage SSH keys for catalyst
  manage-ldap              - Manage LDAP or AD configuration
  manage-networking        - Manage external networking (Beta)
  manage-nfs               - Manage NFS datastores (Beta)
  manage-tls-certificate   - Manage TLS certificates for frontend
  nvidia-grid-install      - Install NVIDIA GRID components (from upload)
  nvidia-grid-uninstall    - Uninstall NVIDIA GRID components (if installed)
  set-syslog-protocol      - Set syslog protocol (tcp or udp)
  sifi                     - SoftIron Federated API Command Line Tool
  ssh                      - Log into backend nodes from the management node
  upgrade                  - Upgrade the cluster

All Other Commands: 
  cluster-manage           - Manage cluster management IP settings
  debug                    - Enter debug mode (under direction of support only)
  halt                     - Halt the node
  help                     - Display this help menu
  image                    - Manage software defined storage block devices
  manage-cluster-name      - Manage cluster name
  manage-disk-encryption   - Manage full disk encryption configuration
  manage-license           - Manage license file
  manage-ssh-keys          - Manage SSH keys for management frontend
  pager                    - Pager for terminal output (similar to more)
  reboot                   - Reboot the node
  setterm                  - Set terminal attributes
  show-current-config      - Show Current Dashboard Configuration
  storage                  - Manage software defined storage cluster
  system                   - System management commands (node-level)
  uptime                   - System uptime
  version                  - Show software version
--------------------------------------------------------------------------------

HyperCloud Legacy contains multiple commands to interact with the dashboard and individual nodes. Browse a list of commands below for an overview of each, including options and argument formats.

Dashboard-only commands

If connected to the dashboard, the following dashboard commands are available:

cluster-reboot           - Reboot the entire cluster
decom-node               - Decommission Node Tool
hypercloud               - SoftIron Unified Command Line Tool
install-ai-model         - Install a new AI model from the files datastore
manage-admin-password    - Manage admin password for management frontend
manage-catalyst-ssh-keys - Manage SSH keys for catalyst
manage-ldap              - Manage LDAP or AD configuration
manage-networking        - Manage external networking (Beta)
manage-nfs               - Manage NFS datastores (Beta)
manage-tls-certificate   - Manage TLS certificates for frontend
nvidia-grid-install      - Install NVIDIA GRID components (from upload)
nvidia-grid-uninstall    - Uninstall NVIDIA GRID components (if installed)
set-syslog-protocol      - Set syslog protocol (tcp or udp)
sifi                     - SoftIron Federated API Command Line Tool
ssh                      - Log into backend nodes from the management node
upgrade                  - Upgrade the cluster

Host-only commands

If connected to host console, the following host commands are available:

dashboard-console        - Access dashboard console (if running on this node)
manage-iscsi             - Configure iSCSI initiator for this host (Beta)
multipath                - List multipath paths (if applicable)
vm                       - Manually manage VMs running on this node

Universal commands

The following commands can be accessed from both the dashboard and individual nodes

cluster-manage           - Manage cluster management IP settings
debug                    - Enter debug mode (under direction of support only)
halt                     - Halt the node
help                     - Display this help menu
image                    - Manage software defined storage block devices
manage-cluster-name      - Manage cluster name
manage-disk-encryption   - Manage full disk encryption configuration
manage-license           - Manage license file
manage-ssh-keys          - Manage SSH keys for management frontend
pager                    - Pager for terminal output (similar to more)
reboot                   - Reboot the node
setterm                  - Set terminal attributes
show-current-config      - Show Current Dashboard Configuration
storage                  - Manage software defined storage cluster
system                   - System management commands (node-level)
uptime                   - System uptime
version                  - Show software version