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

IBM Spectrum ScaleVersion 5.0.3

Command and ProgrammingReference

GC27-9570-03

IBM

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

This edition applies to version 5 release 0 modification 3 of the following products, and to all subsequent releasesand modifications until otherwise indicated in new editions:v IBM Spectrum Scale Data Management Edition ordered through Passport Advantage® (product number 5737-F34)v IBM Spectrum Scale Data Access Edition ordered through Passport Advantage (product number 5737-I39)v IBM Spectrum Scale Erasure Code Edition ordered through Passport Advantage (product number 5737-J34)v IBM Spectrum Scale Data Management Edition ordered through AAS (product numbers 5641-DM1, DM3, DM5)v IBM Spectrum Scale Data Access Edition ordered through AAS (product numbers 5641-DA1, DA3, DA5)v IBM Spectrum Scale Data Management Edition for IBM ESS (product number 5765-DME)v IBM Spectrum Scale Data Access Edition for IBM ESS (product number 5765-DAE)

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 xxiii. 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 2015, 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 . . . . . xxiiConventions used in this information . . . . . xxiiHow to send your comments . . . . . . . . xxiii

Summary of changes . . . . . . . . xxv

Chapter 1. Command reference. . . . . 1gpfs.snap command . . . . . . . . . . . . 6mmaddcallback command . . . . . . . . . 11mmadddisk command. . . . . . . . . . . 25mmaddnode command . . . . . . . . . . 31mmadquery command. . . . . . . . . . . 35mmafmconfig command . . . . . . . . . . 40mmafmctl command . . . . . . . . . . . 43mmafmlocal command . . . . . . . . . . 59mmapplypolicy command . . . . . . . . . 61mmaudit command. . . . . . . . . . . . 73mmauth command . . . . . . . . . . . . 78mmbackup command . . . . . . . . . . . 83mmbackupconfig command . . . . . . . . . 93mmblock command . . . . . . . . . . . 95mmbuildgpl command . . . . . . . . . . 100mmcachectl command . . . . . . . . . . 102mmcallhome command . . . . . . . . . . 105mmces command . . . . . . . . . . . . 117mmcesdr command . . . . . . . . . . . 128mmchattr command . . . . . . . . . . . 137mmchcluster command . . . . . . . . . . 144mmchconfig command . . . . . . . . . . 149mmchdisk command . . . . . . . . . . . 185mmcheckquota command . . . . . . . . . 193mmchfileset command . . . . . . . . . . 197mmchfs command. . . . . . . . . . . . 204mmchlicense command . . . . . . . . . . 211mmchmgr command . . . . . . . . . . . 214mmchnode command . . . . . . . . . . 216mmchnodeclass command . . . . . . . . . 221mmchnsd command . . . . . . . . . . . 224mmchpolicy command . . . . . . . . . . 227mmchpool command . . . . . . . . . . . 230mmchqos command . . . . . . . . . . . 232mmclidecode command . . . . . . . . . . 241mmclone command . . . . . . . . . . . 243mmcloudgateway command . . . . . . . . 246mmcrcluster command . . . . . . . . . . 275mmcrfileset command . . . . . . . . . . 280mmcrfs command . . . . . . . . . . . . 287mmcrnodeclass command . . . . . . . . . 300mmcrnsd command . . . . . . . . . . . 302mmcrsnapshot command . . . . . . . . . 307mmdefedquota command . . . . . . . . . 312mmdefquotaoff command . . . . . . . . . 316

mmdefquotaon command . . . . . . . . . 319mmdefragfs command . . . . . . . . . . 322mmdelacl command . . . . . . . . . . . 325mmdelcallback command . . . . . . . . . 327mmdeldisk command . . . . . . . . . . 328mmdelfileset command . . . . . . . . . . 333mmdelfs command . . . . . . . . . . . 336mmdelnode command . . . . . . . . . . 338mmdelnodeclass command . . . . . . . . . 341mmdelnsd command . . . . . . . . . . . 343mmdelsnapshot command . . . . . . . . . 345mmdf command . . . . . . . . . . . . 349mmdiag command . . . . . . . . . . . 353mmdsh command . . . . . . . . . . . . 361mmeditacl command . . . . . . . . . . . 363mmedquota command . . . . . . . . . . 366mmexportfs command . . . . . . . . . . 370mmfsck command. . . . . . . . . . . . 372mmfsctl command. . . . . . . . . . . . 387mmgetacl command . . . . . . . . . . . 391mmgetstate command . . . . . . . . . . 394mmhadoopctl command. . . . . . . . . . 397mmhealth command . . . . . . . . . . . 399mmimgbackup command . . . . . . . . . 413mmimgrestore command . . . . . . . . . 417mmimportfs command . . . . . . . . . . 420mmkeyserv command . . . . . . . . . . 424mmlinkfileset command . . . . . . . . . . 438mmlsattr command . . . . . . . . . . . 440mmlscallback command . . . . . . . . . . 443mmlscluster command . . . . . . . . . . 445mmlsconfig command . . . . . . . . . . 448mmlsdisk command . . . . . . . . . . . 450mmlsfileset command . . . . . . . . . . 454mmlsfs command . . . . . . . . . . . . 459mmlslicense command . . . . . . . . . . 464mmlsmgr command . . . . . . . . . . . 466mmlsmount command . . . . . . . . . . 468mmlsnodeclass command . . . . . . . . . 470mmlsnsd command . . . . . . . . . . . 472mmlspolicy command . . . . . . . . . . 475mmlspool command . . . . . . . . . . . 477mmlsqos command . . . . . . . . . . . 479mmlsquota command . . . . . . . . . . 484mmlssnapshot command . . . . . . . . . 488mmmigratefs command . . . . . . . . . . 491mmmount command . . . . . . . . . . . 493mmmsgqueue command . . . . . . . . . 496mmnetverify command . . . . . . . . . . 501mmnfs command . . . . . . . . . . . . 513mmnsddiscover command . . . . . . . . . 523mmobj command . . . . . . . . . . . . 525mmperfmon command . . . . . . . . . . 541mmpmon command . . . . . . . . . . . 553mmprotocoltrace command. . . . . . . . . 559mmpsnap command . . . . . . . . . . . 563

© Copyright IBM Corp. 2015, 2019 iii

mmputacl command . . . . . . . . . . . 566mmquotaoff command . . . . . . . . . . 569mmquotaon command . . . . . . . . . . 571mmremotecluster command . . . . . . . . 573mmremotefs command . . . . . . . . . . 576mmrepquota command . . . . . . . . . . 579mmrestoreconfig command. . . . . . . . . 583mmrestorefs command . . . . . . . . . . 587mmrestripefile command . . . . . . . . . 591mmrestripefs command . . . . . . . . . . 594mmrpldisk command. . . . . . . . . . . 601mmsdrrestore command. . . . . . . . . . 608mmsetquota command . . . . . . . . . . 612mmshutdown command. . . . . . . . . . 616mmsmb command. . . . . . . . . . . . 618mmsnapdir command . . . . . . . . . . 630mmstartup command. . . . . . . . . . . 634mmtracectl command. . . . . . . . . . . 636mmumount command . . . . . . . . . . 640mmunlinkfileset command . . . . . . . . . 643mmuserauth command . . . . . . . . . . 646mmwatch command . . . . . . . . . . . 668mmwinservctl command . . . . . . . . . 675spectrumscale command. . . . . . . . . . 677

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

GPFS-specific DMAPI events . . . . . . . 705DMAPI functions . . . . . . . . . . . 706DMAPI configuration attributes . . . . . . 710DMAPI restrictions for GPFS . . . . . . . 711

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

Sessions . . . . . . . . . . . . . . 712Data management events . . . . . . . . 712Mount and unmount . . . . . . . . . . 714Tokens and access rights . . . . . . . . 715Parallelism in Data Management applications 716Data Management attributes . . . . . . . 717Support for NFS . . . . . . . . . . . 717Quota . . . . . . . . . . . . . . . 717Memory mapped files . . . . . . . . . 717

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

Required files for implementation of DataManagement applications . . . . . . . . 718GPFS configuration attributes for DMAPI . . . 719Enabling DMAPI for a file system . . . . . 720Initializing the Data Management application 721

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

Enhancements to data structures . . . . . . 722Usage restrictions on DMAPI functions. . . . 723Definitions for GPFS-specific DMAPI functions 725Semantic changes to DMAPI functions . . . . 738GPFS-specific DMAPI events . . . . . . . 739

Additional error codes returned by DMAPIfunctions . . . . . . . . . . . . . . 740

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

Single-node failure . . . . . . . . . . 742Session failure and recovery . . . . . . . 743Event recovery . . . . . . . . . . . . 743Loss of access rights . . . . . . . . . . 744DODeferred deletions . . . . . . . . . 744DM application failure . . . . . . . . . 744

Chapter 3. GPFS programminginterfaces . . . . . . . . . . . . . 747gpfs_acl_t structure . . . . . . . . . . . 750gpfs_clone_copy() subroutine . . . . . . . . 751gpfs_clone_snap() subroutine . . . . . . . . 753gpfs_clone_split() subroutine . . . . . . . . 755gpfs_clone_unsnap() subroutine . . . . . . . 757gpfs_close_inodescan() subroutine . . . . . . 759gpfs_cmp_fssnapid() subroutine . . . . . . . 760gpfs_declone() subroutine . . . . . . . . . 762gpfs_direntx_t structure . . . . . . . . . . 764gpfs_direntx64_t structure . . . . . . . . . 766gpfs_fcntl() subroutine . . . . . . . . . . 768gpfs_fgetattrs() subroutine . . . . . . . . . 771gpfs_fputattrs() subroutine . . . . . . . . . 773gpfs_fputattrswithpathname() subroutine . . . . 775gpfs_free_fssnaphandle() subroutine . . . . . . 777gpfs_fssnap_handle_t structure . . . . . . . 778gpfs_fssnap_id_t structure . . . . . . . . . 779gpfs_fstat() subroutine . . . . . . . . . . 780gpfs_fstat_x() subroutine . . . . . . . . . 782gpfs_get_fsname_from_fssnaphandle() subroutine 784gpfs_get_fssnaphandle_by_fssnapid() subroutine 785gpfs_get_fssnaphandle_by_name() subroutine . . 787gpfs_get_fssnaphandle_by_path() subroutine . . . 789gpfs_get_fssnapid_from_fssnaphandle() subroutine 791gpfs_get_pathname_from_fssnaphandle()subroutine . . . . . . . . . . . . . . 793gpfs_get_snapdirname() subroutine . . . . . . 795gpfs_get_snapname_from_fssnaphandle()subroutine . . . . . . . . . . . . . . 797gpfs_getacl() subroutine . . . . . . . . . . 799gpfs_iattr_t structure . . . . . . . . . . . 801gpfs_iattr64_t structure . . . . . . . . . . 804gpfs_iclose() subroutine . . . . . . . . . . 808gpfs_ifile_t structure . . . . . . . . . . . 810gpfs_igetattrs() subroutine . . . . . . . . . 811gpfs_igetattrsx() subroutine. . . . . . . . . 813gpfs_igetfilesetname() subroutine . . . . . . . 815gpfs_igetstoragepool() subroutine. . . . . . . 817gpfs_iopen() subroutine . . . . . . . . . . 819gpfs_iopen64() subroutine . . . . . . . . . 821gpfs_iputattrsx() subroutine . . . . . . . . 823gpfs_iread() subroutine . . . . . . . . . . 826gpfs_ireaddir() subroutine . . . . . . . . . 828gpfs_ireaddir64() subroutine . . . . . . . . 830gpfs_ireadlink() subroutine . . . . . . . . . 832gpfs_ireadlink64() subroutine . . . . . . . . 834gpfs_ireadx() subroutine . . . . . . . . . . 836gpfs_iscan_t structure . . . . . . . . . . 839

iv IBM Spectrum Scale 5.0.3: Command and Programming Reference

gpfs_lib_init() subroutine . . . . . . . . . 840gpfs_lib_term() subroutine . . . . . . . . . 841gpfs_next_inode() subroutine . . . . . . . . 842gpfs_next_inode64() subroutine . . . . . . . 844gpfs_next_inode_with_xattrs() subroutine . . . . 846gpfs_next_inode_with_xattrs64() subroutine . . . 848gpfs_next_xattr() subroutine . . . . . . . . 850gpfs_opaque_acl_t structure . . . . . . . . 852gpfs_open_inodescan() subroutine . . . . . . 853gpfs_open_inodescan64() subroutine. . . . . . 856gpfs_open_inodescan_with_xattrs() subroutine . . 859gpfs_open_inodescan_with_xattrs64() subroutine 862gpfs_prealloc() subroutine . . . . . . . . . 865gpfs_putacl() subroutine . . . . . . . . . . 868gpfs_quotactl() subroutine . . . . . . . . . 870gpfs_quotaInfo_t structure . . . . . . . . . 873gpfs_seek_inode() subroutine . . . . . . . . 875gpfs_seek_inode64() subroutine . . . . . . . 877gpfs_stat() subroutine . . . . . . . . . . 879gpfs_stat_inode() subroutine . . . . . . . . 881gpfs_stat_inode64() subroutine . . . . . . . 883gpfs_stat_inode_with_xattrs() subroutine . . . . 885gpfs_stat_inode_with_xattrs64() subroutine . . . 887gpfs_stat_x() subroutine . . . . . . . . . . 889gpfsFcntlHeader_t structure . . . . . . . . 891gpfsGetDataBlkDiskIdx_t structure . . . . . . 892gpfsGetFilesetName_t structure . . . . . . . 895gpfsGetReplication_t structure . . . . . . . . 896gpfsGetSetXAttr_t structure . . . . . . . . 898gpfsGetSnapshotName_t structure . . . . . . 900gpfsGetStoragePool_t structure . . . . . . . 901gpfsListXAttr_t structure . . . . . . . . . 902gpfsRestripeData_t structure . . . . . . . . 903gpfsRestripeRange_t structure . . . . . . . . 905gpfsRestripeRangeV2_t structure . . . . . . . 908gpfsSetReplication_t structure . . . . . . . . 911gpfsSetStoragePool_t structure. . . . . . . . 913

Chapter 4. GPFS user exits . . . . . 915mmsdrbackup user exit . . . . . . . . . . 916nsddevices user exit . . . . . . . . . . . 917syncfsconfig user exit. . . . . . . . . . . 918

Chapter 5. IBM Spectrum Scalemanagement API endpoints . . . . . 919Version 1 - deprecated . . . . . . . . . . 919

CES addresses: GET . . . . . . . . . . 920CES addresses/{cesAddress}: GET . . . . . 922CES services: GET . . . . . . . . . . . 924CES services/{service}: GET . . . . . . . 927Config: GET . . . . . . . . . . . . . 930Cluster: GET . . . . . . . . . . . . 931Filesets: GET . . . . . . . . . . . . 937Filesets/{filesetName}: GET . . . . . . . 943Filesets: POST . . . . . . . . . . . . 949Filesets/{filesetName}: PUT . . . . . . . 954Filesets/{filesetName}: DELETE . . . . . . 958Filesystems: GET . . . . . . . . . . . 960Filesystems/{filesystemName}: GET . . . . . 966Info: GET. . . . . . . . . . . . . . 972

Nodes: GET . . . . . . . . . . . . . 975Nodes/{name}: GET . . . . . . . . . . 979Quotas: GET . . . . . . . . . . . . 982Quotas: POST . . . . . . . . . . . . 986Snapshots: GET. . . . . . . . . . . . 989Snapshots/{snapshotName}: GET. . . . . . 992Snapshots: POST . . . . . . . . . . . 995Snapshots/{snapshotName}: DELETE . . . . 997

Version 2 . . . . . . . . . . . . . . . 998CES/addresses: GET . . . . . . . . . . 999CES/addresses/{cesAddress}: GET . . . . . 1003CES/services: GET . . . . . . . . . . 1006CES/services/{service}: GET . . . . . . . 1009Cliauditlog: GET . . . . . . . . . . . 1012Cluster: GET . . . . . . . . . . . . 1016Config: GET . . . . . . . . . . . . 1022Filesystems: GET . . . . . . . . . . . 1027Filesystems/{filesystemName}: GET . . . . 1034Filesystems/{filesystemName}/acl/{path}: GET 1041Filesystems/{filesystemName}/acl/{path}: PUT 1044Filesystems/{filesystemName}/afm/state: GET 1049Filesystems/{filesystemName}/audit: PUT 1052Filesystems/{filesystemName}/disks: GET 1056Filesystems/{filesystemName}/disks/{diskName}: GET. . . . . . . . . . . 1060Filesystems/{filesystemName}/filesets: GET 1064Filesystems/{filesystemName}/filesets: POST 1071Filesystems/{filesystemName}/filesets/{filesetName}: DELETE . . . . . . . . . 1076Filesystems/{filesystemName}/filesets/{filesetName}: GET . . . . . . . . . . 1079Filesystems/{filesystemName}/filesets/{filesetName}: PUT . . . . . . . . . . 1085Filesystems/{filesystemName}/filesets/{filesetName}/afmctl: POST . . . . . . . 1091Filesystems/{filesystemName}/filesets/{filesetName}/link: DELETE . . . . . . . 1097Filesystems/{filesystemName}/filesets/{filesetName}/link: POST . . . . . . . . 1100Filesystems/{filesystemName}/filesets/{filesetName}/psnaps: POST . . . . . . . 1103Filesystems/{filesystemName}/filesets/{filesetName}/psnaps/{snapshotName}:DELETE . . . . . . . . . . . . . . 1107Filesystems/{filesystemName}/filesets/{filesetName}/quotadefaults: GET . . . . . 1111Filesystems/{filesystemName}/filesets/{filesetName}/defaultquotas: PUT . . . . . 1115Filesystems/{filesystemName}/filesets/{filesetName}quotadefaults: POST . . . . . 1119Filesystems/{filesystemName}/filesets/{filesetName}/quotas: GET . . . . . . . 1123Filesystems/{filesystemName}/filesets/{filesetName}/quotas: POST . . . . . . . 1127Filesystems/{filesystemName}/filesets/{filesetName}/snapshots: GET . . . . . . 1131Filesystems/{filesystemName}/filesets/{filesetName}/snapshots: POST . . . . . . 1134Filesystems/{filesystemName}/filesets/{filesetName}/snapshots/{snapshotName}:DELETE . . . . . . . . . . . . . . 1137

Contents v

Filesystems/{filesystemName}/filesets/{filesetName}/snapshots/{snapshotName}: GET 1140Filesystems/{filesystemName}/mount: PUT 1143Filesystems/{filesystemName}/owner/{path}:GET . . . . . . . . . . . . . . . 1147Filesystems/{filesystemName}/owner/{path}:PUT . . . . . . . . . . . . . . . 1150Filesystems/{filesystemName}/policies: GET 1153Filesystems/{filesystemName}/policies: PUT 1156Filesystems/{filesystemName}/quotadefaults:GET . . . . . . . . . . . . . . . 1160Filesystems/{filesystemName}/quotadefaults:PUT . . . . . . . . . . . . . . . 1164Filesystems/{filesystemName}/quotadefaults:POST. . . . . . . . . . . . . . . 1169Filesystems/{filesystemName}/quotagracedefaults: GET . . . . . . . . 1173Filesystems/{filesystemName}/quotagracedefaults: POST . . . . . . . . 1176Filesystems/{filesystemName}/quotamanagement: PUT . . . . . . . . 1180Filesystems/{filesystemName}/quotas: GET 1184Filesystems/{filesystemName}/quotas: POST 1188Filesystems/{filesystemName}/snapshots: GET 1192Filesystems/{filesystemName}/snapshots:POST. . . . . . . . . . . . . . . 1195Filesystems/{filesystemName}/snapshots/{snapshotName}: DELETE . . . . . . . . 1198Filesystems/{filesystemName}/snapshots/{snapshotName}: GET . . . . . . . . . 1201Filesystems/{filesystemName}/unmount: PUT 1204Info: GET . . . . . . . . . . . . . 1208Jobs: GET . . . . . . . . . . . . . 1211Jobs/{jobId}: DELETE . . . . . . . . . 1215Jobs/{jobID}: GET . . . . . . . . . . 1218NFS/exports: GET . . . . . . . . . . 1222NFS/exports: POST . . . . . . . . . . 1226NFS/exports/{exportPath}: GET. . . . . . 1230NFS/exports/{exportPath}: PUT. . . . . . 1234NFS/exports/{exportPath}: DELETE . . . . 1238Nodeclasses: GET . . . . . . . . . . 1241Nodeclasses: POST . . . . . . . . . . 1244Nodeclasses/{nodeclassName}: GET . . . . 1248Nodeclasses/{nodeclassName}: DELETE . . . 1251Nodeclasses/{nodeclassName}: PUT . . . . 1254Nodes: GET . . . . . . . . . . . . 1258Nodes: POST . . . . . . . . . . . . 1265Nodes/{name}: DELETE . . . . . . . . 1269Nodes/{name}: GET. . . . . . . . . . 1273Nodes/{name}/health/events: GET . . . . 1278Nodes/{name}/health/states: GET . . . . . 1282

Nodes/{name}/services: GET . . . . . . 1286Nodes/{name}/services/{serviceName}: GET 1289Nodes/{name}/services/{serviceName}: PUT 1293NSDs: GET . . . . . . . . . . . . . 1297NSDs/{nsdName}: GET . . . . . . . . 1303Perfmon/data: GET . . . . . . . . . . 1306Perfmon/sensors/{sensorName}: GET . . . . 1311Perfmon/sensors: GET . . . . . . . . . 1313Perfmon/sensors/{sensorName}: PUT . . . . 1315SMB/shares: GET . . . . . . . . . . 1319SMB/shares/{shareName}: GET . . . . . . 1324SMB/shares: POST . . . . . . . . . . 1329SMB/shares/{shareName}: PUT . . . . . . 1335SMB/shares/{shareName}: DELETE . . . . 1340SMB/shares/{shareName}/acl: DELETE . . . 1343SMB/shares/{shareName}/acl: GET . . . . 1346SMB/shares/{shareName}/acl: DELETE . . . 1349SMB/shares/{shareName}/acl/{name}: GET 1352SMB/shares/{shareName}/acl/{name}: PUT 1355Thresholds: GET . . . . . . . . . . . 1359Thresholds: POST . . . . . . . . . . 1363Thresholds/{name}: DELETE . . . . . . . 1368Thresholds/{name}: GET . . . . . . . . 1371

Chapter 6. Watch folder API. . . . . 1375gpfs_init_watch subroutine . . . . . . . . 1376gpfs_add_watch subroutine . . . . . . . . 1377gpfs_add_fset_watch subroutine. . . . . . . 1379gpfs_add_inodespace_watch subroutine . . . . 1381gpfs_add_filesystem_watch subroutine . . . . 1383gpfs_rm_watch subroutine . . . . . . . . 1385gpfs_read_watch subroutine . . . . . . . . 1386gpfs_close_watch subroutine . . . . . . . . 1388gpfs_watch_strerror subroutine . . . . . . . 1389

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

Notices . . . . . . . . . . . . . 1393Trademarks . . . . . . . . . . . . . 1394Terms and conditions for product documentation 1395IBM Online Privacy Statement . . . . . . . 1395

Glossary . . . . . . . . . . . . . 1397

Index . . . . . . . . . . . . . . 1403

vi IBM Spectrum Scale 5.0.3: Command and Programming Reference

||

Tables

1. IBM Spectrum Scale library information units x2. Conventions . . . . . . . . . . . . xxii3. List of changes in documentation . . . . xxxii4. GPFS commands . . . . . . . . . . . 15. Global events and supported parameters 166. Local events and supported parameters 177. Query details by type . . . . . . . . . 368. Key-value. . . . . . . . . . . . . 1099. key-value . . . . . . . . . . . . . 110

10. Effects of options on compressed oruncompressed files. . . . . . . . . . 140

11. Values assigned to autoBuildGPL and theireffects . . . . . . . . . . . . . . 156

12. Settings for debugDataControl . . . . . . 16013. Values returned by statvfs or statfs for

different settings of linuxStatfsUnits . . . 16414. Default intervals for collecting and sending

statistics . . . . . . . . . . . . . 23315. Allocation of IOPS . . . . . . . . . . 23516. GPFS commands that support QoS . . . . 23617. Supported block sizes with subblock size 29118. Contents of columns input1 and input2

depending on the value in column Buf type . 35419. mmkeyserv server show . . . . . . . . 43020. mmkeyserv tenant show . . . . . . . . 43021. Information and error messages . . . . . 50122. Shortcut terms for network checks . . . . 50623. Network checks. . . . . . . . . . . 50724. Restoring a global snapshot . . . . . . . 58825. Restoring a fileset snapshot . . . . . . . 58826. Tracing status information . . . . . . . 63727. DMAPI configuration attributes . . . . . 71128. Specific DMAPI functions and associated

error codes. . . . . . . . . . . . . 74129. GPFS programming interfaces . . . . . . 74730. GPFS user exits . . . . . . . . . . . 91531. List of parameters . . . . . . . . . . 99932. List of parameters . . . . . . . . . 100333. List of parameters . . . . . . . . . 100934. List of parameters . . . . . . . . . 101235. List of parameters . . . . . . . . . 102236. List of parameters . . . . . . . . . 102737. List of parameters . . . . . . . . . 103438. List of parameters . . . . . . . . . 104139. List of parameters . . . . . . . . . 104440. List of request parameters . . . . . . . 104941. List of request parameters . . . . . . . 105242. List of parameters . . . . . . . . . 105643. List of parameters . . . . . . . . . 106044. List of parameters . . . . . . . . . 106445. List of request parameters . . . . . . . 107146. List of request parameters . . . . . . . 107647. List of parameters . . . . . . . . . 107948. List of request parameters . . . . . . . 108549. List of request parameters . . . . . . . 109150. List of request parameters . . . . . . . 1097

51. List of request parameters . . . . . . . 110052. List of request parameters . . . . . . . 110353. List of request parameters . . . . . . . 110754. List of request parameters . . . . . . . 111155. List of request parameters . . . . . . . 111556. List of request parameters . . . . . . . 111957. List of request parameters . . . . . . . 112358. List of request parameters . . . . . . . 113159. List of request parameters . . . . . . . 113460. List of request parameters . . . . . . . 113761. List of request parameters . . . . . . . 114062. List of parameters. . . . . . . . . . 114363. List of request parameters . . . . . . . 114764. List of request parameters . . . . . . . 115065. List of parameters. . . . . . . . . . 115366. List of request parameters . . . . . . . 115667. List of request parameters . . . . . . . 116068. List of request parameters . . . . . . . 116469. List of request parameters . . . . . . . 116970. List of request parameters . . . . . . . 117371. List of request parameters . . . . . . . 117672. List of request parameters . . . . . . . 118073. List of request parameters . . . . . . . 118474. List of request parameters . . . . . . . 118875. List of request parameters . . . . . . . 119276. List of request parameters . . . . . . . 119577. List of request parameters . . . . . . . 119878. List of request parameters . . . . . . . 120179. List of parameters . . . . . . . . . 120480. List of request parameters . . . . . . . 121181. List of request parameters . . . . . . . 121582. List of request parameters . . . . . . . 121883. List of request parameters . . . . . . . 122284. List of request parameters . . . . . . . 122685. List of request parameters . . . . . . . 123086. List of request parameters . . . . . . . 123487. List of request parameters . . . . . . . 123888. List of request parameters . . . . . . . 124189. List of request parameters . . . . . . . 124490. List of request parameters . . . . . . . 124891. List of request parameters . . . . . . . 125192. List of request parameters . . . . . . . 125493. List of request parameters . . . . . . . 126594. List of request parameters . . . . . . . 126995. List of request parameters . . . . . . . 127396. List of request parameters . . . . . . . 127897. List of request parameters . . . . . . . 128298. List of parameters . . . . . . . . . 128699. List of parameters . . . . . . . . . 1289

100. List of parameters . . . . . . . . . 1293101. List of request parameters . . . . . . . 1297102. List of request parameters . . . . . . . 1303103. List of request parameters . . . . . . . 1306104. List of request parameters . . . . . . . 1311105. List of request parameters . . . . . . . 1313106. List of parameters . . . . . . . . . 1315

© Copyright IBM Corp. 2015, 2019 vii

||

|||

||||||

||

107. List of request parameters . . . . . . . 1319108. List of request parameters . . . . . . . 1324109. List of request parameters . . . . . . . 1346110. List of request parameters . . . . . . . 1352

111. List of request parameters . . . . . . . 1359112. List of request parameters . . . . . . . 1363113. List of request parameters . . . . . . . 1368114. List of request parameters . . . . . . . 1371

viii IBM Spectrum Scale 5.0.3: Command and Programming Reference

About this information

This edition applies to IBM Spectrum Scale version 5.0.3 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. 2015, 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 Introduction to clustered watchv 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.3: 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 Installation of Active FileManagement (AFM)

v Installing and upgrading AFM-basedDisaster Recovery

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


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 IBM Spectrum™ Scalenon-protocol Linux nodes

v Upgrading IBM Spectrum Scaleprotocol nodes

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 IBM Spectrum Scaleproduct edition

v Completing the upgrade to a newlevel of IBM Spectrum Scale

v Reverting to the previous level ofIBM Spectrum Scale


xii IBM Spectrum Scale 5.0.3: Command and Programming Reference

||

||




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

v Servicing IBM Spectrum Scaleprotocol nodes

About this information xiii

||



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 Steps that are taken when a watch is

enabled with the mmwatch command

v 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 Native NFS and GPFSv Considerations for GPFS applicationsv Accessing a remote GPFS file system

System administrators or programmersof IBM Spectrum Scale systems

xiv IBM Spectrum Scale 5.0.3: Command and Programming Reference

||



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 Windows /

RFC 2307 Attributes

v 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

About this information xv

||



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 loggingv Monitoring clustered watch

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 Troubleshooting mmwatchv Message queue issuesv 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

xvi IBM Spectrum Scale 5.0.3: Command and Programming Reference

|

|

|



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 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

About this information xvii




v mmcrnodeclass commandv mmcrnsd commandv mmcrsnapshot commandv 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



xviii IBM Spectrum Scale 5.0.3: Command and Programming Reference




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



About this information xix




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



xx IBM Spectrum Scale 5.0.3: Command and Programming Reference



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 HortonworksData Platform 2.6

v Planningv Installationv Upgrading software stackv Configurationv Administrationv Troubleshootingv Limitationsv FAQ



IBM Spectrum Scale on AWSGuide

IBM Spectrum Scale on AWS

v Summary of changesv Introduction to IBM Spectrum Scale

on 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 Active file management on AWSv Troubleshootingv Frequently Asked Questions



About this information xxi

|

|



IBM Spectrum Scale ErasureCode Edition Guide

IBM Spectrum Scale Erasure CodeEdition

v Introduction to IBM Spectrum ScaleErasure Code Edition

v Planning for IBM Spectrum ScaleErasure Code Edition

v Installing IBM Spectrum Scale ErasureCode Edition

v Incorporating IBM Spectrum ScaleErasure Code Edition in an ElasticStorage Server (ESS) cluster

v Upgrading IBM Spectrum ScaleErasure Code Edition

v Administering IBM Spectrum ScaleErasure Code Edition

v Troubleshootingv IBM Spectrum Scale RAID

Administration 1

Note: 1 For PDF or EPUB format of IBMSpectrum Scale RAID Administrationdocumentation, see Elastic StorageServer for Power documentation on IBMKnowledge Center.



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).

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.

xxii IBM Spectrum Scale 5.0.3: Command and Programming Reference

https://www.ibm.com/support/knowledgecenter/SSYSP8/sts_welcome.htmlhttps://www.ibm.com/support/knowledgecenter/SSYSP8/sts_welcome.htmlhttps://www.ibm.com/support/knowledgecenter/SSYSP8/sts_welcome.htmlhttp://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

Table 2. Conventions (continued)

Convention Usage

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.

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]

About this information xxiii

xxiv IBM Spectrum Scale 5.0.3: 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.3as updated, September 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 Added a new configuration parameter - afmRefreshAsync to enable cache data refreshoperation in asynchronous mode. For more information, see the topic mmchconfig command inthe IBM Spectrum Scale: Command and Programming Reference.

v Added a use case - Data migration by using AFM migration enhancements.v Added Example of AFM support for kerberos-enabled NFS protocol exports under Administering

AFM.

Authentication-related changes

v mmuserauth service list reports servers as "*" indicating any domain controller in theenvironment can be used.

v mmuserauth service check --server-reachability output enhanced to report DomainController connected by each CES node.

v mmuserauth service create reports a warning message for clock skew greater than 5 minutesbetween CES node and domain controller.

v File Authentication configuration is supported with sudo setup.

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 changes

v A new container is automatically created during reconcile when the specified threshold of filesis reached, thus enabling improved maintenance. For more information, see the topic Bindingyour file system or fileset to the Cloud service by creating a container pair set in the IBM SpectrumScale: Administration Guide.

v Recalls are performed directly without any intervention or interaction with the Cloud servicesServer category of nodes thus improving efficiency and performance. For more information, seethe topic Client-assisted recalls in the IBM Spectrum Scale: Concepts, Planning, and InstallationGuide.

v Microsoft Azure object storage service supported. For more information, see the topic MicrosoftAzure in the IBM Spectrum Scale: Administration Guide.

v Linux on Z supported.

File system core improvements

Compatibility settings resolve the unit types that are returned by statfs and statvfsThe linuxStatfsUnits attribute controls the types of units that are returned in f_bsize,f_rsize, f_blocks, and f_bfree for compatibility with earlier or later versions of statfs

© Copyright IBM Corp. 2015, 2019 xxv

|||

||

|

|||

|

||

|

||

||

||

|

|||

|

||||

||||

||

|

|

|||

https://www.ibm.com/support/knowledgecenter/STXKQY_BDA_SHR/bl1bda_soc.htmhttps://www.ibm.com/support/knowledgecenter/STXKQY_BDA_SHR/bl1bda_soc.htm

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

QoS for I/O is enhanced to scale better in large clustersQoS dynamically adjusts the frequency of data collection based on the number of nodesthat have mounted the file system. Alternatively you can configure a fixed-value customfrequency with the mmchqos command. For more information, see the topic mmchqoscommand in the IBM Spectrum Scale: Command and Programming Reference.

zfast, alphae, and alphah libraries compress genomic dataFile compression methods for genomic data include zfast compression for active genomicdata in FASTA, SAM, and VCF format and alphae and alphah compression for activegenomic data in FASTQ format. For more information, see the topic File compression in theIBM Spectrum Scale: Administration Guide.

The mmaddnode command assigns a license to the new nodeThe licenseType node descriptor assigns a license of the specified type to the new node.For more information, see the topic mmaddnode command in the IBM Spectrum Scale:Command and Programming Reference.

The proactiveReconnnect parameter (mmchconfig command) reduces node expulsion that iscaused by short-term network outages

The proactiveReconnnect attribute proactively closes and reestablishes problematic TCPconnections between nodes. This feature can prevent nodes from being expelled from acluster when TCP connections go into error states that are caused by packet loss in thenetwork or in the adapter. For more information, see the topic mmchconfig command in theIBM Spectrum Scale: Command and Programming Reference.

The mmfsck command repairs block allocation map corruption in online modeThe command detects and repairs structural corruptions such as corrupted block headersand corrupted disk addresses in online mode. For more information, see the topic mmfsckcommand in the IBM Spectrum Scale: Command and Programming Reference.

The mmkeyserv command shows certificate expiration datesThe server show and client show parameters display expiration dates for the RESTcertificate and the KMIP certificate. For more information, see the topic mmkeyservcommand in the IBM Spectrum Scale: Command and Programming Reference.

The mmnetverify command checks RDMA connectivity The rdma-connectivity option verifies the verbsPorts configuration and checks nodeconnectivity through the active InfiniBand interfaces. For more information, see the topicmmnetverify command in the IBM Spectrum Scale: Command and Programming Reference.

The mmsdrrestore command repairs CCR files that are corrupted or lost on all quorum nodesThe --ccr-repair parameter repairs files in the CCR committed directory when they havebeen lost or corrupted on all the quorum nodes. The manual procedure is no longerrequired. For AIX you must install Python 2.7.5 or later from the AIX Toolbox for LinuxApplications. For more information, see the topic mmsdrrestore command in the IBMSpectrum Scale: Command and Programming Reference.

The primary-secondary configuration server feature is deprecatedThe primary and secondary configuration server functionality is deprecated and will beremoved in a future release. The default configuration service is CCR:v The mmcrcluster command no longer creates primary and secondary configuration

servers or allows a cluster to be created with a primary-secondary configuration. Formore information, see the topic mmcrcluster command in the IBM Spectrum Scale:Command and Programming Reference.

xxvi IBM Spectrum Scale 5.0.3: Command and Programming Reference

||

|||||

|||||

||||

|||||||

||||

||||

||||

||||||

|||

||||

https://www.ibm.com/developerworks/aix/library/aix-toolbox/https://www.ibm.com/developerworks/aix/library/aix-toolbox/

v The mmchcluster command still switches from the CCR configuration toprimary-secondary configuration, with warnings and checks. For more information, seethe topic mmchcluster command in the IBM Spectrum Scale: Command and ProgrammingReference.

Other improvements

v You can use the --use-stale-replica option for the mmfsck command to read possiblestale replica blocks from unrecovered disks. For more information, see the topic mmfsckcommand in the IBM Spectrum Scale: Command and Programming Reference.

v You can install a gpfs.gplbin package on a machine that has a different Linux kernelthan the machine on which the gpfs.gplbin package was built. For more information,see the topic mmbuildgpl command in the IBM Spectrum Scale: Command and ProgrammingReference.

v I/O error checking is improved for locally attached disks of NSD servers. For moreinformation, see the topic Additional considerations for managing disks in the IBMSpectrum Scale: Administration Guide.

v Performance is improved for a large number of nodes concurrently creating files in asmall directory.

v Reporting is improved for possible network issues.v Error messages are more detailed for failed CCR requests during mm-commands. For

more information, see error messages 6027-4200 [E] through 6027-4207 [E] in the IBMSpectrum Scale: Problem Determination Guide.

IBM Spectrum Scale Erasure Code EditionIBM Spectrum Scale Erasure Code Edition provides network-dispersed erasure coding,distributing data and metadata across the internal disks of a cluster of servers. This allows IBMSpectrum Scale to use internal disks as reliable storage with low overhead and high performance.

For more information, see IBM Spectrum Scale Erasure Code Edition documentation.

IBM Spectrum Scale on AWS changesFor information about changes in IBM Spectrum Scale on AWS 1.2.0, see IBM Spectrum Scale onAWS 1.2.0: Summary of changes.

Installation toolkit changes

v Support for IBM Spectrum Scale Erasure Code Edition. For more information, see Overview ofthe installation toolkit in IBM Spectrum Scale: Concepts, Planning, and Installation Guide.

v Support for SLES 15 on x86_64 and s390xv Upgrade related enhancements:

– Upgrade flow changes to minimize I/O disruptions. For more information, see Upgradeprocess flow in IBM Spectrum Scale: Concepts, Planning, and Installation Guide.

– Enhanced upgrade pre-checks to determine the packages that must be upgraded.The versions of the installed packages are compared with the versions in the repository ofthe packages that you want to upgrade to. In a mixed operating system cluster, thecomparison is done with the package repository applicable for the operating system runningon the respective nodes.

– Mixed OS support for upgrade– Enhanced upgrade post-checks to ensure that all packages have been upgraded successfully– Enhanced dependency checks to ensure dependencies are met for each required package– Improvements in upgrade messaging to make the upgrade progress clearer to the user

Management API changesAdded the following API commands:v GET: /filesystems/{filesystemName}/filesets/{filesetName}/quotadefaults

Summary of changes xxvii

||||

|

|||

||||

|||

||

|

|||

||||

|

|||

|

||

|

|

||

|

||||

|

|

|

|

||

|

https://www.ibm.com/support/knowledgecenter/STXKQY_ECE_5.0.3/ibmspectrumscaleece503_welcome.htmlhttps://www.ibm.com/support/knowledgecenter/STXKQY_AWS_SHR/com.ibm.spectrum.scale.aws.v5r03.doc/bl1cld_aws_soc.htmhttps://www.ibm.com/support/knowledgecenter/STXKQY_AWS_SHR/com.ibm.spectrum.scale.aws.v5r03.doc/bl1cld_aws_soc.htm

v POST: /filesystems/{filesystemName}/filesets/{filesetName}/quotadefaultsv PUT: filesystems/{filesystemName}/filesets/{filesetName}/quotadefaultsv PUT: /filesystems/{filesystemName}/mountv PUT: /filesystems/{filesystemName}/unmountv GET: /filesystems/{filesystemName}/quotadefaultsv POST: /filesystems/{filesystemName}/quotadefaultsv PUT: /filesystems/{filesystemName}/quotadefaultsv GET: /filesystems/{filesystemName}/quotagracedefaultsv POST: /filesystems/{filesystemName}/quotagracedefaults

For more information on the API commands, see IBM Spectrum Scale management API endpoints 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.

Management GUI changes

The following changes are made to the GUI:v Improved quota management features. The changes made to the Files > Quotas page are as

follows:– You can now define both capacity and inode quotas for users, user groups, and filesets from

the Files > Quotas page.– Introduced Defaults tab to improve user experience for defining and enabling default

quotas for user, group, and fileset.– Introduced Settings tab. You can perform actions such as enable quota, disable quota, set

quota accounting scope, check quota, and set grace time periods.v Added options to configure user authentication for NFS and SMB protocol user access from the

Services > File Authentication page.v To prevent files from being changed or deleted unexpectedly, you can use the integrated

archive mode (IAM) mode. You can set this option from the Files > Filesets page whilecreating the fileset or when you modify it.

v You can modify the list of file auditing events to be included in the file audit log by using theedit option that is available against Events logged by file audit logging option that is availableunder the Properties tab of the detailed view of File Systems page. You can access the detailedview of a file system by selecting View Details option that is available in the Actions menu.

v Introduced option in the Files > Information Lifecycle page to define a migration to externalpool rule to migrate the data from local pool to external pools like tape or transparent cloudtiering.

v Introduced Configure External Authentication option in the Services > GUI > ExternalAuthentication page to configure an LDAP-based authentication method on an externalauthentication server for GUI user access management.

v NFS and SMB Performance details can be easily monitored through the newly introducedperformance charts and metrics in the NFS Exports and SMB Shares pages.

v The Protocols > NFS Exports page now offers effective management of NFS client definitionsand support for pseudo paths for NFSv4.

v Introduced separate Exports and Client Definition views in the Protocols > NFS Exports pagefor better manageability of client definitions.

v The following navigation menu updates are made in the GUI:– Removed the Access and Settings menus.– Introduced Cluster and Support menus.

xxviii IBM Spectrum Scale 5.0.3: Command and Programming Reference

|

|

|

|

|

|

|

|

|

|||||

|

|

||

||

||

||

||

|||

||||

|||

|||

||

||

||

|

|

|

– Moved File System ACL page from Access menu to Files menu.– Moved Remote Connections page from Access menu to newly introduced Cluster menu.– Moved Command Audit Log page from the Access menu to Monitoring menu.– Moved Event Notifications page from the Settings menu to newly introduced Support menu.– Moved Diagnostic Data and Call Home pages from the Settings menu to the new Support

menu.– Moved Network page to Cluster menu.

mmces command enhancements

The node suspend command has been extended with the --stop option, which stops all therunning CES services.

The node resume command has been extended with the --start option, which starts all theenabled protocols.

For more information, see the mmces command section in the IBM Spectrum Scale: Command andProgramming Reference.

NFS changes

v Increased send queues leading to improved NFS performance.v Statistics counters for NFSv3, NFSv4 protocol versions and RPC queues provided might help

identify the probable area of performance bottlenecks.v Memory consumption and Readdir / listing improvements for CES NFS service that runs on

protocol nodes.

Object changes

Updated the mmobj command with a new password file. For more information, see the topicmmobj command in the IBM Spectrum Scale: Command and Programming Reference.

SMB changes

v Support for SMB 3.1.1. SMB protocol version 3.1.1 is now supported with IBM Spectrum Scale.Support is automatically enabled on new installations. When upgrading, the support can beenabled by making the config change: /usr/lpp/mmfs/bin/net conf setparm global ’servermax protocol’ SMB3_11

Note: The limitations still apply. For more information, see the SMB limitations topic in the IBMSpectrum Scale: Concepts, Planning, and Installation Guide.

v The SYNCHRONIZE bit in NFSv4 ACLS is now honored by the SMB server. Note that this bitis expected to be set for many file operations on Windows clients. For more information, seethe NFS V4 ACL Syntax topic in the IBM Spectrum Scale: Administration Guide.

v FSCTL_SET_ZERO_DATA is now supported on sparse files.

System Health changes

mmhealth command enhancements

The mmhealth command print output form can be selectedThe node show, cluster show, and node eventlog commands can now have acolor or non-colored output. For more information, see the mmhealth commandsection in the IBM Spectrum Scale: Command and Programming Reference.

The mmhealth command re-syncs health state and events The node show commands can now re-sync all the health states and events of thecurrent node with the cluster state manager. For more information, see themmhealth command section in the IBM Spectrum Scale: Command and ProgrammingReference. command.

Summary of changes xxix

|

|

|

|

||

|

|

||

||

||

|

|

||

||

|

||

|

||||

||

|||

|

|

|

||||

|||||

The mmhealth command displays the unhealthy componentsThe cluster show commands can now display the unhealthy components. Formore information, see the mmhealth command section in the IBM Spectrum Scale:Command and Programming Reference.

The mmhealth command displays health state of call home and NVMe componentsThe node show and cluster show commands can now display the health state forcall home and NVMe components. For more information, see the mmhealthcommand section in the IBM Spectrum Scale: Command and Programming Reference.

Identifying ACTIVE THRESHOLD MONITOR roleA pmcollector node that has been granted the ACTIVE THRESHOLD MONITOR role can now beidentified. For more information, see the Monitoring the health of a node section and the Usecase 4 in the Threshold monitoring use case section in the IBM Spectrum Scale: ProblemDetermination Guide.

Call Home changes

Automatic data upload options for call home

Following enhancements have been made to the automatic upload function in callhome:

Event-based uploads

v Added more events to the event-based uploads.v Improved the performance and scalability of the uploads.

For more information on event-based uploads, see the Event -based uploads sectionin the IBM Spectrum Scale: Problem Determination Guide.

HeartbeatsThis type of upload is done once daily by each call home master node. The callhome master nodes sends basic cluster information to ECuRep. For moreinformation on heartbeats, see the Heartbeats feature for call home section in theIBM Spectrum Scale: Problem Determination Guide.

Other improvements

v Performance improvement for mmcallhome commandv Scalability improvements for the scheduled data collectionv Call Home packages no longer needed for call home child nodesv Perl-dependencies for gpfs.callhome removedv SLES 15 support available

Watch folder

In IBM Spectrum Scale 5.0.3, watch folder has a clustered watch capability. An entire file system,fileset, or inode space can be watched. For more information, see Introduction to clustered watch inthe IBM Spectrum Scale: Concepts, Planning, and Installation Guide.

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

New commandsThere are no new commands in this release.

New structuresThere are no new structures.

New subroutinesThe following subroutine is new:v gpfs_add_filesystem_watch

xxx IBM Spectrum Scale 5.0.3: Command and Programming Reference

||||

||||

|||||

|

|

|

|

|

|

||

|||||

|

|

|

|

|

|

|

|||

|||

||

||

||

|

Changed commandsThe following commands are changed:v mmaddnodev mmbuildgplv mmcallhomev mmcesv mmchattrv mmchclusterv mmchconfigv mmchfilesetv mmchqosv mmcloudgatewayv mmcrclusterv mmcrfilesetv mmcrfsv mmdiagv mmdeldiskv mmfsckv mmhealthv mmkeyservv mmlsattrv mmnetverifyv mmobjv mmsdrrestorev mmuserauthv mmwatchv spectrumscale

Changed structuresThere are no changed structures.

Changed subroutinesThere are no changed subroutines.

Deleted commandsThere are no deleted commands.

Deleted structuresThere are no deleted structures.

Deleted subroutinesThere are no deleted subroutines.

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

New messages6027-1285, 6027-1397, 6027-1965, 6027-3735, 6027-3736, 6027-3737, 6027-3738, 6027-3739,6027-3740, 6027-3741, 6027-3742, 6027-3743, 6027-3744, 6027-3745, 6027-3746, 6027-3747,6027-3748, 6027-3749, 6027-3938, 6027-3939, 6027-3940, 6027-3941, 6027-3942, 6027-3943,6027-4100, 6027-4101, 6027-4102, 6027-4103, 6027-4104, 6027-4105, 6027-4106, 6027-4107,6027-4108, 6027-4200, 6027-4201, 6027-4202, 6027-4203, 6027-4204, 6027-4205, 6027-4206,and 6027-4207

Summary of changes xxxi

||

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

||

||

||

||

||

||

|||||||

Changed messages6027-2409, 6027-2410, and 6027-2411

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

Installing Moved the following topic under Preparing to install the GPFSsoftware on Linux nodes:

v For Linux on Z: Changing the kernel settings in IBM Spectrum Scale:Concepts, Planning, and Installation Guide

Administration Guide Configuring Moved the following topic under Configuring and tuning your systemfor Cloud services:

v Configuration command execution matrix in IBM Spectrum Scale:Administration Guide

Administering Added the following topic under Administering AFM:

v Example of AFM support for kerberos-enabled NFS protocol exports inIBM Spectrum Scale: Administration Guide

Problemdetermination Guide

Monitoring Changed the location of the following sections under Performancemonitoring:

v Moved the Viewing and analyzing the performance data underPerformance monitoring in the IBM Spectrum Scale: ProblemDetermination Guide.

v Moved the Removing non-detectable resource identifiers from theperformance monitoring tool database and Performance monitoringlimitations sections under Using the performance monitoring tool inthe IBM Spectrum Scale: Problem Determination Guide.

Moved the following topic under Viewing and analyzing theperformance data:

v Performance monitoring using IBM Spectrum Scale GUI in the IBMSpectrum Scale: Problem Determination Guide.

Changed the name of following section:

v Performance monitoring tool overview to Using the performancemonitoring tool in the IBM Spectrum Scale: Problem DeterminationGuide.

Restructured the content in the Monitoring, uploading, and sharingcollected data with IBM® Support section into the following threetopics:

v Space requirements for call home data uploadv Types of call home data uploadv Uploading custom files using call homeEnd of change

Changed the location of the following sections underTroubleshooting:

v Moved the Failures using the mmpmon command section underPerformance issues in the IBM Spectrum Scale: Problem DeterminationGuide.

xxxii IBM Spectrum Scale 5.0.3: Command and Programming Reference

||

||

|

|

||

||

||||

|||||

||

||||

||

||

||

|||||

|||

||||

||

||

|

|||

|||

|

|

|

||

|||

Summary of changes xxxiii

|

xxxiv IBM Spectrum Scale 5.0.3: 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 35 Queries and validates Active Directory (AD) server settings.

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

“mmafmctl command” on page 43 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 59 Provides a list of cached files and file statistics such as inodenumber, allocated blocks, and so on.

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

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

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

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

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

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

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

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

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

“mmces command” on page 117 Manages CES configuration.

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

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

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

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

© Copyright IBM Corp. 2015, 2019 1

|

Table 4. GPFS commands (continued)

Command Purpose

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

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

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

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

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

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

“mmchnode command” on page 216 Changes node attributes.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2 IBM Spectrum Scale 5.0.3: Command and Programming Reference


Command Purpose

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

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

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

“mmedquota command” on page 366 Sets quota limits.

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

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

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

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

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

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

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

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

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

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

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

“mmlsattr command” on page 440 Queries file attributes.

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

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

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

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

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

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

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

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

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

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

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

“mmlspolicy command” on page 475 Displays policy information.

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

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

Chapter 1. Command reference 3


Command Purpose

“mmlsqos command” on page 479 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 488 Displays GPFS snapshot information.

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

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

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

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

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

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

“mmobj command” on page 525 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 541 Configures the Performance Monitoring tool and lists theperformance metrics.

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

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

“mmpsnap command” on page 563 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 566 Sets the GPFS access control list for the specified file ordirectory.

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

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

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

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

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

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

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

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

“mmrestripefs command” on page 594 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 601 Replaces the specified disk.

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

“mmsetquota command” on page 612 Sets quota limits.

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

4 IBM Spectrum Scale 5.0.3: Command and Programming Reference


Command Purpose

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

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

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

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

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

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

“mmuserauth command” on pa

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

Documents