Start of change

Product documentation in guide format

Contains IBM Spectrum Scale™ product documentation in PDF and EPUB formats.

Guide name Description Links
Concepts, Planning, and Installation Guide This guide provides information about the following sections:
Product overview
  • IBM Spectrum Scale product editions
  • IBM Spectrum Scale license designation
  • Overview of GPFS™
  • GPFS architecture
  • Protocols support overview: Integration of protocol access methods with GPFS
  • Active File Management
  • AFM-based Asynchronous Disaster Recovery (AFM DR)
  • Introduction to IBM Spectrum Scale GUI
  • Introduction to Transparent Cloud Tiering
  • IBM Spectrum Scale in an OpenStack cloud deployment
Planning
  • Planning for GPFS
  • Planning for protocols
  • Considerations for GPFS applications
  • Firewall recommendations
  • Planning for Transparent Cloud Tiering
Installing and upgrading
  • Steps to establishing and starting your GPFS cluster
  • Installing IBM Spectrum Scale on Linux nodes and deploying protocols
  • Installing IBM Spectrum Scale on AIX® nodes
  • Installing IBM Spectrum Scale on Windows nodes
  • Installing Transparent Cloud Tiering on IBM Spectrum Scale nodes
  • Installing Active File Management
  • Installing AFM-based Disaster Recovery
  • Migration, coexistence and compatibility
  • Steps to permanently uninstall GPFS and/or Protocols
Administration Guide This guide provides information about the following sections:
Configuring
  • Configuring the GPFS cluster
  • Configuring the CES and protocol configuration
  • Configuring and tuning your system for GPFS
  • Parameters for performance tuning and optimization
  • Configuring and tuning your system for Transparent Cloud Tiering
  • Configuring Active File Management
  • Configuring AFM-based DR
  • Tuning for kNFS backend on AFM and AFM DR
Administering
  • Performing GPFS administration tasks
  • Managing file systems
  • File system format changes between versions of GPFS
  • Managing disks
  • Managing protocol services
  • Managing protocol user authentication
  • Managing protocol data exports
  • Managing object storage
  • Managing GPFS quotas
  • Managing GUI administrators
  • Managing GPFS access control lists
  • Considerations for GPFS applications
  • Accessing a remote GPFS file system
  • Information lifecycle management for IBM Spectrum Scale
  • Creating and maintaining snapshots of file systems
  • Creating and managing file clones
  • Scale Out Backup and Restore (SOBAR)
  • Data Mirroring and Replication
  • Implementing a clustered NFS environment on Linux
  • Implementing Cluster Export Services
  • Identity management on Windows
  • Protocols cluster disaster recovery
  • File Placement Optimizer
  • Hadoop support for IBM Spectrum Scale
  • Encryption
  • Managing certificates to secure communications between GUI web server and web browsers
  • Securing protocol data
  • Transparent Cloud Tiering
  • Highly-available write cache (HAWC)
  • Local read-only cache
  • Miscellaneous advanced administration topics
  • GUI limitations
Problem Determination Guide This guide provides information about the following sections:
Monitoring
  1. Performance monitoring
  2. Monitoring system health through the IBM Spectrum Scale GUI
  3. Monitoring system health using the mmhealth command
  4. Monitoring events through callbacks
  5. Monitoring AFM
  6. Monitoring AFM DR
  7. GPFS SNMP support
  8. Monitoring the IBM Spectrum Scale system remotely by using call home
  9. Monitoring the health of Transparent Cloud Tiering service
Troubleshooting
  • Best practices for troubleshooting
  • Understanding the system limitations
  • Collecting details of the issues
  • Managing deadlocks
  • Installation and configuration issues
  • Network issues
  • File system issues
  • Disk issues
  • Security issues
  • Protocol issues
  • Disaster recovery issues
  • Performance issues
  • GUI issues
  • AFM issues
  • AFM DR issues
  • Transparent Cloud Tiering issues
  • Recovery procedures
  • Support for troubleshooting
  • References
Command and Programming Reference This guide provides information about the following sections:
Command reference
  1. gpfs.snap command
  2. mmaddcallback command
  3. mmadddisk command
  4. mmaddnode command
  5. mmadquery command
  6. mmafmconfig command
  7. mmafmctl command
  8. mmafmlocal command
  9. mmapplypolicy command
  10. mmauth command
  11. mmbackup command
  12. mmbackupconfig command
  13. mmbuildgpl command
  14. mmcallhome command
  15. mmces command
  16. mmcesdr command
  17. mmchattr command
  18. mmchcluster command
  19. mmchconfig command
  20. mmchdisk command
  21. mmcheckquota command
  22. mmchfileset command
  23. mmchfs command
  24. mmchlicense command
  25. mmchmgr command
  26. mmchnode command
  27. mmchnodeclass command
  28. mmchnsd command
  29. mmchpolicy command
  30. mmchpool command
  31. mmchqos command
  32. mmclone command
  33. mmcrcluster command
  34. mmcloudgateway command
  35. mmcrfileset command
  36. mmcrfs command
  37. mmcrnodeclass command
  38. mmcrnsd command
  39. mmcrsnapshot command
  40. mmdefedquota command
  41. mmdefquotaoff command
  42. mmdefquotaon command
  43. mmdefragfs command
  44. mmdelacl command
  45. mmdelcallback command
  46. mmdeldisk command
  47. mmdelfileset command
  48. mmdelfs command
  49. mmdelnode command
  50. mmdelnodeclass command
  51. mmdelnsd command
  52. mmdelsnapshot command
  53. mmdf command
  54. mmdiag command
  55. mmeditacl command
  56. mmedquota command
  57. mmexportfs command
  58. mmfsck command
  59. mmfsctl command
  60. mmgetacl command
  61. mmgetstate command
  62. mmhadoopctl command
  63. mmhealth command
  64. mmimgbackup command
  65. mmimgrestore command
  66. mmimportfs command
  67. mmkeyserv command
  68. mmlinkfileset command
  69. mmlsattr command
  70. mmlscallback command
  71. mmlscluster command
  72. mmlsconfig command
  73. mmlsdisk command
  74. mmlsfileset command
  75. mmlsfs command
  76. mmlslicense command
  77. mmlsmgr command
  78. mmlsmount command
  79. mmlsnodeclass command
  80. mmlsnsd command
  81. mmlspolicy command
  82. mmlspool command
  83. mmlsqos command
  84. mmlsquota command
  85. mmlssnapshot command
  86. mmmigratefs command
  87. mmmount command
  88. mmnfs command
  89. mmnsddiscover command
  90. mmobj command
  91. mmperfmon command
  92. mmpmon command
  93. mmprotocoltrace command
  94. mmpsnap command
  95. mmputacl command
  96. mmquotaoff command
  97. mmquotaon command
  98. mmremotecluster command
  99. mmremotefs command
  100. mmrepquota command
  101. mmrestoreconfig command
  102. mmrestorefs command
  103. mmrestripefile command
  104. mmrestripefs command
  105. mmrpldisk command
  106. mmsdrrestore command
  107. mmsetquota command
  108. mmshutdown command
  109. mmsmb command
  110. mmsnapdir command
  111. mmstartup command
  112. mmtracectl command
  113. mmumount command
  114. mmunlinkfileset command
  115. mmuserauth command
  116. mmwinservctl command
  117. spectrumscale command
Programming reference
  • IBM Spectrum Scale Data Management API for GPFS information
  • GPFS programming interfaces
  • GPFS user exits
End of change