Maintain the Bare Metal Solution environment

After your Bare Metal Solution environment is up and running, use the information included in this guide to maintain your Bare Metal Solution servers, storage, and networking.

If you are running SAP HANA in your Bare Metal Solution environment, then see the SAP HANA on Bare Metal Solution planning guide.

Set up your Google Cloud project to use the Bare Metal Solution API

The Bare Metal Solution API provides many tools that let you monitor and maintain your Bare Metal Solution environment. Typically, you only need to use this procedure the first time you use the Bare Metal Solution API. However, reuse these instructions as needed for troubleshooting purposes in case the API does not respond as expected.

1. Assign the Bare Metal Solution Admin or Bare Metal Solution Editor predefined IAM role to your principals. To learn how to map IAM roles, see Grant an IAM role.

2. Enable the Bare Metal Solution API in your Google Cloud project.

   Console

   1. Go to the Bare Metal Solution API in your Google Cloud console dashboard. You can also search for the Bare Metal Solution API in the API Library here: APIs & Services > Library.
   2. On the Bare Metal Solution API page, click Enable.
   3. Click the Back button on your browser. If you see a green checkmark next to the words API Enabled, you can use the API.

   gcloud

   • To enable the Bare Metal Solution API through gcloud, enter your gcloud CLI project ID in the following command, copy the command, paste it into the Cloud Shell prompt, and press the Enter or Return key:

      gcloud services enable baremetalsolution.googleapis.com --project=PROJECT_ID
      

3. Allow the Google Cloud CLI to work with your Google Cloud project.

   1. In your Cloud Shell window, enter the gcloud auth login command.

      gcloud auth login
      

   2. Copy the resulting URL and paste it into a separate browser tab or window.
   3. Log in to the page by using your username associated with your Google Cloud project.
   4. Click Allow to enable the gcloud CLI.
   5. Copy the authorization code.
   6. Paste the code into your Cloud Shell client command line.
   7. Press the Enter or Return key.

For additional information about the general steps required to set up an API in Google Cloud, see: Getting Started with Google Cloud APIs.

Operate your Bare Metal Solution server

You can perform the following operations on your Bare Metal Solution server:

• Start—Turns the power on for the server.
• Stop—Turns the power off for the server.

• Reset—Restarts the server.

Because starting, stopping, and restarting a server takes a while to complete, you can check the status by following the steps in View the status of a long-running operation.

Check the status of a server

A server transitions through many states as a part of its lifecycle. When you start a server, Bare Metal Solution provisions the resources for the server. Next, the server prepares for the boot sequence. After the server starts up, the server moves to the running state. During its normal operation, you can stop and restart a running server.

A server can be in one of the following states:

• PROVISIONING: Resources are allocated for the server. The server is not running yet.

• STARTING: Resources are acquired. The server is booting up.

  The boot operation usually takes 30 minutes, after which the server state is set to RUNNING.

• RUNNING: The server is up and running.

  If the server state is RUNNING, but you're unable to use the server, it might still be booting up. This might happen if your server is large or has many storage volumes and LUNs. For more information, see Server takes a long time to boot.

• STOPPING: The server is stopping.

• SHUTDOWN: The server is stopped and powered off.

• DELETED: The server is deleted.

gcloud bms instances describe --project=PROJECT_ID --region=REGION SERVER_NAME

state: RUNNING

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/instances/SERVER_NAME"

"state" : "RUNNING"

Manage resources in your Bare Metal Solution environment

Bare Metal Solution management APIs, gcloud commands, and the Google Cloud console enable you to view the status of the resources in your Bare Metal Solution environment, such as servers, networking, and storage.

Make sure you set up the Bare Metal Solution API

Viewing resource status requires you to enable the Bare Metal Solution API and the gcloud CLI. You also need to grant one of the Bare Metal Solution IAM roles to your principals, such as Bare Metal Solution Admin or Bare Metal Solution Editor. To complete the API set up steps prior to managing your resources, see Set up your Google Cloud project to use the Bare Metal Solution API.

List Bare Metal Solution resources in an organization and folder

Sometimes, you might need to view your Bare Metal Solution resources at an organization level or a folder level. To list resources at an organization or folder level, you need the IAM permissions to list those resources at the corresponding level.

To learn how to grant IAM permissions to a user, see Access control for organization resources with IAM.

Following is a sample Python script that lists storage volumes in an organization or a folder. You can modify this sample script as per your requirements and use it. For example, by using a filter such as attached=false, you can list all the unattached storage volumes.

To list storage volumes at the organization level using this script, you need the following IAM permissions at the organization level:

• resourcemanager.folders.get
• resourcemanager.folders.list
• resourcemanager.organizations.get
• resourcemanager.projects.get
• resourcemanager.projects.list
• baremetalsolution.volumes.list
• baremetalsolution.luns.list

#!/usr/bin/env python

# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


# This file is automatically generated. Please do not modify it directly.
# Find the relevant recipe file in the samples/recipes or samples/ingredients
# directory and apply your changes there.

from typing import Sequence
from typing import Tuple
from absl import app
from absl import flags
from google.api_core.exceptions import PermissionDenied
from google.cloud import resourcemanager_v3
from google.cloud.bare_metal_solution_v2.services.bare_metal_solution import BareMetalSolutionClient
from google.cloud.bare_metal_solution_v2.types import ListVolumesRequest


_ORGANIZATION_ID = flags.DEFINE_string(
    "organization-id",
    None,
    "Your organization id retrieved from its name:"
    " organizations/<organization-id>.",
)
_FOLDER_ID = flags.DEFINE_string(
    "folder-id",
    None,
    "Your folder id retrieved from its name: folders/<folder-id>.",
)
_FILTER = flags.DEFINE_string(
    "filter",
    "",
    "Filter for the resource list request. Syntax should be per"
    " https://google.aip.dev/160",
)


def get_projects(
    parent: str,
    folders_client: resourcemanager_v3.FoldersClient,
    projects_client: resourcemanager_v3.ProjectsClient,
) -> str:
  """Retrieves a list of all project IDs available in given organization or folder parent.

  Args:
      parent: Organization ID or Folder ID of the Cloud org or folder you want
        to recursively list project IDs from.
      folders_client: Resource manager folder API client.
      projects_client: Resource manager project API client.

  Yields:
      The list of project ids as a string.
  """
  projects_request = resourcemanager_v3.ListProjectsRequest(parent=parent)
  for project in projects_client.list_projects(request=projects_request):
    yield project.project_id

  folders_request = resourcemanager_v3.ListFoldersRequest(parent=parent)
  for folder in folders_client.list_folders(request=folders_request):
    get_projects(folder.name, folders_client, projects_client)


def get_volumes_list(parent: str, filter: str) -> Tuple[str, str]:
  """Retrieves a list of all volume names available in given project.

  Args:
      parent: Organization ID or Folder ID of the Cloud org or folder you want
        to recursively list volumes from.
      filter: Filter string for the resource list call. Syntax is per
        https://google.aip.dev/160.

  Returns:
      The list of volumes as a string and the list of PermissionDenied errors in
      individual folder or projects, if any.
  """
  folders_client = resourcemanager_v3.FoldersClient()
  projects_client = resourcemanager_v3.ProjectsClient()
  bms_client = BareMetalSolutionClient()
  output = []
  errors = []

  try:
    for project in get_projects(parent, folders_client, projects_client):
      volumes_list_request = ListVolumesRequest(
          parent="projects/" + project + "/locations/global",
          filter=filter,
      )
      try:
        for volume in bms_client.list_volumes(request=volumes_list_request):
          output.append(f" -  {volume.name}")
      # This could happen because BMS API is not enabled in a certain project.
      except PermissionDenied as e:
        errors.append(
            f"Unable to list bms resources for project {project}: {e}"
        )
  except PermissionDenied as e:
    errors.append(f"Unable to access folder or project: {e}")
  return "\n".join(output), "\n".join(errors)


def main(_: Sequence[str]):
  if _ORGANIZATION_ID.value is not None and _FOLDER_ID.value is not None:
    raise Exception("Only one of organization ID or folder ID must be provided")
  elif _ORGANIZATION_ID.value is None and _FOLDER_ID.value is None:
    raise Exception(
        "Either one of organization ID or folder ID must be provided"
    )
  elif _ORGANIZATION_ID.value is not None:
    parent = f"organizations/{_ORGANIZATION_ID.value}"
  else:
    parent = f"folders/{_FOLDER_ID.value}"
  volumes, errors = get_volumes_list(parent, filter=_FILTER.value)
  print(
      "=================== Flat list of volumes in the folder or organization"
      " ==================="
  )
  print(volumes)

  print(
      "=================== List of folders or projects with errors"
      " ==================="
  )
  print(errors)


if __name__ == "__main__":
  app.run(main)

Manage servers

You can manage the servers in your Bare Metal Solution environment in the following ways:

• View servers
• Organize servers by using labels
• Rename a server
• Retrieve the initial password for a server
• View OS details
• Change the OS for a server
• Enable hyperthreading on a server

View servers

To view the details of your Bare Metal Solution servers, follow these steps:

Organize servers by using labels

To help organize your servers, you can use labels. Labels are key-value pairs that you can attach to each server, then filter the servers based on their labels. For example, you can use labels to group servers by purpose, environment, location, department, and so on. Labels are optional.

Add or update labels for servers

You can add or update labels for the existing servers.

gcloud bms instances update SERVER_NAME --project=PROJECT_ID --region=REGION --update-labels environment=dev,location=branch

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/instances/SERVER_NAME?updateMask=labels"
 -d "{
  'labels' : {'environment': 'test'}
}"

Remove labels from servers

You can remove labels from the servers.

gcloud bms instances update SERVER_NAME --project=PROJECT_ID --region=REGION --remove-labels=department

gcloud bms instances update SERVER_NAME --project=PROJECT_ID --region=REGION --clear-labels

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/instances/SERVER_NAME?updateMask=labels"
 -d "{
  'labels' : {'environment': 'test'}
}"

Filter servers using labels

You can search your servers and filter results by using labels.

gcloud bms instances list --project=PROJECT_ID --region=REGION --filter labels.environment=dev

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/instances"?filter=labels.environment=test

Rename a server

To rename a server, follow these steps:

gcloud bms instances rename SERVER_NAME --new-name=NEW_NAME --project=PROJECT_ID --region=REGION

Retrieve the initial password for a server

When you first receive your Bare Metal Solution server or change the operating system, the server begins in a default state and has an initial password. You must use this password the first time you gain access to the server. After you enter the initial password, the server prompts you to change the password.

To find your initial password:

View OS details

To view the details of the operating system (OS) of your server, run the gcloud bms os-images describe command to view the OS details.

gcloud bms os-images describe OS_IMAGE --project=PROJECT_ID

Replace the following:

• OS_IMAGE: The OS image code. To get the OS image code for your OS, see Operating systems.
• PROJECT_ID: The project ID.

Example:

gcloud bms os-images describe OEL8x --project=test-project

Following is a sample output:

applicableInstanceTypes:
- o2-highmem-224-metal
- o2-standard-112-metal
- o2-standard-16-metal
- o2-standard-32-metal
- o2-standard-48-metal
code: OEL8x
description: Oracle Linux 8.8 [5.4.17-2136.324.5.3.el8uek.x86_64]
name: projects/bmaas-testing/locations/global/osImages/OEL8x
supportedNetworkTemplates:
- s200-bondaa-bondaa
- s400-bondaa-bondaa

Change the OS for a server

You can reimage a Bare Metal Solution server with a different OS image. Changing the OS image takes a long time to complete and requires a power cycle of the server. To select one of the available OS images, visit Operating systems.

gcloud bms instances update SERVER_NAME --region REGION --os-image=OS_IMAGE

gcloud alpha bms instances update SERVER_NAME --region REGION --os-image=OS_IMAGE --kms-crypto-key-version=KMS_CRYPTO_KEY_VERSION --ssh-keys=KEY_1,KEY_2

gcloud alpha bms instances update server1 --region europe-west3 --os-image=OS_IMAGE --kms-crypto-key-version=projects/bmaas-testing/locations/global/keyRings/e2e-test/cryptoKeys/e2e-test-key/cryptoKeyVersions/1 --ssh-keys=e2e-test-key-1,e2e-test-key-2

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/instances/SERVER_NAME?updateMask=os_image"
 -d "{
  'osImage' : 'OS_IMAGE'
}"

Because this change takes awhile to complete, you can check the status by following the steps in View the status of a long-running operation.

Enable hyperthreading on a server

You can enable or disable hyperthreading on your Bare Metal Solution servers. This action takes a long time to complete and requires a power cycle of the server.

gcloud bms instances update SERVER_NAME --region REGION --enable-hyperthreading

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/instances/SERVER_NAME?updateMask=hyperthreading_enabled"
 -d "{
  'hyperthreadingEnabled' : 'HYPERTHREADING_VALUE'
}"

Because this change takes awhile to complete, you can check the status by following the steps in View the status of a long-running operation.

Manage VRFs

In Bare Metal Solution environment, a VRF (Virtual Routing and Forwarding) is a connecting interface between a client network and VLAN attachments (also known as interconnectAttachments).

Using a VRF, you can map your client network to your VLAN attachments in the following ways:

• Map a single client network to a single VLAN attachment pair through a single VRF. This is the default mapping. When you create a client network through the Google Cloud console intake form, a VRF is created implicitly. This VRF is used to establish a connection from your client network and its VLAN attachment towards Google Cloud.

  

• Map a single client network to multiple VLAN attachments through a single VRF. This way, you can increase the bandwidth between your Bare Metal Solution environment and Google Cloud.

  

• Map multiple client networks using a single VRF to share multiple VLAN attachments. This way, you can increase the bandwidth between your Bare Metal Solution environment and Google Cloud.

  In this mapping, the client networks aren't isolated from each other. They are routed between each other through a common VRF. Therefore, the hosts in these networks can talk to each other without any traffic filtering.

  

• Map multiple client networks to their dedicated VLAN attachments using dedicated VRFs. This way, you can achieve a particular bandwidth for each client network.

  In this mapping, the client networks are isolated from each other. You can't use the VPC network (that is, the Google Cloud network) as a transit between these client networks.

  

You can manage the VRFs and VLAN attachments in your Bare Metal Solution environment in the following ways:

• View VRFs
• Create a VRF
• Delete a VRF
• Add a VLAN attachment pair
• Update a VLAN attachment pair
• Delete a VLAN attachment pair

View VRFs

To view the details of your VRFs, follow these steps:

1. Go to the VRFs page.

   Go to VRFs

   The VRFs page lists all your VRFs with the following details:

   Field	Description
   Status	Indicates the availability of a VRF.
   Name	Name of the VRF. Click the name to view additional information about the VRF. Note: If you did not enter a name when you provisioned your VRF, the ID appears in this field.
   ID	Identifier assigned to your VRF. Click the ID to view additional information about the VRF. Share the ID with Google Cloud support when troubleshooting this resource.
   Region	Region where the VRF is located.
   Pod	Pod that contains your VRF. A pod is a unit of isolation that contains your Bare Metal Solution resources. Resources in different pods cannot be connected. A region can have multiple pods. The Pod column is disabled by default. To enable it, do the following: Click Column display optionsview_column. Select the Pod checkbox. Click OK. If you don't want to enable the Pod column, you can view the pod of a VRF by clicking the VRF name or ID.

2. To see the additional details about a VRF, click the Name or ID of the VRF.

   The VRF details page shows the following additional details:

   Field	Description
   VLAN attachment pairs	Details of the VLAN attachment pairs associated with the VRF, such as peer IP, router IP, and bandwidth.
   Member networks	List of networks associated with the VRF. You can view the details of a network by clicking it.

Create a VRF

When you provision a new network through the Google Cloud console intake form, a VRF is created implicitly. However, you can also create more VRFs afterwards.

To create a new VRF, follow these steps:

1. Go to the VRFs page.

   Go to VRFs

2. Click Create.

3. Enter a name for the VRF.

4. In the Region list, select a region for the VRF.

5. In the Pod list, select a pod for the VRF.

   The Pod drop-down list also shows the number of your existing Bare Metal Solution resources in each pod of the selected location.

   If you're unsure about which pod to select, contact Google Cloud Sales.

6. Add VLAN attachment pairs.

   While creating a VRF, you can only add one VLAN attachment pair. You can add more VLAN attachment pairs after you have created the VRF by following the steps in Add a VLAN attachment pair.

   1. Click Add a VLAN attachment pair.
   2. From the Bandwidth list, select the amount of bandwidth that you want to allocate to the VLAN attachment pair.
   3. To add a VLAN attachment pair from the current project:
      1. Select the Select VLAN attachments from your current project checkbox.
      2. In the First VLAN attachment ID field, enter the ID of the first VLAN attachment and in the Second VLAN attachment ID field, enter the ID of the second VLAN attachment.

   4. To add a VLAN attachment pair from different project:

      1. In the project that contains your VLAN attachments, perform the following one-time actions before adding VLAN attachments in the next steps. If you've already done this, skip these actions.
         1. Enable the Bare Metal Solutions API
         2. Go to any Bare Metal Solution page in the Google Cloud console or run any Bare Metal Solution Bare Metal Solution gcloud command
         3. For more information check Google Cloud console intake form.
      2. Clear the Select VLAN attachments from your current project checkbox.

      3. In the First VLAN attachment ID field, enter the ID of the first VLAN attachment and in the Second VLAN attachment ID field, enter the ID of the second VLAN attachment. Enter the VLAN attachments in the following format

         projects/PROJECT_ID/regions/INTERCONNECT_REGION/interconnectAttachments/VLAN_ATTACHMENT_NAME
         

   5. Click Done.

7. Click Create.

Delete a VRF

Before deleting a VRF, you must delete all its VLAN attachment pairs and attached networks. See Delete a VLAN attachment pair and Delete a network.

To delete a VRF, follow these steps:

1. Go to the VRFs page.

   Go to VRFs

2. Select the VRF to delete.

3. Click Delete.

4. Click Confirm.

Manage VLAN attachments

You can manage your VLAN attachment pairs in the following ways:

• Add a VLAN attachment pair
• Update a VLAN attachment pair
• Delete a VLAN attachment pair

Add a VLAN attachment pair

A VRF can have multiple VLAN attachment pairs. However, a VLAN attachment can only be paired with one VRF.

For a Bare Metal Solution network, we recommend that you create VLAN attachments in pairs for high availability.

1. Go to the VRFs page.

   Go to VRFs

2. Click the VRF name.

3. On the VRF details page, in the VLAN Attachment pairs section, click Create.

4. On the New VLAN attachment pair page:

5. From the Bandwidth list, select the amount of bandwidth that you want to allocate to the VLAN attachment pair.

6. To add a VLAN attachment pair from the current project:

   1. Select Select VLAN attachments from your current project checkbox.
   2. In the First VLAN attachment ID field, enter the ID of the first VLAN attachment and in the Second VLAN attachment ID field, enter the ID of the second VLAN attachment.

7. To add VLAN attachment pair from different project:

   1. In the project that contains your VLAN attachments, perform the following one-time actions before adding VLAN attachments in the next steps. If you've already done this, skip these actions.
      1. Enable the Bare Metal Solutions API
      2. Go to any Bare Metal Solution page in the Google Cloud console or run any Bare Metal Solution gcloud command.
      3. For more information check Google Cloud console intake form.
   2. Clear the Select VLAN attachments in your current project checkbox.

   3. In the First VLAN attachment ID field, enter the ID of the first VLAN attachment and in the Second VLAN attachment ID field, enter the ID of the second VLAN attachment. Enter the VLAN attachments in the following format

       projects/PROJECT_ID/regions/INTERCONNECT_REGION/interconnectAttachments/VLAN_ATTACHMENT_NAME
      

8. Click Create.

Because creating a VLAN attachment pair takes a while to complete, you can check the status by following the steps in View the status of a long-running operation.

Update a VLAN attachment pair

You can update only the bandwidth of a VLAN attachment pair.

1. Go to the VRFs page.

   Go to VRFs

2. Click the VRF name.

3. On the VRF details page, in the VLAN Attachment pairs section, select the VLAN attachment pair that you want to update.

4. Click Edit.

5. On the Edit VLAN attachment pair page, do the following:

   1. From the Bandwidth list, select the amount of bandwidth that you want to allocate to the VLAN attachment pair.
   2. Click Save.

Because updating a VLAN attachment pair takes a while to complete, you can check the status by following the steps in View the status of a long-running operation.

Delete a VLAN attachment pair

Deleting a VLAN attachment pair using the steps in this procedure only unlinks a VLAN attachment pair from the VRF and does not actually delete it.

1. Go to the VRFs page.

   Go to VRFs

2. Click the VRF name.

3. On the VRF details page, in the VLAN Attachment pairs section, select the VLAN attachment pair that you want to delete.

4. Click Delete.

Because deleting a VLAN attachment pair takes a while to complete, you can check the status by following the steps in View the status of a long-running operation.

Manage networks

You can manage the networks in your Bare Metal Solution environment in the following ways:

• View networks
• Organize networks by using labels
• Rename a network
• Create a network
• Attach a network to a server
• Detach a network from a server
• Delete a network
• View advanced networking information for a Bare Metal Solution environment
• Implement IP address management in a Bare Metal Solution environment

View networks

Monitoring your network resources in the Bare Metal Solution environment lets you know how your servers connect to other resources.

To view the details of your networks, follow these steps:

Organize networks by using labels

To help organize your networks, you can use labels. Labels are key-value pairs that you can attach to each network, then filter the networks based on their labels. For example, you can use labels to group networks by purpose, environment, location, department, and so on. Labels are optional.

Add or update labels for networks

You can add or update labels for the existing networks.

gcloud bms networks update NETWORK_NAME --project=PROJECT_ID --region=REGION --update-labels environment=dev,location=branch

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/networks/NETWORK_NAME?updateMask=labels"
 -d "{
  'labels' : {'environment': 'test'}
}"

Remove labels from networks

You can remove labels from networks.

gcloud bms networks update NETWORK_NAME --project=PROJECT_ID --region=REGION --remove-labels=department

gcloud bms networks update NETWORK_NAME --project=PROJECT_ID --region=REGION --clear-labels

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/networks/NETWORK_NAME?updateMask=labels"
 -d "{
  'labels' : {'environment': 'test'}
}"

Filter networks using labels

You can search your networks and filter results by using labels.

gcloud bms networks list --project=PROJECT_ID --region=REGION --filter labels.environment=dev

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/networks"?filter=labels.environment=test

Rename a network

To rename a network, follow these steps:

gcloud bms networks rename NETWORK_NAME --new-name=NEW_NAME --project=PROJECT_ID --region=REGION

Create a network

Before creating a network, you must create a VRF. See Create a VRF.

To create a network, follow these steps:

1. Go to the Networks page.

   Go to Networks

2. Click Create.

3. Enter a name for the network.

4. In the Location list, select a region for the network.

5. In the Pod list, select a pod for the network.

   The Pod drop-down list also shows the number of your existing Bare Metal Solution resources in each pod of the selected location.

   If you're unsure about which pod to select, contact Google Cloud Sales.

6. Select the type of the network:

   1. To create a client network, select Client.
   2. To create a private network, select Private.

7. (Applicable only if you selected the Client network type) In the VRF list, select a VRF.

8. In the Network IP address range field, enter the IP address range of the network.

9. (Optional) In the Service IP address range field, enter the service IP address range of the network.

10. Select the MTU for the network:

    1. 1500—For standard sized frames.
    2. 9000—For jumbo frames.

1. Click Save.

Attach a network to a server

You can't attach a network to a server if the IP address range of the network overlaps with another network attached to the server.

To attach a network, follow these steps:

1. Go to the Servers page.

   Go to Servers

2. Click the server name.

3. On the Server details page, click Attach network.

4. On the Attach a network page, do the following:

   1. To select a network from other projects in your organization:
      1. Select the Select networks from other projects in your organization checkbox.
      2. From the Select an existing network list, select a network.

   2. To select a network from the current project:

      1. Clear the Select networks from other projects in your organization checkbox.
      2. From the Select an existing network list, select a network.

   3. Set the interface configuration:

      1. From the Interface list, select a bond interface for this network.

         In most cases, select bond0 for a client network and bond1 for a private network.

      2. In the IP address field, enter an IP address from the network that you are attaching.

5. (Optional) To make this network the default gateway, select the Default gateway checkbox.

6. Click Attach network.

   The server status changes to "Provisioning". Attaching a network is a long-running operation. To check the status, in the Google Cloud console, click notifications Notifications. You can also follow the steps in View the status of a long-running operation. When the operation completes, the server status changes to "Running".

7. Update the OS configuration of your Bare Metal Solution server.

   Once you complete the previous steps for attaching the network through the Google Cloud console and the server status changes to "Running", you must update the OS configuration of your Bare Metal Solution server. If you don't update the OS configuration, the changes made in the Google Cloud console are not implemented completely. The next steps in this procedure show you how to update your OS configuration.

   The next steps are only for example and might vary depending on your OS. Refer to your OS configuration guide if you face any issue.

   RHEL and Oracle Linux

   1. Log in as the root user.

   2. Create a new connection. Run the following command:

      nmcli connection add type vlan con-name INTERFACE_NAME.VLAN_ID  ifname INTERFACE_NAME.VLAN_ID dev INTERFACE_NAME mtu MTU id VLAN_ID ip4 IP_ADDRESS/NETMASK ipv6.method "ignore"
      

      Replace the following:

      • INTERFACE_NAME: The name of the interface to which you want to attach the network. This is the same interface that you selected in Step 6 (Set the interface configuration) of this procedure. You can get the interface name from the Server details page, in the Networks section. See View servers.
      • VLAN_ID: The VLAN ID of the network that you want to attach. You can get the VLAN ID from the Network details page. See View networks.
      • IP_ADDRESS: The IP address of the Bare Metal Solution server in the network. This is the same IP address that you entered in Step 6 (Set the interface configuration) of this procedure. You can get the IP address from the Server details page, in the Networks section. See View servers.
      • NETMASK: The network mask of the network that you want to attach. You can get the network mask from the CIDR field on the Network details page. See View networks.
      • MTU: The MTU of the network that you want to attach. You can get the MTU from the Network details page. See View networks.

      Example:

      nmcli connection add type vlan con-name bond0.114 ifname bond0.114 dev bond0 mtu 1500 id 114 ip4 172.16.80.1/24 ipv6.method "ignore"
      

   3. (Optional) If you have created a Client network and you want to use this network to connect from your VPC to VLAN attachments or other environment (such as, an on-prem environment), configure a route to your specific subnet. Run the following commands as the root user:

      nmcli connection modify INTERFACE_NAME.VLAN_ID +ipv4.routes "SUBNET GATEWAY_IP"
      

      nmcli connection up INTERFACE_NAME.VLAN_ID
      

      Replace the following:

      • INTERFACE_NAME: The name of the interface to which you want to attach the network. This is the same interface that you selected in Step 6 (Set the interface configuration) of this procedure. You can get the interface name from the Server details page, in the Networks section. See View servers.
      • VLAN_ID: The VLAN ID of the network that you want to attach. You can get the VLAN ID from the Network details page. See View networks.
      • SUBNET: The IP address and the mask of the network in CIDR notation that is used to connect to your Bare Metal Solution server through the client network. If this is your VPC network, you can get the subnet from the VPC networks page, in the Subnets section. See List subnets. If this is another environment, contact your network administrator.
      • GATEWAY_IP: The IP address of the gateway in the network that you want to attach. You can get the Gateway IP from the Network details page. See View networks.

      Example:

      nmcli connection modify bond0.114 +ipv4.routes "192.168.122.0/24 172.16.80.254"
      
      nmcli connection up bond0.114
      

   4. (Optional) If you created a Client network and set it as the default gateway in Step 7 (Default gateway) of this procedure, follow these steps to update your OS configuration:

      1. Complete the previous step, that is, Step 9.c.
      2. Ensure that you are connected to your Bare Metal Solution server through the new client network. For example, by connecting to the server from a VM in your VPC that this network is attached to with VLAN attachments.

      3. To set this network as the default gateway, disable the default gateway settings on the old network and then enable the default gateway settings on this network. Run the following commands as the root user:

         nmcli connection modify OLD_INTERFACE_NAME.OLD_VLAN_ID ipv4.gateway ""
         

         nmcli connection modify INTERFACE_NAME.VLAN_ID ipv4.gateway GATEWAY_IP
         

         nmcli connection up INTERFACE_NAME.VLAN_ID
         

         nmcli connection up OLD_INTERFACE_NAME.OLD_VLAN_ID
         

         Replace the following:

         • OLD_INTERFACE_NAME: The name of the interface to which the old default gateway network is attached to. You can get the interface name from the Server details page, in the Networks section, or by examining your Bare Metal Solution server OS configuration, that is, by using ip a or nmcli connection show commands.
         • OLD_VLAN_ID: The VLAN ID of the old default gateway network. You can get the VLAN ID from the Network details page. See View networks, or by examining your Bare Metal Solution server OS configuration, that is, by using ip a or nmcli connection show commands.
         • INTERFACE_NAME: The name of the interface to which the the new network network is attached to. This is the same interface that you selected in Step 11 (Set the interface configuration) of this procedure. You can get the interface name from the Server details page, in the Networks section. See View servers.
         • VLAN_ID: The VLAN ID of the new network. You can get the VLAN ID from the Network details page. See View networks.
         • GATEWAY_IP: The IP address of the gateway in the new network. You can get the Gateway IP from the Network details page. See View networks.

         Example:

         nmcli connection modify bond0.143 ipv4.gateway ""
         
         nmcli connection modify bond0.114 ipv4.gateway 172.16.80.254
         
         nmcli connection up bond0.114
         
         nmcli connection up bond0.143
         

   SLES

   1. Log in as the root user.

   2. Create an interface configuration (ifcfg) file at the location /etc/sysconfig/network with the following naming convention:

      ifcfg-INTERFACE_NAME.VLAN_ID
      

      Replace the following:

      • INTERFACE_NAME: The name of the interface to which you want to attach the network. This is the same interface that you selected in Step 6 (Set the interface configuration) of this procedure. You can get the interface name from the Server details page, in the Networks section. See View servers.
      • VLAN_ID: The VLAN ID of the network that you want to attach. You can get the VLAN ID from the Network details page. See View networks.

      When you are done, the path to your file looks like this:

      /etc/sysconfig/network/ifcfg-INTERFACE_NAME.VLAN_ID
      

   3. Add the following information for the network interface in the ifcfg file.

      NAME='INTERFACE_NAME.VLAN_ID'
      ETHERDEVICE='INTERFACE_NAME'
      STARTMODE='auto'
      USERCONTROL='no'
      BOOTPROTO='static'
      IPADDR='IP_ADDRESS/NETMASK'
      MTU=MTU
      VLAN='yes'
      

      Replace the following:

      • INTERFACE_NAME: The name of the interface to which you want to attach the network. This is the same interface that you selected in Step 6 (Set the interface configuration) of this procedure. You can get the interface name from the Server details page, in the Networks section. See View servers.
      • VLAN_ID: The VLAN ID of the network that you want to attach. You can get the VLAN ID from the Network details page. See View networks.
      • IP_ADDRESS: The IP address of the Bare Metal Solution server in the network. This is the same IP address that you entered in Step 6 (Set the interface configuration) of this procedure. You can find the IP address in the Server details page in the Networks section.
      • NETMASK: The network mask of the network that you want to attach. You can get the network mask from the CIDR field on the Network details page. See View networks.
      • MTU: The MTU of the network that you want to attach. You can get the MTU from the Network details page. See View networks.

      For example, a sample file /etc/sysconfig/network/ifcfg-bond1.121 looks like this:

       NAME='bond1.121'
       ETHERDEVICE='bond1'
       STARTMODE='auto'
       USERCONTROL='no'
       BOOTPROTO='static'
       IPADDR='192.168.200.10/24'
       MTU=1500
       VLAN='yes'
      

      1. Bring up the interface to apply the changes.

         ifup INTERFACE_NAME.VLAN_ID
         

         Replace the following:

         • INTERFACE_NAME: The name of the interface to which you want to attach the network. This is the same interface that you selected in Step 6 (Set the interface configuration) of this procedure. You can get the interface name from the Server details page, in the Networks section. See View servers.
         • VLAN_ID: The VLAN ID of the network that you want to attach. You can get the VLAN ID from the Network details page. See View networks.

   4. (Optional) If you have created a Client network and you want to use this network to connect from your VPC to VLAN attachments or other environment (such as, an on-prem environment), configure a route to your specific subnet.

      1. Create an interface route configuration (ifroute) file at the location /etc/sysconfig/network with the following naming convention:

         ifroute-INTERFACE_NAME.VLAN_ID
         

         When you're done, the path to your file looks like this:

         /etc/sysconfig/network/ifroute-INTERFACE_NAME.VLAN_ID
         

      2. Add the following information for the network interface in the ifroute file.

         SUBNET   GATEWAY_IP    -       -
         

         Replace the following:

         • SUBNET: The IP address and the mask of the network in CIDR notation that is used to connect to your Bare Metal Solution server through the client network. If this is your VPC network, you can get the subnet from the VPC networks page, in the Subnets section. See List subnets. If this is another environment, contact your network administrator.
         • GATEWAY_IP: The IP address of the gateway in the network that you want to attach. You can get the Gateway IP from the Network details page. See View networks.

      3. Bring up the interface to apply the changes.

         ifup INTERFACE_NAME.VLAN_ID
         

         Replace the following:

         • INTERFACE_NAME: The name of the interface to which you want to attach the network. This is the same interface that you selected in Step 6 (Set the interface configuration) of this procedure. You can get the interface name from the Server details page, in the Networks section. See View servers.
         • VLAN_ID: The VLAN ID of the network that you want to attach. You can get the VLAN ID from the Network details page. See View networks.

   5. (Optional) If you created a Client network and set it as the default gateway in Step 7 (Default gateway) of this procedure, follow these steps to update your OS configuration:

      1. Complete the previous step, that is, Step 9.c.
      2. Ensure that you are connected to your Bare Metal Solution server through this network. For example, by connecting to the server from a VM in your VPC that this network is attached to through VLAN attachments.

      3. To set this network as the default gateway, change your system default route configuration:

         Edit the file /etc/sysconfig/network/routes to replace the IP address of the current default gateway with IP address of the new default gateway.

         Update file contents to match the following:

         default   GATEWAY_IP    -       -
         

         Replace the following:

         • GATEWAY_IP: The IP address of the gateway in the new network. You can get the Gateway IP from the Network details page. See View networks.

      4. Reload network configuration to apply the change.

         systemctl reload network
         

Detach a network from a server

You can detach only one network at a time from a server, and the server can be running or powered-off.

To detach a network, follow these steps:

1. Update the OS configuration of your Bare Metal Solution server.

   Before detaching a network through the Google Cloud console, you must first update the OS configuration of your Bare Metal Solution server. If you don't update the OS configuration, the changes made in the Google Cloud console are not implemented completely.

   The actions in this step are only for example and might vary depending on your OS. Refer to your OS configuration guide if you face any issue.

   RHEL and Oracle Linux

   1. Delete the bond interface for the network that you want to detach. As the root user, run the following command:

      nmcli connection delete INTERFACE_NAME.VLAN_ID
      

      Replace the following:

      • INTERFACE_NAME: The name of the interface for the network that you want to detach. You can get the interface name from the Server details page, in the Networks section. See View servers.
      • VLAN_ID: The VLAN ID of the network that you want to detach. You can get the VLAN ID from the Network details page. See View networks.

      Example:

      nmcli connection delete bond0.148
      

   SLES

   1. Bring the interface down. As the root user, run the following command:

      ifdown INTERFACE_NAME.VLAN_ID
      

      Replace the following:

      • INTERFACE_NAME: The name of the interface for the network that you want to detach. You can get the interface name from the Server details page, in the Networks section. See View servers.
      • VLAN_ID: The VLAN ID of the network that you want to detach. You can get the VLAN ID from the Network details page. See View networks.

      Example:

      ifdown bond1.121
      

   2. Backup the information of the interface configuration file into a different file so that it is not processed on the next boot. Run the following command:

      mv /etc/sysconfig/network/ifcfg-INTERFACE_NAME.VLAN_ID /etc/sysconfig/network/ifcfg-INTERFACE_NAME.VLAN_ID.backup
      

      Replace the following:

      • INTERFACE_NAME: The name of the interface for the network that you want to detach. You can get the interface name from the Server details page, in the Networks section. See View servers.
      • VLAN_ID: The VLAN ID of the network that you want to detach. You can get the VLAN ID from the Network details page. See View networks.

      Example:

      mv /etc/sysconfig/network/ifcfg-bond1.121 /etc/sysconfig/network/ifcfg-bond1.121.backup
      

   3. (Optional) If you want to detach a Client network and you configured routes specific for this network. Backup the information of the interface route configuration file into a different file so that it is not processed on the next boot. Run the following command:

      mv /etc/sysconfig/network/ifroute-INTERFACE_NAME.VLAN_ID /etc/sysconfig/network/ifroute-INTERFACE_NAME.VLAN_ID.backup
      

      Replace the following:

      • INTERFACE_NAME: The name of the interface for the network that you want to detach. You can get the interface name from the Server details page, in the Networks section. See View servers.
      • VLAN_ID: The VLAN ID of the network that you want to detach. You can get the VLAN ID from the Network details page. See View networks.

      Example:

      mv /etc/sysconfig/network/ifroute-bond1.121 /etc/sysconfig/network/ifroute-bond1.121.backup
      

2. Detach the network through the Google Cloud console:

   1. Go to the Compute Engine > Bare Metal Solution > Servers page.
   2. Click the server name.
   3. On the Server details page, select the network that you want to detach.
   4. Click Detach network.
   5. When prompted, click Confirm.

The server status changes to "Provisioning". Detaching a network is a long-running operation. To check the status, in the Google Cloud console, click notifications Notifications. You can also follow the steps in View the status of a long-running operation. When the operation completes, the server status changes to "Running".

Delete a network

Multiple client networks attached to the same VRF can't be deleted. In this case, contact Customer Care.

To delete a network, follow these steps:

Deleting a network is a long-running operation. To check the status, in the Google Cloud console, click notifications Notifications. You can also follow the steps in View the status of a long-running operation.

View advanced networking information for a Bare Metal Solution environment

If you selected the advanced networking option for complex deployments in your Bare Metal Solution environment, you can view this information by using the following server commands.

gcloud bms instances describe SERVER_NAME --project=PROJECT_ID --region=REGION

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/instances/SERVER_NAME"

Implement IP Address Management in a Bare Metal Solution environment

Being able to manage your network topology inside your Bare Metal Solution environment is important. IP address management helps you create, view, and delete IP addresses for your resources. You can use this information to prevent overlapping IP addresses and resolve conflicts when requesting new resources.

View IP address reservations

To view IP addresses for existing reservations:

gcloud bms networks list-ip-reservations --project=PROJECT_ID --region REGION

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/networks/NETWORK_NAME"

Create and update an IP address reservation

To create a new IP address reservation or update an existing one:

gcloud bms networks update NETWORK_NAME --project=PROJECT_ID --region REGION --add-ip-range-reservation=start-address=START_ADDRESS,end-address=END_ADDRESS,note="NOTE"

gcloud bms networks update NETWORK_NAME --project=PROJECT_ID --region REGION --remove-ip-range-reservation=start-address=START_ADDRESS,end-address=END_ADDRESS

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/networks/NETWORK_NAME?updateMask=reservations"
 -d "{
  'reservations' : [
    {
      'startAddress' : 'START_ADDRESS_1',
      'endAddress' : 'END_ADDRESS_1',
      'note' : 'NOTES_1'
    },
    {
      'startAddress' : 'START_ADDRESS_2',
      'endAddress' : 'END_ADDRESS_2',
      'note' : 'NOTES_2'
    }
  ]
}"

Manage storage

You can manage the storage in your Bare Metal Solution environment in the following ways:

• View storage volumes
• Organize storage volumes by using labels
• Rename a storage volume
• Provision storage volume resources
• Remove storage volume resources
• View boot volume snapshots and their details
• Create a boot volume snapshot
• Delete a boot volume snapshot
• Restore a boot volume snapshot

View storage volumes

Paying attention to your storage resources in the Bare Metal Solution environment helps you determine if your servers have enough storage capacity for applications and workloads.

To view the details of your storage volumes, follow these steps:

Organize storage volumes by using labels

To help organize your storage volumes, you can use labels. Labels are key-value pairs that you can attach to each storage volume, then filter the storage volumes based on their labels. For example, you can use labels to group storage volumes by purpose, environment, location, department, and so on. Labels are optional.

Add or update labels for storage volumes

You can add or update labels for the existing storage volumes.

gcloud bms volumes update VOLUME_NAME --project=PROJECT_ID --region=REGION --update-labels environment=dev,location=branch

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/volumes/VOLUME_NAME?updateMask=labels"
 -d "{
  'labels' : {'environment': 'test'}
}"

Remove labels from storage volumes

You can remove labels from the storage volumes.

gcloud bms volumes update VOLUME_NAME --project=PROJECT_ID --region=REGION --remove-labels=department

gcloud bms volumes update VOLUME_NAME --project=PROJECT_ID --region=REGION --clear-labels

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/volumes/VOLUME_NAME?updateMask=labels"
 -d "{
  'labels' : {'environment': 'test'}
}"

Filter storage volumes using labels

You can search your storage volumes and filter results by using labels.

gcloud bms volumes list --project=PROJECT_ID --region=REGION --filter labels.environment=dev

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/volumes"?filter=labels.environment=test

Rename a storage volume

To rename a storage volume, follow these steps:

gcloud bms volumes rename VOLUME_NAME --new-name=NEW_NAME --project=PROJECT_ID --region=REGION

Provision storage volume resources in your Bare Metal Solution environment

After ordering storage resources for your Bare Metal Solution environment, you can provision the resources once they are available. You can provision the following self-service options:

• Create a new Fibre Channel storage volume
• Create LUNs on a volume
• Attach a storage volume to a server

Create a new storage volume

This feature lets you provision storage that you have previously ordered. To order storage volumes, contact Google Cloud Sales.

To create a new storage volume, follow these steps:

1. In the Google Cloud console, go to the Compute Engine > Bare Metal Solution > Volumes menu.

2. Click Create.

3. Enter the following information:

   Field	Description	Example
   Region	Google Cloud region located closest to your Bare Metal Solution environment.	us-central1
   Name	Create a name for your storage volume.	volume-1
   Type	Select the type of storage: SSD – Solid state drive HDD – Hard drive	SSD
   Performance tier	If you selected the SSD storage type, select the performance tier of the SSD drive: Standard – Select to create a standard SSD drive. Performance – Select to create a performance SSD drive.	Performance
   Size	Select the size of the drive in GiB, where 1024 GiB = 1 TiB. The size ranges from a minimum of 100 GiB to a maximum of 16 TiB. If you need more than 16 TiB, create additional volumes as needed. For Performance SSD drive, the maximum size is 8 TiB per volume.	16384
   Snapshot enabled	Saves a backup copy of your storage volume once per day. Required for custom snapshots, but disabled by default.	Checkbox selected to enable snapshots
   Configuration	Select the type of LUN configuration you need: Default configuration – Create LUNs of equal size (recommended). Custom configuration – Create LUNs with different sizes.	Default configuration
   Target server	Select a server and attach the storage volume.	server-1

4. Click Create.

5. The console checks if there is enough space available for the requested storage volume. The console implements the change if there is available space, or alerts you if the operation cannot be performed. If your storage volume request succeeds, billing for the additional storage begins automatically.

6. After you have provisioned the storage volume, you can share it with additional servers.

Create LUNs on a storage volume

To create LUNs for a storage volume, follow these steps:

1. In the Google Cloud console, go to the Compute Engine > Bare Metal Solution > Volumes menu.

2. Click the name of the storage volume on which you want to create a LUN.

3. Next to the LUNs section, click Create.

4. Enter the following information:

   Field	Description	Example
   Number of LUNs	Total number of LUNs you want to create with a particular size.	4
   Size	Select the size of the LUN in GiB, where 1024 GiB = 1 TiB.	1024

5. Click Add item if you need to create more than one set of LUNs.

6. Click Create to deploy the new LUNs.

Attach a storage volume to a server

You can attach multiple storage volumes to a server at once.

To attach a storage volume to a server, follow these steps:

1. In the Google Cloud console, go to the Compute Engine > Bare Metal Solution > Servers page.

2. Click the name of the server to which you want to attach a storage volume.

3. In the LUNs section, click Attach Volumes.

4. From the Target volumes list, select the storage volume you want to attach. You can also select multiple storage volumes.

5. Click Attach volumes.

You can also attach the same storage volume to other servers in parallel. Go to the Servers page and repeat this procedure for all the other servers.

Delete storage volume resources

When you no longer need specific storage volume resources, you can delete them. You can delete either a whole storage volume or its LUNs. But before doing so, you must detach the storage volume from the servers it is attached to.

This section explains the following tasks:

• Detach a storage volume from a server
• Delete LUNs from a storage volume
• Delete a storage volume

Detach a storage volume from a server

You can detach a storage volume from a server. You can't detach individual LUNs from a server. You can detach multiple storage volumes at once.

To detach a storage volume from a server, follow these steps:

1. Update the OS configuration of your Bare Metal Solution server.

   Before detaching the storage volume through the Google Cloud console, you must update the OS configuration of your Bare Metal Solution server. If you don't update the OS configuration, the changes made in the Google Cloud console are not implemented completely, your data might become corrupted, and the server might experience issues with the next reboot.

   This step shows examples of how to update your OS configuration. The instructions might vary depending on your OS. Refer to your OS configuration guide if you face any issue.

   Logical Volume Manager (LVM)

   Detach a storage volume through LVM for RHEL7.x, RHEL 8.x, Oracle Linux 7.x, Oracle Linux 8.x, SLES 12 SP4, SLES 12 SP5, SLES 15, and SLES 15 SP1.

   The following example procedure shows how to detach a file system (/testvol02) and its associated logical volume, physical volume, and the underlying LUN through LVM.

   Follow these steps:

   1. Identify the LVM volume and underlying LUN associated with the file system /testvol02.

        df -h|grep testvol02
        

      Sample output:

        /dev/mapper/testvg01-lv02                         99G   33M   99G   1% /testvol02
        

      The output shows that the file system /testvol02 is associated with device /dev/mapper/testvg01-lv02.

   2. Determine the WWID of the device testvg01-lv02.

        sudo dmsetup ls --tree
        

      Sample output:

        testvg01-lv02 (253:10)
        └─3600a0980383146354a2b522d53374236 (253:6)
            ├─ (8:176)
            ├─ (8:112)
            ├─ (8:240)
            └─ (8:48)
        testvg01-lv01 (253:9)
        └─3600a0980383146354a2b522d53374235 (253:5)
            ├─ (8:160)
            ├─ (8:96)
            ├─ (8:224)
            └─ (8:32)
        

      The output shows that the WWID of the device testvg01-lv02 is 3600a0980383146354a2b522d53374236.

   3. Determine the logical volume, physical volume, and the WWID of the underlying LUN for file system /testvol02.

        sudo vgdisplay -v
        

      Sample output:

          --- Volume group ---
          VG Name               testvg01
          System ID
          Format                lvm2
          Metadata Areas        2
          Metadata Sequence No  4
          VG Access             read/write
          VG Status             resizable
          MAX LV                0
          Cur LV                2
          Open LV               2
          Max PV                0
          Cur PV                2
          Act PV                2
          VG Size               199.99 GiB
          PE Size               4.00 MiB
          Total PE              51198
          Alloc PE / Size       50688 / 198.00 GiB
          Free  PE / Size       510 / 1.99 GiB
          VG UUID               W42Rle-9sER-jpS1-dwBC-xbtn-1D2b-FNRDMA
      
          --- Logical volume ---
          LV Path                /dev/testvg01/lv01
          LV Name                lv01
          VG Name                testvg01
          LV UUID                W8bzQQ-Qtyf-CDJA-AXPt-P1b1-X4xL-2WDq92
          LV Write Access        read/write
          LV Creation host, time at-5176205-svr001, 2022-12-06 22:14:56 +0000
          LV Status              available
          # open                 1
          LV Size                99.00 GiB
          Current LE             25344
          Segments               1
          Allocation             inherit
          Read ahead sectors     auto
          - currently set to     8192
          Block device           253:9
      
          --- Logical volume ---
          LV Path                /dev/testvg01/lv02
          LV Name                lv02
          VG Name                testvg01
          LV UUID                B1vtMm-RAKx-3S92-mHfx-98xc-gKwR-XWOavH
          LV Write Access        read/write
          LV Creation host, time at-5176205-svr001, 2022-12-07 17:02:53 +0000
          LV Status              available
          # open                 1
          LV Size                99.00 GiB
          Current LE             25344
          Segments               1
          Allocation             inherit
          Read ahead sectors     auto
          - currently set to     8192
          Block device           253:10
      
          --- Physical volumes ---
          PV Name               /dev/mapper/3600a0980383146354a2b522d53374235
          PV UUID               ieY2Cr-HNrg-dj2G-wHgP-lsuh-PTAH-hNemRq
          PV Status             allocatable
          Total PE / Free PE    25599 / 255
      
          PV Name               /dev/mapper/3600a0980383146354a2b522d53374236
          PV UUID               AMrtZa-TZHO-w0h6-Uf1G-NCwa-UtFY-83rZen
          PV Status             allocatable
          Total PE / Free PE    25599 / 255
        

      The output shows the following:

      • The file system /testvol02 is using the Logical Volume (LV) lv02 from the volume group testvg01.
      • The Physical Volume (PV) in use is /dev/mapper/3600a0980383146354a2b522d53374236.
      • The underlying LUN's WWID is 3600a0980383146354a2b522d53374236.

   4. Unmount the file system /testvol02.

        sudo umount /testvol02
        

   5. If required, find and remove the corresponding entry for the file system /testvol02 from file /etc/fstab by commenting or deleting the relevant line.

        grep testvol02 /etc/fstab
        

      Sample output:

        /dev/mapper/testvg01-lv02 /testvol02                    xfs     defaults        0 0
        

   6. Deactivate the logical volume lv02.

        sudo lvchange -an /dev/testvg01/lv02
        

   7. Remove the logical volume lv02 from the volume group testvg01.

        sudo lvremove /dev/testvg01/lv02
        

      Sample output:

        Logical volume "lv02" successfully removed
        

   8. Remove the physical volume /dev/mapper/3600a0980383146354a2b522d53374236 from the volume group testvg01.

     sudo vgreduce testvg01 /dev/mapper/3600a0980383146354a2b522d53374236
     

   Sample output:

     Removed "/dev/mapper/3600a0980383146354a2b522d53374236" from volume group "testvg01"
     

   9. Optional: After removing the logical volume and the physical volume, use commands vgdisplay -v and dmsetup ls -tree to confirm that the device is no longer in use by the LVM. If the device is no longer in use, it doesn't appear in the "Physical volumes" section of the vgdisplay command output, and it's not seen associated with any volume in the dmsetup command output.

   Local file system

   Detach a storage volume through local file system for RHEL7.x, RHEL 8.x, Oracle Linux 7.x, and Oracle Linux 8.x.

   The following example procedure shows how to remove a file system (/localfs01) and the underlying LUN.

   Follow these steps:

   1. Identify the underlying LUN associated with the file system /localfs01.

      df -h|grep localfs01
      

      Sample output:

      /dev/mapper/3600a0980383146354a2b522d53374236    100G   33M  100G   1% /localfs01
      

      The output of the df command shows that the file system /localfs01 is associated with device /dev/mapper/3600a0980383146354a2b522d53374236.

   2. Unmount the file system /localfs01.

      sudo umount /localfs01
      

   3. If required, find and remove the corresponding entry for the file system /localfs01 from file /etc/fstab by commenting or deleting the relevant line.

      grep localfs01 /etc/fstab
      

      Sample output:

      grep localfs01 /etc/fstab
      /dev/mapper/3600a0980383146354a2b522d53374236 /localfs01    xfs defaults 0 0
      

   Oracle ASM

   Detach a storage volume through Oracle ASM for RHEL7.x, RHEL 8.x, Oracle Linux 7.x, and Oracle Linux 8.x.

   The following example procedure shows how to remove a disk (DEMO_0001) and the associated LUN in Oracle ASM.

   Follow these steps:

   1. Identify the disk in Oracle ASM that you want to remove.

      sqlplus / as sysasm
      
      set lines 999;
      col diskgroup for a15
      col diskname for a15
      col path for a35
      select a.name DiskGroup,b.name DiskName, b.total_mb, (b.total_mb-b.free_mb) Used_MB, b.free_mb,b.path,b.header_status
      from v$asm_disk b, v$asm_diskgroup a
      where a.group_number (+) =b.group_number
      order by b.group_number,b.name;
      
      DISKGROUP   DISKNAME      TOTAL_MB    USED_MB    FREE_MB PATH                    HEADER_STATU
      --------------- --------------- ---------- ---------- ---------- ----------------------------------- ------------
      DATA        DATA_0000        25600   5676      19924 /dev/asmdisks/DATA1             MEMBER
      DEMO        DEMO_0000        25600     16      25584 /dev/asmdisks/DEMO1             MEMBER
      DEMO        DEMO_0001       102400     51     102349 /dev/asmdisks/DEMO2             MEMBER
      RECO        RECO_0000        25600   3896      21704 /dev/asmdisks/RECO1             MEMBER
      

      Sample output:

      DISKGROUP   DISKNAME      TOTAL_MB    USED_MB    FREE_MB PATH                    HEADER_STATU
      --------------- --------------- ---------- ---------- ---------- ----------------------------------- ------------
      DATA        DATA_0000        25600   5676      19924 /dev/asmdisks/DATA1             MEMBER
      DEMO        DEMO_0000        25600     16      25584 /dev/asmdisks/DEMO1             MEMBER
      DEMO        DEMO_0001       102400     51     102349 /dev/asmdisks/DEMO2             MEMBER
      RECO        RECO_0000        25600   3896      21704 /dev/asmdisks/RECO1             MEMBER
      

      The output of the query shows that the device associated with the disk DEMO_0001 is /dev/asmdisks/DEMO2.

   2. Determine the multipath device associated with the disk and its WWID.

      ls -l /dev/asmdisks/DEMO2
      lrwxrwxrwx 1 root root 8 Dec 29 17:52 /dev/asmdisks/DEMO2 -> ../dm-18
      

      sudo multipath -ll|grep dm-18
      3600a0980383146354a2b522d53374247 dm-18 NETAPP  ,LUN C-Mode
      

   3. Remove the disk from the disk group.

      SQL> alter diskgroup DEMO drop disk DEMO_0001 rebalance power 5;
      
      Diskgroup altered.
      
      col diskgroup for a15
      col diskname for a15
      col path for a35
      select a.name DiskGroup,b.name DiskName, b.total_mb, (b.total_mb-b.free_mb) Used_MB, b.free_mb,b.path,b.header_status
      from v$asm_disk b, v$asm_diskgroup a
      where a.group_number (+) =b.group_number
      order by b.group_number,b.name;
      
      DISKGROUP   DISKNAME      TOTAL_MB    USED_MB    FREE_MB PATH                    HEADER_STATU
      --------------- --------------- ---------- ---------- ---------- ----------------------------------- ------------
                0     0          0 /dev/asmdisks/DEMO2             FORMER
      DATA        DATA_0000        25600   5676      19924 /dev/asmdisks/DATA1             MEMBER
      DEMO        DEMO_0000        25600     64      25536 /dev/asmdisks/DEMO1             MEMBER
      RECO        RECO_0000        25600   3896      21704 /dev/asmdisks/RECO1             MEMBER
      
      SQL> exit
      

   4. (Perform this step on all nodes in the cluster.) Remove all the references to the disk from the /etc/udev/rules.d/99-oracle-asmdevices.rules file.

      In this example, we remove lines 9 and 10 as they are associated with the disk DEMO_0001 and the WWID of 3600a0980383146354a2b522d53374247 identified in Step 1.b of this procedure.

      cat -n /etc/udev/rules.d/99-oracle-asmdevices.rules
       1  # BEGIN ASM disk udev rules for /dev/mapper/3600a0980383146354a2b522d53374244
       2  ACTION=="add|change", ENV{DM_UUID}=="mpath-3600a0980383146354a2b522d53374244", SYMLINK+="asmdisks/DATA1", GROUP="asmadmin", OWNER="grid", MODE="0660"
       3  # END ASM disk udev rules for /dev/mapper/3600a0980383146354a2b522d53374244
       4  # BEGIN ASM disk udev rules for /dev/mapper/3600a0980383146354a2b522d53374243
       5  ACTION=="add|change", ENV{DM_UUID}=="mpath-3600a0980383146354a2b522d53374243", SYMLINK+="asmdisks/RECO1", GROUP="asmadmin", OWNER="grid", MODE="0660"
       6  # END ASM disk udev rules for /dev/mapper/3600a0980383146354a2b522d53374243
       7  # BEGIN ASM disk udev rules for /dev/mapper/3600a0980383146354a2b522d53374242
       8  ACTION=="add|change", ENV{DM_UUID}=="mpath-3600a0980383146354a2b522d53374242", SYMLINK+="asmdisks/DEMO1", GROUP="asmadmin", OWNER="grid", MODE="0660"
       9  # BEGIN ASM disk udev rules for /dev/mapper/3600a0980383146354a2b522d53374247
      10  ACTION=="add|change", ENV{DM_UUID}=="mpath-3600a0980383146354a2b522d53374247", SYMLINK+="asmdisks/DEMO2", GROUP="asmadmin", OWNER="grid", MODE="0660"
      11  # END ASM disk udev rules for /dev/mapper/3600a0980383146354a2b522d53374247
      

   5. (Perform this step on all nodes in the cluster.) Apply udev ruleset changes.

      sudo udevadm control -R
      

   Oracle Linux Virtualization Manager

   Detach a storage volume through Oracle Linux Virtualization Manager 4.4.10.7.

   Removing individual Fibre Channel devices from an Oracle Linux Virtualization Manager storage domain is not supported. The storage domain needs to be removed before the underlying LUNs can be removed.

   The following example procedure shows how to remove LUNs with WWIDs of 3600a0980383146354a2b522d53374244 and 3600a0980383146354a2b522d53374245 that are part of the Oracle Linux Virtualization Manager storage domain olvm-domain-02.

   1. In the Oracle Linux Virtualization Manager, go to Storage > Domains.
   2. Select storage domain olvm-domain-02.
   3. Click Manage Domain.
   4. Make a note of the WWIDs of the Fibre Channel LUNs you want to remove. In this case, the WWIDs are 3600a0980383146354a2b522d53374244 and 3600a0980383146354a2b522d53374245.
   5. Close the Manage Domain pane.
   6. Put the storage domain in maintenance mode as follows:
      1. Click the storage domain.
      2. Select the Data Center tab.
      3. Click Maintenance and then OK.

      For more information regarding this step, see Oracle documentation: How to safely remove a storage domain from the environment.

   7. Click Detach and then OK.
   8. Remove the storage domain:
      1. Return to Storage > Domains.
      2. Select the storage domain.
      3. Click Remove and then OK.

   Oracle VM Server

   Detach a storage volume through Oracle VM Server release 3.4.6.

   The following example procedure shows how to remove the LUN with the WWID of 3600a0980383146354a2b522d53374236.

   Follow these steps:

   1. In the Oracle VM Manager, delete the associated physical disk. See Oracle documentation: Delete physical disk.

      In this example, the OVM console name of the physical disk with a WWID of 3600a0980383146354a2b522d53374236 is NETAPP (10).

   1. From the Servers and VMs, select the physical disk.
   2. Click Delete physical disk and then OK.

2. In the Google Cloud console, go to the Compute Engine > Bare Metal Solution > Servers page.

3. Click the name of the server that has the storage volumes you want to detach.

4. In the LUNs section, click Detach Volumes.

5. From the Target volumes list, select the storage volume that you want to detach. You can also select multiple storage volumes.

6. Optional: By default, the server reboots when you detach a storage volume. If you don't want to reboot the server, select the Skip reboot for the server checkbox.

7. Click Detach Volumes.

   If you did not select the Skip reboot for the server option in Step 6, the server reboots and detaches the storage volume and its LUNs.

8. (Perform this step if you skipped the reboot in Step 6.) After detaching the storage volume through the Google Cloud console, perform an SCSI rescan and device cleanup on your OS.

   The instructions might vary depending on your OS. If you face any issue, refer to your OS configuration guide.

   • Red Hat
   • Oracle
   • SUSE

   Logical Volume Manager (LVM)

   This example is applicable for RHEL7.x, RHEL 8.x, Oracle Linux 7.x, Oracle Linux 8.x, SLES 12 SP4, SLES 12 SP5, SLES 15, and SLES 15 SP1.

   1. Remove paths associated with the LUN.

      Following is an example from the Bare Metal Solution environment:

          sudo /bin/rescan-scsi-bus.sh -r
          Syncing file systems
          Scanning SCSI subsystem for new devices and remove devices that have disappeared
          Scanning host 0 for  SCSI target IDs  0 1 2 3 4 5 6 7, all LUNs
          Scanning host 1 for  SCSI target IDs  0 1 2 3 4 5 6 7, all LUNs
          Scanning host 2 for  SCSI target IDs  0 1 2 3 4 5 6 7, all LUNs
          ...
          Scanning host 17 for all SCSI target IDs, all LUNs
          0 new or changed device(s) found.
          0 remapped or resized device(s) found.
          4 device(s) removed.
            [14:0:2:1]
            [14:0:3:1]
            [16:0:0:1]
            [16:0:1:1]
          

   2. Reload the multipath maps.

        sudo /sbin/multipath -r
        

   Local file system

   This example is applicable for RHEL7.x, RHEL 8.x, Oracle Linux 7.x, and Oracle Linux 8.x.

   1. Remove paths associated with the LUN.

      Following is an example from the Bare Metal Solution environment:

        sudo /bin/rescan-scsi-bus.sh -r
        Syncing file systems
        Scanning SCSI subsystem for new devices and remove devices that have disappeared
        Scanning host 0 for  SCSI target IDs  0 1 2 3 4 5 6 7, all LUNs
        Scanning host 1 for  SCSI target IDs  0 1 2 3 4 5 6 7, all LUNs
        Scanning host 2 for  SCSI target IDs  0 1 2 3 4 5 6 7, all LUNs
        ...
        Scanning host 17 for all SCSI target IDs, all LUNs
        0 new or changed device(s) found.
        0 remapped or resized device(s) found.
        4 device(s) removed.
          [14:0:2:1]
          [14:0:3:1]
          [16:0:0:1]
          [16:0:1:1]
        

   2. Reload the multipath maps.

       sudo /sbin/multipath -r
       

   Oracle ASM

   This example is applicable for RHEL7.x, RHEL 8.x, Oracle Linux 7.x, and Oracle Linux 8.x.

   Perform these step on all nodes in the cluster.

   1. Remove paths associated with the LUN.

      Following is an example from the Bare Metal Solution environment:

        sudo /bin/rescan-scsi-bus.sh -r
        Syncing file systems
        Scanning SCSI subsystem for new devices and remove devices that have disappeared
        Scanning host 0 for  SCSI target IDs  0 1 2 3 4 5 6 7, all LUNs
        Scanning host 1 for  SCSI target IDs  0 1 2 3 4 5 6 7, all LUNs
        Scanning host 2 for  SCSI target IDs  0 1 2 3 4 5 6 7, all LUNs
        ...
        Scanning host 17 for  all SCSI target IDs, all LUNs
        0 new or changed device(s) found.
        0 remapped or resized device(s) found.
        4 device(s) removed.
          [14:0:2:8]
          [14:0:3:8]
          [16:0:0:8]
          [16:0:3:8]
      

   2. Reload the multipath maps.

      sudo /sbin/multipath -r
      

   Oracle Linux Virtualization Manager

   This example is applicable for Oracle Linux Virtualization Manager 4.4.10.7.

   This example uses the remove_stale_lun.yml Ansible playbook provided as part of the Oracle Linux Virtualization Manager installation. The playbook uses an Ansible role that builds an inventory of KVM hosts from the Oracle Linux Virtualization Manager and then removes the specified WWIDs from those KVM hosts. For more information, see the Ansible playbook.

   1. Update the file passwords.yml with the password for the KVM hosts in the method appropriate for your Ansible environment.
   2. Edit the file remove_stale_lun.yml to update the vars section with the values of data_center and lun_wwid to match the WWID values identified in Step 1.d of this procedure.

        vars:
         ansible_ssh_common_args: "-o StrictHostKeyChecking=no"
         ansible_user: root
         ansible_ssh_private_key_file: /etc/pki/ovirt-engine/keys/engine_id_rsa
      
         engine_fqdn: manager.olvm.test
         engine_user: admin@internal
      
         data_center: default
         lun_wwid: 3600a0980383146354a2b522d53374244 3600a0980383146354a2b522d53374245
        

   3. From the Oracle Linux Virtualization Manager engine, run the Ansible playbook.

          ansible-playbook /usr/share/ansible/collections/ansible_collections/ovirt/ovirt/roles/remove_stale_lun/examples/remove_stale_lun.yml
      
          PLAY [oVirt remove stale LUN] ***********************************************************************************************************************************************************
      
          ... [output skipped]
      
          TASK [ovirt.ovirt.remove_stale_lun : Logout from oVirt] *********************************************************************************************************************************
          skipping: [localhost]
      
          PLAY RECAP ******************************************************************************************************************************************************************************
          localhost                  : ok=7    changed=3    unreachable=0    failed=0    skipped=1    rescued=0    ignored=0
      
        

      Once the Ansible playbook is complete, the paths associated with the LUN are safely removed from the KVM hosts.

   Oracle VM Server

   This example is applicable for Oracle VM Server release 3.4.6.

   Perform these step on all Oracle VM servers to which the LUN was attached.

   1. Remove paths associated with the LUN.

      sudo /usr/bin/rescan-scsi-bus.sh -r
      Syncing file systems
      Scanning SCSI subsystem for new devices and remove devices that have disappeared
      Scanning host 0 for  SCSI target IDs  0 1 2 3 4 5 6 7, all LUNs
      Scanning host 1 for  SCSI target IDs  0 1 2 3 4 5 6 7, all LUNs
      Scanning host 2 for  SCSI target IDs  0 1 2 3
      [output skipped]
      Scanning host 17 for  all SCSI target IDs, all LUNs
      0 new or changed device(s) found.
      0 remapped or resized device(s) found.
      4 device(s) removed.
        [14:0:2:2]
        [14:0:3:2]
        [16:0:2:2]
        [16:0:3:2]
      

   2. Reload the multipath maps.

      sudo /sbin/multipath -r
      

Delete LUNs from a storage volume

Before deleting LUNs from a storage volume, detach the storage volume from all the servers it is attached to. See Detach a storage volume from a server.

To delete LUNs from a storage volume, follow these steps:

1. In the Google Cloud console, go to the Compute Engine > Bare Metal Solution > Volumes page.

2. Click the name of the storage volume that contains the LUNs you want to delete.

3. In the LUNs section, select the LUNs you want to delete.

4. Click Delete.

   Deleting a LUN puts it in a seven day cooling-off period. The LUN is deleted only after the cooling-off period is complete. If you want to restore your LUN during the cooling-off period, contact Customer Care.

   If you want to skip the cooling-off period and delete the LUN permanently, continue with the following steps:

5. Select the LUN for which you want to skip the cooling-off period.

6. Click Evict.

7. Click Confirm.

   Delete and evict are long-running operations. To check the status, in the Google Cloud console, click notifications Notifications. When the delete operation completes, the LUN status changes to "Cool Off" and when the evict operation completes, the LUN is removed from the list of LUNs.

   Once the LUN is deleted, the storage space is returned to your storage volume for use. However, the quota is returned only when you delete or evict the storage volume. If you delete the LUN, the quota is returned to you after the seven day cooling-off period. However, if you evict the LUN, the quota is returned to you once the evict operation is complete.

If you want to reattach the storage volume after deleting LUNs, see Attach a storage volume to a server.

Delete a storage volume

You can delete multiple storage volumes at once.

Before deleting a storage volume, detach it from all the servers it is attached to. See Detach a storage volume from a server.

To delete a storage volume, follow these steps:

1. In the Google Cloud console, go to the Compute Engine > Bare Metal Solution > Volumes page.

2. Select the storage volume.

3. Click Delete.

   Deleting a storage volume puts it in a seven day cooling-off period. The storage volume is deleted only after the cooling-off period is complete. If you want to restore your storage volume during the cooling-off period, contact Customer Care.

   If you want to skip the cooling-off period and delete the storage volume permanently, continue with the following steps:

4. Select the volume for which you want to skip the cooling-off period.

5. Click Evict.

6. Click Confirm.

   Delete and evict are long-running operations. To check the status, in the Google Cloud console, click notifications Notifications. When the delete operation completes, the storage volume status changes to "Cool Off" and when the evict operation completes, the storage volume is removed from the list of storage volumes.

   Once the storage volume is deleted, the quota is returned to you after the seven day cooling-off period. However, if you evict the storage volume, the quota is returned to you once the evict operation is complete.

Manage boot volume snapshots

You can manage your boot volume snapshots in the following ways:

• View boot volume snapshots and their details
• Create a boot volume snapshot
• Delete a boot volume snapshot
• Restore a boot volume snapshot

View boot volume snapshots and their details

You can view the list of snapshots of a boot volume and their details, including the following:

• ID
• Name
• Description
• Create time
• Associated volume

• Type

gcloud bms volumes snapshots list --project=PROJECT_ID --region=REGION --volume=VOLUME_NAME

gcloud bms volumes snapshots describe --project=PROJECT_ID --region=REGION --volume=VOLUME_NAME --snapshot=SNAPSHOT_NAME

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/volumes/VOLUME_NAME/snapshots"

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/volumes/VOLUME_NAME/snapshots/SNAPSHOT_NAME"

Create a boot volume snapshot

You can create snapshots for boot volumes.

gcloud bms volumes snapshot --project=PROJECT_ID --region=REGION --volume=VOLUME_NAME --snapshot=SNAPSHOT_NAME --description=DESCRIPTION

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/volumes/VOLUME_NAME/snapshots"
 -d \
'{\''name\'':
\''projects/PROJECT_ID/locations/REGION/volumes/VOLUME_NAME/snapshots/SNAPSHOT_NAME\'', \''description\'': \''DESCRIPTION\''}' \

Delete a boot volume snapshot

You can delete boot volume snapshots.

gcloud bms volumes snapshots delete --project=PROJECT_ID --region=REGION --volume=VOLUME_NAME --snapshot=SNAPSHOT_NAME

curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/volumes/VOLUME_NAME/snapshots/SNAPSHOT_NAME"

Restore a boot volume snapshot

You can restore a boot volume from a snapshot.

gcloud bms volumes restore --project=PROJECT_ID --region=REGION VOLUME_NAME --snapshot=SNAPSHOT_NAME

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
-H "Content-Length:0" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/volumes/VOLUME_NAME/snapshots/SNAPSHOT_NAME:restoreVolumeSnapshot"

Because restoring a boot volume takes a while to complete, you can check the status by following the steps in View the status of a long-running operation.

Manage NFS file storage

You can manage your NFS file storage in the following ways:

• View NFS volumes
• Organize NFS volumes by using labels
• Rename an NFS volume
• Create an NFS volume
• Update an NFS volume
• Delete an NFS volume

View NFS volumes

After you order and provision NFS for Bare Metal Solution, you can view the status of your NFS file storage and confirm that Google Cloud implemented your configured settings as expected.

To view the details of your NFS volumes, follow these steps:

Organize NFS file storage by using labels

To help organize your NFS file storage, you can use labels. Labels are key-value pairs that you can attach to each NFS volume, then filter the NFS volumes based on their labels. For example, you can use labels to group NFS volumes by purpose, environment, location, department, and so on. Labels are optional.

Add or update labels for NFS volumes

You can add or update labels for the existing NFS volumes.

gcloud bms nfs-shares update NFS_VOLUME_NAME --project=PROJECT_ID --region=REGION --update-labels environment=dev,location=branch

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/nfsShares/NFS_VOLUME_NAME?updateMask=labels"
 -d "{
  'labels' : {'environment': 'test'}
}"

Remove labels from NFS volumes

You can remove labels from the NFS volumes.

gcloud bms nfs-shares update NFS_VOLUME_NAME --project=PROJECT_ID --region=REGION --remove-labels=department

gcloud bms nfs-shares update NFS_VOLUME_NAME --project=PROJECT_ID --region=REGION --clear-labels

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/nfsShares/NFS_VOLUME_NAME?updateMask=labels"
 -d "{
  'labels' : {'environment': 'test'}
}"

'labels' : {
}

'labels' : {
     'user': 'production',
     'env': 'production',
     'purpose': 'shared_data_store'
}

Filter NFS volumes using labels

You can search your NFS volumes and filter results by using labels.

gcloud bms nfs-shares list --project=PROJECT_ID --region=REGION --filter labels.environment=dev

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/nfsShares"?filter=labels.environment=test

Rename an NFS volume

To rename an NFS volume, follow these steps:

gcloud bms nfs-shares rename NFS_VOLUME_NAME --new-name=NEW_NAME --project=PROJECT_ID --region=REGION

Create an NFS volume

You can create an NFS volume with one or more allowed clients.

gcloud bms nfs-shares create --project=PROJECT_ID --region=REGION NFS_VOLUME_NAME \
--size-gib=SIZE_GIB --storage-type=STORAGE_TYPE \
--allowed-client=network=NETWORK_NAME,\
network-project-id=PROJECT_ID,cidr=IP_ADDRESS_RANGE,\
mount-permissions=MOUNT_PERMISSIONS,allow-dev=ALLOW_DEV,allow-suid=ALLOW_SUID,\
enable-root-squash=ENABLE_ROOT_SQUASH \

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/nfsShares"
 -d \
'{
  "name": "projects/PROJECT_ID/locations/REGION/nfsShares/NFS_VOLUME_NAME",
  "labels": {
    "nfsKey1": "some_value",
    "key2": "another_value",
  },
  "requestedSizeGib": "SIZE_GIB",
  "storageType": "STORAGE_TYPE",
  "allowedClients": [
    {
      "network": "projects/PROJECT_ID/locations/REGION/networks/NETWORK_NAME",
      "allowedClientsCidr": "IP_ADDRESS_RANGE",
      "mountPermissions": "MOUNT_PERMISSIONS",
      "allowDev": ALLOW_DEV,
      "allowSuid": ALLOW_SUID,
      "noRootSquash": ENABLE_ROOT_SQUASH,
    }
  ],
}'

Because creating an NFS volume takes a while to complete, you can check the status by following the steps in View the status of a long-running operation.

Update an NFS volume

After an NFS volume has been created, you can update only its allowed clients.

gcloud bms nfs-shares update --project=PROJECT_ID --region=REGION NFS_VOLUME_NAME --remove-allowed-client=network=NETWORK_NAME,network-project-id=PROJECT_ID,cidr=IP_ADDRESS_RANGE

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/nfsShares/NFS_VOLUME_NAME?updateMask=allowed_clients%2Clabels"
 -d \
'{
  "name": "projects/PROJECT_ID/locations/REGION/nfsShares/NFS_VOLUME_NAME",
  "labels": {
    "newKey": "newVal",
  },
  "allowedClients": [
    {
      "network": "projects/PROJECT_ID/locations/REGION/networks/NFS_VOLUME_NAME",
      "allowedClientsCidr": "IP_ADDRESS_RANGE",
      "mountPermissions": "MOUNT_PERMISSIONS",
      "allowDev": ALLOW_DEV,
      "allowSuid": ALLOW_SUID,
      "noRootSquash": ENABLE_ROOT_SQUASH,
    }
  ],
}'

Because updating an NFS volume takes a while to complete, you can check the status by following the steps in View the status of a long-running operation.

Delete an NFS volume

Deleting an NFS volume automatically triggers a cooling-off period of seven days during which time Google Cloud removes the volume from use.

gcloud bms nfs-shares delete --project=PROJECT_ID --region=REGION NFS_VOLUME_NAME

curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
-H "Content-Type: application/json" \
"https://baremetalsolution.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/nfsShares/NFS_VOLUME_NAME"

Because deleting an NFS volume takes a while to complete, you can check the status by following the steps in View the status of a long-running operation.

View the status of a long-running operation

Some gcloud or API commands, such as a server reset, might take a long time to complete. A command that produces a long-running operation also generates output that contains an operation ID. You can use the operation ID to check the status of the long-running operation.

In the name field of the output, you can find the operation ID located after the operations directory. For example, the following output of the reset API command displays the operation ID as eb0056e2-b6f6-4792-8255-59cd79d5c686.

{
"name": "projects/PROJECT_ID/locations/REGION/operations/eb0056e2-b6f6-4792-8255-59cd79d5c686",
"done": true
}

To check the status of a long-running operation, use the following options:

gcloud bms operations describe --project=PROJECT_ID --region=REGION OPERATION_ID