Create quote

03/30/2022 Contributors

You can create a quote for a new volume which returns a resource quote needed to satisfy the request. The resource quote contains aggregate information where the volume will be created and confirms if the space is available. This is a recommended step but is not mandatory.

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

Single Node
HA pair

Create quote for single node

You can use this workflow to retrieve quote details for a single node working environment.

1. Select the working environment

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

2. Select the aggregate

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

3. Select the permutations configuration

Perform the workflow Get permutations and choose the size and diskType values for step 4.

4. Generate the volume quote

HTTP method	Path
POST	/occm/api/vsa/quote

curl example

curl --location --request POST 'https://cloudmanager.cloud.netapp.com/occm/api/vsa/volumes/quote' --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 list of input parameters.
JSON input example

{
  "workingEnvironmentId": "VsaWorkingEnvironment-5dZfyKS5",
  "svmName": "svm_ziv01we01",
  "aggregateName": "ziv01agg01",
  "name": "ziv1vol02",
  "size": {
    "size": "100",
    "unit": "GB"
  },
  "enableThinProvisioning": "true",
  "providerVolumeType": "gp2",
  "verifyNameUniqueness": "true"
}

Output: The JSON output example includes an example of the quote details.

JSON output example

{
    "numOfDisks": 0,
    "diskSize": {
        "size": 100.0,
        "unit": "GB"
    },
    "aggregateName": "ziv01agg01",
    "newAggregate": false,
    "autoVsaCapacityManagement": true
}

Create quote for high availability pair

You can use this workflow to retrieve quote details for an HA working environment.

1. Select the working environment

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

2. Select the aggregate

Perform the workflow Get aggregates and choose the name value for step 4.

3. Select the package

Perform the Get packages workflow and select the size and diskType values of the required package for diskSize and providerVolumeType values.

4. Generate the volume quote

HTTP method	Path
POST	/occm/api/aws/ha/quote

curl example

curl --location --request POST 'https://cloudmanager.cloud.netapp.com/occm/api/aws/ha/volumes/quote' --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 list of input parameters.
JSON input example

{
  "workingEnvironmentId": "VsaWorkingEnvironment-N6BPfglr",
  "svmName": "svm_ziv04we01ha",
  "aggregateName": "aggr1",
  "name": "ziv04we01haagg01vol01",
  "size": {
    "size": "100",
    "unit": "GB"
  },
  "enableThinProvisioning": "true",
  "providerVolumeType": "gp2",
  "verifyNameUniqueness": "true"
}

Output: The JSON output example includes an example of the quote details.
JSON output example

{
    "numOfDisks": 0,
    "diskSize": {
        "size": 100.0,
        "unit": "GB"
    },
    "aggregateName": "ziv04we01haagg01",
    "newAggregate": false,
    "autoVsaCapacityManagement": true
}