Documentation sur Oracle Cloud Infrastructure

Démarrage rapide

Cette section décrit 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.

Note

Nous vous recommandons vivement d'exécuter sudo dnf update régulièrement pour installer les derniers RPM disponibles afin que votre système soit toujours à jour.

Pour utiliser dnf pour installer l'interface de ligne de commande :

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

L'interface de ligne de commande sera installée dans les ensembles de site Python :

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

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

Pour désinstaller l'interface de ligne de commande :

sudo dnf remove python39-oci-cli

Oracle Linux 8

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

Note

Nous vous recommandons vivement d'exécuter sudo dnf update régulièrement pour installer les derniers RPM disponibles afin que votre système soit toujours à jour.

Pour utiliser dnf pour installer l'interface de ligne de commande :

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

L'interface de ligne de commande sera installée dans les ensembles de site Python :

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

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

Pour désinstaller l'interface de ligne de commande :

sudo dnf remove python36-oci-cli

Oracle Linux 7

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

Pour utiliser yum pour installer l'interface de ligne de commande :

sudo yum install python36-oci-cli

L'interface de ligne de commande sera installée dans les ensembles de site Python :

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

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

Pour désinstaller l'interface de ligne de commande :

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 sous Mac OS.

Pour installer l'interface de ligne de commande sous Mac OS avec Homebrew :

brew update && brew install oci-cli

Pour mettre à niveau votre installation de l'interface de ligne de commande sous Mac OS avec Homebrew : 

brew update && brew upgrade oci-cli

Pour désinstaller l'interface de ligne de commande sous Mac OS avec Homebrew : 

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 l'interface de ligne de commande sous Windows à l'aide du programme d'installation de MSI :
Note

Le programme d'installation de l'interface de ligne de commande MSI remplacera toutes les versions existantes de l'interface de ligne de commande sur votre système Windows. Si vous devez installer plusieurs versions de l'interface de ligne de commande, pour les installations suivantes, créez un environnement virtuel et utilisez la méthode d'installation manuelle. Pour plus d'informations, voir Installations manuelles et hors ligne.
  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 voulez installer l'interface de ligne de commande, puis cliquez sur Suivant.
  4. Lorsque le programme d'installation est terminé, cliquez sur Terminer.

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

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

  2. Le programme d'installation active le remplissage automatique en installant et en exécutant un script. Pour permettre l'exécution de ce script, vous devez activer la politique d'exécution RemoteSigned.

    Pour configurer la politique 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 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 d'installation avec ou sans invites :
    1. Pour lancer le script 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 d'installation sans invites, en acceptant les paramètres par défaut, exécutez la commande suivante :
      ./install.ps1 -AcceptAllDefaults

Linux et Unix

Note

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 conditions requises sont réunies.
Note

L'interface de ligne de commande est préinstallée dans Oracle Linux 8 et Oracle Linux Cloud Developer 7.
  1. Ouvrez un terminal.
  2. Pour lancer 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)"
    Note

    Pour exécuter une installation silencieuse qui accepte toutes les valeurs par défaut sans invite, 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 listé ici, voir Installations manuelles et hors ligne.

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

  1. À partir d'une invite de commande, exécutez la commande suivante :
    oci --version

Invites du script d'installation

Le script d'installation vous demande les informations suivantes.

  • Si vous n'avez pas de version compatible de Python installée :
    • Windows et Linux : Vous êtes invité à fournir un emplacement pour l'installation des binaires et des exécutables. Le script installera Python pour vous.
    • MacOS : Vous êtes avisé que votre version de Python n'est pas compatible. Vous devez procéder à la mise à niveau pour pouvoir poursuivre l'installation. Le script n'installera 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 par Y (Oui) pour remplacer une installation existante.
  • Lorsque vous êtes invité à mettre à jour votre chemin (PATH), répondez par Y (Oui) pour pouvoir appeler l'interface de ligne de commande sans indiquer le chemin 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 contenant les données 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.

Utiliser la boîte de dialogue de configuration

Pour que l'interface de ligne de commande vous guide tout au long du processus de configuration, utilisez la commande setup config.
oci setup config
Cette commande vous demande d'entrer les informations requises pour créer le fichier de configuration et 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, chargez la clé publique à l'aide de la console.

Pour plus d'informations sur la façon de trouver les informations requises, voir :

Configuration manuelle

Si vous voulez configurer vous-même les clés publiques/privées d'API et écrire votre propre fichier de configuration, voir Configuration des trousses SDK et des outils.

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

Assurez-vous que votre fichier de configuration est complet

Un fichier de configuration approprié doit comporter au moins un nom de profil (par exemple [DEFAULT]) et les entrées suivantes dans la section Entrées de fichier : user, fingerprint, key_file, tenancy, region et, éventuellement, pass_phrase.

Note

Voir la section Exemple de configuration pour un exemple de fichier de configuration.

Confirmez vos informations d'utilisateur et d'empreinte numérique

Vous pouvez confirmer vos informations d'utilisateur et d'empreinte numérique en vous connectant à la console OCI, en ouvrant le menu de profil en haut à droite, puis en sélectionnant votre nom d'utilisateur.

Une fois que vous avez sélectionné votre nom d'utilisateur, votre OCID s'affiche dans le panneau Informations sur l'utilisateur. Cet OCID doit correspondre à l'entrée "user" dans votre fichier de configuration.

Vous pouvez trouver votre empreinte numérique en naviguant jusqu'à la section Clés d'API sous la colonne Ressources en bas à gauche.

Ajout de commentaires au fichier de configuration

Veillez à ne pas insérer de commentaires dans 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 basée sur un jeton pour le principal d'instance et le principal de ressource pour certains services. Pour plus d'informations, voir Méthodes d'authentification des trousses SDK.