Sorry, you need to enable JavaScript to visit this website.

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.

Right Image 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

1.2.8

Working Draft

2025-01-20

Key updates and features of Swordfish v1.2.8 include:

  • Enhancements to the NVMe-oF™ white paper.
  • Updates to NVMe® functionality and mapping guide for namespace management
  • Advancements to filesystem use cases and mockups
  • Revisions to mapping and masking functionality
  • Expanded StoragePool Metrics

 

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

Swordfish_v1.2.8.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.

Swordfish_v1.2.8_Specification.html Swordfish_v1.2.8_Specification.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.

Swordfish_v1.2.8_Schema.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.

Swordfish_v1.2.8_Profiles.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.

Swordfish_v1.2.8_Templates.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.

Swordfish_v1.2.8_UserGuide.html Swordfish_v1.2.8_UserGuide.pdf

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_v1.2.8_ErrorGuide.html Swordfish_v1.2.8_ErrorGuide.pdf

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_v1.2.8_NVMeMappingGuide.html Swordfish_v1.2.8_NVMeMappingGuide.pdf

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_v1.2.8_PropertyGuide.html Swordfish_v1.2.8_PropertyGuide.pdf

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.

Swordfish_v1.2.8_InteropGuide.html Swordfish_v1.2.8_InteropGuide.pdf

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.

Swordfish_v1.2.8_MetricsWhitePaper.html Swordfish_v1.2.8_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

Swordfish_v1.2.8_NVMeoFWhitePaper.html Swordfish_v1.2.8_NVMeoFWhitePaper.pdf

1.2.7

Working Draft

2024-05-21

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.

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

Swordfish_v1.2.7.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.

Swordfish_v1.2.7_Specification.html Swordfish_v1.2.7_Specification.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.

Swordfish_v1.2.7_Schema.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.

Swordfish_v1.2.7_Profiles.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.

Swordfish_v1.2.7_Templates.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.

Swordfish_v1.2.7_UserGuide.html Swordfish_v1.2.7_UserGuide.pdf

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_v1.2.7_ErrorGuide.html Swordfish_v1.2.7_ErrorGuide.pdf

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_v1.2.7_NVMeMappingGuide.html Swordfish_v1.2.7_NVMeMappingGuide.pdf

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_v1.2.7_PropertyGuide.html Swordfish_v1.2.7_PropertyGuide.pdf

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.

Swordfish_v1.2.7_InteropGuide.html Swordfish_v1.2.7_InteropGuide.pdf

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.

Swordfish_v1.2.7_MetricsWhitePaper.html Swordfish_v1.2.7_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

Swordfish_v1.2.7_NVMeoFWhitePaper.html Swordfish_v1.2.7_NVMeoFWhitePaper.pdf

1.2.6

Working Draft

2024-01-22

Swordfish v.1.2.6 offers key features such as new metrics for FileSystem, StoragePool, StorageService, and enhancements to VolumeMetrics. It introduces new mapping and masking models using Connections in the Fabric model and deprecates StorageGroups. It also includes support for new volume properties: ProvidingStoragePool, ChangeStripSize, Asymmetric Logical Unit Access (ALUA) to manage reservations. Swordfish v.1.2.6 adds enhancements to NVMe Domain Management, including ALUA support. Finally, it offers updates to NVMe namespaces, such as simplified Logical Block Address (LBA) Format representation and multiple namespace management.

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

Swordfish_v1.2.6.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.

Swordfish_v1.2.6_Specification.html Swordfish_v1.2.6_Specification.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.

Swordfish_v1.2.6_Schema.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.

Swordfish_v1.2.6_Profiles.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.

Swordfish_v1.2.6_Templates.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.

Swordfish_v1.2.6_UserGuide.html Swordfish_v1.2.6_UserGuide.pdf

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_v1.2.6_ErrorGuide.html Swordfish_v1.2.6_ErrorGuide.pdf

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_v1.2.6_NVMeMappingGuide.html Swordfish_v1.2.6_NVMeMappingGuide.pdf

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_v1.2.6_PropertyGuide.html Swordfish_v1.2.6_PropertyGuide.pdf

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.

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.

Swordfish_v1.2.6_MetricsWhitePaper.html Swordfish_v1.2.6_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

Swordfish_v1.2.6_NVMeoFWhitePaper.html Swordfish_v1.2.6_NVMeoFWhitePaper.pdf

1.2.5

Working Draft

2023-03-14

Version 1.2.5 of Swordfish adds expanded support for Swordfish profiles and support to map Swordfish to the 2.0c version of the NVMe™ and NVMe-oF™ specifications in the Swordfish NVMe Model Overview and Mapping Guide. New functionality includes metrics for volumes, drives, and storage controllers, as well as support for NVMe SMART Metrics, enhanced NVMe-oF discovery controller capabilities managing NVMe-oF centralized discovery controllers. There are also enhancements to the storage connections model, used to provide an updated mapping and masking model. Other integrated functionality is delivered in conjunction with the Redfish 2023.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, 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.

Swordfish_v1.2.5.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.

Swordfish_v1.2.5_Specification.html Swordfish_v1.2.5_Specification.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.

Swordfish_v1.2.5_Schema.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.

Swordfish_v1.2.5_Profiles.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.

Swordfish_v1.2.5_Templates.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.

Swordfish_v1.2.5_UserGuide.html Swordfish_v1.2.5_UserGuide.pdf

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_v1.2.5_ErrorGuide.html Swordfish_v1.2.5_ErrorGuide.pdf

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_v1.2.5_NVMeMappingGuide.html Swordfish_v1.2.5_NVMeMappingGuide.pdf

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_v1.2.5_PropertyGuide.html Swordfish_v1.2.5_PropertyGuide.pdf

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.

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.

Swordfish_v1.2.5_MetricsWhitePaper.html Swordfish_v1.2.5_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.4

Working Draft

2022-04-12

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

Swordfish_v1.2.4.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.

Swordfish_v1.2.4_Specification.html Swordfish_v1.2.4_Specification.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.

Swordfish_v1.2.4_Schema.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.

Swordfish_v1.2.4_Profiles.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.

Swordfish_v1.2.4_Templates.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.

Swordfish_v1.2.4_UserGuide.html Swordfish_v1.2.4_UserGuide.pdf

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_v1.2.4_ErrorGuide.html Swordfish_v1.2.4_ErrorGuide.pdf

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_v1.2.4_NVMeMappingGuide.html Swordfish_v1.2.4_NVMeMappingGuide.pdf

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_v1.2.4_PropertyGuide.html Swordfish_v1.2.4_PropertyGuide.pdf

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.

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.

Swordfish_v1.2.4_MetricsWhitePaper.html Swordfish_v1.2.4_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.3

Working Draft

2021-08-30

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

Swordfish_v1.2.3.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.

Swordfish_v1.2.3_Specification.html Swordfish_v1.2.3_Specification.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.

Swordfish_v1.2.3_Schema.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.

Swordfish_v1.2.3_Profiles.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.

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.

Swordfish_v1.2.3_UserGuide.html Swordfish_v1.2.3_UserGuide.pdf

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_v1.2.3_ErrorGuide.html Swordfish_v1.2.3_ErrorGuide.pdf

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_v1.2.3_NVMeMappingGuide.html Swordfish_v1.2.3_NVMeMappingGuide.pdf

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_v1.2.3_PropertyGuide.html Swordfish_v1.2.3_PropertyGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.2

Working Draft

2021-03-22

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

Swordfish_v1.2.2.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.

Swordfish_v1.2.2_Specification.html Swordfish_v1.2.2_Specification.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.

Swordfish_v1.2.2_Schema.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.

Swordfish_v1.2.2_Profiles.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.

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.

Swordfish_v1.2.2_UserGuide.html Swordfish_v1.2.2_UserGuide.pdf

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_v1.2.2_ErrorGuide.html Swordfish_v1.2.2_ErrorGuide.pdf

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_v1.2.2_NVMeMappingGuide.html Swordfish_v1.2.2_NVMeMappingGuide.pdf

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_v1.2.2_PropertyGuide.html Swordfish_v1.2.2_PropertyGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.1c

Working Draft

2020-10-20

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

Swordfish_v1.2.1c.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.

Swordfish_v1.2.1c_Specification.html Swordfish_v1.2.1c_Specification.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.

Swordfish_v1.2.1c_Schema.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.

Swordfish_v1.2.1_Profiles.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.

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.

Swordfish_v1.2.1a_UserGuide.html Swordfish_v1.2.1_UserGuide.pdf

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_v1.2.1a_ErrorGuide.html Swordfish_v1.2.1_ErrorGuide.pdf

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_v1.2.1a_NVMeMappingGuide.html Swordfish_v1.2.1_NVMeMappingGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.1a

Working Draft

2020-09-29

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

Swordfish_v1.2.1a.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.

Swordfish_v1.2.1a_Specification.html Swordfish_v1.2.1a_Specification.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.

Swordfish_v1.2.1a_Schema.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.

Swordfish_v1.2.1_Profiles.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.

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.

Swordfish_v1.2.1a_UserGuide.html Swordfish_v1.2.1_UserGuide.pdf

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_v1.2.1a_ErrorGuide.html Swordfish_v1.2.1_ErrorGuide.pdf

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_v1.2.1a_NVMeMappingGuide.html Swordfish_v1.2.1_NVMeMappingGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.1

Working Draft

2020-08-18

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

Swordfish_v1.2.1.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.

Swordfish_v1.2.1_Specification.html Swordfish_v1.2.1_Specification.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.

Swordfish_v1.2.1_Schema.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.

Swordfish_v1.2.1_Profiles.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.

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.

Swordfish_v1.2.1_UserGuide.html Swordfish_v1.2.1_UserGuide.pdf

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_v1.2.1_ErrorGuide.html Swordfish_v1.2.1_ErrorGuide.pdf

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_v1.2.1_NVMeMappingGuide.html Swordfish_v1.2.1_NVMeMappingGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.0

Working Draft

2020-05-29

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

Swordfish_v1.2.0.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.

Swordfish_v1.2.0_Specification.html Swordfish_v1.2.0_Specification.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.

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.

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.

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.

Swordfish_v1.2.0_UserGuide.html Swordfish_v1.2.0_UserGuide.pdf

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_v1.2.0_ErrorGuide.html Swordfish_v1.2.0_ErrorGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.1.0

Working Draft

2019-08-22

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

Swordfish_v1.1.0.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.

Swordfish_v1.1.0_Specification.html Swordfish_v1.1.0_Specification.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.

Swordfish_v1.1.0_Schema.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.

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.

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.

Swordfish_v1.1.0_UserGuide.html Swordfish_v1.1.0_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.7a

Working Draft

2018-11-08

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

Swordfish_v1.0.7a.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.

Swordfish_v1.0.7a_Specfication.html Swordfish_v1.0.7a_Specification.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.

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.

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.

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.

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.6

Working Draft

2018-02-13

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

Swordfish_v1.0.6.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.

Swordfish_v1.0.6_Specification.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.

Swordfish_v1.0.6_Schema.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.

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.

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.

Swordfish_v1.0.6_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.5

Working Draft

2017-10-03

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

Swordfish_v1.0.5.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.

Swordfish_v1.0.5_Specification.html Swordfish_v1.0.5_Specification.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.

Swordfish_v1.0.5_Schema.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.

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.

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.

Swordfish_v1.0.5_UserGuide.html Swordfish_v1.0.5_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.4

Working Draft

2017-04-17

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

Swordfish_v1.0.4.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.

Swordfish_v1.0.4_Specification.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.

Swordfish_v1.0.4_Schema.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.

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.

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.

Swordfish_v1.0.4_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.2a

Working Draft

2016-11-18

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

Swordfish_v1.0.2a.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.

Swordfish_v1.0.2_Specification.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.

Swordfish_v1.0.2a_Schema.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.

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.

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.

Swordfish_v1.0.2_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.2

Working Draft

2016-11-16

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

Swordfish_v1.0.2.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.

Swordfish_v1.0.2_Specification.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.

Swordfish_v1.0.2_Schema.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.

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.

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.

Swordfish_v1.0.2_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.1

Working Draft

2016-10-16

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

Swordfish_v1.0.1.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.

Swordfish_v1.0.1_Specification.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.

Swordfish_v1.0.1_Schema.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.

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.

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.

Swordfish_v1.0.1_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.0

Working Draft

2016-09-19

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

Swordfish_v1.0.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.

Swordfish_v1.0_Specification.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.

Swordfish_v1.0_Schema.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.

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.

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.

Swordfish_v1.0_UsersGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

Full Release

1.2.8

Full Release

2025-05-22

Key updates and features of Swordfish v1.2.8 include:

  • Enhancements to the NVMe-oF™ white paper.
  • Updates to NVMe® functionality and mapping guide for namespace management
  • Advancements to filesystem use cases and mockups
  • Revisions to mapping and masking functionality
  • Expanded StoragePool Metrics

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

Swordfish_v1.2.8.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.

Swordfish_v1.2.8_Specification.html Swordfish_v1.2.8_Specification.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.

Swordfish_v1.2.8_Schema.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.

Swordfish_v1.2.8_Profiles.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.

Swordfish_v1.2.8_Templates.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.

Swordfish_v1.2.8_UserGuide.html Swordfish_v1.2.8_UserGuide.pdf

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_v1.2.8_ErrorGuide.html Swordfish_v1.2.8_ErrorGuide.pdf

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_v1.2.8_NVMeMappingGuide.html Swordfish_v1.2.8_NVMeMappingGuide.pdf

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_v1.2.8_PropertyGuide.html Swordfish_v1.2.8_PropertyGuide.pdf

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.

Swordfish_v1.2.8_InteropGuide.html Swordfish_v1.2.8_InteropGuide.pdf

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.

Swordfish_v1.2.8_MetricsWhitePaper.html Swordfish_v1.2.8_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

Swordfish_v1.2.8_NVMeoFWhitePaper.html Swordfish_v1.2.8_NVMeoFWhitePaper.pdf

1.2.7

Full Release

2024-08-13

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.

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

Swordfish_v1.2.7.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.

Swordfish_v1.2.7_Specification.html Swordfish_v1.2.7_Specification.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.

Swordfish_v1.2.7_Schema.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.

Swordfish_v1.2.7_Profiles.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.

Swordfish_v1.2.7_Templates.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.

Swordfish_v1.2.7_UserGuide.html Swordfish_v1.2.7_UserGuide.pdf

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_v1.2.7_ErrorGuide.html Swordfish_v1.2.7_ErrorGuide.pdf

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_v1.2.7_NVMeMappingGuide.html Swordfish_v1.2.7_NVMeMappingGuide.pdf

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_v1.2.7_PropertyGuide.html Swordfish_v1.2.7_PropertyGuide.pdf

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.

Swordfish_v1.2.7_InteropGuide.html Swordfish_v1.2.7_InteropGuide.pdf

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.

Swordfish_v1.2.7_MetricsWhitePaper.html Swordfish_v1.2.7_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

Swordfish_v1.2.7_NVMeoFWhitePaper.html Swordfish_v1.2.7_NVMeoFWhitePaper.pdf

1.2.6

Full Release

2024-04-09

Swordfish v.1.2.6 offers key features such as new metrics for FileSystem, StoragePool, StorageService, and enhancements to VolumeMetrics. It introduces new mapping and masking models using Connections in the Fabric model and deprecates StorageGroups. It also includes support for new volume properties: ProvidingStoragePool, ChangeStripSize, Asymmetric Logical Unit Access (ALUA) to manage reservations. Swordfish v.1.2.6 adds enhancements to NVMe Domain Management, including ALUA support. Finally, it offers updates to NVMe namespaces, such as simplified Logical Block Address (LBA) Format representation and multiple namespace management.

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

Swordfish_v1.2.6.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.

Swordfish_v1.2.6_Specification.html Swordfish_v1.2.6_Specification.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.

Swordfish_v1.2.6_Schema.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.

Swordfish_v1.2.6_Profiles.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.

Swordfish_v1.2.6_Templates.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.

Swordfish_v1.2.6_UserGuide.html Swordfish_v1.2.6_UserGuide.pdf

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_v1.2.6_ErrorGuide.html Swordfish_v1.2.6_ErrorGuide.pdf

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_v1.2.6_NVMeMappingGuide.html Swordfish_v1.2.6_NVMeMappingGuide.pdf

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_v1.2.6_PropertyGuide.html Swordfish_v1.2.6_PropertyGuide.pdf

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.

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.

Swordfish_v1.2.6_MetricsWhitePaper.html Swordfish_v1.2.6_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

Swordfish_v1.2.6_NVMeoFWhitePaper.html Swordfish_v1.2.6_NVMeoFWhitePaper.pdf

1.2.5a

Full Release

2023-06-20

Version 1.2.5a of Swordfish adds expanded support for Swordfish profiles and support to map Swordfish to the 2.0c version of the NVMe™ and NVMe-oF™ specifications in the Swordfish NVMe Model Overview and Mapping Guide. New functionality includes metrics for volumes, drives, and storage controllers, as well as support for NVMe SMART Metrics, enhanced NVMe-oF discovery controller capabilities managing NVMe-oF centralized discovery controllers. There are also enhancements to the storage connections model, used to provide an updated mapping and masking model. Other integrated functionality is delivered in conjunction with the Redfish 2023.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, 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.

Swordfish_v1.2.5a.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.

Swordfish_v1.2.5a_Specification.html Swordfish_v1.2.5a_Specification.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.

Swordfish_v1.2.5a_Schema.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.

Swordfish_v1.2.5a_Profiles.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.

Swordfish_v1.2.5a_Templates.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.

Swordfish_v1.2.5a_UserGuide.html Swordfish_v1.2.5a_UserGuide.pdf

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_v1.2.5a_ErrorGuide.html Swordfish_v1.2.5a_ErrorGuide.pdf

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_v1.2.5a_NVMeMappingGuide.html Swordfish_v1.2.5a_NVMeMappingGuide.pdf

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_v1.2.5a_PropertyGuide.html Swordfish_v1.2.5a_PropertyGuide.pdf

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.

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.

Swordfish_v1.2.5a_MetricsWhitePaper.html Swordfish_v1.2.5a_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.4a

Full Release

2022-07-12

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

Swordfish_v1.2.4a.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.

Swordfish_v1.2.4a_Specification.html Swordfish_v1.2.4a_Specification.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.

Swordfish_v1.2.4a_Schema.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.

Swordfish_v1.2.4a_Profiles.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.

Swordfish_v1.2.4a_Templates.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.

Swordfish_v1.2.4a_UserGuide.html Swordfish_v1.2.4a_UserGuide.pdf

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_v1.2.4a_ErrorGuide.html Swordfish_v1.2.4a_ErrorGuide.pdf

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_v1.2.4a_NVMeMappingGuide.html Swordfish_v1.2.4a_NVMeMappingGuide.pdf

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_v1.2.4a_PropertyGuide.html Swordfish_v1.2.4a_PropertyGuide.pdf

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.

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.

Swordfish_v1.2.4a_MetricsWhitePaper.html Swordfish_v1.2.4a_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.3

Full Release

2021-12-05

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

Swordfish_v1.2.3.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.

Swordfish_v1.2.3_Specification.html Swordfish_v1.2.3_Specification.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.

Swordfish_v1.2.3_Schema.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.

Swordfish_v1.2.3_Profiles.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.

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.

Swordfish_v1.2.3_UserGuide.html Swordfish_v1.2.3_UserGuide.pdf

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_v1.2.3_ErrorGuide.html Swordfish_v1.2.3_ErrorGuide.pdf

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_v1.2.3_NVMeMappingGuide.html Swordfish_v1.2.3_NVMeMappingGuide.pdf

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_v1.2.3_PropertyGuide.html Swordfish_v1.2.3_PropertyGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.2a

Full Release

2021-06-14

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

Swordfish_v1.2.2a.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.

Swordfish_v1.2.2a_Specification.html Swordfish_v1.2.2a_Specification.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.

Swordfish_v1.2.2a_Schema.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.

Swordfish_v1.2.2a_Profiles.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.

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.

Swordfish_v1.2.2a_UserGuide.html Swordfish_v1.2.2a_UserGuide.pdf

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_v1.2.2a_ErrorGuide.html Swordfish_v1.2.2a_ErrorGuide.pdf

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_v1.2.2a_NVMeMappingGuide.html Swordfish_v1.2.2a_NVMeMappingGuide.pdf

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_v1.2.2a_PropertyGuide.html Swordfish_v1.2.2a_PropertyGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.1c

Full Release

2020-10-31

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

Swordfish_v1.2.1c_SS.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.

Swordfish_v1.2.1c_Specification.html Swordfish_v1.2.1c_Specification.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.

Swordfish_v1.2.1c_Schema.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.

Swordfish_v1.2.1c_Profiles.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.

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.

Swordfish_v1.2.1c_UserGuide.html Swordfish_v1.2.1c_UserGuide.pdf

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_v1.2.1c_ErrorGuide.html Swordfish_v1.2.1c_ErrorGuide.pdf

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_v1.2.1c_NVMeMappingGuide.html Swordfish_v1.2.1c_NVMeMappingGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.1.0d

Full Release

2020-09-29

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

Swordfish_v1.1.0d.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.

Swordfish_v1.1.0d_Specification.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.

Swordfish_v1.1.0a_Schema.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.

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.

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.

Swordfish_v1.1.0a_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.1.0c

Full Release

2020-06-16

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

Swordfish_v1.1.0c.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.

Swordfish_v1.1.0c_Specification.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.

Swordfish_v1.1.0a_Schema.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.

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.

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.

Swordfish_v1.1.0a_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.1.0b

Full Release

2020-03-24

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

Swordfish_v1.1.0b.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.

Swordfish_v1.1.0b_Specification.html Swordfish_v1.1.0b_Specification.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.

Swordfish_v1.1.0a_Schema.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.

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.

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.

Swordfish_v1.1.0a_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.1.0a

Full Release

2020-01-14

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

Swordfish_v1.1.0a.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.

Swordfish_v1.1.0a_Specification.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.

Swordfish_v1.1.0a_Schema.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.

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.

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.

Swordfish_v1.1.0a_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.7a

Full Release

2018-12-23

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

Swordfish_v1.0.7a.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.

Swordfish_v1.0.7a_Specfication.html Swordfish_v1.0.7a_Specification.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.

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.

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.

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.

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.6

Full Release

2018-05-25

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

Swordfish_v1.0.6.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.

Swordfish_v1.0.6_specification.html Swordfish_v1.0.6_Specification.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.

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.

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.

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.

Swordfish_v1.0.6_UserGuide.html Swordfish_v1.0.6_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.3

Full Release

2017-01-24

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

Swordfish_v1.0.3.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.

Swordfish_v1.0.3_Specification.html Swordfish_v1.0.3_Specification.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.

Swordfish_v1.0.3_Schema.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.

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.

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.

Swordfish_v1.0.3_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

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 ToolDescription
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

Technical Work

Videos

The Minimum Requirements for SNIA Swordfish™

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

Working Draft

1.2.8

Working Draft

2025-01-20

Key updates and features of Swordfish v1.2.8 include:

  • Enhancements to the NVMe-oF™ white paper.
  • Updates to NVMe® functionality and mapping guide for namespace management
  • Advancements to filesystem use cases and mockups
  • Revisions to mapping and masking functionality
  • Expanded StoragePool Metrics

 

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

Swordfish_v1.2.8.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.

Swordfish_v1.2.8_Specification.html Swordfish_v1.2.8_Specification.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.

Swordfish_v1.2.8_Schema.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.

Swordfish_v1.2.8_Profiles.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.

Swordfish_v1.2.8_Templates.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.

Swordfish_v1.2.8_UserGuide.html Swordfish_v1.2.8_UserGuide.pdf

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_v1.2.8_ErrorGuide.html Swordfish_v1.2.8_ErrorGuide.pdf

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_v1.2.8_NVMeMappingGuide.html Swordfish_v1.2.8_NVMeMappingGuide.pdf

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_v1.2.8_PropertyGuide.html Swordfish_v1.2.8_PropertyGuide.pdf

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.

Swordfish_v1.2.8_InteropGuide.html Swordfish_v1.2.8_InteropGuide.pdf

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.

Swordfish_v1.2.8_MetricsWhitePaper.html Swordfish_v1.2.8_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

Swordfish_v1.2.8_NVMeoFWhitePaper.html Swordfish_v1.2.8_NVMeoFWhitePaper.pdf

1.2.7

Working Draft

2024-05-21

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.

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

Swordfish_v1.2.7.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.

Swordfish_v1.2.7_Specification.html Swordfish_v1.2.7_Specification.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.

Swordfish_v1.2.7_Schema.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.

Swordfish_v1.2.7_Profiles.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.

Swordfish_v1.2.7_Templates.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.

Swordfish_v1.2.7_UserGuide.html Swordfish_v1.2.7_UserGuide.pdf

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_v1.2.7_ErrorGuide.html Swordfish_v1.2.7_ErrorGuide.pdf

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_v1.2.7_NVMeMappingGuide.html Swordfish_v1.2.7_NVMeMappingGuide.pdf

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_v1.2.7_PropertyGuide.html Swordfish_v1.2.7_PropertyGuide.pdf

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.

Swordfish_v1.2.7_InteropGuide.html Swordfish_v1.2.7_InteropGuide.pdf

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.

Swordfish_v1.2.7_MetricsWhitePaper.html Swordfish_v1.2.7_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

Swordfish_v1.2.7_NVMeoFWhitePaper.html Swordfish_v1.2.7_NVMeoFWhitePaper.pdf

1.2.6

Working Draft

2024-01-22

Swordfish v.1.2.6 offers key features such as new metrics for FileSystem, StoragePool, StorageService, and enhancements to VolumeMetrics. It introduces new mapping and masking models using Connections in the Fabric model and deprecates StorageGroups. It also includes support for new volume properties: ProvidingStoragePool, ChangeStripSize, Asymmetric Logical Unit Access (ALUA) to manage reservations. Swordfish v.1.2.6 adds enhancements to NVMe Domain Management, including ALUA support. Finally, it offers updates to NVMe namespaces, such as simplified Logical Block Address (LBA) Format representation and multiple namespace management.

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

Swordfish_v1.2.6.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.

Swordfish_v1.2.6_Specification.html Swordfish_v1.2.6_Specification.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.

Swordfish_v1.2.6_Schema.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.

Swordfish_v1.2.6_Profiles.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.

Swordfish_v1.2.6_Templates.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.

Swordfish_v1.2.6_UserGuide.html Swordfish_v1.2.6_UserGuide.pdf

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_v1.2.6_ErrorGuide.html Swordfish_v1.2.6_ErrorGuide.pdf

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_v1.2.6_NVMeMappingGuide.html Swordfish_v1.2.6_NVMeMappingGuide.pdf

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_v1.2.6_PropertyGuide.html Swordfish_v1.2.6_PropertyGuide.pdf

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.

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.

Swordfish_v1.2.6_MetricsWhitePaper.html Swordfish_v1.2.6_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

Swordfish_v1.2.6_NVMeoFWhitePaper.html Swordfish_v1.2.6_NVMeoFWhitePaper.pdf

1.2.5

Working Draft

2023-03-14

Version 1.2.5 of Swordfish adds expanded support for Swordfish profiles and support to map Swordfish to the 2.0c version of the NVMe™ and NVMe-oF™ specifications in the Swordfish NVMe Model Overview and Mapping Guide. New functionality includes metrics for volumes, drives, and storage controllers, as well as support for NVMe SMART Metrics, enhanced NVMe-oF discovery controller capabilities managing NVMe-oF centralized discovery controllers. There are also enhancements to the storage connections model, used to provide an updated mapping and masking model. Other integrated functionality is delivered in conjunction with the Redfish 2023.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, 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.

Swordfish_v1.2.5.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.

Swordfish_v1.2.5_Specification.html Swordfish_v1.2.5_Specification.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.

Swordfish_v1.2.5_Schema.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.

Swordfish_v1.2.5_Profiles.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.

Swordfish_v1.2.5_Templates.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.

Swordfish_v1.2.5_UserGuide.html Swordfish_v1.2.5_UserGuide.pdf

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_v1.2.5_ErrorGuide.html Swordfish_v1.2.5_ErrorGuide.pdf

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_v1.2.5_NVMeMappingGuide.html Swordfish_v1.2.5_NVMeMappingGuide.pdf

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_v1.2.5_PropertyGuide.html Swordfish_v1.2.5_PropertyGuide.pdf

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.

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.

Swordfish_v1.2.5_MetricsWhitePaper.html Swordfish_v1.2.5_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.4

Working Draft

2022-04-12

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

Swordfish_v1.2.4.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.

Swordfish_v1.2.4_Specification.html Swordfish_v1.2.4_Specification.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.

Swordfish_v1.2.4_Schema.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.

Swordfish_v1.2.4_Profiles.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.

Swordfish_v1.2.4_Templates.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.

Swordfish_v1.2.4_UserGuide.html Swordfish_v1.2.4_UserGuide.pdf

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_v1.2.4_ErrorGuide.html Swordfish_v1.2.4_ErrorGuide.pdf

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_v1.2.4_NVMeMappingGuide.html Swordfish_v1.2.4_NVMeMappingGuide.pdf

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_v1.2.4_PropertyGuide.html Swordfish_v1.2.4_PropertyGuide.pdf

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.

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.

Swordfish_v1.2.4_MetricsWhitePaper.html Swordfish_v1.2.4_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.3

Working Draft

2021-08-30

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

Swordfish_v1.2.3.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.

Swordfish_v1.2.3_Specification.html Swordfish_v1.2.3_Specification.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.

Swordfish_v1.2.3_Schema.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.

Swordfish_v1.2.3_Profiles.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.

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.

Swordfish_v1.2.3_UserGuide.html Swordfish_v1.2.3_UserGuide.pdf

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_v1.2.3_ErrorGuide.html Swordfish_v1.2.3_ErrorGuide.pdf

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_v1.2.3_NVMeMappingGuide.html Swordfish_v1.2.3_NVMeMappingGuide.pdf

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_v1.2.3_PropertyGuide.html Swordfish_v1.2.3_PropertyGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.2

Working Draft

2021-03-22

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

Swordfish_v1.2.2.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.

Swordfish_v1.2.2_Specification.html Swordfish_v1.2.2_Specification.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.

Swordfish_v1.2.2_Schema.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.

Swordfish_v1.2.2_Profiles.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.

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.

Swordfish_v1.2.2_UserGuide.html Swordfish_v1.2.2_UserGuide.pdf

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_v1.2.2_ErrorGuide.html Swordfish_v1.2.2_ErrorGuide.pdf

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_v1.2.2_NVMeMappingGuide.html Swordfish_v1.2.2_NVMeMappingGuide.pdf

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_v1.2.2_PropertyGuide.html Swordfish_v1.2.2_PropertyGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.1c

Working Draft

2020-10-20

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

Swordfish_v1.2.1c.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.

Swordfish_v1.2.1c_Specification.html Swordfish_v1.2.1c_Specification.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.

Swordfish_v1.2.1c_Schema.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.

Swordfish_v1.2.1_Profiles.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.

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.

Swordfish_v1.2.1a_UserGuide.html Swordfish_v1.2.1_UserGuide.pdf

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_v1.2.1a_ErrorGuide.html Swordfish_v1.2.1_ErrorGuide.pdf

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_v1.2.1a_NVMeMappingGuide.html Swordfish_v1.2.1_NVMeMappingGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.1a

Working Draft

2020-09-29

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

Swordfish_v1.2.1a.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.

Swordfish_v1.2.1a_Specification.html Swordfish_v1.2.1a_Specification.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.

Swordfish_v1.2.1a_Schema.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.

Swordfish_v1.2.1_Profiles.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.

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.

Swordfish_v1.2.1a_UserGuide.html Swordfish_v1.2.1_UserGuide.pdf

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_v1.2.1a_ErrorGuide.html Swordfish_v1.2.1_ErrorGuide.pdf

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_v1.2.1a_NVMeMappingGuide.html Swordfish_v1.2.1_NVMeMappingGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.1

Working Draft

2020-08-18

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

Swordfish_v1.2.1.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.

Swordfish_v1.2.1_Specification.html Swordfish_v1.2.1_Specification.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.

Swordfish_v1.2.1_Schema.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.

Swordfish_v1.2.1_Profiles.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.

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.

Swordfish_v1.2.1_UserGuide.html Swordfish_v1.2.1_UserGuide.pdf

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_v1.2.1_ErrorGuide.html Swordfish_v1.2.1_ErrorGuide.pdf

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_v1.2.1_NVMeMappingGuide.html Swordfish_v1.2.1_NVMeMappingGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.0

Working Draft

2020-05-29

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

Swordfish_v1.2.0.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.

Swordfish_v1.2.0_Specification.html Swordfish_v1.2.0_Specification.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.

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.

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.

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.

Swordfish_v1.2.0_UserGuide.html Swordfish_v1.2.0_UserGuide.pdf

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_v1.2.0_ErrorGuide.html Swordfish_v1.2.0_ErrorGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.1.0

Working Draft

2019-08-22

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

Swordfish_v1.1.0.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.

Swordfish_v1.1.0_Specification.html Swordfish_v1.1.0_Specification.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.

Swordfish_v1.1.0_Schema.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.

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.

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.

Swordfish_v1.1.0_UserGuide.html Swordfish_v1.1.0_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.7a

Working Draft

2018-11-08

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

Swordfish_v1.0.7a.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.

Swordfish_v1.0.7a_Specfication.html Swordfish_v1.0.7a_Specification.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.

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.

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.

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.

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.6

Working Draft

2018-02-13

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

Swordfish_v1.0.6.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.

Swordfish_v1.0.6_Specification.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.

Swordfish_v1.0.6_Schema.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.

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.

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.

Swordfish_v1.0.6_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.5

Working Draft

2017-10-03

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

Swordfish_v1.0.5.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.

Swordfish_v1.0.5_Specification.html Swordfish_v1.0.5_Specification.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.

Swordfish_v1.0.5_Schema.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.

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.

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.

Swordfish_v1.0.5_UserGuide.html Swordfish_v1.0.5_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.4

Working Draft

2017-04-17

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

Swordfish_v1.0.4.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.

Swordfish_v1.0.4_Specification.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.

Swordfish_v1.0.4_Schema.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.

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.

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.

Swordfish_v1.0.4_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.2a

Working Draft

2016-11-18

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

Swordfish_v1.0.2a.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.

Swordfish_v1.0.2_Specification.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.

Swordfish_v1.0.2a_Schema.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.

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.

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.

Swordfish_v1.0.2_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.2

Working Draft

2016-11-16

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

Swordfish_v1.0.2.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.

Swordfish_v1.0.2_Specification.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.

Swordfish_v1.0.2_Schema.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.

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.

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.

Swordfish_v1.0.2_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.1

Working Draft

2016-10-16

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

Swordfish_v1.0.1.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.

Swordfish_v1.0.1_Specification.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.

Swordfish_v1.0.1_Schema.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.

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.

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.

Swordfish_v1.0.1_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.0

Working Draft

2016-09-19

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

Swordfish_v1.0.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.

Swordfish_v1.0_Specification.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.

Swordfish_v1.0_Schema.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.

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.

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.

Swordfish_v1.0_UsersGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

Full Release

1.2.8

Full Release

2025-05-22

Key updates and features of Swordfish v1.2.8 include:

  • Enhancements to the NVMe-oF™ white paper.
  • Updates to NVMe® functionality and mapping guide for namespace management
  • Advancements to filesystem use cases and mockups
  • Revisions to mapping and masking functionality
  • Expanded StoragePool Metrics

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

Swordfish_v1.2.8.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.

Swordfish_v1.2.8_Specification.html Swordfish_v1.2.8_Specification.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.

Swordfish_v1.2.8_Schema.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.

Swordfish_v1.2.8_Profiles.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.

Swordfish_v1.2.8_Templates.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.

Swordfish_v1.2.8_UserGuide.html Swordfish_v1.2.8_UserGuide.pdf

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_v1.2.8_ErrorGuide.html Swordfish_v1.2.8_ErrorGuide.pdf

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_v1.2.8_NVMeMappingGuide.html Swordfish_v1.2.8_NVMeMappingGuide.pdf

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_v1.2.8_PropertyGuide.html Swordfish_v1.2.8_PropertyGuide.pdf

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.

Swordfish_v1.2.8_InteropGuide.html Swordfish_v1.2.8_InteropGuide.pdf

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.

Swordfish_v1.2.8_MetricsWhitePaper.html Swordfish_v1.2.8_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

Swordfish_v1.2.8_NVMeoFWhitePaper.html Swordfish_v1.2.8_NVMeoFWhitePaper.pdf

1.2.7

Full Release

2024-08-13

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.

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

Swordfish_v1.2.7.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.

Swordfish_v1.2.7_Specification.html Swordfish_v1.2.7_Specification.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.

Swordfish_v1.2.7_Schema.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.

Swordfish_v1.2.7_Profiles.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.

Swordfish_v1.2.7_Templates.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.

Swordfish_v1.2.7_UserGuide.html Swordfish_v1.2.7_UserGuide.pdf

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_v1.2.7_ErrorGuide.html Swordfish_v1.2.7_ErrorGuide.pdf

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_v1.2.7_NVMeMappingGuide.html Swordfish_v1.2.7_NVMeMappingGuide.pdf

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_v1.2.7_PropertyGuide.html Swordfish_v1.2.7_PropertyGuide.pdf

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.

Swordfish_v1.2.7_InteropGuide.html Swordfish_v1.2.7_InteropGuide.pdf

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.

Swordfish_v1.2.7_MetricsWhitePaper.html Swordfish_v1.2.7_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

Swordfish_v1.2.7_NVMeoFWhitePaper.html Swordfish_v1.2.7_NVMeoFWhitePaper.pdf

1.2.6

Full Release

2024-04-09

Swordfish v.1.2.6 offers key features such as new metrics for FileSystem, StoragePool, StorageService, and enhancements to VolumeMetrics. It introduces new mapping and masking models using Connections in the Fabric model and deprecates StorageGroups. It also includes support for new volume properties: ProvidingStoragePool, ChangeStripSize, Asymmetric Logical Unit Access (ALUA) to manage reservations. Swordfish v.1.2.6 adds enhancements to NVMe Domain Management, including ALUA support. Finally, it offers updates to NVMe namespaces, such as simplified Logical Block Address (LBA) Format representation and multiple namespace management.

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

Swordfish_v1.2.6.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.

Swordfish_v1.2.6_Specification.html Swordfish_v1.2.6_Specification.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.

Swordfish_v1.2.6_Schema.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.

Swordfish_v1.2.6_Profiles.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.

Swordfish_v1.2.6_Templates.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.

Swordfish_v1.2.6_UserGuide.html Swordfish_v1.2.6_UserGuide.pdf

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_v1.2.6_ErrorGuide.html Swordfish_v1.2.6_ErrorGuide.pdf

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_v1.2.6_NVMeMappingGuide.html Swordfish_v1.2.6_NVMeMappingGuide.pdf

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_v1.2.6_PropertyGuide.html Swordfish_v1.2.6_PropertyGuide.pdf

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.

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.

Swordfish_v1.2.6_MetricsWhitePaper.html Swordfish_v1.2.6_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

Swordfish_v1.2.6_NVMeoFWhitePaper.html Swordfish_v1.2.6_NVMeoFWhitePaper.pdf

1.2.5a

Full Release

2023-06-20

Version 1.2.5a of Swordfish adds expanded support for Swordfish profiles and support to map Swordfish to the 2.0c version of the NVMe™ and NVMe-oF™ specifications in the Swordfish NVMe Model Overview and Mapping Guide. New functionality includes metrics for volumes, drives, and storage controllers, as well as support for NVMe SMART Metrics, enhanced NVMe-oF discovery controller capabilities managing NVMe-oF centralized discovery controllers. There are also enhancements to the storage connections model, used to provide an updated mapping and masking model. Other integrated functionality is delivered in conjunction with the Redfish 2023.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, 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.

Swordfish_v1.2.5a.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.

Swordfish_v1.2.5a_Specification.html Swordfish_v1.2.5a_Specification.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.

Swordfish_v1.2.5a_Schema.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.

Swordfish_v1.2.5a_Profiles.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.

Swordfish_v1.2.5a_Templates.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.

Swordfish_v1.2.5a_UserGuide.html Swordfish_v1.2.5a_UserGuide.pdf

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_v1.2.5a_ErrorGuide.html Swordfish_v1.2.5a_ErrorGuide.pdf

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_v1.2.5a_NVMeMappingGuide.html Swordfish_v1.2.5a_NVMeMappingGuide.pdf

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_v1.2.5a_PropertyGuide.html Swordfish_v1.2.5a_PropertyGuide.pdf

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.

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.

Swordfish_v1.2.5a_MetricsWhitePaper.html Swordfish_v1.2.5a_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.4a

Full Release

2022-07-12

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

Swordfish_v1.2.4a.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.

Swordfish_v1.2.4a_Specification.html Swordfish_v1.2.4a_Specification.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.

Swordfish_v1.2.4a_Schema.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.

Swordfish_v1.2.4a_Profiles.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.

Swordfish_v1.2.4a_Templates.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.

Swordfish_v1.2.4a_UserGuide.html Swordfish_v1.2.4a_UserGuide.pdf

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_v1.2.4a_ErrorGuide.html Swordfish_v1.2.4a_ErrorGuide.pdf

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_v1.2.4a_NVMeMappingGuide.html Swordfish_v1.2.4a_NVMeMappingGuide.pdf

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_v1.2.4a_PropertyGuide.html Swordfish_v1.2.4a_PropertyGuide.pdf

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.

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.

Swordfish_v1.2.4a_MetricsWhitePaper.html Swordfish_v1.2.4a_MetricsWhitePaper.pdf

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.3

Full Release

2021-12-05

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

Swordfish_v1.2.3.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.

Swordfish_v1.2.3_Specification.html Swordfish_v1.2.3_Specification.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.

Swordfish_v1.2.3_Schema.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.

Swordfish_v1.2.3_Profiles.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.

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.

Swordfish_v1.2.3_UserGuide.html Swordfish_v1.2.3_UserGuide.pdf

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_v1.2.3_ErrorGuide.html Swordfish_v1.2.3_ErrorGuide.pdf

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_v1.2.3_NVMeMappingGuide.html Swordfish_v1.2.3_NVMeMappingGuide.pdf

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_v1.2.3_PropertyGuide.html Swordfish_v1.2.3_PropertyGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.2a

Full Release

2021-06-14

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

Swordfish_v1.2.2a.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.

Swordfish_v1.2.2a_Specification.html Swordfish_v1.2.2a_Specification.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.

Swordfish_v1.2.2a_Schema.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.

Swordfish_v1.2.2a_Profiles.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.

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.

Swordfish_v1.2.2a_UserGuide.html Swordfish_v1.2.2a_UserGuide.pdf

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_v1.2.2a_ErrorGuide.html Swordfish_v1.2.2a_ErrorGuide.pdf

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_v1.2.2a_NVMeMappingGuide.html Swordfish_v1.2.2a_NVMeMappingGuide.pdf

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_v1.2.2a_PropertyGuide.html Swordfish_v1.2.2a_PropertyGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.2.1c

Full Release

2020-10-31

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

Swordfish_v1.2.1c_SS.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.

Swordfish_v1.2.1c_Specification.html Swordfish_v1.2.1c_Specification.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.

Swordfish_v1.2.1c_Schema.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.

Swordfish_v1.2.1c_Profiles.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.

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.

Swordfish_v1.2.1c_UserGuide.html Swordfish_v1.2.1c_UserGuide.pdf

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_v1.2.1c_ErrorGuide.html Swordfish_v1.2.1c_ErrorGuide.pdf

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_v1.2.1c_NVMeMappingGuide.html Swordfish_v1.2.1c_NVMeMappingGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.1.0d

Full Release

2020-09-29

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

Swordfish_v1.1.0d.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.

Swordfish_v1.1.0d_Specification.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.

Swordfish_v1.1.0a_Schema.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.

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.

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.

Swordfish_v1.1.0a_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.1.0c

Full Release

2020-06-16

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

Swordfish_v1.1.0c.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.

Swordfish_v1.1.0c_Specification.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.

Swordfish_v1.1.0a_Schema.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.

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.

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.

Swordfish_v1.1.0a_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.1.0b

Full Release

2020-03-24

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

Swordfish_v1.1.0b.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.

Swordfish_v1.1.0b_Specification.html Swordfish_v1.1.0b_Specification.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.

Swordfish_v1.1.0a_Schema.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.

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.

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.

Swordfish_v1.1.0a_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.1.0a

Full Release

2020-01-14

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

Swordfish_v1.1.0a.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.

Swordfish_v1.1.0a_Specification.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.

Swordfish_v1.1.0a_Schema.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.

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.

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.

Swordfish_v1.1.0a_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.7a

Full Release

2018-12-23

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

Swordfish_v1.0.7a.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.

Swordfish_v1.0.7a_Specfication.html Swordfish_v1.0.7a_Specification.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.

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.

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.

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.

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.6

Full Release

2018-05-25

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

Swordfish_v1.0.6.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.

Swordfish_v1.0.6_specification.html Swordfish_v1.0.6_Specification.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.

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.

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.

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.

Swordfish_v1.0.6_UserGuide.html Swordfish_v1.0.6_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.

1.0.3

Full Release

2017-01-24

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

Swordfish_v1.0.3.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.

Swordfish_v1.0.3_Specification.html Swordfish_v1.0.3_Specification.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.

Swordfish_v1.0.3_Schema.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.

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.

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.

Swordfish_v1.0.3_UserGuide.pdf

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.

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.

Swordfish and NVMe-oF Whitepaper

This paper provides a deep dive into the NVMe oF configurations, and more specifically, how these are represented in both the Swordfish client model and API. It will also focus on the concepts of logical devices, called exported resources, and how these are represented, allocated and managed, as these are represented differently for NVMe oF devices than for other types of storage devices modeled in Swordfish.