Archivo de configuración de SDK y CLI

Los SDK y la CLI de Oracle Cloud Infrastructure requieren información de configuración básica, como las credenciales de usuario y el OCID de arrendamiento. Puede proporcionar esta información:

Usando un archivo de configuración
Declarando una configuración en tiempo de ejecución

Nota

Puede utilizar la consola para ayudarle a generar un archivo de configuración. Para obtener más información, consulte Generación de una clave de firma de API (consola).

Los SDK soportan completamente ambas opciones. Consulte la documentación de cada SDK para obtener información sobre el objeto de configuración y cualquier excepción al utilizar un archivo de configuración:

La CLI necesita un archivo de configuración, pero también permite definir variables de entorno para proporcionar cierta información. Para obtener más información, consulte Variables de entorno de CLI.

Nombre y ubicación del archivo

El nombre y la ubicación del archivo de configuración por defecto es ~/.oci/config.

Nota

En Windows, puede utilizar PowerShell para crear la carpeta con el siguiente comando: mkdir %HOMEDRIVE%%HOMEPATH%\.oci. El explorador de archivos no soporta la creación de nombres de carpeta que empiecen por un punto.

Entradas de archivo

En la siguiente tabla se enumeran las entradas básicas necesarias para el archivo de configuración y se indica dónde obtener la información necesaria.


Entrada	Descripción y lugar en el que obtener el valor	¿Necesaria?
`user`	OCID del usuario que llama a la API. Para obtener el valor, consulte Claves y OCID necesarios. Ejemplo: `ocid1.user.oc1..<unique_ID>`(acortado para abreviar)	Sí
`fingerprint`	Huella para la clave pública que se ha agregado a este usuario. Para obtener el valor, consulte Claves y OCID necesarios.	Sí
`key_file`	Ruta de acceso completa y nombre de archivo de la clave privada. Importante: el par de claves debe estar en formato PEM. Para obtener instrucciones sobre la generación de un par de claves en formato PEM, consulte Claves y OCID necesarios. Ejemplo (Linux/Mac OS): `~/.oci/oci_api_key.pem` Ejemplo (Windows): `~/.oci/oci_api_key.pem` Esto corresponde al archivo `%HOMEDRIVE%%HOMEPATH%\.oci\oci_api_key.pem`.	Sí
`pass_phrase`	Contraseña utilizada para la clave, si está cifrada. Atención: Esta entrada está en desuso y solo se incluye por motivos de compatibilidad con versiones anteriores. Evite guardar información confidencial en el archivo de configuración. Para obtener más seguridad, transfiera la frase de contraseña al SDK o la CLI en tiempo de ejecución.	Sí, si la clave está cifrada y la frase de contraseña no se ha configurado para que se transfiera en tiempo de ejecución.
`tenancy`	OCID de su arrendamiento. Para obtener el valor, consulte Claves y OCID necesarios. Ejemplo: `ocid1.tenancy.oc1..<unique_ID>`	Sí
`region`	Región de Oracle Cloud Infrastructure. Consulte Regiones y dominios de disponibilidad. Ejemplo: `us-ashburn-1`	Sí
`security_token_file`	Este parámetro es obligatorio se utiliza la autenticación con token de sesión. Cuando se utiliza este método de autenticación, la huella, el usuario y la frase de contraseña no son necesarios. Al iniciar una sesión con la CLI de OCI, se rellenarán todos los parámetros obligatorios de este método de autenticación. Consulte Inicio de una sesión de CLI basada en token.	Condicional

Valores personalizados

Algunos SDK de Oracle Cloud Infrastructure soportan la definición de valores personalizados en el archivo de configuración. Consulte la documentación de cada SDK para obtener más información.

Perfiles y herencia

Puede crear varios perfiles con distintos valores para estas entradas y, a continuación, especificar el perfil que desea cargar.

Algunos SDK de Oracle Cloud Infrastructure necesitan un perfil DEFAULT y soportan la herencia de perfiles. Esto significa que cualquier valor que no se haya definido explícitamente para un perfil determinado se hereda del perfil DEFAULT. Consulte la documentación de cada SDK para obtener más información.

Ejemplo de configuración

En el siguiente ejemplo (para Linux y Mac OS) se muestran los valores clave de un archivo de configuración y cómo definir perfiles para un SDK que soporte la herencia de perfiles.

[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>
region=us-ashburn-1

[ADMIN_USER]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=keys/admin_key.pem
pass_phrase=<your_passphrase>

Este ejemplo es para Windows:

[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=%HOMEPATH%\.oci\oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>
region=us-ashburn-1

[ADMIN_USER]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<your_fingerprint>
key_file=keys\admin_key.pem
pass_phrase=<your_passphrase>