IBM Spectrum ScaleVersion 4 Release 2.2

Command and ProgrammingReference

SA23-1456-05

IBM

IBM Spectrum ScaleVersion 4 Release 2.2

Command and ProgrammingReference

SA23-1456-05

IBM

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

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

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 xii. 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, 2017.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 . . . . . . xiConventions used in this information . . . . . . xiHow to send your comments . . . . . . . . xii

Summary of changes . . . . . . . . xiii

Chapter 1. Command reference. . . . . 1gpfs.snap command . . . . . . . . . . . . 6mmaddcallback command . . . . . . . . . 10mmadddisk command. . . . . . . . . . . 23mmaddnode command . . . . . . . . . . 29mmadquery command. . . . . . . . . . . 32mmafmconfig command . . . . . . . . . . 37mmafmctl command . . . . . . . . . . . 40mmafmlocal command . . . . . . . . . . 54mmapplypolicy command . . . . . . . . . 56mmauth command . . . . . . . . . . . . 67mmbackup command . . . . . . . . . . . 72mmbackupconfig command . . . . . . . . . 81mmblock command . . . . . . . . . . . 83mmbuildgpl command . . . . . . . . . . 87mmcallhome command . . . . . . . . . . 89mmces command . . . . . . . . . . . . 101mmcesdr command . . . . . . . . . . . 111mmchattr command . . . . . . . . . . . 120mmchcluster command . . . . . . . . . . 126mmchconfig command . . . . . . . . . . 130mmchdisk command . . . . . . . . . . . 158mmcheckquota command . . . . . . . . . 166mmchfileset command . . . . . . . . . . 170mmchfs command. . . . . . . . . . . . 176mmchlicense command . . . . . . . . . . 182mmchmgr command . . . . . . . . . . . 185mmchnode command . . . . . . . . . . 187mmchnodeclass command . . . . . . . . . 192mmchnsd command . . . . . . . . . . . 195mmchpolicy command . . . . . . . . . . 198mmchpool command . . . . . . . . . . . 201mmchqos command . . . . . . . . . . . 203mmclone command . . . . . . . . . . . 210mmcloudgateway command . . . . . . . . 213mmcrcluster command . . . . . . . . . . 230mmcrfileset command . . . . . . . . . . 235mmcrfs command . . . . . . . . . . . . 241mmcrnodeclass command . . . . . . . . . 251mmcrnsd command . . . . . . . . . . . 253mmcrsnapshot command . . . . . . . . . 258mmdefedquota command . . . . . . . . . 263mmdefquotaoff command . . . . . . . . . 266mmdefquotaon command . . . . . . . . . 269mmdefragfs command . . . . . . . . . . 272mmdelacl command . . . . . . . . . . . 275

mmdelcallback command . . . . . . . . . 277mmdeldisk command . . . . . . . . . . 278mmdelfileset command . . . . . . . . . . 283mmdelfs command . . . . . . . . . . . 286mmdelnode command . . . . . . . . . . 288mmdelnodeclass command . . . . . . . . . 291mmdelnsd command . . . . . . . . . . . 293mmdelsnapshot command . . . . . . . . . 295mmdf command . . . . . . . . . . . . 299mmdiag command . . . . . . . . . . . 302mmdsh command . . . . . . . . . . . . 308mmeditacl command . . . . . . . . . . . 311mmedquota command . . . . . . . . . . 314mmexportfs command . . . . . . . . . . 318mmfsck command. . . . . . . . . . . . 320mmfsctl command. . . . . . . . . . . . 329mmgetacl command . . . . . . . . . . . 333mmgetstate command . . . . . . . . . . 336mmhadoopctl command. . . . . . . . . . 339mmhealth command . . . . . . . . . . . 340mmimgbackup command . . . . . . . . . 348mmimgrestore command . . . . . . . . . 352mmimportfs command . . . . . . . . . . 355mmkeyserv command . . . . . . . . . . 359mmlinkfileset command . . . . . . . . . . 369mmlsattr command . . . . . . . . . . . 371mmlscallback command . . . . . . . . . . 374mmlscluster command . . . . . . . . . . 376mmlsconfig command . . . . . . . . . . 379mmlsdisk command . . . . . . . . . . . 381mmlsfileset command . . . . . . . . . . 385mmlsfs command . . . . . . . . . . . . 389mmlslicense command . . . . . . . . . . 393mmlsmgr command . . . . . . . . . . . 395mmlsmount command . . . . . . . . . . 397mmlsnodeclass command . . . . . . . . . 399mmlsnsd command . . . . . . . . . . . 401mmlspolicy command . . . . . . . . . . 404mmlspool command . . . . . . . . . . . 406mmlsqos command . . . . . . . . . . . 408mmlsquota command. . . . . . . . . . . 411mmlssnapshot command . . . . . . . . . 415mmmigratefs command . . . . . . . . . . 418mmmount command . . . . . . . . . . . 420mmnetverify command . . . . . . . . . . 422mmnfs command . . . . . . . . . . . . 428mmnsddiscover command . . . . . . . . . 438mmobj command . . . . . . . . . . . . 440mmperfmon command . . . . . . . . . . 455mmpmon command . . . . . . . . . . . 466mmprotocoltrace command. . . . . . . . . 471mmpsnap command . . . . . . . . . . . 475mmputacl command . . . . . . . . . . . 478mmquotaoff command . . . . . . . . . . 481mmquotaon command . . . . . . . . . . 483mmremotecluster command . . . . . . . . 485

Copyright IBM Corp. 2014, 2017 iii

||

||

||

mmremotefs command . . . . . . . . . . 488mmrepquota command . . . . . . . . . . 491mmrest command . . . . . . . . . . . . 495mmrestoreconfig command. . . . . . . . . 499mmrestorefs command . . . . . . . . . . 503mmrestripefile command . . . . . . . . . 507mmrestripefs command . . . . . . . . . . 510mmrpldisk command. . . . . . . . . . . 517mmsdrrestore command. . . . . . . . . . 524mmsetquota command . . . . . . . . . . 526mmshutdown command. . . . . . . . . . 530mmsmb command. . . . . . . . . . . . 532mmsnapdir command . . . . . . . . . . 543mmstartup command. . . . . . . . . . . 547mmtracectl command. . . . . . . . . . . 549mmumount command . . . . . . . . . . 553mmunlinkfileset command . . . . . . . . . 556mmuserauth command . . . . . . . . . . 559mmwinservctl command . . . . . . . . . 579spectrumscale command. . . . . . . . . . 581

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

GPFS-specific DMAPI events . . . . . . . 599DMAPI functions . . . . . . . . . . . 600DMAPI configuration attributes . . . . . . 604DMAPI restrictions for GPFS . . . . . . . 605

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

Sessions . . . . . . . . . . . . . . 606Data management events . . . . . . . . 606Mount and unmount . . . . . . . . . . 608Tokens and access rights . . . . . . . . 609Parallelism in Data Management applications 610Data Management attributes . . . . . . . 611Support for NFS . . . . . . . . . . . 611Quota . . . . . . . . . . . . . . . 611Memory mapped files . . . . . . . . . 611

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

Required files for implementation of DataManagement applications . . . . . . . . 612GPFS configuration attributes for DMAPI . . . 613Enabling DMAPI for a file system . . . . . 614Initializing the Data Management application 615

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

Enhancements to data structures . . . . . . 615Usage restrictions on DMAPI functions. . . . 617Definitions for GPFS-specific DMAPI functions 618Semantic changes to DMAPI functions . . . . 632GPFS-specific DMAPI events . . . . . . . 633Additional error codes returned by DMAPIfunctions . . . . . . . . . . . . . . 634

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

Single-node failure . . . . . . . . . . 636

Session failure and recovery . . . . . . . 637Event recovery . . . . . . . . . . . . 637Loss of access rights . . . . . . . . . . 638DODeferred deletions . . . . . . . . . 638DM application failure . . . . . . . . . 638

Chapter 3. GPFS programminginterfaces . . . . . . . . . . . . . 641gpfs_acl_t structure . . . . . . . . . . . 644gpfs_clone_copy() subroutine . . . . . . . . 645gpfs_clone_snap() subroutine . . . . . . . . 647gpfs_clone_split() subroutine . . . . . . . . 649gpfs_clone_unsnap() subroutine . . . . . . . 651gpfs_close_inodescan() subroutine . . . . . . 653gpfs_cmp_fssnapid() subroutine . . . . . . . 654gpfs_declone() subroutine . . . . . . . . . 656gpfs_direntx_t structure . . . . . . . . . . 658gpfs_direntx64_t structure . . . . . . . . . 660gpfs_fcntl() subroutine . . . . . . . . . . 662gpfs_fgetattrs() subroutine . . . . . . . . . 665gpfs_fputattrs() subroutine . . . . . . . . . 667gpfs_fputattrswithpathname() subroutine . . . . 669gpfs_free_fssnaphandle() subroutine . . . . . . 671gpfs_fssnap_handle_t structure . . . . . . . 672gpfs_fssnap_id_t structure . . . . . . . . . 673gpfs_fstat() subroutine . . . . . . . . . . 674gpfs_fstat_x() subroutine . . . . . . . . . 676gpfs_get_fsname_from_fssnaphandle() subroutine 678gpfs_get_fssnaphandle_by_fssnapid() subroutine 679gpfs_get_fssnaphandle_by_name() subroutine . . 681gpfs_get_fssnaphandle_