Create a FlexGroup volume

08/21/2023 Contributors

You can use this workflow to create an ONTAP FlexGroup volume.

Requirements

The ONTAP cluster must be running version 9.7 or later.
You should be aware of the considerations and requirements when selecting the aggregates for provisioning a FlexGroup volume. See the ONTAP documentation for more details.
You should be aware of minimum and maximum size limits. See the NetApp ONTAP FlexGroup volumes best practices and implementation guide for more details.

Limitations

FlexGroup volumes are not supported as a source for data replication from the BlueXP replication service.
FlexGroup volumes do not support iSCSI block protocol.

1. Select the working environment

Perform the workflow Get working environments and choose the publicId and the svmName values for the workingEnvironmentId and the svmName input parameters.

2. Select the aggregates and constituents

Select one or more aggregates as needed.
Perform the workflow Get aggregates and choose the name values of the aggregates for the flexGroupVolumeInfo → aggregateList input parameter.
Choose the desired value for the flexGroupVolumeInfo → numberOfConstituents input parameter.
As a general rule, the minimum or maximum size limit of a FlexGroup volume is based on the number of constituent members. The maximum member constituent count is 200; the minimum size of a constituent member volume is 100GB and the maximum member volume size is 100TB. For example, if you provide the value of the flexGroupVolumeInfo → numberOfConstituents parameter as 10, the minimum volume size should be 100GB * 10 = 1TB and the maximum volume size should be 100TB * 10 = 1000TB.

If one or more aggregates do not exist and the aggregate names are not provided on the REST API call, the response will fail and the API call will be aborted.
The flexGroupVolumeInfo → numberOfConstituents parameter in the API request signifies the total number constituents of a FlexGroup volume. This number must be distributed equally among the required aggregates in the flexGroupVolumeInfo → aggregateList list, otherwise the API call will fail.

3. Select the network

Choose the desired value for the exportPolicyInfo input parameter. You need to specify your internal network IP for the ips input parameter that can access a volume.

4. Choose the size for the disk

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

5. Create the volume

HTTP method	Path
POST	/occm/api/onprem/volumes

curl example

curl --location --request POST 'https://cloudmanager.cloud.netapp.com/occm/api/onprem/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)

JSON input example

{
  "verifyNameUniqueness": true,
  "name": "fgvol3",
  "volumeTags": [],
  "size": {
    "size": "2",
    "unit": "TB"
  },
  "enableCompression": true,
  "enableDeduplication": true,
  "flexGroupVolumeInfo": {
    "aggregateList": [
      "aggr2GP3",
      "aggr1"
    ],
    "numberOfConstituents": 10
  },
  "enableThinProvisioning": true,
  "svmName": "svm_cvogalinaonprem",
  "snapshotPolicyName": "default",
  "autoVsaCapacityManagementEnabled": true,
  "exportPolicyInfo": {
    "policyType": "custom",
    "rules": [
      {
        "nfsVersion": [
          "nfs3",
          "nfs4"
        ],
        "ruleAccessControl": "readwrite",
        "ips": [
          "0.0.0.0/0"
        ],
        "superUser": true,
        "index": 1
      }
    ]
  },
  "workingEnvironmentId": "OnPremWorkingEnvironment-xx"
}

Output: None