Introduction

Cette rubrique décrit comment installer et configurer les modules OCI pour PowerShell.

Préalables

Assurez-vous de satisfaire à toutes les exigences énumérées ici.

Installation des modules

Démarrez une session PowerShell :
1. Sous Windows, lancez PowerShell à partir du menu Démarrer.
2. Sous Linux ou MacOS, exécutez pwsh à partir d'une invite de l'interpréteur de commandes :
```
$ pwsh

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

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

PS /Users/username>
```
Pour installer tous les modules OCI, installez le module de base :

Install-Module OCI.PSModules

Note

La désinstallation du module OCI.PSModules ne désinstalle pas les autres modules OCI. Pour pouvoir désinstaller un module OCI spécifique installé par ce module, il faut d'abord désinstaller le module OCI.PSModules.
Vous pouvez installer uniquement les modules d'un service individuel. Les applets de commande correspondant à chaque service OCI pris en charge par les modules OCI pour PowerShell sont regroupés dans un module Powershell individuel nommé OCI.PSModules.<ServiceName>.
Poursuivez l'installation à partir de PowerShell Gallery ou l'installation à partir de GitHub.

Installation à partir de PowerShell Gallery

Par défaut, PowerShell Gallery ("PS Gallery") est configuré comme PSRepository. Vous pouvez le vérifier en exécutant la commande Get-PSRepository :

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

Vous pouvez définir PS Gallery comme un référentiel approuvé pour éviter les invites chaque fois que vous tentez d'installer un module à partir de PS Gallery :
```
PS /> Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
```
Les modules PowerShell qui correspondent à un service OCI pris en charge sont appelés modules de service. Pour installer un module de service, exécutez la commande Install-Module. L'exemple suivant installe le module de service pour le service OCI Identity :
```
PS /> Install-Module -Name OCI.PSModules.Identity
```
Note

Chaque module de service dépend de OCI.PSModules.Common (module commun), qui offre des fonctionnalités communes à tous les modules de service. L'installation d'un module de service installera également la version correspondante de OCI.PSModules.Common pour ce module de service.
Vous pouvez rechercher les modules installés en fonction du chemin spécifié par la variable d'environnement $Env:PSModulePath, ou en exécutant la commande Get-Module avec le paramètre ListAvailable.
```
PS /> Get-Module -ListAvailable
```

Installation à partir de GitHub

Pour installer les modules OCI pour PowerShell à partir de GitHub :

Téléchargez les derniers artefacts des modules OCI et extrayez-les dans un répertoire local.
Note

Les applets de commande correspondant à chaque service OCI pris en charge par les modules OCI pour PowerShell sont regroupés dans un module Powershell individuel nommé OCI.PSModules.<ServiceName>.

Enregistrez le répertoire extrait en tant que référentiel PowerShell local :

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

Recherchez les modules disponibles dans le référentiel local :
```
PS /> Find-Module -Repository "LocalRepo"
```
Installez un module spécifique :
```
PS /> Install-Module -Name OCI.PSModules.Objectstorage -Verbose -Repository LocalRepo
```
Note

Chaque module de service dépend de OCI.PSModules.Common (module commun), qui offre des fonctionnalités communes à tous les modules de service. L'installation d'un module de service installera également la version correspondante de OCI.PSModules.Common pour ce module de service.
Vous pouvez rechercher les modules installés en fonction du chemin spécifié par la variable d'environnement $Env:PSModulePath, ou en exécutant la commande Get-Module avec le paramètre ListAvailable.
```
PS /> Get-Module -ListAvailable
```

Installation avec yum

Si vous utilisez Oracle Linux version 7.x, les ensembles Modules PowerShell pour OCI peuvent être installés avec yum.

Pour installer les modules OCI pour PowerShell avec yum :
```
$ sudo yum install oci-powershell-modules
```
Lancez une session PowerShell et enregistrez le répertoire /usr/lib/dotnet/NuPkgs local PowerShell à l'aide de la commande suivante :
```
$ pwsh
PS /> Register-PSRepository -Name "LocalRepo" -SourceLocation /usr/lib/dotnet/NuPkgs
```
Pour rechercher les modules disponibles dans le référentiel local, exécutez la commande suivante :
```
PS /> Find-Module -Repository "LocalRepo"
```
Installez un module spécifique :
```
PS /> Install-Module -Name OCI.PSModules.Objectstorage -Verbose -Repository LocalRepo
```
Note

Chaque module de service dépend de OCI.PSModules.Common (module commun), qui offre des fonctionnalités communes à tous les modules de service. L'installation d'un module de service installera également la version correspondante de OCI.PSModules.Common pour ce module de service.
Vous pouvez rechercher les modules installés en fonction du chemin spécifié par la variable d'environnement $Env:PSModulePath, ou en exécutant la commande Get-Module avec le paramètre ListAvailable.
```
PS /> Get-Module -ListAvailable
```

Configuration

Suivez ces étapes d'installation si vous n'avez pas installé les modules requis.

Avant d'appeler des applets de commande dans les modules OCI, vous devez définir le fichier de configuration, puis importer les modules requis dans une session PowerShell.

Fichier de configuration

Un fichier de configuration fournit des informations de configuration essentielles, comme les données d'identification de l'utilisateur et l'OCID de la location. Ces informations de configuration sont utilisées par les modules OCI pour PowerShell pour l'authentification et l'interaction avec les services Oracle Cloud. Vous pouvez créer ce fichier à l'aide d'un applet de commande de configuration ou manuellement à l'aide d'un éditeur de texte.

Set-OCIClientConfig

L'applet de commande Set-OCIClientConfig inclus dans le module commun vous guidera tout au long de la définition d'un fichier de configuration. Cet applet de commande vous invite à obtenir les informations requises par le fichier de configuration, y compris la paire de clés utilisée pour signer les demandes d'API.

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

Configuration manuelle

Si vous voulez configurer manuellement la paire de clés de signature d'API et écrire votre propre fichier de configuration, voir Configuration des trousses SDK et des outils et Clés requises.

Note

Utilisez l'applet de commande New-OCIClientKeys pour générer une paire de clés de signature d'API à inclure dans le fichier de configuration.

Importation des modules

PowerShell importera automatiquement le module (et ses dépendances) dans votre session la première fois que vous exécuterez une commande à partir du module installé. Pour importer explicitement un module, exécutez la commande Import-Module.

Par exemple, pour importer la version 1.0.0 du module de service Identity :

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

Pour rechercher tous les modules importés dans votre session PowerShell courante, exécutez la commande Get-Module :

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

Note

Chaque module de service dépend de OCI.PSModules.Common (module commun), qui offre des fonctionnalités communes à tous les modules de service. L'installation d'un module de service installera également la version correspondante de OCI.PSModules.Common pour ce module de service.

Mise à jour des modules

De nouvelles versions des modules PowerShell OCI sont publiées chaque semaine. Pour mettre à jour les modules OCI PowerShell installés vers la dernière version, exécutez la commande Update-Module.

Note

Avant de mettre à jour un module OCI, vous devez d'abord désinstaller le module. Pour éviter les conflits de dépendance lors de l'importation de modules dans la session PowerShell, mettez à jour tous les modules OCI installés avec la même version.

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

Désinstallation des modules

Pour supprimer tout module installé, vous pouvez soit utiliser l'applet de commande Uninstall-Module, soit supprimer le dossier du module situé dans le chemin de la variable d'environnement $Env:PSModulePath.

Par exemple :

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

Étapes suivantes

Maintenant que vous avez effectué l'installation et la configuration, vous pouvez passer directement à Utilisation des applets de commande ou continuer vers Concepts avancés.

Documentation sur Oracle Cloud Infrastructure