IBM Storage Scale native REST API

Use this table to access IBM Storage Scale documentation for the IBM Storage Scale native REST API feature.

Table 1. Quick reference for the IBM Storage Scale native REST API documentation
For this information... Go to...
An overview of native REST API and description of the concepts:
  • Non-root administration daemon (scaleadmd)
  • Authentication
  • Role-based access control
  • API nodes for native REST API
  • Long-running operations
  • Target nodes and node classes option
  • Pagination
  • Views and fields option
  • Update masks
  • Limitations
IBM Storage Scale native REST API
To know how to plan for native REST API
  • Planning for systemd
 Planning for IBM Storage Scale native REST API
To know how to install native REST API
  • Installing native REST API with the installation toolkit
  • Manually installing native REST API with the RPM
 Installing IBM Storage Scale native REST API
To know how to configure native REST API for the following requirements:
  • Changing cluster configuration data with native REST API
  • Configuring node identities
  • Coexistence of native REST API with the mm-commands CLI
  • SSH and SCP replacements with native REST API
 Configuring IBM Storage Scale native REST API
To know how to administer native REST API
  • Migrating an existing IBM Storage Scale cluster from the mm-commands CLI to the use of native REST API
  • Firewall considerations for native REST API
  • Remote cluster support
To know how to monitor native REST API Monitoring IBM Storage Scale native REST API
To know how to troubleshoot native REST API for the following issues:
  • Common errors
  • Logs
  • Request IDs
  • Debugging
  • Debugging node identities
  • Troubleshooting persistent reserve issues
 Troubleshooting IBM Storage Scale native REST API
IBM Storage Scale native REST API endpoints:
  • API-health endpoints
  • Authorization endpoints
  • Cluster endpoints
  • Configuration endpoints
  • Diagnostics endpoints
  • File system endpoints
  • File system disk endpoints
  • Fileset endpoints
  • Manager endpoints
  • Node endpoints
  • Node class endpoints
  • NSD endpoints
  • Operations endpoints
  • Policy endpoints
  • Remote cluster endpoints
  • Remote file system endpoints
  • Snapshot endpoints
  • Storage pool endpoints
  • Troubleshooting endpoints
  • Version endpoints
 IBM Storage Scale native REST API endpoints
IBM Storage Scale native REST API commands:
  • scalectl apihealth command
  • scalectl authorization command
  • scalectl cluster command
  • scalectl config command
  • scalectl diagnostics command
  • scalectl filesystem command
  • scalectl fileset command
  • scalectl node command
  • scalectl nodeclass command
  • scalectl nsd command
  • scalectl operations command
  • scalectl policy command
  • scalectl troubleshooting command
 scalectl command