Cl8r::CLI::FindCommand

SUBCOMMAND_DOCS = {"bmc" => "Inspect Baseboard Management Controller (BMC/IPMI) configuration for a node.\n\nUsage:\n cl8r find bmc [-f <file> | --file=<file>] [--format=<format>] [--no-color] <hostname>\n cl8r find bmc (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "bmcs" => "List all Baseboard Management Controllers (BMC/IPMI) across the cluster.\n\nUsage:\n cl8r find bmcs [-f <file> | --file=<file>] [--format=<format>] [--no-color]\n cl8r find bmcs (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "disk" => "Inspect a physical storage disk by device path, serial number, WWN, or bay coordinate.\n\nUsage:\n cl8r find disk [-f <file> | --file=<file>] [--format=<format>] [--no-color] <identifier>\n cl8r find disk (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "disks" => "Query and inspect physical storage drives across cluster nodes, racks, and chassis bays.\n\nUsage:\n cl8r find disks [-f <file> | --file=<file>] [--format=<format>] [--no-color] [--node=<node>] [--rack=<rack>] [--serial=<serial>] [--bay=<bay>] [--pool=<pool>] [--media=<media>] [<node>]\n cl8r find disks (-h | --help)\n\nFilter Options:\n --node=<node> Filter by node hostname\n --rack=<rack> Filter by rack identifier\n --serial=<serial> Filter by drive serial number\n --bay=<bay> Filter by chassis bay index\n --pool=<pool> Filter by storage pool name\n --media=<media> Filter by media technology (nvme, ssd, hdd)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "ip" => "Inspect reverse IP lookup, DNS reverse mapping, and interface binding for an address.\n\nUsage:\n cl8r find ip [-f <file> | --file=<file>] [--format=<format>] [--no-color] <address>\n cl8r find ip (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "ips" => "List assigned IP addresses, gateways, VIPs, and subnet bindings across network planes.\n\nUsage:\n cl8r find ips [-f <file> | --file=<file>] [--format=<format>] [--no-color] [<filter>]\n cl8r find ips (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "mac" => "Find network interface, node, and switch port binding by MAC address.\n\nUsage:\n cl8r find mac [-f <file> | --file=<file>] [--format=<format>] [--no-color] <mac_address>\n cl8r find mac (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "macs" => "List physical and virtual MAC address table across all interfaces.\n\nUsage:\n cl8r find macs [-f <file> | --file=<file>] [--format=<format>] [--no-color] [<filter>]\n cl8r find macs (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "node" => "Inspect a cluster node, its rack location, roles, interfaces, and storage disks.\n\nUsage:\n cl8r find node [-f <file> | --file=<file>] [--format=<format>] [--no-color] <hostname>\n cl8r find node (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "nodes" => "List all bare-metal hosts and virtual machines defined in the cluster.\n\nUsage:\n cl8r find nodes [-f <file> | --file=<file>] [--format=<format>] [--no-color]\n cl8r find nodes (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "path" => "Trace the layer 2 and layer 3 network path and switch hops between two endpoints.\n\nUsage:\n cl8r find path [-f <file> | --file=<file>] [--format=<format>] [--no-color] <source> <target>\n cl8r find path (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "pool" => "Inspect a host-local or distributed storage pool and its member drives.\n\nUsage:\n cl8r find pool [-f <file> | --file=<file>] [--format=<format>] [--no-color] <name>\n cl8r find pool (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "port" => "Inspect a specific switch port configuration, speed, connected device, and VLAN tagging.\n\nUsage:\n cl8r find port [-f <file> | --file=<file>] [--format=<format>] [--no-color] <switch> <port_id>\n cl8r find port (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "ports" => "Query and inspect physical switch ports across switches in the network fabric.\n\nUsage:\n cl8r find ports [-f <file> | --file=<file>] [--format=<format>] [--available | --unavailable] [--no-color] [<switch>]\n cl8r find ports (-h | --help)\n\nFilter Options:\n --available Filter for available/free (uncabled) switch ports\n --unavailable Filter for unavailable/connected switch ports\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "rack" => "Inspect a datacenter rack, its RU height, PDU feeds, and slotted server elevations.\n\nUsage:\n cl8r find rack [-f <file> | --file=<file>] [--format=<format>] [--no-color] <rack_name>\n cl8r find rack (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "racks" => "List all datacenter racks, RU utilization, and power distribution units.\n\nUsage:\n cl8r find racks [-f <file> | --file=<file>] [--format=<format>] [--no-color]\n cl8r find racks (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "range" => "Inspect dynamic DHCP, static, and reserved IP address pools for a VLAN or network plane.\n\nUsage:\n cl8r find range [-f <file> | --file=<file>] [--format=<format>] [--no-color] <vlan_id>\n cl8r find range (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "reachability" => "Evaluate layer 2/layer 3 connectivity and shared VLAN isolation between two endpoints.\n\nUsage:\n cl8r find reachability [-f <file> | --file=<file>] [--format=<format>] [--no-color] <source> <target>\n cl8r find reachability (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "storage" => "Overview of cluster storage pools, raw/usable capacities, and media breakdown.\n\nUsage:\n cl8r find storage [-f <file> | --file=<file>] [--format=<format>] [--no-color]\n cl8r find storage (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "switch" => "Inspect a Top-of-Rack (TOR) or spine switch, management IP, model, and port map.\n\nUsage:\n cl8r find switch [-f <file> | --file=<file>] [--format=<format>] [--no-color] <switch_name>\n cl8r find switch (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "switches" => "List all Top-of-Rack (TOR) and core spine switches across datacenter racks.\n\nUsage:\n cl8r find switches [-f <file> | --file=<file>] [--format=<format>] [--no-color]\n cl8r find switches (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "vlan" => "Inspect network plane details, CIDR subnets, gateway, and VIPs by VLAN ID or plane name.\n\nUsage:\n cl8r find vlan [-f <file> | --file=<file>] [--format=<format>] [--no-color] <id>\n cl8r find vlan (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message", "vlans" => "List all network planes, VLAN IDs, MTUs, and IPAM subnets.\n\nUsage:\n cl8r find vlans [-f <file> | --file=<file>] [--format=<format>] [--no-color]\n cl8r find vlans (-h | --help)\n\nCommon Options:\n -f <file>, --file=<file> Cluster specification YAML [default: cluster.yaml]\n --format=<format> Output format: pretty, text, json, yaml, csv [default: pretty]\n --no-color Disable ANSI color formatting\n -h, --help Show this help message"}

new(options : Hash(String, String | Int32 | Bool | Array(String) | Nil), stdout : IO = STDOUT, stderr : IO = STDERR)

doc=(doc : String)

name=(name : String)

subcommand_help_for(args : Array(String)) : String | Nil

stderr=(stderr : IO)

stdout=(stdout : IO)