Skip to main content

Get required identifiers

Contributors netapp-aoife

You can access the NetApp Console web UI to retrieve the identifiers needed for the workflows.

Note In addition to the Console web user interface, you can also obtain the ID values through the Cloud Volumes ONTAP REST API. See Get supported services for more information.

Get the Console agent identifier

Every Console agent is assigned a unique identifier. You can retrieve the ID for a Console agent and include it in the x-agent-id HTTP request header with each REST API call.

Before you begin

You must have an account for the Console. You created this account when you first logged in to the Console website and it’s displayed at the top of the Console user interface. See Sign up or log in to NetApp Console for more information.

Steps
  1. Navigate to the Console website using a browser:

  2. Sign in using your account credentials for the Console.

  3. Select the Console agents icon in the top right to view the list of available agents.

  4. Select Manage agents.

  5. Select the Console agent ID.

    Example
    uzJbMFKEnuzi2ryLaENbCP52KBTXx0aIclients

  6. You can optionally derive the associated client ID by removing the clients suffix. This ID applies when accessing the agent directly in local mode and not through the SaaS interface.

    Example
    uzJbMFKEnuzi2ryLaENbCP52KBTXx0aI

After you finish

You can use the agent ID in the x-agent-id request header to properly route the request. See the curl examples in the workflows for more information.

Get the account identifier

Several of the workflows require the account identifier. The steps needed to obtain the unique identifier for an account are presented below.

About this task

If you maintain multiple accounts, each is assigned a unique identifier.

Before you begin

You must have an account for the Console. You created this account when you first logged in to the Console website and it’s displayed at the top of the Console user interface. Sign up or log in to NetApp Console.

Steps
  1. Navigate to the Console website using a browser:

  2. Sign in using your account credentials for the Console.

  3. Click the Account drop-down and click Manage Account for the selected account.

  4. In the Overview section copy the Account ID value.