wiki
  • 👋Welcome to the Ax Framework Wiki
  • Overview
    • ✅Existing Users
    • 💿Installation Guide
    • 💻Ax Controller
    • 💡How it Works
    • ▶️QuickStart Guide
      • Configure Ax Controller
      • Build a Base Image
      • Deploy Instances
      • List Instances
      • Run Scans
      • Teardown Instances
  • Fundamentals
    • 🛠️Ax Utility Scripts
    • 🔎Bring Your Own Provisioner
    • ⚔️Fleets
    • 🚀Scans
      • 🤖Modules
        • 📤Adding Simple Modules
        • 🎯Adding One-Shot Modules
        • 📎Merging and Module Extensions
      • ⚙️Horizontal vs Vertical Scaling
    • 🤝Responsibility
    • 📖Terminology
Powered by GitBook
On this page
  • axiom-rm
  • Help Menu
  1. Overview
  2. QuickStart Guide

Teardown Instances

axiom-rm

Remove one or more axiom instances ❌

Once you're done with your instance, delete it using the command, axiom-rm

axiom-rm jerry
axiom-rm jerry -f # avoid confirmation prompts
axiom-rm jerry01 jerry02 -f # explicitly list the names of the instances to delete
axiom-rm 'jerry\*' -f # delete all instances starting with jerry
axiom-rm '\*erry\*' -f # delete based on substring matches

The -f/--force flag will not prompt on deletion, I generally use this, but if you want to be ultra sure omit the -f flag.

The -m/--multi flag deletes many instances at once. Its a faster way to delete instances and uses less API calls (with most providers)

Help Menu

Description:
  Delete one or more cloud hosted compute devices
  Supports globbing (wildcarding) to match instances based on patterns in their names, such as prefix, suffix, or substring matches.
Examples:
  axiom-rm testy01 # Delete instance named 'testy01'
  axiom-rm 'testy*' # Delete all instances starting with 'testy' (you may need to escape the asterisk)
  axiom-rm '*tess*' # Delete all instances containing the string 'tess' (you may need to escape the asterisks)
  axiom-rm '\*' --force --multi # Delete all instances on the account, avoid confirmation prompts, delete many instances with one API call
Usage:
  <name> string (required)
    Name of the instance(s) to delete
  -f/--force (optional)
    Avoid confirmation prompts
  -m/--multi (optional)
    Delete multiple instances at once
  --debug (optional)
    Run with set -xv, warning: very verbose
  --help (optional)
    Display this help menu

PreviousRun ScansNextAx Utility Scripts

Last updated 3 months ago

▶️