Conceitos Básicos
Este tópico descreve como instalar e configurar os Módulos do OCI para PowerShell.
Este tópico descreve como instalar e configurar os Módulos do OCI para PowerShell.
Pré-requisitos
Certifique-se de atender a todos os requisitos listados aqui.
Instalando Módulos
- Iniciar uma sessão do PowerShell:
- No Windows, inicie o PowerShell no Menu Iniciar.
-
No Linux ou no MacOS, execute
pwsh
em um prompt 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 os módulos do OCI, instale o módulo base:
Install-Module OCI.PSModules
Observação
A desinstalação do móduloOCI.PSModules
não desinstalará outros módulos do OCI. Para desinstalar um módulo específico do OCI instalado por esse módulo, o móduloOCI.PSModules
deverá ser desinstalado primeiro. - Você pode instalar apenas os módulos de um serviço individual. Os Cmdlets correspondentes a cada serviço do OCI suportado pelos Módulos do OCI para PowerShell são empacotados em um módulo Powershell individual chamado
OCI.PSModules.<ServiceName>
. - Continue Instalando pela Galeria do PowerShell ou Instalando pelo GitHub.
Instalando pela Galeria do PowerShell
-
Por padrão, a Galeria do PowerShell ("Galeria PS") é configurada como PSRepository. Isso pode ser verificado executando o comando
Get-PSRepository
:PS /> Get-PSRepository Name InstallationPolicy SourceLocation ---- ------------------ -------------- PSGallery Untrusted https://www.powershellgallery.com/api/v2
-
Você pode definir a Galeria PS como repositório confiável para evitar prompts sempre que tentar instalar um módulo pela Galeria PS:
PS /> Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
-
Os módulos PowerShell que correspondem a um serviço de OCI suportado são chamados módulos de serviços. Para instalar um módulo de serviço, execute o comando Install-Module. Este exemplo instala o módulo de serviço para o serviço de Identidade do OCI:
PS /> Install-Module -Name OCI.PSModules.Identity
Observação
Cada módulo de serviço depende doOCI.PSModules.Common
(Módulo Comum), que oferece funcionalidade comum a todos os módulos de serviço. A instalação de um módulo de serviço também instalará a versão correspondente deOCI.PSModules.Common
para esse módulo de serviço. - Os módulos instalados podem ser encontrados no caminho especificado pela variável de ambiente
$Env:PSModulePath
ou executando o comando Get-Module com o parâmetroListAvailable
.PS /> Get-Module -ListAvailable
Instalando pelo GitHub
Para instalar os módulos do OCI PowerShell pelo GitHub:
- Faça download dos artefatos de Módulos do OCI mais recentes e extraia-os em um diretório local.Observação
Os Cmdlets correspondentes a cada serviço do OCI suportado pelos Módulos do OCI para PowerShell são compactados em um módulo Powershell individual chamadoOCI.PSModules.<ServiceName>
. - Registre o diretório extraído como repositório local do PowerShell:
PS /> Register-PSRepository -Name "LocalRepo" -SourceLocation <extractedlocation>
- Localize os módulos disponíveis no repositório local:
PS /> Find-Module -Repository "LocalRepo"
- Instale um módulo específico:
PS /> Install-Module -Name OCI.PSModules.Objectstorage -Verbose -Repository LocalRepo
Observação
Cada módulo de serviço depende doOCI.PSModules.Common
(Módulo Comum), que oferece funcionalidades comuns a todos os módulos de serviço. A instalação de um módulo de serviço também instalará a versão correspondente deOCI.PSModules.Common
para esse módulo de serviço. - Os módulos instalados podem ser encontrados no caminho especificado pela variável de ambiente
$Env:PSModulePath
ou executando o comando Get-Module com o parâmetroListAvailable
.PS /> Get-Module -ListAvailable
Instalando com o Yum
Se você estiver usando o Oracle Linux versão 7.x, os pacotes de Módulos PowerShell do OCI poderão ser instalados com o yum.
- Para instalar os módulos do OCI PowerShell usando o yum:
$ sudo yum install oci-powershell-modules
- Inicie uma Sessão PowerShell e registre o diretório baixado /usr/lib/dotnet/NuPkgs como um repositório local do PowerShell usando o seguinte comando:
$ pwsh PS /> Register-PSRepository -Name "LocalRepo" -SourceLocation /usr/lib/dotnet/NuPkgs
- Localize os módulos disponíveis no repositório local usando o seguinte comando:
PS /> Find-Module -Repository "LocalRepo"
- Instale um módulo específico:
PS /> Install-Module -Name OCI.PSModules.Objectstorage -Verbose -Repository LocalRepo
Observação
Cada módulo de serviço depende doOCI.PSModules.Common
(Módulo Comum), que oferece funcionalidades comuns a todos os módulos de serviço. A instalação de um módulo de serviço também instalará a versão correspondente deOCI.PSModules.Common
para esse módulo de serviço. - Os módulos instalados podem ser encontrados no caminho especificado pela variável de ambiente
$Env:PSModulePath
ou executando o comando Get-Module com o parâmetroListAvailable
.PS /> Get-Module -ListAvailable
Configurar
Siga estas etapas de instalação se você não tiver instalado os módulos obrigatórios.
Antes de chamar os cmdlets nos Módulos do OCI, configure o arquivo de configuração e, se desejar, importe os módulos obrigatórios em uma sessão do PowerShell.
Arquivo de Configuração
Um arquivo de configuração fornece informações de configuração essenciais, como credenciais do usuário e OCID de tenancy. Essas informações de configuração são usadas pelos Módulos do OCI para PowerShell para autenticar e interagir com os serviços do Oracle Cloud. Você pode criar esse arquivo usando um cmdlet de configuração ou manualmente usando um editor de texto.
Definir-OCIClientConfig
O cmdlet Set-OCIClientConfig
incluído no módulo Comum orientará você durante a instalação de um arquivo de configuração. Esse cmdlet solicita informações exigidas pelo arquivo de configuração, incluindo o par de chaves usado para assinar solicitações de API.
Para obter mais informações sobre como encontrar as informações necessárias, consulte:
Configuração Manual
Se você quiser configurar o par de chaves de assinatura da API manualmente e criar seu próprio arquivo de configuração, consulte Configuração do SDK e da Ferramenta e Chaves Obrigatórias.
Use o cmdlet New-OCIClientKeys
para gerar um par de chaves de assinatura de API a ser incluído no arquivo de configuração.
Importando Módulos
O PowerShell importará automaticamente o módulo (e suas dependências) para sua sessão na primeira vez que você executar qualquer comando do módulo instalado. Para importar explicitamente um módulo, execute o comando Importar-Módulo.
Por exemplo, para importar a versão 1.0.0 do módulo de serviço de Identidade:
PS /> Import-Module OCI.PSModules.Identity -RequiredVersion 1.0.0 -Verbose
Para encontrar todos os módulos importados em sua Sessão atual do PowerShell, execute o 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…
Cada módulo de serviço depende do
OCI.PSModules.Common
(Módulo Comum), que oferece funcionalidades comuns a todos os módulos de serviço. A instalação de um módulo de serviço também instalará a versão correspondente de OCI.PSModules.Common
para esse módulo de serviço.Atualizando Módulos
Novas versões dos módulos do OCI PowerShell são liberadas semanalmente. Para atualizar os módulos do OCI PowerShell instalados para a versão mais recente, execute o comando Update-Module.
Antes de atualizar qualquer módulo do OCI, desinstale primeiro o módulo. Para evitar conflitos de dependência ao importar módulos para a sessão do PowerShell, atualize todos os Módulos do OCI instalados para a mesma versão.
PS /> Update-Module -Name "OCI.PSModules.*" -Verbose
Desinstalando Módulos
Para remover qualquer módulo instalado, você pode usar o cmdlet Uninstall-Module ou excluir a pasta do módulo localizada no caminho da variável de ambiente $Env:PSModulePath
.
Por exemplo:
PS /> Uninstall-Module -Name OCI.PSModules.Identity
Próximas Etapas
Agora que você terminou a instalação e a configuração, poderá prosseguir diretamente para Como Trabalhar com Cmdlets ou continuar em Conceitos Avançados.