Equinix Metal Metabot! The robot for your Equinix Metal metadata!
Available as an executable binary or container, Metabot knows your metadata and will retrieve whatever you want. Metabot's commands are expanding regularly.
Why not just use curl | jq? Sure, you could, but Metabot will extract all of that for you quickly and easily, including expanding and formatting, without any of the long url or, worse, complex jq formatting.
This repository is Maintained meaning that this software is supported by Equinix Metal and its community - available to use in production environments.
Either download the release from this site, or get the latest docker image docker pull packethost/metabot.
Whether you run as a straight binary or container, the basics are the same: run it and ask it what you want:
$ metabot <query> <qualifier>
$ # or
$ docker run --rm packethost/metabot <query> <qualifier>
The qualifiers are unique to each query type. Some accept no qualifiers. If a query accepts multiple qualifiers, the order is unimportant; it just keeps applying them. Some qualifiers filter "up", i.e. change the results. See each type.
Here are queries metabot understands today:
| query | output | example |
|---|---|---|
| id | ID of this server | b642678f-1d6e-45a2-aed1-bd0a63135fe5 |
| hostname | hostname of this server | metabot-test |
| facility | facility ID in which this server exists | ewr1 |
| ip | space-separated list of all IP addresses for this host in cidr format | 10.0.10.10/31 205.206.207.122/31 2604:1380:1:9200::1/127 |
For each query type, here are the acceptable qualifiers. If the qualifier is unknown, Metabot will return an error.
Metabot query ip has multiple qualifiers.
4: return only IPv4 addresses.6: return only IPv6 addresses.private: return only private IP addresses.public: return only public IP addresses.network: return the address of the network the host is in, rather than the address of the host itself.parent: return the parent IP address range instead of the actual IP address on the host.address: return only the address without the/xcidr part, e.g.10.0.10.10 205.206.207.122 2604:1380:1:9200::1.netmask: return the address inip/netmaskformat instead ofip/cidrformat.
Examples (remember, the order of qualifiers does not matter):
$ metabot ip 4 private # return the private ipv4 entries in cidr format
10.99.185.1/31
$ metabot ip 4 private netmask # return the private ipv4 entries in netmask format
10.99.185.1/255.255.255.254
$ metabot ip 4 private address # return the private ipv4 entries in address-only format
10.99.185.1
$ metabot ip private parent network # return the private ipv4 and ipv6 entries of the parent
10.99.185.0/25
By default, Metabot retrieves data from the Equinix Metal URL https://metadata.packet.com/metadata , but you can override it with the --url <url> option.