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.

Swordfish

SNIA 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.

Working Draft Full Release

Release Date: 21 May 2024
Version: 1.2.7

Swordfish 1.2.7 contains the new Swordfish Interoperability Guide, a comprehensive reference guide to the Swordfish-specific extensions to the profile syntax, and a detailed usage guide for Swordfish features and profiles. The Swordfish Features Registry has also been enhanced to support resource-level features. The release also contains new NVMe functionality for NVMe, expanding to include support for Command and Feature Lockdown via a trio of commands: ConfigurationLock, TargetConfigurationLockLevel and ConfigurationlockState.

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

Previous Versions

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.

Learn More

Swordfish Mockups

This site contains the latest public (static) mockups of SNIA Swordfish, a description of the contents, and pointers to client tools that may be helpful.

Learn More

Swordfish Containers available on Docker Hub

This site contains downloadable instances of each of the Swordfish mockup configurations, each instantiated in an independent instance of the Swordfish emulator.

Learn More

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.

Development Tool	Description
Swordfish API Emulator	The Swordfish API Emulator can emulate a Swordfish-based system that responds to create, read, update, and delete RESTful API operations to allow developers to model new Swordfish functionality, test clients, demonstrate Swordfish, and do other similar functions. The Swordfish API Emulator extends the DMTF Redfish Interface Emulator, adding code that supports dynamic interactions with all of the Swordfish schema. The Swordfish API Emulator code is maintained on GitHub by the SNIA, and the Redfish Interface Emulator code is maintained on GitHub by the DMTF.
Swordfish Basic Web Client	The Swordfish Basic Web Client can connect to one or more Swordfish services (including the Swordfish API Emulator), and present in a web UI frame the entire Redfish and Swordfish hierarchy. The Swordfish Basic Web Client provides basic capabilities for managing multiple services simultaneously, modifying configurable Properties and adding or removing elements from the service through the web UI.
Swordfish Datadog Sample Dashboard Integration	The Swordfish Datadog sample dashboard integration provides a dashboard for the Datadog monitoring service that can connect to a Swordfish service (including the Swordfish emulator), and provides an integration to the Datadog UI. It provides connectivity to a Swordfish service and displays system capacity information trending over time, configured capacity thresholds, and alert information based on crossing those thresholds.
Swordfish PowerBI Sample Dashboard Integration	The Swordfish Power BI sample dashboard integration provides a dashboard for the Power BI data center monitoring system that can connect to a Swordfish service (including the Swordfish emulator), and provides an integration to the Power BI UI. It provides connectivity to a Swordfish service and displays system capacity information and configured capacity thresholds.
Swordfish Powershell Toolkit	The PowerShell Toolkit for Swordfish provides a basic framework for querying resources from the SNIA API Emulator. The SNIASwordFish PowerShell Module can be used with Microsoft Windows, Windows Server, macOS or Linux. Below is an example of a connected SwordFish target being used with macOS and PowerShell for Linux (v6.1).
Gofish	Gofish is a Golang client library for DMTF Redfish and SNIA Swordfish interaction. For an overview of the Golang client, watch this video Golang Support for SNIA Swordfish™ from SDC 2019.

Technical Work

More Information

Contact the SNIA Swordfish Development Team at
[email protected]

Shipping Commercial CDMI Servers

Videos

The Minimum Requirements for SNIA Swordfish™

NVMe and NVMe-oF Configuration and Manageability with Swordfish and Redfish