Gestionar las claves de licencia a través de la API

Utiliza la API Ops Manager para comprobar el estado de la clave de licencia de tu instalación de Ops Manager y para instalar o liberar una clave de licencia. Para saber cómo Ops Manager calcula el estado de las claves de licencia, consulta Resumen de Claves de Licencia Ops Manager. Para gestionar claves de licencia en la interfaz Ops Manager, consulta Gestionar Claves de Licencia en Ops Manager.

Requisitos previos

Antes de comenzar, asegúrate de tener lo siguiente:

Una clave API con el rolGlobal Owner.
Un archivo de clave de licencia que has generado en el Portal de Claves. Para saber cómo, consulta Gestionar Claves de Licencia en Ops Manager.

Instalar una clave de licencia

Utiliza el siguiente procedimiento para instalar una clave de licencia y confirma que Ops Manager la aplica.

Comprobar el estado actual de la clave de licencia

Envía una solicitud GET al endpoint /admin/licenses :

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \     --header "Accept: application/json" \     --include \     --request GET \     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/licenses?pretty=true"

La respuesta incluye el campo enforcement.effectiveState y el array licenses . Para una descripción de cada campo, consulte Obtener el estado de la clave de licencia de una instalación.

Instala la clave de licencia

Envía una solicitud PUT al endpoint /admin/licenses . Utiliza el contenido de tu archivo de clave de licencia como cuerpo de la solicitud:

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \     --header "Accept: application/json" \     --header "Content-Type: application/json" \     --include \     --request PUT \     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/licenses?pretty=true" \     --data @{LICENSE-KEY-FILE}

Si Ops Manager acepta la clave de licencia, Ops Manager recalcula el estado y la devuelve. Si Ops Manager rechaza la clave de licencia, la respuesta contiene un error. Para resolver un error, consulte Troubleshooting Install Errors.

Confirma el estado de la nueva clave de licencia

En la respuesta del paso anterior, revisa los siguientes campos:

enforcement.effectiveState es LICENSED.
La nueva clave de licencia aparece en el array de licenses con un status de ACTIVE.

Si el estado no es el que esperas, llama al endpoint Recompute the License Key Status on Demand para recalcular el estado y luego revisa los campos de nuevo.

Liberar una clave de licencia

Utiliza el siguiente procedimiento para liberar una clave de licencia desde tu instalación de Ops Manager.

Importante

Después de liberar una clave de licencia, no puedes usarla de nuevo. Si liberas la única clave de licencia utilizable, tu instalación no tiene cobertura. El estado cambia a GRACE, y luego a UNLICENSED después de 90 días.

Encuentra el ID de la clave de licencia

Envía una solicitud GET al endpoint /admin/licenses . En la respuesta, copia el valor artifactId de la clave de licencia que quieres liberar.

Libera la clave de licencia

Envía una petición DELETE al endpoint /admin/licenses/{artifactId} . Sustituye {ARTIFACT-ID} por el valor artifactId :

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \     --header "Accept: application/json" \     --include \     --request DELETE \     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/licenses/{ARTIFACT-ID}?pretty=true"

Ops Manager recalcula el estado y lo devuelve. Para obtener más información, consulta Liberar una clave de licencia desde Ops Manager.

Recuperar el ID del Gestor de Claves

El ID del Gestor de Claves identifica tu instalación del Gestor de Operaciones, incluyendo todas las instancias en una configuración de alta disponibilidad. La API devuelve el ID del Gestor de Claves en el campo holderId . Para recuperarlo, envía una solicitud GET al punto final /admin/artifacts/identity . Para más información, consulta Obtener el ID del Gestor de Claves de una Instalación.

Rotar la clave identidad

Tu instalación de Ops Manager genera una clave de identidad: un par de claves que la instalación utiliza para demostrar su identidad cuando se conecta a MongoDB. Si sospechas que alguien externo a tu organización obtuvo la clave privada, rota la clave para reemplazarla por un nuevo par de claves. Tu instalación debe poder conectarse a MongoDB para rotar la clave. Para obtener más información, consulta Rotar la clave de identidad de una instalación.

Errores de instalación de solución de problemas

Cuando Ops Manager rechaza una clave de licencia, la respuesta tiene un estado HTTP de 400, 403o 409 y un cuerpo JSON que describe el error. Los siguientes campos identifican el error:

Campo	Descripción
`errorCode`	Código de error, como `ARTIFACT_OUTDATED`.
`detail`	Mensaje que describe el error y cómo proceder.

Para la lista de códigos de error, estados HTTP y mensajes, consulte Solucionar errores de instalación.

Páginas relacionadas

Para más información sobre las claves de licencia, consulte las siguientes páginas:

Volver

Gestionar las llaves de licencia en Ops Manager

API