Skip to main content

Create a new Cloud Volumes ONTAP system

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

AwsEncryption

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

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

Capacity

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

OntapEncryption

False

openSecurityGroup

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

AdminUsername

False

volume

VsaVolumeOnNewVsaCreateRequest

False

vpcId

string

True

vsaMetadata

VsaMetadataRequest

True

wormRequest

WormRequest

False

writingSpeedState

string

False

Writing speed state

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

AwsProperties

False

capacityFeatures

CapacityFeatures

False

cbsProperties

CbsPropertiesWithReason

False

cloudProviderName

string

False

cloudSyncProperties

CloudSyncProperties

False

clusterProperties

VsaClusterProperties

False

complianceProperties

CloudComplianceStatusResponse

False

creatorUserEmail

string

False

cronJobSchedules

array[CronJobSchedule]

True

encryptionProperties

EncryptionProperties

False

fpolicyProperties

FpolicyProperties

False

haProperties

AwsHaProperties

False

interClusterLifs

array[InterClusterLif]

True

isHA

boolean

True

licensesInformation

array[LicenseInformation]

True

monitoringProperties

MonitoringStatusResponse

False

name

string

False

ontapClusterProperties

OntapClusterProperties

False

publicId

string

True

replicationProperties

ReplicationProperties

False

reservedSize

Capacity

False

saasProperties

CvoSaasProperties

False

schedules

array[VsaSchedule]

True

snapshotPolicies

array[SnapshotPolicy]

True

status

StatusProperties

False

supportRegistrationInformation

array[SupportRegistrationInformation]

True

supportRegistrationProperties

SupportRegistrationProperties

False

supportedFeatures

SupportedFeatures

False

svmName

string

False

svms

array[Svm]

True

tenantId

string

False

workingEnvironmentType

string

False

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

Name Type Required Description

cursor

integer

False

flags

integer

True

pattern

string

False

Regex

Name Type Required Description

groupNames

array[string]

True

pattern

pattern

True

PatternMessage

Name Type Required Description

message

string

False

regex

Regex

True

AdminUsername

Name Type Required Description

_1

string

True

validatesWith

PatternMessage

True

index

Export policy rule index

ExportPolicyRule

Name Type Required Description

index

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

IgroupCreationRequest

False

igroups

array[string]

False

Igroups

osName

string

False

Operating system

VolumeQualityOfService

Name Type Required Description

maxDataRate

Capacity

False

maxIops

integer

False

CifsShareUserPermissions

Name Type Required Description

permission

string

False

CIFS share permission type

users

array[string]

True

List of users with the permission

CreateCifsShareInfoRequest

Name Type Required Description

accessControl

CifsShareUserPermissions

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

ExportPolicyInfo

False

initialSize

Capacity

False

iscsiInfo

CreateIscsiInfoRequest

False

junctionPath

string

False

Junction path

name

string

False

Volume name, unique within the SVM

qualityOfService

VolumeQualityOfService

False

shareInfo

CreateCifsShareInfoRequest

False

size

PositiveCapacity

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

WormRetentionPeriod

True

RaidInfoForEvAggregate

Name Type Required Description

diskSize

Capacity

True

numOfDisks

integer

True

Number of new disks needed for the RAID group

ElasticVolumeQuoteInfo

Name Type Required Description

addedCapacityToExistingEvDisks

Capacity

False

newRaidForEvInfo

array[RaidInfoForEvAggregate]

False

New RAID information

totalCapacityToAdd

Capacity

False

totalEvDisks

integer

False

InstanceNameIdAndType

Name Type Required Description

instanceId

string

False

instanceName

string

False

instanceType

string

False

OntapLicenseType

Name Type Required Description

capacityLimit

Capacity

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

OntapLicenseType

False

DisksDetails

Name Type Required Description

diskSize

Capacity

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

Capacity

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

ElasticVolumeQuoteInfo

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

ChangeLicenseParameters

False

maxCapacity

Capacity

True

moreInfo

string

False

More information

numOfDisks

integer

True

Number of disks relevant to the action

providerVolumeType

string

False

Provider volume type

resourcesToDelete

ResourcesToDelete

False

serialNumber

string

True

Platform Serial number

totalCapacity

Capacity

True

volumeInfo

VolumeInfo

False

volumeMoveParameters

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

ActionRequiredParameters

True

severity

string

True

Action Severity

bootDiskSize

coreDiskExists

tags

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

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

bootDiskSize

False

cloudProviderAccountId

string

False

coreDiskExists

coreDiskExists

False

instances

array[InstanceResponse]

False

outpostArn

string

False

regionName

string

False

roleArn

string

False

vpc

VpcBasicResponse

False

iops

DefaultProviderVolume

Name Type Required Description

capacityTier

string

False

diskType

string

False

iops

iops

False

size

Capacity

False

existingIops

MaxDisksAllow

Name Type Required Description

numOfDisks

integer

False

reason

string

False

ProviderVolumeTypeResponse

Name Type Required Description

maxDisksAllow

MaxDisksAllow

True

size

Capacity

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

array[SupportedCapacityTiersResponse]

True

CapacityFeatures

Name Type Required Description

defaultProviderVolumeType

DefaultProviderVolume

False

existingIops

array[existingIops]

False

maxDisksPerAggregate

integer

False

providerVolumesType

array[ProviderVolumeTypeResponse]

False

supportedCapacityTiers

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

ProviderSpecific

False

region

string

False

usedCapacity

Capacity

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

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

DataBrokerProperties

False

isSynced

boolean

False

relationships

array[CloudSyncRelationship]

False

s3Location

string

False

status

CloudSyncStatus

False

lastModifiedOffbox

VsaLicense

Name Type Required Description

capacityLimit

Capacity

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

lastModifiedOffbox

False

licenseExpiryDate

integer

False

licenseType

VsaLicense

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

scopeId

False

status

string

False

ComplianceScanStatusResponse

Name Type Required Description

notScanned

integer

False

scanned

integer

False

volumes

array[ComplianceScanStatusVolumeResponse]

False

ComplianceExtendedStatusResponse

Name Type Required Description

nonSensitiveHits

integer

False

personalHits

integer

False

scanStatus

ComplianceScanStatusResponse

False

sensitivePersonalHits

integer

False

CloudComplianceStatusResponse

Name Type Required Description

complianceBackupStatus

string

False

complianceStatus

ComplianceExtendedStatusResponse

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

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

AwsEncryptionKey

False

awsVolumeEncryption

boolean

False

azureVolumeEncryption

boolean

False

encryptionCertificates

array[CertificateResponse]

False

gcpVolumeEncryption

boolean

False

keyManagers

array[KeyManagerResponse]

False

ontapEncryption

boolean

False

FpolicyProtocolStatus

Name Type Required Description

cifs

integer

False

nfsv3

integer

False

nfsv4

integer

False

FpolicyProperties

Name Type Required Description

fPolicyProtocolStatus

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

MediatorStatus

False

mediatorVersionInfo

MediatorVersionInfo

False

mediatorVersionsToUpdate

array[MediatorUpdateVersionMetadata]

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

Capacity

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

KpiUnitValue

False

node1AverageThroughput

KpiUnitValue

False

node2AverageThroughput

KpiUnitValue

False

storageAverageThroughput

KpiUnitValue

False

MonitoringStatusResponse

Name Type Required Description

monitoringInfo

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

Capacity

False

s3BucketName

string

False

tierLevel

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

CapacityTierInfo

False

clusterName

string

False

clusterUuid

string

False

creationTime

integer

False

evaluation

boolean

False

flashCache

boolean

False

isKeystoneSubscription

boolean

False

isSpaceReportingLogical

boolean

False

lastModifiedOffbox

lastModifiedOffbox

False

licensePackageName

string

False

licenseType

VsaLicense

False

nodes

array[OntapNodeProperties]

False

offboxTarget

boolean

False

ontapVersion

string

False

systemManagerUrl

string

False

upgradeVersions

array[OntapUpdateImageMetadata]

False

usedCapacity

Capacity

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

freeTrialExpiry

False

saasEnabled

saasEnabled

False

subscription

SaasSubscription

False

TimePoint

Name Type Required Description

day

integer

True

hour

integer

False

minute

integer

False

StartStopRange

Name Type Required Description

start

TimePoint

False

stop

TimePoint

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

FailureCauses

False

message

string

False

status

string

False

licenseExpiryDate

SupportRegistrationInformation

Name Type Required Description

cloudLicenseExists

boolean

False

licenseExpiryDate

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