mctl

README

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

Documentation

Overview

Copyright © 2022 Equinix Metal <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.