Référence CLI Equinix Metal
Equinix Metal™ fournit une plateforme bare metal pilotée par API qui combine l'expérience d'automatisation du cloud avec les avantages des serveurs physiques bare metal.
L'interface de ligne de commande [Equinix Metal CLI encapsule le SDK Equinix Metal Go equinix-sdk-go, permettant l'interaction avec l'API Equinix Metal à partir d'une interface de ligne de commande.
Installation
Installation du binaire à partir de la version Release
Vous pouvez télécharger le fichier binaire approprié pour votre système depuis la page Releases sur GitHub. Placez-le à l'emplacement désiré, exécutez-le (chmod) et renommez-le (metal).
Installation du binaire à partir de la source
Si vous avez installé go 1.19 ou une version ultérieure, vous pouvez compiler et installer la dernière version avec:
go install github.com/equinix/metal-cli/cmd/metal@latest
Vous pouvez trouver le fichier exécutable/binaire installé dans le dossier $GOPATH/bin ou $HOME/go/bin.
Brassage maison
Si vous préférez installer via Homebrew, vous pouvez exécuter ce qui suit:
brew tap equinix/homebrew-tap
brew install metal-cli
Ports FreeBSD
Les outils CLI Equinix Metal sont également disponibles à partir des ports FreeBSD:
sudo pkg install -r FreeBSD sysutils/equinix-metal-cli
Authentification
L'interface de ligne de commande (CLI) utilise votre jeton d'API Equinix Metal pour l'authentification. Ce jeton peut être stocké dans la variable d'environnement $METAL_AUTH_TOKEN.
export METAL_AUTH_TOKEN=<your_API_TOKEN>
Vous pouvez également configurer et stocker l'authentification et la configuration dans un fichier de configuration JSON ou YAML créé par metal init.
métal initial
Description
Init vous demandera de définir les paramètres du compte et enregistrera les valeurs par défaut dans un fichier de configuration pouvant être partagé avec d'autres outils Equinix Metal . Ce fichier est généralement stocké dans $HOME/.config/equinix/metal.yaml. Vous pouvez spécifier n'importe quel argument de ligne de commande Metal CLI dans le fichier de configuration. Veillez à ne pas définir d'options que vous ne souhaitez pas utiliser par défaut. Le fichier de configuration peut être modifié avec METAL_CONFIG et --config.
metal init
Exemples
# Example config:
--
token: foo
project-id: 1857dc19-76a5-4589-a9b6-adb729a7d18b
organization-id: 253e9cf1-5b3d-41f5-a4fa-839c130c8c1d
Options
-h, --help help for init
-help help for init
Options héritées des commandes parentes
Voir Options communes.
Environnement et achèvements
L'interface de ligne de commande Equinix Metal propose des commandes qui généreront des variables d'environnement et des complétions, selon le shell que vous utilisez.
environnement métallique
Description
Imprime ou génère des variables d'environnement. Variables actuellement émises: METAL_AUTH_TOKEN, METAL_ORGANIZATION_ID, METAL_PROJECT_ID, METAL_CONFIG. Utilisez l'indicateur --project-id pour définir la variable METAL_PROJECT_ID. Utilisez l'indicateur --organization-id pour définir la variable METAL_ORGANIZATION_ID.
metal env [-p <project_id>]
Exemples
# 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
Options
--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.
Options héritées des commandes parentes
Voir Options communes.
finition du métal
Description
Génère des scripts de complétion de shell pour différents shells.
metal completion [bash | zsh | fish | powershell]
Exemples
# 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
Options
-h, --help help for completion
Options héritées des commandes parentes
Voir Options communes.
Génération de documentation
documents métalliques
Description
Génère la documentation Markdown des commandes dans le répertoire spécifié. Chaque commande obtient un fichier Markdown.
metal docs <destination>
Exemples
# Generate documentation in the ./docs directory:
metal docs ./docs
Options
-h, --help help for docs
Options courantes
Ces options sont disponibles pour toutes les commandes de l'interface de ligne de commande Equinix Metal .
--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)
métal 2fa
Description
Activez ou désactivez l'authentification à deux facteurs sur votre compte utilisateur ou recevez un jeton OTP. Plus d'informations sont disponibles sur /metal/identity-access-management/users/.
Options
-h, --help help for 2fa
Options héritées des commandes parentes
Voir Options communes.
métal 2fa désactivé
Description
Désactive l'authentification à deux facteurs. Nécessite le code OTP actuel, que ce soit par SMS ou via l'application. Si vous n'avez plus accès à votre appareil d'authentification à deux facteurs, veuillez contacter l'assistance.
metal 2fa disable (-a | -s) --code <OTP_code> [flags]
Exemples
# 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>
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
activation du métal 2fa
Description
Active l'authentification à deux facteurs sur le compte de l'utilisateur actuel. L'authentification à deux facteurs est disponible par SMS ou via une application. Un code OPT valide est requis, qui peut être généré par la commande 2fa receive.
metal 2fa enable (-s | -a) --code <OTP_code> [flags]
Exemples
# 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>
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
métal 2fa recevoir
Description
Génère un jeton d'authentification à deux facteurs permettant d'activer l'authentification à deux facteurs sur le compte de l'utilisateur actuel. Pour utiliser les SMS, un numéro de téléphone doit être associé au compte pour recevoir le code. Si vous utilisez une application, l'URI de l'application est renvoyée.
metal 2fa receive (-s | -a) [flags]
Exemples
# Issue the token via SMS:
metal 2fa receive -s
# Issue the token via app:
metal 2fa receive -a
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
capacité métallique
Description
Opérations de capacité. Pour plus d'informations sur la capacité des métros, consultez la page /metal/locations/metros/. Pour plus d'informations sur la capacité des installations, consultez la page /metal/locations/capacity/.
Options
-h, --help help for capacity
Options héritées des commandes parentes
Voir Options communes.
vérification de la capacité du métal
Description
Vérifie si le nombre de serveurs du forfait spécifié est disponible dans la zone métropolitaine ou l'installation spécifiée. Les zones métropolitaine et les installations sont mutuellement exclusives. Au moins une zone métropolitaine (ou installation), un forfait et une quantité de 1 ou plus sont requis.
metal capacity check (-m <metro> | -f <facility>) -P <plan> -q <quantity> [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
capacité du métal
Description
Renvoie la capacité des métros ou des installations. Des filtres sont disponibles pour les métros, les installations et les plans. Les indicateurs de métro et d'installation s'excluent mutuellement. Si aucun indicateur n'est inclus, la capacité de tous les plans de toutes les installations est renvoyée.
metal capacity get [-m | -f] | [--metros <list> | --facilities <list>] [-P <list>] [flags]
Exemples
# 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
Options
--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.
Options héritées des commandes parentes
Voir Options communes.
dispositif métallique
Description
Opérations de périphérique qui contrôlent le provisionnement du serveur, les métadonnées et les opérations de base.
Options
-h, --help help for device
Options héritées des commandes parentes
Voir Options communes.
création d'un dispositif métallique
Description
Crée un périphérique dans le projet spécifié. Un plan, un nom d'hôte, un système d'exploitation et une adresse métropolitaine ou une installation sont requis.
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]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
suppression d'appareil métallique
Description
Supprime le périphérique spécifié avec une invite de confirmation. Pour ignorer la confirmation, utilisez --force.
metal device delete -i <device_id> [-f] [flags]
Exemples
# 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
Options
-f, --force Skips confirmation for the device deletion.
-h, --help help for delete
-i, --id string The UUID of the device.
Options héritées des commandes parentes
Voir Options communes.
appareil métallique obtenir
Description
Récupère la liste des périphériques du projet ou les détails du périphérique spécifié. Un identifiant de projet ou d'appareil est requis.
metal device get [-p <project_id>] | [-i <device_id>] [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
redémarrage de l'appareil métallique
Description
Redémarre le périphérique spécifié.
metal device reboot -i <device_id> [flags]
Exemples
# Reboots the specified device:
metal device reboot --id 26a9da5f-a0db-41f6-8467-827e144e59a7
Options
-h, --help help for reboot
-i, --id string The device UUID.
Options héritées des commandes parentes
Voir Options communes.
réinstallation de l'appareil métallique
Description
Réinstalle l'appareil fourni avec le système d'exploitation actuel ou un nouveau système d'exploitation avec des options permettant de préserver les données ou d'éviter le nettoyage du disque. L'identifiant de l'appareil à réinstaller est requis.
metal device reinstall --id <device-id> [--operating-system <os_slug>] [--deprovision-fast] [--preserve-data] [flags]
Exemples
# 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
Options
--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.
Options héritées des commandes parentes
Voir Options communes.
démarrage de l'appareil métallique
Description
Démarre ou allume un appareil actuellement arrêté ou éteint.
metal device start -i <device_id> [flags]
Exemples
# Starts the specified device:
metal device start --id 26a9da5f-a0db-41f6-8467-827e144e59a7
Options
-h, --help help for start
-i, --id string The UUID of the device.
Options héritées des commandes parentes
Voir Options communes.
butée de dispositif métallique
Description
Arrête ou éteint un appareil actuellement démarré ou sous tension.
metal device stop -i <device_id> [flags]
Exemples
# Stops the specified device:
metal device stop --id [device_UUID]
Options
-h, --help help for stop
-i, --id string The UUID of the device.
Options héritées des commandes parentes
Voir Options communes.
mise à jour de l'appareil métallique
Description
Met à jour le nom d'hôte d'un appareil. Met à jour ou ajoute une description, des balises, des données utilisateur, des données personnalisées et des paramètres iPXE pour un appareil déjà configuré. Peut également verrouiller ou déverrouiller les modifications futures de l'appareil.
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]
Exemples
# Updates the hostname of a device:
metal device update --id 30c15082-a06e-4c43-bfc3-252616b46eba --hostname renamed-staging04
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
événement métal
Description
Informations sur les événements pour les organisations, les projets, les appareils et l'utilisateur actuel.
Options
-h, --help help for event
Options héritées des commandes parentes
Voir Options communes.
événement métal obtenir
Description
Récupère les événements de l'utilisateur actuel, d'une organisation, d'un projet, d'un appareil ou les détails d'un événement spécifique. Les événements de l'utilisateur actuel incluent tous les événements de tous les projets et appareils auxquels il a accès. L'utilisation des options --json ou --yaml implique l'utilisation de l'option --include=relationships.
metal event get [-p <project_id>] | [-d <device_id>] | [-i <event_id>] | [-O <organization_id>] [flags]
Exemples
# 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
Options
-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)
Options héritées des commandes parentes
Voir Options communes.
installations métalliques
Description
Informations sur des installations spécifiques. Les opérations au niveau des installations ont été majoritairement remplacées par des métros, mais elles sont conservées pour des raisons de rétrocompatibilité. La documentation relative aux installations est disponible sur /metal/locations/facilities/.
Options
-h, --help help for facilities
Options héritées des commandes parentes
Voir Options communes.
les installations métalliques obtiennent
Description
Récupère une liste des installations disponibles pour l'utilisateur actuel.
metal facilities get [flags]
Exemples
# Lists facilities for current user:
metal facilities get
Options
-h, --help help for get
Options héritées des commandes parentes
Voir Options communes.
passerelle métallique
Description
Une passerelle Metal fournit une adresse IPv4 unique comme passerelle pour un sous-réseau. Pour plus d'informations, consultez la page /metal/networking/metal-gateway/.
Options
-h, --help help for gateway
Options héritées des commandes parentes
Voir Options communes.
création d'une passerelle métallique
Description
Crée une passerelle Metal sur le VLAN. Un identifiant de réservation IP ou une taille de sous-réseau privé doit être spécifié.
metal gateway create -p <project_UUID> --virtual-network <virtual_network_UUID> (--ip-reservation-id <ip_reservation_UUID> | --private-subnet-size <size>) [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
passerelle métallique create-bgp-dynamic-neighbors
Description
Crée le voisin dynamique BGP pour la passerelle métallique avec la plage IP et l'ASN spécifiés
metal gateway create-bgp-dynamic-neighbors [flags]
Exemples
# 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
Options
--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.
Options héritées des commandes parentes
Voir Options communes.
suppression de la passerelle métallique
Description
Supprime la passerelle spécifiée avec une invite de confirmation. Pour ignorer la confirmation, utilisez --force.
metal gateway delete -i <metal_gateway_UUID> [-f] [flags]
Exemples
# 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
Options
-f, --force Skips confirmation for the removal of the Metal Gateway.
-h, --help help for delete
-i, --id string UUID of the Gateway.
Options héritées des commandes parentes
Voir Options communes.
passerelle métallique supprimer-bgp-voisins-dynamiques
Description
Supprime le voisin dynamique BGP pour la passerelle métallique avec l'ID spécifié
metal gateway delete-bgp-dynamic-neighbors [flags]
Exemples
# 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
Options
--bgp-neighbor-id string UUID of BGP Dynamic Neighbor.
-h, --help help for delete-bgp-dynamic-neighbors
Options héritées des commandes parentes
Voir Options communes.
passerelle métallique
Description
Récupère une liste de tous les VLAN pour le projet spécifié.
metal gateway get -p <project_UUID> [flags]
Exemples
# Lists Metal Gateways for project 3b0795ba-ec9a-4a9e-83a7-043e7e11407c:
metal gateways get -p 3b0795ba-ec9a-4a9e-83a7-043e7e11407c
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
passerelle métallique get-bgp-dynamic-neighbors
Description
Obtient le voisin dynamique BGP avec l'ID spécifié
metal gateway get-bgp-dynamic-neighbors [flags]
Exemples
# Gets a BGP Dynamic Neighbor using the bgp dynamic neighbor ID
$ metal gateways get-bgp-dynamic-neighbor --id "9c56fa1d-ec05-470b-a938-0e5dd6a1540c"
Options
--bgp-neighbor-id string UUID of BGP Dynamic Neighbor ID.
-h, --help help for get-bgp-dynamic-neighbors
Options héritées des commandes parentes
Voir Options communes.
liste de passerelles métalliques-bgp-voisins-dynamiques
Description
Répertorie le voisin dynamique BGP pour la passerelle métallique avec l'ID de passerelle spécifié
metal gateway list-bgp-dynamic-neighbors [flags]
Exemples
# Lists BGP Dynamic Neighbor for the specified metal gateway ID
$ metal gateways list-bgp-dynamic-neighbor --id "9c56fa1d-ec05-470b-a938-0e5dd6a1540c"
Options
-h, --help help for list-bgp-dynamic-neighbors
-i, --id string UUID of Metal Gateway.
Options héritées des commandes parentes
Voir Options communes.
quincaillerie métallique - réservation
Description
Renseignements et opérations sur les réservations de matériel. L'approvisionnement d'appareils spécifiques à partir d'une réservation peut être effectué avec la commande metal device. La documentation est disponible sur /metal/deploy/reserved/.
Options
-h, --help help for hardware-reservation
Options héritées des commandes parentes
Voir Options communes.
quincaillerie métallique - réservation obtenir
Description
Répertorie les réservations matérielles d'un projet ou les détails d'une réservation matérielle spécifiée. L'utilisation des options --json ou --yaml implique l'utilisation de l'option --include=project,facility,device.
metal hardware-reservation get [-p <project_id>] | [-i <hardware_reservation_id>] [flags]
Exemples
# 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
Options
-h, --help help for get
-i, --id string The UUID of a hardware reservation.
-p, --project-id string A project's UUID.
Options héritées des commandes parentes
Voir Options communes.
déménagement de quincaillerie métallique - réservation
Description
Déplace une réservation matérielle vers un projet spécifié. L'ID de réservation matérielle et l'ID de projet du projet de destination sont requis.
metal hardware-reservation move -i <hardware_reservation_id> -p <project_id> [flags]
Exemples
# Moves a hardware reservation to the specified Project:
metal hardware-reservation move -i 8404b73c-d18f-4190-8c49-20bb17501f88 -p 278bca90-f6b2-4659-b1a4-1bdffa0d80b7
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
interconnexions métalliques
Description
Obtenez des informations sur les emplacements du métro. Pour plus d'informations sur /metal/interconnections.
Options
-h, --help help for interconnections
Options héritées des commandes parentes
Voir Options communes.
les interconnexions métalliques créent
Description
Crée une nouvelle interconnexion selon l'ID d'organisation ou l'ID de projet
metal interconnections create -n <name> [-m <metro>] [-r <redundancy> ] [-t <type> ] [-p <project_id> ] | [-O <organization_id> ] [flags]
Exemples
# 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>
Options
-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 .
Options héritées des commandes parentes
Voir Options communes.
suppression des interconnexions métalliques
Description
Supprime l'interconnexion spécifiée. Utilisez --force pour ignorer la confirmation.
metal interconnections delete -i <connection_id> [flags]
Exemples
# 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
Options
-f, --force Skips confirmation for the interconnection deletion.
-h, --help help for delete
-i, --id string The UUID of the interconnection.
Options héritées des commandes parentes
Voir Options communes.
les interconnexions métalliques obtiennent
Description
Récupère les interconnexions pour l'utilisateur actuel, une organisation, un projet ou les détails d'une interconnexion spécifique.
metal interconnections get [flags]
Exemples
# 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
Options
-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)
Options héritées des commandes parentes
Voir Options communes.
mise à jour des interconnexions métalliques
Description
Met à jour une connexion spécifiée.
metal interconnections update -i <connection_id> [flags]
Exemples
# 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"
Options
-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".
Options héritées des commandes parentes
Voir Options communes.
IP métallique
Description
Opérations sur les adresses IP et les sous-réseaux, notamment la demande d'adresses IPv4 et IPv6, l'attribution et la suppression d'adresses IP aux serveurs, et l'obtention d'informations sur les sous-réseaux et leur utilisation. Pour plus d'informations, consultez la page /metal/networking/ip-addresses/.
Options
-h, --help help for ip
Options héritées des commandes parentes
Voir Options communes.
attribution d'adresse IP en métal
Description
Attribue une adresse IP et un sous-réseau à un périphérique spécifié. Renvoie un identifiant d'affectation.
metal ip assign -a <IP_address> -d <device_UUID> [flags]
Exemples
# Assigns an IP address to a server:
metal ip assign -d 060d1626-2481-475a-9789-c6f4bb927303 -a 198.51.100.3/31
Options
-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
Options héritées des commandes parentes
Voir Options communes.
IP métallique disponible
Description
Répertorie les adresses IP disponibles dans une réservation spécifiée pour la taille de sous-réseau souhaitée.
metal ip available -r <reservation_UUID> -c <size_of_subnet> [flags]
Exemples
# Lists available IP addresses in a reservation for a /31 subnet:
metal ip available --reservation-id da1bb048-ea6e-4911-8ab9-b95635ca127a --cidr 31
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
obtenir une adresse IP en métal
Description
Récupère des informations sur les adresses IP d'un projet, les adresses IP qui se trouvent dans une affectation spécifiée ou les adresses IP qui se trouvent dans une réservation spécifiée.
metal ip get -p <project-id> | -a <assignment-id> | -r <reservation-id> [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
retirer l'IP métallique
Description
Supprime une réservation d'adresse IP d'un projet. Les sous-réseaux et adresses IP de la réservation ne pourront plus être utilisés par vos appareils.
metal ip remove -i <reservation_UUID> [flags]
Exemples
# Removes an IP address reservation:
metal ip remove --id a9dfc9d5-ba1a-4d11-8cfc-6e30b9630876
Options
-h, --help help for remove
-i, --id string UUID of the reservation
Options héritées des commandes parentes
Voir Options communes.
demande d'IP métallique
Description
Demande soit un bloc d'adresses IPv4 publiques, soit des adresses IPv4 globales pour votre projet dans une zone métropolitaine ou une installation spécifique.
metal ip request -p <project-id> -t <ip_address_type> -q <quantity> (-m <metro> | -f <facility>) [-f <flags>] [-c <comments>] [flags]
Exemples
# 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"
Options
--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.
Options héritées des commandes parentes
Voir Options communes.
désattribution d'adresse IP métallique
Description
Annule l'attribution d'un sous-réseau et d'une adresse IP à un périphérique en fonction de son ID d'attribution.
metal ip unassign -i <assignment_UUID> [flags]
Exemples
# Unassigns an IP address assignment:
metal ip unassign --id abd8674b-96c4-4271-92f5-2eaf5944c86f
Options
-h, --help help for unassign
-i, --id string The UUID of the assignment.
Options héritées des commandes parentes
Voir Options communes.
métros métalliques
Description
Obtenez des informations sur les emplacements Metro. Pour plus d'informations, consultez /metal/locations/metros/.
Options
-h, --help help for metros
Options héritées des commandes parentes
Voir Options communes.
les métros métalliques obtiennent
Description
Récupère une liste des métros disponibles pour l'utilisateur actuel.
metal metros get [flags]
Exemples
# Lists metros available to the current user:
metal metros get
Options
-h, --help help for get
Options héritées des commandes parentes
Voir Options communes.
systèmes d'exploitation métalliques
Description
Informations sur les systèmes d'exploitation disponibles. Pour plus d'informations sur les systèmes d'exploitation proposés par Equinix Metal, consultez la page /metal/operating-systems/supported/.
Options
-h, --help help for operating-systems
Options héritées des commandes parentes
Voir Options communes.
les systèmes d'exploitation métalliques obtiennent
Description
Récupère la liste des systèmes d'exploitation disponibles pour l'utilisateur actuel. La réponse inclut le slug, la distribution, la version et le nom du système d'exploitation.
metal operating-systems get [flags]
Exemples
# Lists the operating systems available to the current user:
metal operating-systems get
Options
-h, --help help for get
Options héritées des commandes parentes
Voir Options communes.
organisation du métal
Description
Informations et gestion des paramètres au niveau de l'organisation. La documentation sur les organisations se trouve dans /metal/identity-access-management/organizations/.
Options
-h, --help help for organization
Options héritées des commandes parentes
Voir Options communes.
organisation métallique créer
Description
Crée une nouvelle organisation avec l'utilisateur actuel comme propriétaire de l'organisation.
metal organization create -n <name> [-d <description>] [-w <website_URL>] [-t <twitter_URL>] [-l <logo_URL>] [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
organisation métallique supprimer
Description
Supprime une organisation. Vous ne pouvez pas supprimer une organisation qui contient des projets ou des frais impayés. Seuls les propriétaires d'organisations peuvent supprimer une organisation.
metal organization delete -i <organization_UUID> [flags]
Exemples
# 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
Options
-f, --force Skips confirmation for the removal of the organization.
-h, --help help for delete
-i, --organization-id string The UUID of the organization.
Options héritées des commandes parentes
Voir Options communes.
organisation métallique obtenir
Description
Récupère une liste d'organisations ou les détails de l'organisation spécifiée. Les détails d'une organisation ne sont accessibles qu'à ses membres.
metal organization get -i <organization_UUID> [flags]
Exemples
# 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
Options
-h, --help help for get
-i, --organization-id string The UUID of an organization.
Options héritées des commandes parentes
Voir Options communes.
méthodes de paiement des organisations métalliques
Description
Récupère une liste de méthodes de paiement pour l'organisation spécifiée si l'utilisateur actuel est un membre avec le rôle approprié.
metal organization payment-methods -i <organization_UUID> [flags]
Exemples
# Lists the payment methods for an organization:
metal organization payment-methods --id 3bd5bf07-6094-48ad-bd03-d94e8712fdc8
Options
-h, --help help for payment-methods
-i, --id string The UUID of the organization.
Options héritées des commandes parentes
Voir Options communes.
mise à jour de l'organisation du métal
Description
Met à jour l'organisation spécifiée. Vous pouvez modifier le nom, le site web, le compte Twitter ou le logo.
metal organization update -i <organization_UUID> [-n <name>] [-d <description>] [-w <website_URL>] [-t <twitter_URL>] [-l <logo_URL>] [flags]
Exemples
# Updates the name of an organization:
metal organization update -i 3bd5bf07-6094-48ad-bd03-d94e8712fdc8 --name test-cluster02
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
plan métallique
Description
Informations sur les offres de serveurs. Pour plus d'informations sur les différents serveurs Equinix Metal, consultez la page /metal/hardware/standard-servers/.
Options
-h, --help help for plan
Options héritées des commandes parentes
Voir Options communes.
plan métallique obtenir
Description
Récupère la liste des plans disponibles pour l'utilisateur actuel. La réponse inclut l'UUID, le slug et le nom du plan.
metal plan get [flags]
Exemples
# Lists the plans available to the current user:
metal plans get
Options
-h, --help help for get
Options héritées des commandes parentes
Voir Options communes.
port métallique
Description
Informations et opérations pour la conversion des ports entre les modes réseau et la gestion des affectations de VLAN aux ports. Pour plus d'informations sur les différents modes, ports et VLAN, consultez la page /metal/layer2-networking/overview/.
Options
-h, --help help for port
Options héritées des commandes parentes
Voir Options communes.
convertisseur de port métallique
Description
Convertit une liste de ports ou les détails du port spécifié. Les détails d'un port ne sont accessibles qu'à ses membres.
metal port convert -i <port_UUID> [--bonded] [--bulk] --layer2 [--force] [--public-ipv4] [--public-ipv6] [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
port métallique obtenir
Description
Récupère les détails du port spécifié. Ces détails ne sont accessibles qu'à ses membres.
metal port get -i <port_UUID> [flags]
Exemples
# Retrieves details of a port:
metal port get -i 3bd5bf07-6094-48ad-bd03-d94e8712fdc8
Options
-h, --help help for get
-i, --port-id string The UUID of a port.
Options héritées des commandes parentes
Voir Options communes.
port VLAN métallique
Description
Modifie les VLAN du port spécifié selon l'état souhaité. L'état existant peut être rétabli sans erreur.
metal port vlan -i <port_UUID> [--native <vlan>] [--unassign <vlan>]... [--assign <vlan>]... [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
projet métallique
Description
Informations et gestion des projets et du protocole BGP au niveau projet. La documentation relative aux projets est disponible sur /metal/projects/creating-a-project/ et celle relative au protocole BGP sur /metal/bgp/bgp-on-equinix-metal/.
Options
-h, --help help for project
Options héritées des commandes parentes
Voir Options communes.
projet métal bgp-config
Description
Obtient la configuration BGP pour un projet.
metal project bgp-config --project-id <project_UUID> [flags]
Exemples
metal project bgp-config --project-id 50693ba9-e4e4-4d8a-9eb2-4840b11e9375 -d
Options
-h, --help help for bgp-config
-p, --project-id string Project ID (METAL_PROJECT_ID)
Options héritées des commandes parentes
Voir Options communes.
projet métal bgp-enable
Description
Active BGP sur un projet.
metal project bgp-enable --project-id <project_UUID> --deployment-type <deployment_type> [--asn <asn>] [--md5 <md5_secret>] [--use-case <use_case>] [flags]
Exemples
metal project bgp-enable --project-id 50693ba9-e4e4-4d8a-9eb2-4840b11e9375 --deployment-type local --asn 65000
Options
--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
Options héritées des commandes parentes
Voir Options communes.
sessions BGP du projet Metal
Description
Obtient les sessions BGP pour un projet.
metal project bgp-sessions --project-id <project_UUID> [flags]
Exemples
metal project bgp-sessions --project-id 50693ba9-e4e4-4d8a-9eb2-4840b11e9375
Options
-h, --help help for bgp-sessions
-p, --project-id string Project ID (METAL_PROJECT_ID)
Options héritées des commandes parentes
Voir Options communes.
création de projet métallique
Description
Crée un projet portant le nom spécifié. Si aucune organisation n'est spécifiée, le projet est créé dans l'organisation par défaut de l'utilisateur actuel. Si aucun mode de paiement n'est spécifié, le mode de paiement par défaut de l'organisation est utilisé.
metal project create -n <project_name> [-O <organization_UUID>] [-m <payment_method_UUID>] [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
projet métal supprimer
Description
Supprime le projet spécifié avec une invite de confirmation. Pour ignorer la confirmation, utilisez --force. Vous ne pouvez pas supprimer un projet dont les ressources sont actives. Vous devez déprovisionner tous les serveurs et autres infrastructures d'un projet pour le supprimer.
metal project delete --id <project_UUID> [--force] [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
projet de métal obtenir
Description
Récupère tous les projets de l'utilisateur actuel ou les détails d'un projet spécifique. Vous pouvez spécifier le projet par son UUID ou son nom. L'option --json ou --yaml est implicitement activée.
metal project get [-i <project_UUID> | -n <project_name>] [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
mise à jour du projet métal
Description
Met à jour le projet spécifié avec un nouveau nom, un nouveau mode de paiement ou les deux.
metal project update -i <project_UUID> [-n <name>] [-m <payment_method_UUID>] [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
clé ssh en métal
Description
Opérations de clé SSH pour la gestion des clés SSH sur les comptes utilisateurs et les projets. Les clés ajoutées à un compte ou à un projet sont ajoutées aux serveurs lors de la mise en service. La documentation est disponible sur /metal/identity-access-management/ssh-keys/.
Options
-h, --help help for ssh-key
Options héritées des commandes parentes
Voir Options communes.
création d'une clé SSH en métal
Description
Ajoute une clé SSH pour le compte de l'utilisateur actuel. La clé sera ensuite ajoutée aux serveurs de l'utilisateur au moment de la mise en service.
metal ssh-key create --key <public_key> --label <label> [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
suppression de la clé SSH en métal
Description
Supprime une clé SSH avec une invite de confirmation. Pour ignorer la confirmation, utilisez --force. Ne supprime pas la clé SSH des serveurs existants.
metal ssh-key delete --id <SSH-key_UUID> [--force] [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
clé ssh en métal
Description
Récupère une liste de clés SSH associées au compte de l'utilisateur actuel ou les détails d'une seule clé SSH.
metal ssh-key get [-i <SSH-key_UUID>] [-P] [-p <project_id>] [flags]
Exemples
# 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]
Options
-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
Options héritées des commandes parentes
Voir Options communes.
mise à jour de la clé SSH en métal
Description
Met à jour une clé SSH avec une nouvelle clé publique, une nouvelle étiquette ou les deux.
metal ssh-key update -i <SSH-key_UUID> [-k <public_key>] [-l <label>] [flags]
Exemples
# 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
Options
-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
Options héritées des commandes parentes
Voir Options communes.
utilisateur de métal
Description
Ajout d'utilisateurs ou obtention de leurs informations. Pour plus d'informations sur la gestion des utilisateurs et des comptes, consultez la section /metal/identity-access-management/users/ dans la documentation Equinix Metal .
Options
-h, --help help for user
Options héritées des commandes parentes
Voir Options communes.
ajout d'utilisateur de métal
Description
Ajoute un utilisateur, par e-mail, à l'organisation ou au projet spécifié par l'option --organization-id ou --project-id. Les rôles spécifiés par l'option --roles seront attribués à l'utilisateur.
metal user add --email <email> --roles <roles> [--organization-id <organization_id>] [--project-id <project_id>] [flags]
Exemples
# 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
Options
--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.
Options héritées des commandes parentes
Voir Options communes.
utilisateur de métal obtenir
Description
Renvoie des informations sur l'utilisateur actuel ou sur un utilisateur spécifié. Les informations sur l'utilisateur spécifié ne sont disponibles que si cet utilisateur partage un projet avec l'utilisateur actuel.
metal user get [-i <user_UUID>] [flags]
Exemples
# 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
Options
-h, --help help for get
-i, --id string UUID of the user.
Options héritées des commandes parentes
Voir Options communes.
circuit virtuel métallique
Description
Pour plus d'informations sur /metal/interconnections.
Options
-h, --help help for virtual-circuit
Options héritées des commandes parentes
Voir Options communes.
création de circuits virtuels métalliques
Description
Crée un circuit virtuel pour une interconnexion spécifique
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]
Exemples
# 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>]
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
suppression de circuit virtuel métallique
Description
Supprime le circuit virtuel spécifié.
metal virtual-circuit delete -i <virtual-circuit_id> [flags]
Exemples
# Deletes the specified virtual-circuit:
metal vc delete -i 7ec86e23-8dcf-48ed-bd9b-c25c20958277
Options
-h, --help help for delete
-i, --id string Specify the UUID of the virtual-circuit.
Options héritées des commandes parentes
Voir Options communes.
circuit virtuel métallique obtenu
Description
Récupère le circuit virtuel pour un identifiant de circuit spécifique.
metal virtual-circuit get -i <id> [flags]
Exemples
# Retrieve virtual circuit for a specific circuit::
# Retrieve the details of a specific virtual-circuit:
metal vc get -i e9a969b3-8911-4667-9d99-57cd3dd4ef6f
Options
-h, --help help for get
-i, --id string Specify UUID of the virtual-circuit
Options héritées des commandes parentes
Voir Options communes.
mise à jour du circuit virtuel métallique
Description
Met à jour un circuit virtuel spécifié soit vlanID soit vrfID
metal virtual-circuit update -i <id> [-v <vlan UUID>] [-d <description>] [-n <name>] [-s <speed>] [-t <tags>] [flags]
Exemples
# 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> ]
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
réseau virtuel métallique
Description
Gestion des réseaux virtuels d'un projet. L'attribution de VLAN aux ports d'un serveur est possible par la commande ports. Pour plus d'informations sur le fonctionnement des VLAN dans Equinix Metal, consultez /metal/layer2-networking/vlans/.
Options
-h, --help help for virtual-network
Options héritées des commandes parentes
Voir Options communes.
création de réseau virtuel métallique
Description
Crée un VLAN dans le projet spécifié. Si vous créez un VLAN dans une zone métropolitaine, vous pouvez éventuellement spécifier l'ID VXLAN, sinon il est attribué automatiquement. Si vous créez un VLAN dans une installation, l'ID VXLAN est attribué automatiquement.
metal virtual-network create -p <project_UUID> [-m <metro_code> -vxlan <vlan> | -f <facility_code>] [-d <description>] [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
suppression du réseau virtuel métallique
Description
Supprime le VLAN spécifié avec une invite de confirmation. Pour ignorer la confirmation, utilisez l'option --force. Vous ne pouvez pas supprimer un VLAN connecté à un port.
metal virtual-network delete -i <virtual_network_UUID> [-f] [flags]
Exemples
# 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
Options
-f, --force Skips confirmation for the removal of the virtual network.
-h, --help help for delete
-i, --id string UUID of the VLAN.
Options héritées des commandes parentes
Voir Options communes.
réseau virtuel métallique
Description
Récupère une liste de tous les VLAN pour le projet spécifié.
metal virtual-network get -p <project_UUID> [flags]
Exemples
# Lists virtual networks for project 3b0795ba-ec9a-4a9e-83a7-043e7e11407c:
metal virtual-network get -p 3b0795ba-ec9a-4a9e-83a7-043e7e11407c
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
VRF en métal
Description
Opérations VRF: Il définit une collection de blocs IP gérés par le client qui peuvent être utilisés dans le peering BGP sur un ou plusieurs réseaux virtuels et les opérations de base
Options
-h, --help help for vrf
Options héritées des commandes parentes
Voir Options communes.
création de VRF en métal
Description
Crée un routage et une transmission virtuels (VRF) pour un projet spécifié.
metal vrf create [-p <project_id] [-d <description>] [-m <metro>] [-n <name>] [-a <localASN>] [-r <IPranges>] [-t <tags> ] [flags]
Exemples
# 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> ]
Options
-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"
Options héritées des commandes parentes
Voir Options communes.
création d'itinéraire vrf métallique
Description
Créez une route dans un VRF. Actuellement, seules les routes statiques par défaut sont prises en charge.
metal vrf create-route [-i <VrfId>] [-p <Prefix>] [-n NextHop] [-t <tags> ] [flags]
Exemples
# 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> ]
Options
-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".
Options héritées des commandes parentes
Voir Options communes.
suppression du vrf métallique
Description
Supprime le VRF spécifié avec une invite de confirmation. Pour ignorer la confirmation, utilisez --force.
metal vrf delete vrf -i <metal_vrf_UUID> [-f] [flags]
Exemples
# 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
Options
-f, --force Skips confirmation for the removal of the VRF.
-h, --help help for delete
-i, --id string Specify the UUID of the VRF
Options héritées des commandes parentes
Voir Options communes.
suppression de route vrf métallique
Description
Supprimer une route VRF
metal vrf delete-route [-i <VrfRoute-Id>] [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
métal vrf obtenir
Description
Récupère la liste de tous les VRF du projet spécifié ou les détails de l'ID VRF spécifié. Un ID de projet ou un ID VRF est requis.
metal vrf get -p <project_Id> [flags]
Exemples
# 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
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
route d'accès au vrf métallique
Description
Récupérer tous les itinéraires dans le VRF
metal vrf get-route [-i <VrfRoute-Id>] [flags]
Exemples
# Retrieve all routes in the VRF
metal vrf get-route -i bb526d47-8536-483c-b436-116a5fb72235
Options
-h, --help help for get-route
-i, --id string Specify the VRF UUID to list its associated routes configurations
Options héritées des commandes parentes
Voir Options communes.
IPS VRF en métal
Description
Récupère la liste des réservations IP VRF pour le VRF.
metal vrf ips [-v <vrf-id] [-i <ip-id>] [flags]
Exemples
# 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>]
Options
-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.
Options héritées des commandes parentes
Voir Options communes.
mise à jour de l'itinéraire du VRF en métal
Description
Demande qu'une route VRF soit redéployée/mise à jour sur le réseau.
metal vrf update-route [-i <VrfRoute-Id>] [-p <Prefix>] [-n NextHop] [-t <tags> ] [flags]
Exemples
# Requests a VRF Route be redeployed/update across the network.
metal vrf update-route [-i <VrfID>] [-p <prefix>] [-n nextHop] [-t <tags> ]
Options
-h, --help help for update-route
-i, --id string Specify the VRF UUID to update the associated route configurations.
-n, --nextHop string Name of the Virtual Routing and Forwarding
-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 updates the tags for the Virtual Routing and Forwarding --tags "tag1,tag2" OR --tags "tag1" --tags "tag2" (NOTE: --tags "" will remove all tags from the Virtual Routing and Forwarding
Options héritées des commandes parentes
Voir Options communes.