Documentação do Oracle Cloud Infrastructure

Início Rápido

Esta seção mostra como instalar e configurar rapidamente a CLI (interface de linha de comando) do OCI.

Instalando a CLI

Conteúdo desta Seção

Esta seção contém instruções de instalação rápida para os seguintes ambientes:

Oracle Linux 9

Se você estiver usando o Oracle Linux 9, poderá usar o dnf para instalar a CLI.

Observação

É altamente recomendável executar o comando sudo dnf update regularmente para garantir que o sistema esteja atualizado instalando os RPMs atualizados disponíveis.

Para usar o dnf para instalar a CLI:

sudo dnf -y install oraclelinux-developer-release-el9
sudo dnf install python39-oci-cli

A CLI será instalada nos pacotes de sites do Python:

  • /usr/lib/python3.9/site-packages/oci_cli
  • /usr/lib/python3.9/site-packages/services

Documentação e exemplos serão instalados no diretório /usr/share/doc/python39-oci-cli-<version>/.

Para desinstalar a CLI:

sudo dnf remove python39-oci-cli

Oracle Linux 8

Se você estiver usando o Oracle Linux 8, poderá usar o dnf para instalar a CLI.

Observação

É altamente recomendável executar o comando sudo dnf update regularmente para garantir que o sistema esteja atualizado instalando os RPMs atualizados disponíveis.

Para usar o dnf para instalar a CLI:

sudo dnf -y install oraclelinux-developer-release-el8
sudo dnf install python36-oci-cli

A CLI será instalada nos pacotes de sites do Python:

  • /usr/lib/python3.6/site-packages/oci_cli
  • /usr/lib/python3.6/site-packages/services

Documentação e exemplos serão instalados no diretório /usr/share/doc/python36-oci-cli-<version>/.

Para desinstalar a CLI:

sudo dnf remove python36-oci-cli

Oracle Linux 7

Se estiver usando o Oracle Linux 7, você poderá usar o yum para instalar a CLI.

Para usar o yum para instalar a CLI:

sudo yum install python36-oci-cli

A CLI será instalada nos pacotes de sites do Python:

  • /usr/lib/python3.6/site-packages/oci_cli
  • /usr/lib/python3.6/site-packages/services

Documentação e exemplos serão instalados no diretório /usr/share/doc/python36-oci-cli-<version>/.

Para desinstalar a CLI:

sudo yum remove python36-oci-cli

Mac OS

Você pode usar o Homebrew para instalar, fazer upgrade e desinstalar a CLI no Mac OS.

Para instalar a CLI no Mac OS com o Homebrew:

brew update && brew install oci-cli

Para fazer upgrade da instalação da CLI no Mac OS usando o Homebrew: 

brew update && brew upgrade oci-cli

Para desinstalar a CLI no Mac OS usando o Homebrew: 

brew uninstall oci-cli

Windows

Você pode instalar a CLI no Windows usando o instalador MSI ou usando PowerShell.

Para instalar a CLI no Windows usando o instalador MSI:
Observação

O instalador da CLI MSI substituirá todas as versões existentes da CLI no sistema Windows. Se você precisar instalar várias versões da CLI, para instalações subsequentes crie um ambiente virtual e use o método de instalação manual. Para obter mais informações, consulte Instalações Manuais e Off-line.
  1. Faça download do instalador MSI da CLI do OCI para Windows em GitHub.
  2. Execute o executável do instalador baixado.
  3. Selecione o diretório local no sistema no qual você deseja instalar a CLI e clique em Próximo.
  4. Quando o instalador tiver terminado, clique em Finalizar.

Para instalar a CLI no Windows usando PowerShell:

  1. Abra a console do PowerShell usando a opção Executar como Administrador.

  2. O instalador ativa o preenchimento automático instalando e executando um script. Para permitir que esse script seja executado, ative a política de execução RemoteSigned.

    Para configurar a política de execução remota em relação ao PowerShell, execute o comando a seguir.

    Set-ExecutionPolicy RemoteSigned
  3. Force o PowerShell a usar o TLS 1.2 para Windows 2012 e Windows 2016:
    [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
  4. Faça download do script do instalador:
    Invoke-WebRequest https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.ps1 -OutFile install.ps1
  5. Execute o script do instalador com ou sem prompts:
    1. Para executar o script do instalador com prompts, execute o seguinte comando:
      iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.ps1'))

      ...e responda aos Prompts do Script de Instalação.

    2. Para executar o script do instalador sem solicitar ao usuário, aceitando as definições padrão, execute o seguinte comando:
      ./install.ps1 -AcceptAllDefaults

Linux e Unix

Observação

O script instalador instala automaticamente a CLI e suas dependências, Python e virtualenv. Antes de executar o instalador, certifique-se de atender aos requisitos.
Observação

O Oracle Linux 8 e o Oracle Linux Cloud Developer 7 têm a CLI pré-instalada.
  1. Abra um terminal.
  2. Para executar o script do instalador, execute o comando a seguir:
    bash -c "$(curl -L https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.sh)"
    Observação

    Para executar uma instalação 'silenciosa' que aceite todos os valores padrão sem prompts, use o parâmetro --accept-all-defaults.
  3. Responda aos Prompts do Script de Instalação.

Outros Ambientes

Para instalar a CLI em um ambiente não listado aqui, consulte Instalações Manuais e Off-line.

Verificando a Instalação da CLI do OCI

  1. Em um prompt de comando, execute o seguinte comando:
    oci --version

Prompts do Script de Instalação

O script de instalação solicita as informações a seguir.

  • Se você não tiver uma versão compatível do Python instalada:
    • Windows e Linux: você deverá fornecer um local para instalar os binários e os executáveis. O script instalará o Python para você.
    • MacOS: você será notificado de que a sua versão do Python é incompatível. Você deverá fazer upgrade para que possa prosseguir com a instalação. O script não instalará o Python para você.
  • Quando solicitado a fazer upgrade da CLI para a versão mais recente, responda com Y para substituir a instalação existente.
  • Quando solicitado a atualizar o seu PATH, responda com Y para conseguir chamar a CLI sem fornecer o caminho completo para o executável. Isso adicionará oci.exe ao PATH.

Definindo o Arquivo de Configuração

Antes de usar a CLI, você deverá criar um arquivo de configuração que contenha as credenciais necessárias para trabalhar com o Oracle Cloud Infrastructure. É possível criar esse arquivo usando uma caixa de diálogo de configuração ou manualmente usando um editor de texto.

Usar a Caixa de Diálogo de Configuração

Para fazer com que a CLI oriente você durante o processo de configuração pela primeira vez, use o comando setup config:
oci setup config
Esse comando solicita as informações necessárias para criar o arquivo de configuração e as chaves pública e privada da API. A caixa de diálogo de configuração usa essas informações para gerar um par de chaves da API e cria o arquivo de configuração. Após a criação das chaves de API, faça upload da chave pública usando a Console.

Para obter mais informações sobre como encontrar as informações necessárias, consulte:

Configuração Manual

Se você quiser configurar a API pública/privada e criar o seu próprio arquivo de configuração, consulte Configuração de SDKs e Ferramentas.

Dica

Use o comando oci setup keys para gerar um par de chaves a ser incluído no arquivo de configuração.

Verificando o Arquivo de Configuração

Verificar se o seu Arquivo de Configuração Está Completo

Um arquivo de configuração adequado deve ter pelo menos um nome de perfil (como [DEFAULT]) e as entradas especificadas na seção Entradas de Arquivo: user, fingerprint, key_file, tenancy, region e uma pass_phrase opcional.

Observação

Consulte a seção Exemplo de Configuração para obter uma amostra de arquivo de configuração.

Confirmar suas Informações de Usuário e Impressão Digital

Você pode confirmar suas informações de usuário e impressão digital fazendo log-in na console do OCI, abrindo o menu de perfil no canto superior direito e selecionando seu nome de usuário.

Após selecionar seu nome de usuário, você verá seu OCID no painel Informações do Usuário. Este OCID deve ser a entrada do usuário no arquivo de configuração.

Você pode encontrar sua impressão digital navegando até a seção Chaves de API na coluna Recursos na parte inferior esquerda.

Adicionando Comentários ao Arquivo de Configuração

Certifique-se de não adicionar comentários em linha ao arquivo de configuração. Adicione todos os comentários em uma nova linha. Por exemplo:
[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>
# Some comment
region=us-ashburn-1

Outros Métodos de Autenticação

A CLI também suporta autenticação baseada em token, principal de instância e principal de recursos para alguns serviços. Para obter mais informações, consulte Métodos de Autenticação do SDK.