Premiers pas avec la CLI OVHcloud

Base de connaissances

KB0072703

Premiers pas avec la CLI OVHcloud


Icons/System/eye-open Created with Sketch. 923 vues 13.10.2025 CLI

Objectif

L’interface en ligne de commande OVHcloud (CLI) est un outil conçu pour interagir avec les services OVHcloud directement depuis votre terminal. Elle permet d’automatiser des tâches, de gérer vos ressources et d’accéder efficacement aux API OVHcloud.

Installation

Pour installer la CLI OVHcloud, utilisez la commande suivante :

curl -fsSL https://raw.githubusercontent.com/ovh/ovhcloud-cli/main/install.sh | sh

La CLI OVHcloud est également disponible via Homebrew :

brew install --cask ovh/tap/ovhcloud-cli

Vous pouvez également télécharger la dernière version depuis le dépôt GitHub :

  1. Rendez-vous sur la page des releases.
  2. Téléchargez le binaire correspondant à votre système d’exploitation (Linux, macOS ou Windows).
  3. Décompressez l’archive et déplacez le binaire dans un dossier inclus dans votre $PATH.
  4. Vérifiez l’installation :
ovhcloud version

Authentification de la CLI

La CLI OVHcloud nécessite une authentification pour effectuer des appels à l’API. Plusieurs méthodes permettent de définir vos identifiants.

Consultez la page d’authentification pour plus d’informations sur la configuration et les moyens d’authentification.

  • Connexion interactive :
# Permet de se connecter et créer des identifiants API (mode interactif)
ovhcloud login
  • Utilisation d’un fichier de configuration :

Les paramètres par défaut peuvent être définis dans un fichier de configuration nommé .ovh.conf situé dans votre répertoire ${HOME}. Vous pouvez consulter ce guide pour apprendre à créer des identifiants API.

Exemple de fichier de configuration :

[default]
endpoint = ovh-eu

[ovh-eu]
application_key    = <application key>
application_secret = <application secret>
consumer_key       = <consumer key>

[ovh-cli]
default_cloud_project = <ID du projet Public Cloud>
  • Utilisation de variables d’environnement :
OVH_ENDPOINT=ovh-eu
OVH_APPLICATION_KEY=xxx
OVH_APPLICATION_SECRET=xxx
OVH_CONSUMER_KEY=xxx
OVH_CLOUD_PROJECT_SERVICE=<ID du projet Public Cloud>

Exemples de commandes

Voici quelques commandes de base pour commencer :

  • Lister vos projets cloud :
ovhcloud cloud project list
  • Afficher les détails d’un projet spécifique :
ovhcloud cloud project get <PROJECT_ID>
  • Lister les instances d’un projet :
ovhcloud cloud instance list --cloud-project <PROJECT_ID>
  • Créer une nouvelle instance :
ovhcloud cloud instance create BHS5 --cloud-project <PROJECT_ID> --name my-instance --flavor-selector --image-selector --network.public --ssh-key.name <SSH_KEY_NAME>

Remarque : L’option --project-id n’est pas nécessaire si vous avez défini l’entrée default_cloud_project dans votre fichier de configuration, ou si la variable d’environnement OVH_CLOUD_PROJECT_SERVICE est renseignée.

Pour plus d’informations sur les commandes disponibles, consultez la documentation complète.

Couverture des produits

La plupart des produits proposent des commandes de base pour lister les services, récupérer et modifier leurs détails. Certains produits disposent déjà d’une couverture plus avancée, comme par exemple : Baremetal, Public Cloud (Instances, Managed Kubernetes, Rancher, Storage, Network), VPS et IAM.

Remarque : Les actions actuellement disponibles dans la CLI correspondent à celles proposées par l’API principale OVHcloud. Les actions spécifiques à chaque produit, accessibles via leurs propres API, ne sont pas encore couvertes, mais seront progressivement ajoutées selon le produit.

Ressources

Articles associés