diff --git a/providers/ipmi/config/config.go b/providers/ipmi/config/config.go index aa5b85c581..444b36bb24 100644 --- a/providers/ipmi/config/config.go +++ b/providers/ipmi/config/config.go @@ -15,9 +15,15 @@ var Config = plugin.Provider{ ConnectionTypes: []string{provider.ConnectionType}, Connectors: []plugin.Connector{ { - Name: "ipmi", - Use: "ipmi", - Short: "Ipmi", + Name: "ipmi", + Use: "ipmi user@host", + Short: "Intelligent Platform Management Interface (IPMI)", + Long: `ipmi is designed for querying resources via the Intelligent Platform Management Interface (IPMI). +IPMI provides management and monitoring capabilities independently of the host system's CPU, +firmware (BIOS or UEFI), and operating system. +`, + MinArgs: 1, + MaxArgs: 1, Discovery: []string{provider.ConnectionType}, Flags: []plugin.Flag{ { @@ -32,7 +38,7 @@ var Config = plugin.Provider{ Short: "p", Type: plugin.FlagType_String, Default: "", - Desc: "Set the connection password for SSH.", + Desc: "Set the connection password for IPMI connection.", Option: plugin.FlagOption_Password, ConfigEntry: "-", }, diff --git a/providers/ipmi/main.go b/providers/ipmi/main.go index 74b1f7001c..2cefd93958 100644 --- a/providers/ipmi/main.go +++ b/providers/ipmi/main.go @@ -10,6 +10,13 @@ import ( "go.mondoo.com/cnquery/providers/ipmi/provider" ) +// This is the entry point for the IPMI provider. +// +// To test the provider, start the simulator: +// docker run -d -p 623:623/udp vaporio/ipmi-simulator +// +// Once the simulator is running, you can query it: +// cnquery shell ipmi ADMIN@0.0.0.0 --password 'ADMIN' func main() { plugin.Start(os.Args, provider.Init()) } diff --git a/providers/ipmi/provider/provider.go b/providers/ipmi/provider/provider.go index 441ee2d2fc..90b0b7fad9 100644 --- a/providers/ipmi/provider/provider.go +++ b/providers/ipmi/provider/provider.go @@ -44,7 +44,6 @@ func (s *Service) ParseCLI(req *plugin.ParseCLIReq) (*plugin.ParseCLIRes, error) } // custom flag parsing - user := "" port := 623 if len(req.Args) != 0 {