README.md

metal-cli

Table of Contents

• metal-cli
  • Table of Contents
  • Equinix Metal Command Line Interface
  • Requirements
  • Supported Platforms
  • Installation
    • Install binary from Source
    • Install binary from Release Download
    • Install via Homebrew
    • Configuring your Path
    • Linux
    • Mac OS X
    • Windows
    • Shell Completion
  • Authentication
  • Includes and Excludes
  • Reference
  • Example Syntax
    • Create a device
    • Get a device
    • List projects
    • Get a project
  • Support

Equinix Metal Command Line Interface

Equinix Metal provides an API-driven bare metal platform that combines the automation experience of the cloud with the benefits of physical, bare metal servers.

The Equinix Metal CLI wraps the Equinix Go SDK allowing interaction with Equinix Metal platform from a command-line interface.

Requirements

• Equinix Metal authentication token.
• Equinix Metal CLI binaries.

Supported Platforms

The Equinix Metal CLI binaries are available for Linux, Windows, and Mac OS X for various architectures including ARM on Linux.

Installation

Install binary from Source

If you have go 1.19 or later installed, you can build and install the latest version with:

go install github.com/equinix/metal-cli/cmd/metal@latest

You can find the installed executable/binary in either $GOPATH/bin or $HOME/go/bin folder.

Install binary from Release Download

Download the appropriate Equinix Metal CLI binaries for your platform to the desired location,chmod it and rename it to metal.

Install via Homebrew

If you prefer installing via Homebrew, you can run the following:

brew tap equinix/homebrew-tap
brew install metal-cli

Install via FreeBSD ports

The Equinix Metal CLI tools are available directly from FreeBSD ports:

sudo pkg install -r FreeBSD sysutils/equinix-metal-cli

Configuring your Path

If the directory where your binaries were installed is not already in your PATH environment variable, then it will need to be added. Choose the steps to follow for your platform to add directory to PATH.

Configure your path in Linux

Linux

If you plan to run the Equinix Metal CLI in a shell on Linux and placed the binary in /home/YOUR-USER-NAME/metal-cli/, then type the following into your terminal:

export PATH=$PATH:/home/$USER/metal-cli

If you plan to run the Equinix Metal CLI in a shell on Linux and your binary is in $GOPATH/bin or $HOME/go/bin, then type the following into your terminal:

export PATH=$PATH:$GOPATH/bin

or:

export PATH=$PATH:$HOME/go/bin

You can view the current value of $PATH by running:

echo $PATH

Configure your path in Mac OS/X

Mac OS X

If you plan to run the Equinix Metal CLI in a shell on a Mac, download the darwin binary and placed the it in /Users/YOUR-USER-NAME/metal-cli/, then type the following into your terminal.

export PATH=$PATH:/Users/$USER/metal-cli

If you plan to run the Equinix Metal CLI in a shell on a Mac and your binary is in $GOPATH/bin or $HOME/go/bin, then type the following into your terminal:

export PATH=$PATH:$GOPATH/bin

or:

export PATH=$PATH:$HOME/go/bin

You can view the current value of $PATH by running:

echo $PATH

When running the downloaded binary on a Mac, you may be prompted with the following message:

"metal" cannot be opened because the developer cannot be verified

The binary can be trusted by enabling "App Store and identified developers" in "System Preferences -> Security & Privacy -> General". Any blocked apps will appear in the bottom of this window, where they can be authorized.

Configure your path in Windows

Windows

If you plan to run the Equinix Metal CLI in PowerShell on Windows and placed the binary in c:\metal-cli, then type the following into PowerShell:

$env:Path += ";c:\metal-cli"

If you plan to run the Equinix Metal CLI in PowerShell on Windows and your binary is in $GOPATH/bin or $HOME/go/bin, then type the following into PowerShell:

$setx PATH "$($env:path);$GOPATH\bin"

or:

$setx PATH "$($env:path);$HOME\go\bin"

The path can be viewed by running:

echo $env:Path

Shell Completion

Once installed, shell completion can be enabled (in Bash) with source <(metal completion bash) (or for some versions of Bash, `eval "$(metal completion bash)").

Check metal completion -h for instructions to use in other shells.

Authentication

After installing Equinix Metal CLI, configure your account using metal init:

$ metal init
Equinix Metal API Tokens can be obtained through the portal at https://console.equinix.com/.
See https://deploy.equinix.com/developers/docs/metal/identity-access-management/users/ for more details.

Token (hidden): 
Organization ID []: 87e62b5c-7e4e-4a29-ac40-d5df9535868f
Project ID []: a4e48c3a-6819-485a-822f-81b3845d5aa5

Writing /Users/username/.config/equinix/metal.yaml

The Equinix Metal authentication token can be stored in the $METAL_AUTH_TOKEN environment variable or in JSON or YAML configuration files. The configuration file path can be overridden with the --config flag. The default configuration path is "$HOME/config/equinix/metal.*" (any supported filetype).

Includes and Excludes

Equinix Metal API resource responses may have related resources. These related resources can be embedded in the result or referred. Referred resources will only include a Href value, which includes the unique ID of the resource. Embedded resources will be represented with their full API value, which may contain additional embedded or referred resources.

The resources that you want embedded can be included in results using --include. The resources that you want referred can be excluded with --exclude. By excluding some of the embedded-by-default resources, you can speed up and reduce the size of responses. By including referred-by-default resources, you can avoid the round trip of subsequent calls.

metal devices get --project-id $ID --yaml --exclude=ssh_keys,plan --include=project

These arguments are available in any command that returns a response document. The included and excluded fields requested from the API may differ based on the output format, for example, for historic reasons, metal projects get --yaml includes the details of all project members. In the table output format, no member related fields are displayed and so metal projects get will exclude the member resource.

Excluding fields needed for the table output will result in an error. Mixing includes and excludes affecting the same top-level field is not supported.

Reference

The full CLI documentation can be found here or by clicking the links below.

Example Syntax

Create a device

metal device create --hostname [hostname] --plan [plan] --metro [metro_code] --operating-system [operating_system] --project-id [project_UUID]

Get a device

metal device get --id [device_UUID]

List projects

metal project get

Get a project

metal project get -i [project_UUID]

Details on all available commands can be found by visiting the reference pages or typing metal [command] --help for more information about the specific command.

Support

For help with this package:

• Open up a GitHub issue here.