IBM Spectrum Scale 5.0.0: Command and Programming Reference · Command and Programming Reference...

IBM Spectrum ScaleVersion 5.0.0

Command and ProgrammingReference

SC27-9222-03

IBM

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

This edition applies to version 5 release 0 modification 0 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 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 2014, 2018.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 . . . . . . xxiConventions used in this information . . . . . xxiiHow to send your comments . . . . . . . . xxiii

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

Chapter 1. Command reference. . . . . 1gpfs.snap command . . . . . . . . . . . . 7mmaddcallback command . . . . . . . . . 11mmadddisk command. . . . . . . . . . . 25mmaddnode command . . . . . . . . . . 31mmadquery command. . . . . . . . . . . 34mmafmconfig command . . . . . . . . . . 39mmafmctl command . . . . . . . . . . . 42mmafmlocal command . . . . . . . . . . 56mmapplypolicy command . . . . . . . . . 58mmaudit command. . . . . . . . . . . . 69mmauth command . . . . . . . . . . . . 73mmbackup command . . . . . . . . . . . 78mmbackupconfig command . . . . . . . . . 87mmblock command . . . . . . . . . . . 89mmbuildgpl command . . . . . . . . . . 94mmcallhome command . . . . . . . . . . 96mmces command . . . . . . . . . . . . 109mmcesdr command . . . . . . . . . . . 119mmchattr command . . . . . . . . . . . 128mmchcluster command . . . . . . . . . . 135mmchconfig command . . . . . . . . . . 139mmchdisk command . . . . . . . . . . . 170mmcheckquota command . . . . . . . . . 178mmchfileset command . . . . . . . . . . 182mmchfs command. . . . . . . . . . . . 188mmchlicense command . . . . . . . . . . 195mmchmgr command . . . . . . . . . . . 198mmchnode command . . . . . . . . . . 200mmchnodeclass command . . . . . . . . . 205mmchnsd command . . . . . . . . . . . 208mmchpolicy command . . . . . . . . . . 211mmchpool command . . . . . . . . . . . 214mmchqos command . . . . . . . . . . . 216mmclidecode command . . . . . . . . . . 224mmclone command . . . . . . . . . . . 226mmcloudgateway command . . . . . . . . 229mmcrcluster command . . . . . . . . . . 254mmcrfileset command . . . . . . . . . . 259mmcrfs command . . . . . . . . . . . . 265mmcrnodeclass command . . . . . . . . . 277mmcrnsd command . . . . . . . . . . . 279mmcrsnapshot command . . . . . . . . . 284mmdefedquota command . . . . . . . . . 289mmdefquotaoff command . . . . . . . . . 293mmdefquotaon command . . . . . . . . . 296

mmdefragfs command . . . . . . . . . . 299mmdelacl command . . . . . . . . . . . 302mmdelcallback command . . . . . . . . . 304mmdeldisk command . . . . . . . . . . 305mmdelfileset command . . . . . . . . . . 310mmdelfs command . . . . . . . . . . . 313mmdelnode command . . . . . . . . . . 315mmdelnodeclass command . . . . . . . . . 318mmdelnsd command . . . . . . . . . . . 320mmdelsnapshot command . . . . . . . . . 322mmdf command . . . . . . . . . . . . 326mmdiag command . . . . . . . . . . . 330mmdsh command . . . . . . . . . . . . 337mmeditacl command . . . . . . . . . . . 339mmedquota command . . . . . . . . . . 342mmexportfs command . . . . . . . . . . 346mmfsck command. . . . . . . . . . . . 348mmfsctl command. . . . . . . . . . . . 361mmgetacl command . . . . . . . . . . . 365mmgetstate command . . . . . . . . . . 368mmhadoopctl command. . . . . . . . . . 371mmhealth command . . . . . . . . . . . 373mmimgbackup command . . . . . . . . . 386mmimgrestore command . . . . . . . . . 390mmimportfs command . . . . . . . . . . 393mmkeyserv command . . . . . . . . . . 397mmlinkfileset command . . . . . . . . . . 411mmlsattr command . . . . . . . . . . . 413mmlscallback command . . . . . . . . . . 416mmlscluster command . . . . . . . . . . 418mmlsconfig command . . . . . . . . . . 421mmlsdisk command . . . . . . . . . . . 423mmlsfileset command . . . . . . . . . . 427mmlsfs command . . . . . . . . . . . . 432mmlslicense command . . . . . . . . . . 437mmlsmgr command . . . . . . . . . . . 439mmlsmount command . . . . . . . . . . 441mmlsnodeclass command . . . . . . . . . 443mmlsnsd command . . . . . . . . . . . 445mmlspolicy command . . . . . . . . . . 448mmlspool command . . . . . . . . . . . 450mmlsqos command . . . . . . . . . . . 452mmlsquota command . . . . . . . . . . 457mmlssnapshot command . . . . . . . . . 461mmmigratefs command . . . . . . . . . . 464mmmount command . . . . . . . . . . . 466mmmsgqueue command . . . . . . . . . 468mmnetverify command . . . . . . . . . . 471mmnfs command . . . . . . . . . . . . 480mmnsddiscover command . . . . . . . . . 490mmobj command . . . . . . . . . . . . 492mmperfmon command . . . . . . . . . . 507mmpmon command . . . . . . . . . . . 518mmprotocoltrace command. . . . . . . . . 524mmpsnap command . . . . . . . . . . . 528mmputacl command . . . . . . . . . . . 531

© Copyright IBM Corp. 2014, 2018 iii

||

||

mmquotaoff command . . . . . . . . . . 534mmquotaon command . . . . . . . . . . 536mmremotecluster command . . . . . . . . 538mmremotefs command . . . . . . . . . . 541mmrepquota command . . . . . . . . . . 544mmrestoreconfig command. . . . . . . . . 548mmrestorefs command . . . . . . . . . . 552mmrestripefile command . . . . . . . . . 556mmrestripefs command . . . . . . . . . . 559mmrpldisk command. . . . . . . . . . . 566mmsdrrestore command. . . . . . . . . . 573mmsetquota command . . . . . . . . . . 575mmshutdown command. . . . . . . . . . 579mmsmb command. . . . . . . . . . . . 581mmsnapdir command . . . . . . . . . . 593mmstartup command. . . . . . . . . . . 597mmtracectl command. . . . . . . . . . . 599mmumount command . . . . . . . . . . 603mmunlinkfileset command . . . . . . . . . 606mmuserauth command . . . . . . . . . . 609mmwinservctl command . . . . . . . . . 630spectrumscale command. . . . . . . . . . 632

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

GPFS-specific DMAPI events . . . . . . . 655DMAPI functions . . . . . . . . . . . 656DMAPI configuration attributes . . . . . . 660DMAPI restrictions for GPFS . . . . . . . 661

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

Sessions . . . . . . . . . . . . . . 662Data management events . . . . . . . . 662Mount and unmount . . . . . . . . . . 664Tokens and access rights . . . . . . . . 665Parallelism in Data Management applications 666Data Management attributes . . . . . . . 667Support for NFS . . . . . . . . . . . 667Quota . . . . . . . . . . . . . . . 667Memory mapped files . . . . . . . . . 667

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

Required files for implementation of DataManagement applications . . . . . . . . 668GPFS configuration attributes for DMAPI . . . 669Enabling DMAPI for a file system . . . . . 670Initializing the Data Management application 671

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

Enhancements to data structures . . . . . . 672Usage restrictions on DMAPI functions. . . . 673Definitions for GPFS-specific DMAPI functions 675Semantic changes to DMAPI functions . . . . 688GPFS-specific DMAPI events . . . . . . . 689Additional error codes returned by DMAPIfunctions . . . . . . . . . . . . . . 690

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

Single-node failure . . . . . . . . . . 692Session failure and recovery . . . . . . . 693Event recovery . . . . . . . . . . . . 693Loss of access rights . . . . . . . . . . 694DODeferred deletions . . . . . . . . . 694DM application failure . . . . . . . . . 694

Chapter 3. GPFS programminginterfaces . . . . . . . . . . . . . 697gpfs_acl_t structure . . . . . . . . . . . 700gpfs_clone_copy() subroutine . . . . . . . . 701gpfs_clone_snap() subroutine . . . . . . . . 703gpfs_clone_split() subroutine . . . . . . . . 705gpfs_clone_unsnap() subroutine . . . . . . . 707gpfs_close_inodescan() subroutine . . . . . . 709gpfs_cmp_fssnapid() subroutine . . . . . . . 710gpfs_declone() subroutine . . . . . . . . . 712gpfs_direntx_t structure . . . . . . . . . . 714gpfs_direntx64_t structure . . . . . . . . . 716gpfs_fcntl() subroutine . . . . . . . . . . 718gpfs_fgetattrs() subroutine . . . . . . . . . 721gpfs_fputattrs() subroutine . . . . . . . . . 723gpfs_fputattrswithpathname() subroutine . . . . 725gpfs_free_fssnaphandle() subroutine . . . . . . 727gpfs_fssnap_handle_t structure . . . . . . . 728gpfs_fssnap_id_t structure . . . . . . . . . 729gpfs_fstat() subroutine . . . . . . . . . . 730gpfs_fstat_x() subroutine . . . . . . . . . 732gpfs_get_fsname_from_fssnaphandle() subroutine 734gpfs_get_fssnaphandle_by_fssnapid() subroutine 735gpfs_get_fssnaphandle_by_name() subroutine . . 737gpfs_get_fssnaphandle_by_path() subroutine . . . 739gpfs_get_fssnapid_from_fssnaphandle() subroutine 741gpfs_get_pathname_from_fssnaphandle()subroutine . . . . . . . . . . . . . . 743gpfs_get_snapdirname() subroutine . . . . . . 745gpfs_get_snapname_from_fssnaphandle()subroutine . . . . . . . . . . . . . . 747gpfs_getacl() subroutine . . . . . . . . . . 749gpfs_iattr_t structure . . . . . . . . . . . 751gpfs_iattr64_t structure . . . . . . . . . . 754gpfs_iclose() subroutine . . . . . . . . . . 758gpfs_ifile_t structure . . . . . . . . . . . 760gpfs_igetattrs() subroutine . . . . . . . . . 761gpfs_igetattrsx() subroutine. . . . . . . . . 763gpfs_igetfilesetname() subroutine . . . . . . . 765gpfs_igetstoragepool() subroutine. . . . . . . 767gpfs_iopen() subroutine . . . . . . . . . . 769gpfs_iopen64() subroutine . . . . . . . . . 771gpfs_iputattrsx() subroutine . . . . . . . . 773gpfs_iread() subroutine . . . . . . . . . . 776gpfs_ireaddir() subroutine . . . . . . . . . 778gpfs_ireaddir64() subroutine . . . . . . . . 780gpfs_ireadlink() subroutine . . . . . . . . . 782gpfs_ireadlink64() subroutine . . . . . . . . 784gpfs_ireadx() subroutine . . . . . . . . . . 786gpfs_iscan_t structure . . . . . . . . . . 789gpfs_lib_init() subroutine . . . . . . . . . 790gpfs_lib_term() subroutine . . . . . . . . . 791

iv IBM Spectrum Scale 5.0.0: Command and Programming Reference

gpfs_next_inode() subroutine . . . . . . . . 792gpfs_next_inode64() subroutine . . . . . . . 794gpfs_next_inode_with_xattrs() subroutine . . . . 796gpfs_next_inode_with_xattrs64() subroutine . . . 798gpfs_next_xattr() subroutine . . . . . . . . 800gpfs_opaque_acl_t structure . . . . . . . . 802gpfs_open_inodescan() subroutine . . . . . . 803gpfs_open_inodescan64() subroutine. . . . . . 806gpfs_open_inodescan_with_xattrs() subroutine . . 809gpfs_open_inodescan_with_xattrs64() subroutine 812gpfs_prealloc() subroutine . . . . . . . . . 815gpfs_putacl() subroutine . . . . . . . . . . 818gpfs_quotactl() subroutine . . . . . . . . . 820gpfs_quotaInfo_t structure . . . . . . . . . 823gpfs_seek_inode() subroutine . . . . . . . . 825gpfs_seek_inode64() subroutine . . . . . . . 827gpfs_stat() subroutine . . . . . . . . . . 829gpfs_stat_inode() subroutine . . . . . . . . 831gpfs_stat_inode64() subroutine . . . . . . . 833gpfs_stat_inode_with_xattrs() subroutine . . . . 835gpfs_stat_inode_with_xattrs64() subroutine . . . 837gpfs_stat_x() subroutine . . . . . . . . . . 839gpfsFcntlHeader_t structure . . . . . . . . 841gpfsGetDataBlkDiskIdx_t structure . . . . . . 842gpfsGetFilesetName_t structure . . . . . . . 845gpfsGetReplication_t structure . . . . . . . . 846gpfsGetSetXAttr_t structure . . . . . . . . 848gpfsGetSnapshotName_t structure . . . . . . 850gpfsGetStoragePool_t structure . . . . . . . 851gpfsListXAttr_t structure . . . . . . . . . 852gpfsRestripeData_t structure . . . . . . . . 853gpfsRestripeRange_t structure . . . . . . . . 855gpfsRestripeRangeV2_t structure . . . . . . . 858gpfsSetReplication_t structure . . . . . . . . 861gpfsSetStoragePool_t structure. . . . . . . . 863

Chapter 4. GPFS user exits . . . . . 865mmsdrbackup user exit . . . . . . . . . . 866nsddevices user exit . . . . . . . . . . . 867syncfsconfig user exit. . . . . . . . . . . 868

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

CES addresses: GET . . . . . . . . . . 870CES addresses/{cesAddress}: GET . . . . . 872CES services: GET . . . . . . . . . . . 874CES services/{service}: GET . . . . . . . 877Config: GET . . . . . . . . . . . . . 880Cluster: GET . . . . . . . . . . . . 881Filesets: GET . . . . . . . . . . . . 887Filesets/{filesetName}: GET . . . . . . . 893Filesets: POST . . . . . . . . . . . . 899Filesets/{filesetName}: PUT . . . . . . . 904Filesets/{filesetName}: DELETE . . . . . . 908Filesystems: GET . . . . . . . . . . . 910Filesystems/{filesystemName}: GET . . . . . 916Info: GET. . . . . . . . . . . . . . 922Nodes: GET . . . . . . . . . . . . . 925Nodes/{name}: GET . . . . . . . . . . 929

Quotas: GET . . . . . . . . . . . . 932Quotas: POST . . . . . . . . . . . . 936Snapshots: GET. . . . . . . . . . . . 939Snapshots/{snapshotName}: GET. . . . . . 942Snapshots: POST . . . . . . . . . . . 945Snapshots/{snapshotName}: DELETE . . . . 947

Version 2 . . . . . . . . . . . . . . . 948CES/addresses: GET . . . . . . . . . . 949CES/addresses/{cesAddress}: GET . . . . . 953CES/services: GET . . . . . . . . . . 956CES/services/{service}: GET . . . . . . . 959Cluster: GET . . . . . . . . . . . . 962Config: GET . . . . . . . . . . . . . 966Filesystems: GET . . . . . . . . . . . 971Filesystems/{filesystemName}: GET . . . . . 979Filesystems/{filesystemName}/acl/{path}: GET 986Filesystems/{filesystemName}/acl/{path}: PUT 989Filesystems/{filesystemName}/afm/state: GET 994Filesystems/{filesystemName}/disks: GET. . . 997Filesystems/{filesystemName}/disks/{diskName}: GET. . . . . . . . . . . 1001Filesystems/{filesystemName}/filesets: GET 1005Filesystems/{filesystemName}/filesets: POST 1012Filesystems/{filesystemName}/filesets/{filesetName}: DELETE . . . . . . . . . 1017Filesystems/{filesystemName}/filesets/{filesetName}: GET . . . . . . . . . . 1020Filesystems/{filesystemName}/filesets/{filesetName}: PUT . . . . . . . . . . 1026Filesystems/{filesystemName}/filesets/{filesetName}/link: DELETE . . . . . . . 1032Filesystems/{filesystemName}/filesets/{filesetName}/link: POST . . . . . . . . 1035Filesystems/{filesystemName}/filesets/{filesetName}/psnaps: POST . . . . . . . 1038Filesystems/{filesystemName}/filesets/{filesetName}/psnaps/{snapshotName}:DELETE. . . . . . . . . . . . . . 1042Filesystems/{filesystemName}/filesets/{filesetName}/quotas: GET . . . . . . . 1046Filesystems/{filesystemName}/filesets/{filesetName}/quotas: POST . . . . . . . 1050Filesystems/{filesystemName}/filesets/{filesetName}/snapshots: GET . . . . . . 1054Filesystems/{filesystemName}/filesets/{filesetName}/snapshots: POST . . . . . . 1057Filesystems/{filesystemName}/filesets/{filesetName}/snapshots/{snapshotName}:DELETE. . . . . . . . . . . . . . 1060Filesystems/{filesystemName}/filesets/{filesetName}/snapshots/{snapshotName}:GET . . . . . . . . . . . . . . . 1063Filesystems/{filesystemName}/owner/{path}:GET . . . . . . . . . . . . . . . 1066Filesystems/{filesystemName}/owner/{path}:PUT . . . . . . . . . . . . . . . 1069Filesystems/{filesystemName}/quotas: GET 1072Filesystems/{filesystemName}/quotas: POST 1076Filesystems/{filesystemName}/snapshots: GET 1080Filesystems/{filesystemName}/snapshots:POST. . . . . . . . . . . . . . . 1083

Contents v

||

Filesystems/{filesystemName}/snapshots/{snapshotName}: DELETE . . . . . . . . 1086Filesystems/{filesystemName}/snapshots/{snapshotName}: GET . . . . . . . . . 1089Info: GET . . . . . . . . . . . . . 1092Jobs: GET . . . . . . . . . . . . . 1095Jobs/{jobId}: DELETE . . . . . . . . . 1099Jobs/{jobID}: GET . . . . . . . . . . 1102NFS/exports: GET . . . . . . . . . . 1106NFS/exports: POST . . . . . . . . . . 1110NFS/exports/{exportPath}: GET . . . . . . 1113NFS/exports/{exportPath}: PUT . . . . . . 1117NFS/exports/{exportPath}: DELETE . . . . 1121Nodeclasses: GET . . . . . . . . . . 1124Nodeclasses: POST . . . . . . . . . . 1127Nodeclasses/{nodeclassName}: GET . . . . 1131Nodeclasses/{nodeclassName}: DELETE . . . 1134Nodeclasses/{nodeclassName}: PUT . . . . 1137Nodes: GET . . . . . . . . . . . . 1141Nodes: POST . . . . . . . . . . . . 1148Nodes/{name}: DELETE . . . . . . . . 1152Nodes/{name}: GET . . . . . . . . . . 1156Nodes/{name}/health/events: GET . . . . 1161Nodes/{name}/health/states: GET . . . . . 1165NSDs: GET . . . . . . . . . . . . . 1169NSDs/{nsdName}: GET . . . . . . . . 1175Perfmon/data: GET . . . . . . . . . . 1178

SMB/shares: GET . . . . . . . . . . 1180SMB/shares/{shareName}: GET . . . . . . 1185SMB/shares: POST . . . . . . . . . . 1190SMB/shares/{shareName}: PUT . . . . . . 1195SMB/shares/{shareName}: DELETE . . . . 1200Thresholds: GET . . . . . . . . . . . 1203Thresholds: POST . . . . . . . . . . 1207Thresholds/{name}: DELETE . . . . . . . 1212Thresholds/{name}: GET . . . . . . . . 1215

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

Notices . . . . . . . . . . . . . 1221Trademarks . . . . . . . . . . . . . 1222Terms and conditions for product documentation 1223IBM Online Privacy Statement . . . . . . . 1223

Glossary . . . . . . . . . . . . . 1225

Index . . . . . . . . . . . . . . 1231

vi IBM Spectrum Scale 5.0.0: Command and Programming Reference

||

||||||||

Tables

1. IBM Spectrum Scale library information units x2. Conventions . . . . . . . . . . . . xxii3. List of changes in documentation xxxiv4. GPFS commands . . . . . . . . . . . 15. Global events and supported parameters 166. Local events and supported parameters 177. Query details by type . . . . . . . . . 358. key-value . . . . . . . . . . . . . 1009. key-value . . . . . . . . . . . . . 101

10. Settings for debugDataControl . . . . . . 14811. Allocation of IOPS . . . . . . . . . . 21812. GPFS commands that support QoS . . . . 21913. Block sizes and subblock sizes . . . . . . 27014. Contents of columns input1 and input2

depending on the value in column Buf type . 33115. mmkeyserv server show . . . . . . . . 40216. mmkeyserv tenant show . . . . . . . . 40317. Information and error messages . . . . . 47118. Shortcut terms for network checks . . . . 47519. Network checks. . . . . . . . . . . 47520. Restoring a global snapshot . . . . . . . 55321. Restoring a fileset snapshot . . . . . . . 55322. Tracing status information . . . . . . . 60023. DMAPI configuration attributes . . . . . 66124. Specific DMAPI functions and associated

error codes. . . . . . . . . . . . . 69125. GPFS programming interfaces . . . . . . 69726. GPFS user exits . . . . . . . . . . . 86527. List of parameters . . . . . . . . . . 94928. List of parameters . . . . . . . . . . 95329. List of parameters . . . . . . . . . . 95930. List of parameters . . . . . . . . . . 96631. List of parameters . . . . . . . . . . 97132. List of parameters . . . . . . . . . . 97933. List of parameters . . . . . . . . . . 98634. List of parameters . . . . . . . . . . 98935. List of request parameters . . . . . . . 99436. List of parameters . . . . . . . . . . 99737. List of parameters . . . . . . . . . 100138. List of parameters . . . . . . . . . 100539. List of request parameters . . . . . . . 101240. List of request parameters . . . . . . . 101741. List of parameters . . . . . . . . . 102042. List of request parameters . . . . . . . 1026

43. List of request parameters . . . . . . . 103244. List of request parameters . . . . . . . 103545. List of request parameters . . . . . . . 103846. List of request parameters . . . . . . . 104247. List of request parameters . . . . . . . 104648. List of request parameters . . . . . . . 105449. List of request parameters . . . . . . . 105750. List of request parameters . . . . . . . 106051. List of request parameters . . . . . . . 106352. List of request parameters . . . . . . . 106653. List of request parameters . . . . . . . 106954. List of request parameters . . . . . . . 107255. List of request parameters . . . . . . . 107656. List of request parameters . . . . . . . 108057. List of request parameters . . . . . . . 108358. List of request parameters . . . . . . . 108659. List of request parameters . . . . . . . 108960. List of request parameters . . . . . . . 109561. List of request parameters . . . . . . . 109962. List of request parameters . . . . . . . 110263. List of request parameters . . . . . . . 110664. List of request parameters . . . . . . . 111065. List of request parameters . . . . . . . 111366. List of request parameters . . . . . . . 111767. List of request parameters . . . . . . . 112168. List of request parameters . . . . . . . 112469. List of request parameters . . . . . . . 112770. List of request parameters . . . . . . . 113171. List of request parameters . . . . . . . 113472. List of request parameters . . . . . . . 113773. List of request parameters . . . . . . . 114874. List of request parameters . . . . . . . 115275. List of request parameters . . . . . . . 115676. List of request parameters . . . . . . . 116177. List of request parameters . . . . . . . 116578. List of request parameters . . . . . . . 116979. List of request parameters . . . . . . . 117580. List of request parameters . . . . . . . 117881. List of request parameters . . . . . . . 118082. List of request parameters . . . . . . . 118583. List of request parameters . . . . . . . 120384. List of request parameters . . . . . . . 120785. List of request parameters . . . . . . . 121286. List of request parameters . . . . . . . 1215

© Copyright IBM Corp. 2014, 2018 vii

||

||

||

||||

||||||||

viii IBM Spectrum Scale 5.0.0: Command and Programming Reference

About this information

This edition applies to IBM Spectrum Scale™ version 5.0.0 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, 2018 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 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 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.0: 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 Setting up a Cloud services clusterv Installing and configuring IBM

Spectrum Scale management API

v Installing Active File Managementv Installing and upgrading AFM-based

Disaster Recovery

v Installing call homev Installing file audit loggingv 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 object packagesv Upgrading NFS packagesv Upgrading SMB packagesv Manually upgrading pmswiftv Manually upgrading the performance

monitoring tool

v Manually upgrading the IBMSpectrum Scale management GUI

v Upgrading Cloud servicesv Upgrading to IBM Cloud Object

Storage software level 3.7.2 and above

v Upgrading IBM Spectrum Scalecomponents with the installationtoolkit

v Migrating from Express Edition toStandard 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


xii IBM Spectrum Scale 5.0.0: 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 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.0: 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 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 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.0: 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 command



About this information xvii




v mmlsfileset commandv mmlsfs commandv mmlslicense commandv mmlsmgr commandv 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 mmwinservctl commandv spectrumscale command



xviii IBM Spectrum Scale 5.0.0: 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



About this information xix



IBM Spectrum Scale: Big Data andAnalytics Guide


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

BigInsights® 4.2.5 and HortonworksData Platform 2.6

v Planning– Hardware requirements

– Preparing the environment

– Preparing a stanza file

v Installation– Set up

– Installation of software stack

– BigInsights value-add services onIBM Spectrum Scale

v Upgrading software stack– Migrating from BI IOP to HDP

– Upgrading IBM Spectrum Scaleservice MPack

– Upgrading HDFS Transparency

– Upgrading IBM Spectrum Scale filesystem

– Upgrading to BI IOP 4.2.5



xx IBM Spectrum Scale 5.0.0: Command and Programming Reference

||



IBM Spectrum Scale: Big Data andAnalytics Guide

v Configuration– Setting up High Availability [HA]

– IBM Spectrum Scale configurationparameter checklist

– Dual-network deployment

– Manually starting services inAmbari

– Setting up local repository

– Configuring LogSearch

– Setting IBM Spectrum Scaleconfiguration for BigSQL

– Hadoop Kafka/Zookeeper andIBM Spectrum ScaleKafka/Zookeeper

v Administration– IBM Spectrum Scale-FPO

deployment

– Ranger

– Kerberos

– Short-circuit read (SSR)

– Disabling short circuit write

– IBM Spectrum Scale servicemanagement

– Ambari node management

– Restricting root access

– IBM Spectrum Scale managementGUI

– IBM Spectrum Scale versus NativeHDFS

v Troubleshooting– Snap data collection

v Limitations– Limitations and information

v FAQ– General

– Service fails to start

– Service check failures



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 KnowledgeCenter(www.ibm.com/support/knowledgecenter/STXKQY/gpfsclustersfaq.html).

About this information xxi

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.

xxii IBM Spectrum Scale 5.0.0: Command and Programming Reference

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.0: 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.0as updated, November 2018

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 Compression policy is supported. For more information, see File compression in IBM SpectrumScale: Administration Guide.

v ILM for snapshots is supported. For more information, see ILM for snapshots in IBM SpectrumScale: Administration Guide.

v Throttling the number of filesets to perform recoveries on the gateway node. For moreinformation, see Gateway node failure and recovery in IBM Spectrum Scale: Concepts, Planning, andInstallation Guide.

v Improved hashing algorithm to load balance filesets across gateway nodes. For moreinformation, see Primary gateway in IBM Spectrum Scale: Concepts, Planning, and InstallationGuide.

v Configuration parameters have been added - afmMaxParallelRecoveries,afmAsyncOpWaitTimeout, afmSyncOpWaitTimeout, and afmRevalOpWaitTimeout. For moreinformation, see Configuration parameters for AFM and Configuration parameters for AFM-based DRin IBM Spectrum Scale: Administration Guide.

v Configuration parameters have been modified - afmRPO and afmHashVersion. For moreinformation, see Configuration parameters for AFM and Configuration parameters for AFM-based DRin IBM Spectrum Scale: Administration Guide.

Authentication: Primary group selection configurable for AD + RFC2307 based authenticationAbility to choose primary group as set in "UNIX attributes" of a user on Active Directoryintroduced with AD + RFC2307 based authentication scheme. Earlier, Windows primary groupwas by default selected as the primary group.

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

IBM Spectrum Scale management API changesAdded the following new commands:v GET /perfmon/datav GET /filesystems/{filesystemName}/afm/statev DELETE /nodes/{name}v POST /nodesv GET /nodeclassesv POST /nodeclassesv DELETE /nodeclasses/{nodeclassName}v GET /nodeclasses/{nodeclassName}

© Copyright IBM Corp. 2014, 2018 xxv

|||

||

|

||

||

|||

|||

||||

|||

||||

|||

||

|

|

|

|

|

|

|

|

https://www.ibm.com/support/knowledgecenter/STXKQY_BDA_SHR/bl1bda_soc.htm?cp=STXKQY_5.0.0https://www.ibm.com/support/knowledgecenter/STXKQY_BDA_SHR/bl1bda_soc.htm?cp=STXKQY_5.0.0

v PUT /nodeclasses/{nodeclassName}v DELETE /jobs/jobIdv POST /filesystems/{filesystemName}/filesets/{filesetName}/psnapsv DELETE /filesystems/{filesystemName}/filesets/{filesetName}/psnaps/{snapshotName}v GET /thresholdsv GET /thresholds/{name}v POST /thresholdsv DELETE /thresholds/{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.

The JSON object structure is modified for the following API commands:

/clusterrshSudoWrapper, rcpSudoWrapper: Changed type from String to Boolean

/filesetsMoved filesetName and filesystemName out of the config object.

/nfs/exportsRemoved the config object and moved the attributes one level up.

/nsds and /disksRemoved the config object and moved the attributes one level up.

quorumDisk: Changed type from String to Boolean.

size, availableBlocks, availableFragments: Changed type from String to Long. Values are nowin bytes.

/smb/sharesRemoved the config object and moved the attributes one level up.

/snapshotsRemoved the config object and moved the attributes one level up.

IBM Spectrum Scale GUI changesThe following changes are made to the GUI:v Added new Networks page to monitor the performance, configuration, and adapters of

network configurations in the cluster. You can monitor the network performance with respectto the IP and RDMA interfaces used in the configuration. For more information, see Monitoringnetworks in IBM Spectrum Scale: Problem Determination Guide.

v Added new Monitoring > Thresholds page to create and monitor the threshold rules that aredefined in the system. For more information, see Monitoring thresholds in IBM Spectrum Scale:Problem Determination Guide.

v Added Access > Remote Connections page to enable the GUI node of the local cluster tomonitor the remote cluster by establishing a connection with the GUI node of the remotecluster. For more information, see Monitoring remote cluster through GUI in IBM Spectrum Scale:Problem Determination Guide.

v Added Settings > Call Home page to configure call home. Configuring the call home featurehelps the IBM Support to monitor the system. Configuring call home also helps to reduce theresponse time of the IBM Support to resolve any issues.The diagnostic data that is downloaded through the Settings > Diagnostic Data can beuploaded to a problem management record (PMR) by using the call home feature in the

xxvi IBM Spectrum Scale 5.0.0: Command and Programming Reference

|

|

|

|

|

|

|

|

|||||

|

||

||

||

||

|

||

||

||

||

||||

|||

||||

|||

||

backend. To upload the diagnostic data, right-click the relevant data set from the PreviouslyCollected Diagnostic Data, and select Upload to PMR.For more information, see Configuringcall home using GUI in IBM Spectrum Scale: Problem Determination Guide.

v Added the file system creation capabilities in GUI. Use the Files > File Systems > Create FileSystem option to launch the Create File System wizard. In the Create File System wizard, youcan specify the following details of the file system:– File system name– Storage pools– NSDs for the file systems– Failure groups– NSD order for data writes– Maximum number of Spectrum Scale clients– Maximum number of inodes of the root fileset– Whether to enable quota and scope for the quota definition– Whether to enable DMAPI– Mount point and automatic mount mode

For more information, see Creating and managing file systems using GUI in IBM Spectrum Scale:Administration Guide.

v Added the aggregation levels Access Point and Filesets and removed Account for the resourcetype Transparent Cloud Tiering in the Monitoring > Statistics page.

v The Files > Transparent Cloud Tiering page now displays the file systems and filesets that aremapped with the TCT services. It also shows the connection of such a container pairconfiguration to a cloud account and the corresponding CSAP that is configured for the cloudaccount.

v Changed and updated information in the Added DMPs for TIP events page. The DMPs helpthe users resolve issues that are associated with the tip events. For more information, see theDirected maintenance procedures for tip events topic in the IBM Spectrum Scale: ProblemDetermination Guide.

v Changes to capacity monitoring in the GUIThe following changes are made to the capacity monitoring options in the GUI:– Moved the Capacity page from Monitoring to Files menu in the navigation and renamed

the GUI page to User Capacity.– Only the file data user capacity can be viewed from the Files > User Capacity page.

Removed the pools, filesets, file system capacity monitoring options from the Files > UserCapacity page. You can monitor the capacity of these components from the respective GUIpages.

– Replaced the GPFSPoolCap sensor with the GPFSPool sensor and separate data andmetadata level capacity monitoring are introduced in the performance charts available in theFiles > File Systems and Storage > Pools pages.

– New GPFSPool-based data and metadata performance monitoring metrics are available forselection in the Files > Statistics > Edit > Capacity section. You need to select theaggregation level as Pool to view these metrics.

For more information, see Monitoring capacity through GUI in IBM Spectrum Scale: ProblemDetermination Guide.

v AFM monitoring changes in the GUIThe following AFM monitoring features are introduced:– Provides the number of AFM filesets and the corresponding export server maps. Each export

map establishes a mapping between the gateway node and the NFS host name to allowparallel data transfers from cache to home.

Summary of changes xxvii

|||

|||

|

|

|

|

|

|

|

|

|

|

||

||

||||

||||

|

|

||

||||

|||

|||

||

|

|

|||

– By using the Request Access option available in the Files > Active File Management orAccess > Remote Connection page in the GUI, you can now establish connection withremote clusters. After establishing the connection, you can monitor the following AFM andAFM DR configuration details across clusters:- On home and secondary, you can see the AFM relationships configuration, health status,

and performance values of the Cache and Disaster Recovery grids.- On the Overview tab of the detailed view, the available home and secondary inodes are

available.- On the Overview tab of the detailed view, the details such as NFS throughput, IOPs, and

latency details are available, if the protocol is NFS.

For more information, see Monitoring AFM and AFM DR using GUI in IBM Spectrum Scale:Problem Determination Guide.

v New option to create AFM peer snapshots through GUI. Use the Create Peer Snapshot optionin the Files > Snapshots page to create peer snapshots. You can view and delete these peersnapshots from the Snapshots page and also from the detailed view of the Files > Active FileManagement page.

IBM Spectrum Scale functionality to support GDPR requirementsTo understand the requirements of EU General Data Protection Regulation (GDPR) compliancethat are applicable to unstructured data storage and how IBM Spectrum Scale helps to addressthem, see the IBM Spectrum Scale functionality to support GDPR requirements technote.

Encryption: GSKit V8 improves cryptographic performance on IBM POWER8®

The IBM Global Security Kit (GSKit) Version 8 and later improves cryptographic performance onIBM POWER8 hardware. For more information, see the IBM article GSKIT V8 Support for PKCS#11device integration and on-CPU acceleration (https://www.ibm.com/developerworks/community/wikis/home?lang=en#!/wiki/W746177d414b9_4c5f_9095_5b8657ff8e9d/page/PKCS%2311%20device%20integration). The version of GSKit that is shipped with IBM Spectrum Scale v5.0.0offers better performance on POWER8, compared with the versions shipped with earlier releases.

File audit loggingFile audit logging is a new capability in IBM Spectrum Scale v5.0.0. File audit logging takeslocally generated file system events and puts them on a multinode message queue from whichthey are consumed and written to a retention enabled fileset. These events, called lightweightevents, occur at the file system level. They are protocol agnostic, which means that they captureall access to a monitored file system from protocol exports to even root access that occurs directlyon nodes. File audit logging is integrated into the system health infrastructure. Alerts aregenerated for elements of the message queue and the processes that consume the events andcreate the audit logs. For more information, see Introduction to file audit logging in the IBMSpectrum Scale: Concepts, Planning, and Installation Guide.

File compression: The lz4 library provides fast access to compressed dataFile compression supports the lz4 compression library. Lz4 is intended primarily for active dataand favors read-access speed over maximized space saving. For more information, see the topicFile compression in the IBM Spectrum Scale: Administration Guide.

File data: Smaller subblock sizes improve I/O performance and reduce fragmentationSubblock sizes are smaller relative to block sizes; for example, a 4 MiB block uses 8 KiBsubblocks. The same choice of data block sizes is available, but the default data block size islarger, 4 MiB instead of 256 KiB. A larger block size improves the file system performance and asmaller subblock size reduces the amount of unused space. For many business applications, thedefault value of 4 MiB provides the best balance of improved performance and reducedfragmentation. For more information, see mmcrfs command in the IBM Spectrum Scale: Commandand Programming Reference. This feature is supported only for file systems that are created at filesystem format number 18.00 (IBM Spectrum Scale 5.0.0.0) or later.

xxviii IBM Spectrum Scale 5.0.0: Command and Programming Reference

||||

||

||

||

||

||||

||||

|||||||

||||||||||

||||

|||||||||

http://w3-03.ibm.com/support/techdocs/atsmastr.nsf/WebIndex/TD106420https://www.ibm.com/developerworks/community/wikis/home?lang=en#!/wiki/W746177d414b9_4c5f_9095_5b8657ff8e9d/page/PKCS%2311%20device%20integrationhttps://www.ibm.com/developerworks/community/wikis/home?lang=en#!/wiki/W746177d414b9_4c5f_9095_5b8657ff8e9d/page/PKCS%2311%20device%20integrationhttps://www.ibm.com/developerworks/community/wikis/home?lang=en#!/wiki/W746177d414b9_4c5f_9095_5b8657ff8e9d/page/PKCS%2311%20device%20integration

File encryption: AES-XTS encryption is faster on x86 in non-FIPS modeOn x86 architecture in non-FIPS mode, file encryption with the AES algorithm in XTS mode isfaster than it was. For more information, see the topics Encryption policy rules and Encryption andFIPS-140-2 certification in the IBM Spectrum Scale: Administration Guide.

File systems: File system rebalancing is fasterRebalancing is implemented by a lenient round-robin method that typically runs faster than thepreviously used method of strict round robin. The strict round robin method is available as anoption. For more information, see the topics mmrestripefs command, mmrestripefile command,mmadddisk command, and mmdeldisk command in the IBM Spectrum Scale: Command and ProgrammingReference.

Installation toolkit changes

v The installation toolkit has added support for the installation and the deployment of protocoland client nodes in a cluster that contains Elastic Storage Server (ESS). For more information,see ESS awareness with the installation toolkit in IBM Spectrum Scale: Concepts, Planning, andInstallation Guide.

v The installation toolkit has added support for enabling and configuring call home. For moreinformation, see Enabling and configuring call home using the installation toolkit in IBM SpectrumScale: Concepts, Planning, and Installation Guide.

v The installation toolkit has added support for enabling and configuring file audit logging. Formore information, see Enabling and configuring file audit logging using the installation toolkit inIBM Spectrum Scale: Concepts, Planning, and Installation Guide.

v The installation toolkit has added support for the installation and the deployment of IBMSpectrum Scale on Ubuntu 16.04 LTS nodes.

v The installation toolkit has added support for the installation and the deployment of IBMSpectrum Scale on Red Hat Enterprise Linux 7.4 nodes.

v The installation toolkit has added verification of passwordless SSH during prechecks beforeinstallation, deployment, or upgrade.

v The installation toolkit has added support for cumulative object upgrade.

mmafmctl commandThe --outband parameter is deprecated.

mmcallhome command: Enhancements

Addition of -Y optionThe -Y displays the command output in a parseable format with a colon (:) as a fielddelimiter.

Addition of --pmr optionThe --pmr option allows you to upload data to existing PMRs using the mmcallhome runSendFile command. For more information, see mmcallhome command in the IBM SpectrumScale: Command and Programming Reference.

mmchconfig command: Enhancements

Encrypted files can be copied into an LROC deviceWith the lrocEnableStoringClearText attribute, you can control whether file data fromencrypted files, which is held in memory as cleartext, is copied into a local read-onlycache (LROC) device.

InfiniBand addresses can be specified for RDMA transfersIn the verbsPorts attribute, you can specify InfiniBand addresses for RDMA transfersbetween an NSD client and server.

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

Summary of changes xxix

||||

||||||

|

||||

|||

|||

||

||

||

|

||

|

|||

||||

|

||||

|||

||

mmchnsd command: Change NSDs without unmounting the file systemWhen you add or remove NSDs or do other operations with mmchnsd, you do not need tounmount the file system. For more information, see the topic mmchnsd command in the IBMSpectrum Scale: Command and Programming Reference.

mmcrfs command: Enhancements

The default data block size is 4 MiB with an 8 KiB subblock sizeIf no block size is specified, a file system is created with a 4 MiB block size and an 8 KiBsubblock size. The minimum release level (minReleaseLevel) of the cluster must be 5.0.0or greater when the file system is created. For more information, see the entry File data:Smaller subblock sizes improve I/O performance and reduce fragmentation earlier inthis topic.

The default log file size depends on block size and metadata sizeIf the block size is 512 KiB or larger and the metadata block size 256 KiB or larger, thenthe default log file size is 32 MiB. Otherwise, the default log file size is 4 MiB or themetadata block size, whichever is larger. For more information, see the topic mmcrfscommand in the IBM Spectrum Scale: Command and Programming Reference.

The default method for updating atime is relatimeIf the minimum release level (minReleaseLevel) of the cluster is 5.0.0 or greater when thefile system is created, the default method for updating atime is relatime. For moreinformation, see the topics mmcrfs command and mmchfs command in the IBM SpectrumScale: Command and Programming Reference.

mmdsh command: Several options are no longer supportedThe --ignoreSignal, -I, and -d options are no longer supported. Do not use these options unlessinstructed to by IBM support personnel. For more information, see the topic mmdsh command inthe IBM Spectrum Scale: Command and Programming Reference.

mmfsck command: Display an interim status report at any timeWhile a long-running instance of mmfsck is in progress, you can start another instance of mmfsckwith the --status-report parameter to display current status information from all the nodes thatare participating in the mmfsck run. For more information, see the topic mmfsck command in theIBM Spectrum Scale: Command and Programming Reference.

mmgetstate command: Display the unresponsive stateThe command returns the unresponsive state when the GPFS daemon is running but is notresponding. For more information, see the topic mmgetstate command in the IBM Spectrum Scale:Command and Programming Reference.

mmhealth command: Addition to measurement optionsMeasurement options for filesystem, SMB node, and NFS node has been added to the mmhealthcommand. For more information, see the topic mmhealth command in the IBM Spectrum Scale:Command and Programming Reference.

mmkeyserv command: The simplified setup method supports certificate chains from a certificateauthority.

In the simplified setup, with the --kmip-cert parameter, you can set up encryption with IBM®

Security Key Lifecycle Manager (SKLM) as the key management server and with a certificatesigned by a certificate authority (CA) on the KMIP port of the SKLM server. For moreinformation, see the topic mmkeyserv command in the IBM Spectrum Scale: Command andProgramming Reference.

mmnetverify command: Enhancements

Verify the network operation of nodes in a subnetWith the --subnets parameters, you can specify the subnet addresses of the nodes thatyou want to verify.

xxx IBM Spectrum Scale 5.0.0: Command and Programming Reference

||||

|

||||||

|||||

|||||

||||

|||||

||||

||||

|||||||

|

|||

Verify that nodes can handle a new MTU sizeWith the ping-packet-size parameter, you can specify the size of the ICMP echo requestpackets that are sent between local node and the target node during the ping test.

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

mmpmon command: EnhancementsA new option loc_io_s is added to mmpmon command. It stands for locality I/O statistics.

mmtracectl command: Display the tracing statusThe --status parameter displays the tracing status of the specified nodes. For more information,see mmtracectl command in the IBM Spectrum Scale: Command and Programming Reference.

Threshold monitoring enhancementsIf multiple thresholds rules have overlapping entities for the same metrics, only one of theconcurrent rules is made actively eligible. For more information, see the New features for thresholdmonitoring section in Threshold monitoring for system health topic in the IBM Spectrum Scale: ProblemDetermination Guide.

NFS: Dynamic export changesYou can dynamically change the export configuration without restarting the NFS service. Formore information, see the Changing NFS export configuration topic in the IBM Spectrum Scale:Administration Guide.

Object changesThe following changes have been done.v Object protocol support is extended to Ubuntu 16.04 LTS.v The sudo wrapper for object is added on Ubuntu 16.04 LTS.v Cumulative object upgrades from older versions are supported.v Object snap enhancement are done to contain Keystone logs.

Protocol support: EnhancedNFS, SMB, and object support is extended to Ubuntu 16.04 LTS.

Setting up a system for storing crash files for UbuntuSupport is added to set up a system for storing crash files for Ubuntu. For more information, seethe Setting up an Ubuntu system to capture crash files topic in the IBM Spectrum Scale: ProblemDetermination Guide.

SMB: DFS redirects for SMB sharesNew option to configure DFS redirects for SMB shares. For more information, see mmsmbcommand in the IBM Spectrum Scale: Command and Programming Reference.

SMB: SMB server upgrade changesTwo events on CTDB version match/mismatch are added to the RAS events. For moreinformation, see the RAS events topic in the IBM Spectrum Scale: Problem Determination Guide.

Sudo wrappers: Root-level processes can call administration commands directlyRoot-level background processes, such as cron and callback programs, can successfully calladministration commands directly rather than through sudo when sudo wrappers are enabled.For more information, see Root-level processes that call administration commands directly in the IBMSpectrum Scale: Administration Guide.

Cloud services changesThe following enhancements are made:v A new robust set of CLI functions, which allow for much greater configuration of the system.v Support for multiple cloud storage accountsv Support for multiple file systems or filesets per node group

Summary of changes xxxi

|||

||

||

|||

|||||

||||

||

|

|

|

|

||

||||

|||

|||

|||||

||

|

|

|

v Enhanced support for large file systems provided by container spilloverv Support for associating file sets with containers for enhanced granularityv Multiple URL and region support at the node levelv Support for creating a Cloud services separately for tiering and sharing operations. For more

information, see the Creating Cloud services topic in the IBM Spectrum Scale: Administration Guide.v Unique encryption key per cloud containerv Support for remotely mounted clients. For more information, see the Setting up Transparent

cloud tiering service on a remotely mounted client topic in the IBM Spectrum Scale: AdministrationGuide.

v Support for Amazon S3 regions requiring Sigv4 security support, including the US governmentcloud region.

v Ability to enable or disable transparent recall for files for a given file system instantly, withouthaving to rewrite a policy.

v Support for backing up and restoring the Cloud services configuration in case of any disaster.For more information, see the Backing up the Cloud services configuration topic in the IBMSpectrum Scale: Administration Guide.

v Support for backing up the Cloud services database to the cloud. For more information, see theBacking up the Cloud services database to the cloud topic in the IBM Spectrum Scale: AdministrationGuide.

v Support for restoring Transparent cloud tiering service on an identical backup cluster. For moreinformation, see the Restoring Transparent Cloud services on a backup cluster topic in the IBMSpectrum Scale: Administration Guide.

v Support for checking the integrity of the Cloud services database after any system crash oroutage. For more information, see the Checking the Cloud services database integrity topic in theIBM Spectrum Scale: Administration Guide.

v Support for auditing events relating to each operation performed in Cloud services. For moreinformation, see the Cloud services audit events topic in the IBM Spectrum Scale: ProblemDetermination Guide.

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

New commandsThese commands are new in this release.v mmauditv mmmsgqueue

New structuresThere are no new structures.

New subroutinesThere are no new subroutines.

Changed commandsThe following commands were changed:v mmafmctlv mmadddiskv mmcallhomev mmchattrv mmchclusterv mmchconfigv mmchfsv mmchnsd

xxxii IBM Spectrum Scale 5.0.0: Command and Programming Reference

|

|

|

||

|

|||

||

||

|||

|||

|||

|||

|||

||

||

|

|

||

||

||

|

|

|

|

|

|

|

|

v mmcloudgatewayv mmcrclusterv mmcrfsv mmdeldiskv mmdshv mmfsckv mmgetstatev mmkeyservv mmnetverifyv mmnfsv mmpmonv mmrestripefilev mmrestripefsv mmsmbv mmtracectlv mmuserauthv spectrumscale

Changed structuresThere are no changed structures.

Changed subroutinesThere are no changed subroutines.

Deleted commandsmmrest

Deleted structuresThere are no deleted structures.

Deleted subroutinesThere are no deleted subroutines.

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

New messages6027-1264, 6027-1757, 6027-2394, 6027-2395, 6027-2396, 6027-2397, 6027-2398, 6027-2399,6027-2400, 6027-2401, 6027-3259, 6027-3408, 6027-3597, 6027-3598, 6027-3599, 6027-3600,6027-3601, 6027-3602, 6027-3603, 6027-3604, 6027-3730, 6027-3921, 6027-3922, 6027-3923,6027-3924, 6027-3925, 6027-3926, 6027-3927, 6027-3928, 6027-3929, 6027-3930, 6027-3931,and 6027-4019.

Changed messages6027-928

Deleted messagesNone.

Changes in documentation

Separate sections for installing and upgrading documentationThe Installing and upgrading section is split into two separate sections:v Installingv Upgrading

Summary of changes xxxiii

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

|

||

||

||

||

||

||

||||||

||

||

|

||

|

|

Terminology change in upgrade documentationIn the upgrade documentation, the instances of “migration” are replaced with “upgrade”.

Product name changesThe following product name changes are done:v z System is renamed to IBM Zv Linux on IBM Z is renamed to Linux on Z

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 The following sub-sections are moved from the Introduction to Cloudservices topic to Library and related publications → Applying IBMSpectrum Scale:

v Transparent cloud tiering use casesv Supported Cloud data sharing use casesv Supported WORM storage use cases

Installing v Creating a user-defined node class for Transparent cloud tiering orCloud data sharing topic is moved from the Configuring section tothe Installing section

v The IBM Spectrum Scale packaging overview topic is moved onelevel up.

v The following topics and their sub-topics are removed. Thecontent in these topics is now covered in Manually installing IBMSpectrum Scale and deploying protocols on Linux nodes and itssub-topics.

– Manually installing IBM Spectrum Scale on Red Hat EnterpriseLinux 7.x systems

– Manually installing IBM Spectrum Scale on SLES 12 systems

Upgrading The upgrade topics have been reordered to bring out the upgradeflow more clearly and separate manual and installation toolkittopics clearly.

Administration Guide Configuring The following topics are removed from the Configuring and tuningyour system for Cloud services section:

v Pre-validating the cloud account settingsv Associating a file system with Cloud services nodes

Administering Moved the Manual recovery of Transparent cloud tiering database topicunder Administering files for Transparent cloud tiering section

Changes in the Library and related publications section

A Video resources topic was added in this section. This topic contains links to IBMSpectrum Scale videos.

xxxiv IBM Spectrum Scale 5.0.0: 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 7 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

“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 56 Provides a list of cached files and file statistics such as inodenumber, allocated blocks, and so on.

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

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

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

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

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

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

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

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

“mmces command” on page 109 Manages CES configuration.

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

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

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

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

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

© Copyright IBM Corp. 2014, 2018 1

Table 4. GPFS commands (continued)

Command Purpose

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

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

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

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

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

“mmchnode command” on page 200 Changes node attributes.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2 IBM Spectrum Scale 5.0.0: Command and Programming Reference


Command Purpose

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

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

“mmedquota command” on page 342 Sets quota limits.

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

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

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

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

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

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

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

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

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

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

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

“mmlsattr command” on page 413 Queries file attributes.

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

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

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

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

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

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

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

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

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

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

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

“mmlspolicy command” on page 448 Displays policy information.

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

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

Chapter 1. Command reference 3


Command Purpose

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

“mmsetquota command” on page 575 Sets quota limits.

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

4 IBM Spectrum Scale 5.0.0: Command and Programming Reference


Command Purpose

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

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

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

“mmtracectl command” on page 599

Date post:	29-Aug-2019
Category:	Documents
Upload:	ngodien
View:	281 times
Download:	1 times

IBM Spectrum Scale 5.0.0: Command and Programming Reference · Command and Programming Reference...

Documents