ibm spectrum scale 5.0.2: command and programming …...ibm spectrum scale v ersion 5.0.2 command...

IBM Spectrum ScaleVersion 5.0.2

Command and ProgrammingReference

SC27-9290-03

IBM

NoteBefore using this information and the product it supports, read the information in “Notices” on page 1319.

This edition applies to version 5 release 0 modification 2 of the following products, and to all subsequent releasesand modifications until otherwise indicated in new editions:v IBM Spectrum Scale ordered through Passport Advantage® (product number 5725-Q01)v IBM Spectrum Scale ordered through AAS/eConfig (product number 5641-GPF)v IBM Spectrum Scale for Linux on Z (product number 5725-S28)v IBM Spectrum Scale for IBM ESS (product number 5765-ESS)

Significant changes or additions to the text and illustrations are indicated by a vertical line (|) to the left of thechange.

IBM welcomes your comments; see the topic “How to send your comments” on page xxii. When you sendinformation to IBM, you grant IBM a nonexclusive right to use or distribute the information in any way it believesappropriate without incurring any obligation to you.

© Copyright IBM Corporation 2014, 2019.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

Tables . . . . . . . . . . . . . . . vii

About this information . . . . . . . . ixPrerequisite and related information . . . . . . xxConventions used in this information . . . . . xxiHow to send your comments . . . . . . . . xxii

Summary of changes. . . . . . . . xxiii

Chapter 1. Command reference. . . . . 1gpfs.snap command . . . . . . . . . . . . 6mmaddcallback command . . . . . . . . . 11mmadddisk command. . . . . . . . . . . 25mmaddnode command . . . . . . . . . . 31mmadquery command. . . . . . . . . . . 34mmafmconfig command . . . . . . . . . . 39mmafmctl command . . . . . . . . . . . 42mmafmlocal command . . . . . . . . . . 57mmapplypolicy command . . . . . . . . . 59mmaudit command. . . . . . . . . . . . 71mmauth command . . . . . . . . . . . . 76mmbackup command . . . . . . . . . . . 81mmbackupconfig command . . . . . . . . . 90mmblock command . . . . . . . . . . . 92mmbuildgpl command . . . . . . . . . . 97mmcachectl command . . . . . . . . . . . 99mmcallhome command . . . . . . . . . . 102mmces command . . . . . . . . . . . . 115mmcesdr command . . . . . . . . . . . 125mmchattr command . . . . . . . . . . . 134mmchcluster command . . . . . . . . . . 141mmchconfig command . . . . . . . . . . 145mmchdisk command . . . . . . . . . . . 179mmcheckquota command . . . . . . . . . 187mmchfileset command . . . . . . . . . . 191mmchfs command. . . . . . . . . . . . 198mmchlicense command . . . . . . . . . . 205mmchmgr command . . . . . . . . . . . 208mmchnode command . . . . . . . . . . 210mmchnodeclass command . . . . . . . . . 215mmchnsd command . . . . . . . . . . . 218mmchpolicy command . . . . . . . . . . 221mmchpool command . . . . . . . . . . . 224mmchqos command . . . . . . . . . . . 226mmclidecode command . . . . . . . . . . 234mmclone command . . . . . . . . . . . 236mmcloudgateway command . . . . . . . . 239mmcrcluster command . . . . . . . . . . 267mmcrfileset command . . . . . . . . . . 272mmcrfs command . . . . . . . . . . . . 279mmcrnodeclass command . . . . . . . . . 291mmcrnsd command . . . . . . . . . . . 293mmcrsnapshot command . . . . . . . . . 298mmdefedquota command . . . . . . . . . 303mmdefquotaoff command . . . . . . . . . 307

mmdefquotaon command . . . . . . . . . 310mmdefragfs command . . . . . . . . . . 313mmdelacl command . . . . . . . . . . . 316mmdelcallback command . . . . . . . . . 318mmdeldisk command . . . . . . . . . . 319mmdelfileset command . . . . . . . . . . 324mmdelfs command . . . . . . . . . . . 327mmdelnode command . . . . . . . . . . 329mmdelnodeclass command . . . . . . . . . 332mmdelnsd command . . . . . . . . . . . 334mmdelsnapshot command . . . . . . . . . 336mmdf command . . . . . . . . . . . . 340mmdiag command . . . . . . . . . . . 344mmdsh command . . . . . . . . . . . . 351mmeditacl command . . . . . . . . . . . 353mmedquota command . . . . . . . . . . 356mmexportfs command . . . . . . . . . . 360mmfsck command. . . . . . . . . . . . 362mmfsctl command. . . . . . . . . . . . 375mmgetacl command . . . . . . . . . . . 379mmgetstate command . . . . . . . . . . 382mmhadoopctl command. . . . . . . . . . 385mmhealth command . . . . . . . . . . . 387mmimgbackup command . . . . . . . . . 400mmimgrestore command . . . . . . . . . 404mmimportfs command . . . . . . . . . . 407mmkeyserv command . . . . . . . . . . 411mmlinkfileset command . . . . . . . . . . 425mmlsattr command . . . . . . . . . . . 427mmlscallback command . . . . . . . . . . 430mmlscluster command . . . . . . . . . . 432mmlsconfig command . . . . . . . . . . 435mmlsdisk command . . . . . . . . . . . 437mmlsfileset command . . . . . . . . . . 441mmlsfs command . . . . . . . . . . . . 446mmlslicense command . . . . . . . . . . 451mmlsmgr command . . . . . . . . . . . 453mmlsmount command . . . . . . . . . . 455mmlsnodeclass command . . . . . . . . . 457mmlsnsd command . . . . . . . . . . . 459mmlspolicy command . . . . . . . . . . 462mmlspool command . . . . . . . . . . . 464mmlsqos command . . . . . . . . . . . 466mmlsquota command . . . . . . . . . . 471mmlssnapshot command . . . . . . . . . 475mmmigratefs command . . . . . . . . . . 478mmmount command . . . . . . . . . . . 480mmmsgqueue command . . . . . . . . . 483mmnetverify command . . . . . . . . . . 487mmnfs command . . . . . . . . . . . . 498mmnsddiscover command . . . . . . . . . 508mmobj command . . . . . . . . . . . . 510mmperfmon command . . . . . . . . . . 527mmpmon command . . . . . . . . . . . 539mmprotocoltrace command. . . . . . . . . 545mmpsnap command . . . . . . . . . . . 549

© Copyright IBM Corp. 2014, 2019 iii

mmputacl command . . . . . . . . . . . 552mmquotaoff command . . . . . . . . . . 555mmquotaon command . . . . . . . . . . 557mmremotecluster command . . . . . . . . 559mmremotefs command . . . . . . . . . . 562mmrepquota command . . . . . . . . . . 565mmrestoreconfig command. . . . . . . . . 569mmrestorefs command . . . . . . . . . . 573mmrestripefile command . . . . . . . . . 577mmrestripefs command . . . . . . . . . . 580mmrpldisk command. . . . . . . . . . . 587mmsdrrestore command. . . . . . . . . . 594mmsetquota command . . . . . . . . . . 596mmshutdown command. . . . . . . . . . 600mmsmb command. . . . . . . . . . . . 602mmsnapdir command . . . . . . . . . . 614mmstartup command. . . . . . . . . . . 618mmtracectl command. . . . . . . . . . . 620mmumount command . . . . . . . . . . 624mmunlinkfileset command . . . . . . . . . 627mmuserauth command . . . . . . . . . . 630mmwatch command . . . . . . . . . . . 652mmwinservctl command . . . . . . . . . 654spectrumscale command. . . . . . . . . . 656

Chapter 2. IBM Spectrum Scale DataManagement API for GPFSinformation . . . . . . . . . . . . 681Overview of IBM Spectrum Scale DataManagement API for GPFS . . . . . . . . . 681

GPFS-specific DMAPI events . . . . . . . 681DMAPI functions . . . . . . . . . . . 682DMAPI configuration attributes . . . . . . 686DMAPI restrictions for GPFS . . . . . . . 687

Concepts of IBM Spectrum Scale Data ManagementAPI for GPFS . . . . . . . . . . . . . 688

Sessions . . . . . . . . . . . . . . 688Data management events . . . . . . . . 688Mount and unmount . . . . . . . . . . 690Tokens and access rights . . . . . . . . 691Parallelism in Data Management applications 692Data Management attributes . . . . . . . 693Support for NFS . . . . . . . . . . . 693Quota . . . . . . . . . . . . . . . 693Memory mapped files . . . . . . . . . 693

Administration of IBM Spectrum Scale DataManagement API for GPFS . . . . . . . . . 694

Required files for implementation of DataManagement applications . . . . . . . . 694GPFS configuration attributes for DMAPI . . . 695Enabling DMAPI for a file system . . . . . 696Initializing the Data Management application 697

Specifications of enhancements for IBM SpectrumScale Data Management API for GPFS . . . . . 697

Enhancements to data structures . . . . . . 698Usage restrictions on DMAPI functions. . . . 699Definitions for GPFS-specific DMAPI functions 701Semantic changes to DMAPI functions . . . . 714GPFS-specific DMAPI events . . . . . . . 715

Additional error codes returned by DMAPIfunctions . . . . . . . . . . . . . . 716

Failure and recovery of IBM Spectrum Scale DataManagement API for GPFS . . . . . . . . . 717

Single-node failure . . . . . . . . . . 718Session failure and recovery . . . . . . . 719Event recovery . . . . . . . . . . . . 719Loss of access rights . . . . . . . . . . 720DODeferred deletions . . . . . . . . . 720DM application failure . . . . . . . . . 720

Chapter 3. GPFS programminginterfaces . . . . . . . . . . . . . 723gpfs_acl_t structure . . . . . . . . . . . 726gpfs_clone_copy() subroutine . . . . . . . . 727gpfs_clone_snap() subroutine . . . . . . . . 729gpfs_clone_split() subroutine . . . . . . . . 731gpfs_clone_unsnap() subroutine . . . . . . . 733gpfs_close_inodescan() subroutine . . . . . . 735gpfs_cmp_fssnapid() subroutine . . . . . . . 736gpfs_declone() subroutine . . . . . . . . . 738gpfs_direntx_t structure . . . . . . . . . . 740gpfs_direntx64_t structure . . . . . . . . . 742gpfs_fcntl() subroutine . . . . . . . . . . 744gpfs_fgetattrs() subroutine . . . . . . . . . 747gpfs_fputattrs() subroutine . . . . . . . . . 749gpfs_fputattrswithpathname() subroutine . . . . 751gpfs_free_fssnaphandle() subroutine . . . . . . 753gpfs_fssnap_handle_t structure . . . . . . . 754gpfs_fssnap_id_t structure . . . . . . . . . 755gpfs_fstat() subroutine . . . . . . . . . . 756gpfs_fstat_x() subroutine . . . . . . . . . 758gpfs_get_fsname_from_fssnaphandle() subroutine 760gpfs_get_fssnaphandle_by_fssnapid() subroutine 761gpfs_get_fssnaphandle_by_name() subroutine . . 763gpfs_get_fssnaphandle_by_path() subroutine . . . 765gpfs_get_fssnapid_from_fssnaphandle() subroutine 767gpfs_get_pathname_from_fssnaphandle()subroutine . . . . . . . . . . . . . . 769gpfs_get_snapdirname() subroutine . . . . . . 771gpfs_get_snapname_from_fssnaphandle()subroutine . . . . . . . . . . . . . . 773gpfs_getacl() subroutine . . . . . . . . . . 775gpfs_iattr_t structure . . . . . . . . . . . 777gpfs_iattr64_t structure . . . . . . . . . . 780gpfs_iclose() subroutine . . . . . . . . . . 784gpfs_ifile_t structure . . . . . . . . . . . 786gpfs_igetattrs() subroutine . . . . . . . . . 787gpfs_igetattrsx() subroutine. . . . . . . . . 789gpfs_igetfilesetname() subroutine . . . . . . . 791gpfs_igetstoragepool() subroutine. . . . . . . 793gpfs_iopen() subroutine . . . . . . . . . . 795gpfs_iopen64() subroutine . . . . . . . . . 797gpfs_iputattrsx() subroutine . . . . . . . . 799gpfs_iread() subroutine . . . . . . . . . . 802gpfs_ireaddir() subroutine . . . . . . . . . 804gpfs_ireaddir64() subroutine . . . . . . . . 806gpfs_ireadlink() subroutine . . . . . . . . . 808gpfs_ireadlink64() subroutine . . . . . . . . 810gpfs_ireadx() subroutine . . . . . . . . . . 812gpfs_iscan_t structure . . . . . . . . . . 815

iv IBM Spectrum Scale 5.0.2: Command and Programming Reference

||

gpfs_lib_init() subroutine . . . . . . . . . 816gpfs_lib_term() subroutine . . . . . . . . . 817gpfs_next_inode() subroutine . . . . . . . . 818gpfs_next_inode64() subroutine . . . . . . . 820gpfs_next_inode_with_xattrs() subroutine . . . . 822gpfs_next_inode_with_xattrs64() subroutine . . . 824gpfs_next_xattr() subroutine . . . . . . . . 826gpfs_opaque_acl_t structure . . . . . . . . 828gpfs_open_inodescan() subroutine . . . . . . 829gpfs_open_inodescan64() subroutine. . . . . . 832gpfs_open_inodescan_with_xattrs() subroutine . . 835gpfs_open_inodescan_with_xattrs64() subroutine 838gpfs_prealloc() subroutine . . . . . . . . . 841gpfs_putacl() subroutine . . . . . . . . . . 844gpfs_quotactl() subroutine . . . . . . . . . 846gpfs_quotaInfo_t structure . . . . . . . . . 849gpfs_seek_inode() subroutine . . . . . . . . 851gpfs_seek_inode64() subroutine . . . . . . . 853gpfs_stat() subroutine . . . . . . . . . . 855gpfs_stat_inode() subroutine . . . . . . . . 857gpfs_stat_inode64() subroutine . . . . . . . 859gpfs_stat_inode_with_xattrs() subroutine . . . . 861gpfs_stat_inode_with_xattrs64() subroutine . . . 863gpfs_stat_x() subroutine . . . . . . . . . . 865gpfsFcntlHeader_t structure . . . . . . . . 867gpfsGetDataBlkDiskIdx_t structure . . . . . . 868gpfsGetFilesetName_t structure . . . . . . . 871gpfsGetReplication_t structure . . . . . . . . 872gpfsGetSetXAttr_t structure . . . . . . . . 874gpfsGetSnapshotName_t structure . . . . . . 876gpfsGetStoragePool_t structure . . . . . . . 877gpfsListXAttr_t structure . . . . . . . . . 878gpfsRestripeData_t structure . . . . . . . . 879gpfsRestripeRange_t structure . . . . . . . . 881gpfsRestripeRangeV2_t structure . . . . . . . 884gpfsSetReplication_t structure . . . . . . . . 887gpfsSetStoragePool_t structure. . . . . . . . 889

Chapter 4. GPFS user exits . . . . . 891mmsdrbackup user exit . . . . . . . . . . 892nsddevices user exit . . . . . . . . . . . 893syncfsconfig user exit. . . . . . . . . . . 894

Chapter 5. IBM Spectrum Scalemanagement API commands. . . . . 895Version 1 - deprecated . . . . . . . . . . 895

CES addresses: GET . . . . . . . . . . 896CES addresses/{cesAddress}: GET . . . . . 898CES services: GET . . . . . . . . . . . 900CES services/{service}: GET . . . . . . . 903Config: GET . . . . . . . . . . . . . 906Cluster: GET . . . . . . . . . . . . 907Filesets: GET . . . . . . . . . . . . 913Filesets/{filesetName}: GET . . . . . . . 919Filesets: POST . . . . . . . . . . . . 925Filesets/{filesetName}: PUT . . . . . . . 930Filesets/{filesetName}: DELETE . . . . . . 934Filesystems: GET . . . . . . . . . . . 936Filesystems/{filesystemName}: GET . . . . . 942Info: GET. . . . . . . . . . . . . . 948

Nodes: GET . . . . . . . . . . . . . 951Nodes/{name}: GET . . . . . . . . . . 955Quotas: GET . . . . . . . . . . . . 958Quotas: POST . . . . . . . . . . . . 962Snapshots: GET. . . . . . . . . . . . 965Snapshots/{snapshotName}: GET. . . . . . 968Snapshots: POST . . . . . . . . . . . 971Snapshots/{snapshotName}: DELETE . . . . 973

Version 2 . . . . . . . . . . . . . . . 974CES/addresses: GET . . . . . . . . . . 975CES/addresses/{cesAddress}: GET . . . . . 979CES/services: GET . . . . . . . . . . 982CES/services/{service}: GET . . . . . . . 985Cliauditlog: GET . . . . . . . . . . . 988Cluster: GET . . . . . . . . . . . . 992Config: GET . . . . . . . . . . . . . 996Filesystems: GET . . . . . . . . . . . 1001Filesystems/{filesystemName}: GET . . . . 1008Filesystems/{filesystemName}/acl/{path}: GET 1015Filesystems/{filesystemName}/acl/{path}: PUT 1018Filesystems/{filesystemName}/afm/state: GET 1023Filesystems/{filesystemName}/audit: PUT 1026Filesystems/{filesystemName}/disks: GET 1030Filesystems/{filesystemName}/disks/{diskName}: GET. . . . . . . . . . . 1034Filesystems/{filesystemName}/filesets: GET 1038Filesystems/{filesystemName}/filesets: POST 1045Filesystems/{filesystemName}/filesets/{filesetName}: DELETE . . . . . . . . . 1050Filesystems/{filesystemName}/filesets/{filesetName}: GET . . . . . . . . . . 1053Filesystems/{filesystemName}/filesets/{filesetName}: PUT . . . . . . . . . . 1059Filesystems/{filesystemName}/filesets/{filesetName}/afmctl: POST . . . . . . . 1065Filesystems/{filesystemName}/filesets/{filesetName}/link: DELETE . . . . . . . 1071Filesystems/{filesystemName}/filesets/{filesetName}/link: POST . . . . . . . . 1074Filesystems/{filesystemName}/filesets/{filesetName}/psnaps: POST . . . . . . . 1077Filesystems/{filesystemName}/filesets/{filesetName}/psnaps/{snapshotName}:DELETE. . . . . . . . . . . . . . 1081Filesystems/{filesystemName}/filesets/{filesetName}/quotas: GET . . . . . . . 1085Filesystems/{filesystemName}/filesets/{filesetName}/quotas: POST . . . . . . . 1089Filesystems/{filesystemName}/filesets/{filesetName}/snapshots: GET . . . . . . 1093Filesystems/{filesystemName}/filesets/{filesetName}/snapshots: POST . . . . . . 1096Filesystems/{filesystemName}/filesets/{filesetName}/snapshots/{snapshotName}:DELETE. . . . . . . . . . . . . . 1099Filesystems/{filesystemName}/filesets/{filesetName}/snapshots/{snapshotName}: GET 1102Filesystems/{filesystemName}/owner/{path}:GET . . . . . . . . . . . . . . . 1105Filesystems/{filesystemName}/owner/{path}:PUT . . . . . . . . . . . . . . . 1108

Contents v

Filesystems/{filesystemName}/policies: GET 1111Filesystems/{filesystemName}/policies: PUT 1114Filesystems/{filesystemName}/quotas: GET 1118Filesystems/{filesystemName}/quotas: POST 1122Filesystems/{filesystemName}/snapshots: GET 1126Filesystems/{filesystemName}/snapshots:POST. . . . . . . . . . . . . . . 1129Filesystems/{filesystemName}/snapshots/{snapshotName}: DELETE . . . . . . . . 1132Filesystems/{filesystemName}/snapshots/{snapshotName}: GET . . . . . . . . . 1135Info: GET . . . . . . . . . . . . . 1138Jobs: GET . . . . . . . . . . . . . 1141Jobs/{jobId}: DELETE . . . . . . . . . 1145Jobs/{jobID}: GET . . . . . . . . . . 1148NFS/exports: GET . . . . . . . . . . 1152NFS/exports: POST . . . . . . . . . . 1156NFS/exports/{exportPath}: GET. . . . . . 1159NFS/exports/{exportPath}: PUT. . . . . . 1163NFS/exports/{exportPath}: DELETE . . . . 1167Nodeclasses: GET . . . . . . . . . . 1170Nodeclasses: POST . . . . . . . . . . 1173Nodeclasses/{nodeclassName}: GET . . . . 1177Nodeclasses/{nodeclassName}: DELETE . . . 1180Nodeclasses/{nodeclassName}: PUT . . . . 1183Nodes: GET . . . . . . . . . . . . 1187Nodes: POST . . . . . . . . . . . . 1194Nodes/{name}: DELETE . . . . . . . . 1198Nodes/{name}: GET. . . . . . . . . . 1202Nodes/{name}/health/events: GET . . . . 1207Nodes/{name}/health/states: GET . . . . . 1211Nodes/{name}/services: GET . . . . . . 1215Nodes/{name}/services/{serviceName}: GET 1218Nodes/{name}/services/{serviceName}: PUT 1222NSDs: GET . . . . . . . . . . . . . 1226NSDs/{nsdName}: GET . . . . . . . . 1232Perfmon/data: GET . . . . . . . . . . 1235Perfmon/sensors/{sensorName}: GET . . . . 1240Perfmon/sensors: GET . . . . . . . . . 1242Perfmon/sensors/{sensorName}: PUT . . . . 1244SMB/shares: GET . . . . . . . . . . 1248

SMB/shares/{shareName}: GET . . . . . . 1253SMB/shares: POST . . . . . . . . . . 1258SMB/shares/{shareName}: PUT . . . . . . 1263SMB/shares/{shareName}: DELETE . . . . 1268SMB/shares/{shareName}/acl: DELETE . . . 1271SMB/shares/{shareName}/acl: GET . . . . 1274SMB/shares/{shareName}/acl: DELETE . . . 1277SMB/shares/{shareName}/acl/{name}: GET 1280SMB/shares/{shareName}/acl/{name}: PUT 1283Thresholds: GET . . . . . . . . . . . 1287Thresholds: POST . . . . . . . . . . 1291Thresholds/{name}: DELETE . . . . . . . 1296Thresholds/{name}: GET . . . . . . . . 1299

Chapter 6. Watch folder API. . . . . 1303gpfs_init_watch subroutine . . . . . . . . 1304gpfs_add_watch subroutine . . . . . . . . 1305gpfs_add_fset_watch subroutine. . . . . . . 1307gpfs_add_inodespace_watch subroutine . . . . 1309gpfs_rm_watch subroutine . . . . . . . . 1311gpfs_read_watch subroutine . . . . . . . . 1312gpfs_close_watch subroutine . . . . . . . . 1314gpfs_watch_strerror subroutine . . . . . . . 1315

Accessibility features for IBMSpectrum Scale . . . . . . . . . . 1317Accessibility features . . . . . . . . . . 1317Keyboard navigation . . . . . . . . . . 1317IBM and accessibility . . . . . . . . . . 1317

Notices . . . . . . . . . . . . . 1319Trademarks . . . . . . . . . . . . . 1320Terms and conditions for product documentation 1321IBM Online Privacy Statement . . . . . . . 1321

Glossary . . . . . . . . . . . . . 1323

Index . . . . . . . . . . . . . . 1329

vi IBM Spectrum Scale 5.0.2: Command and Programming Reference

||||||||||||||||||

Tables

1. IBM Spectrum Scale library information units x2. Conventions . . . . . . . . . . . . xxi3. List of changes in documentation . . . . . xxx4. GPFS commands . . . . . . . . . . . 15. Global events and supported parameters 166. Local events and supported parameters 177. Query details by type . . . . . . . . . 358. Key-value. . . . . . . . . . . . . 1069. key-value . . . . . . . . . . . . . 107

10. Values assigned to autoBuildGPL and theireffects . . . . . . . . . . . . . . 152

11. Settings for debugDataControl . . . . . . 15512. Allocation of IOPS . . . . . . . . . . 22813. GPFS commands that support QoS . . . . 22914. Block sizes and subblock sizes . . . . . . 28415. Contents of columns input1 and input2

depending on the value in column Buf type . 34516. mmkeyserv server show . . . . . . . . 41617. mmkeyserv tenant show . . . . . . . . 41718. Information and error messages . . . . . 48719. Shortcut terms for network checks . . . . 49220. Network checks. . . . . . . . . . . 49221. Restoring a global snapshot . . . . . . . 57422. Restoring a fileset snapshot . . . . . . . 57423. Tracing status information . . . . . . . 62124. DMAPI configuration attributes . . . . . 68725. Specific DMAPI functions and associated

error codes. . . . . . . . . . . . . 71726. GPFS programming interfaces . . . . . . 72327. GPFS user exits . . . . . . . . . . . 89128. List of parameters . . . . . . . . . . 97529. List of parameters . . . . . . . . . . 97930. List of parameters . . . . . . . . . . 98531. List of parameters . . . . . . . . . . 98832. List of parameters . . . . . . . . . . 99633. List of parameters . . . . . . . . . 100134. List of parameters . . . . . . . . . 100835. List of parameters . . . . . . . . . 101536. List of parameters . . . . . . . . . 101837. List of request parameters . . . . . . . 102338. List of request parameters . . . . . . . 102639. List of parameters . . . . . . . . . 103040. List of parameters . . . . . . . . . 103441. List of parameters . . . . . . . . . 103842. List of request parameters . . . . . . . 104543. List of request parameters . . . . . . . 105044. List of parameters . . . . . . . . . 105345. List of request parameters . . . . . . . 105946. List of request parameters . . . . . . . 106547. List of request parameters . . . . . . . 107148. List of request parameters . . . . . . . 107449. List of request parameters . . . . . . . 1077

50. List of request parameters . . . . . . . 108151. List of request parameters . . . . . . . 108552. List of request parameters . . . . . . . 109353. List of request parameters . . . . . . . 109654. List of request parameters . . . . . . . 109955. List of request parameters . . . . . . . 110256. List of request parameters . . . . . . . 110557. List of request parameters . . . . . . . 110858. List of parameters . . . . . . . . . . 111159. List of request parameters . . . . . . . 111460. List of request parameters . . . . . . . 111861. List of request parameters . . . . . . . 112262. List of request parameters . . . . . . . 112663. List of request parameters . . . . . . . 112964. List of request parameters . . . . . . . 113265. List of request parameters . . . . . . . 113566. List of request parameters . . . . . . . 114167. List of request parameters . . . . . . . 114568. List of request parameters . . . . . . . 114869. List of request parameters . . . . . . . 115270. List of request parameters . . . . . . . 115671. List of request parameters . . . . . . . 115972. List of request parameters . . . . . . . 116373. List of request parameters . . . . . . . 116774. List of request parameters . . . . . . . 117075. List of request parameters . . . . . . . 117376. List of request parameters . . . . . . . 117777. List of request parameters . . . . . . . 118078. List of request parameters . . . . . . . 118379. List of request parameters . . . . . . . 119480. List of request parameters . . . . . . . 119881. List of request parameters . . . . . . . 120282. List of request parameters . . . . . . . 120783. List of request parameters . . . . . . . 121184. List of parameters . . . . . . . . . 121585. List of parameters . . . . . . . . . 121886. List of parameters . . . . . . . . . 122287. List of request parameters . . . . . . . 122688. List of request parameters . . . . . . . 123289. List of request parameters . . . . . . . 123590. List of request parameters . . . . . . . 124091. List of request parameters . . . . . . . 124292. List of parameters . . . . . . . . . 124493. List of request parameters . . . . . . . 124894. List of request parameters . . . . . . . 125395. List of request parameters . . . . . . . 127496. List of request parameters . . . . . . . 128097. List of request parameters . . . . . . . 128798. List of request parameters . . . . . . . 129199. List of request parameters . . . . . . . 1296

100. List of request parameters . . . . . . . 1299

© Copyright IBM Corp. 2014, 2019 vii

||

viii IBM Spectrum Scale 5.0.2: Command and Programming Reference

About this information

This edition applies to IBM Spectrum Scale™ version 5.0.2 for AIX®, Linux, and Windows.

IBM Spectrum Scale is a file management infrastructure, based on IBM® General Parallel File System(GPFS™) technology, which provides unmatched performance and reliability with scalable access tocritical file data.

To find out which version of IBM Spectrum Scale is running on a particular AIX node, enter:lslpp -l gpfs\*

To find out which version of IBM Spectrum Scale is running on a particular Linux node, enter:rpm -qa | grep gpfs (for SLES and Red Hat Enterprise Linux)

dpkg -l | grep gpfs (for Ubuntu Linux)

To find out which version of IBM Spectrum Scale is running on a particular Windows node, openPrograms and Features in the control panel. The IBM Spectrum Scale installed program name includesthe version number.

Which IBM Spectrum Scale information unit provides the information you need?

The IBM Spectrum Scale library consists of the information units listed in Table 1 on page x.

To use these information units effectively, you must be familiar with IBM Spectrum Scale and the AIX,Linux, or Windows operating system, or all of them, depending on which operating systems are in use atyour installation. Where necessary, these information units provide some background information relatingto AIX, Linux, or Windows. However, more commonly they refer to the appropriate operating systemdocumentation.

Note: Throughout this documentation, the term “Linux” refers to all supported distributions of Linux,unless otherwise specified.

© Copyright IBM Corp. 2014, 2019 ix

Table 1. IBM Spectrum Scale library information units

Information unit Type of information Intended users

IBM Spectrum Scale: Concepts,Planning, and Installation Guide

This guide provides the followinginformation:

Product overview

v Overview of IBM Spectrum Scalev GPFS architecturev Protocols support overview:

Integration of protocol accessmethods with GPFS

v Active File Managementv AFM-based Asynchronous Disaster

Recovery (AFM DR)

v Data protection and disaster recoveryin IBM Spectrum Scale

v Introduction to IBM Spectrum ScaleGUI

v IBM Spectrum Scale management APIv Introduction to Cloud servicesv Introduction to file audit loggingv Introduction to watch folderv IBM Spectrum Scale in an OpenStack

cloud deployment

v IBM Spectrum Scale product editionsv IBM Spectrum Scale license

designation

v Capacity based licensingv IBM Spectrum Storage™ Suite

Planning

v Planning for GPFSv Planning for protocolsv Planning for Cloud servicesv Planning for AFMv Planning for AFM DRv Firewall recommendationsv Considerations for GPFS applications

System administrators, analysts,installers, planners, and programmers ofIBM Spectrum Scale clusters who arevery experienced with the operatingsystems on which each IBM SpectrumScale cluster is based

x IBM Spectrum Scale 5.0.2: Command and Programming Reference

|

|

|

Table 1. IBM Spectrum Scale library information units (continued)



Installing

v Steps for establishing and startingyour IBM Spectrum Scale cluster

v Installing IBM Spectrum Scale onLinux nodes and deploying protocols

v Installing IBM Spectrum Scale on AIXnodes

v Installing IBM Spectrum Scale onWindows nodes

v Installing Cloud services on IBMSpectrum Scale nodes

v Installing and configuring IBMSpectrum Scale management API

v Installing Active File Managementv Installing and upgrading AFM-based

Disaster Recovery

v Installing call homev Installing file audit loggingv Installing watch folderv Steps to permanently uninstall GPFS

and/or Protocols


About this information xi

|




Upgrading

v IBM Spectrum Scale supportedupgrade paths

v Upgrading to IBM Spectrum Scale5.0.x from IBM Spectrum Scale 4.2.y

v Upgrading to IBM Spectrum Scale4.2.y from IBM Spectrum Scale 4.1.x

v Upgrading to IBM Spectrum Scale4.1.1.x from GPFS V4.1.0.x

v Upgrading from GPFS 3.5v Online upgrade support for protocols

and performance monitoring

v Upgrading AFM and AFM DRv Upgrading object packagesv Upgrading SMB packagesv Upgrading NFS packagesv Upgrading call homev Manually upgrading the performance

monitoring tool

v Manually upgrading pmswiftv Manually upgrading the IBM

Spectrum Scale management GUI

v Upgrading Cloud servicesv Upgrading to IBM Cloud Object

Storage software level 3.7.2 and above

v Upgrading file audit loggingauthentication

v Upgrading watch folder callbacksv Upgrading IBM Spectrum Scale

components with the installationtoolkit

v Changing the IBM Spectrum Scaleproduct edition

v Completing the upgrade to a newlevel of IBM Spectrum Scale

v Reverting to the previous level ofIBM Spectrum Scale

v Coexistence considerationsv Compatibility considerationsv Considerations for IBM Spectrum

Protect™ for Space Management

v GUI user role considerationsv Applying maintenance to your GPFS

system

v Guidance for upgrading the operatingsystem on IBM Spectrum Scale nodes


xii IBM Spectrum Scale 5.0.2: Command and Programming Reference

|

||

||



IBM Spectrum Scale:Administration Guide


Configuring

v Configuring the GPFS clusterv Configuring the CES and protocol

configuration

v Configuring and tuning your systemfor GPFS

v Parameters for performance tuningand optimization

v Ensuring high availability of the GUIservice

v Configuring and tuning your systemfor Cloud services

v Configuring file audit loggingv Configuring Active File Managementv Configuring AFM-based DRv Tuning for Kernel NFS backend on

AFM and AFM DR

Administering

v Performing GPFS administration tasksv Verifying network operation with the

mmnetverify command

v Managing file systemsv File system format changes between

versions of IBM Spectrum Scale

v Managing disksv Managing protocol servicesv Managing protocol user

authentication

v Managing protocol data exportsv Managing object storagev Managing GPFS quotasv Managing GUI usersv Managing GPFS access control listsv Considerations for GPFS applicationsv Accessing a remote GPFS file system

System administrators or programmersof IBM Spectrum Scale systems

About this information xiii



IBM Spectrum Scale:Administration Guide

v Information lifecycle management forIBM Spectrum Scale

v Creating and maintaining snapshotsof file systems

v Creating and managing file clonesv Scale Out Backup and Restore

(SOBAR)

v Data Mirroring and Replicationv Implementing a clustered NFS

environment on Linux

v Implementing Cluster Export Servicesv Identity management on Windowsv Protocols cluster disaster recoveryv File Placement Optimizerv Encryptionv Managing certificates to secure

communications between GUI webserver and web browsers

v Securing protocol datav Cloud services: Transparent cloud

tiering and Cloud data sharing

v Managing file audit loggingv Performing a watch with watch folderv Administering AFMv Administering AFM DRv Highly-available write cache (HAWC)v Local read-only cachev Miscellaneous advanced

administration

v GUI limitations

System administrators or programmersof IBM Spectrum Scale systems

xiv IBM Spectrum Scale 5.0.2: Command and Programming Reference

|

|

|



IBM Spectrum Scale: ProblemDetermination Guide


Monitoring

v Performance monitoringv Monitoring system health through the

IBM Spectrum Scale GUI

v Monitoring system health by usingthe mmhealth command

v Monitoring events through callbacksv Monitoring capacity through GUIv Monitoring AFM and AFM DRv GPFS SNMP supportv Monitoring the IBM Spectrum Scale

system by using call home

v Monitoring remote cluster throughGUI

v Monitoring file audit logging

Troubleshooting

v Best practices for troubleshootingv Understanding the system limitationsv Collecting details of the issuesv Managing deadlocksv Installation and configuration issuesv Upgrade issuesv Network issuesv File system issuesv Disk issuesv Security issuesv Protocol issuesv Disaster recovery issuesv Performance issuesv GUI issuesv AFM issuesv AFM DR issuesv Transparent cloud tiering issuesv File audit logging issuesv Troubleshooting watch folderv Maintenance proceduresv Recovery proceduresv Support for troubleshootingv References

System administrators of GPFS systemswho are experienced with thesubsystems used to manage disks andwho are familiar with the conceptspresented in the IBM Spectrum Scale:Concepts, Planning, and Installation Guide

About this information xv

|



IBM Spectrum Scale: Commandand Programming Reference


Command reference

v gpfs.snap commandv mmaddcallback commandv mmadddisk commandv mmaddnode commandv mmadquery commandv mmafmconfig commandv mmafmctl commandv mmafmlocal commandv mmapplypolicy commandv mmaudit commandv mmauth commandv mmbackup commandv mmbackupconfig commandv mmblock commandv mmbuildgpl commandv mmcachectl commandv mmcallhome commandv mmces commandv mmcesdr commandv mmchattr commandv mmchcluster commandv mmchconfig commandv mmchdisk commandv mmcheckquota commandv mmchfileset commandv mmchfs commandv mmchlicense commandv mmchmgr commandv mmchnode commandv mmchnodeclass commandv mmchnsd commandv mmchpolicy commandv mmchpool commandv mmchqos commandv mmclidecode commandv mmclone commandv mmcloudgateway commandv mmcrcluster commandv mmcrfileset commandv mmcrfs commandv mmcrnodeclass commandv mmcrnsd commandv mmcrsnapshot command

v System administrators of IBMSpectrum Scale systems

v Application programmers who areexperienced with IBM Spectrum Scalesystems and familiar with theterminology and concepts in theXDSM standard

xvi IBM Spectrum Scale 5.0.2: Command and Programming Reference




v mmdefedquota commandv mmdefquotaoff commandv mmdefquotaon commandv mmdefragfs commandv mmdelacl commandv mmdelcallback commandv mmdeldisk commandv mmdelfileset commandv mmdelfs commandv mmdelnode commandv mmdelnodeclass commandv mmdelnsd commandv mmdelsnapshot commandv mmdf commandv mmdiag commandv mmdsh commandv mmeditacl commandv mmedquota commandv mmexportfs commandv mmfsck commandv mmfsctl commandv mmgetacl commandv mmgetstate commandv mmhadoopctl commandv mmhealth commandv mmimgbackup commandv mmimgrestore commandv mmimportfs commandv mmkeyserv commandv mmlinkfileset commandv mmlsattr commandv mmlscallback commandv mmlscluster commandv mmlsconfig commandv mmlsdisk commandv mmlsfileset commandv mmlsfs commandv mmlslicense commandv mmlsmgr command



About this information xvii




v mmlsmount commandv mmlsnodeclass commandv mmlsnsd commandv mmlspolicy commandv mmlspool commandv mmlsqos commandv mmlsquota commandv mmlssnapshot commandv mmmigratefs commandv mmmount commandv mmmsgqueue commandv mmnetverify commandv mmnfs commandv mmnsddiscover commandv mmobj commandv mmperfmon commandv mmpmon commandv mmprotocoltrace commandv mmpsnap commandv mmputacl commandv mmquotaoff commandv mmquotaon commandv mmremotecluster commandv mmremotefs commandv mmrepquota commandv mmrestoreconfig commandv mmrestorefs commandv mmrestripefile commandv mmrestripefs commandv mmrpldisk commandv mmsdrrestore commandv mmsetquota commandv mmshutdown commandv mmsmb commandv mmsnapdir commandv mmstartup commandv mmtracectl commandv mmumount commandv mmunlinkfileset commandv mmuserauth commandv mmwatch commandv mmwinservctl commandv spectrumscale command



xviii IBM Spectrum Scale 5.0.2: Command and Programming Reference

|




Programming reference

v IBM Spectrum Scale DataManagement API for GPFSinformation

v GPFS programming interfacesv GPFS user exitsv IBM Spectrum Scale management API

commands

v Watch folder API



IBM Spectrum Scale: Big Data andAnalytics Guide


Hadoop Scale Storage Architecture

v Elastic Storage Server (ESS)v Share Storage (SAN-based storage)v File Placement Optimizer (FPO)v Deployment modelv Additional supported features about

storage

IBM Spectrum Scale support forHadoop

v HDFS transparencyv Supported IBM Spectrum Scale

storage modes

v Hadoop cluster planningv Installation and configuration of

HDFS transparency

v Application interaction with HDFStransparency

v Upgrading the HDFS Transparencycluster

v Rolling upgrade for HDFSTransparency

v Securityv Advanced featuresv Hadoop distribution supportv Limitations and differences from

native HDFS

v Problem determination

IBM Spectrum Scale Hadoopperformance tuning guide

v Overviewv Performance overviewv Hadoop Performance Planning over

IBM Spectrum Scale

v Performance guide



About this information xix

|



IBM Spectrum Scale: Big Data andAnalytics Guide

Hortonworks Data Platform 3.X

v Planningv Installationv Upgrading and uninstallationv Configurationv Administrationv Limitationsv Problem determination

Open Source Apache Hadoop

v Apache Hadoop 3.0.x Support

BigInsights 4.2.5 and Hortonworks DataPlatform 2.6

v Planningv Installationv Upgrading software stackv Configurationv Administrationv Troubleshootingv Limitationsv FAQ



IBM Spectrum Scale on AWSGuide

IBM Spectrum Scale on AWS

v Introduction to IBM Spectrum Scaleon AWS

v Setting up the IBM Spectrum Scaleenvironment in the AWS Cloud

v Deploying IBM Spectrum Scale onAWS

v Cleaning up the cluster and the stackv Data security and AWS Identity and

Access Management

v Cluster lifecycle management anddebug data collection

v Upgrading IBM Spectrum Scalev Troubleshootingv Frequently Asked Questions



Prerequisite and related informationFor updates to this information, see IBM Spectrum Scale in IBM Knowledge Center (www.ibm.com/support/knowledgecenter/STXKQY/ibmspectrumscale_welcome.html).

For the latest support information, see the IBM Spectrum Scale FAQ in IBM Knowledge Center(www.ibm.com/support/knowledgecenter/STXKQY/gpfsclustersfaq.html).

xx IBM Spectrum Scale 5.0.2: Command and Programming Reference

http://www.ibm.com/support/knowledgecenter/STXKQY/ibmspectrumscale_welcome.htmlhttp://www.ibm.com/support/knowledgecenter/STXKQY/ibmspectrumscale_welcome.htmlhttp://www.ibm.com/support/knowledgecenter/STXKQY/gpfsclustersfaq.htmlhttp://www.ibm.com/support/knowledgecenter/STXKQY/gpfsclustersfaq.html

Conventions used in this informationTable 2 describes the typographic conventions used in this information. UNIX file name conventions areused throughout this information.

Note: Users of IBM Spectrum Scale for Windows must be aware that on Windows, UNIX-style filenames need to be converted appropriately. For example, the GPFS cluster configuration data is stored inthe /var/mmfs/gen/mmsdrfs file. On Windows, the UNIX namespace starts under the %SystemDrive%\cygwin64 directory, so the GPFS cluster configuration data is stored in the C:\cygwin64\var\mmfs\gen\mmsdrfs file.

Table 2. Conventions

Convention Usage

bold Bold words or characters represent system elements that you must use literally, such ascommands, flags, values, and selected menu options.

Depending on the context, bold typeface sometimes represents path names, directories, or filenames.

bold underlined bold underlined keywords are defaults. These take effect if you do not specify a differentkeyword.

constant width Examples and information that the system displays appear in constant-width typeface.

Depending on the context, constant-width typeface sometimes represents path names,directories, or file names.

italic Italic words or characters represent variable values that you must supply.

Italics are also used for information unit titles, for the first use of a glossary term, and forgeneral emphasis in text.

Angle brackets (less-than and greater-than) enclose the name of a key on the keyboard. Forexample, refers to the key on your terminal or workstation that is labeled with theword Enter.

\ In command examples, a backslash indicates that the command or coding example continueson the next line. For example:

mkcondition -r IBM.FileSystem -e "PercentTotUsed > 90" \-E "PercentTotUsed < 85" -m p "FileSystem space used"

{item} Braces enclose a list from which you must choose an item in format and syntax descriptions.

[item] Brackets enclose optional items in format and syntax descriptions.

The notation indicates a control character sequence. For example, meansthat you hold down the control key while pressing .

item... Ellipses indicate that you can repeat the preceding item one or more times.

| In synopsis statements, vertical lines separate a list of choices. In other words, a vertical linemeans Or.

In the left margin of the document, vertical lines indicate technical changes to theinformation.

Note: CLI options that accept a list of option values delimit with a comma and no space between values.As an example, to display the state on three nodes use mmgetstate -N NodeA,NodeB,NodeC. Exceptions tothis syntax are listed specifically within the command.

About this information xxi

How to send your commentsYour feedback is important in helping us to produce accurate, high-quality information. If you have anycomments about this information or any other IBM Spectrum Scale documentation, send your commentsto the following e-mail address:

[email protected]

Include the publication title and order number, and, if applicable, the specific location of the informationabout which you have comments (for example, a page number or a table number).

To contact the IBM Spectrum Scale development organization, send your comments to the followinge-mail address:

[email protected]

xxii IBM Spectrum Scale 5.0.2: Command and Programming Reference

Summary of changes

This topic summarizes changes to the IBM Spectrum Scale licensed program and the IBM Spectrum Scalelibrary. Within each information unit in the library, a vertical line (|) to the left of text and illustrationsindicates technical changes or additions that are made to the previous edition of the information.

Summary of changesfor IBM Spectrum Scale version 5.0.2as updated, February 2019

This release of the IBM Spectrum Scale licensed program and the IBM Spectrum Scale library includes thefollowing improvements. All improvements are available after an upgrade, unless otherwise specified.

AFM and AFM DR-related changes

v Enabled user-defined gateway node assignment to AFM and AFM DR filesets by modifyingafmHashVersion value to 5 and adding the gateway node as afmGateway. For more information,see the topics mmchfileset command and mmcrfileset command in the IBM Spectrum Scale: Commandand Programming Reference.

v Added new options to mmafmctl prefetch. For more information, see the topic mmafmctlcommand in the IBM Spectrum Scale: Command and Programming Reference.

v Read-Only NFS export is supported for AFM RO mode filesets. For more information, see thetopic Introduction to Active File Management (AFM) in the IBM Spectrum Scale: Concepts, Planning,and Installation Guide.

Authentication-related changesThe --password, --ks-admin-pwd, and --ks-swift-pwd parameters are removed from mmuserauthCLI command. For more information, see the topic mmuserauth command in the IBM SpectrumScale: Command and Programming Reference.

IBM Spectrum Scale on AWSIBM Spectrum Scale can now be deployed on AWS. For more information, see IBM SpectrumScale on AWS.

Big data and analytics changesFor information on changes in IBM Spectrum Scale Big Data and Analytics support, see Big Dataand Analytics - summary of changes.

Cloud services changesCloud services has the following updates:v Support for RHEL 7.4 and 7.5 on both Power® and x86 machines.v Support for Openstack Swift 2.13, IBM Cloud Object Storage 3.13.4.40, and Swift3 2.13

Data Access EditionIBM Spectrum Scale Data Access Edition is a new edition based on capacity-based licensing thatprovides identical functionality as IBM Spectrum Scale Standard Edition. For more information,see IBM Spectrum Scale product editions in IBM Spectrum Scale: Concepts, Planning, and InstallationGuide.

File audit logging updatesFile audit logging has the following updates:v Listing or viewing the contents of directories within file audit logging enabled file systems will

produce OPEN and CLOSE events in the audit logs. For more information, see JSON reportingissues in file audit logging in the IBM Spectrum Scale: Problem Determination Guide.

v Added option to enable and disable file audit logging from the IBM Spectrum Scalemanagement GUI. You can enable file audit logging at the file system level while creating or

© Copyright IBM Corp. 2014, 2019 xxiii

|||

||

|

||||

||

|||

||||

|||

|||

||

|

|

|||||

||

|||

||

https://www.ibm.com/support/knowledgecenter/STXKQY_AWS_SHR/com.ibm.spectrum.scale.aws.v5r01.doc/bl1cld_aws_kclanding.htmhttps://www.ibm.com/support/knowledgecenter/STXKQY_AWS_SHR/com.ibm.spectrum.scale.aws.v5r01.doc/bl1cld_aws_kclanding.htmhttps://www.ibm.com/support/knowledgecenter/STXKQY_BDA_SHR/bl1bda_soc.htmhttps://www.ibm.com/support/knowledgecenter/STXKQY_BDA_SHR/bl1bda_soc.htm

modifying a file system from the Files > File Systems page. For more information, see Enablingand disabling file audit logging using the GUI in the IBM Spectrum Scale: Administration Guide.

v Support for Linux on Z (RHEL 7.x, Ubuntu 16.04 and Ubuntu 18.04 on s390x).v Multi-cluster/remote mount is supported. For more information, see Remotely mounted file

systems in file audit logging in the IBM Spectrum Scale: Concepts, Planning, and Installation Guide.v Improved monitoring of Kafka producers.v Subset of events is supported.v Ability to add broker nodes to the message queue dynamically. For more information, see

Designating additional broker nodes for increased performance in the IBM Spectrum Scale:Administration Guide.

v Call home is supported.

File system core improvements

Certificate expiration warnings are logged for key clients and RKM serversThe GPFS daemon writes warning messages into the error log as digital certificates forkey clients and Remote Key Management (RKM) servers approach their expiration dates.The frequency of warnings increases as the expiration date nears. Only certificates thatare regularly being used for authentication between a key client and an RKM server aretracked. For more information, see the topic Certificate expiration warnings in the IBMSpectrum Scale: Administration Guide.

Combined gpfs.base and gpfs.ext into a single package on LinuxOn Linux, the gpfs.base and gpfs.ext packages are combined into a single package. As aresult, the gpfs.ext package is no longer available on Linux.

File system maintenance mode provides a safe access window for file system maintenanceFile system maintenance mode provides a way to enable a file system maintenancewindow. Use file system maintenance mode whenever you perform maintenance oneither NSD disks or NSD servers that might result in NSDs becoming unavailable.

You must use the --maintenance-mode parameter with the mmchfs and mmlsfs commandsto use file system maintenance mode. For more information, see the topic File systemmaintenance mode in the IBM Spectrum Scale: Administration Guide.

The GPFS portability layer (GPL) can be rebuilt automaticallyFor more information, see the entry Installation improvements later in this topic.

The maxActiveIallocSegs attribute improves the performance of deletes and unlinksThe maxActiveIallocSegs attribute of the mmchconfig command can significantly improveperformance in the following scenario:1. A single node has created a large number of files in multiple directories.2. Processes and threads on multiple nodes are now concurrently attempting to delete or

unlink files in those directories

For more information, see the topic mmchconfig command in the IBM Spectrum Scale:Command and Programming Reference.

The mmnetverify command checks the connectivity of remote clustersThe mmnetverify command checks remote clusters for host-name resolution, networkconnectivity by ping, and GPFS daemon connectivity. It checks known remote clustersfrom the mmsdrfs file and can also check remote clusters that are specified on thecommand line. For more information, see the topic mmnetverify command in the IBMSpectrum Scale: Command and Programming Reference.

The stat cache is effective on Linux in all configurationsThe stat cache is effective on the Linux operating system in all supported hardwareconfigurations, not just when a Local Read-Only Cache (LROC) device is attached. A statcache improves the performance of system calls that return file attributes, such as stat().

xxiv IBM Spectrum Scale 5.0.2: Command and Programming Reference

||

|

||

|

|

|||

|

|

|||||||

|||

||||

|||

||

|||

|

||

||

||||||

||||

The default values of maxStatCache and the factors for estimating a nondefault value formaxStatCache are now the same for Linux as they are for other supported operatingsystems. For more information, see the topic mmchconfig command in the IBM SpectrumScale: Command and Programming Reference.

Two features cope with long I/O waits on directly attached disksThis feature applies only to disks that a node is directly attached to.v The diskIOHang callback event allows you to add notification and data collection

scripts to analyze the cause of a local I/O request that has been pending in the nodekernel for more than 5 minutes. For more information, see the topic mmaddcallbackcommand in the IBM Spectrum Scale: Command and Programming Reference.

v The panicOnIOHang attribute controls whether the GPFS daemon panics the nodekernel when a local I/O request has been pending in the kernel for more than fiveminutes. For more information, see the topic mmchconfig command in the IBM SpectrumScale: Command and Programming Reference.

IBM Spectrum Scale management API changesAdded the following API commands:v PUT /filesystems/{filesystemName}/auditv GET: /smb/shares/{shareName}/aclv GET: /smb/shares/{shareName}/acl/{name}v DELETE: /smb/shares/{shareName}/aclv DELETE: /smb/shares/{shareName}/acl/{name}v PUT: /smb/shares/{shareName}/acl/{name}

For more information on the API commands, see IBM Spectrum Scale management API commands inIBM Spectrum Scale: Command and Programming Reference. You can also access the documentationcorresponding to each API command from the GUI itself. The API documentation is available inthe GUI at: https://:/ibm/api/explorer/. For example:https://scalegui.ibm.com:443/ibm/api/explorer.

IBM Spectrum Scale GUI changes

The following changes are made to the GUI:v Added options to create and manage node classes. The two types of node classes that can be

defined in the IBM Spectrum Scale system are system node classes and user-defined nodeclasses. You can create user-defined node classes by using the Nodes > Node Classes > CreateNode Class option. The system node classes are pre-defined and you cannot create or modifythem using the management GUI.

v Added option to enable and disable file audit logging. File audit logging captures fileoperations on a file system and logs them to a retention enabled fileset. You can enable fileaudit logging at the file system level while creating or modifying a file system from the Files >File Systems page.

v Added option to configure automatic assignment of certain sensors to a single node, in theServices > Performance Monitoring > Sensors page. A single node is automatically selected bythe system to run the GPFSFilesetQuota, GPFSFileset, GPFSPool, and GPFSDiskCap sensors.

v Improved remote cluster monitoring options capabilities.v Introduced an integrated view of GUI services and GUI user management in the Services >

GUI page.Removed the GUI Users and GUI Access pages from the Access menu and integrated the GUIuser management features in the Services > GUI page.

v The GUI automatically logs out the users if the administrator changes the user role or expirethe password of the currently logged in user.

Summary of changes xxv

||||

||

||||

||||

||

|

|

|

|

|

|

|||||

|

|

|||||

||||

|||

|

||

||

||

v Improved filtering and listing of events. Added graphical view of events reported against eachcomponent in the Monitoring > Events page. Clicking on the graph displays only the relevantevents in the grid view. Removed the Unread Events filter option and introduced Current Stateand Notices filter options.

v Improved health status monitoring of CES IPs. Renamed Services > CES Network to Services> CES Network and CES IPs. The Addresses section shows the health status of the CES IPcomponent. It also shows the preferred nodes and non-hostable nodes if Node Affinity isselected as the IP address distribution method.

v Introduced a What's new window to highlight the changes made to the IBM Spectrum ScaleGUI in a release. When the user launches the GUI for the first time after installing orupgrading to the latest version, the GUI users can see the list of GUI changes made in thatrelease. The user can also launch the What's New window by using the What's New? optionthat is available in the Help menu of the management GUI. The Help menu is available at theupper right corner of the GUI.

Installation improvements

The GPFS portability layer (GPL) can be rebuilt automatically.You can now configure a cluster to automatically rebuild the GPL whenever a new levelof the Linux kernel is installed or whenever a new level of IBM Spectrum Scale isinstalled. For more information, see the description of the autoBuildGPL attribute in thetopic mmchconfig command in the IBM Spectrum Scale: Command and Programming Reference.

Installation toolkit changes

v Support for IBM Z (RHEL 7.x, SLES12.x, Ubuntu 16.04 and Ubuntu 18.04 on s390x)v Support for Red Hat Enterprise Linux 7.6 on x86_64, PPC64, PPC64LE, and s390x.v Support for offline upgrade of nodes while they are down or unhealthy. For more information,

see Performing offline upgrade or excluding nodes from upgrade using installation toolkit in IBMSpectrum Scale: Concepts, Planning, and Installation Guide.

v Support for excluding nodes from an upgrade run. For more information, see Performing offlineupgrade or excluding nodes from upgrade using installation toolkit in IBM Spectrum Scale: Concepts,Planning, and Installation Guide.

v Support for rerunning an upgrade procedure after a failure. For more information, see Upgradererun after an upgrade failure in IBM Spectrum Scale: Concepts, Planning, and Installation Guide.

v Support for watch folder. For more information, see Enabling and configuring watch folder usinginstallation toolkit in IBM Spectrum Scale: Concepts, Planning, and Installation Guide.

v Enhancements in CES shared root creation and detection in config populatev Upgraded bundled Chef package. For more information, see Preparing to use installation toolkit

in IBM Spectrum Scale: Concepts, Planning, and Installation Guide.

mmces command enhancements

New --extended-list and --full-list options that show additional data for node affinity. Formore information, see the mmces command section in the IBM Spectrum Scale: Command andProgramming Reference.

mmperfmon command enhancements

The query --list=expiredKeys option that displays the group keys for the entities that have notreturned any metrics values within the default retention period of 14 days. The delete {--expiredKeys | --key Key[,Key...] } allows users to review and delete historical perfmon keysfor renamed and deleted components in the cluster. For more information, see the mmperfmoncommand section in the IBM Spectrum Scale: Command and Programming Reference.

mmcallhome command enhancements

xxvi IBM Spectrum Scale 5.0.2: Command and Programming Reference

||||

||||

||||||

|

|||||

|

|

|

|||

|||

||

||

|

||

|

|||

|

|||||

||

New option that executes one-time gather or send tasks for a Salesforce case descriptor. For moreinformation, see the mmcallhome command section in the IBM Spectrum Scale: Command andProgramming Reference.

mmhealth command enhancements

New --show-state-changes option that displays the additional information about the state of anode has been added to the mmhealth command. For more information, see the mmhealth commandsection in the IBM Spectrum Scale: Command and Programming Reference.

NFS changesCES packages for NFS-Ganesha name changed to avoid conflict with distribution NFS-Ganeshapackages.

Object changesTwo parameters were added to the mmobj command. The --pwd-file parameter specifies a filethat contains administrative user passwords for Object access protocol authenticationconfiguration. The -Y parameter displays headers and output in a machine-readable,colon-delimited format. For more information, see the topic mmobj command in the IBM SpectrumScale: Command and Programming Reference.

IBM Spectrum Scale SMB changesThe following enhancements are available:v Configurations

– IBM Spectrum Scale does not change back the supported SMB protocol versions when theyare changed by a user.- This does not change the supported protocol levels; it just prevents that changes to

unsupported versions are automatically reverted.- No longer force SMB2 for 'server min protocol' in registry template.- No longer force SMB3 for 'server max protocol' in registry template.

v Security– Local user enumeration without credentials has been disabled by setting 'restrict anonymous

= 2' by default. This can be changed back if needed using mmsmb config change --option"restrict anonymous"=0 "

v Stability enhancements– The load on the idmap cache has been reduced by

- Removing calls to gencache_stabilize() in net utility and on smbd server exit- adding an additional cache layer in memory so that the performance of workloads

involving many idmap lookups (with hide unreadable, for example) should improve andtimeouts during idmap cache access are avoided.

– More graceful behavior of CTDB in out-of-memory situations (avoid crash, going unhealthy,log memory usage data).

– Speed up wbinfo -p (the command for local winbind monitoring) to minimize the likelihoodof winbindd monitor timeouts and resulting fail-overs.

v Ubuntu enhancements– As a consequence of the system library dependencies, GPFS SMB on Ubuntu now uses

heimdal libraries for Kerberos to avoid linking against two Kerberos libraries.– Added support for OpenSSL 1.1.0 to allow GPFS SMB build on Ubuntu 18.04.

v Usability– Removed the wrong "malloc fail" error messages and fixed error messages during charset

conversion.– Adjusted debug level when get_winattrs returns EBADF to remove warning Getting

winattrs failed for ..: Bad file descriptor

Summary of changes xxvii

|||

|

|||

|||

||||||

||

|

||

||

|

|

|

|||

|

|

|

|||

||

||

|

||

|

|

||

||

v GPFS SMB version enhanced from 4.6.14_gpfs_36 to gpfs_50-1 4.6.15_gpfs_49-1v Miscellaneous

– Cache dfree information based on query path.– Fix Windows Quota report issue: Fix keep_old_entries logic for older kerberos libraries.– Update SELinux policy module for postfix to avoid SELinux warnings /usr/libexec/

postfix/local from getattr.– Add TasksMax option to smbd systemd service file for SLES12 and Ubuntu to avoid the OS

to prevent forks on new SMB connections as the default is too small.– Restored pre-4.6.9 behavior of GPFS SMB to implicitly set SMB_ACE4_SYNCHRONIZE on

NFSv4 ACLs - more strict ACLs checks have broken downwards compatibility– Fix reporting wrong session times for stale connections in the MMC.

Single IBM Spectrum Scale package for all Linux distributions (per architecture)There is no longer the need to differentiate between protocols and non-protocols packages. Thereis now only one package for all Linux distributions.

System Health changes

v Users can now create, raise, and find custom events. For more information, see the Creating,raising, and finding custom defined events section in the IBM Spectrum Scale: Problem DeterminationGuide.

v Users can now raise events for file audit logging and watch folder. For more information, seethe File audit logging events and Watch folder events sections in the IBM Spectrum Scale: ProblemDetermination Guide.

Upgrades to call home configuration

Updated the list of collected data that is called home.

Watch folderWatch folder is a flexible API that allows programmatic actions to be taken based on file systemevents. For more information, see Introduction to watch folder in the IBM Spectrum Scale: Concepts,Planning, and Installation Guide. It has the following features:v Watch folder can be run against folders, filesets, and inode spaces.v Watch folder is modeled after Linux inotify, but works with clustered file systems and supports

recursive watches for filesets and inode spaces.v Watch folder has two primary components:

– The GPFS programming interfaces, which are included within . For moreinformation, see Watch folder API in the IBM Spectrum Scale: Command and ProgrammingReference.

– The mmwatch command, which provides information for all of the watches running within acluster. For more information, see mmwatch command in the IBM Spectrum Scale: Command andProgramming Reference.

v A watch folder application uses the API to run on a node within an IBM Spectrum Scalecluster.– It utilizes the message queue to receive events from multiple nodes and consume from the

node that is running the application.– Lightweight events come in from all eligible nodes within a cluster and from accessing

clusters.v Watch folder is integrated into call home, IBM Spectrum Scale snap log collection, and IBM

Spectrum Scale trace.

xxviii IBM Spectrum Scale 5.0.2: Command and Programming Reference

|

|

|

|

||

||

||

|

|||

|

|||

|||

|

|

||||

|

||

|

|||

|||

||

||

||

||

Windows 10 supportIBM Spectrum Scale now supports Windows 10 (Pro and Enterprise editions), in bothheterogeneous and homogeneous clusters. Secure Boot must be disabled on Windows 10 nodesfor IBM Spectrum Scale to install and function.

Documented commands, structures, and subroutinesThe following section lists the modifications to the documented commands, structures, andsubroutines:

New commandsThe following command is new in this release:v mmwatch

New structuresThere are no new structures.

New subroutinesThe following subroutines are new:v gpfs_add_watchv gpfs_add_fset_watchv gpfs_add_inodespace_watchv gpfs_close_watchv gpfs_init_watchv gpfs_read_watchv gpfs_rm_watchv gpfs_watch_strerror

Changed commandsThe following commands were changed:v mmaddcallbackv mmafmctlv mmauditv mmbuildgplv mmcallhomev mmcesv mmchconfigv mmhealthv mmmsgqueuev mmnfsv mmobjv mmperfmonv mmrestripefilev mmuserauthv spectrumscale

Changed structuresThere are no changed structures.

Changed subroutinesThere are no changed subroutines.

Deleted commandsThere are no deleted commands.

Summary of changes xxix

||||

|||

||

|

||

||

|

|

|

|

|

|

|

|

||

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

||

||

||

Deleted structuresThere are no deleted structures.

Deleted subroutinesThere are no deleted subroutines.

MessagesThe following are the new, changed, and deleted messages:

New messages6027-1758, 6027-1759, 6027-1760, 6027-1828, 6027-2409, 6027-2410, 6027-2411, 6027-3731,6027-3732, 6027-3733, 6027-3734, 6027-3934, 6027-3935, 6027-3936, 6027-3937, and 6027-3409

Changed messages6027-1265, 6027-1303, 6027-1307, 6027-1309, and 6027-2798

Deleted messagesNone.

Changes in documentation

List of documentation changes in product guides and respective Knowledge Center sections

The following is a list of documentation changes including changes in topic titles,changes in placement of topics, and deleted topics:

Table 3. List of changes in documentation

GuideKnowledge centersection List of changes

Concepts, Planning,and Installation Guide

Product overview v Changed the titles of the following topics:– Primary gateway and afmHashVersion in the IBM Spectrum Scale:

Concepts, Planning, and Installation Guide.

Planning Moved the following topics from the Installing section:

v Requirements for UID and GID on the cache and home clustersv Recommended worker1threads on cache clusterv Inode limits to set at cache and homev Requirements for UID/GID on cache and home clustersv Recommended worker1threads on primary clusterv NFS setup on the secondary cluster

Upgrading v Changed the titles of the following topics:– Manually upgrading file audit logging authentication in IBM

Spectrum Scale: Concepts, Planning, and Installation Guide.

– Changing Express Edition to Standard Edition in IBM SpectrumScale: Concepts, Planning, and Installation Guide.

Administration Guide Configuring Moved the following topics from the Installing section of the IBMSpectrum Scale: Concepts, Planning, and Installation Guide.

v Configuration changes in an existing AFM relationshipv Changing configuration in an existing AFM DR relationship

Administering Moved the following topics from the Installing section of the IBMSpectrum Scale: Concepts, Planning, and Installation Guide.

v Creating an AFM relationship by using the NFS protocolv Creating an AFM relationship by using GPFS protocolv Creating an AFM-based DR relationship using NFS protocolv Converting GPFS filesets to AFM DRv Converting AFM relationship to AFM DR

xxx IBM Spectrum Scale 5.0.2: Command and Programming Reference

||

||

||

|||

||

||

|

|

||

||

||||

||||

||

||

|

|

|

|

|

|

||

||

||

||||

|

|

|||

|

|

|

|

||

Chapter 1. Command reference

A list of all the GPFS commands and a short description of each is presented in this topic.

Table 4 summarizes the GPFS-specific commands.

Table 4. GPFS commands

Command Purpose

“gpfs.snap command” on page 6 Creates an informational system snapshot at a single point intime. This system snapshot consists of information such ascluster configuration, disk configuration, networkconfiguration, network status, GPFS logs, dumps, and traces.

“mmaddcallback command” on page 11 Registers a user-defined command that GPFS will executewhen certain events occur.

“mmadddisk command” on page 25 Adds disks to a GPFS file system.

“mmaddnode command” on page 31 Adds nodes to a GPFS cluster.

“mmadquery command” on page 34 Queries and validates Active Directory (AD) server settings.

“mmafmconfig command” on page 39 Can be used to manage home caching behavior and mappingof gateways and home NFS exported servers.

“mmafmctl command” on page 42 This command is for various operations and reportinginformation on all filesets. It is recommended to read the IBMSpectrum Scale: Administration Guide AFM and AFM DisasterRecovery chapters in conjunction with this manual fordetailed description of the functions.

“mmafmlocal command” on page 57 Provides a list of cached files and file statistics such as inodenumber, allocated blocks, and so on.

“mmapplypolicy command” on page 59 Deletes files, migrates files between storage pools, or does filecompression or decompression in a file system as directed bypolicy rules.

“mmaudit command” on page 71 Manages setting and viewing the file audit loggingconfiguration in IBM Spectrum Scale.

“mmauth command” on page 76 Manages secure access to GPFS file systems.

“mmbackup command” on page 81 Performs a backup of a GPFS file system or independentfileset to an IBM Spectrum Protect server.

“mmbackupconfig command” on page 90 Collects GPFS file system configuration information.

“mmblock command” on page 92 Manages the iSCSI block service.

“mmbuildgpl command” on page 97 Manages prerequisite packages for Linux and builds the GPFSportability layer.

“mmcachectl command” on page 99 Displays information about files and directories in the localpage pool cache.

“mmcallhome command” on page 102 Manages the call home operations.

“mmces command” on page 115 Manages CES configuration.

“mmcesdr command” on page 125 Manages protocol cluster disaster recovery.

“mmchattr command” on page 134 Changes attributes of one or more GPFS files.

“mmchcluster command” on page 141 Changes GPFS cluster configuration data.

“mmchconfig command” on page 145 Changes GPFS configuration parameters.

© Copyright IBM Corp. 2014, 2019 1

|

Table 4. GPFS commands (continued)

Command Purpose

“mmchdisk command” on page 179 Changes state or parameters of one or more disks in a GPFSfile system.

“mmcheckquota command” on page 187 Checks file system user, group and fileset quotas.

“mmchfileset command” on page 191 Changes the attributes of a GPFS fileset.

“mmchfs command” on page 198 Changes the attributes of a GPFS file system.

“mmchlicense command” on page 205 Controls the type of GPFS license associated with the nodes inthe cluster.

“mmchmgr command” on page 208 Assigns a new file system manager node or cluster managernode.

“mmchnode command” on page 210 Changes node attributes.

“mmchnodeclass command” on page 215 Changes user-defined node classes.

“mmchnsd command” on page 218 Changes Network Shared Disk (NSD) configuration attributes.

“mmchpolicy command” on page 221 Establishes policy rules for a GPFS file system.

“mmchpool command” on page 224 Modifies storage pool properties.

“mmchqos command” on page 226 Changes the Quality of Service for I/O operations (QoS)settings for a file system.

“mmclidecode command” on page 234 Decodes the parseable command output field.

“mmclone command” on page 236 Creates and manages file clones.

“mmcloudgateway command” on page 239 Creates and manages the cloud storage tier.

“mmcrcluster command” on page 267 Creates a GPFS cluster from a set of nodes.

“mmcrfileset command” on page 272 Creates a GPFS fileset.

“mmcrfs command” on page 279 Creates a GPFS file system.

“mmcrnodeclass command” on page 291 Creates user-defined node classes.

“mmcrnsd command” on page 293 Creates Network Shared Disks (NSDs) used by GPFS.

“mmcrsnapshot command” on page 298 Creates a snapshot of a file system or fileset at a single pointin time.

“mmdefedquota command” on page 303 Sets default quota limits.

“mmdefquotaoff command” on page 307 Deactivates default quota limit usage.

“mmdefquotaon command” on page 310 Activates default quota limit usage.

“mmdefragfs command” on page 313 Reduces disk fragmentation by increasing the number of fullfree blocks available to the file system.

“mmdelacl command” on page 316 Deletes a GPFS access control list.

“mmdelcallback command” on page 318 Deletes one or more user-defined callbacks from the GPFSsystem.

“mmdeldisk command” on page 319 Deletes disks from a GPFS file system.

“mmdelfileset command” on page 324 Deletes a GPFS fileset.

“mmdelfs command” on page 327 Removes a GPFS file system.

“mmdelnode command” on page 329 Removes one or more nodes from a GPFS cluster.

“mmdelnodeclass command” on page 332 Deletes user-defined node classes.

“mmdelnsd command” on page 334 Deletes Network Shared Disks (NSDs) from the GPFS cluster.

“mmdelsnapshot command” on page 336 Deletes a GPFS snapshot.

“mmdf command” on page 340 Queries available file space on a GPFS file system.

2 IBM Spectrum Scale 5.0.2: Command and Programming Reference


Command Purpose

“mmdiag command” on page 344 Displays diagnostic information about the internal GPFS stateon the current node.

“mmdsh command” on page 351 Runs commands on multiple nodes or network connectedhosts at the same time.

“mmeditacl command” on page 353 Creates or changes a GPFS access control list.

“mmedquota command” on page 356 Sets quota limits.

“mmexportfs command” on page 360 Retrieves the information needed to move a file system to adifferent cluster.

“mmfsck command” on page 362 Checks and repairs a GPFS file system.

“mmfsctl command” on page 375 Issues a file system control request.

“mmgetacl command” on page 379 Displays the GPFS access control list of a file or directory.

“mmgetstate command” on page 382 Displays the state of the GPFS daemon on one or more nodes.

“mmhadoopctl command” on page 385 Installs and sets up the GPFS connector for a Hadoopdistribution; starts or stops the GPFS connector daemon on anode.

“mmimgbackup command” on page 400 Performs a backup of a single GPFS file system metadataimage.

“mmimgrestore command” on page 404 Restores a single GPFS file system from a metadata image.

“mmimportfs command” on page 407 Imports into the cluster one or more file systems that werecreated in another GPFS cluster.

“mmkeyserv command” on page 411 Manages encryption key servers and clients.

“mmlinkfileset command” on page 425 Creates a junction that references the root directory of a GPFSfileset.

“mmlsattr command” on page 427 Queries file attributes.

“mmlscallback command” on page 430 Lists callbacks that are currently registered in the GPFSsystem.

“mmlscluster command” on page 432 Displays the current configuration information for a GPFScluster.

“mmlsconfig command” on page 435 Displays the current configuration data for a GPFS cluster.

“mmlsdisk command” on page 437 Displays the current configuration and state of the disks in afile system.

“mmlsfileset command” on page 441 Displays attributes and status for GPFS filesets.

“mmlsfs command” on page 446 Displays file system attributes.

“mmlslicense command” on page 451 Displays information about the GPFS node licensingdesignation or about disk and cluster capacity.

“mmlsmgr command” on page 453 Displays which node is the file system manager for thespecified file systems or which node is the cluster manager.

“mmlsmount command” on page 455 Lists the nodes that have a given GPFS file system mounted.

“mmlsnodeclass command” on page 457 Displays node classes defined in the system.

“mmlsnsd command” on page 459 Displays Network Shared Disk (NSD) information for theGPFS cluster.

“mmlspolicy command” on page 462 Displays policy information.

“mmlspool command” on page 464 Displays information about the known storage pools.

“mmlsquota command” on page 471 Displays quota information for a user, group, or fileset.

Chapter 1. Command reference 3


Command Purpose

“mmlsqos command” on page 466 Displays the I/O performance values of a file system, whenyou enable Quality of Service for I/O operations (QoS) withthe mmchqos command.

“mmlssnapshot command” on page 475 Displays GPFS snapshot information.

“mmmigratefs command” on page 478 Performs needed conversions to support new file systemfeatures.

“mmmount command” on page 480 Mounts GPFS file systems on one or more nodes in thecluster.

“mmmsgqueue command” on page 483 Manages the IBM Spectrum Scale message queue.

“mmnetverify command” on page 487 Verifies network configuration and operation in a cluster.

“mmnfs command” on page 498 Manages NFS exports and configuration.

“mmnsddiscover command” on page 508 Rediscovers paths to the specified network shared disks.

“mmobj command” on page 510 Manages configuration of Object protocol service, andadministers storage policies for object storage, unified file andobject access, and multi-region object deployment.

“mmperfmon command” on page 527 Configures the Performance Monitoring tool and lists theperformance metrics.

“mmpmon command” on page 539 Manages performance monitoring and displays performanceinformation.

“mmprotocoltrace command” on page 545 Starts, stops, and monitors tracing for the CES protocols.

“mmpsnap command” on page 549 Creates or deletes identical snapshots on the cache and homeclusters, or shows the status of snapshots that have beenqueued up on the gateway nodes.

“mmputacl command” on page 552 Sets the GPFS access control list for the specified file ordirectory.

“mmquotaoff command” on page 555 Deactivates quota limit checking.

“mmquotaon command” on page 557 Activates quota limit checking.

“mmremotecluster command” on page 559 Manages information about remote GPFS clusters.

“mmremotefs command” on page 562 Manages information needed for mounting remote GPFS filesystems.

“mmrepquota command” on page 565 Displays file system user, group, and fileset quotas.

“mmrestoreconfig command” on page 569 Restores file system configuration information.

“mmrestorefs command” on page 573 Restores a file system or an independent fileset from asnapshot.

“mmrestripefile command” on page 577 Rebalances or restores the replication factor of the specifiedfiles, or performs any incomplete or deferred file compressionor decompression.

“mmrestripefs command” on page 580 Rebalances or restores the replication factor of all the files in afile system. Alternatively, this command performs anyincomplete or deferred file compression or decompression ofall the files in a file system.

“mmrpldisk command” on page 587 Replaces the specified disk.

“mmsdrrestore command” on page 594 Restores the latest GPFS system files on the specified nodes.

“mmsetquota command” on page 596 Sets quota limits.

“mmshutdown command” on page 600 Unmounts all GPFS file systems and stops GPFS on one ormore nodes.

4 IBM Spectrum Scale 5.0.2: Command and Programming Reference


Command Purpose

“mmsmb command” on page 602 Administers SMB shares, export ACLs, and globalconfiguration.

“mmsnapdir command” on page 614 Controls how the special directories that connect to snapshotsappear.

“mmstartup command” on page 618 Starts the GPFS subsystem on one or more nodes.

“mmtracectl command” on page 620 Sets up and enables GPFS tracing.

“mmumount command” on page 624 Unmounts GPFS file systems on one or more nodes in thecluster.

“mmunlinkfileset command” on page 627 Removes the junction to a GPFS fileset.

“mmuserauth command” on page 630 Manages the authentication configuration of file and objectaccess protocols. The configuration allows protocol accessmethods to authenticate users who need to access data that isstored on the system over these protocols.

“mmwatch command” on page 652 Lists the active watch folder watches for either a specific filesystem or all file systems.

“mmwinservctl command” on page 654 Manages the mmwinserv Windows service.

“spectrumscale command” on page 656 Installs and configures GPFS; adds nodes to a cluster; deploysand configures protocols, performance monitoring tools, andauthentication services; configures call home and file auditlogging; and upgrades GPFS and protocols.

The following commands are specific to IBM Spectrum Scale RAID and are documented in IBM SpectrumScale RAID: Administration:v mmaddcompv mmaddcompspecv mmaddpdiskv mmchcarrierv mmchcompv mmchcomplocv mmchenclosurev mmchfirmwarev mmchpdiskv mmchrecoverygroupv mmcrrecoverygroupv mmcrvdiskv mmdelcompv mmdelcomplocv mmdelcompspecv mmdelpdiskv mmdelrecoverygroupv mmdelvdiskv mmdiscovercompv mmgetdisktopologyv mmlscompv mmlscomplocv mmlscompspecv mmlsenclosurev mmlsfirmwarev mmlspdiskv mmlsrecoverygroup

Chapter 1. Command reference 5

|||

v mmlsrecoverygroupeventsv mmlsvdiskv mmsyncdisplayid

gpfs.snap commandCreates an informational system snapshot at a single point in time. This system snapshot consists ofinformation such as cluster configuration, disk configuration, network configuration, network status,GPFS logs, dumps, and traces.

Synopsisgpfs.snap [-d OutputDirectory] [-m | -z]

[-a | -N {Node[,Node...] | NodeFile | NodeClass}][--check-space | --no-check-space | --check-space-only][--cloud-gateway {NONE |BASIC |FULL} ] [--full-collection] [--deadlock [--quick] |--limit-large-files {YYYY:MM:DD:HH:MM | NumberOfDaysBack | latest}]

[--exclude-aix-disk-attr] [--exclude-aix-lvm] [--exclude-merge-logs][--exclude-net] [--gather-logs] [--mmdf] [--performance] [--prefix][--protocol ProtocolType[,ProtocolType,...]] [--timeout Seconds][--purge-files KeepNumberOfDaysBack][--hadoop]

Availability

Available on all IBM Spectrum Scale editions.

Description

Use the gpfs.snap command as the main tool to gather data when a GPFS problem is encountered, suchas a hung file system, a hung GPFS command, or a daemon assert.

The gpfs.snap command gathers information (for example, GPFS internal dumps, traces, and kernelthread dumps) to solve a GPFS problem.

Note: By default, large debug files are now a delta collection, which means that they are only collectedwhen there are new files since the previous run of gpfs.snap. To override this default behavior, use eitherthe --limit-large-files or --full-collection options.

Note: This is a service tool and options might change dynamically. The tool impacts performance andoccupies disk space when it runs.

Parameters

-d OutputDirectorySpecifies the output directory. The default is /tmp/gpfs.snapOut.

-m Specifying this option is equivalent to specifying --exclude-merge-logs with -N.

-z Collects gpfs.snap data only from the node on which the command is invoked. No master data iscollected.

-a Directs gpfs.snap to collect data from all nodes in the cluster. This is the default.

-N {Node[,Node ...] | NodeFile | NodeClass}Specifies the nodes from which to collect gpfs.snap data. This option supports all defined nodeclasses. For general information on how to specify node names, see Specifying nodes as input to GPFScommands in IBM Spectrum Scale: Ad

ibm spectrum scale 5.0.2: command and programming …...ibm spectrum scale v ersion 5.0.2 command...

Documents