mirror of
https://github.com/davidallendj/magellan.git
synced 2025-12-20 11:37:01 -07:00
57 lines
2.1 KiB
Markdown
57 lines
2.1 KiB
Markdown
# Magellan
|
|
|
|
Magellan is a small tool designed to collect BMC information and load the data
|
|
into `hms-smd`. It is able to probe hosts for specific open ports using the `dora`
|
|
API or it's own simplier, built-in scanner and query BMC information via `bmclib`.
|
|
Once the data is received, it is then stored into `hms-smd` using its API.
|
|
|
|
## Building
|
|
|
|
To build the project, run the following:
|
|
|
|
```bash
|
|
go mod tidy && go build
|
|
```
|
|
|
|
## Usage
|
|
|
|
Magellan's main goal is to load inventory components into `hms-smd` using redfish
|
|
or IMPI interfaces. It can scan subnets or specific hosts to find interfaces to query and stores into a local database.
|
|
|
|
```bash
|
|
./magellan --help
|
|
Usage of ./magellan:
|
|
--cert-pool string path to an file containing x509 CAs. An empty string uses the system CAs. Only takes effect when --secure-tls=true
|
|
--driver strings set the BMC driver to use (default [redfish])
|
|
--host strings set additional hosts
|
|
--pass string set the BMC pass (default "root_password")
|
|
--port ints set the ports to scan
|
|
--secure-tls enable secure TLS
|
|
--subnet strings set additional subnets (default [127.0.0.0])
|
|
--threads int set the number of threads (default -1)
|
|
--timeout int set the timeout (default 1)
|
|
--user string set the BMC user (default "root")
|
|
|
|
# example usage
|
|
./magellan scan \
|
|
--subnet 127.0.0.0 \ # add a subnet of hosts
|
|
--host 127.0.0.1 \ # add an additional host
|
|
--port 5000 \ # port to scan for
|
|
--timeout 10 \ # timeout for response
|
|
--threads 255 \ # number of simutaneoulsy jobs
|
|
--dbpath data/assets.db # path to store scan results
|
|
|
|
./magellan collect \
|
|
--host 127.0.0.1 \ # host of hms-smd API
|
|
--port 27777 \ # port of hms-smd API
|
|
--dbpath data/assets.db # path of stored scan results
|
|
```
|
|
|
|
## TODO
|
|
|
|
List of things left to fix or do...
|
|
|
|
* [ ] Switch to internal scanner if `dora` fails
|
|
* [ ] Test using different `bmclib` supported drivers (mainly 'redfish')
|
|
* [ ] Confirm loading different components into `hms-smd`
|
|
* [ ] Add unit tests
|