Skip to main content
A newer release of this product is available.

Add or update display names

Contributors netapp-madkat netapp-perveilerk netapp-lhalbert ssantho3
PDFs

You can use this procedure to add or update the display names used for your grid, sites, and nodes. You can rename a single item, multiple items, or even all items at the same time. Defining or updating a display name does not affect StorageGRID operations in any way.

Before you begin

  • From the primary Admin Node, you are signed in to the Grid Manager using a supported web browser.

    Note You can add or update display names from a non-primary Admin Node, but you must be signed in to the primary Admin Node to download a Recovery Package.

  • You have the Maintenance or Root access permission.

  • You have the provisioning passphrase.

  • You understand the requirements and best practices for display names. See Rename grid, sites, and nodes: Overview.

How to rename grid, sites, or nodes

You can rename your StorageGRID system, one or more sites, or one or more nodes.

You can use a display name that was previously used by a different node, as long as the rename doesn't result in a duplicate display name or system name.

Select items to rename

To start, select the items you want to rename.

Steps

  1. Select MAINTENANCE > Tasks > Rename grid, sites, and nodes.

  2. For the Select names step, select the items you want to rename.

    Item to change Instruction

    Names of everything (or almost everything) in your system

    1. Select Select all.

    2. Optionally clear any items you don't want to rename.

    Name of the grid

    Select the checkbox for the grid.

    Name of a site and some or all of its nodes

    1. Select the checkbox in the table header for the site.

    2. Optionally, clear any nodes you don't want to rename.

    Name of a site

    Select the checkbox for the site.

    Name of a node

    Select the checkbox for the node.

  3. Select Continue.

  4. Review the table, which includes the items you selected.

    • The Display name column shows the current name for each item. If the item has never been renamed, its display name is the same as its system name.

    • The System name column shows the name you entered for each item during installation. System names are used for internal StorageGRID operations and can't be changed. For example, the system name for a node might be its hostname.

    • The Type column indicates the item's type: Grid, Site, or the specific type of node.

Propose new names

For the Propose new names step, you can enter a display name for each item individually, or you can rename items in bulk.

Rename items individually

Follow these steps to enter a display name for each item you want to rename.

Steps

  1. In the Display name field, enter a proposed display name for each item in the list.

    See Rename grid, sites, and nodes: Overview to learn the naming requirements.

  2. To remove any items you don't want to rename, select X icon in the Remove from list column.

    If you will not be proposing a new name for an item, you must remove it from the table.

  3. When you have proposed new names for all items in the table, select Rename.

    A success message appears. The new display names are now used throughout Grid Manager.

Rename items in bulk

Use the bulk rename tool if item names share a common string that you want to replace with a different string.

Steps

  1. For the Propose new names step, select Use bulk rename tool.

    The Rename preview includes all items that were shown for the Propose new names step. You can use the preview to see how display names will look after you replace a shared string.

  2. In the Existing string field, enter the shared string you want to replace. For example, if the string you want to replace is Data-Center-1, enter Data-Center-1.

    As you type, your text is highlighted wherever it is found in the names on the left.

  3. Select X icon to remove any items that you don't want to rename with this tool.

    For example, suppose you want to rename all nodes that contain the string Data-Center-1, but you don't want to rename the Data-Center-1 site itself. Select X icon to remove the site from the rename preview.

    Bulk rename tool before

  4. In the New string field, enter the replacement string you want to use instead. For example, enter DC1.

    See Rename grid, sites, and nodes: Overview to learn the naming requirements.

    As you enter the replacement string, the names on the left are updated, so you can verify that the new names will be correct.

    Bulk rename tool after

  5. When you are satisfied with the names shown in the preview, select Add names to add the names to the table for the Propose new names step.

  6. Make any additional changes required, or select X icon to remove any items that you don't want to rename.

  7. When you are ready to rename all items in the table, select Rename.

    A success message is shown. The new display names are now used throughout Grid Manager.

Download the recovery package

When you are done renaming items, download and save a new Recovery Package. The new display names for the items you renamed are included in the Passwords.txt file.

Steps

  1. Enter the provisioning passphrase.

  2. Select Download Recovery Package.

    The download starts immediately.

  3. When the download completes, open the Passwords.txt file to see the server name for all nodes and the display names for any renamed nodes.

  4. Copy the sgws-recovery-package-id-revision.zip file to two safe, secure, and separate locations.

    Important The Recovery Package file must be secured because it contains encryption keys and passwords that can be used to obtain data from the StorageGRID system.

  5. Select Finish to return to the first step.

Revert display names back to system names

You can revert a renamed grid, site, or node back to its original system name. When you revert an item back to its system name, Grid Manager pages and other StorageGRID locations no longer show a Display name for that item. Only the item's system name is shown.

Steps

  1. Select MAINTENANCE > Tasks > Rename grid, sites, and nodes.

  2. For the Select names step, select any items you want to revert back to system names.

  3. Select Continue.

  4. For the Propose new names step, revert display names back to system names individually or in bulk.

    Revert to system names individually

    1. Copy each item's original system name and paste it into the Display name field, or select X icon to remove any items you don't want to revert.

      To revert a display name, the system name must appear in the Display name field, but the name is case insensitive.

    2. Select Rename.

      A success message appears. The display names for these items are no longer used.

    Revert to system names in bulk

    1. For the Propose new names step, select Use bulk rename tool.

    2. In the Existing string field, enter the display name string you want to replace.

    3. In the New string field, enter the system name string you want to use instead.

    4. Select Add names to add the names to the table for the Propose new names step.

    5. Confirm that each entry in the Display name field matches the name in the System name field. Make any changes or select X icon to remove any items that you don't want to revert.

      To revert a display name, the system name must appear in the Display name field, but the name is case insensitive.

    6. Select Rename.

      A success message is shown. The display names for these items are no longer used.

  5. Download and save a new Recovery Package.

    Display names for the items you reverted are no longer included in the Passwords.txt file.