Gerencie chaves de licença por meio da API.

Use a API do Ops Manager para verificar o status da chave de licença da sua instalação do Ops Manager e para instalar ou liberar uma chave de licença. Para saber como o Ops Manager calcula o status da chave de licença, consulte Visão geral das chaves de licença do Ops Manager. Para gerenciar as chaves de licença na interface do Ops Manager, consulte Gerenciar chaves de licença no Ops Manager.

Pré-requisitos

Antes de começar, certifique-se de ter o seguinte:

An API key with the Global Owner role.
Um arquivo de chave de licença que você gerou no Portal de Chaves. Para saber como, consulte Gerenciar Chaves de Licença no Ops Manager.

Instalar uma chave de licença

Utilize o procedimento a seguir para instalar uma chave de licença e confirmar se o Ops Manager a aplicou.

Verifique o status atual da chave de licença.

Send a GET request to the /admin/licenses endpoint:

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"

The response includes the enforcement.effectiveState field and the licenses array. For a description of each field, see Get the License Key Status of an Installation.

Instale a chave de licença.

Send a PUT request to the /admin/licenses endpoint. Use the contents of your license key file as the request body:

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}

Se o Ops Manager aceitar a chave de licença, ele recalculará o status e o retornará. Se o Ops Manager rejeitar a chave de licença, a resposta conterá um erro. Para resolver um erro, consulte a seção Solução de problemas de erros de instalação.

Confirme o status da nova chave de licença.

Na resposta da etapa anterior, verifique os seguintes campos:

enforcement.effectiveState é LICENSED.
The new license key appears in the licenses array with a status of ACTIVE.

Se o estado não for o esperado, chame o endpoint "Recalcular o Status da Chave de Licença Sob Demanda" para recalcular o status e, em seguida, verifique os campos novamente.

Liberar chave de licença

Utilize o procedimento a seguir para liberar uma chave de licença da sua instalação do Ops Manager.

Importante

After you release a license key, you can't use it again. If you release the only usable license key, your installation has no coverage. The state changes to GRACE, and then to UNLICENSED after 90 days.

Encontre o ID da chave de licença.

Send a GET request to the /admin/licenses endpoint. In the response, copy the artifactId value of the license key that you want to release.

Libere a chave de licença.

Send a DELETE request to the /admin/licenses/{artifactId} endpoint. Replace {ARTIFACT-ID} with the artifactId value:

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"

O Ops Manager recalcula o status e o retorna. Para saber mais, consulte Liberar uma chave de licença no Ops Manager.

Recuperar o ID do Gerenciador de Chaves

The Key Manager ID identifies your Ops Manager installation, including every instance in a high-availability setup. The API returns the Key Manager ID in the holderId field. To retrieve it, send a GET request to the /admin/artifacts/identity endpoint. To learn more, see Get the Key Manager ID of an Installation.

Gire a chave de identidade.

A sua instalação do Ops Manager gera uma chave de identidade: um par de chaves que a instalação usa para comprovar sua identidade ao se conectar ao MongoDB. Se você suspeitar que alguém fora da sua organização obteve a chave privada, rotacione a chave para substituí-la por um novo par de chaves. Sua instalação precisa conseguir se conectar ao MongoDB para que a rotação da chave seja realizada. Para saber mais, consulte Rotacionar a chave de identidade de uma instalação.

Solução de problemas de erros de instalação

When Ops Manager rejects a license key, the response has an HTTP status of 400, 403, or 409 and a JSON body that describes the error. The following fields identify the error:

Campo	Descrição
`errorCode`	Error code, such as `ARTIFACT_OUTDATED`.
`detail`	Mensagem que descreve o erro e como proceder.

Para obter a lista de códigos de erro, status HTTP e mensagens, consulte Solucionar problemas de erros de instalação.

Páginas relacionadas

Para obter mais informações sobre chaves de licença, consulte as páginas a seguir:

Voltar

Gerencie as chaves de licença no Ops Manager.

API