Documentación de Oracle Cloud Infrastructure

Inicio rápido

En esta sección, se documenta cómo instalar y configurar rápidamente la interfaz de línea de comandos (CLI) de OCI.

Instalación de la CLI

Contenido de esta sección

Esta sección contiene instrucciones de instalación rápida para los siguientes entornos:

Oracle Linux 9

Si utiliza Oracle Linux 9, puede usar dnf para instalar la CLI.

Nota

Recomendamos encarecidamente ejecutar sudo dnf update con regularidad para garantizar que el sistema esté actualizado mediante la instalación de los RPM actualizados disponibles.

Para utilizar dnf para instalar la CLI:

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

La CLI se instalará en los paquetes del sitio de Python:

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

La documentación y los ejemplos se instalarán en el directorio /usr/share/doc/python39-oci-cli-<version>/.

Para desinstalar la CLI:

sudo dnf remove python39-oci-cli

Oracle Linux 8

Si utiliza Oracle Linux 8, puede usar dnf para instalar la CLI.

Nota

Recomendamos encarecidamente ejecutar sudo dnf update con regularidad para garantizar que el sistema esté actualizado mediante la instalación de los RPM actualizados disponibles.

Para utilizar dnf para instalar la CLI:

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

La CLI se instalará en los paquetes del sitio de Python:

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

La documentación y los ejemplos se instalarán en el directorio /usr/share/doc/python36-oci-cli-<version>/.

Para desinstalar la CLI:

sudo dnf remove python36-oci-cli

Oracle Linux 7

Si utiliza Oracle Linux 7, puede utilizar yum para instalar la CLI.

Para utilizar yum para instalar la CLI:

sudo yum install python36-oci-cli

La CLI se instalará en los paquetes del sitio de Python:

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

La documentación y los ejemplos se instalarán en el directorio /usr/share/doc/python36-oci-cli-<version>/.

Para desinstalar la CLI:

sudo yum remove python36-oci-cli

Mac OS

Puede utilizar Homebrew para instalar, actualizar y desinstalar la CLI en Mac OS.

Para instalar la CLI en Mac OS con Homebrew:

brew update && brew install oci-cli

Para actualizar la instalación de la CLI en Mac OS mediante Homebrew: 

brew update && brew upgrade oci-cli

Para desinstalar la CLI en Mac OS mediante Homebrew: 

brew uninstall oci-cli

Windows

Puede instalar la CLI en Windows mediante el instalador MSI o mediante PowerShell.

Para instalar la CLI en Windows mediante el instalador MSI:
Nota

El instalador de la CLI de MSI sobrescribirá las versiones existentes de la CLI en el sistema Windows. Si necesita instalar varias versiones de la CLI, para las instalaciones posteriores, cree un entorno virtual y use el método de instalación manual. Para obtener más información, consulte Instalaciones manuales y fuera de línea.
  1. Descargue el instalador MSI de la CLI de OCI para Windows desde GitHub.
  2. Ejecute el ejecutable del instalador descargado.
  3. Seleccione el directorio local del sistema en el que desea instalar la CLI y, a continuación, haga clic en Next (Siguiente).
  4. Cuando termine el instalador, haga clic en Terminar.

Para instalar la CLI en Windows mediante PowerShell:

  1. Abra la consola de PowerShell con la opción Ejecutar como administrador.

  2. El instalador permite la terminación automática al instalar y ejecutar un script. Para permitir la ejecución de este script, debe activar la política de ejecución RemoteSigned.

    Para configurar la política de ejecución remota para PowerShell, ejecute el siguiente comando.

    Set-ExecutionPolicy RemoteSigned
  3. Fuerce a PowerShell a utilizar TLS 1.2 para Windows 2012 y Windows 2016:
    [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
  4. Descargar el script del instalador:
    Invoke-WebRequest https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.ps1 -OutFile install.ps1
  5. Ejecute el script del instalador con o sin peticiones de datos:
    1. Para ejecutar el script del instalador con peticiones de datos, ejecute el siguiente comando:
      iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.ps1'))

      ...y responda a las peticiones de datos del script de instalación.

    2. Para ejecutar el script del instalador sin preguntar al usuario, aceptando la configuración por defecto, ejecute el siguiente comando:
      ./install.ps1 -AcceptAllDefaults

Linux y Unix

Nota

El script del instalador instala automáticamente la CLI y sus dependencias, Python y virtualenv. Antes de ejecutar el instalador, asegúrese de cumplir los requisitos.
Nota

Oracle Linux 8 y Oracle Linux Cloud Developer 7 tienen la CLI preinstalada.
  1. Abra un terminal.
  2. Para ejecutar el script del instalador, ejecute el siguiente comando:
    bash -c "$(curl -L https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.sh)"
    Nota

    Para ejecutar una instalación silenciosa que acepte todos los valores por defecto sin peticiones de datos, utilice el parámetro --accept-all-defaults.
  3. Responda a las peticiones de datos del script de instalación.

Otros entornos

Para instalar la CLI en un entorno que no se muestre aquí, consulte Instalaciones manuales y fuera de línea.

Verificación de la instalación de la CLI de OCI

  1. Desde un símbolo del sistema, ejecute el siguiente comando:
    oci --version

Peticiones de datos del script de instalación

El script de instalación le solicita la siguiente información.

  • Si no tiene instalada una versión compatible de Python:
    • Windows y Linux: se le solicitará que proporcione una ubicación para instalar los binarios y ejecutables. El script instalará Python.
    • MacOS: se le notificará que la versión de Python no es compatible. Debe actualizar para continuar con la instalación. El script no instalará Python.
  • Cuando se le solicite que actualice CLI a la versión más reciente, responda Y para sobrescribir una instalación existente.
  • Cuando se le solicite que actualice la RUTA DE ACCESO, responda Y para poder llamar a CLI sin proporcionar la ruta de acceso completa al ejecutable. Así se agregará oci.exe a su RUTA DE ACCESO.

Configuración del archivo de configuración

Antes de usar la CLI, debe crear un archivo de configuración que contenga las credenciales necesarias para trabajar con Oracle Cloud Infrastructure. Puede crear este archivo mediante un cuadro de diálogo de configuración o manualmente con un editor de texto.

Uso del cuadro de diálogo de configuración

Para que la CLI le guíe a través del primer proceso de configuración, utilice el comando setup config:
oci setup config
Este comando le solicita la información necesaria para crear el archivo de configuración y las claves públicas y privadas de API. El cuadro de diálogo de configuración utiliza esta información para generar un par de claves de API y crea el archivo de configuración. Una vez creadas las claves de API, cargue la clave pública utilizando la consola.

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

Configuración manual

Si desea configurar las claves públicas/privadas de API y escribir su propio archivo de configuración, consulte Archivo de configuración SDK y CLI.

Consejo

Utilice el comando oci setup keys para generar un par de claves e incluirlas en el archivo de configuración.

Verificación del archivo de configuración

Asegúrese de que el archivo de configuración esté completo

Un archivo de configuración adecuado debe tener al menos un nombre de perfil (como [DEFAULT]) y las entradas especificadas en la sección Entradas de archivo: usuario, huella, archivo de claves, tenencia, región y una frase de contraseña opcional.

Nota

Consulte la sección Ejemplo de configuración para ver un archivo de configuración de ejemplo.

Confirmación de su información de usuario y de la información de su huella

Para confirmar su información de usuario y la información de su huella, inicie sesión en la consola de OCI, abra el menú de perfil en la parte superior derecha y, a continuación, seleccione su nombre de usuario.

Una vez que haya seleccionado el nombre de usuario, verá su OCID en el panel Información de usuario. Este OCID debe ser la entrada de usuario del archivo de configuración.

Para buscar la huella, vaya a la sección Claves de API de la columna Recursos en la parte inferior izquierda.

Adición de comentarios al archivo de configuración

Asegúrese de no añadir comentarios dentro de la línea en el archivo de configuración. Añada todos los comentarios en una línea nueva. Por ejemplo:
[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

Otros Métodos de Autenticación

La CLI también admite autenticación basada en token, principal de instancia y entidad de recurso para algunos servicios. Para obtener más información, consulte Métodos de autenticación de SDK.