Oracle Cloud Infrastructure - Dokumentation

Schnellstart

In diesem Abschnitt wird dokumentiert, wie Sie die OCI-Befehlszeilenschnittstelle (CLI) schnell installieren und konfigurieren.

CLI installieren

Themen in diesem Abschnitt

Dieser Abschnitt enthält Schnellinstallationsanweisungen für die folgenden Umgebungen:

Oracle Linux 9

Wenn Sie Oracle Linux 9 verwenden, können Sie die CLI mit dnf installieren.

Hinweis

Es wird dringend empfohlen, sudo dnf update regelmäßig auszuführen, um sicherzustellen, dass Ihr System aktuell ist, indem Sie verfügbare aktualisierte RPMs installieren.

So installieren Sie die CLI mit dnf:

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

Die CLI wird im "site-packages"-Verzeichnis von Python installiert:

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

Dokumentation und Beispiele werden im Verzeichnis /usr/share/doc/python39-oci-cli-<version>/ installiert.

So deinstallieren Sie die CLI:

sudo dnf remove python39-oci-cli

Oracle Linux 8

Wenn Sie Oracle Linux 8 verwenden, können Sie die CLI mit dnf installieren.

Hinweis

Es wird dringend empfohlen, sudo dnf update regelmäßig auszuführen, um sicherzustellen, dass Ihr System aktuell ist, indem Sie verfügbare aktualisierte RPMs installieren.

So installieren Sie die CLI mit dnf:

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

Die CLI wird im "site-packages"-Verzeichnis von Python installiert:

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

Dokumentation und Beispiele werden im Verzeichnis /usr/share/doc/python36-oci-cli-<version>/ installiert.

So deinstallieren Sie die CLI:

sudo dnf remove python36-oci-cli

Oracle Linux 7

Wenn Sie Oracle Linux 7 verwenden, können Sie die CLI mit yum installieren.

So installieren Sie die CLI mit yum:

sudo yum install python36-oci-cli

Die CLI wird im "site-packages"-Verzeichnis von Python installiert:

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

Dokumentation und Beispiele werden im Verzeichnis /usr/share/doc/python36-oci-cli-<version>/ installiert.

So deinstallieren Sie die CLI:

sudo yum remove python36-oci-cli

Mac OS

Mit Homebrew können Sie die CLI auf Mac OS installieren, upgraden und deinstallieren.

So installieren Sie die CLI unter Mac OS mit Homebrew:

brew update && brew install oci-cli

So führen Sie ein Upgrade der CLI-Installation unter Mac OS mit Homebrew durch: 

brew update && brew upgrade oci-cli

So deinstallieren Sie die CLI unter Mac OS mit Homebrew: 

brew uninstall oci-cli

Windows

Sie können die CLI unter Windows mit dem MSI-Installationsprogramm oder mit PowerShell installieren.

So installieren Sie die CLI unter Windows mit dem MSI-Installationsprogramm:
Hinweis

Das MSI-CLI-Installationsprogramm überschreibt alle vorhandenen Versionen der CLI auf Ihrem Windows-System. Wenn Sie mehrere Versionen der CLI installieren müssen, erstellen Sie bei nachfolgenden Installationen eine virtuelle Umgebung und verwenden die manuelle Installationsmethode. Weitere Informationen finden Sie unter Manuelle und Offline-Installationen.
  1. Laden Sie das OCI-CLI-MSI-Installationsprogramm für Windows von GitHub herunter.
  2. Führen Sie die heruntergeladene ausführbare Installationsdatei aus.
  3. Wählen Sie das lokale Verzeichnis auf dem System aus, in dem Sie die CLI installieren möchten, und klicken Sie auf Weiter.
  4. Klicken Sie nach Abschluss des Installationsprogramms auf Fertigstellen.

So installieren Sie die CLI unter Windows mit PowerShell:

  1. Öffnen Sie die PowerShell-Konsole mit der Option Als Administrator ausführen.

  2. Das Installationsprogramm ermöglicht die Autovervollständigung durch Installation und Ausführung eines Skripts. Damit dieses Skript ausgeführt werden kann, müssen Sie die RemoteSigned-Ausführungs-Policy aktivieren.

    Um die Remote-Ausführungs-Policy für PowerShell zu konfigurieren, führen Sie den folgenden Befehl aus.

    Set-ExecutionPolicy RemoteSigned
  3. Erzwingen Sie, dass PowerShell TLS 1.2 für Windows 2012 und Windows 2016 verwendet:
    [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
  4. Laden Sie das Installationsprogrammskript herunter:
    Invoke-WebRequest https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.ps1 -OutFile install.ps1
  5. Führen Sie das Installationsprogrammskript mit oder ohne Prompts aus:
    1. Um das Installationsprogrammskript mit Prompts auszuführen, führen Sie den folgenden Befehl aus:
      iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.ps1'))

      Antworten Sie anschließend auf die Installationsprogrammskript-Prompts.

    2. Um das Installationsprogrammskript ohne Benutzer-Prompts und unter Verwendung der Standardeinstellungen auszuführen, führen Sie den folgenden Befehl aus:
      ./install.ps1 -AcceptAllDefaults

Linux und Unix

Hinweis

Das Installationsprogrammskript installiert automatisch die CLI und deren Abhängigkeiten, Python und virtualenv. Stellen Sie vor der Ausführung des Installationsprogramms sicher, dass Sie die Anforderungen erfüllen.
Hinweis

Bei Oracle Linux 8 und Oracle Linux Cloud Developer 7 ist die CLI vorinstalliert.
  1. Öffnen Sie ein Terminal.
  2. Um das Installationsprogrammskript auszuführen, führen Sie den folgenden Befehl aus:
    bash -c "$(curl -L https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.sh)"
    Hinweis

    Um eine vollautomatische Installation durchzuführen, die alle Standardwerte ohne Prompts akzeptiert, verwenden Sie den Parameter --accept-all-defaults.
  3. Beantworten Sie die Eingabeaufforderungen des Installationsskripts.

Andere Umgebungen

Informationen zur Installation der Befehlszeilenschnittstelle (CLI) in einer hier nicht aufgeführten Umgebung finden Sie unter Manuelle und Offlineinstallationen.

OCI-CLI-Installation prüfen

  1. Führen Sie in einer Eingabeaufforderung den folgenden Befehl aus:
    oci --version

Eingabeaufforderungen des Installationsskripts

Das Installationsskript fordert Sie zur Eingabe der folgenden Informationen auf.

  • Wenn keine kompatible Version von Python installiert ist:
    • Windows und Linux: Sie werden aufgefordert, einen Speicherort zur Installation der Binärdateien und ausführbaren Dateien anzugeben. Das Skript installiert Python für Sie.
    • MacOS: Sie werden benachrichtigt, dass Ihre Version von Python nicht kompatibel ist. Sie müssen ein Upgrade ausführen, bevor Sie mit der Installation fortfahren können. Das Skript installiert Python nicht für Sie.
  • Wenn Sie aufgefordert werden, ein Upgrade der CLI auf die neueste Version auszuführen, antworten Sie mit Y, um eine vorhandene Installation zu überschreiben.
  • Wenn Sie aufgefordert werden, den Pfad zu aktualisieren, antworten Sie mit Y, um die CLI aufzurufen, ohne den vollständigen Pfad zur ausführbaren Datei anzugeben. Dadurch wird oci.exe zum Pfad hinzugefügt.

Konfigurationsdatei einrichten

Bevor Sie die CLI verwenden, müssen Sie eine Konfigurationsdatei erstellen, die die erforderlichen Zugangsdaten für die Arbeit mit Oracle Cloud Infrastructure enthält. Sie können diese Datei mit einem Setupdialogfeld oder manuell mit einem Texteditor erstellen.

Setupdialogfeld verwenden

Verwenden Sie den Befehl setup config, damit Sie die CLI durch die Ersteinrichtung führt.
oci setup config
Dieser Befehl fordert Sie zur Eingabe der Informationen auf, die zum Erstellen der Konfigurationsdatei und der öffentlichen und privaten API-Schlüssel erforderlich sind. Im Setupdialogfeld werden diese Informationen verwendet, um ein API-Schlüsselpaar zu generieren und die Konfigurationsdatei zu erstellen. Nachdem die API-Schlüssel erstellt wurden, laden Sie den Public Key mit der Konsole hoch.

Weitere Informationen über die Suche nach den erforderlichen Informationen finden Sie unter:

Manuelles Setup

Wenn Sie den öffentlichen/privaten API-Schlüssel selbst einrichten und Ihre eigene Konfigurationsdatei schreiben möchten, lesen Sie SDK und Toolkonfiguration.

Tipp

Mit dem Befehl oci setup keys generieren Sie ein Schlüsselpaar, das in die Konfigurationsdatei aufgenommen werden kann.

Konfigurationsdatei überprüfen

Vollständigkeit der Konfigurationsdatei sicherstellen

Eine korrekte Konfigurationsdatei muss mindestens einen Profilnamen (wie [DEFAULT]) und die im Abschnitt Dateieinträge angegebenen Einträge enthalten: user, fingerprint, key_file, tenancy, region sowie optional pass_phrase.

Hinweis

Eine Beispielkonfigurationsdatei finden Sie im Abschnitt Beispielkonfiguration.

Benutzer- und Fingerprint-Informationen bestätigen

Sie können die Benutzer- und Fingerprint-Informationen bestätigen, indem Sie sich bei der OCI-Konsole anmelden, das Profilmenü oben rechts öffnen und dann Ihren Benutzernamen auswählen.

Nachdem Sie Ihren Benutzernamen ausgewählt haben, wird im Bereich "Benutzerinformationen" Ihre OCID angezeigt. Diese OCID muss mit dem Benutzereintrag in der Konfigurationsdatei übereinstimmen.

Ihren Fingerprint finden Sie im Abschnitt API-Schlüssel unter der Spalte Ressourcen unten links.

Kommentare zur Konfigurationsdatei hinzufügen

Achten Sie darauf, in der Konfigurationsdatei keine Inline-Kommentare zu verwenden. Fügen Sie alle Kommentare in einer neuen Zeile hinzu. Beispiel:
[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

Andere Authentifizierungsmethoden

Die CLI unterstützt auch die tokenbasierte Instanz-Principal- und Resource-Principal-Authentifizierung für einige Services. Weitere Informationen finden Sie unter SDK-Authentifizierungsmethoden.