# CLI Commands ## `rpk` ``` USAGE: rpk [OPTIONS] OPTIONS: -h, --help Prints help information -v, --version Prints version information COMMANDS: summary Show a summarized report of all resources in the system servers Manage servers and their components switches Manage network switches routers Manage network routers firewalls Manage firewalls systems Manage systems and their dependencies accesspoints Manage access points ups Manage UPS units desktops Manage desktop computers and their components laptops Manage Laptop computers and their components services Manage services and their configurations ansible Generate and manage Ansible inventory ssh Generate SSH configuration from infrastructure hosts Generate a hosts file from infrastructure mermaid Generate Mermaid diagrams from infrastructure ``` ## `rpk accesspoints` ``` DESCRIPTION: Manage access points USAGE: rpk accesspoints [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: summary Show a hardware report for all access points add Add a new access point list List all access points get Retrieve an access point by name describe Show detailed information about an access point set Update properties of an access point del Delete an access point label Manage labels on an access point ``` ## `rpk accesspoints add` ``` DESCRIPTION: Add a new access point USAGE: rpk accesspoints add [OPTIONS] ARGUMENTS: The access point name OPTIONS: -h, --help Prints help information ``` ## `rpk accesspoints del` ``` DESCRIPTION: Delete an access point USAGE: rpk accesspoints del [OPTIONS] ARGUMENTS: The access point name OPTIONS: -h, --help Prints help information ``` ## `rpk accesspoints describe` ``` DESCRIPTION: Show detailed information about an access point USAGE: rpk accesspoints describe [OPTIONS] ARGUMENTS: The access point name OPTIONS: -h, --help Prints help information ``` ## `rpk accesspoints get` ``` DESCRIPTION: Retrieve an access point by name USAGE: rpk accesspoints get [OPTIONS] ARGUMENTS: The access point name OPTIONS: -h, --help Prints help information ``` ## `rpk accesspoints label` ``` DESCRIPTION: Manage labels on an access point USAGE: rpk accesspoints label [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a label to an access point remove Remove a label from an access point ``` ## `rpk accesspoints label add` ``` DESCRIPTION: Add a label to an access point USAGE: rpk accesspoints label add [OPTIONS] ARGUMENTS: The access point name OPTIONS: -h, --help Prints help information --key --value ``` ## `rpk accesspoints label remove` ``` DESCRIPTION: Remove a label from an access point USAGE: rpk accesspoints label remove [OPTIONS] ARGUMENTS: The access point name OPTIONS: -h, --help Prints help information --key ``` ## `rpk accesspoints list` ``` DESCRIPTION: List all access points USAGE: rpk accesspoints list [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk accesspoints set` ``` DESCRIPTION: Update properties of an access point USAGE: rpk accesspoints set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --model The access point model name --speed The speed of the access point in Gb ``` ## `rpk accesspoints summary` ``` DESCRIPTION: Show a hardware report for all access points USAGE: rpk accesspoints summary [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk ansible` ``` DESCRIPTION: Generate and manage Ansible inventory USAGE: rpk ansible [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: inventory Generate an Ansible inventory ``` ## `rpk ansible inventory` ``` DESCRIPTION: Generate an Ansible inventory USAGE: rpk ansible inventory [OPTIONS] OPTIONS: DEFAULT -h, --help Prints help information --group-tags Comma-separated list of tags to group by (e.g. prod,staging) --group-labels Comma-separated list of label keys to group by (e.g. env,site) --global-var Global variable (repeatable). Format: key=value --format ini Inventory format: ini (default) or yaml -o, --output Write inventory to file instead of stdout ``` ## `rpk desktops` ``` DESCRIPTION: Manage desktop computers and their components USAGE: rpk desktops [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a new desktop list List all desktops get Retrieve a desktop by name describe Show detailed information about a desktop set Update properties of a desktop del Delete a desktop from the inventory summary Show a summarized hardware report for all desktops tree Display the dependency tree for a desktop cpu Manage CPUs attached to desktops drive Manage storage drives attached to desktops gpu Manage GPUs attached to desktops nic Manage network interface cards (NICs) for desktops label Manage labels on a desktop ``` ## `rpk desktops add` ``` DESCRIPTION: Add a new desktop USAGE: rpk desktops add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk desktops cpu` ``` DESCRIPTION: Manage CPUs attached to desktops USAGE: rpk desktops cpu [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a CPU to a desktop set Update a desktop CPU del Remove a CPU from a desktop ``` ## `rpk desktops cpu add` ``` DESCRIPTION: Add a CPU to a desktop USAGE: rpk desktops cpu add [OPTIONS] ARGUMENTS: The desktop name OPTIONS: -h, --help Prints help information --model The model name --cores The number of cpu cores --threads The number of cpu threads ``` ## `rpk desktops cpu del` ``` DESCRIPTION: Remove a CPU from a desktop USAGE: rpk desktops cpu del [OPTIONS] ARGUMENTS: The name of the desktop The index of the desktop cpu to remove OPTIONS: -h, --help Prints help information ``` ## `rpk desktops cpu set` ``` DESCRIPTION: Update a desktop CPU USAGE: rpk desktops cpu set [OPTIONS] ARGUMENTS: The desktop name The index of the desktop cpu OPTIONS: -h, --help Prints help information --model The cpu model --cores The number of cpu cores --threads The number of cpu threads ``` ## `rpk desktops del` ``` DESCRIPTION: Delete a desktop from the inventory USAGE: rpk desktops del [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk desktops describe` ``` DESCRIPTION: Show detailed information about a desktop USAGE: rpk desktops describe [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk desktops drive` ``` DESCRIPTION: Manage storage drives attached to desktops USAGE: rpk desktops drive [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a drive to a desktop set Update a desktop drive del Remove a drive from a desktop ``` ## `rpk desktops drive add` ``` DESCRIPTION: Add a drive to a desktop USAGE: rpk desktops drive add [OPTIONS] ARGUMENTS: The name of the desktop OPTIONS: -h, --help Prints help information --type The drive type e.g hdd / ssd --size The drive capacity in GB ``` ## `rpk desktops drive del` ``` DESCRIPTION: Remove a drive from a desktop USAGE: rpk desktops drive del [OPTIONS] ARGUMENTS: The name of the desktop The index of the drive to remove OPTIONS: -h, --help Prints help information ``` ## `rpk desktops drive set` ``` DESCRIPTION: Update a desktop drive USAGE: rpk desktops drive set [OPTIONS] ARGUMENTS: The desktop name The drive index to update OPTIONS: -h, --help Prints help information --type The drive type e.g hdd / ssd --size The drive capacity in Gb ``` ## `rpk desktops get` ``` DESCRIPTION: Retrieve a desktop by name USAGE: rpk desktops get [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk desktops gpu` ``` DESCRIPTION: Manage GPUs attached to desktops USAGE: rpk desktops gpu [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a GPU to a desktop set Update a desktop GPU del Remove a GPU from a desktop ``` ## `rpk desktops gpu add` ``` DESCRIPTION: Add a GPU to a desktop USAGE: rpk desktops gpu add [OPTIONS] ARGUMENTS: The name of the desktop OPTIONS: -h, --help Prints help information --model The Gpu model --vram The amount of gpu vram in Gb ``` ## `rpk desktops gpu del` ``` DESCRIPTION: Remove a GPU from a desktop USAGE: rpk desktops gpu del [OPTIONS] ARGUMENTS: The desktop name The index of the Gpu to remove OPTIONS: -h, --help Prints help information ``` ## `rpk desktops gpu set` ``` DESCRIPTION: Update a desktop GPU USAGE: rpk desktops gpu set [OPTIONS] ARGUMENTS: The desktop name The index of the gpu to update OPTIONS: -h, --help Prints help information --model The gpu model name --vram The amount of gpu vram in Gb ``` ## `rpk desktops label` ``` DESCRIPTION: Manage labels on a desktop USAGE: rpk desktops label [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a label to a desktop remove Remove a label from a desktop ``` ## `rpk desktops label add` ``` DESCRIPTION: Add a label to a desktop USAGE: rpk desktops label add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --key --value ``` ## `rpk desktops label remove` ``` DESCRIPTION: Remove a label from a desktop USAGE: rpk desktops label remove [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --key ``` ## `rpk desktops list` ``` DESCRIPTION: List all desktops USAGE: rpk desktops list [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk desktops nic` ``` DESCRIPTION: Manage network interface cards (NICs) for desktops USAGE: rpk desktops nic [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a NIC to a desktop set Update a desktop NIC del Remove a NIC from a desktop ``` ## `rpk desktops nic add` ``` DESCRIPTION: Add a NIC to a desktop USAGE: rpk desktops nic add [OPTIONS] ARGUMENTS: The desktop name OPTIONS: -h, --help Prints help information --type The nic port type e.g rj45 / sfp+ --speed The port speed --ports The number of ports ``` ## `rpk desktops nic del` ``` DESCRIPTION: Remove a NIC from a desktop USAGE: rpk desktops nic del [OPTIONS] ARGUMENTS: The desktop name The index of the nic to remove OPTIONS: -h, --help Prints help information ``` ## `rpk desktops nic set` ``` DESCRIPTION: Update a desktop NIC USAGE: rpk desktops nic set [OPTIONS] ARGUMENTS: The desktop name The index of the nic to remove OPTIONS: -h, --help Prints help information --type The nic port type e.g rj45 / sfp+ --speed The speed of the nic in Gb/s --ports The number of ports ``` ## `rpk desktops set` ``` DESCRIPTION: Update properties of a desktop USAGE: rpk desktops set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --model ``` ## `rpk desktops summary` ``` DESCRIPTION: Show a summarized hardware report for all desktops USAGE: rpk desktops summary [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk desktops tree` ``` DESCRIPTION: Display the dependency tree for a desktop USAGE: rpk desktops tree [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk firewalls` ``` DESCRIPTION: Manage firewalls USAGE: rpk firewalls [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: summary Show a hardware report for all firewalls add Add a new firewall to the inventory list List all firewalls in the system get Retrieve details of a specific firewall by name describe Show detailed information about a firewall set Update properties of a firewall del Delete a firewall from the inventory port Manage ports on a firewall label Manage labels on a firewall ``` ## `rpk firewalls add` ``` DESCRIPTION: Add a new firewall to the inventory USAGE: rpk firewalls add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk firewalls del` ``` DESCRIPTION: Delete a firewall from the inventory USAGE: rpk firewalls del [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk firewalls describe` ``` DESCRIPTION: Show detailed information about a firewall USAGE: rpk firewalls describe [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk firewalls get` ``` DESCRIPTION: Retrieve details of a specific firewall by name USAGE: rpk firewalls get [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk firewalls label` ``` DESCRIPTION: Manage labels on a firewall USAGE: rpk firewalls label [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a label to a firewall remove Remove a label from a firewall ``` ## `rpk firewalls label add` ``` DESCRIPTION: Add a label to a firewall USAGE: rpk firewalls label add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --key --value ``` ## `rpk firewalls label remove` ``` DESCRIPTION: Remove a label from a firewall USAGE: rpk firewalls label remove [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --key ``` ## `rpk firewalls list` ``` DESCRIPTION: List all firewalls in the system USAGE: rpk firewalls list [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk firewalls port` ``` DESCRIPTION: Manage ports on a firewall USAGE: rpk firewalls port [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a port to a firewall set Update a firewall port del Remove a port from a firewall ``` ## `rpk firewalls port add` ``` DESCRIPTION: Add a port to a firewall USAGE: rpk firewalls port add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --type --speed --count ``` ## `rpk firewalls port del` ``` DESCRIPTION: Remove a port from a firewall USAGE: rpk firewalls port del [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --index ``` ## `rpk firewalls port set` ``` DESCRIPTION: Update a firewall port USAGE: rpk firewalls port set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --index --type --speed --count ``` ## `rpk firewalls set` ``` DESCRIPTION: Update properties of a firewall USAGE: rpk firewalls set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --Model --managed --poe ``` ## `rpk firewalls summary` ``` DESCRIPTION: Show a hardware report for all firewalls USAGE: rpk firewalls summary [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk hosts` ``` DESCRIPTION: Generate a hosts file from infrastructure USAGE: rpk hosts [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: export Generate a /etc/hosts compatible file ``` ## `rpk hosts export` ``` DESCRIPTION: Generate a /etc/hosts compatible file USAGE: rpk hosts export [OPTIONS] OPTIONS: -h, --help Prints help information --include-tags Comma-separated list of tags to include (e.g. prod,staging) --domain-suffix Optional domain suffix to append (e.g. home.local) --no-localhost Do not include localhost defaults -o, --output Write hosts file to file instead of stdout ``` ## `rpk laptops` ``` DESCRIPTION: Manage Laptop computers and their components USAGE: rpk laptops [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a new Laptop list List all Laptops get Retrieve a Laptop by name describe Show detailed information about a Laptop set Update properties of a laptop del Delete a Laptop from the inventory summary Show a summarized hardware report for all Laptops tree Display the dependency tree for a Laptop cpu Manage CPUs attached to Laptops drives Manage storage drives attached to Laptops gpu Manage GPUs attached to Laptops label Manage labels on a laptop ``` ## `rpk laptops add` ``` DESCRIPTION: Add a new Laptop USAGE: rpk laptops add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk laptops cpu` ``` DESCRIPTION: Manage CPUs attached to Laptops USAGE: rpk laptops cpu [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a CPU to a Laptop set Update a Laptop CPU del Remove a CPU from a Laptop ``` ## `rpk laptops cpu add` ``` DESCRIPTION: Add a CPU to a Laptop USAGE: rpk laptops cpu add [OPTIONS] ARGUMENTS: The Laptop name OPTIONS: -h, --help Prints help information --model The model name --cores The number of cpu cores --threads The number of cpu threads ``` ## `rpk laptops cpu del` ``` DESCRIPTION: Remove a CPU from a Laptop USAGE: rpk laptops cpu del [OPTIONS] ARGUMENTS: The name of the Laptop The index of the Laptop cpu to remove OPTIONS: -h, --help Prints help information ``` ## `rpk laptops cpu set` ``` DESCRIPTION: Update a Laptop CPU USAGE: rpk laptops cpu set [OPTIONS] ARGUMENTS: The Laptop name The index of the Laptop cpu OPTIONS: -h, --help Prints help information --model The cpu model --cores The number of cpu cores --threads The number of cpu threads ``` ## `rpk laptops del` ``` DESCRIPTION: Delete a Laptop from the inventory USAGE: rpk laptops del [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk laptops describe` ``` DESCRIPTION: Show detailed information about a Laptop USAGE: rpk laptops describe [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk laptops drives` ``` DESCRIPTION: Manage storage drives attached to Laptops USAGE: rpk laptops drives [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a drive to a Laptop set Update a Laptop drive del Remove a drive from a Laptop ``` ## `rpk laptops drives add` ``` DESCRIPTION: Add a drive to a Laptop USAGE: rpk laptops drives add [OPTIONS] ARGUMENTS: The name of the Laptop OPTIONS: -h, --help Prints help information --type The drive type e.g hdd / ssd --size The drive capacity in GB: ``` ## `rpk laptops drives del` ``` DESCRIPTION: Remove a drive from a Laptop USAGE: rpk laptops drives del [OPTIONS] ARGUMENTS: The name of the Laptop The index of the drive to remove OPTIONS: -h, --help Prints help information ``` ## `rpk laptops drives set` ``` DESCRIPTION: Update a Laptop drive USAGE: rpk laptops drives set [OPTIONS] ARGUMENTS: The Laptop name The drive index to update OPTIONS: -h, --help Prints help information --type The drive type e.g hdd / ssd --size The drive capacity in Gb ``` ## `rpk laptops get` ``` DESCRIPTION: Retrieve a Laptop by name USAGE: rpk laptops get [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk laptops gpu` ``` DESCRIPTION: Manage GPUs attached to Laptops USAGE: rpk laptops gpu [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a GPU to a Laptop set Update a Laptop GPU del Remove a GPU from a Laptop ``` ## `rpk laptops gpu add` ``` DESCRIPTION: Add a GPU to a Laptop USAGE: rpk laptops gpu add [OPTIONS] ARGUMENTS: The name of the Laptop OPTIONS: -h, --help Prints help information --model The Gpu model --vram The amount of gpu vram in Gb ``` ## `rpk laptops gpu del` ``` DESCRIPTION: Remove a GPU from a Laptop USAGE: rpk laptops gpu del [OPTIONS] ARGUMENTS: The Laptop name The index of the Gpu to remove OPTIONS: -h, --help Prints help information ``` ## `rpk laptops gpu set` ``` DESCRIPTION: Update a Laptop GPU USAGE: rpk laptops gpu set [OPTIONS] ARGUMENTS: The Laptop name The index of the gpu to update OPTIONS: -h, --help Prints help information --model The gpu model name --vram The amount of gpu vram in Gb ``` ## `rpk laptops label` ``` DESCRIPTION: Manage labels on a laptop USAGE: rpk laptops label [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a label to a laptop remove Remove a label from a laptop ``` ## `rpk laptops label add` ``` DESCRIPTION: Add a label to a laptop USAGE: rpk laptops label add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --key --value ``` ## `rpk laptops label remove` ``` DESCRIPTION: Remove a label from a laptop USAGE: rpk laptops label remove [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --key ``` ## `rpk laptops list` ``` DESCRIPTION: List all Laptops USAGE: rpk laptops list [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk laptops set` ``` DESCRIPTION: Update properties of a laptop USAGE: rpk laptops set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --model ``` ## `rpk laptops summary` ``` DESCRIPTION: Show a summarized hardware report for all Laptops USAGE: rpk laptops summary [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk laptops tree` ``` DESCRIPTION: Display the dependency tree for a Laptop USAGE: rpk laptops tree [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk mermaid` ``` DESCRIPTION: Generate Mermaid diagrams from infrastructure USAGE: rpk mermaid [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: export Generate a Mermaid infrastructure diagram ``` ## `rpk mermaid export` ``` DESCRIPTION: Generate a Mermaid infrastructure diagram USAGE: rpk mermaid export [OPTIONS] OPTIONS: -h, --help Prints help information --include-tags Comma-separated list of tags to include (e.g. prod,linux) --diagram-type Mermaid diagram type (default: "flowchart TD") --no-labels Disable resource label annotations --no-edges Disable relationship edges --label-whitelist Comma-separated list of label keys to include -o, --output Write Mermaid diagram to file instead of stdout ``` ## `rpk routers` ``` DESCRIPTION: Manage network routers USAGE: rpk routers [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: summary Show a hardware report for all routers add Add a new network router to the inventory list List all routers in the system get Retrieve details of a specific router by name describe Show detailed information about a router set Update properties of a router del Delete a router from the inventory port Manage ports on a router label Manage labels on a router ``` ## `rpk routers add` ``` DESCRIPTION: Add a new network router to the inventory USAGE: rpk routers add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk routers del` ``` DESCRIPTION: Delete a router from the inventory USAGE: rpk routers del [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk routers describe` ``` DESCRIPTION: Show detailed information about a router USAGE: rpk routers describe [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk routers get` ``` DESCRIPTION: Retrieve details of a specific router by name USAGE: rpk routers get [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk routers label` ``` DESCRIPTION: Manage labels on a router USAGE: rpk routers label [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a label to a router remove Remove a label from a router ``` ## `rpk routers label add` ``` DESCRIPTION: Add a label to a router USAGE: rpk routers label add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --key --value ``` ## `rpk routers label remove` ``` DESCRIPTION: Remove a label from a router USAGE: rpk routers label remove [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --key ``` ## `rpk routers list` ``` DESCRIPTION: List all routers in the system USAGE: rpk routers list [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk routers port` ``` DESCRIPTION: Manage ports on a router USAGE: rpk routers port [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a port to a router set Update a router port del Remove a port from a router ``` ## `rpk routers port add` ``` DESCRIPTION: Add a port to a router USAGE: rpk routers port add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --type --speed --count ``` ## `rpk routers port del` ``` DESCRIPTION: Remove a port from a router USAGE: rpk routers port del [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --index ``` ## `rpk routers port set` ``` DESCRIPTION: Update a router port USAGE: rpk routers port set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --index --type --speed --count ``` ## `rpk routers set` ``` DESCRIPTION: Update properties of a router USAGE: rpk routers set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --Model --managed --poe ``` ## `rpk routers summary` ``` DESCRIPTION: Show a hardware report for all routers USAGE: rpk routers summary [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk servers` ``` DESCRIPTION: Manage servers and their components USAGE: rpk servers [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: summary Show a summarized hardware report for all servers add Add a new server to the inventory get List all servers or retrieve a specific server by name describe Display detailed information about a specific server set Update properties of an existing server del Delete a server from the inventory tree Display the dependency tree of a server cpu Manage CPUs attached to a server drive Manage drives attached to a server gpu Manage GPUs attached to a server nic Manage network interface cards (NICs) for a server label Manage labels on a server ``` ## `rpk servers add` ``` DESCRIPTION: Add a new server to the inventory USAGE: rpk servers add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk servers cpu` ``` DESCRIPTION: Manage CPUs attached to a server USAGE: rpk servers cpu [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a CPU to a specific server set Update configuration of a server CPU del Remove a CPU from a server ``` ## `rpk servers cpu add` ``` DESCRIPTION: Add a CPU to a specific server USAGE: rpk servers cpu add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --model --cores --threads ``` ## `rpk servers cpu del` ``` DESCRIPTION: Remove a CPU from a server USAGE: rpk servers cpu del [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --index ``` ## `rpk servers cpu set` ``` DESCRIPTION: Update configuration of a server CPU USAGE: rpk servers cpu set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --index --model --cores --threads ``` ## `rpk servers del` ``` DESCRIPTION: Delete a server from the inventory USAGE: rpk servers del [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk servers describe` ``` DESCRIPTION: Display detailed information about a specific server USAGE: rpk servers describe [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk servers drive` ``` DESCRIPTION: Manage drives attached to a server USAGE: rpk servers drive [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a storage drive to a server set Update properties of a server drive del Remove a drive from a server ``` ## `rpk servers drive add` ``` DESCRIPTION: Add a storage drive to a server USAGE: rpk servers drive add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --type The drive type e.g hdd / ssd --size The drive capacity in GB ``` ## `rpk servers drive del` ``` DESCRIPTION: Remove a drive from a server USAGE: rpk servers drive del [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --index ``` ## `rpk servers drive set` ``` DESCRIPTION: Update properties of a server drive USAGE: rpk servers drive set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --index --type --size ``` ## `rpk servers get` ``` DESCRIPTION: List all servers or retrieve a specific server by name USAGE: rpk servers get [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk servers gpu` ``` DESCRIPTION: Manage GPUs attached to a server USAGE: rpk servers gpu [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a GPU to a server set Update properties of a server GPU del Remove a GPU from a server ``` ## `rpk servers gpu add` ``` DESCRIPTION: Add a GPU to a server USAGE: rpk servers gpu add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --model --vram ``` ## `rpk servers gpu del` ``` DESCRIPTION: Remove a GPU from a server USAGE: rpk servers gpu del [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --index ``` ## `rpk servers gpu set` ``` DESCRIPTION: Update properties of a server GPU USAGE: rpk servers gpu set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --index --model --vram ``` ## `rpk servers label` ``` DESCRIPTION: Manage labels on a server USAGE: rpk servers label [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a label to a server remove Remove a label from a server ``` ## `rpk servers label add` ``` DESCRIPTION: Add a label to a server USAGE: rpk servers label add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --key --value ``` ## `rpk servers label remove` ``` DESCRIPTION: Remove a label from a server USAGE: rpk servers label remove [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --key ``` ## `rpk servers nic` ``` DESCRIPTION: Manage network interface cards (NICs) for a server USAGE: rpk servers nic [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a NIC to a server set Update properties of a server NIC del Remove a NIC from a server ``` ## `rpk servers nic add` ``` DESCRIPTION: Add a NIC to a server USAGE: rpk servers nic add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --type --speed --ports ``` ## `rpk servers nic del` ``` DESCRIPTION: Remove a NIC from a server USAGE: rpk servers nic del [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --index ``` ## `rpk servers nic set` ``` DESCRIPTION: Update properties of a server NIC USAGE: rpk servers nic set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --index --type --speed --ports ``` ## `rpk servers set` ``` DESCRIPTION: Update properties of an existing server USAGE: rpk servers set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --ram --ram_mts --ipmi ``` ## `rpk servers summary` ``` DESCRIPTION: Show a summarized hardware report for all servers USAGE: rpk servers summary [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk servers tree` ``` DESCRIPTION: Display the dependency tree of a server USAGE: rpk servers tree [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk services` ``` DESCRIPTION: Manage services and their configurations USAGE: rpk services [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: summary Show a summary report for all services add Add a new service list List all services get Retrieve a service by name describe Show detailed information about a service set Update properties of a service del Delete a service subnets List subnets associated with a service, optionally filtered by CIDR label Manage labels on a service ``` ## `rpk services add` ``` DESCRIPTION: Add a new service USAGE: rpk services add [OPTIONS] ARGUMENTS: The name of the service OPTIONS: -h, --help Prints help information ``` ## `rpk services del` ``` DESCRIPTION: Delete a service USAGE: rpk services del [OPTIONS] ARGUMENTS: The name of the service OPTIONS: -h, --help Prints help information ``` ## `rpk services describe` ``` DESCRIPTION: Show detailed information about a service USAGE: rpk services describe [OPTIONS] ARGUMENTS: The name of the service OPTIONS: -h, --help Prints help information ``` ## `rpk services get` ``` DESCRIPTION: Retrieve a service by name USAGE: rpk services get [OPTIONS] ARGUMENTS: The name of the service OPTIONS: -h, --help Prints help information ``` ## `rpk services label` ``` DESCRIPTION: Manage labels on a service USAGE: rpk services label [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a label to a service remove Remove a label from a service ``` ## `rpk services label add` ``` DESCRIPTION: Add a label to a service USAGE: rpk services label add [OPTIONS] ARGUMENTS: The name of the service OPTIONS: -h, --help Prints help information --key --value ``` ## `rpk services label remove` ``` DESCRIPTION: Remove a label from a service USAGE: rpk services label remove [OPTIONS] ARGUMENTS: The name of the service OPTIONS: -h, --help Prints help information --key ``` ## `rpk services list` ``` DESCRIPTION: List all services USAGE: rpk services list [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk services set` ``` DESCRIPTION: Update properties of a service USAGE: rpk services set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --ip The ip address of the service --port The port the service is running on --protocol The service protocol --url The service URL --runs-on The system(s) the service is running on ``` ## `rpk services subnets` ``` DESCRIPTION: List subnets associated with a service, optionally filtered by CIDR USAGE: rpk services subnets [OPTIONS] OPTIONS: -h, --help Prints help information --cidr --prefix ``` ## `rpk services summary` ``` DESCRIPTION: Show a summary report for all services USAGE: rpk services summary [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk ssh` ``` DESCRIPTION: Generate SSH configuration from infrastructure USAGE: rpk ssh [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: export Generate an SSH config file ``` ## `rpk ssh export` ``` DESCRIPTION: Generate an SSH config file USAGE: rpk ssh export [OPTIONS] OPTIONS: DEFAULT -h, --help Prints help information --include-tags Comma-separated list of tags to include (e.g. prod,linux) --default-user Default SSH user if not defined in labels --default-port 22 Default SSH port if not defined in labels (default: 22) --default-identity Default SSH identity file (e.g. ~/.ssh/id_rsa) -o, --output Write SSH config to file instead of stdout ``` ## `rpk summary` ``` DESCRIPTION: Show a summarized report of all resources in the system USAGE: rpk summary [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk switches` ``` DESCRIPTION: Manage network switches USAGE: rpk switches [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: summary Show a hardware report for all switches add Add a new network switch to the inventory list List all switches in the system get Retrieve details of a specific switch by name describe Show detailed information about a switch set Update properties of a switch del Delete a switch from the inventory port Manage ports on a network switch label Manage labels on a switch ``` ## `rpk switches add` ``` DESCRIPTION: Add a new network switch to the inventory USAGE: rpk switches add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk switches del` ``` DESCRIPTION: Delete a switch from the inventory USAGE: rpk switches del [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk switches describe` ``` DESCRIPTION: Show detailed information about a switch USAGE: rpk switches describe [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk switches get` ``` DESCRIPTION: Retrieve details of a specific switch by name USAGE: rpk switches get [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk switches label` ``` DESCRIPTION: Manage labels on a switch USAGE: rpk switches label [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a label to a switch remove Remove a label from a switch ``` ## `rpk switches label add` ``` DESCRIPTION: Add a label to a switch USAGE: rpk switches label add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --key --value ``` ## `rpk switches label remove` ``` DESCRIPTION: Remove a label from a switch USAGE: rpk switches label remove [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --key ``` ## `rpk switches list` ``` DESCRIPTION: List all switches in the system USAGE: rpk switches list [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk switches port` ``` DESCRIPTION: Manage ports on a network switch USAGE: rpk switches port [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a port to a switch set Update a switch port del Remove a port from a switch ``` ## `rpk switches port add` ``` DESCRIPTION: Add a port to a switch USAGE: rpk switches port add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --type The port type (e.g., rj45, sfp+) --speed The port speed (e.g., 1, 2.5, 10) --count Number of ports of this type ``` ## `rpk switches port del` ``` DESCRIPTION: Remove a port from a switch USAGE: rpk switches port del [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --index ``` ## `rpk switches port set` ``` DESCRIPTION: Update a switch port USAGE: rpk switches port set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --index --type --speed --count ``` ## `rpk switches set` ``` DESCRIPTION: Update properties of a switch USAGE: rpk switches set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --Model --managed --poe ``` ## `rpk switches summary` ``` DESCRIPTION: Show a hardware report for all switches USAGE: rpk switches summary [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk systems` ``` DESCRIPTION: Manage systems and their dependencies USAGE: rpk systems [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: summary Show a summary report for all systems add Add a new system to the inventory list List all systems get Retrieve a system by name describe Display detailed information about a system set Update properties of a system del Delete a system from the inventory tree Display the dependency tree for a system label Manage labels on a system ``` ## `rpk systems add` ``` DESCRIPTION: Add a new system to the inventory USAGE: rpk systems add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk systems del` ``` DESCRIPTION: Delete a system from the inventory USAGE: rpk systems del [OPTIONS] ARGUMENTS: The name of the system OPTIONS: -h, --help Prints help information ``` ## `rpk systems describe` ``` DESCRIPTION: Display detailed information about a system USAGE: rpk systems describe [OPTIONS] ARGUMENTS: The name of the system OPTIONS: -h, --help Prints help information ``` ## `rpk systems get` ``` DESCRIPTION: Retrieve a system by name USAGE: rpk systems get [OPTIONS] ARGUMENTS: The name of the system OPTIONS: -h, --help Prints help information ``` ## `rpk systems label` ``` DESCRIPTION: Manage labels on a system USAGE: rpk systems label [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a label to a system remove Remove a label from a system ``` ## `rpk systems label add` ``` DESCRIPTION: Add a label to a system USAGE: rpk systems label add [OPTIONS] ARGUMENTS: The name of the system OPTIONS: -h, --help Prints help information --key --value ``` ## `rpk systems label remove` ``` DESCRIPTION: Remove a label from a system USAGE: rpk systems label remove [OPTIONS] ARGUMENTS: The name of the system OPTIONS: -h, --help Prints help information --key ``` ## `rpk systems list` ``` DESCRIPTION: List all systems USAGE: rpk systems list [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk systems set` ``` DESCRIPTION: Update properties of a system USAGE: rpk systems set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --type --os --cores --ram --runs-on The physical machine(s) the service is running on --ip The ip address of the system ``` ## `rpk systems summary` ``` DESCRIPTION: Show a summary report for all systems USAGE: rpk systems summary [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk systems tree` ``` DESCRIPTION: Display the dependency tree for a system USAGE: rpk systems tree [OPTIONS] ARGUMENTS: The name of the system OPTIONS: -h, --help Prints help information ``` ## `rpk ups` ``` DESCRIPTION: Manage UPS units USAGE: rpk ups [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: summary Show a hardware report for all UPS units add Add a new UPS unit list List all UPS units get Retrieve a UPS unit by name describe Show detailed information about a UPS unit set Update properties of a UPS unit del Delete a UPS unit label Manage labels on a UPS unit ``` ## `rpk ups add` ``` DESCRIPTION: Add a new UPS unit USAGE: rpk ups add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk ups del` ``` DESCRIPTION: Delete a UPS unit USAGE: rpk ups del [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk ups describe` ``` DESCRIPTION: Show detailed information about a UPS unit USAGE: rpk ups describe [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk ups get` ``` DESCRIPTION: Retrieve a UPS unit by name USAGE: rpk ups get [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information ``` ## `rpk ups label` ``` DESCRIPTION: Manage labels on a UPS unit USAGE: rpk ups label [OPTIONS] OPTIONS: -h, --help Prints help information COMMANDS: add Add a label to a UPS unit remove Remove a label from a UPS unit ``` ## `rpk ups label add` ``` DESCRIPTION: Add a label to a UPS unit USAGE: rpk ups label add [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --key --value ``` ## `rpk ups label remove` ``` DESCRIPTION: Remove a label from a UPS unit USAGE: rpk ups label remove [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --key ``` ## `rpk ups list` ``` DESCRIPTION: List all UPS units USAGE: rpk ups list [OPTIONS] OPTIONS: -h, --help Prints help information ``` ## `rpk ups set` ``` DESCRIPTION: Update properties of a UPS unit USAGE: rpk ups set [OPTIONS] ARGUMENTS: OPTIONS: -h, --help Prints help information --model --va ``` ## `rpk ups summary` ``` DESCRIPTION: Show a hardware report for all UPS units USAGE: rpk ups summary [OPTIONS] OPTIONS: -h, --help Prints help information ```