Create a new Cloud Volumes ONTAP system

08/17/2026

POST /gcp/vsa/working-environments

Creates a new Cloud Volumes ONTAP system.

Request Body

Name	Type	Required	Description
backupVolumesToCbs	boolean	False	Automatically back up all volumes to the cloud
capacityTier	string	False	Capacity tier
cifsConfigurationRequest	CIFSConfigurationRequest	False
cloudProviderAccount	string	False
dataEncryptionType	string	True	Type of encryption to use for this system
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
firewallIpRanges	firewallIpRanges	False	Firewall IP ranges
firewallRule	string	False	Firewall name for a single node cluster
firewallTagNameRule	string	False	Firewall tag name for a single node cluster
flashCache	boolean	True	Enable Flash Cache
gcpEncryptionParameters	GcpEncryption	False
gcpLabels	array[GcpLabel]	True	Optionally, provide up to four key-value pairs with which to tag all Google Cloud entities created by the NetApp Console.
gcpPerformance	GcpPerformance	False
gcpServiceAccount	string	False	Google Cloud service account
gcpStorageAccount	string	False	Google Cloud storage account
gcpVolumeSize	Capacity	True
gcpVolumeType	string	True	Google Cloud volume type
haParams	GcpHaParameters	False
name	string	False
nssAccount	string	False	NetApp Support Service (NSS) account
packageName	string	False	Pre-configured package name
project	string	False	Google Cloud optional project
providedImage	string	False	Provided external Cloud Volumes ONTAP image
providedMediatorImage	string	False	Provided external mediator image
region	string	False
saasSubscriptionId	string	False	SaaS subscription ID
securityGroupId	string	False
serialNumber	string	False	Serial number for BYOL
skipSvmManagementLif	boolean	True	SVM management LIF flag. Beginning with ONTAP 9.11.1, the flag is always set to true.
subnetId	string	True	Subnet ID for a single node cluster
subnetPath	string	False	Subnet path for a single node cluster
svmName	string	False	SVM name
svmPassword	string	False
tenantId	string	False
tierLevel	string	False	Google Cloud available storage classes
username	AdminUsername	False
volume	VsaVolumeOnNewVsaCreateRequest	False
vpcId	string	True
vsaMetadata	VsaMetadataRequest	True
workerPool	string	False	The worker pool URI. Required for private mode Google Cloud deployments with Cloud Volumes ONTAP.
wormRequest	WormRequest	False
writingSpeedState	string	False	Writing speed state

Name

Type

Required

Description

backupVolumesToCbs

boolean

False

Automatically back up all volumes to the cloud

capacityTier

string

False

Capacity tier

cifsConfigurationRequest

CIFSConfigurationRequest

False

cloudProviderAccount

string

False

dataEncryptionType

string

True

Type of encryption to use for this system

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

firewallIpRanges

False

Firewall IP ranges

firewallRule

string

False

Firewall name for a single node cluster

firewallTagNameRule

string

False

Firewall tag name for a single node cluster

flashCache

boolean

True

Enable Flash Cache

gcpEncryptionParameters

GcpEncryption

False

gcpLabels

array[GcpLabel]

True

Optionally, provide up to four key-value pairs with which to tag all Google Cloud entities created by the NetApp Console.

gcpPerformance

GcpPerformance

False

gcpServiceAccount

string

False

Google Cloud service account

gcpStorageAccount

string

False

Google Cloud storage account

gcpVolumeSize

Capacity

True

gcpVolumeType

string

True

Google Cloud volume type

haParams

GcpHaParameters

False

name

string

False

nssAccount

string

False

NetApp Support Service (NSS) account

packageName

string

False

Pre-configured package name

project

string

False

Google Cloud optional project

providedImage

string

False

Provided external Cloud Volumes ONTAP image

providedMediatorImage

string

False

Provided external mediator image

region

string

False

saasSubscriptionId

string

False

SaaS subscription ID

securityGroupId

string

False

serialNumber

string

False

Serial number for BYOL

skipSvmManagementLif

boolean

True

SVM management LIF flag. Beginning with ONTAP 9.11.1, the flag is always set to true.

subnetId

string

True

Subnet ID for a single node cluster

subnetPath

string

False

Subnet path for a single node cluster

svmName

string

False

SVM name

svmPassword

string

False

tenantId

string

False

tierLevel

string

False

Google Cloud available storage classes

username

AdminUsername

False

volume

VsaVolumeOnNewVsaCreateRequest

False

vpcId

string

True

vsaMetadata

VsaMetadataRequest

True

workerPool

string

False

The worker pool URI. Required for private mode Google Cloud deployments with Cloud Volumes ONTAP.

wormRequest

WormRequest

False

writingSpeedState

string

False

Writing speed state

Example request

{
  "capacityTier": "string",
  "cifsConfigurationRequest": {
    "activeDirectoryDomain": "string",
    "activeDirectoryPassword": "string",
    "activeDirectoryUsername": "string",
    "dnsDomain": "string",
    "ipAddresses": [
      "string"
    ],
    "netBIOS": "string",
    "organizationalUnit": "string",
    "svmName": "string"
  },
  "cloudProviderAccount": "string",
  "dataEncryptionType": "string",
  "enableCompliance": false,
  "enableMonitoring": false,
  "enableServices": [
    "string"
  ],
  "failedToCreateWorkingEnvironmentId": "string",
  "firewallRule": "string",
  "firewallTagNameRule": "string",
  "flashCache": false,
  "gcpEncryptionParameters": {
    "key": "string"
  },
  "gcpLabels": [
    {
      "labelKey": "string",
      "labelValue": "string"
    }
  ],
  "gcpServiceAccount": "string",
  "gcpStorageAccount": "string",
  "gcpVolumeSize": {
    "size": 0,
    "unit": "string"
  },
  "gcpVolumeType": "string",
  "haParams": {
    "mediatorZone": "string",
    "node1Zone": "string",
    "node2Zone": "string",
    "platformSerialNumberNode1": "string",
    "platformSerialNumberNode2": "string",
    "subnet0NodeAndDataConnectivity": "string",
    "subnet1ClusterConnectivity": "string",
    "subnet2HAConnectivity": "string",
    "subnet3DataReplication": "string",
    "vpc0FirewallRuleName": "string",
    "vpc0FirewallRuleTagName": "string",
    "vpc0NodeAndDataConnectivity": "string",
    "vpc1ClusterConnectivity": "string",
    "vpc1FirewallRuleName": "string",
    "vpc1FirewallRuleTagName": "string",
    "vpc2FirewallRuleName": "string",
    "vpc2FirewallRuleTagName": "string",
    "vpc2HAConnectivity": "string",
    "vpc3DataReplication": "string",
    "vpc3FirewallRuleName": "string",
    "vpc3FirewallRuleTagName": "string"
  },
  "name": "string",
  "nssAccount": "string",
  "packageName": "string",
  "project": "string",
  "providedImage": "string",
  "providedMediatorImage": "string",
  "region": "string",
  "saasSubscriptionId": "string",
  "securityGroupId": "string",
  "serialNumber": "string",
  "skipSvmManagementLif": false,
  "subnetId": "string",
  "subnetPath": "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"
  },
  "workerPool": "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
capacityFeatures	CapacityFeatures	False
cbsProperties	CbsPropertiesWithReason	False
cloudProviderName	string	False
clusterProperties	VsaClusterProperties	False
complianceProperties	CloudComplianceStatusResponse	False
creatorUserEmail	string	False
encryptionProperties	EncryptionProperties	False
fpolicyProperties	FpolicyProperties	False
haProperties	GcpHaProperties	False
isHA	boolean	True
licensesInformation	array[LicenseInformation]	True
monitoringProperties	MonitoringStatusResponse	False
name	string	False
ontapClusterProperties	OntapClusterProperties	False
providerProperties	GcpProperties	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

Name

Type

Required

Description

actionsRequired

array[ActionRequired]

True

activeActions

array[string]

False

Actions currently being performed on this system

capacityFeatures

CapacityFeatures

False

cbsProperties

CbsPropertiesWithReason

False

cloudProviderName

string

False

clusterProperties

VsaClusterProperties

False

complianceProperties

CloudComplianceStatusResponse

False

creatorUserEmail

string

False

encryptionProperties

EncryptionProperties

False

fpolicyProperties

FpolicyProperties

False

haProperties

GcpHaProperties

False

isHA

boolean

True

licensesInformation

array[LicenseInformation]

True

monitoringProperties

MonitoringStatusResponse

False

name

string

False

ontapClusterProperties

OntapClusterProperties

False

providerProperties

GcpProperties

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

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"
  ],
  "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",
  "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",
  "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": {
    "mediatorInfo": {
      "instanceStatus": "string",
      "instanceType": "string",
      "mediatorInstanceName": "string",
      "primaryIp": "string",
      "version": "string",
      "zone": "string"
    },
    "node1Info": {
      "instanceName": "string",
      "instanceStatus": "string",
      "instanceType": "string",
      "primaryIp": "string",
      "zone": "string"
    },
    "node2Info": {
      "instanceName": "string",
      "instanceStatus": "string",
      "instanceType": "string",
      "primaryIp": "string",
      "zone": "string"
    },
    "projectName": "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"
  },
  "providerProperties": {
    "deploymentName": "string",
    "instanceType": "string",
    "name": "string",
    "projectName": "string",
    "regionName": "string",
    "subnetCidr": "string",
    "zoneName": [
      "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

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

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

firewallIpRanges

Firewall IP ranges

GcpEncryption

Name	Type	Required	Description
key	string	False

Name

Type

Required

Description

key

string

False

GcpLabel

Name	Type	Required	Description
labelKey	string	False
labelValue	string	False

Name

Type

Required

Description

labelKey

string

False

labelValue

string

False

iops

Optional IOPS for the aggregate

throughput

Optional throughput for the aggregate

GcpPerformance

Name	Type	Required	Description
iops	iops	False	Optional IOPS for the aggregate
throughput	throughput	False	Optional throughput for the aggregate

Name

Type

Required

Description

iops

False

Optional IOPS for the aggregate

throughput

False

Optional throughput for the aggregate

Capacity

Name	Type	Required	Description
size	number	True	Size
unit	string	True	Unit

Name

Type

Required

Description

size

number

True

Size

unit

string

True

Unit

GcpHaParameters

Name	Type	Required	Description
mediatorZone	string	False	Zone for mediator
node1Zone	string	False	Zone for node 1
node2Zone	string	False	Zone for node 2
platformSerialNumberNode1	string	False	Platform serial number for node 1
platformSerialNumberNode2	string	False	Platform serial number for node 2
subnet0NodeAndDataConnectivity	string	False	Subnet path for nic1, required for node and data connectivity
subnet1ClusterConnectivity	string	False	Subnet path for nic2, required for cluster connectivity
subnet2HAConnectivity	string	False	Subnet path for nic3, required for HA connectivity
subnet3DataReplication	string	False	Subnet path for nic4, required for data replication
vpc0FirewallRuleName	string	False	Optional firewall rule name for vpc1
vpc0FirewallRuleTagName	string	False	Optional firewall tag name for vpc1
vpc0NodeAndDataConnectivity	string	False	VPC path for nic1, required for node and data connectivity
vpc1ClusterConnectivity	string	False	VPC path for nic2, required for cluster connectivity
vpc1FirewallRuleName	string	False	Optional firewall rule name for vpc2
vpc1FirewallRuleTagName	string	False	Optional firewall tag name for vpc2
vpc2FirewallRuleName	string	False	Optional firewall rule name for vpc3
vpc2FirewallRuleTagName	string	False	Optional firewall tag name for vpc3
vpc2HAConnectivity	string	False	VPC path for nic3, required for HA connectivity
vpc3DataReplication	string	False	VPC path for nic4, required for data replication
vpc3FirewallRuleName	string	False	Optional firewall rule name for vpc4
vpc3FirewallRuleTagName	string	False	Optional firewall tag name for vpc4

Name

Type

Required

Description

mediatorZone

string

False

Zone for mediator

node1Zone

string

False

Zone for node 1

node2Zone

string

False

Zone for node 2

platformSerialNumberNode1

string

False

Platform serial number for node 1

platformSerialNumberNode2

string

False

Platform serial number for node 2

subnet0NodeAndDataConnectivity

string

False

Subnet path for nic1, required for node and data connectivity

subnet1ClusterConnectivity

string

False

Subnet path for nic2, required for cluster connectivity

subnet2HAConnectivity

string

False

Subnet path for nic3, required for HA connectivity

subnet3DataReplication

string

False

Subnet path for nic4, required for data replication

vpc0FirewallRuleName

string

False

Optional firewall rule name for vpc1

vpc0FirewallRuleTagName

string

False

Optional firewall tag name for vpc1

vpc0NodeAndDataConnectivity

string

False

VPC path for nic1, required for node and data connectivity

vpc1ClusterConnectivity

string

False

VPC path for nic2, required for cluster connectivity

vpc1FirewallRuleName

string

False

Optional firewall rule name for vpc2

vpc1FirewallRuleTagName

string

False

Optional firewall tag name for vpc2

vpc2FirewallRuleName

string

False

Optional firewall rule name for vpc3

vpc2FirewallRuleTagName

string

False

Optional firewall tag name for vpc3

vpc2HAConnectivity

string

False

VPC path for nic3, required for HA connectivity

vpc3DataReplication

string

False

VPC path for nic4, required for data replication

vpc3FirewallRuleName

string

False

Optional firewall rule name for vpc4

vpc3FirewallRuleTagName

string

False

Optional firewall tag name for vpc4

pattern

Regex

Name	Type	Required	Description
groupNames	array[string]	True
pattern	pattern	True

Name

Type

Required

Description

groupNames

array[string]

True

pattern

True

PatternMessage

Name	Type	Required	Description
message	string	False
regex	Regex	True

Name

Type

Required

Description

message

string

False

regex

Regex

True

AdminUsername

Name	Type	Required	Description
_1	string	True
validatesWith	PatternMessage	True

Name

Type

Required

Description

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

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

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

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

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

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

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

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

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

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

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

Name

Type

Required

Description

length

integer

True

Length

unit

string

True

Unit

WormRequest

Name	Type	Required	Description
retentionPeriod	WormRetentionPeriod	True

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

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

Name

Type

Required

Description

addedCapacityToExistingEvDisks

Capacity

False

newRaidForEvInfo

array[RaidInfoForEvAggregate]

False

New RAID information

totalCapacityToAdd

Capacity

False

totalEvDisks

integer

False

InstanceNameIdAndType

Name	Type	Required
instanceId	string	False
instanceName	string	False
instanceType	string	False

Name

Type

Required

Description

instanceId

string

False

instanceName

string

False

instanceType

string

False

OntapLicenseType

Name	Type	Required
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

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

Name

Type

Required

Description

newInstanceType

string

False

newLicenseType

OntapLicenseType

False

DisksDetails

Name	Type	Required
diskSize	Capacity	False
diskType	string	False
numberOfDisks	integer	False

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

Name

Type

Required

Description

instanceNameAndType

array[InstanceNameIdAndType]

False

numberOfDisksAndDiskSize

array[DisksDetails]

False

VolumeInfo

Name	Type	Required
newCapacity	Capacity	False
svmName	string	False
volumeName	string	False

Name

Type

Required

Description

newCapacity

Capacity

False

svmName

string

False

volumeName

string

False

VolumeMoveParameters

Name	Type	Required
homeNode	string	False
isNewTargetAggregate	boolean	False
svmName	string	False
targetAggregateName	string	False
volumeName	string	False

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

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

Name

Type

Required

Description

actionType

string

True

The type of the Action

parameters

ActionRequiredParameters

True

severity

string

True

Action Severity

iops

DefaultProviderVolume

Name	Type	Required
capacityTier	string	False
diskType	string	False
iops	iops	False
size	Capacity	False

Name

Type

Required

Description

capacityTier

string

False

diskType

string

False

iops

False

size

Capacity

False

existingIops

MaxDisksAllow

Name	Type	Required	Description
numOfDisks	integer	False
reason	string	False

Name

Type

Required

Description

numOfDisks

integer

False

reason

string

False

ProviderVolumeTypeResponse

Name	Type	Required
maxDisksAllow	MaxDisksAllow	True
size	Capacity	False
supportedVolumeTypes	array[string]	False

Name

Type

Required

Description

maxDisksAllow

MaxDisksAllow

True

size

Capacity

False

supportedVolumeTypes

array[string]

False

SupportedCapacityTiersResponse

Name	Type	Required
availableTieringPolicies	array[string]	False
supportedCapacityTiers	array[string]	False
volumeType	string	False

Name

Type

Required

Description

availableTieringPolicies

array[string]

False

supportedCapacityTiers

array[string]

False

volumeType

string

False

SupportedCapacityTiers

Name	Type	Required
capacityTiersDisableReasons	array[string]	False
compositeSupported	boolean	False
forceCompositeVersion	boolean	False
supportedCapacityTiersPerVolumeType	array[SupportedCapacityTiersResponse]	True

Name

Type

Required

Description

capacityTiersDisableReasons

array[string]

False

compositeSupported

boolean

False

forceCompositeVersion

boolean

False

supportedCapacityTiersPerVolumeType

array[SupportedCapacityTiersResponse]

True

CapacityFeatures

Name	Type	Required
defaultProviderVolumeType	DefaultProviderVolume	False
existingIops	array[existingIops]	False
maxDisksPerAggregate	integer	False
providerVolumesType	array[ProviderVolumeTypeResponse]	False
supportedCapacityTiers	SupportedCapacityTiers	False

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

Name

Type

Required

Description

snapmirrorLabel

string

False

snapshotsToKeep

integer

False

ProviderSpecific

Name	Type	Required
azureRgName	string	False
gcpProjectId	string	False
gcpRegion	string	False

Name

Type

Required

Description

azureRgName

string

False

gcpProjectId

string

False

gcpRegion

string

False

CbsPropertiesWithReason

Name	Type	Required
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

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

lastModifiedOffbox

VsaLicense

Name	Type	Required	Description
capacityLimit	Capacity	True
name	string	True	License name

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

Name

Type

Required

Description

dataProtocols

array[string]

True

List of supported protocols

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
autoUpdateAllowed	boolean	True
imageVersion	string	True
lastModified	integer	True

Name

Type

Required

Description

autoUpdateAllowed

boolean

True

imageVersion

string

True

lastModified

integer

True

VsaClusterProperties

Name	Type	Required
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

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

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
error	string	False
name	string	False
scopeId	scopeId	False
status	string	False

Name

Type

Required

Description

error

string

False

name

string

False

scopeId

False

status

string

False

ComplianceScanStatusResponse

Name	Type	Required
notScanned	integer	False
scanned	integer	False
volumes	array[ComplianceScanStatusVolumeResponse]	False

Name

Type

Required

Description

notScanned

integer

False

scanned

integer

False

volumes

array[ComplianceScanStatusVolumeResponse]

False

ComplianceExtendedStatusResponse

Name	Type	Required
nonSensitiveHits	integer	False
personalHits	integer	False
scanStatus	ComplianceScanStatusResponse	False
sensitivePersonalHits	integer	False

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

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

AwsEncryptionKey

False

awsVolumeEncryption

boolean

False

azureVolumeEncryption

boolean

False

encryptionCertificates

array[CertificateResponse]

False

gcpVolumeEncryption

boolean

False

keyManagers

array[KeyManagerResponse]

False

ontapEncryption

boolean

False

s3EncryptionKey

AwsEncryptionKey

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

GcpHaMediatorInfo

Name

Type

Required

Description

instanceStatus

string

False

instanceType

string

False

mediatorInstanceName

string

False

primaryIp

string

False

version

string

False

zone

string

False

labels Hash mapping strings to string

Name

Type

Required

Description

empty

boolean

False

traversableAgain

boolean

False

GcpHaNodeInfo

Name

Type

Required

Description

instanceName

string

False

instanceStatus

string

False

instanceType

string

False

labels

False

numOfNics

integer

False

primaryIp

string

False

zone

string

False

GcpHaProperties

Name

Type

Required

Description

mediatorInfo

GcpHaMediatorInfo

False

node1Info

GcpHaNodeInfo

False

node2Info

GcpHaNodeInfo

False

projectName

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

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

CapacityTierInfo

False

capacityTierStatus

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

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

GcpProperties

Name

Type

Required

Description

deploymentName

string

False

instanceType

string

False

labels

False

name

string

False

numOfNics

integer

False

projectName

string

False

regionName

string

False

subnetCidr

string

False

zoneName

array[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

string

False

name

string

False

CvoSaasProperties

Name

Type

Required

Description

capacityLicensePackage

string

False

freeTrialExpiry

False

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

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