SNIA Swordfish®
SNIA Swordfish®
The SNIA Swordfish® specification helps to provide a unified approach for the management of storage and servers in hyperscale and cloud infrastructure environments, making it easier for IT administrators to integrate scalable solutions into their data centers. SNIA Swordfish is an extension of the DMTF Redfish specification, so the same easy-to-use RESTful interface is used, along with JavaScript Object Notation (JSON) and Open Data Protocol (OData), to seamlessly manage storage equipment and storage services in addition to servers.
SwordfishSNIA Swordfish is designed to integrate with the technologies used in cloud data center environments and can be used to accomplish a broad range of storage management tasks from the simple to the advanced.
SNIA Swordfish has been designed around management use cases that focus on what IT administrators need to do with storage equipment and storage services in a data center. As a result, the API provides functionality that simplifies the way storage can be allocated, monitored, and managed.
Release Date: 21 May 2024
Version: 1.2.7
| Title | Bundle Component | File |
|---|---|---|
| Swordfish Release Bundle | Each transmission character is prefixed with either binary "01" or binary "10". This, combined with scrambling, gives the signal desirable engineering properties, yeThe Swordfish Release Bundle contains all of the components that comprise the versioned Swordfish Release. Included documents are: the Swordfish Specification, User’s Guide, Error Handling Guide, NVMe Model Overview and Mapping Guide, Property Guide, Metrics White Paper and Swordfish Interoperability Guide. Included technical content: Swordfish schema and registries bundle, Swordfish profiles bundle, and Swordfish templates bundle.t incurs a much lower overhead than the traditional 8b/10b encoding. | Second 24G SAS Plugfest Completed by the SCSI Trade Association Highlights the Reliability of the Proven Storage Interface |
| Heading | Each transmission character is prefixed with either binary "01" or binary "10". This, combined with scrambling, gives the signal desirable engineering properties, yet incurs a much lower overhead than the traditional 8b/10b encoding. | Inaugural 24G SAS Plugfest Completed by the SCSI Trade Association Highlights the Investment Protection of the Proven Storage Interface |
| Swordfish Schema and Registries Bundle | This bundle contains the schemas defined for JSON resources conforming to the Redfish Specification. Each schema definition is available in CSDL (XML), json, and yaml formats. This bundle also contains the standard dictionary files to support Redfish Device Enablement (RDE), as well as the Swordfish registry files. | Large Build Configurations of Storage Systems Using 12Gb/s SAS Data Interfaces Tested at SCSI Trade Association Plugfest Event |
| Heading | Each transmission character is prefixed with either binary "01" or binary "10". This, combined with scrambling, gives the signal desirable engineering properties, yet incurs a much lower overhead than the traditional 8b/10b encoding. | Volume Deployment and Final Standardization of 12Gb/s SAS Data Storage Interface Boosts SCSI Trade Association’s Plugfest Event |
| Swordfish Templates Bundle | This bundle contains templates for Swordfish metrics and telemetry. These templates show the recommended functionality for Swordfish implementations to enable both basic and enhanced metrics. | 12Gb/s SAS Data Storage Interface Advances; SCSI Trade Association Holds Plugfest Event While Specification Goes to Letter Ballot |
| Heading | Each transmission character is prefixed with either binary "01" or binary "10". This, combined with scrambling, gives the signal desirable engineering properties, yet incurs a much lower overhead than the traditional 8b/10b encoding. | 12 Gb/s SAS Data Storage Interface at the Forefront of the 13th SCSI Trade Association Plugfest Event |
| Swordfish Scalable Storage Management Error Handling Guide | The Swordfish Scalable Storage Management Error Handling Guide provides a summary of the preferred handling of errors and error messages in a Swordfish implementation. | SAS Data Center Storage Advancements Highlight the 12th SCSI Trade Association Plugfest Event |
| Swordfish NVMe Model Overview and Mapping Guide | The Swordfish NVMe Model Overview and Mapping Guide defines the model to manage NVMe and NVMe-oF storage systems with Redfish and Swordfish. It provides the detailed mapping information between the NVMe, NVMe-oF specifications and the Redfish and Swordfish specifications. | SAS ‘Goes Deep’ at the 11th STA/UNH Plugfest Event |
| Swordfish Property Guide | The Property Guide provides a listing of the properties used in the Swordfish schema. It is intended primarily for end users and other consumers of Swordfish data to look up property definitions, without requiring a detailed knowledge of the schema as a whole. | Industry Comes Together to Test 6Gb/s SAS |
| Swordfish Interoperability Guide | The Swordfish Interoperability Guide is a comprehensive reference guide to the Swordfish-specific extensions to the Swordfish Interoperability profile syntax, as well as a detailed usage guide for Swordfish features and profiles. | SCSI Trade Association Held First 6Gb/s SAS Plugfest November 10-14, 2008 |
Developer Resources
SNIA has developed a wealth of vendor-neutral content on all technologies related to data. Check out our many videos, webinars, white papers, and more.
Swordfish Forum
This site contains discussions about the SNIA Swordfish Specification, protocol, profiles and schema. Swordfish feature requests may be submitted here as well.
Swordfish Mockups
This site contains discussions about the SNIA Swordfish Specification, protocol, profiles and schema. Swordfish feature requests may be submitted here as well.
Swordfish Containers available on Docker Hub
This site contains discussions about the SNIA Swordfish Specification, protocol, profiles and schema. Swordfish feature requests may be submitted here as well.
Open
Source Tools
SNIA’s Storage Management Initiative sponsored the initial development of open source software tools that can help developers start working with Swordfish. These tools are already available in open repositories that are managed by the SNIA SSM TWG on GitHub. Brief descriptions of these open source software tools are given below. Installation instructions are provided within each tool’s repository, along with basic documentation for users and developers.
| Title | Bundle Component |
|---|---|
| Swordfish Release Bundle | Each transmission character is prefixed with either binary "01" or binary "10". This, combined with scrambling, gives the signal desirable engineering properties, yeThe Swordfish Release Bundle contains all of the components that comprise the versioned Swordfish Release. Included documents are: the Swordfish Specification, User’s Guide, Error Handling Guide, NVMe Model Overview and Mapping Guide, Property Guide, Metrics White Paper and Swordfish Interoperability Guide. Included technical content: Swordfish schema and registries bundle, Swordfish profiles bundle, and Swordfish templates bundle.t incurs a much lower overhead than the traditional 8b/10b encoding. |
| Heading | Each transmission character is prefixed with either binary "01" or binary "10". This, combined with scrambling, gives the signal desirable engineering properties, yet incurs a much lower overhead than the traditional 8b/10b encoding. |
| Swordfish Schema and Registries Bundle | This bundle contains the schemas defined for JSON resources conforming to the Redfish Specification. Each schema definition is available in CSDL (XML), json, and yaml formats. This bundle also contains the standard dictionary files to support Redfish Device Enablement (RDE), as well as the Swordfish registry files. |
| Heading | Each transmission character is prefixed with either binary "01" or binary "10". This, combined with scrambling, gives the signal desirable engineering properties, yet incurs a much lower overhead than the traditional 8b/10b encoding. |
| Swordfish Templates Bundle | This bundle contains templates for Swordfish metrics and telemetry. These templates show the recommended functionality for Swordfish implementations to enable both basic and enhanced metrics. |
| Heading | Each transmission character is prefixed with either binary "01" or binary "10". This, combined with scrambling, gives the signal desirable engineering properties, yet incurs a much lower overhead than the traditional 8b/10b encoding. |
| Swordfish Scalable Storage Management Error Handling Guide | The Swordfish Scalable Storage Management Error Handling Guide provides a summary of the preferred handling of errors and error messages in a Swordfish implementation. |
| Swordfish NVMe Model Overview and Mapping Guide | The Swordfish NVMe Model Overview and Mapping Guide defines the model to manage NVMe and NVMe-oF storage systems with Redfish and Swordfish. It provides the detailed mapping information between the NVMe, NVMe-oF specifications and the Redfish and Swordfish specifications. |
| Swordfish Property Guide | The Property Guide provides a listing of the properties used in the Swordfish schema. It is intended primarily for end users and other consumers of Swordfish data to look up property definitions, without requiring a detailed knowledge of the schema as a whole. |
| Swordfish Interoperability Guide | The Swordfish Interoperability Guide is a comprehensive reference guide to the Swordfish-specific extensions to the Swordfish Interoperability profile syntax, as well as a detailed usage guide for Swordfish features and profiles. |
Technical Work
More Information
Contact the SNIA Swordfish Development Team at
[email protected]
Shipping Commercial CDMI Servers
- Swordfish School of Videos on YouTube
- Swordfish presentations, webcasts, white papers and more in our Educational Library
- Redfish Developer Hub
- Redfish API Information
- Storage Management Blog
Videos
The Minimum Requirements for SNIA Swordfish™
NVMe and NVMe-oF Configuration and Manageability with Swordfish and Redfish