Retrieve all volumes

Parameters

Name	Type	In	Required	Description
workingEnvironmentId	string	query	False

Name

Type

In

Required

Description

workingEnvironmentId

string

query

False

Error

Status: Default, Default response

Name	Type	Required	Description
aggregateName	string	True	Aggregate name
autoSizeMode	string	True	The operating mode of autosize
capacityTier	string	False	Capacity tier
capacityTierUsedSize	Capacity	False
cbsBackupsInfo	VolumeCbsInfo	False
cifsShareAccessPoint	string	False	CIFS share access point
cloneNames	array[string]	True	Names of cloned copies of the volume
comment	string	False	Volume comment
compression	boolean	True	Specifies whether compression is enabled
compressionSpaceSaved	Capacity	True
constituentsAggregates	array[string]	True	Aggregates which are used for FlexGroup constituents
deduplication	boolean	True	Specifies whether deduplication is enabled
deduplicationSpaceSaved	Capacity	True
exportPolicyInfo	NamedExportPolicyInfo	True
isFlexGroupVolume	boolean	True	Indicates if the volume is FlexGroup volume
iscsiEnabled	boolean	True	Indicates if the volume is used by the iSCSI protocol
junctionPath	string	True	The junction path at which this volume is mounted
maxGrowSize	Capacity	True
minimumCoolingDays	integer	False	Tiering minimum cooling days
mountPoint	string	False	Mount Point
moving	boolean	True	Specifies if the volume move process is in progress
name	string	True	Volume name
parentSnapshot	string	False	The snapshot name the volume is based on
parentVolumeName	string	True	Name of the parent flexible volume for the clone
primaryCifsShareAccessPoint	string	False	Primary CIFS share access point
primaryNoFailoverMountPoint	string	False	Primary mount point without failover
providerVolumeType	string	False	Cloud provider volume type
qosPolicyGroupName	string	False	Quality of service policy group name
rootVolume	boolean	True	Indicates if the volume is a SVM root volume
secondaryCifsShareAccessPoint	string	False	Secondary CIFS share access point
secondaryNoFailoverMountPoint	string	False	Secondary mount point without failover
securityStyle	string	True	The type of the security style
shareInfo	array[CifsShareInfo]	True	The share names, permissions, and users for CIFS
shareNames	array[string]	True	The share names for CIFS
size	Capacity	True
snaplockType	string	False	SnapLock type
snapshotPolicy	string	True	The name of the snapshot policy
snapshotsUsedSize	Capacity	False
state	string	True	Volume state
svmName	string	True	Volume SVM name
targetName	string	True	iSCSI target IQN
thinProvisioning	boolean	True	Specifies whether thin provisioning is enabled
tierInactiveUserData	Capacity	False
tierInactiveUserDataPercent	integer	False	Tier inactive user data percentage
tieringPolicy	string	False	Tiering policy
usedSize	Capacity	True
uuid	string	True	Volume UUID
volumeTotalInodes	integer	False	Total volume inodes size
volumeType	string	True	Volume type
volumeUsedInodes	integer	False	Used volume inodes size

Name

Type

Required

Description

aggregateName

string

True

Aggregate name

autoSizeMode

string

True

The operating mode of autosize

capacityTier

string

False

Capacity tier

capacityTierUsedSize

Capacity

False

cbsBackupsInfo

VolumeCbsInfo

False

cifsShareAccessPoint

string

False

CIFS share access point

cloneNames

array[string]

True

Names of cloned copies of the volume

comment

string

False

Volume comment

compression

boolean

True

Specifies whether compression is enabled

compressionSpaceSaved

Capacity

True

constituentsAggregates

array[string]

True

Aggregates which are used for FlexGroup constituents

deduplication

boolean

True

Specifies whether deduplication is enabled

deduplicationSpaceSaved

Capacity

True

exportPolicyInfo

NamedExportPolicyInfo

True

isFlexGroupVolume

boolean

True

Indicates if the volume is FlexGroup volume

iscsiEnabled

boolean

True

Indicates if the volume is used by the iSCSI protocol

junctionPath

string

True

The junction path at which this volume is mounted

maxGrowSize

Capacity

True

minimumCoolingDays

integer

False

Tiering minimum cooling days

mountPoint

string

False

Mount Point

moving

boolean

True

Specifies if the volume move process is in progress

name

string

True

Volume name

parentSnapshot

string

False

The snapshot name the volume is based on

parentVolumeName

string

True

Name of the parent flexible volume for the clone

primaryCifsShareAccessPoint

string

False

Primary CIFS share access point

primaryNoFailoverMountPoint

string

False

Primary mount point without failover

providerVolumeType

string

False

Cloud provider volume type

qosPolicyGroupName

string

False

Quality of service policy group name

rootVolume

boolean

True

Indicates if the volume is a SVM root volume

secondaryCifsShareAccessPoint

string

False

Secondary CIFS share access point

secondaryNoFailoverMountPoint

string

False

Secondary mount point without failover

securityStyle

string

True

The type of the security style

shareInfo

array[CifsShareInfo]

True

The share names, permissions, and users for CIFS

shareNames

array[string]

True

The share names for CIFS

size

Capacity

True

snaplockType

string

False

SnapLock type

snapshotPolicy

string

True

The name of the snapshot policy

snapshotsUsedSize

Capacity

False

state

string

True

Volume state

svmName

string

True

Volume SVM name

targetName

string

True

iSCSI target IQN

thinProvisioning

boolean

True

Specifies whether thin provisioning is enabled

tierInactiveUserData

Capacity

False

tierInactiveUserDataPercent

integer

False

Tier inactive user data percentage

tieringPolicy

string

False

Tiering policy

usedSize

Capacity

True

uuid

string

True

Volume UUID

volumeTotalInodes

integer

False

Total volume inodes size

volumeType

string

True

Volume type

volumeUsedInodes

integer

False

Used volume inodes size

Example error response

{
  "aggregateName": "string",
  "autoSizeMode": "string",
  "capacityTier": "string",
  "capacityTierUsedSize": {
    "size": 0,
    "unit": "string"
  },
  "cifsShareAccessPoint": "string",
  "cloneNames": [
    "string"
  ],
  "comment": "string",
  "compression": false,
  "compressionSpaceSaved": {
    "size": 0,
    "unit": "string"
  },
  "constituentsAggregates": [
    "string"
  ],
  "deduplication": false,
  "deduplicationSpaceSaved": {
    "size": 0,
    "unit": "string"
  },
  "exportPolicyInfo": {
    "ips": [
      "string"
    ],
    "name": "string",
    "nfsVersion": [
      "string"
    ],
    "policyType": "string",
    "rules": [
      {
        "ips": [
          "string"
        ],
        "nfsVersion": [
          "string"
        ],
        "ruleAccessControl": "string",
        "superUser": false
      }
    ]
  },
  "isFlexGroupVolume": false,
  "iscsiEnabled": false,
  "junctionPath": "string",
  "maxGrowSize": {
    "size": 0,
    "unit": "string"
  },
  "mountPoint": "string",
  "moving": false,
  "name": "string",
  "parentSnapshot": "string",
  "parentVolumeName": "string",
  "primaryCifsShareAccessPoint": "string",
  "primaryNoFailoverMountPoint": "string",
  "providerVolumeType": "string",
  "qosPolicyGroupName": "string",
  "rootVolume": false,
  "secondaryCifsShareAccessPoint": "string",
  "secondaryNoFailoverMountPoint": "string",
  "securityStyle": "string",
  "shareInfo": [
    {
      "accessControlList": [
        {
          "permission": "string",
          "users": [
            "string"
          ]
        }
      ],
      "shareName": "string",
      "vscanFileOpPolicy": "string"
    }
  ],
  "shareNames": [
    "string"
  ],
  "size": {
    "size": 0,
    "unit": "string"
  },
  "snaplockType": "string",
  "snapshotPolicy": "string",
  "snapshotsUsedSize": {
    "size": 0,
    "unit": "string"
  },
  "state": "string",
  "svmName": "string",
  "targetName": "string",
  "thinProvisioning": false,
  "tierInactiveUserData": {
    "size": 0,
    "unit": "string"
  },
  "tieringPolicy": "string",
  "usedSize": {
    "size": 0,
    "unit": "string"
  },
  "uuid": "string",
  "volumeType": "string"
}

Definitions

See Definitions

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

VolumeCbsInfo

Name	Type	Required	Description
totalBackups	integer	False

Name

Type

Required

Description

totalBackups

integer

False

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

NamedExportPolicyInfo

Name	Type	Required	Description
ips	array[string]	True	Custom export policy list of IPs
name	string	False	Export policy name
nfsVersion	array[string]	False	Export policy protocol
policyType	string	True	Export policy type
rules	array[ExportPolicyRule]	True	Export policy rules

Name

Type

Required

Description

ips

array[string]

True

Custom export policy list of IPs

name

string

False

Export policy name

nfsVersion

array[string]

False

Export policy protocol

policyType

string

True

Export policy type

rules

array[ExportPolicyRule]

True

Export policy rules

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

CifsShareInfo

Name	Type	Required	Description
accessControlList	array[CifsShareUserPermissions]	True	List of CIFS share permissions
shareName	string	True	Share name
vscanFileOpPolicy	string	False	Vscan file operations profile

Name

Type

Required

Description

accessControlList

array[CifsShareUserPermissions]

True

List of CIFS share permissions

shareName

string

True

Share name

vscanFileOpPolicy

string

False

Vscan file operations profile