Skip to main content

Retrieve an on-premises ONTAP system

GET /onprem/working-environments/{workingEnvironmentId}

Retrieves an on-premises ONTAP system.

Parameters

Name Type In Required Description

fields

Expands

query

False

workingEnvironmentId

string

path

True

Error

Status: Default, Default response
Name Type Required Description

actionsRequired

array[ActionRequired]

True

aff

boolean

False

capacityFeatures

OnPremCapacityFeatures

False

cbsProperties

CbsPropertiesWithReason

False

cloudSyncProperties

CloudSyncProperties

False

clusterProperties

OnPremClusterProperties

False

complianceProperties

CloudComplianceStatusResponse

False

cronJobSchedules

array[CronJobSchedule]

True

description

string

False

discoverUserEmail

string

False

interClusterLifs

array[InterClusterLif]

True

location

string

False

monitoringProperties

MonitoringStatusResponse

False

name

string

False

ontapClusterProperties

OnPremClusterProperties

False

publicId

string

True

replicationProperties

ReplicationProperties

False

reservedSize

Capacity

False

snapshotPolicies

array[SnapshotPolicy]

True

status

StatusProperties

False

svms

array[Svm]

True

tenantId

string

False

workingEnvironmentType

string

False
Example error response 
{
  "actionsRequired": [
    {}
  ],
  "capacityFeatures": {
    "objectStoreConfigExtended": {
      "objectStoreConfig": {
        "objectStoreName": "string",
        "providerType": "string",
        "s3Name": "string",
        "server": "string"
      },
      "tierLevel": "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"
  },
  "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": {
    "clusterAddress": "string",
    "clusterName": "string",
    "clusterUuid": "string",
    "licenses": [
      "string"
    ],
    "lifs": [
      {}
    ],
    "nodeModels": [
      "string"
    ],
    "ontapVersion": "string",
    "serialNumber": "string",
    "systemId": "string",
    "systemManagerUrl": "string"
  },
  "complianceProperties": {
    "complianceBackupStatus": "string",
    "complianceStatus": {
      "scanStatus": {
        "volumes": [
          {
            "error": "string",
            "name": "string",
            "status": "string"
          }
        ]
      }
    },
    "lastDeploymentError": "string",
    "scanStatus": "string"
  },
  "cronJobSchedules": [
    {
      "days": [
        "string"
      ],
      "description": "string",
      "hours": [
        "string"
      ],
      "minutes": [
        "string"
      ],
      "months": [
        "string"
      ],
      "name": "string",
      "weekDays": [
        "string"
      ]
    }
  ],
  "description": "string",
  "discoverUserEmail": "string",
  "interClusterLifs": [
    {
      "address": "string",
      "name": "string",
      "node": "string",
      "port": "string",
      "status": "string"
    }
  ],
  "location": "string",
  "monitoringProperties": {
    "monitoringInfo": {
      "averageLatency": {
        "unit": "string"
      },
      "node1AverageThroughput": {
        "unit": "string"
      },
      "node2AverageThroughput": {
        "unit": "string"
      },
      "storageAverageThroughput": {
        "unit": "string"
      }
    },
    "monitoringStatus": "string",
    "tenantUrl": "string"
  },
  "name": "string",
  "ontapClusterProperties": {
    "clusterAddress": "string",
    "clusterName": "string",
    "clusterUuid": "string",
    "licenses": [
      "string"
    ],
    "lifs": [
      {}
    ],
    "nodeModels": [
      "string"
    ],
    "ontapVersion": "string",
    "serialNumber": "string",
    "systemId": "string",
    "systemManagerUrl": "string"
  },
  "publicId": "string",
  "replicationProperties": {
    "peers": [
      "string"
    ],
    "replicationTargets": [
      "string"
    ]
  },
  "snapshotPolicies": [
    {
      "description": "string",
      "name": "string",
      "schedules": [
        {}
      ]
    }
  ],
  "status": {
    "extendedFailureReason": "string",
    "message": "string",
    "status": "string"
  },
  "svms": [
    {}
  ],
  "tenantId": "string",
  "workingEnvironmentType": "string"
}

Definitions

See Definitions

Expand

Name Type Required Description

name

string

False

Expands

Name Type Required Description

expands

array[Expand]

True

raw

string

True

Capacity

Name Type Required Description

size

number

True

Size

unit

string

True

Unit

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

ObjectStoreConfigInfo

Name Type Required Description

objectStoreName

string

False

providerType

string

False

s3Name

string

False

server

string

False

usedSpace

Capacity

False

ExtendedObjectStoreConfigInfo

Name Type Required Description

objectStoreConfig

ObjectStoreConfigInfo

False

tierLevel

string

False

OnPremCapacityFeatures

Name Type Required Description

fiveYearSavings

number

False

inactiveUserData

Capacity

False

objectStoreConfigExtended

ExtendedObjectStoreConfigInfo

False

performanceTierUsedCapacity

Capacity

False

rawCapacity

Capacity

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

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

Value

OnPremClusterProperties

Name Type Required Description

aggregateCount

integer

False

clusterAddress

string

False

clusterName

string

False

clusterUuid

string

False

disaggregated

boolean

False

isAff

boolean

False

isSnapmirrorLicenseExists

boolean

False

licenses

array[string]

False

lifs

array[LifResponse]

False

location

Value

False

nodeModels

array[string]

False

ontapVersion

string

False

sanOptimized

boolean

False

serialNumber

string

False

systemId

string

False

systemManagerUrl

string

False

volumeCount

integer

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

InterClusterLif

Name Type Required Description

address

string

False

isPeered

boolean

False

name

string

False

node

string

False

port

string

False

status

string

False

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

ReplicationProperties

Name Type Required Description

peers

array[string]

False

replicationTargets

array[string]

False

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

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