Documentation Oracle Cloud Infrastructure

Démarrage rapide

Cette section explique comment installer et configurer rapidement l'interface de ligne de commande OCI.

Installation de l'interface de ligne de commande

Contenu de cette section

Cette section contient des instructions d'installation rapide pour les environnements suivants :

Oracle Linux 9

Si vous utilisez Oracle Linux 9, vous pouvez utiliser dnf pour installer l'interface de ligne de commande.

Remarque

Nous vous recommandons vivement d'exécuter sudo dnf update régulièrement afin de vous assurer que le système est à jour via l'installation des packages RPM mis à jour disponibles.

Pour utiliser DNF afin d'installer l'interface de ligne de commande, exécutez la commande suivante :

sudo dnf -y install oraclelinux-developer-release-el9
sudo dnf install python39-oci-cli

L'interface de ligne de commande est installée sur les packages du site Python :

  • /usr/lib/python3.9/site-packages/oci_cli
  • /usr/lib/python3.9/site-packages/services

La documentation et des exemples seront installés dans le répertoire /usr/share/doc/python39-oci-cli-<version>/.

Pour désinstaller l'interface de ligne de commande, exécutez la commande suivante :

sudo dnf remove python39-oci-cli

Oracle Linux 8

Si vous utilisez Oracle Linux 8, vous pouvez vous servir de DNF pour installer l'interface de ligne de commande.

Remarque

Nous vous recommandons vivement d'exécuter sudo dnf update régulièrement afin de vous assurer que le système est à jour via l'installation des packages RPM mis à jour disponibles.

Pour utiliser DNF afin d'installer l'interface de ligne de commande, exécutez la commande suivante :

sudo dnf -y install oraclelinux-developer-release-el8
sudo dnf install python36-oci-cli

L'interface de ligne de commande est installée sur les packages du site Python :

  • /usr/lib/python3.6/site-packages/oci_cli
  • /usr/lib/python3.6/site-packages/services

La documentation et les exemples sont installés dans le répertoire /usr/share/doc/python36-oci-cli-<version>/.

Pour désinstaller l'interface de ligne de commande, exécutez la commande suivante :

sudo dnf remove python36-oci-cli

Oracle Linux 7

Si vous utilisez Oracle Linux 7, vous pouvez vous servir de YUM pour installer l'interface de ligne de commande.

Pour utiliser YUM afin d'installer l'interface de ligne de commande, exécutez la commande suivante :

sudo yum install python36-oci-cli

L'interface de ligne de commande est installée sur les packages du site Python :

  • /usr/lib/python3.6/site-packages/oci_cli
  • /usr/lib/python3.6/site-packages/services

La documentation et les exemples sont installés dans le répertoire /usr/share/doc/python36-oci-cli-<version>/.

Pour désinstaller l'interface de ligne de commande, exécutez la commande suivante :

sudo yum remove python36-oci-cli

Mac OS

Vous pouvez utiliser Homebrew pour installer, mettre à niveau et désinstaller l'interface de ligne de commande sur Mac OS.

Pour installer l'interface de ligne de commande sur Mac OS à l'aide de Homebrew, exécutez la commande suivante :

brew update && brew install oci-cli

Pour mettre à niveau l'installation de l'interface de ligne de commande sur Mac OS à l'aide de Homebrew, exécutez la commande suivante : 

brew update && brew upgrade oci-cli

Pour désinstaller l'interface de ligne de commande sur Mac OS à l'aide de Homebrew, exécutez la commande suivante : 

brew uninstall oci-cli

Windows

Vous pouvez installer l'interface de ligne de commande sous Windows à l'aide du programme d'installation MSI ou à l'aide de PowerShell.

Pour installer la CLI sous Windows à l'aide du programme d'installation MSI :
Remarque

Le programme d'installation de la CLI MSI écrasera toutes les versions existantes de la CLI sur votre système Windows. Si vous devez installer plusieurs versions de la CLI, pour les installations suivantes, créez un environnement virtuel et utilisez la méthode d'installation manuelle. Pour plus d'informations, reportez-vous à la section Manual and Offline Installations.
  1. Téléchargez le programme d'installation MSI de l'interface de ligne de commande OCI pour Windows à partir de GitHub.
  2. Exécutez l'exécutable du programme d'installation téléchargé.
  3. Sélectionnez le répertoire local sur votre système où vous souhaitez installer la CLI, puis cliquez sur Next.
  4. Une fois le programme d'installation terminé, cliquez sur Fin.

Pour installer l'interface de ligne de commande sous Windows à l'aide de PowerShell :

  1. Ouvrez la console PowerShell avec l'option Exécuter en tant qu'administrateur.

  2. Le programme d'installation active l'écriture automatique en installant et en exécutant un script. Pour que ce script puisse être exécuté, vous devez activer la stratégie d'exécution RemoteSigned.

    Afin de configurer la stratégie d'exécution distante pour PowerShell, exécutez la commande suivante.

    Set-ExecutionPolicy RemoteSigned
  3. Forcez PowerShell à utiliser TLS 1.2 pour Windows 2012 et Windows 2016 :
    [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
  4. Téléchargez le script du programme d'installation :
    Invoke-WebRequest https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.ps1 -OutFile install.ps1
  5. Exécutez le script du programme d'installation avec ou sans invite :
    1. Pour exécuter le script du programme d'installation avec des invites, exécutez la commande suivante :
      iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.ps1'))

      ...et répondez aux invites du script d'installation.

    2. Pour exécuter le script du programme d'installation sans invite (en acceptant les paramètres par défaut), exécutez la commande suivante :
      ./install.ps1 -AcceptAllDefaults

Linux et Unix

Remarque

Le script du programme d'installation installe automatiquement l'interface de ligne de commande et ses dépendances, Python et virtualenv. Avant d'exécuter le programme d'installation, assurez-vous que les exigences sont respectées.
Remarque

L'interface de ligne de commande est préinstallée sur Oracle Linux 8 et Oracle Linux Cloud Developer 7.
  1. Ouvrez un terminal.
  2. Pour exécuter le script du programme d'installation, exécutez la commande suivante:
    bash -c "$(curl -L https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.sh)"
    Remarque

    Pour exécuter une installation sans invite qui accepte toutes les valeurs par défaut, utilisez le paramètre --accept-all-defaults.
  3. Répondez aux invites du script d'installation.

Autres environnements

Pour installer l'interface de ligne de commande dans un environnement non répertorié ici, reportez-vous à Installations manuelles et hors ligne.

Vérification de l'installation de l'interface de ligne de commande OCI

  1. Dans une invite de commande, exécutez la commande suivante :
    oci --version

Invites du script d'installation

Le script d'installation vous invite à entrer les informations suivantes.

  • Si la version de Python installée n'est pas compatible :
    • Windows et Linux : vous êtes invité à indiquer un emplacement pour l'installation des fichiers binaires et des exécutables. Le script installe Python pour vous.
    • MacOS : vous êtes averti que votre version de Python est incompatible. Vous devez effectuer une mise à niveau avant de poursuivre l'installation. Le script n'installe pas Python pour vous.
  • Lorsque vous êtes invité à mettre à niveau l'interface de ligne de commande vers la version la plus récente, répondez Y pour écraser une installation existante.
  • Lorsque vous êtes invité à mettre à jour le PATH, répondez Y pour pouvoir appeler l'interface de ligne de commande sans indiquer le chemin d'accès complet de l'exécutable. Cette action ajoute oci.exe à votre PATH.

Configuration du fichier de configuration

Avant d'utiliser l'interface de ligne de commande, vous devez créer un fichier de configuration qui contient les informations d'identification requises pour utiliser Oracle Cloud Infrastructure. Vous pouvez créer ce fichier à l'aide d'une boîte de dialogue de configuration ou manuellement à l'aide d'un éditeur de texte.

Utilisation de la boîte de dialogue de configuration

Pour que l'interface de ligne de commande vous guide lors du processus de première configuration, utilisez la commande setup config :
oci setup config
Cette commande vous invite à entrer les informations requises pour créer le fichier de configuration ainsi que les clés publiques et privées d'API. La boîte de dialogue de configuration utilise ces informations pour générer une paire de clés d'API et créer le fichier de configuration. Une fois les clés d'API créées, téléchargez la clé publique à l'aide de la console.

Pour plus d'informations sur la recherche des informations requises, reportez-vous aux rubriques suivantes :

Configuration manuelle

Si vous voulez configurer vous-même les clés publiques et privées de l'API et écrire votre propre fichier de configuration, reportez-vous à Configuration d'outil et de kit SDK.

Conseil

Utilisez la commande oci setup keys pour générer une paire de clés à inclure dans le fichier de configuration.

Vérification du fichier de configuration

Vérification de la complétion du fichier de configuration

Un fichier de configuration correct doit comporter au moins un nom de profil (tel que [DEFAULT]) et les entrées spécifiées dans la section Entrées de fichier : user, fingerprint, key_file, tenancy, region et pass_phrase (facultatif).

Remarque

Reportez-vous à la section Exemple de configuration pour obtenir un exemple de fichier de configuration.

Vérification des informations utilisateur et d'empreinte

Pour vérifier vos informations utilisateur et d'empreinte, connectez-vous à la console OCI, ouvrez le menu Profil en haut à droite, puis sélectionnez votre nom utilisateur.

Une fois le nom utilisateur sélectionné, votre OCID apparaît dans le panneau Informations sur l'utilisateur. Cet OCID doit correspondre à l'entrée utilisateur dans votre fichier de configuration.

Vous pouvez trouver votre empreinte en accédant à la section Clés d'API sous la colonne Ressources en bas à gauche.

Ajout de commentaires au fichier de configuration

Veillez à ne pas ajouter de commentaires en ligne à votre fichier de configuration. Ajoutez tous les commentaires sur une nouvelle ligne. Par exemple :
[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>
# Some comment
region=us-ashburn-1

Autres méthodes d'authentification

L'interface de ligne de commande prend également en charge l'authentification par jeton, par principal d'instance et par principal de ressource pour certains services. Pour plus d'informations, reportez-vous à la section SDK Authentication Methods.