How the REST APIs work
OnCommand Cloud Manager includes REST APIs that enable software developers to automate the management of Cloud Volumes ONTAP (formerly ONTAP Cloud). You should understand how the APIs work before you get started.
API resources
The Cloud Manager APIs enable you to perform operations on different types of resources. The resources are broadly categorized as follows:
-
Administrative resources
Used to set up and configure Cloud Manager -
Auditing resources
Used to view details about Cloud Manager operations -
Authentication resources
Used to authenticate with Cloud Manager so you can run API operations -
Working environment resources
Used to deploy and manage working environments: single Cloud Volumes ONTAP systems, Cloud Volumes ONTAP HA configurations, and ONTAP clusters
API endpoint
Cloud Manager API URLs are relative to http://ip_address:port/occm/api.
For example, the request URL to a launch Cloud Volumes ONTAP in AWS is http://ip_address:port/occm/api/vsa/working-environments.
API request and response formats
The REST API issues calls through HTTP requests and responses. The HTTP message body carries data objects in readable strings, in the default JSON (JavaScript Object Notation) format.
Responses can be a JSON object, or an array of JSON objects.
The format of a JSON object is as follows:
{
name: "string"
}
The format of an array of JSON objects is as follows:
[
{name: "string"}, {name: "string"}
]
Header fields
You must specify the Content-Type field in the header for each API call. The Accept field is optional. Both fields must be set to application/json for most API calls:
Accept: application/json Content-Type: application/json
| The server automatically returns content in JSON format if Accept is not specified. |
The API reference identifies when Content-Type and Accept must be set to different values. For example, for backup API calls, Content-Type must be set to multiport/form-data and for restore API calls, Accept must be set to application/octet-stream.
Each API returns a custom HTTP header field named OnCloud-Request-Id. You can use the value of this field to track the progress of requests using the audit API calls.
Public IDs
All Cloud Manager resources (for example, users, tenants, and working environments) are assigned a public ID. Whenever a resource is created or returned, the public ID is displayed in the response. You must specify a resource’s public ID when performing operations on the resource. For example, you must specify the public ID for a working environment when you create a volume.
HTTP status codes
| HTTP code | Description |
|---|---|
200 |
The operation was completed successfully and the API sent a response. |
202 |
The operation was accepted and is currently in process. Cloud Manager returns this code when the API operation returns before the actual operation finishes. For example, the /vsa/working-environments operation returns with code 202, but the Cloud Volumes ONTAP instance successfully launches up to 25 minutes later. |
204 |
The operation was completed successfully and the API did not send a response. |
400 |
There was an error with the client’s request. An error response explains the reason. |
401 |
The user has not authenticated. |
403 |
The user has authenticated but does not have permissions to perform the operation on the resource. |
409 |
The operation failed because another operation is already in progress. |
420 |
Cloud Manager has not been set up. You must set up Cloud Manager using the API call /occm/setup/init |
5xx |
An error occurred with the Cloud Manager server. |
URI scheme
Host: localhost
BasePath: /occm/api
Schemes: HTTP
Authentication with NetApp Cloud Central
Most API operations require an authentication header that specifies a token. The token identifies the client/caller.
Before you can get the token, you need to obtain the domain and client IDs from Cloud Manager. You can obtain the IDs by calling the support-services API.
After you obtain the IDs, you can then invoke Cloud Manager’s authentication API to get the token.
The following example first obtains the domain and client IDs and then invokes the authentication API:
curl -X GET http://localhost/occm/api/occm/system/support-services |jq -r .portalService.auth0Information > info.txt
clientId=`cat info.txt|jq -r .clientId`
domain=`cat info.txt|jq -r .domain`
audience=`cat info.txt|jq -r .audience`
curl https://$domain/oauth/token -X POST --header "Content-Type:application/json" --data "{\"grant_type\": \"password\",\"username\": \"$email\",\"password\": \"$password\",\"audience\": \"$audience\",\"scope\": \"profile\",\"client_id\": \"$clientId\"}" | jq -r .access_token > token.txt
token+=`cat token.txt`
| This new authentication method was introduced in Cloud Manager 3.5. Previous versions of Cloud Manager used a cookie for authentication. That login method is still supported, but we recommend using this new authentication method. |
Accessing the API reference and running operations using Swagger
Cloud Manager provides interactive API documentation through the Swagger interface. You can use Swagger to find descriptions of the APIs and to run the operations.
Steps
-
Click the link in the lower-right corner of the console, or enter the URL http://server/occm/api-doc in your web browser.
-
Expand the operations for the API calls to view the API descriptions.
- Example
-
The following image shows an API description:
-
If desired, run the operations directly from Swagger by entering values for the parameters and then clicking Try it out!
- Example
-
The following image shows an example result:
API examples
Reviewing API examples can help you understand how to use the Cloud Manager APIs yourself.
| The examples use curl as the HTTP client. Some examples show API calls for single Cloud Volumes ONTAP systems and others show API calls for Cloud Volumes ONTAP HA configurations. |
Creating an AWS Cloud Provider Account
You need to add one or more Cloud Provider Accounts to Cloud Manager so you can specify the AWS account in which you want to deploy Cloud Volumes ONTAP.
curl -X POST http://localhost/occm/api/accounts/aws --header "Authorization: $token" --header "Content-Type: application/json" --data "{\"accountName\": \"AWSAdminKeys\", \"providerKeys\": {\"awsAccessKeys\": {\"accessKey\": \"$accessKey\",\"secretKey\":\"$secretKey\"}}}"
Creating an Azure Cloud Provider Account
You need to add one or more Cloud Provider Accounts to Cloud Manager so you can specify the Azure account in which you want to deploy Cloud Volumes ONTAP.
curl -X POST http://localhost/occm/api/accounts/azure --header "Authorization: $token" --header "Content-Type: application/json" --data "{\"accountName\": \"AzureAdminKeys\", \"providerKeys\": {\"tenantId\": \"$azureTenantId\",\"applicationId\": \"$azureApplicationId\",\"applicationKey\": \"$azureApplicationKey\"}}"
Obtaining your Cloud Provider Account ID
When you create a working environment, you must provide the ID of a Cloud Provider Account.
curl -X GET http://localhost/occm/api/accounts --header "Authorization: $token" |jq -r '.azureAccounts[0]'.publicId > temp.txt azureAccountId=`cat temp.txt` curl -X GET http://localhost/occm/api/accounts --header "Authorization: $token" |jq -r '.awsAccounts[0]'.publicId > temp.txt awsAccountId=`cat temp.txt`
Preparing to launch Cloud Volumes ONTAP in AWS
When you launch Cloud Volumes ONTAP, you must specify valid values for license type, AWS region, Cloud Volumes ONTAP version, and instance type. You can obtain valid values for your version of Cloud Manager by using the following API call:
curl http://localhost/occm/api/vsa/metadata/manifests -X GET --header "Content-Type:application/json" --header "Authorization:$token"
Note the following about the response for this API:
-
For licenses, the type field displays valid values for the licenseType parameter.
-
For regions, the code field displays valid values for the region parameter.
-
For Cloud Volumes ONTAP versions, the valid values for the ontapVersion parameter display underneath the version of Cloud Manager that you are running.
-
For instance types, the valid values for the instanceType parameter display underneath each license type.
You must also identify the target VPC and subnet before you can launch Cloud Volumes ONTAP. The following API call provides the target VPC ID and subnet ID in a specific region:
curl "http://localhost/occm/api/vsa/metadata/vpcs?region=$region&cloudProviderAccountId=$awsAccountId" -X GET --header "Content-Type:application/json" --header "Authorization:$token" | jq .
Launching a single Cloud Volumes ONTAP instance in AWS
The following operation launches Cloud Volumes ONTAP in AWS:
curl http://localhost/occm/api/vsa/working-environments -X POST --header "Authorization:$token" --header "Content-Type:application/json" --data "{\"name\":\"kuki\",\"tenantId\":\"$tenantId\",\"region\":\"$region\",\"subnetId\":\"$subnetId\",\"ebsVolumeType\":\"gp2\",\"ebsVolumeSize\": {\"size\": 500, \"unit\": \"GB\"},\"dataEncryptionType\":\"NONE\",\"ontapEncryptionParameters\":null,\"svmPassword\":\"$svmPassword\",\"vpcId\":\"$vpcId\",\"cloudProviderAccount\": \"$awsAccountId\",\"vsaMetadata\":{\"platformSerialNumber\":null,\"ontapVersion\":\"ONTAP.ENG-9.4.T1\",\"licenseType\":\"cot-standard-paygo\",\"instanceType\":\"m4.2xlarge\"},\"writingSpeedState\":\"NORMAL\"}"
| The preceding example does not specify a license or a volume. |
To monitor the creation of the instance, you can use the following API call:
curl http://localhost/occm/api/vsa/working-environments -X GET --header "Content-Type:application/json" --header "Authorization:$token" | jq -r .[0].publicId > vsaId.txt weid=`cat vsaId.txt`
After the Cloud Volumes ONTAP instance is up and running, you can use the following API call to get details about the instance:
curl "http://localhost/occm/api/vsa/working-environments?fields=status,svmName,awsProperties,reservedSize,encryptionProperties,ontapProperties,actionsRequired,cronJobSchedules,snapshotPolicies,svms,activeActions,interClusterLifs,capacityFeatures,replicationProperties&tenantId=%tenantId%" -X GET --header "Content-Type:application/json" --header "Authorization:$token"
A sample response follows:
{"id":"VsaWorkingEnvironment-UU72AEtE","status":"ON",
"lifs":[{"ip":"4.4.4.4","netmask":"mgmt","lifType":"Node Management",
"dataProtocols":[]},{"ip":"10.20.1.2","netmask":"data","lifType":
"Node Management","dataProtocols":[]},{"ip":"10.20.1.1","netmask":
"data","lifType":"Cluster Management","dataProtocols":[]},
{"ip":"10.20.1.6","netmask":"data","lifType":"Intercluster",
"dataProtocols":[]},{"ip":"10.20.1.4","netmask":"data","lifType":
"Data","dataProtocols":["iscsi"]},{"ip":"10.20.1.5","netmask":
"data","lifType":"Data","dataProtocols":["nfs","cifs"]},
{"ip":"10.20.1.7","netmask":"mgmt","lifType":"SVM Management",
"dataProtocols":[]}],
"serialNumber":"serial-vsa1",
"systemId":"system-id-vsa1",
"clusterName":"vsa1",
"ontapVersion":"ONTAP-9.4.T1",
"accountId":"account123",
"productCode":"",
"amiId":"ami-7731c31c",
"systemManagerUrl":"https://10.20.1.1/sysmgr/SysMgr.html",
"creationTime":1388527200000,
"instanceId":"i-1",
"platformLicense":"",
"licenseExpiryDate":0,
"instanceType":"m4.2xlarge",
"publicIp":null,
"publicDnsName":null,
"activeActions":null,
"licenseType":{"name":"ONTAP Cloud Standard",
"capacityLimit":{"size":10.0,"unit":"TB"}},
"vsaEncryptionResponse":{"awsVolumeEncryption":false,"keyManagers":[],
"ontapEncryption":false,
"ontapEncryptionCertificates":[]}}
You should make note of the working environment ID because you must specify it when performing subsequent operations on the working environment.
Deploying a Cloud Volumes ONTAP system in Azure
The following operation deploys a Cloud Volumes ONTAP system in Azure:
curl http://localhost/occm/api/azure/vsa/working-environments -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"name\": \"vsaAzure\",\"tenantId\": \"$tenantId\",\"region\": \"westus\",\"vsaMetadata\": { \"ontapVersion\": \"ONTAP-9.4X8.T1.azure\", \"licenseType\": \"azure-cot-standard-paygo\", \"instanceType\": \"Standard_DS4_v2\"},\"writingSpeedState\": \"NORMAL\",\"subnetId\": \"$azureSubnetId\",\"svmPassword\": \"$svmPassword\",\"vnetId\": \"$azureVnetId\",\"cloudProviderAccount\": \"$azureAccountId\",\"subscriptionId\": \"$azureSubscriptionId\",\"cidr\": \"$azureCidr\",\"dataEncryptionType\": \"NONE\",\"ontapEncryptionParameters\": null,\"securityGroupId\": null,\"skipSnapshots\": false,\"diskSize\": { \"size\": 1, \"unit\": \"TB\"},\"storageType\": \"Premium_LRS\",\"azureTags\": []}" | jq .
The following API call monitors creation of the system:
curl http://localhost/occm/api/azure/vsa/working-environments -X GET --header "Content-Type:application/json" --header "Authorization:$token" | jq -r .[0].publicId > azureId.txt azureId=`cat azureId.txt`
Creating an aggregate for a single Cloud Volumes ONTAP system in AWS
Use the following API call to create a new aggregate on a Cloud Volumes ONTAP system:
curl http://localhost/occm/api/vsa/aggregates -X POST --header "Content-Type:application/json" header "Authorization:$token" --data "{\"name\": \"aggr33\",\"workingEnvironmentId\": \"%weid%\", \"numberOfDisks\": \"2\", \"diskSize\": {\"size\": \"500\", \"unit\": \"GB\"}, \"providerVolumeType\": \"gp2\"}"
After Cloud Manager creates the aggregate, you can use the following API call to get details about it:
curl http://localhost/occm/api/vsa/aggregates?workingEnvironmentId=%weid% -X GET --header "Content-Type:application/json" --header "Authorization:$token"
Creating an aggregate for a Cloud Volumes ONTAP system in Azure
The following API call creates an aggregate on a Cloud Volumes ONTAP system in Azure using the public ID returned when creating the working environment:
curl http://localhost/occm/api/azure/vsa/aggregates -X POST --header "Content-Type:application/json" header "Authorization:$token" --data "{\"name\": \"aggr2\",\"workingEnvironmentId\": \"%azureId%\",\"numberOfDisks\": \"2\",\"diskSize\": {\"size\": \"1\",\"unit\": \"TB\"},\"providerVolumeType\": \"Standard_LRS\"}"
Creating a volume on a single Cloud Volumes ONTAP system in AWS
The first API call in the following example gets the Storage Virtual Machine (SVM) name to specify when creating the volume. The second API call gets the required number of disks and the aggregate name in which to create the volume. The third API call creates a new volume on a Cloud Volumes ONTAP system using the public ID of the working environment, which was returned after Cloud Manager created the working environment.
| If aggregateName and maxNumOfDisksApprovedToAdd are not specified, then the response fails with a suggested aggregate name and the number of disks that Cloud Manager needs to create to fulfill the request. |
curl "http://localhost/occm/api/vsa/working-environments/%weid%?fields=svmName" -X GET --header "Content-Type:application/json" --header "Authorization:$token" | jq -r .svmName > svm.txt
svm=`cat svm.txt`
curl http://localhost/occm/api/vsa/volumes/quote -X POST --header "Content-Type:application/json" header "Authorization:$token" --data "{\"workingEnvironmentId\": \"%weid%\",\"svmName\": \"%svm%\",\"aggregateName\": \"aggr33\", \"name\": \"newVol\", \"size\": {\"size\": \"100\", \"unit\": \"GB\"}, \"enableThinProvisioning\": \"true\", \"providerVolumeType\": \"gp2\"}" > quote.txt
cat quote.txt| jq -r .numOfDisks >disks.txt
cat quote.txt| jq -r .aggregateName >aggrName.txt
disks=`cat disks.txt`
aggrName=`cat aggrName.txt`
curl http://localhost/occm/api/vsa/volumes -X POST --header "Content-Type:application/json" header "Authorization:$token" --data "{\"name\":\"newVol\",\"workingEnvironmentId\":\"%weid%\",\"svmName\":\"%svm%\",\"exportPolicyInfo\":{\"policyType\":\"custom\",\"ips\":[\"0.0.0.0\/0\"]},\"snapshotPolicyName\":\"default\",\"size\":{\"size\":\"100\",\"unit\":\"GB\"},\"enableThinProvisioning\":\"true\",\"enableDeduplication\":\"true\",\"enableCompression\":\"false\",\"maxNumOfDisksApprovedToAdd\":\"%disks%\",\"aggregateName\":\"%aggrName%\",\"providerVolumeType\":\"gp2\"}"
Creating a volume on an aggregate that uses Provisioned IOPS SSDs
In this example, the first API call obtains the required number of disks and the aggregate name for the volume. The second call creates the volume. Note that the first API call might not return the aggregateName parameter. If that happens, Cloud Manager chooses the best matching aggregate (if one exists) or it creates a new aggregate that meets the requirements.
curl http://localhost/occm/api/vsa/volumes/quote -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"workingEnvironmentId\":\"%weid%\",\"svmName\":\"%svm%\", \"name\":\"newVol1\",\"iops\":500,\"providerVolumeType\":\"io1\",\"verifyNameUniqueness\":true,\"size\":{\"size\":100,\"unit\":\"GB\"},\"enableThinProvisioning\":true,\"enableDeduplication\":true,\"enableCompression\":true}" > quote.txt
cat quote.txt| jq -r .numOfDisks >disks.txt
cat quote.txt| jq -r .aggregateName >aggrName.txt
disks=`cat disks.txt`
aggrName=`cat aggrName.txt`
curl http://localhost/occm/api/vsa/volumes?createAggregateIfNotFound=true -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"workingEnvironmentId\":\"%weid%\", \"svmName\":\"%svm%\", \"exportPolicyInfo\":{\"policyType\":\"custom\", \"ips\":[\"10.30.0.0/16\"],\"_ips\":\"10.30.0.0/16\"},\"snapshotPolicyName\":\"default\",\"name\":\"newVol1\",\"iops\":500,\"providerVolumeType\":\"io1\",\"verifyNameUniqueness\":true,\"size\":{\"size\":100,\"unit\":\"GB\"},\"enableThinProvisioning\":true,\"enableDeduplication\":true,\"enableCompression\":true,\"maxNumOfDisksApprovedToAdd\":\"%disks%\", \"aggregateName\":\"%aggrName%\"}"
Stopping a single Cloud Volumes ONTAP instance in AWS
The following operation stops a Cloud Volumes ONTAP instance in AWS:
curl http://localhost/occm/api/vsa/working-environments/%weid%/stop?take_snapshots=true -X POST --header "Content-Type:application/json" --header "Authorization:$token"
Starting a single Cloud Volumes ONTAP instance in AWS
The following operation starts a Cloud Volumes ONTAP instance in AWS:
curl http://localhost/occm/api/vsa/working-environments/%weid%/start -X POST --header "Content-Type:application/json" --header "Authorization:$token"
Deleting a single Cloud Volumes ONTAP working environment
The following API call deletes a Cloud Volumes ONTAP working environment, which terminates the instance in AWS:
curl http://localhost/occm/api/vsa/working-environments/%weid% -X DELETE --header "Content-Type:application/json" --header "Authorization:$token"
Launching a Cloud Volumes ONTAP HA configuration in multiple Availability Zones
The following API call launches an HA configuration in AWS:
curl http://localhost/occm/api/aws/ha/working-environments -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"name\": \"Ha1\",\"tenantId\": \"$tenantId\",\"region\": \"$haRegion\",\"vsaMetadata\": {\"ontapVersion\": \"ONTAP.ENG-9.4.T1.ha\",\"licenseType\": \"ha-cot-standard-paygo\",\"instanceType\": \"m4.2xlarge\"},\"svmPassword\": \"$svmPassword\",\"vpcId\": \"$haVpcId\",\"volume\": {\"exportPolicyInfo\": {\"policyType\": \"custom\",\"ips\": [\"10.0.0.0/24\"]},\"snapshotPolicyName\": \"default\",\"name\": \"newVol1\",\"enableThinProvisioning\": true,\"enableDeduplication\": true,\"enableCompression\": true,\"size\": {\"size\": 50,\"unit\": \"GB\"}},\"cloudProviderAccount\": \"$awsAccountId\",\"dataEncryptionType\": \"NONE\",\"ontapEncryptionParameters\": null,\"ebsVolumeType\": \"gp2\",\"ebsVolumeSize\": {\"size\": 1,\"unit\": \"TB\"},\"haParams\": {\"node2SubnetId\": \"$haSubnetId2\",\"failoverMode\":\"FloatingIP\",\"mediatorSubnetId\": \"$haSubnetId3\",\"mediatorKeyPairName\": \"$keyPair\",\"clusterFloatingIP\": \"$floatingIp4\",\"dataFloatingIP\": \"$floatingIp5\",\"dataFloatingIP2\": \"$floatingIp6\",\"node1SubnetId\": \"$haSubnetId1\",\"routeTableIds\": [\"$routeTableId1\"]},\"awsTags\": []}" | jq .
Specifying a proxy for the HA mediator
The following example creates an HA working environment that uses a proxy to provide the mediator instance with outbound internet connectivity.
curl http://localhost/occm/api/aws/ha/working-environments -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"name\": \"Ha3\",\"tenantId\": \"$tenantId\",\"region\": \"$haRegion\",\"vsaMetadata\": {\"ontapVersion\": \"ONTAP.ENG-9.4.T1.ha\",\"licenseType\": \"ha-cot-standard-paygo\",\"instanceType\": \"m4.2xlarge\"},\"svmPassword\": \"$svmPassword\",\"vpcId\": \"$haVpcId\",\"cloudProviderAccount\": \"$awsAccountId\",\"dataEncryptionType\": \"NONE\",\"ontapEncryptionParameters\": null,\"ebsVolumeType\": \"gp2\",\"ebsVolumeSize\": {\"size\": 1,\"unit\": \"TB\"},\"haParams\": {\"node2SubnetId\": \"$haSubnetId2\",\"failoverMode\":\"FloatingIP\",\"mediatorSubnetId\": \"$haSubnetId3\",\"mediatorKeyPairName\": \"$keyPair\",\"clusterFloatingIP\": \"$floatingIp7\",\"dataFloatingIP\": \"$floatingIp8\",\"dataFloatingIP2\": \"$floatingIp9\",\"node1SubnetId\": \"$haSubnetId1\",\"routeTableIds\": [\"$routeTableId1\"], \"mediatorProxy\": {\"url\": \"http:///0.0.0.0:555\",\"userName\": \"admin\",\"password\":\"admin\"}},\"awsTags\": []}"
Launching an HA configuration in a single Availability Zone
The following API call launches a Cloud Volumes ONTAP HA configuration in a single AZ in AWS, sets up a proxy configuration for the mediator, and uses dedicated EC2 instances:
curl http://localhost/occm/api/aws/ha/working-environments -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"name\": \"Ha2\",\"tenantId\": \"$tenantId\",\"volume\": {\"exportPolicyInfo\": {\"policyType\": \"custom\",\"ips\": [\"10.20.0.0/16\"]},\"snapshotPolicyName\": \"default\",\"name\": \"newVol1\",\"enableThinProvisioning\": true,\"enableDeduplication\": true,\"enableCompression\": true,\"size\": {\"size\": 50,\"unit\": \"GB\"}},\"region\": \"$haRegion\",\"vsaMetadata\": {\"ontapVersion\": \"ONTAP.ENG-9.4.T1.ha\",\"licenseType\": \"ha-cot-standard-paygo\",\"instanceType\": \"m4.2xlarge\"},\"svmPassword\": \"$svmPassword\",\"vpcId\": \"$haVpcId\",\"cloudProviderAccount\": \"$awsAccountId\",\"dataEncryptionType\": \"AWS\",\"ontapEncryptionParameters\": null,\"ebsVolumeType\": \"gp2\",\"ebsVolumeSize\": {\"size\": 1,\"unit\": \"TB\"},\"haParams\": {\"node2SubnetId\": \"$haSubnetId1\",\"failoverMode\":\"PrivateIP\",\"mediatorSubnetId\": \"$haSubnetId1\",\"mediatorKeyPairName\": \"$keyPair\",\"node1SubnetId\": \"$haSubnetId1\",\"routeTableIds\": [\"$routeTableId1\"],\"mediatorProxy\": {\"url\": \"proxyUrl\",\"userName\": null,\"password\": null}},\"awsTags\": [],\"instanceTenancy\": \"dedicated\",\"awsEncryptionParameters\": {\"kmsKeyId\": \"eecb7e25-848a-40c7-85da-7af078e74ade\"}}" | jq .
To monitor creation of the HA configuration, you can use the following API call:
sleep 60 curl http://localhost/occm/api/vsa/working-environments -X GET --header "Content-Type:application/json" --header "Authorization:$token" > getHA.txt cat getHA.txt| jq -r .[0].publicId > haId.txt cat getHA.txt| jq -r .[0].svmName > svmName.txt haid=`cat haId.txt` svm=`cat svmName.txt`
Creating an aggregate on a node in an HA configuration
The following operation creates an aggregate on the first node in an HA configuration:
curl http://localhost/occm/api/aws/ha/aggregates -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"name\": \"aggr2\",\"workingEnvironmentId\": \"$haid\",\"numberOfDisks\": \"2\",\"diskSize\": {\"size\": \"500\",\"unit\": \"GB\"},\"homeNode\": \"Ha1-01\", \"providerVolumeType\": \"gp2\"}"
Changing the underlying AWS disk type to use storage tiering
The following API commands change the underlying AWS disk type to use storage tiering (General Purpose SSD + S3). Note that the first API call might not return the aggregateName parameter. If that happens, Cloud Manager chooses the best matching aggregate (if one exists) or it creates a new aggregate that meets the requirements.
curl http://localhost/occm/api/aws/ha/volumes/quote -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"workingEnvironmentId\":\"%haid%\",\"svmName\":\"%svm%\",\"name\":\"newVol1\",\"verifyNameUniqueness\":false,\"size\":{\"size\":100,\"unit\":\"GB\"},\"enableThinProvisioning\":true,\"providerVolumeType\":\"gp2\",\"capacityTier\":\"S3\"}" > quote.txt
cat quote.txt| jq -r .numOfDisks >disks.txt
cat quote.txt| jq -r .aggregateName >aggrName.txt
disks=`cat disks.txt`
aggrName=`cat aggrName.txt`
curl http://localhost/occm/api/aws/ha/volumes/%haid%/%svm%/newVol1/change-tier -X POST --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"aggregateName\":\"%aggrName%\",\"numOfDisks\":\"%disks%\",\"newAggregate\":true,\"newDiskTypeName\":\"gp2\",\"newCapacityTier\":\"S3\"}"
Updating route tables for an HA configuration
The following API call updates the list of route tables that contain route entries for an HA configuration’s floating IP addresses:
curl http://localhost/occm/api/aws/ha/working-environments/%haid%/route-tables -X PUT --header "Content-Type:application/json" --header "Authorization:$token" --data "{\"routeTableIds\": [\"%routeTableId1%\", \"%routeTableId2%\"]}"
Stopping an HA configuration
The following API call stops all instances in an HA configuration:
curl http://localhost/occm/api/aws/ha/working-environments/%haid%/stop?take_snapshots=true -X POST --header "Content-Type:application/json" --header "Authorization:$token"
Starting an HA configuration
The following API call starts all instances in an HA configuration:
curl http://localhost/occm/api/aws/ha/working-environments/%haid%/start -X POST --header "Content-Type:application/json" --header "Authorization:$token"
Resources
This section describes the API calls available for each resource.
Accounts
Updates an existing Nss account.
PUT /accounts/nss/{cloudProviderAccountId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
cloudProviderAccountId |
Public Id of Nss account |
true |
string |
|
BodyParameter |
body |
false |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
success |
|
404 |
Nss Account with the given account id does not exist |
No Content |
Consumes
-
application/json
Produces
-
application/json
Retrieves an Nss account by public Id.
GET /accounts/nss/{cloudProviderAccountId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
cloudProviderAccountId |
Public Id of Nss account |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Creates an Azure account.
POST /accounts/azure
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Creates an AWS account.
POST /accounts/aws
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Updates an existing AWS account.
PUT /accounts/aws/{cloudProviderAccountId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
cloudProviderAccountId |
Public Id of AWS account |
true |
string |
|
BodyParameter |
body |
false |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
success |
|
404 |
AWS Account with the given account id does not exist |
No Content |
Consumes
-
application/json
Produces
-
application/json
Retrieves an AWS account by public Id.
GET /accounts/aws/{cloudProviderAccountId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
cloudProviderAccountId |
Public Id of AWS account |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Deletes an existing account. It is not possible to delete an account that has working environments attached to it.
DELETE /accounts/{cloudProviderAccountId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
cloudProviderAccountId |
Public Id of the account to be deleted |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Account with the given account id does not exist |
No Content |
Consumes
-
application/json
Produces
-
application/json
Updates vsa list of an existing Nss account.
PUT /accounts/nss/set-vsa-list/{cloudProviderAccountId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
cloudProviderAccountId |
Public Id of Nss account |
true |
string |
|
BodyParameter |
body |
false |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
success |
|
404 |
Nss Account with the given account id does not exist |
No Content |
Consumes
-
application/json
Produces
-
application/json
Retrieves accounts.
GET /accounts
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Updates an existing Azure account.
PUT /accounts/azure/{cloudProviderAccountId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
cloudProviderAccountId |
Public Id of Azure account |
true |
string |
|
BodyParameter |
body |
false |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
success |
|
404 |
Azure Account with the given account id does not exist |
No Content |
Consumes
-
application/json
Produces
-
application/json
Retrieves an Azure account by public Id.
GET /accounts/azure/{cloudProviderAccountId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
cloudProviderAccountId |
Public Id of Azure account |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Creates an Nss account.
POST /accounts/nss
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Active-directory
Creates a new active directory entry.
POST /active-directory
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Create Active Directory Request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves active directory entries.
GET /active-directory
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
ActiveDirectoryEntry array |
Consumes
-
application/json
Produces
-
application/json
Check connection to active directory.
POST /active-directory/check-connection
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Create Active Directory Request |
true |
Consumes
-
application/json
Produces
-
application/json
Updates an existing active directory entry.
PUT /active-directory/{activeDirectoryId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
activeDirectoryId |
Public Id of active directory |
true |
string |
|
BodyParameter |
body |
Create Active Directory Request |
true |
Consumes
-
application/json
Produces
-
application/json
Deletes an existing active directory entry.
DELETE /active-directory/{activeDirectoryId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
activeDirectoryId |
Public Id of active directory |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Audit
Retrieves the audit group entry for the specific request ID.
GET /audit/{requestId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
requestId |
Retrieve audit group entries for this request ID |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
AuditGroupSummary array |
Consumes
-
application/json
Produces
-
application/json
Retrieves audit groups and group records optionally filtered by query parameters.
GET /audit/auditserver
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
AuditGroupSummary array |
Consumes
-
application/json
Produces
-
application/json
Retrieves audit group entries optionally filtered by query parameters.
GET /audit
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
limit |
Limit entries to specific amount |
false |
integer (int32) |
|
QueryParameter |
after |
Filter entries after specific date |
false |
integer (int64) |
|
QueryParameter |
workingEnvironmentId |
Filter entries by working environment public ID |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
AuditGroupSummary array |
Consumes
-
application/json
Produces
-
application/json
Aws-ha:aggregates
Creates a new aggregate
POST /aws/ha/aggregates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Create Aggregate Request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves aggregates
GET /aws/ha/aggregates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
workingEnvironmentId |
Public Id of working environment |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
AggregateResponse array |
Consumes
-
application/json
Produces
-
application/json
Adds disks to an existing aggregate
POST /aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
PathParameter |
aggregateName |
Name of aggregate to be updated |
true |
string |
|
BodyParameter |
body |
Add disk to aggregate request |
true |
Consumes
-
application/json
Produces
-
application/json
Deletes an existing aggregate
DELETE /aws/ha/aggregates/{workingEnvironmentId}/{aggregateName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
PathParameter |
aggregateName |
Name of aggregate to be deleted |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Aws-ha:discovery
Saves a previously discovered Cloud Volumes ONTAP working environment to the Cloud Manager database.
POST /aws/ha/discovery/recover
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Working environment |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves a list of discovered working environments visible to the current user in the specified AWS region.
GET /aws/ha/discovery/discover
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
Region to discover working environments |
true |
string |
|
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
DiscoveredAwsHaResponse array |
Consumes
-
application/json
Produces
-
application/json
Aws-ha:encryption
Updates the client certificate on the Cloud Volumes ONTAP system
POST /aws/ha/encryption/{workingEnvironmentId}/update-client-certificate
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Updates the key manager CA certificate on the Cloud Volumes ONTAP system
POST /aws/ha/encryption/{workingEnvironmentId}/update-key-manager-ca-certificate
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Update Cloud Volumes ONTAP key manager CA certificate request parameters |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Adds a key manager to the Cloud Volumes ONTAP system
POST /aws/ha/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
PathParameter |
keyManagerIp |
Key manager IP address |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Deletes a key manager from the Cloud Volumes ONTAP system
DELETE /aws/ha/encryption/{workingEnvironmentId}/key-managers/{keyManagerIp}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
PathParameter |
keyManagerIp |
Key manager IP address |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Aws-ha:metadata
Retrieves default snapshot policies available on a cluster
GET /aws/ha/metadata/default-snapshot-policies
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
SnapshotPolicy array |
Consumes
-
application/json
Produces
-
application/json
Retrieves AWS instance profiles
GET /aws/ha/metadata/instance-profiles
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
roleArn |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
InstanceProfileResponse array |
Consumes
-
application/json
Produces
-
application/json
Retrieves AWS user Key Pairs for specific region
GET /aws/ha/metadata/key-pairs
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
true |
string |
||
QueryParameter |
roleArn |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
string array |
Consumes
-
application/json
Produces
-
application/json
Retrieves all the Tag names
GET /aws/ha/metadata/tag-keys
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
roleArn |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
TagKeyResponse array |
Consumes
-
application/json
Produces
-
application/json
Retrieves AWS user Key Pairs for all regions
GET /aws/ha/metadata/key-pairs-by-region
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
roleArn |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves route tables per vpc and their subnet associations.
GET /aws/ha/metadata/route-tables
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
true |
string |
||
QueryParameter |
vpcId |
true |
string |
||
QueryParameter |
roleArn |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
RouteTableResponse array |
Consumes
-
application/json
Produces
-
application/json
Retrieves all Cloud Volumes ONTAP configurations.
GET /aws/ha/metadata/permutations
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
Filter by region |
false |
string |
|
QueryParameter |
version |
Filter by version |
false |
string |
|
QueryParameter |
license |
Filter by license |
false |
string |
|
QueryParameter |
instance_type |
Filter by instance type |
false |
string |
|
QueryParameter |
default_instance_type |
Filter by default instance type |
false |
string |
|
QueryParameter |
feature |
Filter by feature |
false |
string |
|
QueryParameter |
latest_only |
Filter latest only |
false |
string |
|
QueryParameter |
ami |
Filter by ami id |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Configuration array |
Consumes
-
application/json
Produces
-
application/json
Retrieves AWS encryption keys for specific region
GET /aws/ha/metadata/aws-encryption-keys
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
true |
string |
||
QueryParameter |
roleArn |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
AwsEncryptionKey array |
Consumes
-
application/json
Produces
-
application/json
Retrieves supported capacity tiers for EBS volume types
GET /aws/ha/metadata/supported-capacity-tiers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
true |
string |
||
QueryParameter |
ontapVersion |
true |
string |
||
QueryParameter |
dataEncryptionType |
true |
string |
||
QueryParameter |
licenseType |
true |
string |
||
QueryParameter |
instanceType |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves packages configuration
GET /aws/ha/metadata/packages
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
PackageInfoResponse array |
Consumes
-
application/json
Produces
-
application/json
Validates the current user is subscribed to Cloud Volumes ONTAP product in Amazon marketplace
POST /aws/ha/metadata/validate-subscribed-to-ontap-cloud
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Validate subscribed to Cloud Volumes ONTAP request |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves supported EBS volume types
GET /aws/ha/metadata/ebs-volume-types
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
EbsVolumeType array |
Consumes
-
application/json
Produces
-
application/json
Retrieves the minimum number of required IPs for a single Cloud Volumes ONTAP system, an HA node, and HA mediator
GET /aws/ha/metadata/network-requirements
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Validate HA floating IPs.
POST /aws/ha/metadata/validate-floating-ips
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Validate HA floating IPs request |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves AWS regions over which an Cloud Volumes ONTAP working environment may be created
GET /aws/ha/metadata/regions
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Region array |
Consumes
-
application/json
Produces
-
application/json
Retrieves supported features
GET /aws/ha/metadata/supported-features
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
true |
string |
||
QueryParameter |
ontapVersion |
true |
string |
||
QueryParameter |
dataEncryptionType |
true |
string |
||
QueryParameter |
licenseType |
true |
string |
||
QueryParameter |
instanceType |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves all Cloud Manager manifests. Refer to the API Developers Guide in order to understand how to extract valid region codes, license types, instance types and Cloud Volumes ONTAP version parameters for the creation of an Cloud Volumes ONTAP working environment.
GET /aws/ha/metadata/manifests
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves instance types not supporting acceleration and capacity tiering
GET /aws/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse |
Consumes
-
application/json
Produces
-
application/json
Retrieves VPCs
GET /aws/ha/metadata/vpcs
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
true |
string |
||
QueryParameter |
roleArn |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
VpcExtendedResponse array |
Consumes
-
application/json
Produces
-
application/json
Aws-ha:volumes
Quotes a new volume. Returns a resource quote needed to satisfy the requested volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /aws/ha/volumes/quote
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Quote volume request |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Clones an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
true |
Consumes
-
application/json
Produces
-
application/json
Change underlying volume tier.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
true |
Consumes
-
application/json
Produces
-
application/json
Creates a new volume. If the properties aggregateName and maxNumOfDisksApprovedToAdd are not filled in, then the response will fail with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /aws/ha/volumes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
createAggregateIfNotFound |
On create volume request, allow creating not-found aggregate |
false |
boolean |
|
BodyParameter |
body |
Create volume request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves volumes.Operation may only be performed on working environments whose status is: ON, DEGRADED
GET /aws/ha/volumes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
workingEnvironmentId |
Filter volumes by this working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
VolumeResponse array |
Consumes
-
application/json
Produces
-
application/json
Move an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
true |
Consumes
-
application/json
Produces
-
application/json
Create snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
Create snapshot request |
true |
Consumes
-
application/json
Produces
-
application/json
Delete snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED
DELETE /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
Create snapshot request |
true |
Consumes
-
application/json
Produces
-
application/json
Modify an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
PUT /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
ref |
||
BodyParameter |
body |
Modify volume request |
true |
Consumes
-
application/json
Produces
-
application/json
Deletes an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
DELETE /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Return a list of snapshot descriptions for the volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
GET /aws/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
[SnapshotResponse] array |
Consumes
-
application/json
Produces
-
application/json
Aws-ha:working-environments
Retrieves action parameters used in create request of a given Cloud Volumes ONTAP instance
GET /aws/ha/working-environments/{workingEnvironmentId}/create-request-parameters
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Uploads a Cloud license file content on the provided Cloud Volumes ONTAP
POST /aws/ha/working-environments/{workingEnvironmentId}/upload-licenses
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
license file content request |
true |
Consumes
-
application/json
Produces
-
application/json
Activate FPolicy for ransomeware files
PUT /aws/ha/working-environments/{workingEnvironmentId}/activate-fpolicy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Disable FPolicy for ransomeware files
PUT /aws/ha/working-environments/{workingEnvironmentId}/disable-fpolicy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Parses an uploaded Cloud license file
POST /aws/ha/working-environments/parse-license-file
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
HeaderParameter |
filename |
Cloud license file name |
false |
string |
|
BodyParameter |
license |
license |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
multipart/form-data
Produces
-
application/json
Change tier level
POST /aws/ha/working-environments/{workingEnvironmentId}/change-tier-level
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Change tier level request |
true |
Consumes
-
application/json
Produces
-
application/json
Stops a specific Cloud Volumes ONTAP instance
POST /aws/ha/working-environments/{workingEnvironmentId}/stop
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
takeSnapshots |
Take snapshots before stopping Cloud Volumes ONTAP |
true |
boolean |
true |
Consumes
-
application/json
Produces
-
application/json
Change serial number of Cloud Volumes ONTAP
POST /aws/ha/working-environments/{workingEnvironmentId}/change-serial
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Change serial number request |
true |
Consumes
-
application/json
Produces
-
application/json
Sets the writing speed for Cloud Volumes ONTAP
PUT /aws/ha/working-environments/{workingEnvironmentId}/writing-speed
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Writing speed request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves a list of versions to which this Cloud Volumes ONTAP can be upgraded
GET /aws/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
OntapUpdateImageMetadata array |
Consumes
-
application/json
Produces
-
application/json
Starts a specific Cloud Volumes ONTAP instance
POST /aws/ha/working-environments/{workingEnvironmentId}/start
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Checks for the presence of non-persistent locks held on CIFs Sessions.
GET /aws/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
boolean |
Consumes
-
application/json
Produces
-
application/json
Working Environment Cost And Usage
GET /aws/ha/working-environments/{workingEnvironmentId}/cost-and-usage
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
start |
cost and usage start period |
false |
string |
|
QueryParameter |
end |
cost and usage end period |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Creates a new AWS HA Cloud Volumes ONTAP working environment.
POST /aws/ha/working-environments
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Working environment |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Working Environment Ontap Saving
GET /aws/ha/working-environments/{workingEnvironmentId}/ontap-saving
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Activate snapshot policy assignment to all not protected rw volumes
PUT /aws/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Updates Cloud Manager password of a specific Cloud Volumes ONTAP
PUT /aws/ha/working-environments/{workingEnvironmentId}/update-credentials
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Update Cloud Manager password request |
true |
Consumes
-
application/json
Produces
-
application/json
Setup a new CIFS Configuration to an existing Cloud Volumes ONTAP working environment
POST /aws/ha/working-environments/{workingEnvironmentId}/cifs
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
CIFS Configuration request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves CIFS Configuration to an existing Cloud Volumes ONTAP working environment
GET /aws/ha/working-environments/{workingEnvironmentId}/cifs
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Setup a new CIFS using workgroup configuration to an existing Cloud Volumes ONTAP working environment
POST /aws/ha/working-environments/{workingEnvironmentId}/cifs-workgroup
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
CIFS Configuration request |
true |
Consumes
-
application/json
Produces
-
application/json
Modify the svm name of the Cloud Volumes ONTAP
PUT /aws/ha/working-environments/{workingEnvironmentId}/svm
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Svm name modification request |
true |
Consumes
-
application/json
Produces
-
application/json
Updates mediator of the specified Cloud Volumes ONTAP with the given version.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /aws/ha/working-environments/{workingEnvironmentId}/update-mediator
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Sets the instance type of a specific Cloud Volumes ONTAP
PUT /aws/ha/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Instance type modification request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves all license types and their associated instance types for a given Cloud Volumes ONTAP instance
GET /aws/ha/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
LicenseAndInstanceType array |
Consumes
-
application/json
Produces
-
application/json
Updates the route tables of an HA Cloud Volumes ONTAP working environment.Operation may only be performed on working environments whose status is: ON, DEGRADED
PUT /aws/ha/working-environments/{workingEnvironmentId}/route-tables
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
BodyParameter |
body |
true |
Consumes
-
application/json
Produces
-
application/json
Deletes an existing Cloud Volumes ONTAP working environment, including all Cloud resources created for this working environment (unless the localDelete flag is set to true)
DELETE /aws/ha/working-environments/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
localDelete |
If true, the Cloud Volumes ONTAP instance is not terminated in Cloud, but Cloud Manager no longer manages the working environment. |
false |
boolean |
false |
QueryParameter |
forceDelete |
If true, the working environment will be deleted even if it is part of one or more SnapMirror relationships. |
false |
boolean |
false |
Consumes
-
application/json
Produces
-
application/json
Retrieves an HA Cloud Volumes ONTAP working environment.
GET /aws/ha/working-environments/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
fields |
false |
string |
||
PathParameter |
workingEnvironmentId |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Activate offbox configuration
PUT /aws/ha/working-environments/{workingEnvironmentId}/offbox
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Set schedules for Cloud Volumes ONTAP
PUT /aws/ha/working-environments/{workingEnvironmentId}/schedules
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Cloud Volumes ONTAP working environment update schedule request |
true |
Consumes
-
application/json
Produces
-
application/json
List start-stop schedules for Cloud Volumes ONTAP
GET /aws/ha/working-environments/{workingEnvironmentId}/schedules
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
VsaSchedule array |
Consumes
-
application/json
Produces
-
application/json
Retrieves eligibility support status of a Cloud Volumes ONTAP system. Valid values - NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED
GET /aws/ha/working-environments/{workingEnvironmentId}/update-eligibility
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
success |
|
400 |
Working Environment must be ON or UPDATING in order to check eligibility |
No Content |
Consumes
-
application/json
Produces
-
application/json
Registers a Cloud Volumes ONTAP system with NetApp
POST /aws/ha/working-environments/{workingEnvironmentId}/support-registration
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
nssAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves the support registration status of a Cloud Volumes ONTAP system
GET /aws/ha/working-environments/{workingEnvironmentId}/support-registration
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Modify user tags for cloud resources of a given Cloud Volumes ONTAP instance
PUT /aws/ha/working-environments/{workingEnvironmentId}/user-tags
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Modify user tags request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves editable tags for cloud resources of a given Cloud Volumes ONTAP instance
GET /aws/ha/working-environments/{workingEnvironmentId}/user-tags
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Manually triggers subscription sync for all Cloud Volumes ONTAP working environments
POST /aws/ha/working-environments/sync-subscription
Consumes
-
application/json
Produces
-
application/json
Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP
POST /aws/ha/working-environments/{workingEnvironmentId}/update-image
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Update system image request |
true |
Consumes
-
application/json
Produces
-
application/json
Sets the cluster password of a specific Cloud Volumes ONTAP
PUT /aws/ha/working-environments/{workingEnvironmentId}/set-password
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
occmOnly |
false |
boolean |
||
BodyParameter |
body |
Set password request |
true |
Consumes
-
application/json
Produces
-
application/json
Create snapshot policy
POST /aws/ha/working-environments/{workingEnvironmentId}/snapshot-policy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
BodyParameter |
body |
Create snapshot policy request |
true |
Consumes
-
application/json
Produces
-
application/json
Delete FPolicy for ransomeware files
DELETE /aws/ha/working-environments/{workingEnvironmentId}/fpolicy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Enable capacity tiering
POST /aws/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Enable capacity tiering request |
true |
Consumes
-
application/json
Produces
-
application/json
Uploads a Cloud license file on the provided Cloud Volumes ONTAP
POST /aws/ha/working-environments/{workingEnvironmentId}/upload-license-file
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
HeaderParameter |
filename |
Cloud license file name |
false |
string |
|
BodyParameter |
license |
license |
false |
string |
Consumes
-
multipart/form-data
Produces
-
application/json
Retrieves images already installed on the Cloud Volumes ONTAP
GET /aws/ha/working-environments/{workingEnvironmentId}/ontap-available-images
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
UpdateLocalImage array |
Consumes
-
application/json
Produces
-
application/json
Setup NTP server
POST /aws/ha/working-environments/{workingEnvironmentId}/ntp
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
NTP Configuration request |
true |
Consumes
-
application/json
Produces
-
application/json
Modify the net port broadcast domain mtu of the Cloud Volumes ONTAP
PUT /aws/ha/working-environments/{workingEnvironmentId}/networkOptimization
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Use optimization |
true |
Consumes
-
application/json
Produces
-
application/json
Azure-ha:aggregates
Retrieves aggregates
GET /azure/ha/aggregates/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
AggregateResponse array |
Consumes
-
application/json
Produces
-
application/json
Adds disks to an existing aggregate
POST /azure/ha/aggregates/{workingEnvironmentId}/{aggregateName}/disks
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
PathParameter |
aggregateName |
Name of aggregate to be updated |
true |
string |
|
BodyParameter |
body |
Add disk to aggregate request |
true |
Consumes
-
application/json
Produces
-
application/json
Creates a new aggregate
POST /azure/ha/aggregates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Create Aggregate Request |
true |
Consumes
-
application/json
Produces
-
application/json
Deletes an existing aggregate
DELETE /azure/ha/aggregates/{workingEnvironmentId}/{aggregateName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
PathParameter |
aggregateName |
Name of aggregate to be deleted |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Azure-ha:discovery
Retrieves a list of discovered working environments visible to the current user in the specified Azure region.
GET /azure/ha/discovery/discover
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
Region to discover working environments |
true |
string |
|
QueryParameter |
subscriptionId |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Saves a previously discovered Cloud Volumes ONTAP working environment to the Cloud Manager database.
POST /azure/ha/discovery/recover
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Working environment |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Azure-ha:metadata
Retrieves Network Extended Info
GET /azure/ha/metadata/vnets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
true |
string |
||
QueryParameter |
subscriptionId |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves packages configuration
GET /azure/ha/metadata/packages
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
PackageInfoResponse array |
Consumes
-
application/json
Produces
-
application/json
Retrieves default snapshot policies available on a cluster
GET /azure/ha/metadata/default-snapshot-policies
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
SnapshotPolicy array |
Consumes
-
application/json
Produces
-
application/json
Retrieves Azure regions over which an Cloud Volumes ONTAP working environment may be created
GET /azure/ha/metadata/regions
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
fields |
false |
string |
||
QueryParameter |
subscriptionId |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
AzureRegionResponse array |
Consumes
-
application/json
Produces
-
application/json
Validates the current user is subscribed to Cloud Volumes ONTAP product in Azure marketplace
POST /azure/ha/metadata/validate-subscribed-to-ontap-cloud
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Validate subscribed to Cloud Volumes ONTAP request |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves supported features
GET /azure/ha/metadata/supported-features
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
true |
string |
||
QueryParameter |
ontapVersion |
true |
string |
||
QueryParameter |
dataEncryptionType |
true |
string |
||
QueryParameter |
licenseType |
true |
string |
||
QueryParameter |
instanceType |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves all ONTAP Cloud configurations.
GET /azure/ha/metadata/permutations
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
Filter by region |
false |
string |
|
QueryParameter |
version |
Filter by version |
false |
string |
|
QueryParameter |
license |
Filter by license |
false |
string |
|
QueryParameter |
instance_type |
Filter by instance type |
false |
string |
|
QueryParameter |
default_instance_type |
Filter by default instance type |
false |
string |
|
QueryParameter |
feature |
Filter by feature |
false |
string |
|
QueryParameter |
latest_only |
Filter latest only |
false |
string |
|
QueryParameter |
marketplace_version |
Filter by marketplace version |
false |
string |
|
QueryParameter |
marketplace_sku |
Filter by marketplace sku |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Configuration array |
Consumes
-
application/json
Produces
-
application/json
Retrieves associated subscriptions
GET /azure/ha/metadata/associated-subscriptions
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
AssociatedSubscription array |
Consumes
-
application/json
Produces
-
application/json
Retrieves all the Tag names
GET /azure/ha/metadata/tag-keys
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
subscriptionId |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
TagKeyResponse array |
Consumes
-
application/json
Produces
-
application/json
Retrieves the minimum number of required IPs for an Cloud Volumes ONTAP system
GET /azure/ha/metadata/network-requirements
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves instance types not supporting acceleration and capacity tiering
GET /azure/ha/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse |
Consumes
-
application/json
Produces
-
application/json
Retrieves supported Azure storage account types
GET /azure/ha/metadata/storage-account-types
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves supported capacity tiers for Azure disk types
GET /azure/ha/metadata/supported-capacity-tiers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
true |
string |
||
QueryParameter |
ontapVersion |
true |
string |
||
QueryParameter |
dataEncryptionType |
true |
string |
||
QueryParameter |
licenseType |
true |
string |
||
QueryParameter |
instanceType |
true |
string |
||
QueryParameter |
subscriptionId |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Azure-ha:volumes
Creates a new volume. If the properties aggregateName and maxNumOfDisksApprovedToAdd are not filled in, then the response will fail with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /azure/ha/volumes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
createAggregateIfNotFound |
On create volume request, allow creating not-found aggregate |
false |
boolean |
|
BodyParameter |
body |
Create volume request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves volumes.Operation may only be performed on working environments whose status is: ON, DEGRADED
GET /azure/ha/volumes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
workingEnvironmentId |
Filter volumes by this working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
VolumeResponse array |
Consumes
-
application/json
Produces
-
application/json
Quotes a new volume. Returns a resource quote needed to satisfy the requested volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /azure/ha/volumes/quote
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Quote volume request |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Clones an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
true |
Consumes
-
application/json
Produces
-
application/json
Change underlying volume tier.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
true |
Consumes
-
application/json
Produces
-
application/json
Create snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
Create snapshot request |
true |
Consumes
-
application/json
Produces
-
application/json
Delete snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED
DELETE /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
Create snapshot request |
true |
Consumes
-
application/json
Produces
-
application/json
Modify an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
PUT /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
ref |
||
BodyParameter |
body |
Modify volume request |
true |
Consumes
-
application/json
Produces
-
application/json
Deletes an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
DELETE /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Move an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
true |
Consumes
-
application/json
Produces
-
application/json
Return a list of snapshot descriptions for the volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
GET /azure/ha/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
[SnapshotResponse] array |
Consumes
-
application/json
Produces
-
application/json
Azure-ha:working-environments
Setup NTP server
POST /azure/ha/working-environments/{workingEnvironmentId}/ntp
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
NTP Configuration request |
true |
Consumes
-
application/json
Produces
-
application/json
Create snapshot policy
POST /azure/ha/working-environments/{workingEnvironmentId}/snapshot-policy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
BodyParameter |
body |
Create snapshot policy request |
true |
Consumes
-
application/json
Produces
-
application/json
Manually triggers subscription sync for all Cloud Volumes ONTAP working environments
POST /azure/ha/working-environments/sync-subscription
Consumes
-
application/json
Produces
-
application/json
Registers a Cloud Volumes ONTAP system with NetApp
POST /azure/ha/working-environments/{workingEnvironmentId}/support-registration
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
nssAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves the support registration status of a Cloud Volumes ONTAP system
GET /azure/ha/working-environments/{workingEnvironmentId}/support-registration
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Setup a new CIFS using workgroup configuration to an existing Cloud Volumes ONTAP working environment
POST /azure/ha/working-environments/{workingEnvironmentId}/cifs-workgroup
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
CIFS Configuration request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves action parameters used in create request of a given Cloud Volumes ONTAP instance
GET /azure/ha/working-environments/{workingEnvironmentId}/create-request-parameters
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Sets the writing speed for Cloud Volumes ONTAP
PUT /azure/ha/working-environments/{workingEnvironmentId}/writing-speed
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Writing speed request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves number of available ip addresses in the Cloud Volumes ONTAP working environment’s subnet
GET /azure/ha/working-environments/{workingEnvironmentId}/available-ips-in-subnet
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Checks for the presence of non-persistent locks held on CIFs Sessions.
GET /azure/ha/working-environments/{workingEnvironmentId}/cifs-locks-exist
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
boolean |
Consumes
-
application/json
Produces
-
application/json
Starts a specific Cloud Volumes ONTAP instance
POST /azure/ha/working-environments/{workingEnvironmentId}/start
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Change tier level
POST /azure/ha/working-environments/{workingEnvironmentId}/change-tier-level
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Change tier level request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves eligibility support status of a Cloud Volumes ONTAP system. Valid values - NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED
GET /azure/ha/working-environments/{workingEnvironmentId}/update-eligibility
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
success |
|
400 |
Working Environment must be ON or UPDATING in order to check eligibility |
No Content |
Consumes
-
application/json
Produces
-
application/json
Returns true if a resource group with that name already exists, false otherwise
GET /azure/ha/working-environments/resource-group-exists/{resourceGroupName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
resourceGroupName |
resource group name |
true |
string |
|
QueryParameter |
subscriptionId |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
boolean |
Consumes
-
application/json
Produces
-
application/json
Stops a specific Cloud Volumes ONTAP instance
POST /azure/ha/working-environments/{workingEnvironmentId}/stop
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
takeSnapshots |
Take snapshots before stopping Cloud Volumes ONTAP |
true |
boolean |
true |
Consumes
-
application/json
Produces
-
application/json
Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP
POST /azure/ha/working-environments/{workingEnvironmentId}/update-image
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Update system image request |
true |
Consumes
-
application/json
Produces
-
application/json
Disable FPolicy for ransomeware files
PUT /azure/ha/working-environments/{workingEnvironmentId}/disable-fpolicy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Activate snapshot policy assignment to all not protected rw volumes
PUT /azure/ha/working-environments/{workingEnvironmentId}/activate-snapshot-policy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Setup a new CIFS Configuration to an existing Cloud Volumes ONTAP working environment
POST /azure/ha/working-environments/{workingEnvironmentId}/cifs
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
CIFS Configuration request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves CIFS Configuration to an existing Cloud Volumes ONTAP working environment
GET /azure/ha/working-environments/{workingEnvironmentId}/cifs
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves images already installed on the Cloud Volumes ONTAP
GET /azure/ha/working-environments/{workingEnvironmentId}/ontap-available-images
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
UpdateLocalImage array |
Consumes
-
application/json
Produces
-
application/json
Working Environment Ontap Saving
GET /azure/ha/working-environments/{workingEnvironmentId}/ontap-saving
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Creates a new Azure HA Cloud Volumes ONTAP working environment.
POST /azure/ha/working-environments
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Working environment |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves Cloud Volumes ONTAP working environments visible to the currently logged in user
GET /azure/ha/working-environments
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
fields |
false |
string |
||
QueryParameter |
tenantId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Change serial number of Cloud Volumes ONTAP
POST /azure/ha/working-environments/{workingEnvironmentId}/change-serial
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Change serial number request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves a list of versions to which this Cloud Volumes ONTAP can be upgraded
GET /azure/ha/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
OntapUpdateImageMetadata array |
Consumes
-
application/json
Produces
-
application/json
Sets the cluster password of a specific Cloud Volumes ONTAP
PUT /azure/ha/working-environments/{workingEnvironmentId}/set-password
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
occmOnly |
false |
boolean |
||
BodyParameter |
body |
Set password request |
true |
Consumes
-
application/json
Produces
-
application/json
Deletes an existing Cloud Volumes ONTAP working environment, including all Cloud resources created for this working environment (unless the localDelete flag is set to true)
DELETE /azure/ha/working-environments/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
localDelete |
If true, the Cloud Volumes ONTAP instance is not terminated in Cloud, but Cloud Manager no longer manages the working environment. |
false |
boolean |
false |
QueryParameter |
forceDelete |
If true, the working environment will be deleted even if it is part of one or more SnapMirror relationships. |
false |
boolean |
false |
Consumes
-
application/json
Produces
-
application/json
Retrieves an Cloud Volumes ONTAP working environment
GET /azure/ha/working-environments/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
fields |
false |
string |
||
PathParameter |
workingEnvironmentId |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Parses an uploaded Cloud license file
POST /azure/ha/working-environments/parse-license-file
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
HeaderParameter |
filename |
Cloud license file name |
false |
string |
|
BodyParameter |
license |
license |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
multipart/form-data
Produces
-
application/json
Uploads a Cloud license file content on the provided Cloud Volumes ONTAP
POST /azure/ha/working-environments/{workingEnvironmentId}/upload-licenses
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
license file content request |
true |
Consumes
-
application/json
Produces
-
application/json
Sets the instance type of a specific Cloud Volumes ONTAP
PUT /azure/ha/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Instance type modification request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves all license types and their associated instance types for a given Cloud Volumes ONTAP instance
GET /azure/ha/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
LicenseAndInstanceType array |
Consumes
-
application/json
Produces
-
application/json
Delete FPolicy for ransomeware files
DELETE /azure/ha/working-environments/{workingEnvironmentId}/fpolicy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Activate FPolicy for ransomeware files
PUT /azure/ha/working-environments/{workingEnvironmentId}/activate-fpolicy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Working Environment Cost And Usage
GET /azure/ha/working-environments/{workingEnvironmentId}/cost-and-usage
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
start |
cost and usage start period |
false |
string |
|
QueryParameter |
end |
cost and usage end period |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Updates Cloud Manager password of a specific Cloud Volumes ONTAP
PUT /azure/ha/working-environments/{workingEnvironmentId}/update-credentials
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Update Cloud Manager password request |
true |
Consumes
-
application/json
Produces
-
application/json
Modify user tags for cloud resources of a given Cloud Volumes ONTAP instance
PUT /azure/ha/working-environments/{workingEnvironmentId}/user-tags
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Modify user tags request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves editable tags for cloud resources of a given Cloud Volumes ONTAP instance
GET /azure/ha/working-environments/{workingEnvironmentId}/user-tags
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Enable capacity tiering
POST /azure/ha/working-environments/{workingEnvironmentId}/enable-capacity-tiering
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Enable capacity tiering request |
true |
Consumes
-
application/json
Produces
-
application/json
Modify the svm name of the Cloud Volumes ONTAP
PUT /azure/ha/working-environments/{workingEnvironmentId}/svm
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Svm name modification request |
true |
Consumes
-
application/json
Produces
-
application/json
Set schedules for Cloud Volumes ONTAP
PUT /azure/ha/working-environments/{workingEnvironmentId}/schedules
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Cloud Volumes ONTAP working environment update schedule request |
true |
Consumes
-
application/json
Produces
-
application/json
List start-stop schedules for Cloud Volumes ONTAP
GET /azure/ha/working-environments/{workingEnvironmentId}/schedules
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
VsaSchedule array |
Consumes
-
application/json
Produces
-
application/json
Modify the net port broadcast domain mtu of the Cloud Volumes ONTAP
PUT /azure/ha/working-environments/{workingEnvironmentId}/networkOptimization
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Use optimization |
true |
Consumes
-
application/json
Produces
-
application/json
Activate offbox configuration
PUT /azure/ha/working-environments/{workingEnvironmentId}/offbox
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Uploads a Cloud license file on the provided Cloud Volumes ONTAP
POST /azure/ha/working-environments/{workingEnvironmentId}/upload-license-file
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
HeaderParameter |
filename |
Cloud license file name |
false |
string |
|
BodyParameter |
license |
license |
false |
string |
Consumes
-
multipart/form-data
Produces
-
application/json
Azure-vsa:aggregates
Creates a new aggregate
POST /azure/vsa/aggregates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Create Aggregate Request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves aggregates.Operation may only be performed on working environments whose status is: ON, INITIALIZING, DEGRADED
GET /azure/vsa/aggregates/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
AggregateResponse array |
Consumes
-
application/json
Produces
-
application/json
Adds disks to an existing aggregate
POST /azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName}/disks
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
PathParameter |
aggregateName |
Name of aggregate to be updated |
true |
string |
|
BodyParameter |
body |
Add disk to aggregate request |
true |
Consumes
-
application/json
Produces
-
application/json
Deletes an existing aggregate
DELETE /azure/vsa/aggregates/{workingEnvironmentId}/{aggregateName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
PathParameter |
aggregateName |
Name of aggregate to be deleted |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Azure-vsa:discovery
Saves a previously discovered Cloud Volumes ONTAP working environment to the Cloud Manager database.
POST /azure/vsa/recover
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Working environment |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves a list of discovered working environments visible to the current user in the specified Azure region.
GET /azure/vsa/discover
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
Region to discover working environments |
true |
string |
|
QueryParameter |
subscriptionId |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Azure-vsa:metadata
Retrieves default snapshot policies available on a cluster
GET /azure/vsa/metadata/default-snapshot-policies
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
SnapshotPolicy array |
Consumes
-
application/json
Produces
-
application/json
Retrieves Network Extended Info.
GET /azure/vsa/metadata/vnets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
true |
string |
||
QueryParameter |
subscriptionId |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves supported Azure storage account types.
GET /azure/vsa/metadata/storage-account-types
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves supported capacity tiers for Azure disk types.
GET /azure/vsa/metadata/supported-capacity-tiers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
true |
string |
||
QueryParameter |
ontapVersion |
true |
string |
||
QueryParameter |
dataEncryptionType |
true |
string |
||
QueryParameter |
licenseType |
true |
string |
||
QueryParameter |
instanceType |
true |
string |
||
QueryParameter |
subscriptionId |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves Azure regions over which an Cloud Volumes ONTAP working environment may be created.
GET /azure/vsa/metadata/regions
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
fields |
false |
string |
||
QueryParameter |
subscriptionId |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
AzureRegionResponse array |
Consumes
-
application/json
Produces
-
application/json
Retrieves instance types not supporting acceleration and capacity tiering
GET /azure/vsa/metadata/instance-types-not-supporting-acceleration-and-capacity-tiering
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
InstanceTypesNotSupportingAccelerationAndCapacityTieringResponse |
Consumes
-
application/json
Produces
-
application/json
Retrieves the minimum number of required IPs for an Cloud Volumes ONTAP system.
GET /azure/vsa/metadata/network-requirements
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves packages configuration
GET /azure/vsa/metadata/packages
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
PackageInfoResponse array |
Consumes
-
application/json
Produces
-
application/json
Validates the current user is subscribed to Cloud Volumes ONTAP product in Azure marketplace.
POST /azure/vsa/metadata/validate-subscribed-to-ontap-cloud
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Validate subscribed to Cloud Volumes ONTAP request |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves all the Tag names.
GET /azure/vsa/metadata/tag-keys
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
subscriptionId |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
TagKeyResponse array |
Consumes
-
application/json
Produces
-
application/json
Retrieves all Cloud Volumes ONTAP configurations.
GET /azure/vsa/metadata/permutations
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
Filter by region |
false |
string |
|
QueryParameter |
version |
Filter by version |
false |
string |
|
QueryParameter |
license |
Filter by license |
false |
string |
|
QueryParameter |
instance_type |
Filter by instance type |
false |
string |
|
QueryParameter |
default_instance_type |
Filter by default instance type |
false |
string |
|
QueryParameter |
feature |
Filter by feature |
false |
string |
|
QueryParameter |
latest_only |
Filter latest only |
false |
string |
|
QueryParameter |
marketplace_version |
Filter by marketplace version |
false |
string |
|
QueryParameter |
marketplace_sku |
Filter by marketplace sku |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Configuration array |
Consumes
-
application/json
Produces
-
application/json
Retrieves associated subscriptions.
GET /azure/vsa/metadata/associated-subscriptions
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
AssociatedSubscription array |
Consumes
-
application/json
Produces
-
application/json
Retrieves supported features
GET /azure/vsa/metadata/supported-features
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
region |
true |
string |
||
QueryParameter |
ontapVersion |
true |
string |
||
QueryParameter |
dataEncryptionType |
true |
string |
||
QueryParameter |
licenseType |
true |
string |
||
QueryParameter |
instanceType |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Azure-vsa:volumes
Return a list of snapshot descriptions for the volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
GET /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
[SnapshotResponse] array |
Consumes
-
application/json
Produces
-
application/json
Modify an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
PUT /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
ref |
||
BodyParameter |
body |
Modify volume request |
true |
Consumes
-
application/json
Produces
-
application/json
Deletes an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
DELETE /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Creates a new volume. If the properties aggregateName and maxNumOfDisksApprovedToAdd are not filled in, then the response will fail with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /azure/vsa/volumes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
createAggregateIfNotFound |
On create volume request, allow creating not-found aggregate |
false |
boolean |
|
BodyParameter |
body |
Create volume request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves volumes.Operation may only be performed on working environments whose status is: ON, DEGRADED
GET /azure/vsa/volumes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
workingEnvironmentId |
Filter volumes by this working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
VolumeResponse array |
Consumes
-
application/json
Produces
-
application/json
Quotes a new volume. Returns a resource quote needed to satisfy the requested volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /azure/vsa/volumes/quote
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Quote volume request |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Move an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/move
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
true |
Consumes
-
application/json
Produces
-
application/json
Change underlying volume tier.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/change-tier
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
true |
Consumes
-
application/json
Produces
-
application/json
Create snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
Create snapshot request |
true |
Consumes
-
application/json
Produces
-
application/json
Delete snapshot manually.Operation may only be performed on working environments whose status is: ON, DEGRADED
DELETE /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
Create snapshot request |
true |
Consumes
-
application/json
Produces
-
application/json
Clones an existing volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /azure/vsa/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
true |
Consumes
-
application/json
Produces
-
application/json
Azure-vsa:working-environments
Modify the net port broadcast domain mtu of the Cloud Volumes ONTAP
PUT /azure/vsa/working-environments/{workingEnvironmentId}/networkOptimization
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Use optimization |
true |
Consumes
-
application/json
Produces
-
application/json
Stops a specific Cloud Volumes ONTAP instance
POST /azure/vsa/working-environments/{workingEnvironmentId}/stop
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
takeSnapshots |
Take snapshots before stopping Cloud Volumes ONTAP |
true |
boolean |
true |
Consumes
-
application/json
Produces
-
application/json
Uploads a Cloud license file on the provided Cloud Volumes ONTAP
POST /azure/vsa/working-environments/{workingEnvironmentId}/upload-license-file
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
HeaderParameter |
filename |
Cloud license file name |
false |
string |
|
BodyParameter |
license |
license |
false |
string |
Consumes
-
multipart/form-data
Produces
-
application/json
Sets the cluster password of a specific Cloud Volumes ONTAP
PUT /azure/vsa/working-environments/{workingEnvironmentId}/set-password
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
occmOnly |
false |
boolean |
||
BodyParameter |
body |
Set password request |
true |
Consumes
-
application/json
Produces
-
application/json
Create snapshot policy
POST /azure/vsa/working-environments/{workingEnvironmentId}/snapshot-policy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
BodyParameter |
body |
Create snapshot policy request |
true |
Consumes
-
application/json
Produces
-
application/json
Parses an uploaded Cloud license file
POST /azure/vsa/working-environments/parse-license-file
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
HeaderParameter |
filename |
Cloud license file name |
false |
string |
|
BodyParameter |
license |
license |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
multipart/form-data
Produces
-
application/json
Disable FPolicy for ransomeware files
PUT /azure/vsa/working-environments/{workingEnvironmentId}/disable-fpolicy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Retrieves action parameters used in create request of a given Cloud Volumes ONTAP instance
GET /azure/vsa/working-environments/{workingEnvironmentId}/create-request-parameters
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves images already installed on the Cloud Volumes ONTAP
GET /azure/vsa/working-environments/{workingEnvironmentId}/ontap-available-images
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
UpdateLocalImage array |
Consumes
-
application/json
Produces
-
application/json
Working Environment Ontap Saving
GET /azure/vsa/working-environments/{workingEnvironmentId}/ontap-saving
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Returns true if a resource group with that name already exists, false otherwise
GET /azure/vsa/working-environments/resource-group-exists/{resourceGroupName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
resourceGroupName |
resource group name |
true |
string |
|
QueryParameter |
subscriptionId |
false |
string |
||
QueryParameter |
cloudProviderAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
boolean |
Consumes
-
application/json
Produces
-
application/json
Setup NTP server
POST /azure/vsa/working-environments/{workingEnvironmentId}/ntp
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
NTP Configuration request |
true |
Consumes
-
application/json
Produces
-
application/json
Updates Cloud Manager password of a specific Cloud Volumes ONTAP
PUT /azure/vsa/working-environments/{workingEnvironmentId}/update-credentials
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Update Cloud Manager password request |
true |
Consumes
-
application/json
Produces
-
application/json
Delete FPolicy for ransomeware files
DELETE /azure/vsa/working-environments/{workingEnvironmentId}/fpolicy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Sets the instance type of a specific Cloud Volumes ONTAP
PUT /azure/vsa/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Instance type modification request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves all license types and their associated instance types for a given Cloud Volumes ONTAP instance
GET /azure/vsa/working-environments/{workingEnvironmentId}/license-instance-type
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
LicenseAndInstanceType array |
Consumes
-
application/json
Produces
-
application/json
Registers a Cloud Volumes ONTAP system with NetApp
POST /azure/vsa/working-environments/{workingEnvironmentId}/support-registration
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
nssAccountId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves the support registration status of a Cloud Volumes ONTAP system
GET /azure/vsa/working-environments/{workingEnvironmentId}/support-registration
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Activate FPolicy for ransomeware files
PUT /azure/vsa/working-environments/{workingEnvironmentId}/activate-fpolicy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Change serial number of Cloud Volumes ONTAP
POST /azure/vsa/working-environments/{workingEnvironmentId}/change-serial
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Change serial number request |
true |
Consumes
-
application/json
Produces
-
application/json
Activate offbox configuration
PUT /azure/vsa/working-environments/{workingEnvironmentId}/offbox
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Manually triggers subscription sync for all Cloud Volumes ONTAP working environments
POST /azure/vsa/working-environments/sync-subscription
Consumes
-
application/json
Produces
-
application/json
Retrieves eligibility support status of a Cloud Volumes ONTAP system. Valid values - NSS_NOT_VALID, NOT_REGISTERED, IPA_PROBLEM, VALID, NSS_NOT_EXISTS, LICENSE_EXPIRED
GET /azure/vsa/working-environments/{workingEnvironmentId}/update-eligibility
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
success |
|
400 |
Working Environment must be ON or UPDATING in order to check eligibility |
No Content |
Consumes
-
application/json
Produces
-
application/json
Creates a new Cloud Volumes ONTAP working environment.
POST /azure/vsa/working-environments
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Working environment |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves Cloud Volumes ONTAP working environments visible to the currently logged in user
GET /azure/vsa/working-environments
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
fields |
false |
string |
||
QueryParameter |
tenantId |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Starts a specific Cloud Volumes ONTAP instance
POST /azure/vsa/working-environments/{workingEnvironmentId}/start
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Modify user tags for cloud resources of a given Cloud Volumes ONTAP instance
PUT /azure/vsa/working-environments/{workingEnvironmentId}/user-tags
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Modify user tags request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves editable tags for cloud resources of a given Cloud Volumes ONTAP instance
GET /azure/vsa/working-environments/{workingEnvironmentId}/user-tags
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Sets the writing speed for Cloud Volumes ONTAP
PUT /azure/vsa/working-environments/{workingEnvironmentId}/writing-speed
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Writing speed request |
true |
Consumes
-
application/json
Produces
-
application/json
Change tier level
POST /azure/vsa/working-environments/{workingEnvironmentId}/change-tier-level
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Change tier level request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves a list of versions to which this Cloud Volumes ONTAP can be upgraded
GET /azure/vsa/working-environments/{workingEnvironmentId}/occm-provided-upgrade-versions
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
OntapUpdateImageMetadata array |
Consumes
-
application/json
Produces
-
application/json
Activate snapshot policy assignment to all not protected rw volumes
PUT /azure/vsa/working-environments/{workingEnvironmentId}/activate-snapshot-policy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Setup a new CIFS using workgroup configuration to an existing Cloud Volumes ONTAP working environment
POST /azure/vsa/working-environments/{workingEnvironmentId}/cifs-workgroup
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
CIFS Configuration request |
true |
Consumes
-
application/json
Produces
-
application/json
Uploads a Cloud license file content on the provided Cloud Volumes ONTAP
POST /azure/vsa/working-environments/{workingEnvironmentId}/upload-licenses
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
license file content request |
true |
Consumes
-
application/json
Produces
-
application/json
Performs a complete image update operation on the single node of the specified Cloud Volumes ONTAP
POST /azure/vsa/working-environments/{workingEnvironmentId}/update-image
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Update system image request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves number of available ip addresses in the Cloud Volumes ONTAP working environment’s subnet
GET /azure/vsa/working-environments/{workingEnvironmentId}/available-ips-in-subnet
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Working Environment Cost And Usage
GET /azure/vsa/working-environments/{workingEnvironmentId}/cost-and-usage
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
start |
cost and usage start period |
false |
string |
|
QueryParameter |
end |
cost and usage end period |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Set schedules for Cloud Volumes ONTAP
PUT /azure/vsa/working-environments/{workingEnvironmentId}/schedules
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Cloud Volumes ONTAP working environment update schedule request |
true |
Consumes
-
application/json
Produces
-
application/json
List start-stop schedules for Cloud Volumes ONTAP
GET /azure/vsa/working-environments/{workingEnvironmentId}/schedules
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
VsaSchedule array |
Consumes
-
application/json
Produces
-
application/json
Modify the svm name of the Cloud Volumes ONTAP
PUT /azure/vsa/working-environments/{workingEnvironmentId}/svm
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Svm name modification request |
true |
Consumes
-
application/json
Produces
-
application/json
Deletes an existing Cloud Volumes ONTAP working environment, including all Cloud resources created for this working environment (unless the localDelete flag is set to true)
DELETE /azure/vsa/working-environments/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
localDelete |
If true, the Cloud Volumes ONTAP instance is not terminated in Cloud, but Cloud Manager no longer manages the working environment. |
false |
boolean |
false |
QueryParameter |
forceDelete |
If true, the working environment will be deleted even if it is part of one or more SnapMirror relationships. |
false |
boolean |
false |
Consumes
-
application/json
Produces
-
application/json
Retrieves an Cloud Volumes ONTAP working environment
GET /azure/vsa/working-environments/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
fields |
false |
string |
||
PathParameter |
workingEnvironmentId |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Setup a new CIFS Configuration to an existing Cloud Volumes ONTAP working environment
POST /azure/vsa/working-environments/{workingEnvironmentId}/cifs
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
CIFS Configuration request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves CIFS Configuration to an existing Cloud Volumes ONTAP working environment
GET /azure/vsa/working-environments/{workingEnvironmentId}/cifs
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Enable capacity tiering
POST /azure/vsa/working-environments/{workingEnvironmentId}/enable-capacity-tiering
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Enable capacity tiering request |
true |
Consumes
-
application/json
Produces
-
application/json
Cloudsync
Retrieve all S3 buckets.
GET /cloudsync/buckets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
userId |
User ID of the working environment creator |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
S3BucketInfo array |
Consumes
-
application/json
Produces
-
application/json
List S3 bucket’s sub directories in working environment’s account.
GET /cloudsync/buckets/{bucketName}/sub-directories/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of VSA working environment |
true |
string |
|
QueryParameter |
fullPath |
Full path to list sub directories |
false |
string |
|
PathParameter |
bucketName |
Bucket name to get sub directories from |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieve all S3 buckets in working environment’s account.
GET /cloudsync/buckets/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of VSA working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
S3BucketInfo array |
Consumes
-
application/json
Produces
-
application/json
Create sync of VSA working environment with Cloud Sync service.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /cloudsync/sync/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of VSA working environment |
true |
string |
|
BodyParameter |
body |
Create sync request |
true |
Consumes
-
application/json
Produces
-
application/json
Delete sync of VSA working environment to Cloud Sync service.Operation may only be performed on working environments whose status is: ON, DEGRADED
DELETE /cloudsync/sync/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of VSA working environment |
true |
string |
Consumes
-
application/json
Produces
-
application/json
List S3 bucket’s sub directories.
GET /cloudsync/buckets/{bucketName}/sub-directories
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
userId |
User ID of the working environment creator |
true |
string |
|
QueryParameter |
fullPath |
Full path to list sub directories |
false |
string |
|
PathParameter |
bucketName |
Bucket name to get sub directories from |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves AWS user Key Pairs for working environment’s account and region.
GET /cloudsync/key-pairs-by-vsa/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of VSA working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
string array |
Consumes
-
application/json
Produces
-
application/json
Get Cloud Sync Service url, according to the current environment.
GET /cloudsync/service-url
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves VPCs for working environment’s account and region.
GET /cloudsync/vpcs-by-vsa/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of VSA working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
VpcExtendedResponse array |
Consumes
-
application/json
Produces
-
application/json
Add Cloud Sync relationship to an OnPrem volume.Operation may only be performed on working environments whose status is: ON
POST /cloudsync/relationship/onprem/{workingEnvironmentId}/{volumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of OnPrem working environment |
true |
string |
|
PathParameter |
volumeName |
true |
ref |
Consumes
-
application/json
Produces
-
application/json
Delete Cloud Sync relationship from an OnPrem volume.Operation may only be performed on working environments whose status is: ON
DELETE /cloudsync/relationship/onprem/{workingEnvironmentId}/{volumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of OnPrem working environment |
true |
string |
|
PathParameter |
volumeName |
true |
ref |
Consumes
-
application/json
Produces
-
application/json
Add Cloud Sync relationship to a VSA volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /cloudsync/relationship/{workingEnvironmentId}/{volumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of VSA working environment |
true |
string |
|
PathParameter |
volumeName |
true |
ref |
Consumes
-
application/json
Produces
-
application/json
Delete Cloud Sync relationship from a VSA volume.Operation may only be performed on working environments whose status is: ON, DEGRADED
DELETE /cloudsync/relationship/{workingEnvironmentId}/{volumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of VSA working environment |
true |
string |
|
PathParameter |
volumeName |
true |
ref |
Consumes
-
application/json
Produces
-
application/json
Create sync of OnPrem working environment with Cloud Sync service.Operation may only be performed on working environments whose status is: ON
POST /cloudsync/sync/onprem/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of OnPrem working environment |
true |
string |
|
BodyParameter |
body |
Create sync request |
true |
Consumes
-
application/json
Produces
-
application/json
Delete sync of OnPrem working environment to Cloud Sync service.Operation may only be performed on working environments whose status is: ON
DELETE /cloudsync/sync/onprem/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of OnPrem working environment |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Kubernetes
Kubernetes Setup - Uploads Kubernetes configuration file in YAML format, it should be provided in multipart/form-data, with the file at a part named 'config'..
POST /k8s/load
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
HeaderParameter |
filename |
false |
string |
||
BodyParameter |
config |
config |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
multipart/form-data
Produces
-
application/json
Connect ONTAP Cloud Working Environment to Kubernetes.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /k8s/connect/{k8sClusterId}/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
k8sClusterId |
Kubernetes cluster public ID |
true |
string |
|
PathParameter |
workingEnvironmentId |
Working environment public ID |
true |
string |
|
BodyParameter |
body |
Connect request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieve Kubernetes clusters.
GET /k8s/clusters
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
[K8sInfo] array |
Consumes
-
application/json
Produces
-
application/json
Remove existing Kubernetes cluster configuration.
DELETE /k8s/{k8sClusterId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
k8sClusterId |
Public Id of Kubernetes cluster |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Disconnect ONTAP Cloud Working Environment from Kubernetes.
DELETE /k8s/disconnect/{k8sClusterId}/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
k8sClusterId |
Kubernetes cluster public ID |
true |
string |
|
PathParameter |
workingEnvironmentId |
Working environment public ID |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Retrieve external Kubernetes clusters.
GET /k8s/external-clusters
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
HeaderParameter |
api-token |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
[K8sInfo] array |
Consumes
-
application/json
Produces
-
application/json
Kubernetes Setup - Saves Kubernetes configuration.
POST /k8s/save
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Save request |
true |
Consumes
-
application/json
Produces
-
application/json
Occm:asup
Sends Cloud Manager support data to NetApp Support.
POST /occm/asup/send
Produces
-
application/json
Sends Cloud Volumes ONTAP performance archive support data to NetApp Support.Operation may only be performed on working environments whose status is: ON, DEGRADED
POST /occm/asup/send-Cot-performance-Asup/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Produces
-
application/json
Downloads a compressed file of all ASUP files from all VSAs.
GET /occm/asup/download-ontap-cloud-asups
Produces
-
application/json
Downloads Cloud Manager support data.
GET /occm/asup/download
Produces
-
application/json
Sends Cloud Volumes ONTAP support data to NetApp Support.
POST /occm/asup/send-Cot-Asup
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
sendToOccm |
Send Asup to OCCM |
true |
boolean |
false |
Produces
-
application/json
Updates the AutoSupport configuration.
PUT /occm/asup
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
false |
Consumes
-
application/json
Produces
-
application/json
Retrieves the AutoSupport configuration.
GET /occm/asup
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Produces
-
application/json
Occm:config
Retrieves the current simplicator URI and status. Internal use only.
GET /occm/config/simplicator
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Resets to the default simplicator URI. Internal use only.
POST /occm/config/simplicator/reset
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Configures modifiable Cloud Manager parameters.
PUT /occm/config
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
false |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves Cloud Manager configuration parameters.
GET /occm/config
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Occm:encryption:certificate
Validates and installs the provided certificate. Successive calls will overwrite any previously installed certificate. The certificate must match a previously generated CSR.
POST /occm/encryption/certificate
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
The certificate generated for Cloud Manager |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves the installed certificate, if one exists.
GET /occm/encryption/certificate
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Occm:encryption:csr
Generates, stores and returns a certificate signing request (CSR). This CSR can be signed by a CA and then installed in Cloud Manager using /install_certificate. Successive calls will not overwrite previously generated CSRs.
POST /occm/encryption/csr
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves the most recently generated CSR, if any exists.
GET /occm/encryption/csr
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Occm:encryption:key-managers
Adds a new key manager.
POST /occm/encryption/key-managers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Create key manager request parameters |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves all key managers.
GET /occm/encryption/key-managers
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
KeyManagerResponse array |
Consumes
-
application/json
Produces
-
application/json
Updates an existing key manager.
PUT /occm/encryption/key-managers/{keyManagerId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Update key manager request parameters |
true |
||
PathParameter |
keyManagerId |
Public Id of the key manager to be updated |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
success |
|
404 |
Key manager with the given id does not exist |
No Content |
Consumes
-
application/json
Produces
-
application/json
Deletes an existing key manager.
DELETE /occm/encryption/key-managers/{keyManagerId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
keyManagerId |
Public Id of the key manager to be deleted |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Key manager with the given id does not exist |
No Content |
Consumes
-
application/json
Produces
-
application/json
Returns specific key manager by public Id.
GET /occm/encryption/key-managers/{keyManagerId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
keyManagerId |
Public Id of the key manager |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Occm:encryption:key-managers-ca-certificates
Adds a new key manager CA certificate.
POST /occm/encryption/key-managers-ca-certificates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Saves a key manager ca certificate request parameters |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves all key managers CA certificates.
GET /occm/encryption/key-managers-ca-certificates
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
CertificateResponse array |
Consumes
-
application/json
Produces
-
application/json
Deletes an existing key manager CA certificate.
DELETE /occm/encryption/key-managers-ca-certificates/{keyManagerCaCertificateId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
keyManagerCaCertificateId |
Public Id of the key manager ca certificate to be deleted |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
404 |
Key manager ca certificate with the given ID does not exist |
No Content |
Consumes
-
application/json
Produces
-
application/json
Retrieves a specific key manager CA certificate.
GET /occm/encryption/key-managers-ca-certificates/{keyManagerCaCertificateId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
keyManagerCaCertificateId |
Public Id of the key manager ca certificate |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Occm:key-store
Return existing trusted certificates added by the user from trust store.
GET /occm/key-store/user-trusted-certificates
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Validates and installs the provided root CA chain. Successive calls will overwrite any previously installed root CA chain.
POST /occm/key-store/signed-certificate
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
The CA signed certificate |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieve the CA signed certificate of Cloud Manager key store, if one exists.
GET /occm/key-store/signed-certificate
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Generate new key pair and self certificate at key store and return a certificate signing request (CSR). This CSR can be signed by a CA.
POST /occm/key-store/external-certificate
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
The CA signed certificate and an associated private key |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Validates and installs the provided root CA chain. Successive calls will overwrite any previously installed root CA chain.
POST /occm/key-store/signed-certificate-file
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
HeaderParameter |
filename |
Certificate file name |
false |
string |
|
BodyParameter |
certificate |
The CA signed certificate |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
multipart/form-data
Produces
-
application/json
Validates and installs the provided certificate in trust store.
POST /occm/key-store/trusted-certificate-file
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
HeaderParameter |
filename |
Trusted certificate file name |
false |
string |
|
BodyParameter |
certificate |
certificate |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
multipart/form-data
Produces
-
application/json
Retrieve the self certificate of Cloud Manager key store, if one exists.
GET /occm/key-store/self-certificate
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Generate new key pair and self certificate at key store and return a certificate signing request (CSR). This CSR can be signed by a CA.
POST /occm/key-store
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
false |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Generate new key pair and self certificate at key store and return a certificate signing request (CSR). This CSR can be signed by a CA.
POST /occm/key-store/external-certificate-file
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
HeaderParameter |
certificateFilename |
Certificate file name |
false |
string |
|
HeaderParameter |
privateKeyFilename |
Private key file name |
false |
string |
|
BodyParameter |
certificate |
The CA signed certificate |
false |
string |
|
BodyParameter |
privateKey |
The private key associated with the CA signed certificate |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
multipart/form-data
Produces
-
application/json
Delete existing trusted certificate from trust store.
DELETE /occm/key-store/trusted-certificate/{certificateId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
certificateId |
The trusted certificate’s ID |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Occm:setup
Validates a given proxy URL.
POST /occm/setup/validate/proxy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Proxy Url |
true |
Consumes
-
application/json
Produces
-
application/json
Performs volume view initial setup.
POST /occm/setup/volume-view-init
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Setup data |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
success |
|
400 |
If setup already performed |
No Content |
Consumes
-
application/json
Produces
-
application/json
Performs initial setup.
POST /occm/setup/init
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Setup data |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
success |
|
400 |
If setup already performed |
No Content |
Consumes
-
application/json
Produces
-
application/json
Validates that Cloud Manager has an active Internet connection
POST /occm/setup/validate/connectivity
Consumes
-
application/json
Produces
-
application/json
Validates the given user as part of the Setup Wizard.
POST /occm/setup/validate/user
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
User Setup data |
true |
||
HeaderParameter |
Setup-Proxy |
false |
string |
||
HeaderParameter |
Setup-Proxy-User |
false |
string |
||
HeaderParameter |
Setup-Proxy-Password |
false |
string |
||
HeaderParameter |
Setup-Proxy-Domain |
false |
string |
||
HeaderParameter |
Setup-Company |
false |
string |
||
HeaderParameter |
Setup-Site |
false |
string |
Consumes
-
application/json
Produces
-
application/json
Validates the given tenant as part of the Setup Wizard.
POST /occm/setup/validate/tenant
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Tenant Setup data |
true |
||
HeaderParameter |
Setup-Proxy |
false |
string |
||
HeaderParameter |
Setup-Proxy-User |
false |
string |
||
HeaderParameter |
Setup-Proxy-Password |
false |
string |
||
HeaderParameter |
Setup-Proxy-Domain |
false |
string |
||
HeaderParameter |
Setup-Company |
false |
string |
||
HeaderParameter |
Setup-Site |
false |
string |
Consumes
-
application/json
Produces
-
application/json
Occm:setup-portal
Performs initial setup with NetApp Cloud Central.
POST /occm/setup-portal/init
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
HeaderParameter |
Authorization |
false |
string |
||
BodyParameter |
body |
Setup data |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
success |
|
400 |
If setup already performed |
No Content |
Consumes
-
application/json
Produces
-
application/json
Complete setup which was pending connectivity.
POST /occm/setup-portal/complete-connectivity-pending-setup
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Register Cloud Manager to NetApp Cloud Central.
POST /occm/setup-portal/register
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
success |
|
412 |
Cloud Manager is not configured with NetApp Cloud Central |
No Content |
404 |
Failed Communicating with NetApp Cloud Central |
No Content |
409 |
Cloud Manager is already registered to NetApp Cloud Central |
No Content |
Consumes
-
application/json
Produces
-
application/json
Validates that Cloud Manager has an active Internet connection
POST /occm/setup-portal/validate/connectivity
Consumes
-
application/json
Produces
-
application/json
Setup a given proxy URL.
POST /occm/setup-portal/proxy/setup
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Proxy Url |
true |
Consumes
-
application/json
Produces
-
application/json
Occm:system
Performs a restore of Cloud Manager data from a provided backup file. Backup should be provided in multipart/form-data, with the file at a part named 'backup'. Note - This operation can not be performed via swagger.
POST /occm/system/restore
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
HeaderParameter |
filename |
false |
string |
||
BodyParameter |
backup |
backup |
false |
string |
Consumes
-
multipart/form-data
Produces
-
application/json
Retrieves the AWS region, VPC, and subnet in which the Cloud Manager instance is running, in case it is running in AWS.
GET /occm/system/occm-instance-placement
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Produces
-
application/json
Retrieves cloud providers supported regions.
GET /occm/system/cloud-provider-regions
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Produces
-
application/json
Retrieves Feature Flags.
GET /occm/system/feature-flags
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Produces
-
application/json
Manually activate PAYGO working environments registration.
POST /occm/system/manually-activate-register-existing-paygos
Produces
-
application/json
Updates Cloud Manager with the given patch. Backup should be provided in multipart/form-data, with the file at a part named 'patch'.
POST /occm/system/patch
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
HeaderParameter |
filename |
false |
string |
||
BodyParameter |
patch |
patch |
false |
string |
Consumes
-
multipart/form-data
Produces
-
application/json
Manually activate Cloud Volumes ONTAP capacity automatic management cycle.
POST /occm/system/manually-activate-auto-vsa-capacity-management-cycle
Produces
-
application/json
Checks for a new version of Cloud Manager.
GET /occm/system/available-update-versions
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
UpdateInfo array |
Produces
-
application/json
Performs fetch and cache of Cloud Volumes ONTAP and Cloud Manager version information files from s3.
POST /occm/system/cloud-ontap-update-metadata
Produces
-
application/json
Updates Cloud Manager to the given version.
POST /occm/system/update
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
false |
Produces
-
application/json
Retrieves Cloud Manager support services information.
GET /occm/system/support-services
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Produces
-
application/json
Retrieves Cloud Manager feedback configuration.
GET /occm/system/external-config
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Produces
-
application/json
Performs fetch and processing of Cloud Volumes ONTAP image update metadata files.
POST /occm/system/cloud-ontap-update-image-metadata
Produces
-
application/json
Retrieves Cloud Manager server information.
GET /occm/system/about
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Produces
-
application/json
Manually activate status reports sending.
POST /occm/system/manually-activate-send-status-reports
Produces
-
application/json
Restart server.
POST /occm/system/restart-server
Produces
-
application/json
Performs a backup of Cloud Manager data. Data is returned as an application/octet-stream with Content-Disposition attachment;filename={fileName}.
GET /occm/system/backup
Produces
-
application/octet-stream
Onprem:aggregates
Retrieves aggregates.
GET /onprem/aggregates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
workingEnvironmentId |
Filter aggregates by this working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
OnPremAggregateResponse array |
Consumes
-
application/json
Produces
-
application/json
Onprem:metadata
Verifies the address and credentials of the given cluster by retrieving the cluster info.
GET /onprem/metadata/cluster-info
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
HeaderParameter |
clusterAddress |
Cluster address |
true |
string |
|
HeaderParameter |
clusterUsername |
Cluster username |
true |
string |
|
HeaderParameter |
clusterPassword |
Cluster password |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Onprem:volumes
Create snapshot manually.Operation may only be performed on working environments whose status is: ON
POST /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
Create snapshot request |
true |
Consumes
-
application/json
Produces
-
application/json
Delete snapshot manually.Operation may only be performed on working environments whose status is: ON
DELETE /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshot
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
true |
string |
||
PathParameter |
svmName |
true |
string |
||
PathParameter |
volumeName |
true |
string |
||
BodyParameter |
body |
Delete snapshot request |
true |
Consumes
-
application/json
Produces
-
application/json
Creates a new volume.Operation may only be performed on working environments whose status is: ON
POST /onprem/volumes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Create volume request |
true |
Consumes
-
application/json
Produces
-
application/json
Retrieves volumes.Operation may only be performed on working environments whose status is: ON
GET /onprem/volumes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
workingEnvironmentId |
Filter volumes by this working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
VolumeResponse array |
Consumes
-
application/json
Produces
-
application/json
Clones an existing volume.Operation may only be performed on working environments whose status is: ON
POST /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/clone
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
PathParameter |
svmName |
SVM name |
true |
string |
|
PathParameter |
volumeName |
Name of volume to be cloned |
true |
string |
|
BodyParameter |
body |
Clone volume request |
true |
Consumes
-
application/json
Produces
-
application/json
Modify an existing volume.Operation may only be performed on working environments whose status is: ON
PUT /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
PathParameter |
svmName |
SVM name |
true |
string |
|
PathParameter |
volumeName |
Name of volume to be modified |
true |
ref |
|
BodyParameter |
body |
Modify volume request |
true |
Consumes
-
application/json
Produces
-
application/json
Deletes an existing volume.Operation may only be performed on working environments whose status is: ON
DELETE /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
PathParameter |
svmName |
SVM name |
true |
string |
|
PathParameter |
volumeName |
Name of volume to be deleted |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Return a list of snapshot descriptions for the volume.Operation may only be performed on working environments whose status is: ON
GET /onprem/volumes/{workingEnvironmentId}/{svmName}/{volumeName}/snapshots
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
PathParameter |
svmName |
SVM name |
true |
string |
|
PathParameter |
volumeName |
Filter snapshot descriptions for specified volume |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
[SnapshotResponse] array |
Consumes
-
application/json
Produces
-
application/json
Onprem:working-environments
Retrieves CIFS Configuration to an existing Cloud Volumes ONTAP working environment.Operation may only be performed on working environments whose status is: ON
GET /onprem/working-environments/{workingEnvironmentId}/cifs
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
vserver |
Vserver name |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Discovers on-premises working environment in Cloud Manager.
POST /onprem/working-environments
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Working environment |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves on-premises working environments visible to the currently logged in user.
GET /onprem/working-environments
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
fields |
false |
string |
||
QueryParameter |
tenantId |
Public Id of tenant |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Updates Cloud Manager password for an On Premises working environment.
PUT /onprem/working-environments/{workingEnvironmentId}/update-credentials
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Update Cloud Manager password request |
true |
Consumes
-
application/json
Produces
-
application/json
Cloud Manager will no longer manage this working environment, but will not affect the Data ONTAP itself.
DELETE /onprem/working-environments/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Retrieves an on-premises ONTAP working environment.
GET /onprem/working-environments/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
fields |
false |
string |
||
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Replication
Retrieves the intercluster LIFs used in a cluster peering relationship.
GET /replication/intercluster-lifs
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
QueryParameter |
peerWorkingEnvironmentId |
Public Id of peer working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Breaks a SnapMirror replication relationship.
POST /replication/break/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
destinationWorkingEnvironmentId |
Public Id of destination working environment |
true |
string |
|
PathParameter |
destinationSvmName |
Destination SVM name |
true |
string |
|
PathParameter |
destinationVolumeName |
Destination volume name |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Retrieves SnapMirror replication relationship statuses of a specific working environment.
GET /replication/status/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Initializes an existing SnapMirror relationship. This method can only be performed in case the relationship has already been established and is healthy, yet is idle and uninitialized. For example, if the initial transfer were interrupted, then it can be restarted with this request.
POST /replication/initialize/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
destinationWorkingEnvironmentId |
Public Id of the working environment with which the SnapMirror relationship has already been established |
true |
string |
|
PathParameter |
destinationSvmName |
Destination SVM name |
true |
string |
|
PathParameter |
destinationVolumeName |
Destination volume name |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Retrieves replication schedules of a specific working environment.
GET /replication/schedules/{workingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of destination working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
ReplicationSchedule array |
Consumes
-
application/json
Produces
-
application/json
Updates the destination endpoint of the SnapMirror relationship.
POST /replication/update/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
destinationWorkingEnvironmentId |
Public Id of destination working environment |
true |
string |
|
PathParameter |
destinationSvmName |
Destination SVM name |
true |
string |
|
PathParameter |
destinationVolumeName |
Destination volume name |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Creates a new replication to an on-premises working environment.
POST /replication/onprem
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
false |
Consumes
-
application/json
Produces
-
application/json
Resyncs a SnapMirror replication relationship.
POST /replication/resync/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
destinationWorkingEnvironmentId |
Public Id of destination working environment |
true |
string |
|
PathParameter |
destinationSvmName |
Destination SVM name |
true |
string |
|
PathParameter |
destinationVolumeName |
Destination volume name |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Retrieves the status of all SnapMirror relationships.
GET /replication/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
tenantId |
Public Id of tenant |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Removes a replication relationship.
DELETE /replication/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
destinationWorkingEnvironmentId |
Public Id of destination working environment |
true |
string |
|
PathParameter |
destinationSvmName |
Destination SVM name |
true |
string |
|
PathParameter |
destinationVolumeName |
Destination volume name |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Reversing an existing SnapMirror relationship. This method can only be performed in case the relationship has already been established and is healthy and idle.
POST /replication/reverse/{destinationWorkingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
destinationWorkingEnvironmentId |
Public Id of the working environment with which the SnapMirror relationship has already been established |
true |
string |
|
PathParameter |
destinationSvmName |
Destination SVM name |
true |
string |
|
PathParameter |
destinationVolumeName |
Destination volume name |
true |
string |
|
BodyParameter |
body |
false |
Consumes
-
application/json
Produces
-
application/json
Updates a SnapMirror replication relationship.
PUT /replication/{workingEnvironmentId}/{destinationSvmName}/{destinationVolumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
BodyParameter |
body |
Replication update request |
true |
||
PathParameter |
destinationSvmName |
Destination SVM name |
true |
string |
|
PathParameter |
destinationVolumeName |
Destination volume name |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Creates a new replication to an Cloud Volumes ONTAP working environment.
POST /replication/vsa
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
false |
Consumes
-
application/json
Produces
-
application/json
Replication:metadata
return list of snapshot labels from the volume matching lables in the passed list.Operation may only be performed on working environments whose status is: ON, DEGRADED
GET /replication/metadata/snapshot-labels/{workingEnvironmentId}/{svmName}/{volumeName}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
workingEnvironmentId |
Public Id of working environment |
true |
string |
|
PathParameter |
svmName |
SVM name |
true |
string |
|
PathParameter |
volumeName |
Volume name |
true |
string |
|
QueryParameter |
labels |
false |
csv string array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
string array |
Consumes
-
application/json
Produces
-
application/json
retrieves SnapMirror policies based on source and destination Cloud Volumes ONTAP.
GET /replication/metadata/snapmirror-policies/{sourceWorkingEnvironmentId}/{targetWorkingEnvironmentId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
sourceWorkingEnvironmentId |
Public Id of source working environment |
true |
string |
|
PathParameter |
targetWorkingEnvironmentId |
Public Id of destination working environment |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
SnapMirrorPolicyResponse array |
Consumes
-
application/json
Produces
-
application/json
Tenants
Links an existing tenant to a NetApp Support Site account.
PUT /tenants/{tenantId}/nss-keys
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
tenantId |
Public Id of the tenant to be updated |
true |
string |
|
BodyParameter |
body |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Creates a new tenant.
POST /tenants
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Retrieves tenants that are visible to the currently logged in user.
GET /tenants
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
fields |
false |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
TenantResponse array |
Consumes
-
application/json
Produces
-
application/json
Updates an existing tenant.
PUT /tenants/{tenantId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
tenantId |
Public Id of tenant |
true |
string |
|
BodyParameter |
body |
Tenant update request |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
Deletes an existing tenant. It is not possible to delete a tenant over which working environments exist.
DELETE /tenants/{tenantId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
tenantId |
Public Id of the tenant to be deleted |
true |
string |
Consumes
-
application/json
Produces
-
application/json
Retrieves a tenant.
GET /tenants/{tenantId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
fields |
false |
string |
||
PathParameter |
tenantId |
Public Id of tenant |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Consumes
-
application/json
Produces
-
application/json
User-mng:auth
Retrieves representation of currently logged in user.
GET /auth/current-user
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
success |
|
401 |
No user is currently logged in |
No Content |
403 |
No connectivity - SSL Exception |
No Content |
409 |
Setup halted. Internet connectivity required to complete |
No Content |
Consumes
-
application/json
Produces
-
application/json
Log in to Cloud Manager.
POST /auth/login
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
false |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
Incorrect email/password combination |
No Content |
408 |
Failed Communicating with Active Directory |
No Content |
Consumes
-
application/json
Produces
-
application/json
Log out of Cloud Manager.
POST /auth/logout
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
No user is currently logged in |
No Content |
Consumes
-
application/json
Produces
-
application/json
Changes the password of the currently logged in user.
PUT /auth/current-user/change-password
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
BodyParameter |
body |
Change current user password request parameters |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
401 |
No user is currently logged in |
No Content |
Consumes
-
application/json
Produces
-
application/json
User-mng:roles
Retrieves all roles.
GET /roles
Responses
| HTTP Code | Description | Schema |
|---|---|---|
default |
success |
Role array |
Consumes
-
application/json
Produces
-
application/json
Retrieves a specific role.
GET /roles/{roleId}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
roleId |
Role public Id |
true |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
success |
|
404 |
Role with the given public ID does not exist |
No Content |
Consumes
-
application/json
Produces
-
application/json
User-mng:users
Resets the password of the given user.
PUT /users/{userId}/reset-password
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
PathParameter |
userId |
Public Id of the user whose password is to be reset |
true |
string |
|
BodyParameter |
body |
Reset password request |
true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
403 |
The current user does not have permissions to perform this operation for the given user |
No Content |
Consumes
-
application/json
Produces
-
application/json
Updates an existing user.
PUT /users/{userId}