Installer et configurer OSC CLI

OSC CLI et oapi-cli, les CLI historiques de 3DS OUTSCALE, sont maintenant en mode maintenance. Cela signifie que, bien que les éventuels bugs les effectant seront toujours corrigés, l’innovation fonctionnelle se concentrera désormais sur l’outil successeur octl. octl a vocation à être la CLI de référence commune à tous les produits OUTSCALE. Pour en savoir plus, voir Installer et configurer octl.

Vous pouvez gérer vos ressources du Cloud OUTSCALE avec OSC CLI, une interface en ligne de commande (CLI) développée par 3DS OUTSCALE.

OSC CLI est compatible avec l’API OUTSCALE et toutes nos API AWS-compliant.

Installer OSC CLI

Installer OSC CLI sur Linux

Avant de commencer : Assurez-vous que Python 3.6 ou ultérieur et pip sont installés sur votre machine.

  1. (optionnel) Il est recommandé d’installer OSC CLI et ses dépendances dans un environnement virtuel Python (virtualenv), plutôt que directement sur votre système. Pour créer un virtualenv, lancez les commandes suivantes :

    $ python3 -m venv .venv
$ source .venv/bin/activate

  2. Pour installer OSC CLI depuis le paquet PyPI, lancez la commande suivante :

    $ pip install osc-sdk

    Pour quitter le virtualenv, tapez deactivate dans votre terminal.

Installer OSC CLI sur macOS

Avant de commencer : Installez Homebrew sur votre machine.

  1. Pour installer OSC CLI depuis le paquet Homebrew, lancez la commande suivante dans votre terminal :

    $ brew install osc-cli

  2. Mettez à jour la variable d’environnement PATH de votre terminal avec la commande suivante (remplacez PRENOM.NOM par la valeur adéquate, et 3.9 par votre numéro de version de Python) :

    $ export PATH=$PATH:/Users/PRENOM.NOM/Library/Python/3.9/bin/

Installer OSC CLI sur Windows

  1. Installez Python 3 sur votre machine :

    1. Téléchargez et lancez le installateur Python le plus récent.

    2. Cochez la case Add Python 3.x to PATH.

    3. Cliquez sur Install Now.

    4. Cliquez sur Disable path length limit.

  2. Dans une invite de commande, tapez la commande suivante :

    $ pip install --upgrade pip
$ pip install osc-sdk

    OSC CLI est maintenant installé.

Configurer OSC CLI

  1. Dans votre répertoire home, créez un répertoire .osc.

  2. Dans .osc, créez un fichier nommé config.json avec le contenu suivant :

    {
    "default": {
        "access_key": "ACCESSKEY",
        "secret_key": "SECRETKEY",
        "host": "outscale.com",
        "https": true,
        "method": "POST",
        "region": "eu-west-2"
    }
}

    où :

    • eu-west-2 est la Région de votre compte OUTSCALE.

    • ACCESSKEY et SECRETKEY sont l’ID d’access key et la secret key correspondante de votre compte OUTSCALE. Pour en savoir plus, voir Créer une access key.

      Vous pouvez maintenant exécuter des requêtes d’API avec OSC CLI.

      Pour des options de configuration plus avancées, voir le dépôt GitHub d’OSC CLI.

Utiliser OSC CLI

Pour envoyer une requête avec OSC CLI, spécifiez dans votre commande :

  • Une des API supportées (api pour l’API OUTSCALE, ou fcu, lbu, eim ou directlink).

  • La requête que vous demandez.

  • Toute autre option attendu par la commande.

Exemple de requête
$ osc-cli api CreateVolume \
   --SubregionName eu-west-2a \
   --Size 10

Si vous voulez spécifier un nombre en tant que chaîne de texte et non en tant qu’entier, vous devez l’entourer de deux paires de guillemets ('"12345678"').

Pages connexes

AWS™ et Amazon Web Services™ sont des marques de commerce d'Amazon Technologies, Inc. ou de ses affiliées aux États-Unis et/ou dans les autres pays.

Exporter en PDF