Filesystems/{filesystemName}/filesets: GET

Gets information of all filesets that are part of a specific file system.

Availability

Available on all IBM Spectrum Scale™ editions.

Description

The GET filesystems/{filesystemName}/filesets request gets information about all filesets in the specified file system. For more information about the fields in the data structures that are returned, see the topics mmcrfileset command, mmchfileset command, and mmlsfileset command.

Request URL

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

where:

filesystem/filesystemName: Specifies the name of the file system to which the filesets belong. Required.
filesets: Specifies that you need to get details of all filesets that belong to the specified file system. 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 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"
    },
   "filesets": [
      {         
         "config": 
           {
            "filesetName":"Fileset",
            "filesystemName":"Device",
            "path": "Path",
            "inodeSpace":"Inodes",
            "maxNumInodes":"Inodes",
            "permissionChangeMode":"Mode",
            "comment":"Comment",
            "iamMode":"Mode",
            "oid": "ID",
            "id":"ID",
            "status":"Status"
            "parentId":"ID",
            "created":"DateTime",
            "isInodeSpaceOwner":"isOwner",
            "inodeSpaceMask":"inodeSpace",
            "snapID":"ID",
            "rootInode":"Inode",
           }
        "afm": {  
            "afmTarget":"Protocol://{Host | Map}/Path"
            "afmAsyncDelay":"Delay",
            "afmDirLookupRefreshInterval":"Interval",
            "afmDirOpenRefreshInterval":"Interval",
            "afmEnableAutoEviction":"{yes | no}",
            "afmExpirationTimeout":"Interval",
            "afmFileLookupRefreshInterval":"Interval",
            "afmMode": "{single-writer | sw | read-only | ro | local-updates | lu | 
               independent-writer | Primary | Secondary}",
            "afmNumFlushThreads":"Threads",
            "afmParallelReadChunkSize":"Size",
            "afmParallelReadThreshold":"Threshold",
            "afmParallelWriteChunkSize":"Size",
            "afmParallelWriteThreshold":"Threshold",
            "afmPrefetchThreshold":"{1 | 1-99 | 100}",
            "afmPrimaryID":"ID",
            "afmRPO":"Interval",
            "afmShowHomeSnapshots":"{yes | no}",
         } 
      }
   ],
  }   
}

"status":

Return status.

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

"paging"

The URL to retrieve the next page. Paging is enabled when more than 1000 objects are returned by the query.

"filesets":

An array of information about the filesets in the specified file system. Each array element describes one fileset and can contain the data structures afm, config, links, and state. For more information about the fields in these data structures, see the links at the end of this topic:

"filesets":

Information about the fileset configuration.

"filesetName": "Fileset",

The name of the fileset.

"filesystemName": "Device"

Required. The file system in which the fileset is located.

"path": "Path"

The absolute path of the fileset.

"inodeSpace": "Inodes"

The number of inodes that are allocated for use by the fileset.

"maxNumInodes": "Inodes"

The inode limit for the inode space that is owned by the specified fileset.

"permissionChangeMode": "Mode"

The permission change mode. Controls how chmod and ACL commands affect objects in the fileset.

chmodOnly: Only the chmod command can change access permissions.
setAclOnly: Only the ACL commands and API can change access permissions.
chmodAndSetAcl: Both the chmod command and ACL commands can change access permissions.
chmodAndUpdateAcl: Both the chmod command and ACL commands can change access permissions.

"comment": "Comment",

A comment that appears in the output of the mmlsfileset command.

"iamMode": "Mode"

The integrated archive manager (IAM) mode for the fileset.

ad | advisory
nc | noncompliant
co | compliant

"oid": "ID"

Internal identifier of the fileset that is used for paging.

"id": ID

The fileset identifier.

"status": "Status"

Specifies whether the file is linked or unlinked.

"parentId": ParentID

The parent identifier of the fileset.

"created": "DateTime",

The date and time when the fileset was created.

"isInodeSpaceOwner": "isOwner",

Indicates whether the fileset has its own inode space.

"isInodeSpaceMask": "isMask",

The inode space mask.

"snapID": ID

The snapshot ID.

"afm":

Information about Active File Management (AFM).

"afmTarget": "Interval"Protocol://{Host | Map}/Path"

The home that is associated with the cache.

"afmAsyncDelay": "Delay"

The time in seconds by which to delay write operations because of the lag in updating remote clusters.

"afmDirLookupRefreshInterval":" Interval"

The interval in seconds between data revalidations of directories that are caused by lookup operations such as ls and stat.

"afmDirOpenRefreshInterval": Interval

The interval in seconds between data revalidations of directories that are caused by lookup operations.

"afmEnableAutoEviction": "{yes | no}"

Enables or disables eviction on the fileset.

"afmExpirationTimeout": Interval

The timeout in seconds after which cached data is considered expired. Used with afmDisconnectTimeout, which is set with mmchconfig.

"afmFileLookupRefreshInterval": Interval

The interval in seconds between data revalidations of files that are caused by lookup operations such as ls and stat.

"afmMode": "{single-writer | sw | read-only | ro | local-updates | lu | independent-writer | Primary | Secondary}"

The mode in which the cache operates.

"afmNumFlushThreads": numThreads

The number of threads that are used on each gateway to synchronize updates to the home cluster.

"afmParallelReadChunkSize": Size

The minimum chunk size of read data, in bytes, that must be distributed among the gateway nodes during parallel reads.

"afmParallelReadThreshold": Threshold

The minimum file size, in megabytes, at which to do parallel reads.

"afmParallelWriteChunkSize": Size

The minimum chunk size of write data, in bytes, that must be distributed among the gateway nodes during parallel writes.

"afmParallelWriteThreshold": Threshold

The minimum file size, in megabytes, at which to do parallel writes.

"afmPrefetchThreshold": {1 | 1-99 | 100}

The percentage of file size that must be cached before the entire file is prefetched.

0: Enables full file prefetching.
1-99: The percentage of file size that must be cached before the entire file is prefetched.
100: Disables full file prefetching.

"afmPrimaryID": "ID"

The unique primary ID of the primary fileset for asynchronous data replication.

"afmRPO": Interval

The recovery point objective (RPO) interval, in minutes, for a primary fileset.

"afmShowHomeSnapshots": "{yes | no}"

Shows or hides the home snapshot directory in cache. Specify yes to show, no to hide.

Examples

The following example gets information about the filesets in file system gpfs0.

Request data:

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

The request URL with no field or filter parameter returns only the details that uniquely identify the object.

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.

{
  "filesets" : [ {
    "config" : {
      "filesetName" : "root",
      "filesystemName" : "gpfs0"
    }
  }, {
    "config" : {
      "filesetName" : "fset1",
      "filesystemName" : "gpfs0"
    }
  }, {
    "config" : {
      "filesetName" : "fset2",
      "filesystemName" : "gpfs0"
    }
  } ],
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully"
  }
}

Using the field parameter ":all:" returns entire details of the filesets that are part of the specified file system. For example:

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

{
  "filesets" : [ {
    "afm" : {
      "afmAsyncDelay" : 0,
      "afmDirLookupRefreshInterval" : 0,
      "afmDirOpenRefreshInterval" : 0,
      "afmEnableAutoEviction" : false,
      "afmExpirationTimeout" : 0,
      "afmFileLookupRefreshInterval" : 0,
      "afmMode" : "",
      "afmNumFlushThreads" : 0,
      "afmParallelReadChunkSize" : 0,
      "afmParallelReadThreshold" : 0,
      "afmParallelWriteChunkSize" : 0,
      "afmParallelWriteThreshold" : 0,
      "afmPrefetchThreshold" : 0,
      "afmPrimaryID" : "",
      "afmRPO" : 0,
      "afmShowHomeSnapshots" : false
    },
    "filesets" : [ {
       "config" : { 
       "comment" : "root fileset",
       "created" : "2017-08-21 23:21:21,000",
        "iamMode" : "off",
         "id" : 0,
        "inodeSpace" : 0,
        "inodeSpaceMask" : 4096,
        "isInodeSpaceOwner" : true,
        "maxNumInodes" : 100000,
        "oid" : 66,
        "path" : "/mnt/gpfs0",
        "permissionChangeMode" : "chmodAndSetacl",
        "rootInode" : 3,
        "snapId" : 0,
        "status" : "Linked" 
},
       "filesetName" : "root",
       "filesystemName" : "gpfs0",
       "usage" : {
       "allocatedInodes" : 100000,
       "inodeSpaceFreeInodes" : 95962,
       "inodeSpaceUsedInodes" : 4038,
       "usedBytes" : 0,
        "usedInodes" : 4038
}
}, {
    "afm" : {
      "afmAsyncDelay" : 0,
      "afmDirLookupRefreshInterval" : 0,
      "afmDirOpenRefreshInterval" : 0,
      "afmEnableAutoEviction" : false,
      "afmExpirationTimeout" : 0,
      "afmFileLookupRefreshInterval" : 0,
      "afmMode" : "",
      "afmNumFlushThreads" : 0,
      "afmParallelReadChunkSize" : 0,
      "afmParallelReadThreshold" : 0,
      "afmParallelWriteChunkSize" : 0,
      "afmParallelWriteThreshold" : 0,
      "afmPrefetchThreshold" : 0,
      "afmPrimaryID" : "",
      "afmRPO" : 0,
      "afmShowHomeSnapshots" : false
    },
    "status" : {
    "code" : 200,
    "message" : "The request finished successfully"
  }
}