Skip to content

SoftIron Documentation

version

Initializing search

Home
HyperCloud
VM²
Appliances
Releases
Advisories

SoftIron Documentation

Home
HyperCloud
HyperCloud
- Learn HyperCloud
  Learn HyperCloud
  - Background
  - Problem
  - Design Goals
  - Architecture
    Architecture
    
    Hardware Management
    
    Networking
    
    Storage
    
    Virtualization
    
    Containerization
    
    Service Catalog
    
    Tenancy Management
    
    Management
    
    Reference Configuration
  - Summary
  - Advanced
    Advanced
    
    Deployment Guide
- User Guide
  User Guide
  - Authentication and access
    Authentication and access
    
    Logging in
    
    SSH Keys
    
    User Authentication
    
    Users
    
    Groups
    
    VDCs
    
    Dashboard SSH Keys
    
    Dashboard Admin Password
    
    Setting an SSH Banner
    
    Modifying SSH Cipher
    
    Enabling Cloud Federation
  - Compute
    Compute
    
    Instances
    Instances
    
    Overview
    
    Scheduling Instances
    
    Shutdown, Undeploy and Terminate
    
    Change Syslog Protocol
    
    Resource Allocation
    
    Autoscaling Services
    
    Load Balancers
    
    Updating UI Certificate
    
    Configuring Client Certificate
    
    Changing Dashboard Admin Password
    
    Enabling Cluster-wide Syslog
    
    NVIDIA GRID
    
    Cloud Bursting
    Cloud Bursting
    
    Overview
    
    Amazon EC2
    
    Amazon EC2 Reference
    
    Troubleshooting
    Troubleshooting
    
    VMs Wrong Group
    
    Restoring Replicated VMs
  - Marketplaces
    Marketplaces
    
    SoftIron Marketplaces
    
    Marketplace Images Offline
    
    Creating Apps
    
    Custom Marketplaces
  - Containers
    Containers
    
    Enabling LXD Containers
    
    Kubernetes with K3s
  - Images and backups
    
    Images and backups
    
    Creating Templates
    
    Building from ISO
    
    Building with libguestfs
    
    One Context Refresh
    
    Creating a Windows Image Template
    
    Managing Backups
    
    Restoring Large Replicated Volumes
    
    Snapshots
    
    Snapshots
    
    Backups service
    
    Local Snapshot Usage
    
    Remote Snapshot Usage
    
    Archive Snapshot Usage
    
    Snapshot System State
  - Networking
    Networking
    
    Security Groups
    
    Virtual Networks
    
    Virtual Routers
    
    Dashboard Node IP
    
    Static Routes
    
    Manual DNS Entry
    
    DNS with Dnsmasq (GitHub)
    
    Configure MTU
    
    Network Initialization
    
    Change Syslog Protocol
    
    Troubleshooting
    Troubleshooting
    
    Firewall Drops Packets
    
    Bridging Loop
  - Storage
    Storage
    
    Datastores
    
    Managing Files
    
    EC Datastores
    
    VirtIO-SCSI
    
    Bcache Devices
    
    Shared Block Storage
    
    Block IO Size
    
    Bcache Tuneables
    
    Filesystem Usage
    
    Remote and Backup List and Import
    
    Object Storage with MinIO
    
    Full Disk Encryption
    
    Troubleshooting
    Troubleshooting
    
    Recovering Corrupted Monitor
    
    Recovering Failed Disk
    
    Restoring Replicated VMs
    
    ARM Node Boot Failure
  - Cluster management
    Cluster management
    
    Cloud Management GUI
    
    Setting Dashboard CPU, Memory, and rootfs
    
    Pausing Ceph
    
    Shutting Down Cluster
    
    Wipe Node
    
    Accounting
    Accounting
    
    Accounting Client
    
    Showback
    
    IPMI
    
    Monitoring with Prometheus and Grafana
    
    Prometheus Exporter Python Package
    
    Flashing M2 Drives
    
    Upgrading
    
    Upgrading
    
    Upgrading HyperCloud
    
    HyperCloud upgrade prior to 2.1
    HyperCloud upgrade prior to 2.1
    
    HyperCloud upgrade to version 2.2 from before 2.1
    
    Legacy firmware upgrade
    
    Hot Patching
    Hot Patching
    
    Creating Hot Patches
    
    Installing Hot Patches
    
    Expunging Hot Patches
    
    Listing Hot Patches
    
    Automatic Patching Rules
    
    Emergency Hot Patching
  - Interfaces and external clouds
    Interfaces and external clouds
    
    CLI
    
    CLI
    
    Accounting
    
    Access-control lists
    
    Cluster
    
    Datastore
    
    Group
    
    Hook
    
    Host
    
    Image
    
    Market
    
    Marketplace appliances
    
    Security groups
    
    Showback
    
    Template
    
    User
    
    vCenter
    
    Virtual datacenter
    
    Virtual machine
    
    Virtual network
    
    Virtual Network template
    
    Virtual Router
    
    Zone
    
    HyperCloud API
    
    S3 Documentation
    
    Amazon EC2
    
    Amazon EC2 Reference
- Quick Reference
  Quick Reference
  - Releases
    Releases
    
    Hypercloud
    
    VM²
    
    Appliances
  - Advisories
  - Shutdown, Undeploy and Terminate
  - Change Syslog Protocol
VM²
VM²
- Getting Started
  Getting Started
  - Requirements
  - First Steps
    First Steps
    
    Installation & License
    
    Cluster Management
    
    Creating your first Virtual Machine
  - How To
    How To
    
    Converting VMWare vCenters
    
    VMWare Import with Catalyst
    
    Configure Active Directory
    
    Configure iSCSI Initiator
    
    Configure LDAP Authentication
    
    Configure an NFS Datastore
    
    Create Images from ISO
    
    Create Windows 10 Template
    
    Create Windows 11 Template
    
    Update License
    
    Upgrade the Cluster
    
    Decommission a Node
  - Reference Architecture
    
    Reference Architecture
    
    Overview
    
    Host networking
    
    Host storage
    
    Example environment
    
    Users and groups
    
    Virtual Data Centers (VDCs)
    
    Networking appliances
    
    Additional security
  - Troubleshooting
    Troubleshooting
    
    Known issues
    
    Hardware specific issues
- Glasshouse
  Glasshouse
- Catalyst Importer
  Catalyst Importer
- Turbine Hypervisor
  Turbine Hypervisor
- Amplifier Marketplace
  Amplifier Marketplace
  - Accessing Amplifier images offline
- Electron Network
  Electron Network
- Neutron Storage
  Neutron Storage
- Manifold API
  Manifold API
  - Interacting with Manifold
- Command Line
  Command Line
  - Dashboard commands
    Dashboard commands
    
    cluster-reboot
    
    decom-node
    
    manage-admin-password
    
    manage-catalyst-keys
    
    manage-ldap
    
    manage-networking
    
    manage-nfs
    
    manage-tls-certificate
    
    sifi
    
    ssh
    
    upgrade
    
    vmsquared
  - Host commands
    Host commands
    
    dashboard-console
    
    manage-iscsi.md
    
    vm
  - cluster-manage
  - expert
  - halt
  - help
  - image
  - manage-cluster-name
  - manage-disk-encryption
  - manage-license
  - manage-ssh-keys
  - reboot
  - setterm
  - show-current-config
  - storage
  - uptime
  - version
Appliances
Appliances
Releases
Releases
Advisories

version

This command shows the current VM Squared version.

VMsquared:vmsquared\dashboard> version
VMsquared 2.5.0

HyperCloud appliances

Copyright © SoftIron Limited 2025. All rights reserved.