Introducción

En este tema se describe cómo instalar y configurar los módulos OCI para PowerShell.

Requisitos

Asegúrese de cumplir con todos los requisitos enumerados aquí.

Instalación de módulos

Iniciar una sesión en PowerShell:

En Windows, inicie PowerShell desde el menú Inicio.

En Linux o MacOS, ejecute pwsh desde una petición de datos 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>

Para instalar todos los módulos de OCI, instale el módulo básico:

Install-Module OCI.PSModules

Nota

La desinstalación del módulo OCI.PSModules no desinstalará otros módulos OCI. Para desinstalar un módulo OCI específico instalado por este módulo, es necesario desinstalar primero el módulo OCI.PSModules.
Puede instalar solo los módulos para un servicio individual. Los cmdlets correspondientes a cada servicio de OCI soportado por los módulos OCI para PowerShell se empaquetan en un módulo individual de Powershell denominado OCI.PSModules.<ServiceName>.
Continúe con Instalación desde la galería de PowerShell o Instalación desde GitHub.

Instalación desde la galería de PowerShell

Por defecto, la galería de PowerShell ("Galería de PS") se ha configurado como PSRepository. Esto se puede verificar ejecutando el comando Get-PSRepository:

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

Puede definir la galería de PS como repositorio de confianza para evitar peticiones de datos cada vez que intente instalar un módulo desde la galería de PS:
```
PS /> Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
```
Los módulos PowerShell que corresponden a un servicio OCI soportado se denominan módulos de servicio. Para instalar un módulo de servicio, ejecute el comando Install-Module. En este ejemplo, se instala el módulo de servicio para el servicio de identidad de OCI:
```
PS /> Install-Module -Name OCI.PSModules.Identity
```
Nota

Cada módulo de servicio depende del OCI.PSModules.Common (módulo común), que ofrece funcionalidad común a todos los módulos de servicio. La instalación de un módulo de servicio también instalará la versión correspondiente de OCI.PSModules.Common para ese módulo de servicio.
Los módulos instalados se pueden encontrar en la ruta especificada por la variable de entorno $Env:PSModulePath o ejecutando el comando Get-Module con el parámetro ListAvailable.
```
PS /> Get-Module -ListAvailable
```

Instalación desde GitHub

Para instalar los módulos de PowerShell de OCI desde GitHub:

Descargue los artefactos de los módulos OCI más recientes y extráigalos a un directorio local.
Nota

Los cmdlets correspondientes a cada servicio de OCI soportado por los módulos OCI para PowerShell se empaquetan en un módulo individual de Powershell denominado OCI.PSModules.<ServiceName>.

Registre el directorio extraído como el repositorio local de PowerShell:

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

Encuentre los módulos disponibles en el repositorio local:
```
PS /> Find-Module -Repository "LocalRepo"
```
Instale un módulo específico:
```
PS /> Install-Module -Name OCI.PSModules.Objectstorage -Verbose -Repository LocalRepo
```
Nota

Cada módulo de servicio depende de OCI.PSModules.Common (módulo común), que ofrece funcionalidades comunes a todos los módulos de servicio. La instalación de un módulo de servicio también instalará la versión correspondiente de OCI.PSModules.Common para ese módulo de servicio.
Los módulos instalados se pueden encontrar en la ruta especificada por la variable de entorno $Env:PSModulePath o ejecutando el comando Get-Module con el parámetro ListAvailable.
```
PS /> Get-Module -ListAvailable
```

Instalación con Yum

Si utiliza Oracle Linux versión 7.x, los paquetes de los módulos de PowerShell de OCI se pueden instalar con yum.

Para instalar los módulos de PowerShell de OCI mediante yum:
```
$ sudo yum install oci-powershell-modules
```
Inicie una sesión de PowerShell y registre el directorio descargado /usr/lib/dotnet/NuPkgs como un repositorio de PowerShell local mediante el siguiente comando:
```
$ pwsh
PS /> Register-PSRepository -Name "LocalRepo" -SourceLocation /usr/lib/dotnet/NuPkgs
```
Busque los módulos disponibles en el repositorio local utilizando el siguiente comando:
```
PS /> Find-Module -Repository "LocalRepo"
```
Instale un módulo específico:
```
PS /> Install-Module -Name OCI.PSModules.Objectstorage -Verbose -Repository LocalRepo
```
Nota

Cada módulo de servicio depende de OCI.PSModules.Common (módulo común), que ofrece funcionalidades comunes a todos los módulos de servicio. La instalación de un módulo de servicio también instalará la versión correspondiente de OCI.PSModules.Common para ese módulo de servicio.
Los módulos instalados se pueden encontrar en la ruta especificada por la variable de entorno $Env:PSModulePath o ejecutando el comando Get-Module con el parámetro ListAvailable.
```
PS /> Get-Module -ListAvailable
```

Configuración

Siga estos pasos de instalación si no ha instalado los módulos necesarios.

Antes de llamar a cmdlets en módulos OCI, debe configurar el archivo de configuración y, a continuación, importar los módulos necesarios a una sesión de PowerShell.

Archivo de configuración

Un archivo de configuración proporciona información de configuración esencial, como credenciales de usuario y OCID de arrendamiento. Esta información de configuración la utilizan los módulos OCI para PowerShell para autenticar e interactuar con los servicios de Oracle Cloud. Puede crear este archivo mediante un cmdlet de configuración, o manualmente con un editor de texto.

Set-OCIClientConfig

El cmdlet Set-OCIClientConfig incluido en el módulo común le guiará en la configuración de un archivo de configuración. Este cmdlet le solicita información necesaria para el archivo de configuración, incluido el par de claves utilizado para firmar solicitudes de API.

Para obtener más información sobre cómo buscar la información necesaria, consulte:

Configuración manual

Si desea configurar el par de claves de firma de API manualmente y escribir su propio archivo de configuración, consulte Configuración de herramientas y SDK y Claves necesarias.

Nota

Utilice el cmdlet New-OCIClientKeys para generar un par de claves de firma de API para incluirlo en el archivo de configuración.

Importación de módulos

PowerShell importará automáticamente el módulo (y sus dependencias) a la sesión la primera vez que ejecute algún comando desde el módulo instalado. Para importar un módulo explícitamente, ejecute el comando Import-Module.

Por ejemplo, para importar la versión 1.0.0 del módulo de servicio de identidad:

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

Para buscar todos los módulos importados en la sesión de PowerShell actual, ejecute el comando 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…

Nota

Cada módulo de servicio depende de OCI.PSModules.Common (módulo común), que ofrece funcionalidades comunes a todos los módulos de servicio. La instalación de un módulo de servicio también instalará la versión correspondiente de OCI.PSModules.Common para ese módulo de servicio.

Actualización de módulos

Nuevas versiones semanales de los módulos de PowerShell de OCI. Para actualizar los módulos de PowerShell de OCI instalados a la última versión, ejecute el comando Update-Module.

Nota

Antes de actualizar cualquier módulo OCI, debe desinstalar el módulo. Para evitar conflictos de dependencia al importar módulos a la sesión de PowerShell, actualice todos los módulos OCI instalados a la misma versión.

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

Desinstalación de módulos

Para eliminar cualquier módulo instalado, puede utilizar el cmdlet Uninstall-Module o suprimir la carpeta de módulo ubicada en la ruta de acceso de la variable de entorno $Env:PSModulePath.

Por ejemplo:

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

Siguientes pasos

Ya ha realizado la instalación y la configuración, y puede proceder directamente a Trabajar con cmdlets o continuar con Conceptos avanzados.

Documentación de Oracle Cloud Infrastructure