Manage ONTAP in ONTAP-mode

This page describes how to manage ONTAP in ONTAP-mode.

For security and logging reasons, NetApp Volumes doesn't allow direct connections to the ONTAP management LIF. Therefore, you can't use tools such as SystemManager or SSH to manage the ONTAP system directly. Instead, you can submit ONTAP operations to your ONTAP-mode storage pool using a Google proxy API for ONTAP REST API calls.

The management tools, such as Terraform, use the Google API proxy to manage ONTAP resources.

Use a Google proxy API for ONTAP REST API calls

NetApp Volumes provides a Google API endpoint for each Flex Unified ONTAP-mode storage pool, which lets you send ONTAP REST API calls to the underlying ONTAP cluster. This lets you control ONTAP features using APIs.

Calls to the ONTAP proxy must use the following URL format:

  https://netapp.googleapis.com/v1beta1/projects/PROJECT/locations/LOCATION/storagePools/POOL_NAME/ontap/ONTAP_REST_URL

This URL consists of following elements:

Baseline URL: https://netapp.googleapis.com/v1beta1/projects
Google URN for the storage pool: /PROJECT/locations/LOCATION/storagePools/POOL_NAME

Replace the following information:
- PROJECT: your project ID or number.
- LOCATION: the zone name for zonal pools or the region for regional pools.
- POOL_NAME: the name of your pool.
ONTAP REST API path: /ontap/ONTAP_REST_URL. For more information, see the ONTAP REST API reference.

List all volumes of a storage pool

The following example shows the full URL to list all volumes for the storage pool mypool in us-central1-a in project myproject.

https://netapp.googleapis.com/v1beta1/projects/myproject/locations/us-central1-a/storagePools/mypool/ontap/api/storage/volumes

Like all Google API calls, this call must be authenticated. The following CLI example fetches an API token, and then calls the URL using curl to list all volumes in the pool:

   TOKEN=$(gcloud auth print-access-token)
   curl --location
   'https://netapp.googleapis.com/v1beta1/projects/myproject/locations/us-central1-a/storagePools/mypool/ontap/api/storage/volumes' 

   --header "Authorization: Bearer $TOKEN" 

   --header "Content-Type: application/json"

Create a volume

This section shows how to create a volume named myvolume in an existing Flex Unified ONTAP-mode storage pool, identified by the URN: /projects/myproject/locations/us-central1-a/storagePools/mypool, using the ONTAP REST API.

To create a volume, see the ONTAP REST API online documentation. In the documentation, navigate to the Storage section, and then expand Manage storage volumes. This section provides several examples.

Use the following instructions to create a volume.

Determine the ONTAP REST API endpoint.

Using the basic example in NetApp Volumes, the required ONTAP API endpoint is /api/storage/volumes. This endpoint creates the URL: https://netapp.googleapis.com/v1beta1/projects/myproject/locations/us-central1-a/storagePools/mypool/ontap/api/storage/volumes.
Construct the request payload.

Use the example payload from the ONTAP documentation to match your specific environment. For example:
```
{
  "name": "vol1",
  "aggregates": [
    {
      "name": "aggr1"
    }
  ],
  "svm": {
    "name": "vs1"
  }
}
```
When you create a volume, use the name field to assign the volume name. The volume creation payload requires the names of the aggregate and the storage virtual machine (SVM) assigned by NetApp Volumes during ONTAP-mode pool creation. In ONTAP-mode, each storage pool has one SVM and one storage aggregate. This information can be retrieved by querying ONTAP for all SVMs.

To retrieve the SVM and the aggregate names:
1. Use ontap_fields for field selection: in NetApp Volumes ONTAP-mode pools, use the query parameter ontap_fields= instead of the standard ONTAP fields= parameter to specify the requested fields.
2. Optional: Usejq to extract fields: the following example uses the jq open source tool to extract the name (SVM name) and aggregates from the JSON response, which is useful for processing in shell scripts.
```
TOKEN=$(gcloud auth print-access-token)
curl --location
'https://netapp.googleapis.com/v1beta1/projects/myproject/locations/us-central1-a/storagePools/mypool/ontap/api/svm/svms?ontap_fields=name,aggregates' \
--header "Authorization: Bearer $TOKEN" \
--header "Content-Type: application/json" | jq '.rawResponse.records[] | {name: .name, aggregates: .aggregates[].name}'
```
  Example response:
```
{
 "name": "gcnv-7cf6ee41c1a94f0-svm-01",
 "aggregates": "aggr1"
}
```
Execute the volume creation API call.

With the aggregate name (aggr1) and the SVM name (gcnv-7cf6ee41c1a94f0-svm-01), create the final volume creation payload and submit the API call. Note that the ONTAP API payload must be enclosed within a body: {} envelope for NetApp Volumes.

The following example creates a volume named myvolume with a size of 2 GB:
```
curl --location
'https://netapp.googleapis.com/v1beta1/projects/myproject/locations/us-central1-a/storagePools/mypool/ontap/api/storage/volumes' \
--header "Authorization: Bearer $TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "body": {
    "name": "myvolume",
    "aggregates": [
      {
        "name": "aggr1"
      }
    ],
    "svm": {
      "name": "gcnv-7cf6ee41c1a94f0-svm-01"
    },
    "size": "2GB"
  }
}'
```
Volume creation supports many optional parameters, such as size. For example, the payload specifies a 2 GB size. The resource's documentation page lists all available parameters, including required and optional parameters. It also provides detailed examples of payloads and response bodies.

Monitor the ONTAP job.

Most ONTAP API calls, such as POST or PATCH operations that create or update resources, don't run synchronously. Instead, these calls return an ONTAP job resource, as shown in the volume creation example.

Example job response:

{
  "body": {
    "job": {
      "_links": {
        "self": {
          "href": "curl --location
'https://netapp.googleapis.com/v1beta1/projects/myproject/locations/us-central1-a/storagePools/mypool/ontap/api/cluster/jobs/15be1c46-fd2c-11f0-b3c2-7f15697be61c' \
--header "Authorization: Bearer $TOKEN" \
--header "Content-Type: application/json""
        }
      },
      "uuid": "15be1c46-fd2c-11f0-b3c2-7f15697be61c"
    }
  }
}

To check the job's status, query the job resource using the returned uuid:

curl --location
'https://netapp.googleapis.com/v1beta1/projects/myproject/locations/us-central1-a/storagePools/mypool/ontap/api/cluster/jobs/15be1c46-fd2c-11f0-b3c2-7f15697be61c' \
--header "Authorization: Bearer $TOKEN" \
--header "Content-Type: application/json"

Example response:

{
  "rawResponse": {
    "uuid": "15be1c46-fd2c-11f0-b3c2-7f15697be61c",
    "description": "POST
/api/storage/volumes/15be0ad9-fd2c-11f0-b3c2-7f15697be61c",
    "state": "success",
    "message": "success",
    "code": 0,
    "start_time": "2026-01-29T16:03:43+00:00",
    "end_time": "2026-01-29T16:03:44+00:00",
    "svm": {
      "name": "gcnv-7cf6ee41c1a94f0-svm-01",
      "uuid": "8a29c15d-fb31-11f0-ab03-03e1bb49206d"
   }
  }
}

If the state is success, the volume is created.

This example workflow guides you through looking up ONTAP actions in the ONTAP REST API documentation. It also shows you how to create the required payload format and submit it to the storage pool using a Google API. Finally, it demonstrates how to monitor an ONTAP job until the resource is created. With this approach, you can control most ONTAP settings for your storage pool.

Allowed ONTAP actions

When you access a pool through the API or CLI proxy, you have limited permissions and can't run all ONTAP commands. This protects the system's integrity. For some APIs, the system filters API request and response payloads. For example, because NetApp Volumes bills for logical capacity, the system blocks parameters for configuring physical capacity. If you send a parameter that isn't allowed, the API returns an error.

Delete an ONTAP-mode pool

To delete an ONTAP-mode pool, you must first delete all volumes in the pool.