Create a system with capacity-based license

10/09/2025 Contributors

You can create a new Cloud Volumes ONTAP system using capacity-based licensing.

When using capacity-based license:

A marketplace subscription is required.
If you purchase a license from NetApp (BYOL), a NetApp Support Site (NSS) key is required to register the system for support.
You can add more volumes after creating the system. You can choose to create a volume using either NFS, CIFS, or iSCSI protocol.

Learn more about capacity-based licensing.

Choose the workflow to use based on the type of Cloud Volumes ONTAP deployment:

Single Node
HA pair

Create a system for a single node

You can use this workflow to create a single node system with capacity-based licensing.

1. Select the region

Perform the workflow Get regions and do the following:

Choose the name value of the required region for the region parameter in step 11.
Choose one of the VPCs. Choose name for vpcId parameter and subnets: path for subnetId and subnetPath parameters in step 11.

2. Select the workspace

Perform the workflow Get tenants and choose the workspacePublicId value for the tenantId parameter in step 11.

3. Select the project

Perform the workflow Get projects and choose the projectId value of the required project for project parameter in step 11.

4. Select the permutations

Perform the workflow Get permutations and choose the ontapVersion, license: type, and instanceType values of the required vsaMetadata parameter in step 11.

5. Select the capacity package name

Choose the package name for the vsaMetadata:capacityPackageName parameter in step 11. There are three licensing options available: Professional, Essentials, and Freemium. Review the Cloud Volumes ONTAP licensing types offered to new customers to know more about the available options.

6. Select the packages configuration

Perform the workflow Get packages and search the licenseType from the various permutations of packages configuration values:

Choose the name for packageName parameter in step 11.
Choose the diskSize for gcpVolumeSize in step 11.
Choose the diskType and writingSpeedState for the gcpVolumeType and writingSpeedState parameters in step 11.

7. Select the service account

Perform the workflow Get service accounts workflow and choose the email value of the required service accounts for the gcpServiceAccount parameter in step 11.

8. Attach a marketplace subscription

Perform the workflow Attach SaaS subscription and choose the subscriptionId value for the saasSubscriptionId parameter in step 11.

9. (Optional) Obtain an NSS key

An NSS key is optional when using a marketplace subscription. When using BYOL, you can create a key or select an existing key, and include the NSS key in the nssAccount parameter in step 11.

To create a new NSS key using the NetApp Console web user interface, perform the task Generate NSS user ID and choose the id.
To select an existing NSS key, perform the Get NSS keys workflow and choose the id value of the required NSS user.

10. (Optional) Add a BYOL license

If you purchase a license from NetApp (BYOL), ensure that the purchased license is available in the Console. The license gets automatically added to your account if you have associated the NSS account with the Console. To add the license manually, refer to Add purchased licenses to your account.

11. Create the system

HTTP method	Path
POST	/occm/api/gcp/vsa/working-environments

curl example

curl --location --request POST 'https://api.bluexp.netapp.com/occm/api/gcp/vsa/working-environments' --header 'x-agent-id: <AGENT_ID>' --header 'Authorization: Bearer <ACCESS_TOKEN>' ---header 'Content-Type: application/json' --d @JSONinput

Input: The JSON input example includes the minimum list of parameters.

This request uses the hourly pay-as-you-go (PAYGO) as indicated in the licenseType parameter.

JSON input example

{
  "name": "zivgcp01we03",
  "svmPassword": "password",
  "vpcId": "default",
  "region": "us-west1-b",
  "tenantId": "tenantID",
  "subnetPath": "projects/occm-dev/regions/us-west1/subnetworks/default",
  "subnetId": "projects/occm-dev/regions/us-west1/subnetworks/default",
  "dataEncryptionType": "GCP",
  "vsaMetadata": {
    "ontapVersion": "ONTAP-9.11.1RC1.T1",
    "licenseType": "capacity-paygo",
    "instanceType": "m5.2xlarge",
    "capacityPackageName": "Professional"
  },
  "gcpVolumeSize": {
    "size": 100,
    "unit": "GB"
  },
  "gcpVolumeType": "pd-ssd",
  "gcpLabels": [],
  "writingSpeedState": "NORMAL",
  "packageName": "gcp_poc",
  "gcpServiceAccount": "xxxxx@occm-dev.iam.xxx.com",
  "project": "occm-dev",
  "backupVolumesToCbs": false
}

JSON output example

{
    "publicId": "vsaworkingenvironment-2qkd75xv",
    "name": "zivgcp01we03",
    "tenantId": "tenantIDshownhere",
    "svmName": "svm_zivgcp01we03",
    "creatorUserEmail": "user_email",
    "status": null,
    "providerProperties": null,
    "reservedSize": null,
    "clusterProperties": null,
    "ontapClusterProperties": null,
    "cloudProviderName": "GCP",
    "snapshotPolicies": null,
    "actionsRequired": null,
    "activeActions": null,
    "replicationProperties": null,
    "schedules": null,
    "svms": null,
    "workingEnvironmentType": "VSA",
    "supportRegistrationProperties": null,
    "supportRegistrationInformation": null,
    "capacityFeatures": null,
    "encryptionProperties": null,
    "supportedFeatures": null,
    "isHA": false,
    "haProperties": null,
    "k8sProperties": null,
    "fpolicyProperties": null,
    "saasProperties": null,
    "cbsProperties": null,
    "complianceProperties": null,
    "monitoringProperties": null
}

Create a system for a high availability pair

You can use this workflow to create an HA system.

1. Select the region

Perform the workflow Get regions and do the following:

Choose the name value of the required region for the region parameter in step 12.
Choose one of the VPCs. Choose name for vpcId parameter and subnets: path for subnetId and subnetPath parameters in step 12.

2. Select the workspace

Perform the workflow Get tenants and choose the workspacePublicId value for the tenantId parameter in step 12.

3. Select the project

Perform the workflow Get projects and choose the projectId value of the required project for project parameter in step 12.

4. Select the VPC

Perform the Get vpcs workflow and do the following:

Choose one of the vpcs. Choose the name for the vpcId parameter, subnets: path for subnetId and subnetPath, ha: subnet0NodeAndDataConnectivity parameters and vpcPath for the vpc0NodeAndDataConnectivity parameter.
Choose the second vpc and select the vpcPath for vpc1ClusterConnectivity parameter and subnets: path for subnet1ClusterConnectivity parameter.
Choose the third vpc and select the vpcPath for pc2HAConnectivity parameter and subnets: path for subnet2HAConnectivity parameter.
Choose the fourth vpc and select the vpcPath for vpc3DataReplication parameter and subnets: path for subnet3DataReplication parameter.

5. Select the permutations

Perform the workflow Get permutations and choose the ontapVersion, license: type, and instanceType values of the required vsaMetadata parameter in step 12.

6. Select the capacity package name

Choose the package name for the vsaMetadata:capacityPackageName parameter in step 12. There are three licensing options available: Professional, Essentials, and Freemium. Review the Cloud Volumes ONTAP licensing types offered to new customers to know about the available options.

7. Select the packages configuration

Perform the workflow Get packages and search the licenseType from permutations:

Choose the name for packageName parameter.
Choose the diskSize for gcpVolumeSize.
Choose the diskType and writingSpeedState for the gcpVolumeType and writingSpeedState parameters.

8. Select the service account

Perform the workflow Get service accounts workflow and choose the email value of the required service accounts for the gcpServiceAccount parameter in step 12.

9. Attach a marketplace subscription

Perform the workflow Attach SaaS subscription and choose the subscriptionId value for the saasSubscriptionId parameter in step 12.

10. (Optional) Obtain an NSS key

An NSS key is optional when using a marketplace subscription. When using BYOL, you can create a key or select an existing key, and include the NSS key in the nssAccount parameter in step 12.

To create a new NSS key using the Console web user interface, perform the task Generate NSS user ID and choose the id.
To select an existing NSS key, perform the Get NSS keys workflow and choose the id value of the required NSS user.

11. (Optional) Add a BYOL license

12. Create the system

HTTP method	Path
POST	/occm/api/gcp/ha/working-environments

curl example

curl --location --request POST 'https://api.bluexp.netapp.com/occm/api/gcp/ha/working-environments' --header 'x-agent-id: <AGENT_ID>' //<1> --header 'Authorization: Bearer <ACCESS_TOKEN>' //<2> ---header 'Content-Type: application/json' --d @JSONinput

Input: The JSON input example includes the minimum list of parameters.

This request uses the hourly pay-as-you-go (PAYGO) as indicated in the licenseType parameter.

JSON input example

{
  "name": "ziv01we02ha",
  "svmPassword": "password",
  "vpcId": "default",
  "region": "us-west1-a",
  "tenantId": "workspace-ced4x9X4",
  "subnetPath": "projects/occm-dev/regions/us-west1/subnetworks/default",
  "subnetId": "projects/occm-dev/regions/us-west1/subnetworks/default",
  "dataEncryptionType": "GCP",
  "vsaMetadata": {
    "ontapVersion": "ONTAP-9.11.1RC1.T1",
    "licenseType": "ha-capacity-paygo",
    "instanceType": "m5.2xlarge",
    "capacityPackageName": "Professional"
  },
  "gcpVolumeSize": {
    "size": 100,
    "unit": "GB"
  },
  "gcpVolumeType": "pd-ssd",
  "gcpLabels": [],
  "writingSpeedState": "NORMAL",
  "packageName": "gcp_ha_poc",
  "gcpServiceAccount": "xxxx@occm-dev.iam.gserviceaccount.com",
  "project": "occm-dev",
  "haParams": {
    "node1Zone": "us-west1-a",
    "node2Zone": "us-west1-b",
    "mediatorZone": "us-west1-c",
    "vpc0NodeAndDataConnectivity": "projects/occm-dev/global/networks/default",
    "vpc1ClusterConnectivity": "projects/occm-dev/global/networks/vpc4qa-2",
    "vpc2HAConnectivity": "projects/occm-dev/global/networks/vpc4qa-3",
    "vpc3DataReplication": "projects/occm-dev/global/networks/vpc4qa-4",
    "subnet0NodeAndDataConnectivity": "projects/occm-dev/regions/us-west1/subnetworks/default",
    "subnet1ClusterConnectivity": "projects/occm-dev/regions/us-west1/subnetworks/vpc4qa-2-us-west1",
    "subnet2HAConnectivity": "projects/occm-dev/regions/us-west1/subnetworks/vpc4qa-3-us-west1",
    "subnet3DataReplication": "projects/occm-dev/regions/us-west1/subnetworks/vpc4qa-4-us-west1"
  }
}

JSON output example

{
    "publicId": "vsaworkingenvironment-blg9ei6u",
    "name": "ziv01we02ha",
    "tenantId": "Tenant-xxxvvv",
    "svmName": "svm_ziv01we02ha",
    "creatorUserEmail": "user_email",
    "status": null,
    "providerProperties": null,
    "reservedSize": null,
    "clusterProperties": null,
    "ontapClusterProperties": null,
    "cloudProviderName": "GCP",
    "snapshotPolicies": null,
    "actionsRequired": null,
    "activeActions": null,
    "replicationProperties": null,
    "schedules": null,
    "svms": null,
    "workingEnvironmentType": "VSA",
    "supportRegistrationProperties": null,
    "supportRegistrationInformation": null,
    "capacityFeatures": null,
    "encryptionProperties": null,
    "supportedFeatures": null,
    "isHA": true,
    "haProperties": null,
    "k8sProperties": null,
    "fpolicyProperties": null,
    "saasProperties": null,
    "cbsProperties": null,
    "complianceProperties": null,
    "monitoringProperties": null
}