Equinix + Steampipe

Steampipe is an open source CLI to instantly query cloud APIs using SQL.

Equinix Metal delivers global, interconnected, integrated, and on-demand bare-metal infrastructure as a service. As the name implies, these bare metal servers do not require virtualization or multi-tenancy. The provisioned infrastructure is deployed at Equinix data center locations allowing enabling direct network interconnects to other cloud providers and a global network backbone.

For example:

select
  hostname,
  state,
  tags
from
  equinix_metal_device

+-----------------------+--------+---------------+
| hostname              | state  | tags          |
+-----------------------+--------+---------------+
| dc13-c3.medium.x86-01 | active | {"prod":true} |
+-----------------------+--------+---------------+

Documentation

• Table definitions & examples →

Get started

Install

Download and install the latest Equinix Metal plugin:

steampipe plugin install equinix

Credentials

Configuration

Installing the latest equinix plugin will create a config file (~/.steampipe/config/equinix.spc) with a single connection named equinix:

connection "equinix" {
  plugin  = "equinix"
  token   = "XV1JE4QXVHdCYoWT2wbr2NRdPYrZRx3N"
}

Multi-Account Connections

You may create multiple equinix connections:

connection "equinix_dev" {
  plugin    = "equinix"
  token     = "XV1KL4QXVHcCYoWT2wbr2NRdRTrZRx3K"
}

connection "equinix_qa" {
  plugin    = "equinix"
  token     = "XV1KL4QXVHcCYoWT2wbr2NRdRTrZRx3L"
}

connection "equinix_prod" {
  plugin    = "equinix"
  token     = "XV1KL4QXVHcCYoWT2wbr2NRdRTrZRx3M"
}

Each connection is implemented as a distinct Postgres schema. As such, you can use qualified table names to query a specific connection:

select
  *
from
  equinix_qa.equinix_metal_organization

You can create multi-account connections by using an aggregator connection. Aggregators allow you to query data from multiple connections for a plugin as if they are a single connection.

connection "equinix_all" {
  plugin      = "equinix"
  type        = "aggregator"
  connections = ["equinix_dev", "equinix_qa", "equinix_prod"]
}

Querying tables from this connection will return results from the equinix_dev, equinix_qa, and equinix_prod connections:

select
  *
from
  equinix_all.equinix_metal_organization

Alternatively, you can use an unqualified name and it will be resolved according to the Search Path. It's a good idea to name your aggregator first alphabetically so that it is the first connection in the search path (i.e. equinix_all comes before equinix_dev):

select
  *
from
  equinix_metal_organization

Steampipe supports the * wildcard in the connection names. For example, to aggregate all the equinix plugin connections whose names begin with equinix_:

connection "equinix_all" {
  type        = "aggregator"
  plugin      = "equinix"
  connections = ["equinix_*"]
}

Get involved

• Open source: https://github.com/turbot/steampipe-plugin-equinix
• Community: Discussion forums