Overview
ISO/IEC 5965:2023 - "Information technology - Swordfish Scalable Storage Management API Specification" - defines a standardized, RESTful API and data model for managing storage and related data services at scale. Published as the second edition in 2023, it formalizes the Swordfish API (prepared by SNIA) as an ISO/IEC standard and extends the DMTF Redfish Scalable Platforms Management API (DSP0266). The standard targets customer‑centric, scalable storage management through well‑defined resource schemas and HTTP semantics.
Key topics and technical requirements
- RESTful interface: Standardized use of HTTP methods, status codes and resource addressing for storage operations, creation, update and delete semantics.
- Schema‑based data model: Extensive JSON schema definitions for resources such as Storage, Volume, StoragePool, FileSystem, StorageGroup, StorageService and NVMeDomain.
- NVMe and NVMe‑oF support: Added support for management of NVMe and NVMe‑over‑Fabrics devices and domains.
- Profile and feature registry: Expanded profiles (Access Rights, Connectivity Rights, Management Controllers, NVMe EBOF/JBOF, NVMe‑oF, etc.) and updates to the FeaturesRegistry to enable conformance and interoperability.
- Security and device controls: Enhanced security requirements including SecureErase for NVMe drives and improved CHAP usage for storage authentication.
- Standalone configuration: A simplified Swordfish Standalone Configuration in the /Storage collection to make single‑system implementations easier to instrument.
- Schema and action enhancements: Volume and StoragePool enhancements (new Actions like ChangeRAIDLayout, ForceEnable), addition of NVMeFirmwareImage and domain schemas, and migration from NetworkPort to Port.
- Implementation constraints: Guidance on discovery, events, ClassOfService, entity addressing, and required behavior for HTTP responses.
Practical applications
- Automating storage provisioning, snapshots, replication and firmware updates across arrays and disaggregated NVMe systems.
- Integrating storage hardware and software into orchestration platforms, cloud control planes, and datacenter management tools.
- Enabling interoperable management APIs for OEMs, system integrators and third‑party storage management software.
- Supporting SRE/site‑reliability and automation workflows that require consistent REST APIs for storage telemetry and actions.
Who should use this standard
- Storage hardware vendors and firmware developers implementing management endpoints
- Cloud and datacenter operators and SRE teams building automation/orchestration
- Systems integrators and software vendors that require interoperable storage APIs
- Test and QA teams validating storage conformance and interoperability
Related standards
- DMTF Redfish Scalable Platforms Management API Specification (DSP0266) - Swordfish extends this Redfish foundation.
- ISO/IEC 5965:2021 - the prior edition, superseded by the 2023 release.
Keywords: ISO/IEC 5965:2023, Swordfish, Scalable Storage Management API, Redfish, NVMe, NVMe‑oF, storage API, storage automation, storage schemas, storage profiles.