Get aggregates
Contributors
Suggest changes
You can retrieve a list of available disk aggregates of an Azure working environment.
Choose the workflow to use based on the type of Cloud Volumes ONTAP deployment:
Get aggregates for single node
You can use this workflow to retrieve the aggregates for a single node working environment.
1. Create the working environment
Perform the workflow Create Azure single node working environment and choose the publicId value of the working environment for the workingEnvironmentId path parameter.
2. Get the list of aggregates
| HTTP method | Path |
|---|---|
GET |
/occm/api/azure/vsa/aggregates/{workingEnvironmentId} |
- curl example
curl --location --request GET 'https://cloudmanager.cloud.netapp.com/occm/api/azure/vsa/aggregates/<WORKING_ENV_ID>' --header 'Content-Type: application/json' --header 'x-agent-id: <AGENT_ID>' --header 'Authorization: Bearer <ACCESS_TOKEN>'- Input
-
Path parameter:
-
<WORKING_ENV_ID>
(workingEnvironmentId)string
-
- Output
-
An array of aggregates for the indicated working environment is returned as shown in the JSON output example.
|
The capacity (sizes) in the output are in MB/GB/TB (1000th order) because these are ONTAP aggregates, whereas in BlueXP the capacity is specified as MiB, GiB (1024 order). |
- JSON output example
[
{
"name": "aggr1",
"availableCapacity": {
"size": 905.27,
"unit": "GB"
},
"totalCapacity": {
"size": 906.29,
"unit": "GB"
},
"usedCapacity": {
"size": 1.02,
"unit": "GB"
},
"volumes": [
{
"name": "svm_ShirleyAzureVsa2601_root",
"totalSize": {
"size": 1.0,
"unit": "GB"
},
"usedSize": {
"size": 3.62396240234375E-4,
"unit": "GB"
},
"thinProvisioned": false,
"isClone": false,
"rootVolume": true
}
],
"providerVolumes": [
{
"id": "/subscriptions/x000xx00-0x00-0000-000x/resourceGroups/ShirleyAzureVsa2601-rg/providers/Microsoft.Compute/disks/ShirleyAzureVsa2601datadisk3",
"name": "ShirleyAzureVsa2601datadisk3",
"size": {
"size": 1.0,
"unit": "TB"
},
"state": "available",
"device": "3",
"instanceId": "/subscriptions/x000xx00-0x00-0000-000x/resourceGroups/ShirleyAzureVsa2601-rg/providers/Microsoft.Compute/virtualMachines/ShirleyAzureVsa2601",
"diskType": "Premium_LRS",
"encrypted": false,
"iops": null
}
],
"disks": [
{
"name": "NET-1.2",
"position": "data",
"ownerNode": "ShirleyAzureVsa2601-01",
"device": "LUN 5.3",
"vmDiskProperties": null
}
],
"state": "online",
"encryptionType": "notEncrypted",
"encryptionKeyId": null,
"isRoot": false,
"homeNode": "ShirleyAzureVsa2601-01",
"ownerNode": "ShirleyAzureVsa2601-01",
"capacityTier": null,
"capacityTierUsed": null,
"sidlEnabled": false,
"snaplockType": "non_snaplock"
},
{
"name": "aggr2",
"availableCapacity": {
"size": 906.29,
"unit": "GB"
},
"totalCapacity": {
"size": 906.29,
"unit": "GB"
},
"usedCapacity": {
"size": 3.48,
"unit": "MB"
},
"volumes": [],
"providerVolumes": [
{
"id": "/subscriptions/x000xx00-0x00-0000-000x/resourceGroups/ShirleyAzureVsa2601-rg/providers/Microsoft.Compute/disks/ShirleyAzureVsa2601datadisk4",
"name": "ShirleyAzureVsa2601datadisk4",
"size": {
"size": 1.0,
"unit": "TB"
},
"state": "available",
"device": "4",
"instanceId": "/subscriptions/x000xx00-0x00-0000-000x/resourceGroups/ShirleyAzureVsa2601-rg/providers/Microsoft.Compute/virtualMachines/ShirleyAzureVsa2601",
"diskType": "Premium_LRS",
"encrypted": false,
"iops": null
}
],
"disks": [
{
"name": "NET-1.3",
"position": "data",
"ownerNode": "ShirleyAzureVsa2601-01",
"device": "LUN 5.4",
"vmDiskProperties": null
}
],
"state": "online",
"encryptionType": "notEncrypted",
"encryptionKeyId": null,
"isRoot": false,
"homeNode": "ShirleyAzureVsa2601-01",
"ownerNode": "ShirleyAzureVsa2601-01",
"capacityTier": null,
"capacityTierUsed": null,
"sidlEnabled": false,
"snaplockType": "non_snaplock"
},
{
"name": "aggr3",
"availableCapacity": {
"size": 1.77,
"unit": "TB"
},
"totalCapacity": {
"size": 1.77,
"unit": "TB"
},
"usedCapacity": {
"size": 5.78,
"unit": "MB"
},
"volumes": [],
"providerVolumes": [
{
"id": "/subscriptions/x000xx00-0x00-0000-000x/resourceGroups/ShirleyAzureVsa2601-rg/providers/Microsoft.Compute/disks/ShirleyAzureVsa2601datadisk5",
"name": "ShirleyAzureVsa2601datadisk5",
"size": {
"size": 1.0,
"unit": "TB"
},
"state": "available",
"device": "5",
"instanceId": "/subscriptions/x000xx00-0x00-0000-000x/resourceGroups/ShirleyAzureVsa2601-rg/providers/Microsoft.Compute/virtualMachines/ShirleyAzureVsa2601",
"diskType": "Premium_LRS",
"encrypted": false,
"iops": null
},
{
"id": "/subscriptions/x000xx00-0x00-0000-000x/resourceGroups/ShirleyAzureVsa2601-rg/providers/Microsoft.Compute/disks/ShirleyAzureVsa2601datadisk6",
"name": "ShirleyAzureVsa2601datadisk6",
"size": {
"size": 1.0,
"unit": "TB"
},
"state": "available",
"device": "6",
"instanceId": "/subscriptions/x000xx00-0x00-0000-000x/resourceGroups/ShirleyAzureVsa2601-rg/providers/Microsoft.Compute/virtualMachines/ShirleyAzureVsa2601",
"diskType": "Premium_LRS",
"encrypted": false,
"iops": null
}
],
"disks": [
{
"name": "NET-1.4",
"position": "data",
"ownerNode": "ShirleyAzureVsa2601-01",
"device": "LUN 5.5",
"vmDiskProperties": null
},
{
"name": "NET-1.5",
"position": "data",
"ownerNode": "ShirleyAzureVsa2601-01",
"device": "LUN 5.6",
"vmDiskProperties": null
}
],
"state": "online",
"encryptionType": "notEncrypted",
"encryptionKeyId": null,
"isRoot": false,
"homeNode": "ShirleyAzureVsa2601-01",
"ownerNode": "ShirleyAzureVsa2601-01",
"capacityTier": null,
"capacityTierUsed": null,
"sidlEnabled": false,
"snaplockType": "non_snaplock"
}
]Get aggregates for high availability pair
You can use this workflow to retrieve the aggregates for an HA working environment.
1. Create the working environment
Perform the workflow Create Azure HA working environment and choose the publicId value of the working environment for the workingEnvironmentId path parameter.
2. Get the list of aggregates
| HTTP method | Path |
|---|---|
GET |
/occm/api/azure/ha/aggregates/{workingEnvironmentId} |
- curl example
curl --location --request GET 'https://cloudmanager.cloud.netapp.com/occm/api/azure/ha/aggregates/<WORKING_ENV_ID>' --header 'Content-Type: application/json' --header 'x-agent-id: <AGENT_ID>' --header 'Authorization: Bearer <ACCESS_TOKEN>'- Input
-
Path parameter:
-
<WORKING_ENV_ID>
(workingEnvironmentId)string
-
- Output
-
An array of aggregates for the indicated working environment is returned as shown in the JSON output example.
|
|
The capacity (sizes) in the output are in MB/GB/TB (1000th order) because these are ONTAP aggregates, whereas in BlueXP the capacity is specified as MiB, GiB (1024 order). |
- JSON output example
[
{
"name": "aggr1",
"availableCapacity": {
"size": 906.16,
"unit": "GB"
},
"totalCapacity": {
"size": 907.18,
"unit": "GB"
},
"usedCapacity": {
"size": 1.01,
"unit": "GB"
},
"volumes": [
{
"name": "svm_ShirleyHa2801_root",
"totalSize": {
"size": 1.0,
"unit": "GB"
},
"usedSize": {
"size": 3.24249267578125E-4,
"unit": "GB"
},
"thinProvisioned": false,
"isClone": false,
"rootVolume": true
}
],
"providerVolumes": [
{
"id": "ki4cw3n3oyha",
"name": "ki4cw3n3oyha",
"size": {
"size": 1.0,
"unit": "TB"
},
"state": "available",
"device": "",
"instanceId": "",
"diskType": "Premium_LRS",
"encrypted": true,
"iops": null
}
],
"disks": [
{
"name": "NET-1.3",
"position": "data",
"ownerNode": "ShirleyHa2801-01",
"device": "",
"vmDiskProperties": {
"objectName": "ki4cw3n3oyha",
"storageAccountName": "rootsacnqfypfg",
"containerName": "blobcontainer"
}
}
],
"state": "online",
"encryptionType": "cloudEncrypted",
"encryptionKeyId": null,
"isRoot": false,
"homeNode": "ShirleyHa2801-01",
"ownerNode": "ShirleyHa2801-01",
"capacityTier": "Blob",
"capacityTierUsed": {
"size": 0.0,
"unit": "GB"
},
"sidlEnabled": true,
"snaplockType": "non_snaplock"
},
{
"name": "aggr2",
"availableCapacity": {
"size": 907.18,
"unit": "GB"
},
"totalCapacity": {
"size": 907.18,
"unit": "GB"
},
"usedCapacity": {
"size": 500.0,
"unit": "KB"
},
"volumes": [],
"providerVolumes": [
{
"id": "1102qyj51rwt",
"name": "1102qyj51rwt",
"size": {
"size": 1.0,
"unit": "TB"
},
"state": "available",
"device": "",
"instanceId": "",
"diskType": "Premium_LRS",
"encrypted": true,
"iops": null
}
],
"disks": [
{
"name": "NET-1.4",
"position": "data",
"ownerNode": "ShirleyHa2801-01",
"device": "",
"vmDiskProperties": {
"objectName": "1102qyj51rwt",
"storageAccountName": "rootsacnqfypfg",
"containerName": "blobcontainer"
}
}
],
"state": "online",
"encryptionType": "cloudEncrypted",
"encryptionKeyId": null,
"isRoot": false,
"homeNode": "ShirleyHa2801-01",
"ownerNode": "ShirleyHa2801-01",
"capacityTier": "Blob",
"capacityTierUsed": {
"size": 0.0,
"unit": "GB"
},
"sidlEnabled": true,
"snaplockType": "non_snaplock"
}
]