Introduction

Cette rubrique décrit l'installation et la configuration des modules OCI pour PowerShell.

Prérequis

Veillez à respecter toutes les exigences répertoriées ici.

Installation de 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 shell :
```
$ 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

Remarque

La désinstallation du module OCI.PSModules ne désinstalle pas les autres modules OCI. Pour désinstaller un module OCI spécifique installé par ce module, vous devez d'abord désinstaller le module OCI.PSModules.
Vous pouvez installer uniquement les modules d'un service spécifique. Les cmdlets correspondant à chaque service OCI pris en charge par les modules OCI pour PowerShell sont packagées dans un module PowerShell individuel nommé OCI.PSModules.<ServiceName>.
Reportez-vous ensuite à Installation à partir de PowerShell Gallery ou à Installation à partir de GitHub.

Installation à partir de PowerShell Gallery

Par défaut, PowerShell Gallery ("PS Gallery") est configuré en tant que PSRepository. Pour vérifier cette configuration, exécutez la commande Get-PSRepository :

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

Vous pouvez définir PS Gallery en tant que référentiel sécurisé pour ne pas recevoir une invite chaque fois que vous tentez d'installer un module à partir de PS Gallery :
```
PS /> Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
```
Les modules PowerShell correspondant à un service OCI pris en charge sont appelés modules de services. Pour installer un module de service, exécutez la commande Install-Module. Cet exemple illustre l'installation du module de service pour le service OCI Identity :
```
PS /> Install-Module -Name OCI.PSModules.Identity
```
Remarque

Chaque module de service dépend du module OCI.PSModules.Common (module commun), qui offre des fonctionnalités communes à tous les modules de service. L'installation d'un module de service entraînera également l'installation de la version correspondante de OCI.PSModules.Common pour ce module de service.
Vous trouverez les modules installés dans le chemin indiqué par la variable d'environnement $Env:PSModulePath. Vous pouvez également exécuter 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, procédez comme suit :

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

Les cmdlets correspondant à chaque service OCI pris en charge par les modules OCI pour PowerShell sont packagées dans un module PowerShell individuel nommé OCI.PSModules.<ServiceName>.

Inscrivez 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
```
Remarque

Chaque module de service dépend du module OCI.PSModules.Common (module commun), qui offre des fonctionnalités communes à tous les modules de service. L'installation d'un module de service entraînera également l'installation de la version correspondante de OCI.PSModules.Common pour ce module de service.
Vous trouverez les modules installés dans le chemin indiqué par la variable d'environnement $Env:PSModulePath. Vous pouvez également exécuter la commande Get-Module avec le paramètre ListAvailable.
```
PS /> Get-Module -ListAvailable
```

Installation à l'aide de YUM

Si vous utilisez Oracle Linux version 7.x, les packages des modules OCI pour PowerShell peuvent être installés avec YUM.

Installez les modules OCI pour PowerShell à l'aide de YUM :
```
$ sudo yum install oci-powershell-modules
```
Démarrez une session PowerShell et inscrivez le répertoire téléchargé /usr/lib/dotnet/NuPkgs en tant que référentiel PowerShell local à l'aide de la commande suivante :
```
$ pwsh
PS /> Register-PSRepository -Name "LocalRepo" -SourceLocation /usr/lib/dotnet/NuPkgs
```
Recherchez les modules disponibles dans le référentiel local à l'aide de la commande suivante :
```
PS /> Find-Module -Repository "LocalRepo"
```
Installez un module spécifique :
```
PS /> Install-Module -Name OCI.PSModules.Objectstorage -Verbose -Repository LocalRepo
```
Remarque

Chaque module de service dépend du module OCI.PSModules.Common (module commun), qui offre des fonctionnalités communes à tous les modules de service. L'installation d'un module de service entraînera également l'installation de la version correspondante de OCI.PSModules.Common pour ce module de service.
Vous trouverez les modules installés dans le chemin indiqué par la variable d'environnement $Env:PSModulePath. Vous pouvez également exécuter 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 cmdlets dans les modules OCI, vous devez configurer le fichier de configuration, puis éventuellement importer les modules requis dans une session PowerShell.

Fichier de configuration

Un fichier de configuration fournit des informations de configuration essentielles, telles que les informations d'identification utilisateur et l'OCID de location. Ces informations de configuration sont utilisées par les modules OCI pour PowerShell afin d'authentifier les services Oracle Cloud et d'interagir avec ces derniers. Vous pouvez créer ce fichier à l'aide d'une cmdlet de configuration ou manuellement à l'aide d'un éditeur de texte.

Set-OCIClientConfig

La cmdlet Set-OCIClientConfig incluse dans le module commun vous guidera tout au long de la configuration d'un fichier de configuration. Cette cmdlet vous invite à fournir les informations requises par le fichier de configuration, y compris la paire de clés utilisée pour signer les demandes API.

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

Configuration manuelle

Si vous voulez configurer manuellement la paire de clés de signature d'API et écrire votre propre fichier de configuration, reportez-vous à Configuration d'outil et de kit SDK et à Clés requises.

Remarque

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

Import de modules

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

Par exemple, pour importer la version 1.0.0 du module de service Identity, exécutez la commande suivante :

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

Pour rechercher tous les modules importés dans votre session PowerShell en cours, 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…

Remarque

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

Mise à jour de modules

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

Remarque

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

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

Désinstallation de modules

Pour enlever un module installé, vous pouvez utiliser la cmdlet Uninstall-Module ou supprimer le dossier du module dans le chemin de la variable d'environnement $Env:PSModulePath.

Par exemple :

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

Etapes suivantes

Une fois que vous avez terminé l'installation et la configuration, vous pouvez passer directement à Utilisation des cmdlets ou à Concepts avancés.

Documentation Oracle Cloud Infrastructure