Advancing Storage and Information Technology
 
 

Swordfish Release Archive

Working Drafts

Version: 
1.2.4
Working Draft
Release Date: 
12 April 2022

Version 1.2.4 of Swordfish adds enhanced support for NVMe and NVMe-oF configurations, with detailed requirements for JBOF and EBOFs, and NVMe-oF fabric-attached configurations. The release also includes corresponding enhancements to the NVMe Model Overview and Mapping Guide. It includes new content in both the User’s Guide and the Error Handling Guide, and includes the new white paper “Metrics and Telemetry in Swordfish”.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
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.
ZIP
Swordfish Profile Bundle
This bundle contains all the Swordfish profiles. The Swordfish Core Profiles define the set of features and the corresponding detailed profiles define the required functionality to implement Swordfish.
ZIP
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.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
Swordfish Metrics White Paper
This paper defines the approach, infrastructure and mechanisms to use for Swordfish implementations, to capture and store historical metrics to present to Swordfish clients in a standardized fashion, using the Redfish telemetry service. The examples provided focus on capacity and performance instrumentation, but additional standardized definitions may be provided separately.
PDF, HTML
Version: 
1.2.3
Working Draft
Release Date: 
30 August 2021

Version 1.2.3 of Swordfish adds enhanced support for NVMe advanced devices (such as arrays), with detailed requirements for front-end configuration specified in a new profile, enhancements to the NVMe Model Overview and Mapping Guide. It also includes new content in both the User’s Guide and the Error Handling Guide.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
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.
ZIP
Swordfish Profile Bundle
This bundle contains all the Swordfish profiles. The Swordfish Core Profiles define the set of features and the corresponding detailed profiles define the required functionality to implement Swordfish.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
Version: 
1.2.2
Working Draft
Release Date: 
22 March 2021

v1.2.2 adds NVMe drive profiles and corresponding details in the NVMe mapping document. It also includes the new Swordfish Property Guide. See included manifest (in the release bundle) for additional change details.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
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.
ZIP
Swordfish Profile Bundle
This bundle contains all the Swordfish profiles. The Swordfish Core Profiles define the set of features and the corresponding detailed profiles define the required functionality to implement Swordfish.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
Version: 
1.2.1c
Working Draft
Release Date: 
20 October 2020

Specification updates include additional Redfish URI annotations.

Latest v1.2.1 bundle. See included manifest for change details.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
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.
ZIP
Swordfish Profile Bundle
This bundle contains all the Swordfish profiles. The Swordfish Core Profiles define the set of features and the corresponding detailed profiles define the required functionality to implement Swordfish.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
Version: 
1.2.1a
Working Draft
Release Date: 
29 September 2020

Updated JSON and YAML schema copyrights, and YAML OpenSchema reference
changed to v4 instead of v4.0.3.

Specification:

  • Added bibliography
  • Updated TLS references
Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
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.
ZIP
Swordfish Profile Bundle
This bundle contains all the Swordfish profiles. The Swordfish Core Profiles define the set of features and the corresponding detailed profiles define the required functionality to implement Swordfish.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
Version: 
1.2.1
Working Draft
Release Date: 
18 August 2020

Latest v1.2.1 bundle. See included manifest for change details.

The Profiles zip file contains the Swordfish profiles released as part of the Swordfish v1.2.1 release.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
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.
ZIP
Swordfish Profile Bundle
This bundle contains all the Swordfish profiles. The Swordfish Core Profiles define the set of features and the corresponding detailed profiles define the required functionality to implement Swordfish.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
Version: 
1.2.0
Working Draft
Release Date: 
29 May 2020

This version adds:

  • The addition of the Swordfish Standalone Configuration in the /Storage collection at the ServiceRoot. This simplification of the hierarchy features Storage systems at the ServiceRoot and makes standalone implementations easier to instrument.
  • Added support to Volume for new Actions: ChangeRAIDLayout, ForceEnable.
  • Added InitializeMethod, IOPerfModeEnabled, and OwningStorageResource and link to JournalingMedia to Volume.
  • Enhanced CHAP definitions and usage in StorageGroup.
  • Fix multiple URI issues across various schema.
  • Add additional enum members:
    • None to RAIDType
    • Off to WriteCachePolicy
  • Enhanced support for RDE Dictionaries
  • Add LinesOfService to StorageService
Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF, HTML
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.
PDF, HTML
Version: 
1.1.0
Working Draft
Release Date: 
22 August 2019

Specification:

  • Restructured to add features and profiles
    • Add description of SupportedFeatures usage and requirements
    • Add requirements for subsets of features
  • Add language to clarify support for use with and without the class of service (now an optional feature)
  • Added descriptions of support for seamless extension of Redfish Storage model to Swordfish
  • Add updated model diagrams to reflect new model permutations
  • Added descriptions of new constructs (e.g., Consistency Groups)
  • Cleaned up references to Redfish Specification based on latest version
  • Add Status Codes clarification and constraints section
    See bundle manifest for full v1.1.0 change details.
Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
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.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF, HTML
Version: 
1.0.7a
Working Draft
Release Date: 
8 November 2018

Updated spare capacity management model, added OpenAPI support, Added iSCSI properties for CHAP, Event usage enhancements and guidance and Volume schema updates

  • Updated Enhanced Spare Capacity Management Model
  • Deprecated Remaining Capacity
  • Added OpenAPI support: schema references and OpenAPI YAML files
  • Added iSCSI properties for CHAP
  • Event usage enhancements and guidance
  • Volume schema updates – RAID Type enum (deprecating VolumeType usage), add ReplicaTargets
Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
Version: 
1.0.6
Working Draft
Release Date: 
13 February 2018

Updated storage systems models, schema, and User’s guide updates.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF
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.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF
Version: 
1.0.5
Working Draft
Release Date: 
3 October 2017

Schema, Mockup and User's Guide update

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
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.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF, HTML
Version: 
1.0.4
Working Draft
Release Date: 
17 April 2017

Schema and User’s Guide update

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF
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.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF
Version: 
1.0.2a
Working Draft
Release Date: 
18 November 2016

Schema update

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF
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.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF
Version: 
1.0.2
Working Draft
Release Date: 
16 November 2016

See v.1.0.2a for Schema update

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF
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.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF
Version: 
1.0.1
Working Draft
Release Date: 
16 October 2016
Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF
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.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF
Version: 
1.0.0
Working Draft
Release Date: 
19 September 2016
Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF
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.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF

Full Releases

Version: 
1.2.4a
Full Release
Release Date: 
12 July 2022

Version 1.2.4a of Swordfish adds enhanced support for NVMe and NVMe-oF configurations, with detailed requirements for JBOF and EBOFs, and NVMe-oF fabric-attached configurations. The release also includes corresponding enhancements to the NVMe Model Overview and Mapping Guide. It includes new content in both the User’s Guide and the Error Handling Guide, and includes the new white paper “Metrics and Telemetry in Swordfish”.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
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.
ZIP
Swordfish Profile Bundle
This bundle contains all the Swordfish profiles. The Swordfish Core Profiles define the set of features and the corresponding detailed profiles define the required functionality to implement Swordfish.
ZIP
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.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
Swordfish Metrics White Paper
This paper defines the approach, infrastructure and mechanisms to use for Swordfish implementations, to capture and store historical metrics to present to Swordfish clients in a standardized fashion, using the Redfish telemetry service. The examples provided focus on capacity and performance instrumentation, but additional standardized definitions may be provided separately.
PDF, HTML
Version: 
1.2.3
Full Release
Release Date: 
5 December 2021

Version 1.2.3 of Swordfish adds enhanced support for NVMe advanced devices (such as arrays), with detailed requirements for front-end configuration specified in a new profile, enhancements to the NVMe Model Overview and Mapping Guide. It also includes new content in both the User’s Guide and the Error Handling Guide.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
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.
ZIP
Swordfish Profile Bundle
This bundle contains all the Swordfish profiles. The Swordfish Core Profiles define the set of features and the corresponding detailed profiles define the required functionality to implement Swordfish.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
Version: 
1.2.2a
Full Release
Release Date: 
14 June 2021

v1.2.2a adds NVMe drive profiles and corresponding details in the NVMe Model Overview and Mapping Guide. It also includes the new Swordfish Property Guide. See included manifest (in the release bundle) for additional change details.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
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.
ZIP
Swordfish Profile Bundle
This bundle contains all the Swordfish profiles. The Swordfish Core Profiles define the set of features and the corresponding detailed profiles define the required functionality to implement Swordfish.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
Version: 
1.2.1c
Full Release
Release Date: 
31 October 2020

Specification updates include additional Redfish URI annotations.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
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.
ZIP
Swordfish Profile Bundle
This bundle contains all the Swordfish profiles. The Swordfish Core Profiles define the set of features and the corresponding detailed profiles define the required functionality to implement Swordfish.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF, HTML
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.
PDF, HTML
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.
PDF, HTML
Version: 
1.1.0d
Full Release
Release Date: 
29 September 2020

Latest v1.1.0 bundle. See included manifest for change details.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF
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.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF
Version: 
1.1.0c
Full Release
Release Date: 
16 June 2020

Latest v1.1.0 bundle. See included manifest for change details.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF
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.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF
Version: 
1.1.0b
Full Release
Release Date: 
24 March 2020

Latest v1.1.0 bundle. See included manifest for change details.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
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.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF
Version: 
1.1.0a
Full Release
Release Date: 
14 January 2020

Latest v1.1.0 bundle. See included manifest for change details.

Updated January 14, 2020 with updated RDE Dictionary schema to correct a build issue.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF
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.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF
Version: 
1.0.7a
Full Release
Release Date: 
23 December 2018

Latest v1.0.7a bundle. See included manifest for change details.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
Version: 
1.0.6
Full Release
Release Date: 
25 May 2018

Latest v1.0.6 bundle. See included manifest for change details.

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF, HTML
Version: 
1.0.3
Full Release
Release Date: 
24 January 2017

Latest v1.0 bundle

Bundle Component
Files
Swordfish Release Bundle
The 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, and NVMe Model Overview and Mapping Guide. Included technical content: Swordfish schema bundle and Swordfish profiles bundle.
ZIP
Swordfish Scalable Storage Management API Specification
Swordfish extends the Redfish Scalable Platforms Management API Specification to define a comprehensive, RESTful API for storage management that addresses block storage, file systems, object storage, and storage network infrastructure.
PDF, HTML
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.
ZIP
Swordfish Scalable Storage Management API User’s Guide
This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API.
PDF