Filesystems/{filesystemName}/quotadefaults: GET

Gets the details of the default quotas that are defined at the file system level.

Availability

Available on all IBM Storage Scale editions.

Description

The GET filesystems/filesystemName/quotadefaults request gets information about the default quotas that are defined at the file system level. For more information, see mmsetquota command and mmrepquota command

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/filesystems/filesystemName/quotadefaults

where

filesystems/filesystemName: The file system about which you need the default quota information. Required.
quotadefaults: Specifies that you need to get the default quota details. Required.

Request headers


Accept: application/json

Request parameters

The following parameters can be used in the request URL to customize the request:

Table 1. List of request parameters
Parameter name	Description and applicable keywords	Required/optional
filesystemName	The file system name. You can also use keywords such as :all:, :all_local:, or :all_remote:	Required.
fields	Comma separated list of fields to be included in response. ':all:' selects all available fields.	Optional.
filter	Filter objects by expression. For example, 'status=HEALTHY,entityType=FILESET'	Optional.

Request data

No request data.

Response data


      {  
         "status": {
             "code":ReturnCode,
             "message":"ReturnMessage"
      },
         "paging": {
         "next": "URL",
         "fields": "Fields specified",
         "filter": "Filter used",
         "baseUrl": "Base URL",
         "lastId": "Last ID"
             },
         "quotaDefaults": [
               {
             "clusterId": {
               "clusterID": "string"
                  },
             "deviceName": "string",
             "filesetName": "Fileset name",
             "quotaType": "Quota type",
             "blockSoftLimit": "Soft limit set for capacity",
             "blockHardLimit": "Hard limit set for capacity",
             "filesSoftLimit": "Soft limit set for number of inodes",
             "filesHardLimit": "Hard limit set for number of inodes",
             "entryType": "DEFAULT_ON",
             ],
   },
}

For more information about the fields in the following data structures, see the links at the end of this topic.

"status":

Return status.

"message": "ReturnMessage",: The return message.
"code": ReturnCode: The return code.

"paging":"Paging details"

"next": "URL",: URL of the next item.
"fields": "Fields specified",: Fields specified in the request.
"filter": "Filter used",: Filters used in the request.
"baseUrl": "Base URL",: Base URL
"lastId": "Last ID",: Last item's ID.

"quotasDefaults":""

"clusterId"

clusterID": "ID": Unique cluster ID.

"deviceName": "string",: Device name.
"filesetId": "Fileset ID",: The fileset ID for which the default quota is applicable.
"filesetName": "Fileset name",: The fileset for which the quota is applicable.
"quotaType":"USR | GRP | FILESET": The quota type.
"blockSoftLimit": "Soft limit set for capacity",: Soft limit set for capacity.
"blockHardLimit": "Hard limit set for capacity",: Hard limit set for capacity.
"filesSoftLimit": "Soft limit set for number of inodes",: Soft limit set for number of inodes.
"filesHardLimit": "Hard limit set for number of inodes",: Hard limit set for number of inodes.
"entryType": "DEFAULT_ON",: Entry type.

Examples

The following example gets quota information for all filesets inside file system mari.

Request URL:

curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/filesystems/gpfs0/filesets/:all/quotadefaults'

Response data:

Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error.

{
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully."
  },
  "quotaDefaults" : [ {
    "deviceName" : "mari",
    "filesetId" : 0,
    "filesetName" : "root",
    "quotaType" : "USR",
    "blockSoftLimit" : 204800,
    "blockHardLimit" : 409600,
    "filesSoftLimit" : 0,
    "filesHardLimit" : 0,
    "entryType" : "DEFAULT_ON"
  }, {
    "deviceName" : "mari",
    "filesetId" : 0,
    "filesetName" : "root",
    "quotaType" : "GRP",
    "blockSoftLimit" : 0,
    "blockHardLimit" : 0,
    "filesSoftLimit" : 0,
    "filesHardLimit" : 0,
    "entryType" : "DEFAULT_ON"
  }, {
    "deviceName" : "mari",
    "filesetId" : 2,
    "filesetName" : "lisa",
    "quotaType" : "USR",
    "blockSoftLimit" : 0,
    "blockHardLimit" : 0,
    "filesSoftLimit" : 0,
    "filesHardLimit" : 0,
    "entryType" : "DEFAULT_ON"
  }, {
    "deviceName" : "mari",
    "filesetId" : 2,
    "filesetName" : "lisa",
    "quotaType" : "GRP",
    "blockSoftLimit" : 0,
    "blockHardLimit" : 0,
    "filesSoftLimit" : 0,
    "filesHardLimit" : 0,
    "entryType" : "DEFAULT_OFF"
  } ]
}