Create a volume using NFS

09/29/2025 Contributors

You can use this workflow to create a volume accessed through NFS protocol.

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

Single Node
HA pair

Create a volume using NFS for a single node

You can use this workflow to create a volume using NFS for a single node system.

If the properties aggregateName and maxNumOfDisksApprovedToAdd are not provided on the REST API call, the response will fail with a suggested name for the aggregate and the number of disks needed to fulfill the request.

1. Select the system

Perform the workflow Get system and choose the publicId and the svmName values for the workingEnvironmentId and the svmName parameters. From the capacityFeatures field in the response, choose the value of the capacityTier parameter.

2. Select the aggregate

Perform the workflow Get aggregates and choose the name value of the aggregate for the name parameter. From the providerVolumes field in the response, you must also choose the value of the providerVolumeType parameter, the value of the iops parameter, and the value of the throughput parameter.

If aggregate name does not exist and the createAggregateIfNotFound query parameter is set true, the create volume request is allowed if the named aggregate is not found.

3. Choose the size for the disk

Choose the size value for the size:size parameter. The size:unit must be one of the following: TB, GB, MB, KB, or Byte.

4. Select the region

Perform the workflow Get regions workflow and pick ipCidrRange value of the required region→ subnets for exportPolicy→ips value.

5. Select the rules

Choose values for the exportPolicyInfo→rules→ruleAccessControl and exportPolicyInfo→rules→superUser parameters.

6. Create the quote

Perform the workflow Create a quote. This is a recommended step but is not mandatory.

7. Create the volume

HTTP method	Path
POST	/occm/api/gcp/vsa/volumes

curl example

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

Input

The JSON input example includes the minimum list of input parameters, including:

<WORKING_ENV_ID> (workingEnvironmentId)
<SVM_NAME> (svmName)
<AGGR_NAME> (aggregateName)

If aggregate name does not exist, you can set the createAggregateIfNotFound query parameter to true which allows the aggregate not-found condition.

JSON input example

{
  "workingEnvironmentId": "vsaworkingenvironment-u5lqmxrf",
   "svmName": "svm_name",
   "aggregateName": "aggr1",
   "name": "gcp_vol_nfs",
   "size": {
    "size": "1",
    "unit": "GB"
    },
    "snapshotPolicyName": "default",
    "exportPolicyInfo": {
      "policyType": "custom",
      "rules":
      [
        {
          "index": 1,
          "ruleAccessControl":
          "readwrite",
          "ips": [ "0.0.0.0/0" ],
          "nfsVersion": [
            "nfs3",
            "nfs4"
            ],
             "superUser": True
      }
    ]
 }
          "enableThinProvisioning": true,
          "enableCompression": true,
          "enableDeduplication": true,
          "maxNumOfDisksApprovedToAdd": 0,
          "evCapacityApprovedToAdd": null,
          "verifyNameUniqueness": true,
          "providerVolumeType": "pd-ssd",
          "iops": null,
          "throughput": null,
          "capacityTier": "cloudStorage",
          "tieringPolicy": "auto",
          "minimumCoolingDays": 31
}

Output: None

Create a volume using NFS for a high availability pair

You can use this workflow to create a volume using NFS for an HA system.

1. Select a system

2. Select an aggregate

If aggregate name does not exist and the createAggregateIfNotFound query parameter is set true, the create volume request is allowed if the named aggregate is not found.

3. Choose a size for the disk

Choose the size value for the size:size parameter. The size:unit must be one of the following: TB, GB, MB, KB, or Byte.

4. Select a region

Perform the workflow Get regions workflow and pick ipCidrRange value of the required region→ subnets for exportPolicy→ips value.

5. Select rules

Choose values for the exportPolicyInfo→rules→ruleAccessControl and exportPolicyInfo→rules→superUser
parameters.

6. Create a quote

Perform the workflow Create a quote. This is a recommended step but is not mandatory.

7. Create the volume

HTTP method	Path
POST	/occm/api/gcp/ha/volumes

curl example

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

Input

The JSON input example includes the minimum list of input parameters, including:

<WORKING_ENV_ID> (workingEnvironmentId)
<SVM_NAME> (svmName)
<AGGR_NAME> (aggregateName)

If aggregate name does not exist, you can set the createAggregateIfNotFound query parameter to true which allows the aggregate not-found condition.

JSON input example

{
  "workingEnvironmentId": "vsaworkingenvironment-u5lqmxrf",
   "svmName": "svm_name",
   "aggregateName": "aggr1",
   "name": "gcp_vol_nfs",
   "size": {
    "size": "1",
    "unit": "GB"
    },
    "snapshotPolicyName": "default",
    "exportPolicyInfo": {
      "policyType": "custom",
      "rules":
      [
        {
          "index": 1,
          "ruleAccessControl":
          "readwrite",
          "ips": [ "0.0.0.0/0" ],
          "nfsVersion": [
            "nfs3",
            "nfs4"
            ],
             "superUser": True
      }
    ]
 }
          "enableThinProvisioning": true,
          "enableCompression": true,
          "enableDeduplication": true,
          "maxNumOfDisksApprovedToAdd": 0,
          "evCapacityApprovedToAdd": null,
          "verifyNameUniqueness": true,
          "providerVolumeType": "pd-ssd",
          "iops": null,
          "throughput": null,
          "capacityTier": "cloudStorage",
          "tieringPolicy": "auto",
          "minimumCoolingDays": 31
}

Output: None