INCUS.LIST(1)

📦
version 7.0.1 · 11 versions
, in ubuntu stonking

💖 incus-list — List instances 💖

okay bestie, welcome to the Incus command line client manual, part incus-list. this is where you learn to list your instances and make the terminal give you exactly the info you want, no cap. 🦋 let's gooo.

✨ NAME ✨

incus-list — List instances

🎀 SYNOPSIS 🎀

incus list [:] [...] [flags]

👑 DESCRIPTION 👑

Description:

  • List instances

okay so first things first — the default column layout is ns46tS, and the fast column layout is nsacPt. remember those, they come back later. 👑

You can filter your list in a bunch of ways, and literally all of them are valid:

  • A single keyword like "web" which will list any instance with a name starting by "web".
  • A regular expression on the instance name. (e.g. .*web.*01$).
  • A key/value pair referring to a configuration item. For those, the namespace can be abbreviated to the smallest unambiguous identifier.
  • A key/value pair where the key is a shorthand. Multiple values must be delimited by ','. Available shorthands:
    • type={instance type}
    • status={instance current lifecycle status}
    • architecture={instance architecture}
    • location={location name}
    • ipv4={ip or CIDR}
    • ipv6={ip or CIDR}

Examples:

  • "user.blah=abc" will list all instances with the "blah" user property set to "abc".
  • "u.blah=abc" will do the same
  • "security.privileged=true" will list all privileged instances
  • "s.privileged=true" will do the same
  • "type=container" will list all container instances
  • "type=container status=running" will list all running container instances

A regular expression matching a configuration item or its value. (e.g. volatile.eth0.hwaddr=10:66:6a:.*).

When multiple filters are passed, they are added one on top of the other, selecting instances which satisfy them all. it's giving "AND", bestie — every filter has to pass, all of them, no exceptions.

🌈 == Columns == 🌈

The -c option takes a comma separated list of arguments that control which instance attributes to output when displaying in table or csv format.

Column arguments are either pre-defined shorthand chars (see below), or (extended) config keys.

Commas between consecutive shorthand chars are optional. yes really, they just vibe together. ✨

Pre-defined column shorthand chars:

  • 4 - IPv4 address
  • 6 - IPv6 address
  • a - Architecture
  • b - Storage pool
  • c - Creation date
  • d - Description
  • D - disk usage
  • e - Project name
  • l - Last used date
  • m - Memory usage
  • M - Memory usage (%)
  • n - Name
  • N - Number of Processes
  • p - PID of the instance's init process
  • P - Profiles
  • s - State
  • S - Number of snapshots
  • t - Type (persistent or ephemeral)
  • u - CPU usage (in seconds)
  • U - Started date
  • L - Location of the instance (e.g. its cluster member)
  • f - Base Image Fingerprint (short)
  • F - Base Image Fingerprint (long)

🧚 Custom columns 🧚

Custom columns are defined with "[config:|devices:]key[:name][:maxWidth]":

  • KEY: The (extended) config or devices key to display. If [config:|devices:] is omitted then it defaults to config key.
  • NAME: Name to display in the column header. Defaults to the key if not specified or empty.
  • MAXWIDTH: Max width of the column (longer results are truncated). Defaults to -1 (unlimited). Use 0 to limit to the column header size.

💅 OPTIONS 💅

  • --all-projects[=false] — Display instances from all projects
  • -c, --columns="ns46tSL" — Columns
  • --fast[=false] — Fast mode (same as --columns=nsacPt)
  • -f, --format="table" — Format (csv|json|table|yaml|compact|markdown), use suffix ,noheader to disable headers and ,header to enable it if missing, e.g. csv,header

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

these are the ones you get for free from the parent command, bestie — they're yours now 💖

  • --debug[=false] — Show all debug messages
  • --explain[=false] — If the command is valid, explain its parsed arguments instead of running it
  • --force-local[=false] — Force using the local unix socket
  • -h, --help[=false] — Print help
  • --project="" — Override the source project
  • -q, --quiet[=false] — Don't show progress information
  • --sub-commands[=false] — Use with help or --help to view sub-commands
  • -v, --verbose[=false] — Show all information messages
  • --version[=false] — Print version number

🔥 EXAMPLE 🔥

incus list -c nFs46,volatile.eth0.hwaddr:MAC,config:image.os,devices:eth0.parent:ETHP

Show instances using the "NAME", "BASE IMAGE", "STATE", "IPV4", "IPV6" and "MAC" columns. "BASE IMAGE", "MAC" and "IMAGE OS" are custom columns generated from instance configuration keys. "ETHP" is a custom column generated from a device key.

look at that custom column game, we love to see it. 🌸

incus list -c ns,user.comment:comment

List instances with their running state and user comment.

🦋 SEE ALSO 🦋

⭐ HISTORY ⭐

24-Sep-2026 Auto generated by spf13/cobra

and that's the whole page, bestie!! you ate that. 💅 this one was auto generated by spf13/cobra, dated Sep 2026, and it lives under the Incus - Command line client(1) manual. go forth and list those instances. periodt. 👑✨

📦 where this page comes from