mctl

mctl is a CLI utility to interact with the metal-toolbox ecosystem of services.

Getting started

1. Install the latest available version using go install github.com/metal-toolbox/mctl@latest. Please note the mctl binary will install in the bin directory of your $GOPATH.
2. Create a configuration file as .mctl.yml, for sample configuration files checkout samples/mctl.yml.
3. Export MCTLCONFIG=~/.mctl.yml.

Actions

For the updated list of all commands available, check out the CLI docs

• Get component information on a server - mctl get component --server-id <>
• List available firmware - mctl list firmware
• List firmware sets - mctl list firmware-set
• Retrieve information about a firmware - mctl get firmware --id <>
• Install a firmware set on a server - mctl install firmware-set --server <>
• Import firmware, firmware-set from file - mctl create firmware-set --from-file samples/fw-set.json, where the JSON file contents is the output of mctl list firmware-set
• Get component gaps between EMAPI and FleetDB for a server - ./mctl get component_gaps -s <>. You will need to build the mctl with a build tag -tags staff.