Stay organized with collections
Save and categorize content based on your preferences.
This page provides instructions on how to verify key access after you
create a customer-managed encryption key (CMEK) policy.
Key access verification use cases
At any time, you can rerun key access verification to identify issues with the
key:
Key disablement: if a key gets disabled, data access to volumes stops.
Key destructions: if a key is destroyed, access to data is unrestorable.
You can delete volumes to free up capacity. For more information, see
Delete a volume.
To use a CMEK key, you must grant the service permission to read the
specified key first. NetApp Volumes provides the correct
Google Cloud CLI commands. To grant the required Cloud KMS key
permissions to the service, you need to create a project-wide custom role with
the appropriate permissions, and then a key role binding that binds the custom
role to the appropriate service account. You need the Role Administrator
(roles/iam.RoleAdmin) permissions on the project within your Google Account to
create the custom role and the Cloud KMS Admin (roles/cloudkms.admin)
permissions to grant NetApp Volumes access to the key.
Console
Use the following instructions to grant the service permission to read a key
using the Google Cloud console.
Go to the NetApp Volumes page in the Google Cloud console.
Find the CMEK policy you want to edit and click the Show more menu.
Select Verify key access.
If you haven't configured key access yet, the verification fails and the
UI shows instructions on how to grant key access. After you run the
required Google Cloud CLI commands, click Retry to run key
verification again.
If verification is successful, a dialog appears that indicates
successful verification. If verification is unsuccessful, click
Retry to rerun the key check.
gcloud
Use the following instructions to grant the service permission to read
a key using Google Cloud CLI.
PROJECT_ID: the unique project ID you want to
grant access for.
LOCATION: the region of the config.
If key verification is successful, the command outputs the following message:
healthy:true
If key verification fails, you have to grant access permissions to the key.
Run the following command to identify the Google Cloud CLI commands to grant the
service key access. You need the cloudkms.admin role to run the following
command.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[],[],null,["# Verify key access\n\nThis page provides instructions on how to verify key access after you\ncreate a customer-managed encryption key (CMEK) policy.\n\nKey access verification use cases\n---------------------------------\n\nAt any time, you can rerun key access verification to identify issues with the\nkey:\n\n- **Key disablement**: if a key gets disabled, data access to volumes stops.\n\n- **Key destructions** : if a key is destroyed, access to data is unrestorable.\n You can delete volumes to free up capacity. For more information, see\n [Delete a volume](/netapp/volumes/docs/configure-and-use/volumes/manage-volume#delete_a_volume).\n\n- **Missing permissions** : if permissions are removed, the instructions to\n grant them appear. See [Grant the service permission to read a key](/netapp/volumes/docs/configure-and-use/cmek/verify-key-access#grant_the_service_permission_to_read_a_key).\n\nGrant the service permission to read a key\n------------------------------------------\n\nTo use a CMEK key, you must grant the service permission to read the\nspecified key first. NetApp Volumes provides the correct\nGoogle Cloud CLI commands. To grant the required Cloud KMS key\npermissions to the service, you need to create a project-wide custom role with\nthe appropriate permissions, and then a key role binding that binds the custom\nrole to the appropriate service account. You need the Role Administrator\n(`roles/iam.RoleAdmin`) permissions on the project within your Google Account to\ncreate the custom role and the Cloud KMS Admin (`roles/cloudkms.admin`)\npermissions to grant NetApp Volumes access to the key. \n\n### Console\n\nUse the following instructions to grant the service permission to read a key\nusing the Google Cloud console.\n\n1. Go to the **NetApp Volumes page** in the Google Cloud console.\n\n [Go to NetApp Volumes](https://console.cloud.google.com/netapp/volumes)\n2. Select **CMEK policies**.\n\n3. Find the CMEK policy you want to edit and click the **Show more** menu.\n\n4. Select **Verify key access**.\n\n5. If you haven't configured key access yet, the verification fails and the\n UI shows instructions on how to grant key access. After you run the\n required Google Cloud CLI commands, click **Retry** to run key\n verification again.\n\n If verification is successful, a dialog appears that indicates\n successful verification. If verification is unsuccessful, click\n **Retry** to rerun the key check.\n\n### gcloud\n\nUse the following instructions to grant the service permission to read\na key using Google Cloud CLI.\n\nRun the following `kms-configs verify` command: \n\n```bash\n gcloud netapp kms-configs verify CONFIG_NAME \\\n --project=PROJECT_ID \\\n --location=LOCATION\n```\n\nReplace the following information:\n\n- \u003cvar translate=\"no\"\u003eCONFIG_NAME\u003c/var\u003e: the name of the config.\n\n- \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e: the unique project ID you want to\n grant access for.\n\n- \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e: the region of the config.\n\nIf key verification is successful, the command outputs the following message: \n\n```json\nhealthy: true\n```\n\nIf key verification fails, you have to grant access permissions to the key.\nRun the following command to identify the Google Cloud CLI commands to grant the\nservice key access. You need the `cloudkms.admin` role to run the following\ncommand. \n\n```json\n gcloud netapp kms-configs describe CONFIG_NAME \\\n --project=\u003cvar label=\"project ID\" translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e \\\n --location=\u003cvar label=\"location\" translate=\"no\"\u003eLOCATION\u003c/var\u003e \\\n --format=\"value(instructions)\"\n```\n\nFor more options, see [Google Cloud SDK documentation for Cloud Key Management Service](/sdk/gcloud/reference/netapp/kms-configs).\n\nFor more information, see [Cloud Key Management Service user documentation](/kms/docs/quickstart).\n\nWhat's next\n-----------\n\n[Manage CMEK policies](/netapp/volumes/docs/configure-and-use/cmek/manage-cmek-policy)."]]
