Equinix Metal CLI Reference¶

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

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

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

export METAL_AUTH_TOKEN=<your_API_TOKEN>

metal init

# Example config:
--
token: foo
project-id: 1857dc19-76a5-4589-a9b6-adb729a7d18b
organization-id: 253e9cf1-5b3d-41f5-a4fa-839c130c8c1d

-h, --help   help for init
-help   help for init

metal env [-p <project_id>]

# Print the current environment variables:
metal env

# Print the current environment variables in Terraform format:
metal env --output terraform

# Load environment variables in Bash, Zsh:
source <(metal env)

# Load environment variables in Bash 3.2.x:
eval "$(metal env)"

# Load environment variables in Fish:
metal env | source

--export                   Export the environment variables.
-h, --help                     help for env
-O, --organization-id string   A organization UUID to set as an environment variable.
-o, --output string            Output format for environment variables (*sh, terraform, capp). (default "sh")
-p, --project-id string        A project UUID to set as an environment variable.
-project-id string             A project UUID to set as an environment variable.

metal completion [bash | zsh | fish | powershell]

# To load completions in Bash:
source <(metal completion bash)

# To load completions in Bash (3.2.x):
eval "$(metal completion bash)"

# To load completions in Bash for each session, on Linux execute once:
metal completion bash > /etc/bash_completion.d/metal-cli

# To load completions in Bash for each session, on Mac execute once:
metal completion bash > /usr/local/etc/bash_completion.d/metal-cli

# To load completions in Zsh:
source <(metal completion zsh)

# To load completions in Zsh for each session, execute once:
metal completion zsh > "${fpath[1]}/_metal-cli"

# To load completions in Fish:
metal completion fish | source

# To load completions in Fish for each session, execute once:
metal completion fish > ~/.config/fish/completions/metal-cli.fish

-h, --help   help for completion

metal docs <destination>

# Generate documentation in the ./docs directory:
metal docs ./docs

-h, --help   help for docs

--config string         Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings       Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray    Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings   Headers to add to requests (in format key=value)
--include strings       Comma separated Href references to expand in results, may be dotted three levels deep
-o, --output string         Output format (*table, json, yaml). env output formats are (*sh, terraform, capp).
--search string         Search keyword for use in 'get' actions. Search is not supported by all resources.
--sort-by string        Sort fields for use in 'get' actions. Sort is not supported by all resources.
--sort-dir string       Sort field direction for use in 'get' actions. Sort is not supported by all resources.
--token string          Metal API Token (METAL_AUTH_TOKEN)

-h, --help   help for 2fa

metal 2fa disable (-a | -s) --code <OTP_code>  [flags]

# Disable two-factor authentication via SMS
metal 2fa disable -s -c <OTP_code>

# Disable two-factor authentication via APP
metal 2fa disable -a -c <OTP_code>

-a, --app           The OTP code is issued from an application.
-c, --code string   The two-factor authentication OTP code.
-h, --help          help for disable
-s, --sms           The OTP code is issued to you via SMS.

metal 2fa enable (-s | -a) --code <OTP_code> [flags]

# Enable two factor authentication via SMS.
metal 2fa enable -s -c <OTP_code>

# Enable two factor authentication via an application.
metal 2fa enable -a -c <OTP_code>

-a, --app           Enables two-factor authentication using an application on the current user's account.
-c, --code string   Two-factor authentication code that is provided by a request to the 2fa receive command.
-h, --help          help for enable
-s, --sms           Enables two-factor authentication using SMS on the current user's account.

metal 2fa receive (-s | -a) [flags]

# Issue the token via SMS:
metal 2fa receive -s 

# Issue the token via app:
metal 2fa receive -a

-a, --app    Issues an OTP URI for an authentication application.
-h, --help   help for receive
-s, --sms    Issues SMS OTP token to the phone number associated with the current user account.

-h, --help   help for capacity

metal capacity check (-m <metro> | -f <facility>) -P <plan> -q <quantity> [flags]

# Checks if 10 c3.medium.x86 servers are available in NY or Dallas:
metal capacity check -m ny,da -P c3.medium.x86 -q 10

# Checks if Silicon Valley or Dallas has either 4 c3.medium.x86 or m3.large.x86
metal capacity check -m sv,da -P c3.medium.x86,m3.large.x86 -q 4

-f, --facilities strings   A facility or list of facilities.
-h, --help                 help for check
-m, --metros strings       A metro or list of metros.
-P, --plans strings        A plan or list of plans.
-q, --quantity int         The number of devices wanted.

metal capacity get [-m | -f] | [--metros <list> | --facilities <list>] [-P <list>] [flags]

# Returns the capacity of all plans in all facilities:
metal capacity get 

# Returns the capacity of the c3.small.x86 in all metros:
metal capacity get -m -P c3.small.x86

# Returns c3.large.arm and c3.medium.x86 capacity in the Silicon Valley, New York, and Dallas metros:
metal capacity get --metros sv,ny,da -P c3.large.arm,c3.medium.x86

--facilities strings   A facility or list of facilities for client-side filtering. Will only return the capacity for the specified facilities. Can not be used with --metros.
-f, --facility             Return the capacity for all facilities. Can not be used with -m. (default true)
-h, --help                 help for get
-m, --metro                Return the capacity for all metros. Can not be used with -f.
--metros strings       A metro or list of metros for client-side filtering. Will only return the capacity for the specified metros. Can not be used with --facilities.
-P, --plans strings        Return only the capacity for the specified plans.

-h, --help   help for device

metal device create -p <project_id> (-m <metro> | -f <facility>) -P <plan> -H <hostname> -O <operating_system> [-u <userdata> | --userdata-file <filepath>] [-c <customdata>] [-t <tags>] [-r <hardware_reservation_id>] [-I <ipxe_script_url>] [--always-pxe] [--spot-instance] [--spot-price-max=<max_price>] [flags]

# Provisions a c3.small.x86 in the Dallas metro running Ubuntu 20.04:
metal device create -p $METAL_PROJECT_ID -P c3.small.x86 -m da -H test-staging-2 -O ubuntu_20_04

# Provisions a c3.medium.x86 in Silicon Valley, running Rocky Linux, from a hardware reservation:
metal device create -p $METAL_PROJECT_ID -P c3.medium.x86 -m sv -H test-rocky -O rocky_8 -r 47161704-1715-4b45-8549-fb3f4b2c32c7

-a, --always-pxe                       Sets whether the device always PXE boots on reboot.
-b, --billing-cycle string             Billing cycle  (default "hourly")
-c, --customdata string                Custom data to be included with your device's metadata.
-f, --facility string                  Code of the facility where the device will be created
-r, --hardware-reservation-id string   The UUID of a hardware reservation, if you are provisioning a server from your reserved hardware.
-h, --help                             help for create
-H, --hostname string                  Hostname
-I, --ipxe-script-url string           The URL of an iPXE script.
-m, --metro string                     Code of the metro where the device will be created
-O, --operating-system string          Operating system name for the device
-P, --plan string                      Name of the plan
-p, --project-id string                The project's UUID. This flag is required, unless specified in the config created by metal init or set as METAL_PROJECT_ID environment variable.
-S, --public-ipv4-subnet-size int      Size of the public IPv4 subnet.
-s, --spot-instance                    Provisions the device as a spot instance.
--spot-price-max float             Sets the maximum spot market price for the device: --spot-price-max=1.2
-t, --tags strings                     Tag or list of tags for the device: --tags="tag1,tag2".
-T, --termination-time string          Device termination time: --termination-time="2023-08-24T15:04:05Z"
-u, --userdata string                  Userdata for device initialization. Can not be used with --userdata-file.
--userdata-file string             Path to a userdata file for device initialization. Can not be used with --userdata.

metal device delete -i <device_id> [-f] [flags]

# Deletes the specified device:
metal device delete -i 7ec86e23-8dcf-48ed-bd9b-c25c20958277
>
✔ Are you sure you want to delete device 7ec86e23-8dcf-48ed-bd9b-c25c20958277 [Y/N]: y

# Deletes a VLAN, skipping confirmation:
metal device delete -f -i 7ec86e23-8dcf-48ed-bd9b-c25c20958277

-f, --force       Skips confirmation for the device deletion.
-h, --help        help for delete
-i, --id string   The UUID of the device.

metal device get [-p <project_id>] | [-i <device_id>] [flags]

# Gets the details of the specified device:
metal device get -i 52b60ca7-1ae2-4875-846b-4e4635223471

# Gets a list of devices in the specified project:
metal device get -p 5ad070a5-62e8-4cfe-a0b9-3b79e59f1cfe

# Get a list of devices with the hostname foo and a default project configured:
metal device get --filter hostname=foo

-h, --help                help for get
-i, --id string           The UUID of a device.
-p, --project-id string   The project's UUID. This flag is required, unless specified in the config created by metal init or set as METAL_PROJECT_ID environment variable.

metal device reboot -i <device_id> [flags]

# Reboots the specified device:
metal device reboot --id 26a9da5f-a0db-41f6-8467-827e144e59a7

-h, --help        help for reboot
-i, --id string   The device UUID.

metal device reinstall --id <device-id> [--operating-system <os_slug>] [--deprovision-fast] [--preserve-data] [flags]

# Reinstalls a device with the current OS:
metal device reinstall -d 50382f72-02b7-4b40-ac8d-253713e1e174

# Reinstalls a device with Ubuntu 22.04 while preserving the data on non-OS disks:
metal device reinstall -d 50382f72-02b7-4b40-ac8d-253713e1e174 -O ubuntu_22_04 --preserve-data

--deprovision-fast          Avoid optional potentially slow clean-up tasks.
-h, --help                      help for reinstall
-d, --id string                 ID of device to be reinstalled
-O, --operating-system string   Operating system install on the device. If omitted the current OS will be reinstalled.
--preserve-data             Avoid wiping data on disks where the OS is *not* being installed.

metal device start -i <device_id> [flags]

# Starts the specified device:
metal device start --id 26a9da5f-a0db-41f6-8467-827e144e59a7

-h, --help        help for start
-i, --id string   The UUID of the device.

metal device stop -i <device_id> [flags]

# Stops the specified device:
metal device stop --id [device_UUID]

-h, --help        help for stop
-i, --id string   The UUID of the device.

metal device update -i <device_id> [-H <hostname>] [-d <description>] [--locked <boolean>] [-t <tags>] [-u <userdata> | --userdata-file <filepath>] [-c <customdata>] [-s <ipxe_script_url>] [--always-pxe=<true|false>] [flags]

# Updates the hostname of a device:
metal device update --id 30c15082-a06e-4c43-bfc3-252616b46eba --hostname renamed-staging04

-a, --always-pxe               Updates the always_pxe toggle for the device (<true|false>).
-c, --customdata string        Adds or updates custom data to be included with your device's metadata.
-d, --description string       Adds or updates the description for the device.
-h, --help                     help for update
-H, --hostname string          The new hostname of the device.
-i, --id string                The UUID of the device.
-s, --ipxe-script-url string   Add or update the URL of the iPXE script.
-l, --locked                   Locks or unlocks the device for future changes (<true|false>).
-t, --tags strings             Adds or updates the tags for the device --tags="tag1,tag2".
-u, --userdata string          Adds or updates the userdata for the device.
--userdata-file string     Path to a userdata file for device initialization. Can not be used with --userdata.

-h, --help   help for event

metal event get [-p <project_id>] | [-d <device_id>] | [-i <event_id>] | [-O <organization_id>] [flags]

# Retrieve all events of a current user:
metal event get

# Retrieve the details of a specific event:
metal event get -i e9a969b3-8911-4667-9d99-57cd3dd4ef6f

# Retrieve all the events of an organization:
metal event get -o c079178c-9557-48f2-9ce7-cfb927b81928

# Retrieve all events of a project:
metal event get -p 1867ee8f-6a11-470a-9505-952d6a324040

# Retrieve all events of a device:
metal event get -d ca614540-fbd4-4dbb-9689-457c6ccc8353

-d, --device-id string         UUID of the device
-h, --help                     help for get
-i, --id string                UUID of the event
-O, --organization-id string   UUID of the organization
-p, --project-id string        Project ID (METAL_PROJECT_ID)

-h, --help   help for facilities

metal facilities get [flags]

# Lists facilities for current user:
metal facilities get

-h, --help   help for get

-h, --help   help for gateway

metal gateway create -p <project_UUID> --virtual-network <virtual_network_UUID> (--ip-reservation-id <ip_reservation_UUID> | --private-subnet-size <size>) [flags]

# Creates a Metal Gateway on the VLAN with a given IP Reservation ID:
metal gateway create -p $METAL_PROJECT_ID -v 77e6d57a-d7a4-4816-b451-cf9b043444e2 -r 50052f72-02b7-4b40-ac9d-253713e1e178

# Creates a Metal Gateway on the VLAN with a Private 10.x.x.x/28 subnet:
metal gateway create -p $METAL_PROJECT_ID --virtual-network 77e6d57a-d7a4-4816-b451-cf9b043444e2 --private-subnet-size 16

-h, --help                        help for create
-r, --ip-reservation-id string    UUID of the Public or VRF IP Reservation to assign.
-s, --private-subnet-size int32   Size of the private subnet to request (8 for /29)
-p, --project-id string           The project's UUID. This flag is required, unless specified in the config created by metal init or set as METAL_PROJECT_ID environment variable.
-v, --virtual-network string      UUID of the Virtual Network to assign.

metal gateway create-bgp-dynamic-neighbors [flags]

# Create a BGP Dynamic Neighbor using ip range and asn for the metal gateway id

metal gateways create-bgp-dynamic-neighbor --id "9c56fa1d-ec05-470b-a938-0e5dd6a1540c" --bgp-neighbor-range "10.70.43.226/29" --asn 65000

--asn int                     ASN for the BGP Dynamic Neighbor IP range.
--bgp-neighbor-range string   BGP Dynamic Neighbor IP Range from gateway.
-h, --help                        help for create-bgp-dynamic-neighbors
-i, --id string                   Metal Gateway ID for which the BGP Dynamic Neighbor to be created.

metal gateway delete -i <metal_gateway_UUID> [-f] [flags]

# Deletes a Gateway, with confirmation.
metal gateway delete -i 77e6d57a-d7a4-4816-b451-cf9b043444e2
>
✔ Are you sure you want to delete Metal Gateway 77e6d57a-d7a4-4816-b451-cf9b043444e2 [Y/N]: y

# Deletes a Gateway, skipping confirmation.
metal gateway delete -f -i 77e6d57a-d7a4-4816-b451-cf9b043444e2

-f, --force       Skips confirmation for the removal of the Metal Gateway.
-h, --help        help for delete
-i, --id string   UUID of the Gateway.

metal gateway delete-bgp-dynamic-neighbors [flags]

# Deletes a BGP Dynamic Neighbor using the bgp dynamic neighbor ID

$ metal gateways delete-bgp-dynamic-neighbor --id "9c56fa1d-ec05-470b-a938-0e5dd6a1540c"

BGP Dynamic Neighbor deletion initiated. Please check 'metal gateway get-bgp-dynamic-neighbor -i 9c56fa1d-ec05-470b-a938-0e5dd6a1540c for status

--bgp-neighbor-id string   UUID of BGP Dynamic Neighbor.
-h, --help                     help for delete-bgp-dynamic-neighbors

metal gateway get -p <project_UUID> [flags]

# Lists Metal Gateways for project 3b0795ba-ec9a-4a9e-83a7-043e7e11407c:
metal gateways get -p 3b0795ba-ec9a-4a9e-83a7-043e7e11407c

-h, --help                help for get
-p, --project-id string   The project's UUID. This flag is required, unless specified in the config created by metal init or set as METAL_PROJECT_ID environment variable.

metal gateway get-bgp-dynamic-neighbors [flags]

# Gets a BGP Dynamic Neighbor using the bgp dynamic neighbor ID

$ metal gateways get-bgp-dynamic-neighbor --id "9c56fa1d-ec05-470b-a938-0e5dd6a1540c"

--bgp-neighbor-id string   UUID of BGP Dynamic Neighbor ID.
-h, --help                     help for get-bgp-dynamic-neighbors

metal gateway list-bgp-dynamic-neighbors [flags]

# Lists BGP Dynamic Neighbor for the specified metal gateway ID

$ metal gateways list-bgp-dynamic-neighbor --id "9c56fa1d-ec05-470b-a938-0e5dd6a1540c"

-h, --help        help for list-bgp-dynamic-neighbors
-i, --id string   UUID of Metal Gateway.

-h, --help   help for hardware-reservation

metal hardware-reservation get [-p <project_id>] | [-i <hardware_reservation_id>] [flags]

# Retrieve all hardware reservations of a project:
metal hardware-reservations get -p $METAL_PROJECT_ID

# Retrieve the details of a specific hardware reservation:
metal hardware-reservations get -i 8404b73c-d18f-4190-8c49-20bb17501f88

-h, --help                help for get
-i, --id string           The UUID of a hardware reservation.
-p, --project-id string   A project's UUID.

metal hardware-reservation move -i <hardware_reservation_id> -p <project_id> [flags]

# Moves a hardware reservation to the specified Project:
metal hardware-reservation move -i 8404b73c-d18f-4190-8c49-20bb17501f88 -p 278bca90-f6b2-4659-b1a4-1bdffa0d80b7

-h, --help                help for move
-i, --id string           The UUID of the hardware reservation.
-p, --project-id string   The Project ID of the Project you are moving the hardware reservation to.

-h, --help   help for interconnections

metal interconnections create -n <name> [-m <metro>] [-r <redundancy> ] [-t <type> ] [-p <project_id> ] | [-O <organization_id> ] [flags]

# Creates a new interconnection named "it-interconnection":
metal interconnections create -n <name> [-m <metro>] [-r <redundancy>] [-t "dedicated" ] [-p <project_id>] | [-O <organization_id>]

metal interconnections create -n <name> [-m <metro>] [-r <redundancy>] [-t "shared" ] [-p <project_id>] | [-O <organization_id>] -T <service_token_type>

metal interconnections create -n <name> [-m <metro>] [-r <redundancy>] [-t "shared" ] [-p <project_id>] | [-O <organization_id>] -T <service_token_type> -v <vrfs>

-h, --help                        help for create
-m, --metro string                Metro Id or Metro Code from where the interconnection will be originated.
-n, --name string                 Name of the interconnection.
--organization-id string      The Organization's UUID to be used for creating org level interconnection request. Either one of this flag or --project-id is required.
-p, --project-id string           The project's UUID. Either one of this flag or --organization-id is required.
-r, --redundancy string           Types of redundancy for the interconnection. Either 'primary' or 'redundant'.
-T, --service-token-type string   Type of service token for shared connection. Enum: 'a_side', 'z_side'.
-s, --speed int32                 The maximum speed of the interconnections. (default 1000000000)
-t, --type string                 Type of of interconnection. Either 'dedicated' or 'shared' when requesting for a Fabric VC.
--vlan int32Slice             A list of VLANs to attach to the Interconnection. Ex: --vlans 1000, 1001 . (default [])
--vrf strings                 A list of VRFs to attach to the Interconnection. Ex: --vrfs uuid1, uuid2 .

metal interconnections delete -i <connection_id>  [flags]

# Deletes the specified interconnection:
metal interconnections delete -i 7ec86e23-8dcf-48ed-bd9b-c25c20958277
>
✔ Are you sure you want to delete device 7ec86e23-8dcf-48ed-bd9b-c25c20958277 [Y/n]: Y

-f, --force       Skips confirmation for the interconnection deletion.
-h, --help        help for delete
-i, --id string   The UUID of the interconnection.

metal interconnections get [flags]

# Retrieve all interconnections of a current user::

# Retrieve the details of a specific interconnection:
metal interconnections get -i e9a969b3-8911-4667-9d99-57cd3dd4ef6f

# Retrieve all the interconnection of an organization:
metal interconnections get -O c079178c-9557-48f2-9ce7-cfb927b81928

# Retrieve all interconnection of a project:
metal interconnections get -p 1867ee8f-6a11-470a-9505-952d6a324040 

-i, --connID string           UUID of the interconnection
-h, --help                    help for get
-O, --organizationID string   UUID of the organization
-p, --projectID string        Project ID (METAL_PROJECT_ID)

metal interconnections update -i <connection_id> [flags]

# Updates a specified connection.:
metal interconnections update --id 30c15082-a06e-4c43-bfc3-252616b46eba -n [<name>] -d [<description>] -r [<'redundant'|'primary'>]-m [<standard|tunnel>] -e [<E-mail>] --tags="tag1,tag2"

-e, --contactEmail string   adds or updates the Email
-d, --description string    Adds or updates the description for the interconnection.
-h, --help                  help for update
-i, --id string             The UUID of the interconnection.
-m, --mode string           Adds or updates the mode for the interconnection.
-n, --name string           The new name of the interconnection.
-r, --redundancy string     Updating from 'redundant' to 'primary' will remove a secondary port, while updating from 'primary' to 'redundant' will add one.
-t, --tags strings          Adds or updates the tags for the connection --tags="tag1,tag2".

-h, --help   help for ip

metal ip assign -a <IP_address> -d <device_UUID> [flags]

# Assigns an IP address to a server:
metal ip assign -d 060d1626-2481-475a-9789-c6f4bb927303  -a 198.51.100.3/31

-a, --address string     IP address and CIDR you would like to assign.
-d, --device-id string   The UUID of the device.
-h, --help               help for assign

metal ip available -r <reservation_UUID> -c <size_of_subnet> [flags]

# Lists available IP addresses in a reservation for a /31 subnet:
metal ip available --reservation-id da1bb048-ea6e-4911-8ab9-b95635ca127a --cidr 31

-c, --cidr int                The size of the desired subnet in bits.
-h, --help                    help for available
-r, --reservation-id string   The UUID of the IP address reservation.

metal ip get -p <project-id> | -a <assignment-id> | -r <reservation-id> [flags]

# Lists all IP addresses in a project:
metal ip get -p bb73aa19-c216-4ce2-a613-e5ca93732722 

# Gets information about the IP addresses from an assignment ID:
metal ip get -a bb526d47-8536-483c-b436-116a5fb72235

# Gets the IP addresses from a reservation ID:
metal ip get -r da1bb048-ea6e-4911-8ab9-b95635ca127a

-a, --assignment-id string    UUID of an IP address assignment. When you assign an IP address to a server, it gets an assignment UUID.
-h, --help                    help for get
-p, --project-id string       A Project UUID (METAL_PROJECT_ID).
-r, --reservation-id string   UUID of an IP address reservation.

metal ip remove -i <reservation_UUID> [flags]

# Removes an IP address reservation:
metal ip remove --id a9dfc9d5-ba1a-4d11-8cfc-6e30b9630876

-h, --help        help for remove
-i, --id string   UUID of the reservation

metal ip request -p <project-id> -t <ip_address_type> -q <quantity> (-m <metro> | -f <facility>) [-f <flags>] [-c <comments>] [flags]

# Requests a block of 4 public IPv4 addresses in Dallas:
metal ip request -p $METAL_PROJECT_ID -t public_ipv4 -q 4 -m da

metal ip request -v df18fbd8-2919-4104-a042-5d42a05b8eed -t vrf --cidr 24 -n 172.89.1.0 --tags foo --tags bar --customdata '{"my":"goodness"}' --details "i don't think VRF users need this or will see it after submitting the request"

--cidr int            The size of the desired subnet in bits.
-c, --comments string     General comments or description.
--customdata string   customdata is to add to the reservation, in a comma-separated list.
--details string      VRF IP Reservation's details
-f, --facility string     Code of the facility where the IP Reservation will be created
-h, --help                help for request
-m, --metro string        Code of the metro where the IP Reservation will be created
-n, --network string      The starting address for this VRF IP Reservation's subnet
-p, --project-id string   The project's UUID. This flag is required, unless specified in the config created by metal init or set as METAL_PROJECT_ID environment variable.
-q, --quantity int        Number of IP addresses to reserve.
--tags strings        Adds the tags for the IP Reservations --tags "tag1,tag2" OR --tags "tag1" --tags "tag2"
-t, --type string         The type of IP Address, either public_ipv4 or global_ipv4.
-v, --vrf-id string       Specify the VRF UUID.

metal ip unassign -i <assignment_UUID>  [flags]

# Unassigns an IP address assignment:
metal ip unassign --id abd8674b-96c4-4271-92f5-2eaf5944c86f

-h, --help        help for unassign
-i, --id string   The UUID of the assignment.

-h, --help   help for metros

metal metros get [flags]

# Lists metros available to the current user:   
metal metros get

-h, --help   help for get

-h, --help   help for operating-systems

metal operating-systems get [flags]

# Lists the operating systems available to the current user:
metal operating-systems get

-h, --help   help for get

-h, --help   help for organization

metal organization create -n <name> [-d <description>] [-w <website_URL>] [-t <twitter_URL>] [-l <logo_URL>] [flags]

# Creates a new organization named "it-backend-infra": 
metal organization create -n it-backend-infra

# Creates a new organization with name, website, and twitter:
metal organization create -n test-org -w www.metal.equinix.com -t https://twitter.com/equinixmetal 

-d, --description string   Description of the organization.
-h, --help                 help for create
-l, --logo string          A Logo image URL.]
-n, --name string          Name of the organization.
-t, --twitter string       Twitter URL of the organization.
-w, --website string       Website URL of the organization.

metal organization delete -i <organization_UUID> [flags]

# Deletes an organization, with confirmation: 
metal organization delete -i 3bd5bf07-6094-48ad-bd03-d94e8712fdc8
>
✔ Are you sure you want to delete organization 3bd5bf07-6094-48ad-bd03-d94e8712fdc8 [Y/N]: y

# Deletes an organization, skipping confirmation:
metal organization delete -i 3bd5bf07-6094-48ad-bd03-d94e8712fdc8 -f

-f, --force                    Skips confirmation for the removal of the organization.
-h, --help                     help for delete
-i, --organization-id string   The UUID of the organization.

metal organization get -i <organization_UUID> [flags]

# Retrieves list of the current user's organizations:
metal organization get

# Retrieves details of an organization:
metal organization get -i 3bd5bf07-6094-48ad-bd03-d94e8712fdc8

-h, --help                     help for get
-i, --organization-id string   The UUID of an organization.

metal organization payment-methods -i <organization_UUID> [flags]

# Lists the payment methods for an organization:
metal organization payment-methods --id 3bd5bf07-6094-48ad-bd03-d94e8712fdc8

-h, --help        help for payment-methods
-i, --id string   The UUID of the organization.

metal organization update -i <organization_UUID> [-n <name>] [-d <description>] [-w <website_URL>] [-t <twitter_URL>] [-l <logo_URL>] [flags]

# Updates the name of an organization:
metal organization update -i 3bd5bf07-6094-48ad-bd03-d94e8712fdc8 --name test-cluster02

-d, --description string   User-friendly description of the organization.
-h, --help                 help for update
-i, --id string            An organization UUID.
-l, --logo string          A logo image URL for the organization.
-n, --name string          New name for the organization.
-t, --twitter string       A Twitter URL of the organization.
-w, --website string       A website URL for the organization.

-h, --help   help for plan

metal plan get [flags]

# Lists the plans available to the current user:
metal plans get

-h, --help   help for get

-h, --help   help for port

metal port convert -i <port_UUID> [--bonded] [--bulk] --layer2 [--force] [--public-ipv4] [--public-ipv6] [flags]

# Converts list of the current user's ports:
metal port convert -i <port_UUID> [--bonded] [--bulk] [--layer2] [--force] [--public-ipv4] [--public-ipv6]

# Converts port to layer-2 unbonded:
metal port convert -i 3bd5bf07-6094-48ad-bd03-d94e8712fdc8 --layer2 --bonded=false

# Converts port to layer-2 bonded:
metal port convert -i 3bd5bf07-6094-48ad-bd03-d94e8712fdc8 --layer2 --bonded

# Converts port to layer-3 bonded with public IPv4 and public IPv6:
metal port convert -i 3bd5bf07-6094-48ad-bd03-d94e8712fdc8 -2=false -b -4 -6

-b, --bonded           Convert to layer-2 bonded.
--bulk             Affect both ports in a bond.
-f, --force            Force conversion to layer-2 bonded.
-h, --help             help for convert
-2, --layer2           Convert to layer-2 unbonded.
-i, --port-id string   The UUID of a port.
-4, --public-ipv4      Convert to layer-2 bonded with public IPv4.
-6, --public-ipv6      Convert to layer-2 bonded with public IPv6.

metal port get -i <port_UUID> [flags]

# Retrieves details of a port:
metal port get -i 3bd5bf07-6094-48ad-bd03-d94e8712fdc8

-h, --help             help for get
-i, --port-id string   The UUID of a port.

metal port vlan -i <port_UUID> [--native <vlan>] [--unassign <vlan>]... [--assign <vlan>]... [flags]

# Assigns VLANs 1234 and 5678 to the port:
metal port vlans -i 3bd5bf07-6094-48ad-bd03-d94e8712fdc8 -a 1234 -a 5678

# Unassigns VXLAN 1234 from the port:
metal port vlans -i 3bd5bf07-6094-48ad-bd03-d94e8712fdc8 -u 1234

# Assigns VXLAN 1234 to the port and makes it the Native VLAN:
metal port vlans -i 3bd5bf07-6094-48ad-bd03-d94e8712fdc8 --native=1234

-a, --assign strings     A VXLAN to assign to the port. May also be used to change a Native VLAN assignment to tagged (non-native).
-h, --help               help for vlan
-n, --native string      The VXLAN to make assign as the Native VLAN
-i, --port-id string     The UUID of a port.
-u, --unassign strings   A VXLAN to unassign from a port.

-h, --help   help for project

metal project bgp-config --project-id <project_UUID> [flags]

metal project bgp-config --project-id 50693ba9-e4e4-4d8a-9eb2-4840b11e9375 -d 

-h, --help                help for bgp-config
-p, --project-id string   Project ID (METAL_PROJECT_ID)

metal project bgp-enable --project-id <project_UUID> --deployment-type <deployment_type> [--asn <asn>] [--md5 <md5_secret>] [--use-case <use_case>] [flags]

metal project bgp-enable --project-id 50693ba9-e4e4-4d8a-9eb2-4840b11e9375 --deployment-type local --asn 65000

--asn int                  Local ASN (default 65000)
--deployment-type string   Deployment type (local, global)
-h, --help                     help for bgp-enable
--md5 string               BGP Password
-p, --project-id string        Project ID (METAL_PROJECT_ID)
--use-case string          Use case for BGP

metal project bgp-sessions --project-id <project_UUID> [flags]

metal project bgp-sessions --project-id 50693ba9-e4e4-4d8a-9eb2-4840b11e9375

-h, --help                help for bgp-sessions
-p, --project-id string   Project ID (METAL_PROJECT_ID)

metal project create -n <project_name> [-O <organization_UUID>] [-m <payment_method_UUID>] [flags]

# Creates a new project named dev-cluster02: 
metal project create --name dev-cluster02

# Creates a new project named dev-cluster03 in the specified organization with a payment method:
metal project create -n dev-cluster03 -O 814b09ca-0d0c-4656-9de0-4ce65c6faf70 -m ab1fbdaa-8b25-4c3e-8360-e283852e3747

-h, --help                       help for create
-n, --name string                Name of the project
-O, --organization-id string     The UUID of the organization.
-m, --payment-method-id string   The UUID of the payment method.

metal project delete --id <project_UUID> [--force] [flags]

# Deletes project 50693ba9-e4e4-4d8a-9eb2-4840b11e9375:
metal project delete -i 50693ba9-e4e4-4d8a-9eb2-4840b11e9375
>
✔ Are you sure you want to delete project 50693ba9-e4e4-4d8a-9eb2-4840b11e9375 [Y/N]: y

# Deletes project 50693ba9-e4e4-4d8a-9eb2-4840b11e9375, skipping confirmation:
metal project delete -i 50693ba9-e4e4-4d8a-9eb2-4840b11e9375 -f

-f, --force       Force removal of the project
-h, --help        help for delete
-i, --id string   The project's UUID. This flag is required, unless specified in the config created by metal init or set as METAL_PROJECT_ID environment variable.

metal project get [-i <project_UUID> | -n <project_name>] [flags]

# Retrieve all projects:
metal project get

# Retrieve a specific project by UUID: 
metal project get -i 2008f885-1aac-406b-8d99-e6963fd21333

# Retrieve a specific project by name:
metal project get -n dev-cluster03

-h, --help             help for get
-i, --id string        The project's UUID, which can be specified in the config created by metal init or set as METAL_PROJECT_ID environment variable.
-n, --project string   The name of the project.

metal project update -i <project_UUID> [-n <name>] [-m <payment_method_UUID>] [flags]

# Updates the specified project with a new name:
metal project update -i $METAL_PROJECT_ID -n new-prod-cluster05

# Updates the specified project with a new payment method:
metal project update -i $METAL_PROJECT_ID -m e2fcdf91-b6dc-4d6a-97ad-b26a14b66839

-h, --help                       help for update
-i, --id string                  The project's UUID. This flag is required, unless specified in the config created by metal init or set as METAL_PROJECT_ID environment variable.
-n, --name string                The new name for the project.
-m, --payment-method-id string   The UUID of the new payment method.

-h, --help   help for ssh-key

metal ssh-key create --key <public_key> --label <label> [flags]

# Adds a key labled "example-key" to the current user account.
metal ssh-key create --key ssh-rsa AAAAB3N...user@domain.com --label example-key

-h, --help           help for create
-k, --key string     User's full SSH public key string.
-l, --label string   Name or other user-friendly description of the SSH key.

metal ssh-key delete --id <SSH-key_UUID> [--force] [flags]

# Deletes an SSH key, with confirmation:
metal ssh-key delete -i 5cb96463-88fd-4d68-94ba-2c9505ff265e
>
✔ Are you sure you want to delete SSH Key 5cb96463-88fd-4d68-94ba-2c9505ff265e [Y/N]: y

# Deletes an SSH key, skipping confirmation:
metal ssh-key delete -i 5cb96463-88fd-4d68-94ba-2c9505ff265e -f

-f, --force       Skips confirmation for the deletion of the SSH key.
-h, --help        help for delete
-i, --id string   The UUID of the SSH key.

metal ssh-key get [-i <SSH-key_UUID>] [-P] [-p <project_id>] [flags]

# Retrieves the SSH keys of the current user: 
metal ssh-key get

# Returns the details of SSH key 5cb96463-88fd-4d68-94ba-2c9505ff265e:
metal ssh-key get --id 5cb96463-88fd-4d68-94ba-2c9505ff265e

# Retrieve all project SSH keys
metal ssh-key get --project-ssh-keys --project-id [project_UUID]

-h, --help                help for get
-i, --id string           The UUID of an SSH key.
-p, --project-id string   List SSH Keys for the project identified by Project ID (ignored without -P)
-P, --project-ssh-keys    List SSH Keys for projects

metal ssh-key update -i <SSH-key_UUID> [-k <public_key>] [-l <label>] [flags]

# Updates SSH key 5cb96463-88fd-4d68-94ba-2c9505ff265e with a new public key: 
metal ssh-key update -i 5cb96463-88fd-4d68-94ba-2c9505ff265e -k AAAAB3N...user@domain.com

# Updates SSH key 5cb96463-88fd-4d68-94ba-2c9505ff265e with a new label:
metal ssh-key update -i 5cb96463-88fd-4d68-94ba-2c9505ff265e -l test-machine-2

-h, --help           help for update
-i, --id string      UUID of the SSH key
-k, --key string     Public SSH key string
-l, --label string   Name of the SSH key

-h, --help   help for user

metal user add --email <email> --roles <roles> [--organization-id <organization_id>] [--project-id <project_id>] [flags]

# Adds a user to a project with admin role:
metal user add --email user@example.org --roles admin --project-id 3b0795ba-fd0b-4a9e-83a7-063e5e12409d

--email string             Email of the user.
-h, --help                     help for add
--organization-id string   Organization to invite the user to.
-p, --project-id strings       Projects to invite the user to with the specified roles.
--roles strings            Roles to assign to the user.

metal user get [-i <user_UUID>] [flags]

# Retrieves the current user's information:
metal user get

# Returns information on user 3b0795ba-fd0b-4a9e-83a7-063e5e12409d:
metal user get --i 3b0795ba-fd0b-4a9e-83a7-063e5e12409d

-h, --help        help for get
-i, --id string   UUID of the user.

-h, --help   help for virtual-circuit

metal virtual-circuit create  [-c connection_id] [-p port_id] [-P <project_id> ] -n <name> [-d <description>] [--vnid <vnid> ] [-V <vlan> ] [-s <speed> ] [-t <tags> ] [flags]

# Creates a new virtual-circuit named "interconnection": 
metal vc create [-c connection_id] [-p port_id] [-P <project_id> ] [-n <name>] [-d <description>] [--vnid <vnid> ] [-V <vlan> ] [-s <speed> ] [-t <tags> ]

metal vc create -c 81c9cb9e-b02f-4c73-9e04-06702f1380a0 -p 9c8f0c71-591d-42fe-9519-2f632761e2da -P b4673e33-0f48-4948-961a-c31d6edf64f8 -n test-inter  -d test-interconnection -v 15315810-2fda-48b8-b8cd-441ebab684b5 -V 1010 -s 100

metal vc create [-c connection_id] [-p port_id] [-P <project_id> ] [-n <name>] [-d <description>] [-v <vrf-id>] [-M <md5sum>] [-a <peer-asn>] [-S <subnet>] [-c <customer_ip>] [-m <metal_ip>]

-c, --connection-id string   Specify the UUID of the interconnection.
--customer-ip string     An IP address from the subnet that will be used on the Customer side
-d, --description string     Description for a Virtual Circuit
-h, --help                   help for create
-M, --md5 string             The plaintext BGP peering password shared by neighbors as an MD5 checksum
-m, --metal-ip string        An IP address from the subnet that will be used on the Metal side. 
-n, --name string            Name of the Virtual Circuit
-a, --peer-asn int           The peer ASN that will be used with the VRF on the Virtual Circuit.
-p, --port-id string         Specify the UUID of the port.
-P, --project-id string      The project's UUID. This flag is required, unless specified in the config created by metal init or set as METAL_PROJECT_ID environment variable.
-s, --speed int              bps speed or string (e.g. 52 - '52m' or '100g' or '4 gbps')
-S, --subnet string          The /30 or /31 subnet of one of the VRF IP Blocks that will be used with the VRF for the Virtual Circuit. 
-t, --tags strings           Adds the tags for the virtual-circuit --tags "tag1,tag2" OR --tags "tag1" --tags "tag2"
-V, --vlan int               Adds or updates vlan  Must be between 2 and 4094
--vnid string            Specify the UUID  of the VLAN.
-v, --vrf-id string          The UUID of the VRF that will be associated with the Virtual Circuit.

metal virtual-circuit delete -i <virtual-circuit_id>  [flags]

# Deletes the specified virtual-circuit:
metal vc delete -i 7ec86e23-8dcf-48ed-bd9b-c25c20958277

-h, --help        help for delete
-i, --id string   Specify the UUID of the virtual-circuit.

metal virtual-circuit get -i <id> [flags]

# Retrieve virtual circuit for a specific circuit::

# Retrieve the details of a specific virtual-circuit:
metal vc get -i e9a969b3-8911-4667-9d99-57cd3dd4ef6f

-h, --help        help for get
-i, --id string   Specify UUID of the virtual-circuit

metal virtual-circuit update -i <id> [-v <vlan UUID>] [-d <description>] [-n <name>] [-s <speed>] [-t <tags>] [flags]

# Updates a specified virtualcircuit etiher of vlanID OR vrfID:

metal vc update [-i <id>] [-n <name>] [-d <description>] [-v <vnid> ] [-s <speed> ] [-t <tags> ]

metal vc update -i e2edb90b-a8ef-47cb-a577-63b0ba129c29 -d "test-inter-fri-dedicated"

metal vc update [-i <id>] [-n <name>] [-d <description>] [-M <md5sum>] [-a <peer-asn>] [-S <subnet>] [-c <customer-ip>] [-m <metal-ip>] [-t <tags> ]

-c, --customer-ip string   An IP address from the subnet that will be used on the Customer side
-d, --description string   Description for a Virtual Circuit
-h, --help                 help for update
-i, --id string            Specify the UUID of the virtual-circuit.
-M, --md5 string           The plaintext BGP peering password shared by neighbors as an MD5 checksum
-m, --metal-ip string      An IP address from the subnet that will be used on the Metal side. 
-n, --name string          Name of the Virtual Circuit
-a, --peer-asn int         The peer ASN that will be used with the VRF on the Virtual Circuit.
-s, --speed string         Adds or updates Speed can be changed only if it is an interconnection on a Dedicated Port
-S, --subnet string        The /30 or /31 subnet of one of the VRF IP Blocks that will be used with the VRF for the Virtual Circuit. 
-t, --tags strings         updates the tags for the virtual circuit --tags "tag1,tag2" OR --tags "tag1" --tags "tag2" (NOTE: --tags "" will remove all tags from the virtual circuit
-v, --vnid string          A Virtual Network record UUID or the VNID of a Metro Virtual Network in your project.

-h, --help   help for virtual-network

metal virtual-network create -p <project_UUID>  [-m <metro_code> -vxlan <vlan> | -f <facility_code>] [-d <description>] [flags]

# Creates a VLAN with vxlan ID 1999 in the Dallas metro:
metal virtual-network create -p $METAL_PROJECT_ID -m da --vxlan 1999

# Creates a VLAN in the sjc1 facility
metal virtual-network create -p $METAL_PROJECT_ID -f sjc1

-d, --description string   A user-friendly description of the virtual network.
-f, --facility string      Code of the facility.
-h, --help                 help for create
-m, --metro string         Code of the metro.
-p, --project-id string    The project's UUID. This flag is required, unless specified in the config created by metal init or set as METAL_PROJECT_ID environment variable.
--vxlan int            Optional VXLAN ID. Must be between 2 and 3999 and can only be used with --metro.

metal virtual-network delete -i <virtual_network_UUID> [-f] [flags]

# Deletes a VLAN, with confirmation.
metal virtual-network delete -i 77e6d57a-d7a4-4816-b451-cf9b043444e2
>
✔ Are you sure you want to delete virtual network 77e6d57a-d7a4-4816-b451-cf9b043444e2 [Y/N]: y

# Deletes a VLAN, skipping confirmation.
metal virtual-network delete -f -i 77e6d57a-d7a4-4816-b451-cf9b043444e2

-f, --force       Skips confirmation for the removal of the virtual network.
-h, --help        help for delete
-i, --id string   UUID of the VLAN.

metal virtual-network get -p <project_UUID> [flags]

# Lists virtual networks for project 3b0795ba-ec9a-4a9e-83a7-043e7e11407c:
metal virtual-network get -p 3b0795ba-ec9a-4a9e-83a7-043e7e11407c

-h, --help                help for get
-p, --project-id string   The project's UUID. This flag is required, unless specified in the config created by metal init or set as METAL_PROJECT_ID environment variable.

-h, --help   help for vrf

metal vrf create [-p <project_id] [-d <description>] [-m <metro>] [-n <name>] [-a <localASN>] [-r <IPranges>] [-t <tags> ] [flags]

# Creates an Creates a Virtual Routing and Forwarding(VRF) for a specified project.

metal vrf create [-p <project_id] [-d <description>] [-m <metro>] [-n <name>] [-a <localASN>] [-r <ipranges>] [-t <tags> ]

-d, --description string   Description of the Virtual Routing and Forwarding.
-h, --help                 help for create
-r, --ipranges strings     A list of CIDR network addresses. Like [10.0.0.0/16, 2001:d78::/56]. IPv4 blocks must be between /8 and /29 in size. IPv6 blocks must be between /56 and /64.
-a, --local-asn int        Local ASN for the VRF
-m, --metro string         The UUID (or metro code) for the Metro in which to create this Virtual Routing and Forwarding
-n, --name string          Name of the Virtual Routing and Forwarding
-p, --project-id string    The project's UUID. This flag is required, unless specified in the config created by metal init or set as METAL_PROJECT_ID environment variable.
-t, --tags strings         Adds the tags for the virtual-circuit --tags "tag1,tag2" OR --tags "tag1" --tags "tag2"

metal vrf create-route [-i <VrfId>] [-p <Prefix>] [-n NextHop] [-t <tags> ] [flags]

# Create a route in a VRF. Currently only static default routes are supported.

metal vrf create-route [-i <VrfID>] [-p <prefix>] [-n nextHop] [-t <tags> ]

-h, --help             help for create-route
-i, --id string        Specify the VRF UUID activate route configurations
-n, --nextHop string   The IPv4 address within the VRF of the host that will handle this route
-p, --prefix string    The IPv4 prefix for the route, in CIDR-style notation. For a static default route, this will always be '0.0.0.0/0'
-t, --tags strings     Adds the tags for the connection --tags="tag1,tag2".

metal vrf delete vrf -i <metal_vrf_UUID> [-f] [flags]

# Deletes a VRF, with confirmation.
metal delete vrf -i 77e6d57a-d7a4-4816-b451-cf9b043444e2
>
✔ Are you sure you want to delete device 7ec86e23-8dcf-48ed-bd9b-c25c20958277 [Y/N]: y

# Deletes a VRF, skipping confirmation.
metal delete vrf -f -i 77e6d57a-d7a4-4816-b451-cf9b043444e2

-f, --force       Skips confirmation for the removal of the VRF.
-h, --help        help for delete
-i, --id string   Specify the UUID of the VRF

metal vrf delete-route [-i <VrfRoute-Id>] [flags]

# Delete a VRF Route
metal vrf delete-route -i 77e6d57a-d7a4-4816-b451-cf9b043444e2
>
✔ Are you sure you want to delete device 7ec86e23-8dcf-48ed-bd9b-c25c20958277 [Y/N]: y

# Deletes a VRF, skipping confirmation.
metal vrf delete-route -f -i 77e6d57a-d7a4-4816-b451-cf9b043444e2

-f, --force       Skips confirmation for the removal of the VRF routes.
-h, --help        help for delete-route
-i, --id string   Specify the VRF UUID to delete the associated route configurations.

metal vrf get -p <project_Id>  [flags]

# Gets the details of the specified device
metal vrf get -v 3b0795ba-ec9a-4a9e-83a7-043e7e11407c

# Lists VRFs for project 3b0795ba-ec9a-4a9e-83a7-043e7e11407c:
metal vrf list -p 3b0795ba-ec9a-4a9e-83a7-043e7e11407c

-h, --help                help for get
-m, --metro string        Filter by Metro ID (uuid) or Metro Code
-p, --project-id string   The project's UUID. This flag is required, unless specified in the config created by metal init or set as METAL_PROJECT_ID environment variable.
-v, --vrf-id string       Specify the VRF UUID.

metal vrf get-route [-i <VrfRoute-Id>] [flags]

# Retrieve all routes in the VRF
metal vrf get-route -i bb526d47-8536-483c-b436-116a5fb72235

-h, --help        help for get-route
-i, --id string   Specify the VRF UUID to list its associated routes configurations

metal vrf ips [-v <vrf-id] [-i <ip-id>] [flags]

# Retrieves the list of VRF IP Reservations for the VRF.
metal vrf ips [-v <vrf-id] 

# Retrieve a specific IP Reservation for a VRF
metal vrf ips [-v <vrf-id] [-i <ip-id>]

-h, --help            help for ips
-i, --id string       Specify the IP UUID to retrieve the details of a VRF IP reservation.
-v, --vrf-id string   Specify the VRF UUID to list its associated IP reservations.