Manage Registration Keys

Managing your registration keys involves creating, downloading, and revoking the keys.

About Registration Keys

A registration key is issued against your identity domain, and it’s used when you deploy cloud agents.

You can create a new registration key and use that key for installing a new agent by specifying the AGENT_REGISTRATION_KEY=<NewKeyValue> parameter in the response file. The registration key is only used during installation. Once an agent is installed with the registration key, that key can be removed from Oracle Management Cloud.

A registration key can exist in three states:
  • VALID: The registration key is valid, and it can be used to run the installation script.

  • EXPIRED: The registration key’s usage count is greater or equal to the maximum usage specified at the time of creating the key.

  • DISABLED: The registration key is explicitly set to be in the disabled state by calling a Cloud Service REST API.

Create a Registration Key

To create a registration key:

  1. On the Oracle Management Cloud home page, click the global navigation menu on the top left, then click Agents under Administration.

  2. On the Oracle Management Cloud Agents page, click the Registration keys tab.

    The Registration Keys page displays a list of all registration keys.

  3. Enter the required details in the Registration Keys page:

    1. In the Name field, specify a name to identify the registration key.

    2. In the Registration Limit field, enter a number that indicates the maximum number of agents, data collectors, and gateways that can be associated with the registration key.

    3. Click Create New Key.

    A new registration key is created. You can now pass the value of this key to the AgentInstall script at the time of installation.

Download a Registration Key

You can download a registration key from the Oracle Management Cloud Agents page.

  1. In the Oracle Management Cloud Agents page, click Registration Keys on the left navigation pane.

    The Registration Keys page displays a list of all registration keys.

  2. From the list of registration keys, select the key that you want to download.

  3. On the right side of the page, click the actions menu and select Download.

    A text file registrationKey.txt that contains the value of the registration key is downloaded to your local drive.

  4. To view the key value, open the registrationKey.txt file.

Revoke a Registration Key

You can revoke a registration key when you feel that any unauthorized user has obtained the value of a key.

To revoke a key:

  1. In the Oracle Management Cloud Agents page, click Registration Keys on the left navigation pane.

    The Registration Keys page displays a list of all registration keys.

  2. From the list of registration keys, click the registration key that you want to revoke.

  3. On the right side of the page, click the actions menu and select Revoke.