Create a new Cloud Volumes ONTAP system
Suggest changes
POST /vsa/working-environments
Creates a new Cloud Volumes ONTAP system. Refer to the API Developers Guide in order to understand how to populate the values for the region, licenseType, instanceType, and version.
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
awsEncryptionParameters |
False |
||
awsTags |
array[AwsTag] |
True |
Optionally, provide up to four key-value pairs with which to tag all AWS entities created by the NetApp Console. |
backupVolumesToCbs |
boolean |
False |
Automatically back up all volumes to Amazon S3 |
capacityTier |
string |
False |
Capacity tier |
cifsConfigurationRequest |
False |
||
cloudProviderAccount |
string |
False |
Cloud provider account |
clusterKeyPairName |
string |
False |
Support SSH using a key-pair |
dataEncryptionType |
string |
True |
Type of encryption to use for this system |
description |
string |
False |
|
disableEv |
boolean |
False |
Disable Elastic Volume |
ebsVolumeSize |
True |
||
ebsVolumeType |
string |
True |
EBS volume type |
enableCompliance |
boolean |
True |
Enable compliance |
enableMonitoring |
boolean |
True |
Enable monitoring |
enableServices |
array[string] |
False |
Enable services |
failedToCreateWorkingEnvironmentId |
string |
False |
Public ID of the failed-to-create system |
instanceProfileName |
string |
False |
Instance profile name |
instanceTenancy |
string |
False |
Instance tenancy configuration |
iops |
integer |
False |
Provisioned IOPS |
name |
string |
False |
|
nssAccount |
string |
False |
NetApp Support Site (NSS) account |
ontapEncryptionDefined |
boolean |
False |
|
ontapEncryptionParameters |
False |
||
openSecurityGroup |
False |
Open the security group to all IP ranges |
|
optimizedNetworkUtilization |
boolean |
False |
Use optimized network utilization |
packageName |
string |
False |
Pre-configured package name |
region |
string |
False |
|
roleArn |
string |
False |
ARN of an optional role to assume |
saasSubscriptionId |
string |
False |
SaaS subscription ID |
securityGroupId |
string |
False |
|
subnetId |
string |
True |
Subnet ID for a single node cluster |
svmName |
string |
False |
SVM name |
svmPassword |
string |
False |
|
tenantId |
string |
False |
|
throughput |
integer |
False |
Provisioned throughput |
tierLevel |
string |
False |
Tier Level |
username |
False |
||
volume |
False |
||
vpcId |
string |
True |
|
vsaMetadata |
True |
||
wormRequest |
False |
||
writingSpeedState |
string |
False |
Writing speed state |
Example request
{
"awsEncryptionParameters": {
"kmsKeyArn": "string",
"kmsKeyId": "string"
},
"awsTags": [
{
"tagKey": "string",
"tagValue": "string"
}
],
"capacityTier": "string",
"cifsConfigurationRequest": {
"activeDirectoryDomain": "string",
"activeDirectoryPassword": "string",
"activeDirectoryUsername": "string",
"dnsDomain": "string",
"ipAddresses": [
"string"
],
"netBIOS": "string",
"organizationalUnit": "string",
"svmName": "string"
},
"cloudProviderAccount": "string",
"clusterKeyPairName": "string",
"dataEncryptionType": "string",
"description": "string",
"ebsVolumeSize": {
"size": 0,
"unit": "string"
},
"ebsVolumeType": "string",
"enableCompliance": false,
"enableMonitoring": false,
"enableServices": [
"string"
],
"failedToCreateWorkingEnvironmentId": "string",
"instanceProfileName": "string",
"instanceTenancy": "string",
"name": "string",
"nssAccount": "string",
"ontapEncryptionParameters": {
"keyManagerCaCertificateId": "string",
"keyManagerIds": [
"string"
]
},
"packageName": "string",
"region": "string",
"roleArn": "string",
"saasSubscriptionId": "string",
"securityGroupId": "string",
"subnetId": "string",
"svmName": "string",
"svmPassword": "string",
"tenantId": "string",
"tierLevel": "string",
"volume": {
"exportPolicyInfo": {
"ips": [
"string"
],
"nfsVersion": [
"string"
],
"policyType": "string",
"rules": [
{
"ips": [
"string"
],
"nfsVersion": [
"string"
],
"ruleAccessControl": "string",
"superUser": false
}
]
},
"initialSize": {
"size": 0,
"unit": "string"
},
"iscsiInfo": {
"igroupCreationRequest": {
"igroupName": "string",
"initiators": [
"string"
]
},
"igroups": [
"string"
],
"osName": "string"
},
"junctionPath": "string",
"name": "string",
"qualityOfService": {
"maxDataRate": {
"size": 0,
"unit": "string"
}
},
"shareInfo": {
"accessControl": {
"permission": "string",
"users": [
"string"
]
},
"shareName": "string"
},
"size": {
"size": 0,
"unit": "string"
},
"snapshotPolicyName": "string",
"tieringPolicy": "string"
},
"vpcId": "string",
"vsaMetadata": {
"capacityPackageName": "string",
"instanceType": "string",
"keyStoneSubscription": "string",
"licenseType": "string",
"ontapVersion": "string",
"platformSerialNumber": "string",
"providedLicense": "string"
},
"wormRequest": {
"retentionPeriod": {
"length": 0,
"unit": "string"
}
},
"writingSpeedState": "string"
}Error
Status: Default, Default response| Name | Type | Required | Description |
|---|---|---|---|
actionsRequired |
array[ActionRequired] |
True |
|
activeActions |
array[string] |
False |
Actions currently being performed on this system |
awsProperties |
False |
||
capacityFeatures |
False |
||
cbsProperties |
False |
||
cloudProviderName |
string |
False |
|
cloudSyncProperties |
False |
||
clusterProperties |
False |
||
complianceProperties |
False |
||
creatorUserEmail |
string |
False |
|
cronJobSchedules |
array[CronJobSchedule] |
True |
|
encryptionProperties |
False |
||
fpolicyProperties |
False |
||
haProperties |
False |
||
interClusterLifs |
array[InterClusterLif] |
True |
|
isHA |
boolean |
True |
|
licensesInformation |
array[LicenseInformation] |
True |
|
monitoringProperties |
False |
||
name |
string |
False |
|
ontapClusterProperties |
False |
||
publicId |
string |
True |
|
replicationProperties |
False |
||
reservedSize |
False |
||
saasProperties |
False |
||
schedules |
array[VsaSchedule] |
True |
|
snapshotPolicies |
array[SnapshotPolicy] |
True |
|
status |
False |
||
supportRegistrationInformation |
True |
||
supportRegistrationProperties |
False |
||
supportedFeatures |
False |
||
svmName |
string |
False |
|
svms |
array[Svm] |
True |
|
tenantId |
string |
False |
|
workingEnvironmentType |
string |
False |
Example error response
{
"actionsRequired": [
{
"actionType": "string",
"parameters": {
"aggregateName": "string",
"currentInstanceType": "string",
"evCapacityDetails": {
"addedCapacityToExistingEvDisks": {
"size": 0,
"unit": "string"
},
"newRaidForEvInfo": [
{
"diskSize": {
"size": 0,
"unit": "string"
},
"numOfDisks": 0
}
],
"totalCapacityToAdd": {
"size": 0,
"unit": "string"
}
},
"instances": [
{
"instanceId": "string",
"instanceName": "string",
"instanceType": "string"
}
],
"isCapacityBased": false,
"isComposite": false,
"licenseExpiryDate": 0,
"licenseParameters": {
"newInstanceType": "string",
"newLicenseType": {
"capacityLimit": {
"size": 0,
"unit": "string"
},
"capacity_limit": "string",
"description": "string",
"name": "string",
"subDescription": "string",
"subName": "string",
"type": "string"
}
},
"maxCapacity": {
"size": 0,
"unit": "string"
},
"moreInfo": "string",
"numOfDisks": 0,
"providerVolumeType": "string",
"resourcesToDelete": {
"instanceNameAndType": [
{
"instanceId": "string",
"instanceName": "string",
"instanceType": "string"
}
],
"numberOfDisksAndDiskSize": [
{
"diskSize": {
"size": 0,
"unit": "string"
},
"diskType": "string"
}
]
},
"serialNumber": "string",
"totalCapacity": {
"size": 0,
"unit": "string"
},
"volumeInfo": {
"newCapacity": {
"size": 0,
"unit": "string"
},
"svmName": "string",
"volumeName": "string"
},
"volumeMoveParameters": {
"homeNode": "string",
"svmName": "string",
"targetAggregateName": "string",
"volumeName": "string"
},
"volumeNames": [
"string"
],
"workingEnvironmentId": "string"
},
"severity": "string"
}
],
"activeActions": [
"string"
],
"awsProperties": {
"accountId": "string",
"availabilityZones": [
"string"
],
"cloudProviderAccountId": "string",
"outpostArn": "string",
"regionName": "string",
"roleArn": "string",
"vpc": {
"cidrBlock": "string",
"default": false,
"state": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"vpcId": "string"
}
},
"capacityFeatures": {
"defaultProviderVolumeType": {
"capacityTier": "string",
"diskType": "string",
"size": {
"size": 0,
"unit": "string"
}
},
"existingIops": [
"object"
],
"providerVolumesType": [
{
"maxDisksAllow": {
"reason": "string"
},
"size": {
"size": 0,
"unit": "string"
},
"supportedVolumeTypes": [
"string"
]
}
],
"supportedCapacityTiers": {
"capacityTiersDisableReasons": [
"string"
],
"supportedCapacityTiersPerVolumeType": [
{
"availableTieringPolicies": [
"string"
],
"supportedCapacityTiers": [
"string"
],
"volumeType": "string"
}
]
}
},
"cbsProperties": {
"cbsBackupStatus": "string",
"cbsPolicyName": "string",
"cbsRules": [
{
"snapmirrorLabel": "string"
}
],
"exclusionReason": "string",
"ipSpace": "string",
"objectStoreName": "string",
"providerAccountName": "string",
"providerSpecific": {
"azureRgName": "string",
"gcpProjectId": "string",
"gcpRegion": "string"
},
"region": "string",
"usedCapacity": {
"size": 0,
"unit": "string"
}
},
"cloudProviderName": "string",
"cloudSyncProperties": {
"dataBrokerProperties": {
"dataBrokerPlacement": {
"instanceId": "string",
"instanceType": "string",
"keyPair": "string",
"subnetId": "string",
"vpcId": "string"
},
"id": "string",
"name": "string"
},
"relationships": [
{
"failureMessage": "string",
"id": "string",
"relationshipStatus": "string",
"s3Location": "string",
"svmName": "string",
"volumeName": "string"
}
],
"s3Location": "string",
"status": {
"failureMessage": "string",
"status": "string"
}
},
"clusterProperties": {
"accountId": "string",
"amiId": "string",
"clusterName": "string",
"instanceId": "string",
"instanceType": "string",
"licenseType": {
"capacityLimit": {
"size": 0,
"unit": "string"
},
"name": "string"
},
"lifs": [
{
"dataProtocols": [
"string"
],
"ip": "string",
"lifType": "string",
"netmask": "string",
"nodeName": "string",
"privateIp": false
}
],
"ontapVersion": "string",
"platformLicense": "string",
"productCode": "string",
"publicDnsName": "string",
"publicIp": "string",
"serialNumber": "string",
"systemId": "string",
"systemManagerUrl": "string",
"upgradeVersions": [
{
"autoUpdateAllowed": false,
"imageVersion": "string",
"lastModified": 0
}
],
"writingSpeedState": "string"
},
"complianceProperties": {
"complianceBackupStatus": "string",
"complianceStatus": {
"scanStatus": {
"volumes": [
{
"error": "string",
"name": "string",
"status": "string"
}
]
}
},
"lastDeploymentError": "string",
"scanStatus": "string"
},
"creatorUserEmail": "string",
"cronJobSchedules": [
{
"days": [
"string"
],
"description": "string",
"hours": [
"string"
],
"minutes": [
"string"
],
"months": [
"string"
],
"name": "string",
"weekDays": [
"string"
]
}
],
"encryptionProperties": {
"awsEncryptionKey": {
"alias": "string",
"keyId": "string",
"origin": "string",
"status": "string"
},
"encryptionCertificates": [
{
"certificate": "string",
"certificateType": "string",
"directIssuerName": "string",
"publicId": "string",
"serialNumber": "string",
"startDate": 0,
"subjectName": "string"
}
],
"keyManagers": [
{
"address": "string",
"name": "string",
"publicId": "string",
"status": "string",
"usernameField": "string",
"usernameValue": "string"
}
],
"s3EncryptionKey": {
"alias": "string",
"keyId": "string",
"origin": "string",
"status": "string"
}
},
"fpolicyProperties": {
"fileExtensions": [
"string"
]
},
"haProperties": {
"failoverMode": "string",
"mediatorStatus": {
"statusMessage": "string"
},
"mediatorVersionInfo": {
"bootVolumeId": "string",
"description": "string",
"state": "string",
"version": "string"
},
"mediatorVersionsToUpdate": [
{
"manifestFileName": "string",
"mediatorVersion": "string",
"metadataFileName": "string"
}
],
"routeTables": [
"string"
]
},
"interClusterLifs": [
{
"address": "string",
"name": "string",
"node": "string",
"port": "string",
"status": "string"
}
],
"isHA": false,
"licensesInformation": [
{
"capacityLimit": {
"size": 0,
"unit": "string"
},
"expirations": [
"object"
],
"package": "string",
"serialNumbers": [
"string"
],
"type": "string",
"useType": "string"
}
],
"monitoringProperties": {
"monitoringInfo": {
"averageLatency": {
"unit": "string"
},
"node1AverageThroughput": {
"unit": "string"
},
"node2AverageThroughput": {
"unit": "string"
},
"storageAverageThroughput": {
"unit": "string"
}
},
"monitoringStatus": "string",
"tenantUrl": "string"
},
"name": "string",
"ontapClusterProperties": {
"broadcastDomainInfos": [
{
"broadcastDomain": "string",
"ipSpace": "string",
"mtu": 0
}
],
"capacityTierInfo": {
"capacityTierUsedSize": {
"size": 0,
"unit": "string"
},
"s3BucketName": "string",
"tierLevel": "string"
},
"capacityTierStatus": {
"message": "string",
"status": "string"
},
"clusterName": "string",
"clusterUuid": "string",
"licensePackageName": "string",
"licenseType": {
"capacityLimit": {
"size": 0,
"unit": "string"
},
"name": "string"
},
"nodes": [
{
"cloudProviderId": "string",
"lifs": [
{
"dataProtocols": [
"string"
],
"ip": "string",
"lifType": "string",
"netmask": "string",
"nodeName": "string",
"privateIp": false
}
],
"name": "string",
"platformLicense": "string",
"platformSerialNumber": "string",
"serialNumber": "string",
"systemId": "string"
}
],
"ontapVersion": "string",
"systemManagerUrl": "string",
"upgradeVersions": [
{
"autoUpdateAllowed": false,
"imageVersion": "string",
"lastModified": 0
}
],
"usedCapacity": {
"size": 0,
"unit": "string"
},
"userName": "string",
"vscanFileOperationDefaultProfile": "string",
"writingSpeedState": "string"
},
"publicId": "string",
"replicationProperties": {
"peers": [
"string"
],
"replicationTargets": [
"string"
]
},
"reservedSize": {
"size": 0,
"unit": "string"
},
"saasProperties": {
"capacityLicensePackage": "string",
"subscription": {
"id": "string",
"name": "string"
}
},
"schedules": [
{
"name": "string",
"schedule": [
{
"start": {
"day": 0
},
"stop": {
"day": 0
}
}
]
}
],
"snapshotPolicies": [
{
"description": "string",
"name": "string",
"schedules": [
{
"frequency": "string",
"retention": 0
}
]
}
],
"status": {
"extendedFailureReason": "string",
"failureCauses": {
"invalidOntapCredentials": false
},
"message": "string",
"status": "string"
},
"supportRegistrationInformation": [
{
"nssAccountId": "string",
"serialNumber": "string",
"supportRegistrationStatus": "string"
}
],
"supportRegistrationProperties": {
"supportRegistrationStatus": "string"
},
"svmName": "string",
"svms": [
{
"allowedAggregates": [
"string"
],
"allowedProtocols": [
"object"
],
"language": "string",
"name": "string",
"state": "string",
"ver3Enabled": false,
"ver4Enabled": false
}
],
"tenantId": "string",
"workingEnvironmentType": "string"
}Definitions
See Definitions
AwsEncryption
| Name | Type | Required | Description |
|---|---|---|---|
kmsKeyArn |
string |
False |
|
kmsKeyId |
string |
False |
AwsTag
| Name | Type | Required | Description |
|---|---|---|---|
tagKey |
string |
False |
|
tagValue |
string |
False |
CIFSConfigurationRequest
| Name | Type | Required | Description |
|---|---|---|---|
activeDirectoryDomain |
string |
True |
Active Directory domain name |
activeDirectoryPassword |
string |
True |
Active Directory password |
activeDirectoryUsername |
string |
True |
Active Directory username |
dnsDomain |
string |
False |
DNS domain name |
ipAddresses |
array[string] |
True |
DNS server IP addresses |
netBIOS |
string |
True |
CIFS server NetBIOS name |
organizationalUnit |
string |
True |
Organizational unit for registration |
svmName |
string |
False |
SVM name |
Capacity
| Name | Type | Required | Description |
|---|---|---|---|
size |
number |
True |
Size |
unit |
string |
True |
Unit |
OntapEncryption
| Name | Type | Required | Description |
|---|---|---|---|
keyManagerCaCertificateId |
string |
False |
|
keyManagerIds |
array[string] |
False |
openSecurityGroup
Open the security group to all IP ranges
pattern
Regex
| Name | Type | Required | Description |
|---|---|---|---|
groupNames |
array[string] |
True |
|
pattern |
True |
PatternMessage
| Name | Type | Required | Description |
|---|---|---|---|
message |
string |
False |
|
regex |
True |
AdminUsername
| Name | Type | Required | Description |
|---|---|---|---|
_1 |
string |
True |
|
validatesWith |
True |
index
Export policy rule index
ExportPolicyRule
| Name | Type | Required | Description |
|---|---|---|---|
index |
False |
Export policy rule index |
|
ips |
array[string] |
True |
Export policy rule list of IPs |
nfsVersion |
array[string] |
False |
Export policy rule protocol |
ruleAccessControl |
string |
True |
Export policy rule access control |
superUser |
boolean |
True |
Export policy rule super user access |
ExportPolicyInfo
| Name | Type | Required | Description |
|---|---|---|---|
ips |
array[string] |
False |
Custom export policy list of IPs |
nfsVersion |
array[string] |
False |
Export policy protocol |
policyType |
string |
False |
Export policy type |
rules |
array[ExportPolicyRule] |
False |
Export policy rules |
IgroupCreationRequest
| Name | Type | Required | Description |
|---|---|---|---|
igroupName |
string |
False |
Igroup name |
initiators |
array[string] |
False |
Initiators |
CreateIscsiInfoRequest
| Name | Type | Required | Description |
|---|---|---|---|
igroupCreationRequest |
False |
||
igroups |
array[string] |
False |
Igroups |
osName |
string |
False |
Operating system |
VolumeQualityOfService
| Name | Type | Required | Description |
|---|---|---|---|
maxDataRate |
False |
||
maxIops |
integer |
False |
| Name | Type | Required | Description |
|---|---|---|---|
permission |
string |
False |
CIFS share permission type |
users |
array[string] |
True |
List of users with the permission |
| Name | Type | Required | Description |
|---|---|---|---|
accessControl |
False |
||
shareName |
string |
False |
Share name |
PositiveCapacity
| Name | Type | Required | Description |
|---|---|---|---|
size |
number |
True |
Size |
unit |
string |
True |
Unit |
VsaVolumeOnNewVsaCreateRequest
| Name | Type | Required | Description |
|---|---|---|---|
enableCompression |
boolean |
False |
Enable compression on the volume |
enableDeduplication |
boolean |
False |
Enable deduplication on the volume |
enableThinProvisioning |
boolean |
False |
Enable thin provisioning on the volume |
exportPolicyInfo |
False |
||
initialSize |
False |
||
iscsiInfo |
False |
||
junctionPath |
string |
False |
Junction path |
name |
string |
False |
Volume name, unique within the SVM |
qualityOfService |
False |
||
shareInfo |
False |
||
size |
False |
||
snapshotPolicyName |
string |
False |
|
tieringPolicy |
string |
False |
Tiering policy |
VsaMetadataRequest
| Name | Type | Required | Description |
|---|---|---|---|
capacityPackageName |
string |
False |
Optional capacity-based package |
instanceType |
string |
True |
Instance type |
keyStoneSubscription |
string |
False |
Keystone subscription ID |
licenseType |
string |
True |
License type |
ontapVersion |
string |
True |
ONTAP version |
platformSerialNumber |
string |
False |
Optional platform serial number |
providedLicense |
string |
False |
Optional provided license |
useLatestVersion |
boolean |
False |
Use the latest version |
WormRetentionPeriod
| Name | Type | Required | Description |
|---|---|---|---|
length |
integer |
True |
Length |
unit |
string |
True |
Unit |
WormRequest
| Name | Type | Required | Description |
|---|---|---|---|
retentionPeriod |
True |
RaidInfoForEvAggregate
| Name | Type | Required | Description |
|---|---|---|---|
diskSize |
True |
||
numOfDisks |
integer |
True |
Number of new disks needed for the RAID group |
ElasticVolumeQuoteInfo
| Name | Type | Required | Description |
|---|---|---|---|
addedCapacityToExistingEvDisks |
False |
||
newRaidForEvInfo |
array[RaidInfoForEvAggregate] |
False |
New RAID information |
totalCapacityToAdd |
False |
||
totalEvDisks |
integer |
False |
InstanceNameIdAndType
| Name | Type | Required | Description |
|---|---|---|---|
instanceId |
string |
False |
|
instanceName |
string |
False |
|
instanceType |
string |
False |
OntapLicenseType
| Name | Type | Required | Description |
|---|---|---|---|
capacityLimit |
True |
||
capacity_limit |
string |
False |
|
default |
boolean |
False |
|
description |
string |
False |
|
name |
string |
False |
|
platformLicenseRequired |
boolean |
False |
|
subDescription |
string |
False |
|
subName |
string |
False |
|
type |
string |
False |
ChangeLicenseParameters
| Name | Type | Required | Description |
|---|---|---|---|
newInstanceType |
string |
False |
|
newLicenseType |
False |
DisksDetails
| Name | Type | Required | Description |
|---|---|---|---|
diskSize |
False |
||
diskType |
string |
False |
|
numberOfDisks |
integer |
False |
ResourcesToDelete
| Name | Type | Required | Description |
|---|---|---|---|
instanceNameAndType |
array[InstanceNameIdAndType] |
False |
|
numberOfDisksAndDiskSize |
array[DisksDetails] |
False |
VolumeInfo
| Name | Type | Required | Description |
|---|---|---|---|
newCapacity |
False |
||
svmName |
string |
False |
|
volumeName |
string |
False |
VolumeMoveParameters
| Name | Type | Required | Description |
|---|---|---|---|
homeNode |
string |
False |
|
isNewTargetAggregate |
boolean |
False |
|
svmName |
string |
False |
|
targetAggregateName |
string |
False |
|
volumeName |
string |
False |
ActionRequiredParameters
| Name | Type | Required | Description |
|---|---|---|---|
aggregateName |
string |
True |
Aggregate name |
currentInstanceType |
string |
False |
Current instance type |
evCapacityDetails |
False |
||
instances |
array[InstanceNameIdAndType] |
True |
Instances information |
isCapacityBased |
boolean |
True |
Indicates if the license type is a capacity-based license type |
isComposite |
boolean |
True |
Indicates if the aggregate is a composite aggregate |
licenseExpiryDate |
integer |
True |
License expiry date |
licenseParameters |
False |
||
maxCapacity |
True |
||
moreInfo |
string |
False |
More information |
numOfDisks |
integer |
True |
Number of disks relevant to the action |
providerVolumeType |
string |
False |
Provider volume type |
resourcesToDelete |
False |
||
serialNumber |
string |
True |
Platform Serial number |
totalCapacity |
True |
||
volumeInfo |
False |
||
volumeMoveParameters |
False |
||
volumeNames |
array[string] |
True |
A limited list of volumes on the aggregate |
workingEnvironmentId |
string |
True |
System public ID |
ActionRequired
| Name | Type | Required | Description |
|---|---|---|---|
actionType |
string |
True |
The type of the Action |
parameters |
True |
||
severity |
string |
True |
Action Severity |
bootDiskSize
coreDiskExists
Instance tags
Hash mapping strings to string
| Name | Type | Required | Description |
|---|---|---|---|
empty |
boolean |
False |
|
traversableAgain |
boolean |
False |
InstanceResponse
| Name | Type | Required | Description |
|---|---|---|---|
availabilityZone |
string |
True |
Availability zone |
id |
string |
True |
Instance ID |
imageId |
string |
True |
Image ID |
instanceProfileId |
string |
False |
Instance profile ID |
instanceType |
string |
True |
Instance type |
isOCCMInstance |
boolean |
True |
Indicates if the instance is a NetApp Console instance |
isVsaInstance |
boolean |
True |
Indicates if the instance is a Cloud Volumes ONTAP instance |
keyPairName |
string |
True |
Key pair |
name |
string |
True |
Instance name |
placementGroup |
string |
True |
Placement group |
privateDnsName |
string |
True |
Private DNS name |
privateIpAddress |
string |
True |
Private IP address that is assigned to the instance |
productCode |
string |
True |
Product code |
publicDnsName |
string |
True |
Public DNS |
publicIpAddress |
string |
True |
Public IP address that is assigned to the instance |
state |
string |
True |
Instance state |
subnetId |
string |
True |
Subnet ID |
tags |
True |
Instance tags |
|
tenancy |
string |
True |
Instance Tenancy |
VpcTagResponse
| Name | Type | Required | Description |
|---|---|---|---|
key |
string |
True |
VPC tag key |
value |
string |
True |
VPC tag value |
VpcBasicResponse
| Name | Type | Required | Description |
|---|---|---|---|
cidrBlock |
string |
True |
VPC Classless Inter-Domain Routing (CIDR) block |
default |
boolean |
True |
Indicates whether the VPC is the default |
state |
string |
True |
The state of the VPC |
tags |
array[VpcTagResponse] |
True |
VPC tags |
vpcId |
string |
True |
The VPC identifier |
AwsProperties
| Name | Type | Required | Description |
|---|---|---|---|
accountId |
string |
False |
|
availabilityZones |
array[string] |
False |
|
bootDiskSize |
False |
||
cloudProviderAccountId |
string |
False |
|
coreDiskExists |
False |
||
instances |
array[InstanceResponse] |
False |
|
outpostArn |
string |
False |
|
regionName |
string |
False |
|
roleArn |
string |
False |
|
vpc |
False |
iops
DefaultProviderVolume
| Name | Type | Required | Description |
|---|---|---|---|
capacityTier |
string |
False |
|
diskType |
string |
False |
|
iops |
False |
||
size |
False |
existingIops
MaxDisksAllow
| Name | Type | Required | Description |
|---|---|---|---|
numOfDisks |
integer |
False |
|
reason |
string |
False |
ProviderVolumeTypeResponse
| Name | Type | Required | Description |
|---|---|---|---|
maxDisksAllow |
True |
||
size |
False |
||
supportedVolumeTypes |
array[string] |
False |
SupportedCapacityTiersResponse
| Name | Type | Required | Description |
|---|---|---|---|
availableTieringPolicies |
array[string] |
False |
|
supportedCapacityTiers |
array[string] |
False |
|
volumeType |
string |
False |
SupportedCapacityTiers
| Name | Type | Required | Description |
|---|---|---|---|
capacityTiersDisableReasons |
array[string] |
False |
|
compositeSupported |
boolean |
False |
|
forceCompositeVersion |
boolean |
False |
|
supportedCapacityTiersPerVolumeType |
True |
CapacityFeatures
| Name | Type | Required | Description |
|---|---|---|---|
defaultProviderVolumeType |
False |
||
existingIops |
array[existingIops] |
False |
|
maxDisksPerAggregate |
integer |
False |
|
providerVolumesType |
array[ProviderVolumeTypeResponse] |
False |
|
supportedCapacityTiers |
False |
CbsSchedule
| Name | Type | Required | Description |
|---|---|---|---|
snapmirrorLabel |
string |
False |
|
snapshotsToKeep |
integer |
False |
ProviderSpecific
| Name | Type | Required | Description |
|---|---|---|---|
azureRgName |
string |
False |
|
gcpProjectId |
string |
False |
|
gcpRegion |
string |
False |
CbsPropertiesWithReason
| Name | Type | Required | Description |
|---|---|---|---|
cbsBackupStatus |
string |
False |
|
cbsPolicyName |
string |
False |
|
cbsRules |
array[CbsSchedule] |
False |
|
exclusionReason |
string |
False |
|
ipSpace |
string |
False |
|
numberOfBackedUpVolumes |
integer |
False |
|
objectStoreName |
string |
False |
|
providerAccountName |
string |
False |
|
providerSpecific |
False |
||
region |
string |
False |
|
usedCapacity |
False |
DataBrokerPlacement
| Name | Type | Required | Description |
|---|---|---|---|
instanceId |
string |
False |
|
instanceType |
string |
False |
|
keyPair |
string |
False |
|
subnetId |
string |
False |
|
vpcId |
string |
False |
DataBrokerProperties
| Name | Type | Required | Description |
|---|---|---|---|
dataBrokerPlacement |
False |
||
id |
string |
False |
|
name |
string |
False |
CloudSyncRelationship
| Name | Type | Required | Description |
|---|---|---|---|
failureMessage |
string |
False |
|
id |
string |
False |
|
progress |
integer |
False |
|
relationshipStatus |
string |
False |
|
s3Location |
string |
False |
|
svmName |
string |
False |
|
volumeName |
string |
False |
CloudSyncStatus
| Name | Type | Required | Description |
|---|---|---|---|
failureMessage |
string |
False |
|
status |
string |
False |
CloudSyncProperties
| Name | Type | Required | Description |
|---|---|---|---|
dataBrokerProperties |
False |
||
isSynced |
boolean |
False |
|
relationships |
array[CloudSyncRelationship] |
False |
|
s3Location |
string |
False |
|
status |
False |
lastModifiedOffbox
VsaLicense
| Name | Type | Required | Description |
|---|---|---|---|
capacityLimit |
True |
||
name |
string |
True |
License name |
LifResponse
| Name | Type | Required | Description |
|---|---|---|---|
dataProtocols |
array[string] |
True |
List of supported protocols |
ip |
string |
True |
LIF IP address |
lifType |
string |
True |
LIF type |
netmask |
string |
True |
LIF netmask |
nodeName |
string |
True |
Node name |
privateIp |
boolean |
True |
Specifies whether the IP address is a private address |
OntapUpdateImageMetadata
| Name | Type | Required | Description |
|---|---|---|---|
autoUpdateAllowed |
boolean |
True |
|
imageVersion |
string |
True |
|
lastModified |
integer |
True |
VsaClusterProperties
| Name | Type | Required | Description |
|---|---|---|---|
accountId |
string |
False |
|
amiId |
string |
False |
|
clusterName |
string |
False |
|
creationTime |
integer |
False |
|
instanceId |
string |
False |
|
instanceType |
string |
False |
|
lastModifiedOffbox |
False |
||
licenseExpiryDate |
integer |
False |
|
licenseType |
False |
||
lifs |
array[LifResponse] |
False |
|
offboxTarget |
boolean |
False |
|
ontapVersion |
string |
False |
|
platformLicense |
string |
False |
|
productCode |
string |
False |
|
publicDnsName |
string |
False |
|
publicIp |
string |
False |
|
serialNumber |
string |
False |
|
systemId |
string |
False |
|
systemManagerUrl |
string |
False |
|
upgradeVersions |
array[OntapUpdateImageMetadata] |
False |
|
writingSpeedState |
string |
False |
scopeId
ComplianceScanStatusVolumeResponse
| Name | Type | Required | Description |
|---|---|---|---|
error |
string |
False |
|
name |
string |
False |
|
scopeId |
False |
||
status |
string |
False |
ComplianceScanStatusResponse
| Name | Type | Required | Description |
|---|---|---|---|
notScanned |
integer |
False |
|
scanned |
integer |
False |
|
volumes |
False |
ComplianceExtendedStatusResponse
| Name | Type | Required | Description |
|---|---|---|---|
nonSensitiveHits |
integer |
False |
|
personalHits |
integer |
False |
|
scanStatus |
False |
||
sensitivePersonalHits |
integer |
False |
CloudComplianceStatusResponse
| Name | Type | Required | Description |
|---|---|---|---|
complianceBackupStatus |
string |
False |
|
complianceStatus |
False |
||
lastDeploymentError |
string |
False |
|
scanStatus |
string |
False |
CronJobSchedule
| Name | Type | Required | Description |
|---|---|---|---|
days |
array[string] |
False |
|
description |
string |
False |
|
hours |
array[string] |
False |
|
minutes |
array[string] |
False |
|
months |
array[string] |
True |
|
name |
string |
False |
|
weekDays |
array[string] |
False |
validTo
AwsEncryptionKey
| Name | Type | Required | Description |
|---|---|---|---|
alias |
string |
False |
|
default |
boolean |
False |
|
keyId |
string |
False |
|
origin |
string |
False |
|
status |
string |
False |
|
validTo |
False |
CertificateResponse
| Name | Type | Required | Description |
|---|---|---|---|
certificate |
string |
False |
|
certificateType |
string |
False |
|
directIssuerName |
string |
False |
|
endDate |
integer |
False |
|
publicId |
string |
False |
|
serialNumber |
string |
False |
|
startDate |
integer |
True |
|
subjectName |
string |
False |
KeyManagerResponse
| Name | Type | Required | Description |
|---|---|---|---|
address |
string |
False |
|
name |
string |
False |
|
publicId |
string |
False |
|
status |
string |
False |
|
usernameField |
string |
False |
|
usernameValue |
string |
False |
EncryptionProperties
| Name | Type | Required | Description |
|---|---|---|---|
awsEncryptionKey |
False |
||
awsVolumeEncryption |
boolean |
False |
|
azureVolumeEncryption |
boolean |
False |
|
encryptionCertificates |
array[CertificateResponse] |
False |
|
gcpVolumeEncryption |
boolean |
False |
|
keyManagers |
array[KeyManagerResponse] |
False |
|
ontapEncryption |
boolean |
False |
|
s3EncryptionKey |
False |
FpolicyProtocolStatus
| Name | Type | Required | Description |
|---|---|---|---|
cifs |
integer |
False |
|
nfsv3 |
integer |
False |
|
nfsv4 |
integer |
False |
FpolicyProperties
| Name | Type | Required | Description |
|---|---|---|---|
fPolicyProtocolStatus |
False |
||
fileExtensions |
array[string] |
False |
|
status |
integer |
False |
MediatorStatus
| Name | Type | Required | Description |
|---|---|---|---|
statusCode |
integer |
False |
|
statusMessage |
string |
False |
MediatorVersionInfo
| Name | Type | Required | Description |
|---|---|---|---|
bootVolumeId |
string |
False |
|
description |
string |
False |
|
state |
string |
True |
|
version |
string |
False |
MediatorUpdateVersionMetadata
| Name | Type | Required | Description |
|---|---|---|---|
major |
boolean |
False |
|
manifestFileName |
string |
False |
|
mediatorVersion |
string |
False |
|
metadataFileName |
string |
False |
|
timeStamp |
integer |
False |
AwsHaProperties
| Name | Type | Required | Description |
|---|---|---|---|
failoverMode |
string |
False |
|
mediatorStatus |
False |
||
mediatorVersionInfo |
False |
||
mediatorVersionsToUpdate |
False |
||
routeTables |
array[string] |
False |
InterClusterLif
| Name | Type | Required | Description |
|---|---|---|---|
address |
string |
False |
|
isPeered |
boolean |
False |
|
name |
string |
False |
|
node |
string |
False |
|
port |
string |
False |
|
status |
string |
False |
expirations
LicenseInformation
| Name | Type | Required | Description |
|---|---|---|---|
capacityLimit |
False |
||
expirations |
array[expirations] |
False |
|
package |
string |
True |
|
serialNumbers |
array[string] |
False |
|
type |
string |
True |
|
useType |
string |
True |
KpiUnitValue
| Name | Type | Required | Description |
|---|---|---|---|
unit |
string |
False |
|
value |
number |
False |
MonitoringInfo
| Name | Type | Required | Description |
|---|---|---|---|
averageIops |
number |
False |
|
averageLatency |
False |
||
node1AverageThroughput |
False |
||
node2AverageThroughput |
False |
||
storageAverageThroughput |
False |
MonitoringStatusResponse
| Name | Type | Required | Description |
|---|---|---|---|
monitoringInfo |
False |
||
monitoringStatus |
string |
False |
|
tenantUrl |
string |
False |
BroadcastDomainInfo
| Name | Type | Required | Description |
|---|---|---|---|
broadcastDomain |
string |
False |
|
ipSpace |
string |
False |
|
mtu |
integer |
True |
CapacityTierInfo
| Name | Type | Required | Description |
|---|---|---|---|
capacityTierUsedSize |
False |
||
s3BucketName |
string |
False |
|
tierLevel |
string |
False |
CapacityTierStatus
| Name | Type | Required | Description |
|---|---|---|---|
message |
string |
False |
|
status |
string |
False |
OntapNodeProperties
| Name | Type | Required | Description |
|---|---|---|---|
cloudProviderId |
string |
False |
|
healthy |
boolean |
False |
|
inTakeover |
boolean |
False |
|
lifs |
array[LifResponse] |
False |
|
name |
string |
False |
|
platformLicense |
string |
False |
|
platformSerialNumber |
string |
False |
|
serialNumber |
string |
False |
|
systemId |
string |
False |
OntapClusterProperties
| Name | Type | Required | Description |
|---|---|---|---|
aggregateCount |
integer |
False |
|
broadcastDomainInfos |
array[BroadcastDomainInfo] |
False |
|
canConfigureCapacityTier |
boolean |
False |
|
capacityTierInfo |
False |
||
capacityTierStatus |
False |
||
clusterName |
string |
False |
|
clusterUuid |
string |
False |
|
creationTime |
integer |
False |
|
evaluation |
boolean |
False |
|
flashCache |
boolean |
False |
|
isKeystoneSubscription |
boolean |
False |
|
isSpaceReportingLogical |
boolean |
False |
|
lastModifiedOffbox |
False |
||
licensePackageName |
string |
False |
|
licenseType |
False |
||
nodes |
array[OntapNodeProperties] |
False |
|
offboxTarget |
boolean |
False |
|
ontapVersion |
string |
False |
|
systemManagerUrl |
string |
False |
|
upgradeVersions |
array[OntapUpdateImageMetadata] |
False |
|
usedCapacity |
False |
||
userName |
string |
False |
|
volumeCount |
integer |
False |
|
vscanFileOperationDefaultProfile |
string |
False |
|
wormEnabled |
boolean |
False |
|
writingSpeedState |
string |
False |
ReplicationProperties
| Name | Type | Required | Description |
|---|---|---|---|
peers |
array[string] |
False |
|
replicationTargets |
array[string] |
False |
freeTrialExpiry
saasEnabled
SaasSubscription
| Name | Type | Required | Description |
|---|---|---|---|
active |
boolean |
False |
|
id |
string |
False |
|
name |
string |
False |
CvoSaasProperties
| Name | Type | Required | Description |
|---|---|---|---|
capacityLicensePackage |
string |
False |
|
freeTrialExpiry |
False |
||
saasEnabled |
False |
||
subscription |
False |
TimePoint
| Name | Type | Required | Description |
|---|---|---|---|
day |
integer |
True |
|
hour |
integer |
False |
|
minute |
integer |
False |
StartStopRange
| Name | Type | Required | Description |
|---|---|---|---|
start |
False |
||
stop |
True |
VsaSchedule
| Name | Type | Required | Description |
|---|---|---|---|
enabled |
boolean |
False |
|
name |
string |
True |
|
schedule |
array[StartStopRange] |
True |
PolicySchedule
| Name | Type | Required | Description |
|---|---|---|---|
frequency |
string |
True |
Frequency |
retention |
integer |
True |
Retention |
SnapshotPolicy
| Name | Type | Required | Description |
|---|---|---|---|
description |
string |
True |
Description |
name |
string |
True |
Name |
schedules |
array[PolicySchedule] |
True |
Schedules |
FailureCauses
| Name | Type | Required | Description |
|---|---|---|---|
invalidCloudProviderCredentials |
boolean |
False |
|
invalidOntapCredentials |
boolean |
True |
|
noCloudProviderConnection |
boolean |
False |
StatusProperties
| Name | Type | Required | Description |
|---|---|---|---|
extendedFailureReason |
string |
False |
|
failureCauses |
False |
||
message |
string |
False |
|
status |
string |
False |
licenseExpiryDate
SupportRegistrationInformation
| Name | Type | Required | Description |
|---|---|---|---|
cloudLicenseExists |
boolean |
False |
|
licenseExpiryDate |
False |
||
nssAccountId |
string |
False |
|
serialNumber |
string |
False |
|
supportRegistrationStatus |
string |
False |
SupportRegistrationProperties
| Name | Type | Required | Description |
|---|---|---|---|
licenseExpiryDate |
integer |
False |
|
supportRegistrationStatus |
string |
False |
SupportedFeatures
| Name | Type | Required | Description |
|---|---|---|---|
supportsElasticVolumes |
boolean |
False |
|
supportsGp3Disk |
boolean |
False |
|
supportsMixedAggregates |
boolean |
False |
|
supportsTieringWithServiceAccount |
boolean |
False |
Value
Svm
| Name | Type | Required | Description |
|---|---|---|---|
allowedAggregates |
array[string] |
False |
|
allowedProtocols |
array[Value] |
True |
|
language |
string |
False |
|
name |
string |
False |
|
state |
string |
False |
|
ver3Enabled |
boolean |
True |
NFS Version 3 enabled |
ver4Enabled |
boolean |
True |
NFS Version 4 enabled |