List of IBM Storage Scale management API commands
The following table lists the currently supported operations for each type of resource and resource element. The first and second columns list the resource type and the operation. The third column lists the resource and resource element terms that appear in the HTTPS request. The braces {} are a notation for indicating a resource element in text and do not appear in the actual HTTPS request. The fourth column lists the HTTP method that is called to do the operation. A footnote indicates a request that requires HTTP parameters.
Note: You can access the documentation corresponding to each API command from the GUI node. The API
documentation is available in the GUI at: https://<IP address or host name of GUI
server>:<port>/api/explorer/. For example,
https://scalegui.ibm.com:443/api/explorer.
| Resource type | Operation | Resource/{element} | Method |
|---|---|---|---|
| CES addresses | Get information about CES addresses. | /ces/addresses | GET |
| Get information about a CES address. | /ces/addresses/{cesAddress} | GET | |
| CES services | Get information about CES services. | ces/services | GET |
| Get information about a CES service. | /ces/services/{service} | GET | |
| Cluster | Get information about the current cluster. | /cluster | GET |
| GPFS snap | List the GPFS snap files containing the diagnostic data that is collected by the gpfs.snap command. | /diagnostic/snap | GET |
| Create a GPFS snap file. | /diagnostic/snap | POST | |
| Download the specific snap file that comprises the diagnostic data to troubleshoot issues in the system. | /diagnostic/snap/{snapPath} | GET | |
| Upload a snap file to a PMR. | /diagnostic/snap/{snapPath}/pmr/{pmrID} | PUT | |
| Delete the snap file that contains the diagnostic data that is collected by the gpfs.snap command. | diagnostic/snap/{snapPath} | DELETE | |
| CLI audit log | Gets details of the CLI commands that are issued on the cluster. | /cliauditlog | GET |
| Config | Get the current configuration attributes. | /config | GET |
| File systems | Get information about file systems in the cluster. | /filesystems | GET |
| Get information about a file system. | /filesystems/{filesystemName} | GET | |
| Resume a file system. | filesystems/{filesystemName}/resume | PUT | |
| Suspend a file system. | /filesystems/{filesystemName}/suspend | PUT | |
| Unmount a file system. | /filesystems/{filesystemName}/unmount | PUT | |
| ACLs | Get access control list of a file or directory in a file system. | /filesystems/{filesystemName}/acl/{path} | GET |
| Set an access control list for a file or directory in a file system. | /filesystems/{filesystemName}/acl/{path} | PUT | |
| Get the list of all REST API access control lists (ACL). | /access/acls | GET | |
| Get the list of the REST API access control lists (ACL) defined for a user group. | /access/acls/{userGroup} | GET | |
| Delete all the REST API access control lists (ACL) that is defined for a user group. | /access/acls/{userGroup} | DELETE | |
| Delete a specified REST API access control lists (ACL) entry that is defined for a user group. | /access/acls/{userGroup}/entry/{entryID} | DELETE | |
| Copy a REST API ACL entry from an existing group and overwrite the entries that are defined for the specified group. | /access/acls/{userGroup} | POST | |
| Add a REST API access control list (ACL) entry for a user group. | /access/acls/{userGroup} | PUT | |
| File audit logging | Enable or disable file audit logging for a file system. | /filesystems/{filesystemName}/audit | PUT |
| Storage Pool | Get information about a particular storage pool. | /filesystems/{filesystemName}/pools/{poolName} | GET |
| Get the list of storage pools in a specific file system. | /filesystems/{filesystemName}/pools | GET | |
| Disks | Get details about disks that are part of a file system. | /filesystems/{filesystemName}/disks | GET |
| Get details about a disk that is part of a file system. | /filesystems/{filesystemName}/disks/{diskName} | GET | |
| Filesets | Get information about filesets in a file system. | /filesystems/{filesystemName}/filesets | GET |
| Get information about a fileset. | /filesystems/{filesystemName}/filesets/{filesetName} | GET | |
| Create a fileset. | /filesystems/{filesystemName}/filesets | POST | |
| Modify a fileset. | /filesystems/{filesystemName}/filesets/{filesetName} | PUT | |
| Delete a fileset. | /filesystems/{filesystemName}/filesets/{filesetName} | DELETE | |
| Link an existing fileset. | /filesystems/{filesystemName}/filesets/{filesetName}/link | POST | |
| Unlink a fileset. | /filesystems/{filesystemName}/filesets/{filesetName}/link | DELETE | |
| Control AFM for a fileset. | /filesystems/{filesystemName}/filesets/{filesetName}/afmctl | POST | |
| Directory | Creates a directory on a GPFS file system. | /filesystems/{filesystemName}/directory/{path} | POST |
| Remove a directory from a GPFS file system. | /filesystems/{filesystemName}/directory/{path} | DELETE | |
| Copy a directory on a file system. | /filesystems/{filesystemName}/directoryCopy/{sourcePath} | PUT | |
| Create a directory on a fileset. | /filesystems/{filesystemName}/filesets/{filesetName}/directory/{path} | POST | |
| Remove a directory from a fileset. | /filesystems/{filesystemName}/filesets/{filesetName}/directory/{path} | DELETE | |
| Copy a directory on a fileset. | /filesystems/{filesystemName}/filesets/{filesetName}/directoryCopy/{sourcePath} | PUT | |
| Quotas | Get information about quota defined at the fileset level. | /filesystems/{filesystemName}/filesets/{filesetName}/quotas | GET |
| Set quota limits at the fileset level. | /filesystems/{filesystemName}/filesets/{filesetName}/quotas | POST | |
| Get information about quota defined at the file system level. | /filesystems/{filesystemName}/quotas | GET | |
| Set quota limits at the file system level. | /filesystems/{filesystemName}/quotas | POST | |
| List quota defaults in a cluster. | /filesystems/{filesystemName}/filesets/{filesetName}/quotadefaults | GET | |
| Set the quota defaults USR, GRP, or FILESET for a file system. | /filesystems/{filesystemName}/filesets/{filesetName}/quotadefaults | POST | |
| Enable/disable the quota defaults for a fileset. | /filesystems/{filesystemName}/filesets/{filesetName}/quotadefaults | PUT | |
| List quota defaults in the cluster. | /filesystems/{filesystemName}/quotagracedefaults | GET | |
| Set the default quota for user, group, and fileset of a file system. | /filesystems/{filesystemName}/quotagracedefaults | POST | |
| Enable or disable the quota management for a file system. | /filesystems/{filesystemName}/quotamanagement | PUT | |
| Cloud Object Store | Create a Cloud Object Store fileset. | /filesystems/{filesystemName}/filesets/cos | POST |
| Create a Cloud Object Store-related directory in a fileset. | /filesystems/{filesystemName}/filesets/{filesetName}/cos/directory | POST | |
| Download files from Cloud Object Store. | /filesystems/{filesystemName}/filesets/{filesetName}/cos/download | POST | |
| Evict files from object store. | /filesystems/{filesystemName}/filesets/{filesetName}/cos/evict | POST | |
| Upload files to the object store. | /filesystems/{filesystemName}/filesets/{filesetName}/cos/upload | POST | |
| Owner | Get details of the owner of the file or directory in a file system. | /filesystems/{filesystemName}/owner/{path} | GET |
| Set owner of the file or directory in a file system. | /filesystems/{filesystemName}/owner/{path} | PUT | |
| Policies | Lists the policies that are applied on the file system. | /filesystems/{filesystemName}/policies | GET |
| Sets a policy for a file system. | /filesystems/{filesystemName}/policies | PUT | |
| Information | Get information about the IBM Storage Scale management API. | /info | GET |
| Jobs | Get details about asynchronous jobs. | /jobs | GET |
| Get details about an asynchronous job. | /jobs/{jobID} | GET | |
| Cancel a specific asynchronous job. | /jobs/{jobId} | DELETE | |
| NFS exports | Get information about NFS exports configured in the system. | /nfs/exports | GET |
| Get information about an NFS export configured in the system. | /nfs/exports/{exportPath} | GET | |
| Create an NFS export. | /nfs/exports | POST | |
| Modify an existing NFS export. | /nfs/exports/{exportPath} | PUT | |
| Delete an NFS export. | /nfs/exports/{exportPath} | DELETE | |
| Nodes | Get information about nodes in the cluster. | /nodes | GET |
| Get information about a node. | /nodes/{nodeName} | GET | |
| Add one or more nodes in the cluster. | /nodes | POST | |
| Delete one or more nodes from the cluster. | /nodes/{name} | DELETE | |
| Change node designation for a node or node class. | /nodes/{name} | PUT | |
| Node mapping | List all AFM node mappings. | /nodes/afm/mapping | GET |
| Create AFM node mapping. | /nodes/afm/mapping | POST | |
| Delete existing mapping. | /nodes/afm/mapping/{mappingName} | DELETE | |
| Gets the details of a specific map. | /nodes/afm/mapping/{mappingName} | GET | |
| Change an existing map. | /nodes/afm/mapping/{mappingName} | PUT | |
| Node health | Get details about system health events that are reported on a node. | /nodes/{name}/heath/events | GET |
| Get details about system health states of the events that are reported in a node. | /nodes/{name}/heath/states | GET | |
| Node class | Get details of the node classes. | /nodeclasses | GET |
| Create a node class. | /nodeclasses | POST | |
| Delete a specific node class. | /nodeclasses/{nodeclassName} | DELETE | |
| Get details of a specific node class. | /nodeclasses/{nodeclassName} | GET | |
| Make changed to a specific node class. | /nodeclasses/{nodeclassName} | PUT | |
| Symlink | Remove a symlink from a GPFS file system. | /filesystems/{filesystemName}/symlink/{path} | DELETE |
| Create a symlink for a path from a GPFS file system. | /filesystems/{filesystemName}/symlink/{linkPath} | POST | |
| Services | Gets the details of the services that are configured on a node. | /nodes/{name}/services | GET |
| Gets the details of a specific service that is configured on a node. | /nodes/{name}/services/{serviceName} | GET | |
| Starts or stops a service on a node or node class. | /nodes/{name}/services/{serviceName} | PUT | |
| NSDs | Gets information about NSDs that are part of the system. | /nsds | GET |
| Gets information about an NSD. | /nsds/{nsdName} | GET | |
| Snapshots | Get information about fileset snapshots. | /filesystems/{filesystemName}/filesets/{filesetName}/snapshots | GET |
| Get information about a fileset snapshot. | /filesystems/{filesystemName}/filesets/{filesetName}/snapshots/{snapshotName} | GET | |
| Get information about file system snapshots. | /filesystems/{filesystemName}/snapshots | GET | |
| Get information about a file system snapshot. | /filesystems/{filesystemName}/snapshots/{snapshotName} | GET | |
| Create a fileset snapshot. | /filesystems/{filesystemName}/filesets/{filesetName}/snapshots | POST | |
| Create a file system snapshot. | /filesystems/{filesystemName}/snapshots | POST | |
| Delete a fileset snapshot. | /filesystems/{filesystemName}/filesets/{filesetName}/snapshots | DELETE | |
| Delete a file system snapshot. | /filesystems/{filesystemName}/snapshots | DELETE | |
| Copy a file system snapshot. | /filesystems/{filesystemName}/filesets/{filesetName}/snapshotCopy/{snapshotName} | PUT | |
| Copy a directory from a path relative to a snapshot of the file system. | /filesystems/{filesystemName}/filesets/{filesetName}/snapshotCopy/{snapshotName}/path/{source Path} | PUT | |
| AFM peer snapshots | Create a peer snapshot. | /filesystems/{filesystemName}/filesets/{filesetName}/psnaps | POST |
| Delete a peer snapshot. | /filesystems/{filesystemName}/filesets/{filesetName}/psnaps/{snapshotName} | DELETE | |
| AFM | List AFM state in a file system. | /filesystems/{filesystemName}/afm/state | GET |
| SMB shares | Get information about SMB shares. | smb/shares | GET |
| Get information about an SMB share. | /smb/shares/{shareName} | GET | |
| Create an SMB share. | /smb/shares | POST | |
| Modify an existing SMB share. | /smb/shares/{shareName} | PUT | |
| Delete an SMB share. | /smb/shares/{shareName} | DELETE | |
| Delete complete access control list of an SMB share. | /smb/shares/{shareName}/acl | DELETE | |
| Get access control list of share. | /scalemgmt/v2/smb/shares/{shareName}/acl | GET | |
| Delete an entry from the access control list of a SMB share. | /smb/shares/{shareName}/acl/{name} | DELETE | |
| Get access control list entry of a specific user/group/system of share. | /smb/shares/{shareName}/acl/{name} | GET | |
| Adds an entry to the access control list of an SMB share. | /smb/shares/{shareName}/acl/{name} | PUT | |
| Performance monitoring | Get performance data. | /perfmon/data | GET |
| Gets the sensor configuration. | /perfmon/sensor | GET | |
| Gets details about a specific sensor configuration. | /perfmon/sensor/{sensorName} | GET | |
| Modifies the sensor configuration. | /perfmon/sensor/{sensorName} | PUT | |
| Run a custom query for performance data. | /perfmon/stats | GET | |
| Thresholds | Get list of threshold rules. | /thresholds | GET |
| Create a threshold rule. | /thresholds | POST | |
| Delete an existing threshold rule. | /thresholds/{name} | DELETE | |
| Get details of a threshold rule. | thresholds/{name} | GET | |
| For more information about the commands, see IBM Storage Scale management API endpoints. | |||