Erste Schritte

In diesem Thema wird die Installation und Konfiguration der OCI-PowerShell-Module beschrieben.

Voraussetzungen

Achten Sie darauf, alle hier aufgeführten Anforderungen zu erfüllen.

Module installieren

Starten Sie eine PowerShell-Session:
1. Starten Sie PowerShell unter Windows über das Startmenü.
2. Führen Sie unter Linux oder MacOS pwsh über einen Shell-Prompt aus:
```
$ pwsh

PowerShell 7.1.0
Copyright (c) Microsoft Corporation. All rights reserved.

https://aka.ms/powershell
Type 'help' to get help.

PS /Users/username>
```
Um alle OCI-Module zu installieren, installieren Sie das Basismodul:

Install-Module OCI.PSModules

Hinweis

Wenn Sie das Modul OCI.PSModules deinstallieren, werden keine anderen OCI-Module deinstalliert. Um ein bestimmtes von diesem Modul installiertes OCI-Modul zu deinstallieren, muss das Modul OCI.PSModules zuerst deinstalliert werden.
Sie können nur die Module für einen individuellen Service installieren. Cmdlets, die den einzelnen von OCI-PowerShell-Modulen unterstützten OCI-Services entsprechen, werden in einem einzelnen PowerShell-Modul namens OCI.PSModules.<ServiceName> verpackt.
Fahren Sie entweder unter Von PowerShell Gallery installieren oder unter Von GitHub installieren fort.

Von PowerShell Gallery installieren

Standardmäßig ist PowerShell Gallery ("PS Gallery") als PSRepository konfiguriert. Dies kann durch Ausführen des Befehls Get-PSRepository verifiziert werden:

PS /> Get-PSRepository
 
Name                      InstallationPolicy   SourceLocation
----                      ------------------   --------------
PSGallery                 Untrusted            https://www.powershellgallery.com/api/v2

Sie können PS Gallery als vertrauenswürdiges Repository festlegen, damit Ihnen nicht bei jedem Versuch, ein Modul von PS Gallery zu installieren, Prompts angezeigt werden:
```
PS /> Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
```
PowerShell-Module, die einem unterstützten OCI-Service entsprechen, werden als Servicemodule bezeichnet. Um ein Servicemodul zu installieren, führen Sie den Befehl Install-Module aus. In diesem Beispiel wird das Servicemodul für den OCI Identity Service installiert:
```
PS /> Install-Module -Name OCI.PSModules.Identity
```
Hinweis

Jedes Servicemodul hängt von OCI.PSModules.Common (allgemeines Modul) ab, das Funktionen enthält, die allen Servicemodulen gemeinsam sind. Wenn Sie ein Servicemodul installieren, wird auch die entsprechende Version von OCI.PSModules.Common für dieses Servicemodul installiert.
Installierte Module finden Sie im von der Umgebungsvariablen $Env:PSModulePath angegebenen Pfad oder indem Sie den Befehl Get-Module mit dem Parameter ListAvailable ausführen.
```
PS /> Get-Module -ListAvailable
```

Von GitHub installieren

So installieren Sie OCI-PowerShell-Module von GitHub:

Laden Sie die neuesten OCI-Modulartefakte herunter, und extrahieren Sie sie in ein lokales Verzeichnis.
Hinweis

Cmdlets, die den einzelnen von OCI-PowerShell-Modulen unterstützten OCI-Services entsprechen, werden in einem einzelnen PowerShell-Modul namens OCI.PSModules.<ServiceName> verpackt.

Registrieren Sie das extrahierte Verzeichnis als lokales PowerShell-Repository:

PS /> Register-PSRepository -Name "LocalRepo" -SourceLocation <extractedlocation>

Suchen Sie die im lokalen Repository verfügbaren Module:
```
PS /> Find-Module -Repository "LocalRepo"
```
Installieren Sie ein spezifisches Modul:
```
PS /> Install-Module -Name OCI.PSModules.Objectstorage -Verbose -Repository LocalRepo
```
Hinweis

Jedes Servicemodul hängt von OCI.PSModules.Common (allgemeines Modul) ab, das Funktionen enthält, die allen Servicemodulen gemeinsam sind. Wenn Sie ein Servicemodul installieren, wird auch die entsprechende Version von OCI.PSModules.Common für dieses Servicemodul installiert.
Installierte Module finden Sie im von der Umgebungsvariablen $Env:PSModulePath angegebenen Pfad oder indem Sie den Befehl Get-Module mit dem Parameter ListAvailable ausführen.
```
PS /> Get-Module -ListAvailable
```

Mit Yum installieren

Wenn Sie Oracle Linux-Version 7.x verwenden, können die OCI-PowerShell-Modulpackages mit yum installiert werden.

So installieren Sie die OCI-PowerShell-Module mit yum:
```
$ sudo yum install oci-powershell-modules
```
Starten Sie eine PowerShell-Session, und registrieren Sie das heruntergeladene Verzeichnis /usr/lib/dotnet/NuPkgs mit dem folgenden Befehl als lokales PowerShell-Repository:
```
$ pwsh
PS /> Register-PSRepository -Name "LocalRepo" -SourceLocation /usr/lib/dotnet/NuPkgs
```
Suchen Sie die im lokalen Repository verfügbaren Module mit dem folgenden Befehl:
```
PS /> Find-Module -Repository "LocalRepo"
```
Installieren Sie ein spezifisches Modul:
```
PS /> Install-Module -Name OCI.PSModules.Objectstorage -Verbose -Repository LocalRepo
```
Hinweis

Jedes Servicemodul hängt von OCI.PSModules.Common (allgemeines Modul) ab, das Funktionen enthält, die allen Servicemodulen gemeinsam sind. Wenn Sie ein Servicemodul installieren, wird auch die entsprechende Version von OCI.PSModules.Common für dieses Servicemodul installiert.
Installierte Module finden Sie im von der Umgebungsvariablen $Env:PSModulePath angegebenen Pfad oder indem Sie den Befehl Get-Module mit dem Parameter ListAvailable ausführen.
```
PS /> Get-Module -ListAvailable
```

Setup

Befolgen Sie diese Installationsschritte, wenn Sie die erforderlichen Module noch nicht installiert haben.

Bevor Sie Cmdlets in OCI-Modulen aufrufen, müssen Sie die Konfigurationsdatei einrichten. Anschließend können Sie optional die erforderlichen Module in eine PowerShell-Session importieren.

Konfigurationsdatei

Eine Konfigurationsdatei stellt wichtige Konfigurationsinformationen, wie beispielsweise Benutzerzugangsdaten und die Mandanten-OCID, bereit. Anhand dieser Konfigurationsinformationen können die OCI-PowerShell-Module Oracle Cloud-Services authentifizieren und mit ihnen interagieren. Sie können diese Datei mit einem Setup-Cmdlet oder manuell mit einem Texteditor erstellen.

Set-OCIClientConfig

Das im allgemeinen Modul enthaltene Set-OCIClientConfig-Cmdlet zeigt Ihnen Schritt für Schritt, wie Sie eine Konfigurationsdatei einrichten können. Dieses Cmdlet fordert Sie zur Eingabe von Informationen auf, die von der Konfigurationsdatei benötigt werden, einschließlich des Schlüsselpaares zum Signieren von API-Anforderungen.

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

Manuelles Setup

Wenn Sie das API-Signaturschlüsselpaar manuell einrichten und Ihre eigene Konfigurationsdatei schreiben möchten, finden Sie unter SDK- und Toolkonfiguration und Erforderliche Schlüssel weitere Informationen.

Hinweis

Verwenden Sie das Cmdlet New-OCIClientKeys, um ein API-Signaturschlüsselpaar zu generieren, das in die Konfigurationsdatei aufgenommen werden soll.

Module importieren

PowerShell importiert das Modul (und seine Abhängigkeiten) automatisch in Ihre Session, wenn Sie zum ersten Mal einen beliebigen Befehl aus dem installierten Modul heraus ausführen. Um ein Modul explizit zu importieren, führen Sie den Befehl Import-Module aus.

Beispiel: So importieren Sie die Version 1.0.0 des Identity Service-Moduls:

PS /> Import-Module OCI.PSModules.Identity  -RequiredVersion 1.0.0   -Verbose

Um alle importierten Module in der aktuellen PowerShell-Session zu suchen, führen Sie den Befehl Get-Module aus:

PS /> Get-Module
 
ModuleType Name                            ExportedCommands
---------- ----                            ----------------
    Binary OCI.PSModules.Common            {Clear-OCICmdletHistory, Get-OCIClientSession], Get-OCICmdletHisto…
    Binary OCI.PSModules.Identity          {Add-OCIIdentityUserToGroup, Enable-OCIIdentityMfaTotpDevice…

Hinweis

Jedes Servicemodul hängt von OCI.PSModules.Common (allgemeines Modul) ab, das Funktionen enthält, die allen Servicemodulen gemeinsam sind. Wenn Sie ein Servicemodul installieren, wird auch die entsprechende Version von OCI.PSModules.Common für dieses Servicemodul installiert.

Module aktualisieren

Neue Versionen der OCI-PowerShell-Module werden wöchentlich veröffentlicht. Um die installierten OCI-PowerShell-Module auf die neueste Version zu aktualisieren, führen Sie den Befehl Update-Module aus.

Hinweis

Bevor Sie ein OCI-Modul aktualisieren, sollten Sie das Modul zuerst deinstallieren. Um Abhängigkeitskonflikte beim Import von Modulen in die PowerShell-Session zu vermeiden, aktualisieren Sie alle installierten OCI-Module auf dieselbe Version.

PS /> Update-Module -Name "OCI.PSModules.*" -Verbose

Module deinstallieren

Um ein installiertes Modul zu entfernen, können Sie entweder das Cmdlet Uninstall-Module verwenden oder den Modulordner löschen, der sich im Pfad der Umgebungsvariablen $Env:PSModulePath befindet.

Beispiel:

PS /> Uninstall-Module -Name OCI.PSModules.Identity

Nächste Schritte

Nachdem Sie die Installation und das Setup abgeschlossen haben, können Sie direkt unter Mit Cmdlets arbeiten oder Erweiterte Konzepte fortfahren.

Oracle Cloud Infrastructure - Dokumentation