Create volume using CIFS

Contributors netapp-ranuk

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

Note 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.

Choose the correct workflow depending on the type of Cloud Volumes ONTAP deployment:

Create volume using CIFS for single node

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

1. Choose the CIFS configuration

A CIFS server configuration must be defined for your working environment. You can do one of the following:

2. Select the working environment

Perform the workflow Get working environments and choose the publicId and the svmName values for the workingEnvironmentId (working environment) and the svmName (SVM name) parameters.

3. Select the aggregate

Perform the workflow Get aggregates and choose the name for the aggregateName value.

Note 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.

4. 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.

5. Create the quote

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

6. Create the volume

HTTP method Path

POST

/occm/api/vsa/volumes

curl example
curl --location --request POST 'https://cloudmanager.cloud.netapp.com/occm/api/vsa/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 an 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-SfpVUZSc",
  "svmName": "svm_zivaws02we01",
  "aggregateName": "aggr1",
  "name": "zivaws02we02vol02Cifs",
  "size": {
    "size": 100,
    "unit": "GB"
  },
  "shareInfo": {
    "accessControl": {
        "permission": "full_control",
        "users": [
            "Everyone"
        ],
        "users": "Everyone;"
    },
    "shareName": "zivaws02we01vol02Cifs_share"
  },
  "snapshotPolicyName": "default",
  "enableThinProvisioning": true,
  "enableCompression": true,
  "enableDeduplication": true,
  "maxNumOfDisksApprovedToAdd": 0
}
Output

None

Create volume using CIFS for high availability pair

You can use this workflow to create volume using CIFS for an HA working environment.

1. Choose the CIFS configuration

A CIFS server configuration must be defined for your working environment. You can do one of the following:

2. Select the working environment

Perform the workflow Get working environments and choose the publicId and the svmName values for the workingEnvironmentId (working environment) and the svmName (SVM name) parameters.

3. Select the aggregate

Perform the workflow Get aggregates and choose the name for the aggregateName value.

Note 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.

4. 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.

5. Create the quote

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

6. Create the volume

HTTP method Path

POST

/occm/api/aws/ha/volumes

curl example
curl --location --request POST 'https://cloudmanager.cloud.netapp.com/occm/api/aws/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 an 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-SfpVUZSc",
  "svmName": "svm_zivaws02we01",
  "aggregateName": "aggr1",
  "name": "zivaws02we02vol02Cifs",
  "size": {
    "size": 100,
    "unit": "GB"
  },
  "shareInfo": {
    "accessControl": {
        "permission": "full_control",
        "users": [
            "Everyone"
        ],
        "users": "Everyone;"
    },
    "shareName": "zivaws02we01vol02Cifs_share"
  },
  "snapshotPolicyName": "default",
  "enableThinProvisioning": true,
  "enableCompression": true,
  "enableDeduplication": true,
  "maxNumOfDisksApprovedToAdd": 0
}
Output

None