cli-commands-index.md 28 KB

  • rpk
    • accesspoints - Manage access points
      • add - Add a new access point
      • add - Add a new access point
      • del - Delete an access point
      • del - Delete an access point
      • describe - Show detailed information about an access point
      • describe - Show detailed information about an access point
      • get - Retrieve an access point by name
      • get - Retrieve an access point by name
      • label - Manage labels on an access point
        • add - Add a label to an access point
        • add - Add a label to an access point
        • remove - Remove a label from an access point
        • remove - Remove a label from an access point
      • list - List all access points
      • list - List all access points
      • set - Update properties of an access point
      • set - Update properties of an access point
      • summary - Show a hardware report for all access points
      • summary - Show a hardware report for all access points
    • ansible - Generate and manage Ansible inventory
    • desktops - Manage desktop computers and their components
      • add - Add a new desktop
      • add - Add a new desktop
      • cpu - Manage CPUs attached to desktops
        • add - Add a CPU to a desktop
        • add - Add a CPU to a desktop
        • del - Remove a CPU from a desktop
        • del - Remove a CPU from a desktop
        • set - Update a desktop CPU
        • set - Update a desktop CPU
      • del - Delete a desktop from the inventory
      • del - Delete a desktop from the inventory
      • describe - Show detailed information about a desktop
      • describe - Show detailed information about a desktop
      • drive - Manage storage drives attached to desktops
        • add - Add a drive to a desktop
        • add - Add a drive to a desktop
        • del - Remove a drive from a desktop
        • del - Remove a drive from a desktop
        • set - Update a desktop drive
        • set - Update a desktop drive
      • get - Retrieve a desktop by name
      • get - Retrieve a desktop by name
      • gpu - Manage GPUs attached to desktops
        • add - Add a GPU to a desktop
        • add - Add a GPU to a desktop
        • del - Remove a GPU from a desktop
        • del - Remove a GPU from a desktop
        • set - Update a desktop GPU
        • set - Update a desktop GPU
      • label - Manage labels on a desktop
        • add - Add a label to a desktop
        • add - Add a label to a desktop
        • remove - Remove a label from a desktop
        • remove - Remove a label from a desktop
      • list - List all desktops
      • list - List all desktops
      • nic - Manage network interface cards (NICs) for desktops
        • add - Add a NIC to a desktop
        • add - Add a NIC to a desktop
        • del - Remove a NIC from a desktop
        • del - Remove a NIC from a desktop
        • set - Update a desktop NIC
        • set - Update a desktop NIC
      • set - Update properties of a desktop
      • set - Update properties of a desktop
      • summary - Show a summarized hardware report for all desktops
      • summary - Show a summarized hardware report for all desktops
      • tree - Display the dependency tree for a desktop
      • tree - Display the dependency tree for a desktop
    • firewalls - Manage firewalls
      • add - Add a new firewall to the inventory
      • add - Add a new firewall to the inventory
      • del - Delete a firewall from the inventory
      • del - Delete a firewall from the inventory
      • describe - Show detailed information about a firewall
      • describe - Show detailed information about a firewall
      • get - Retrieve details of a specific firewall by name
      • get - Retrieve details of a specific firewall by name
      • label - Manage labels on a firewall
        • add - Add a label to a firewall
        • add - Add a label to a firewall
        • remove - Remove a label from a firewall
        • remove - Remove a label from a firewall
      • list - List all firewalls in the system
      • list - List all firewalls in the system
      • port - Manage ports on a firewall
        • add - Add a port to a firewall
        • add - Add a port to a firewall
        • del - Remove a port from a firewall
        • del - Remove a port from a firewall
        • set - Update a firewall port
        • set - Update a firewall port
      • set - Update properties of a firewall
      • set - Update properties of a firewall
      • summary - Show a hardware report for all firewalls
      • summary - Show a hardware report for all firewalls
    • hosts - Generate a hosts file from infrastructure
      • export - Generate a /etc/hosts compatible file
      • export - Generate a /etc/hosts compatible file
    • laptops - Manage Laptop computers and their components
      • add - Add a new Laptop
      • add - Add a new Laptop
      • cpu - Manage CPUs attached to Laptops
        • add - Add a CPU to a Laptop
        • add - Add a CPU to a Laptop
        • del - Remove a CPU from a Laptop
        • del - Remove a CPU from a Laptop
        • set - Update a Laptop CPU
        • set - Update a Laptop CPU
      • del - Delete a Laptop from the inventory
      • del - Delete a Laptop from the inventory
      • describe - Show detailed information about a Laptop
      • describe - Show detailed information about a Laptop
      • drives - Manage storage drives attached to Laptops
        • add - Add a drive to a Laptop
        • add - Add a drive to a Laptop
        • del - Remove a drive from a Laptop
        • del - Remove a drive from a Laptop
        • set - Update a Laptop drive
        • set - Update a Laptop drive
      • get - Retrieve a Laptop by name
      • get - Retrieve a Laptop by name
      • gpu - Manage GPUs attached to Laptops
        • add - Add a GPU to a Laptop
        • add - Add a GPU to a Laptop
        • del - Remove a GPU from a Laptop
        • del - Remove a GPU from a Laptop
        • set - Update a Laptop GPU
        • set - Update a Laptop GPU
      • label - Manage labels on a laptop
        • add - Add a label to a laptop
        • add - Add a label to a laptop
        • remove - Remove a label from a laptop
        • remove - Remove a label from a laptop
      • list - List all Laptops
      • list - List all Laptops
      • set - Update properties of a laptop
      • set - Update properties of a laptop
      • summary - Show a summarized hardware report for all Laptops
      • summary - Show a summarized hardware report for all Laptops
      • tree - Display the dependency tree for a Laptop
      • tree - Display the dependency tree for a Laptop
    • mermaid - Generate Mermaid diagrams from infrastructure
      • export - Generate a Mermaid infrastructure diagram
      • export - Generate a Mermaid infrastructure diagram
    • routers - Manage network routers
      • add - Add a new network router to the inventory
      • add - Add a new network router to the inventory
      • del - Delete a router from the inventory
      • del - Delete a router from the inventory
      • describe - Show detailed information about a router
      • describe - Show detailed information about a router
      • get - Retrieve details of a specific router by name
      • get - Retrieve details of a specific router by name
      • label - Manage labels on a router
        • add - Add a label to a router
        • add - Add a label to a router
        • remove - Remove a label from a router
        • remove - Remove a label from a router
      • list - List all routers in the system
      • list - List all routers in the system
      • port - Manage ports on a router
        • add - Add a port to a router
        • add - Add a port to a router
        • del - Remove a port from a router
        • del - Remove a port from a router
        • set - Update a router port
        • set - Update a router port
      • set - Update properties of a router
      • set - Update properties of a router
      • summary - Show a hardware report for all routers
      • summary - Show a hardware report for all routers
    • servers - Manage servers and their components
      • add - Add a new server to the inventory
      • add - Add a new server to the inventory
      • cpu - Manage CPUs attached to a server
        • add - Add a CPU to a specific server
        • add - Add a CPU to a specific server
        • del - Remove a CPU from a server
        • del - Remove a CPU from a server
        • set - Update configuration of a server CPU
        • set - Update configuration of a server CPU
      • del - Delete a server from the inventory
      • del - Delete a server from the inventory
      • describe - Display detailed information about a specific server
      • describe - Display detailed information about a specific server
      • drive - Manage drives attached to a server
        • add - Add a storage drive to a server
        • add - Add a storage drive to a server
        • del - Remove a drive from a server
        • del - Remove a drive from a server
        • set - Update properties of a server drive
        • set - Update properties of a server drive
      • get - List all servers or retrieve a specific server by name
      • get - List all servers or retrieve a specific server by name
      • gpu - Manage GPUs attached to a server
        • add - Add a GPU to a server
        • add - Add a GPU to a server
        • del - Remove a GPU from a server
        • del - Remove a GPU from a server
        • set - Update properties of a server GPU
        • set - Update properties of a server GPU
      • label - Manage labels on a server
        • add - Add a label to a server
        • add - Add a label to a server
        • remove - Remove a label from a server
        • remove - Remove a label from a server
      • nic - Manage network interface cards (NICs) for a server
        • add - Add a NIC to a server
        • add - Add a NIC to a server
        • del - Remove a NIC from a server
        • del - Remove a NIC from a server
        • set - Update properties of a server NIC
        • set - Update properties of a server NIC
      • set - Update properties of an existing server
      • set - Update properties of an existing server
      • summary - Show a summarized hardware report for all servers
      • summary - Show a summarized hardware report for all servers
      • tree - Display the dependency tree of a server
      • tree - Display the dependency tree of a server
    • services - Manage services and their configurations
      • add - Add a new service
      • add - Add a new service
      • del - Delete a service
      • del - Delete a service
      • describe - Show detailed information about a service
      • describe - Show detailed information about a service
      • get - Retrieve a service by name
      • get - Retrieve a service by name
      • label - Manage labels on a service
        • add - Add a label to a service
        • add - Add a label to a service
        • remove - Remove a label from a service
        • remove - Remove a label from a service
      • list - List all services
      • list - List all services
      • set - Update properties of a service
      • set - Update properties of a service
      • subnets - List subnets associated with a service, optionally filtered by CIDR
      • subnets - List subnets associated with a service, optionally filtered by CIDR
      • summary - Show a summary report for all services
      • summary - Show a summary report for all services
    • ssh - Generate SSH configuration from infrastructure
      • export - Generate an SSH config file
      • export - Generate an SSH config file
    • summary - Show a summarized report of all resources in the system
    • summary - Show a summarized report of all resources in the system
    • switches - Manage network switches
      • add - Add a new network switch to the inventory
      • add - Add a new network switch to the inventory
      • del - Delete a switch from the inventory
      • del - Delete a switch from the inventory
      • describe - Show detailed information about a switch
      • describe - Show detailed information about a switch
      • get - Retrieve details of a specific switch by name
      • get - Retrieve details of a specific switch by name
      • label - Manage labels on a switch
        • add - Add a label to a switch
        • add - Add a label to a switch
        • remove - Remove a label from a switch
        • remove - Remove a label from a switch
      • list - List all switches in the system
      • list - List all switches in the system
      • port - Manage ports on a network switch
        • add - Add a port to a switch
        • add - Add a port to a switch
        • del - Remove a port from a switch
        • del - Remove a port from a switch
        • set - Update a switch port
        • set - Update a switch port
      • set - Update properties of a switch
      • set - Update properties of a switch
      • summary - Show a hardware report for all switches
      • summary - Show a hardware report for all switches
    • systems - Manage systems and their dependencies
      • add - Add a new system to the inventory
      • add - Add a new system to the inventory
      • del - Delete a system from the inventory
      • del - Delete a system from the inventory
      • describe - Display detailed information about a system
      • describe - Display detailed information about a system
      • get - Retrieve a system by name
      • get - Retrieve a system by name
      • label - Manage labels on a system
        • add - Add a label to a system
        • add - Add a label to a system
        • remove - Remove a label from a system
        • remove - Remove a label from a system
      • list - List all systems
      • list - List all systems
      • set - Update properties of a system
      • set - Update properties of a system
      • summary - Show a summary report for all systems
      • summary - Show a summary report for all systems
      • tree - Display the dependency tree for a system
      • tree - Display the dependency tree for a system
    • ups - Manage UPS units
      • add - Add a new UPS unit
      • add - Add a new UPS unit
      • del - Delete a UPS unit
      • del - Delete a UPS unit
      • describe - Show detailed information about a UPS unit
      • describe - Show detailed information about a UPS unit
      • get - Retrieve a UPS unit by name
      • get - Retrieve a UPS unit by name
      • label - Manage labels on a UPS unit
        • add - Add a label to a UPS unit
        • add - Add a label to a UPS unit
        • remove - Remove a label from a UPS unit
        • remove - Remove a label from a UPS unit
      • list - List all UPS units
      • list - List all UPS units
      • set - Update properties of a UPS unit
      • set - Update properties of a UPS unit
      • summary - Show a hardware report for all UPS units
      • summary - Show a hardware report for all UPS units