towk/magellan
1
0
Fork 0
mirror of https://github.com/davidallendj/magellan.git synced 2025-12-20 03:27:03 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added initial round of comments for API documentation

Browse source
This commit is contained in:
David Allen 2024-07-18 18:18:03 -06:00
parent 796a67d5ab
commit 1ab5c8a7df
No known key found for this signature in database
GPG key ID: 717C593FF60A2ACC
5 changed files with 114 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

6
cmd/scan.go
View file

@ -25,6 +25,12 @@ var (
disableProbing bool
)
// The `scan` command is usually the first step to using the CLI tool.
// This command will perform a network scan over a subnet by supplying
// a list of subnets, subnet masks, and additional IP address to probe.
//
// See the `ScanForAssets()` function in 'internal/scan.go' for details
// related to the implementation.
var scanCmd = &cobra.Command{
Use: "scan",
Short: "Scan for BMC nodes on a network",