Swordfish Scalable Storage Management API User’s Guide

Version 1.2.2

ABSTRACT: The Swordfish Scalable Storage Management API defines a RESTful interface and a standardized data model to provide a scalable, customer-centric interface for managing storage and related data services.

Publication of this Working Draft for review and comment has been approved by the Scalable Storage Management Technical Work Group. This draft represents a ‘best effort’ attempt by the Scalable Storage Management Technical Work Group to reach preliminary consensus, and it may be updated, replaced, or made obsolete at any time. This document should not be used as reference material or cited as other than a ‘work in progress.’ Suggestions for revision should be directed to http://www.snia.org/feedback.

Working Draft

This document has been released and approved by the SNIA. The SNIA believes that the ideas, methodologies, and technologies described in this document accurately represent the SNIA goals and are appropriate for widespread distribution. Suggestion for revision should be directed to http://www.snia.org/feedback/.

SNIA Approved Publication

Last Updated 2 March 2021

USAGE

Copyright (c) 2016 - 2021 SNIA. All rights reserved. All other trademarks or registered trademarks are the property of their respective owners.

The SNIA hereby grants permission for individuals to use this document for personal use only, and for corporations and other business entities to use this document for internal use only (including internal copying, distribution, and display) provided that:

  1. Any text, diagram, chart, table or definition reproduced must be reproduced in its entirety with no alteration, and,

  2. Any document, printed or electronic, in which material from this document (or any portion hereof) is reproduced must acknowledge the SNIA copyright on that material, and must credit the SNIA for granting permission for its reuse.

Other than as explicitly provided above, you may not make any commercial use of this document, or any portion thereof, or distribute this document to third parties. All rights not explicitly granted are expressly reserved to SNIA.

Permission to use this document for purposes other than those enumerated above may be requested by emailing tcmd@snia.org. Please include the identity of the requesting individual and/or company and a brief description of the purpose, nature, and scope of the requested use.

All code fragments, scripts, data tables, and sample code in this SNIA document are made available under the following license:

BSD 3-Clause Software License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

DISCLAIMER

The information contained in this publication is subject to change without notice. The SNIA makes no warranty of any kind with regard to this publication, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The SNIA shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance, or use.

Suggestions for revisions should be directed to http://www.snia.org/feedback/.

Contact SNIA

SNIA Web Site

Current SNIA practice is to make updates and other information available through their web site at http://www.snia.org.

FEEDBACK AND INTERPRETATIONS

Requests for interpretation, suggestions for improvement and addenda, or defect reports are welcome. They should be sent via the SNIA Feedback Portal at http://www.snia.org/feedback/ or by mail to the Storage Networking Industry Association, 4360 ArrowsWest Drive, Colorado Springs, Colorado 80907, U.S.A.

INTENDED AUDIENCE

This document is intended for use by individuals and companies engaged in storage management.

VERSIONING POLICY

This document is versioned material. Versioned material shall have a three-level revision identifier, comprised of a version number ‘v’, a release number ‘r’ and an errata number ‘e’. Future publications of this document are subject to specific constraints on the scope of change that is permissible from one revision to the next and the degree of interoperability and backward compatibility that should be assumed between products designed to this standard. This versioning policy applies to all SNIA Swordfish versioned materials.

Version Number: Versioned material having version number ‘v’ shall be backwards compatible with all of revisions of that material that have the same version number ‘v’. There is no assurance of interoperability or backward compatibility between revisions of a versioned material with different version numbers.

Release Number: Versioned material with a version number ‘v’ and release number ‘r’ shall be backwards compatible with previous revisions of the material with the same version number, and a lower release number. A minor revision represents a technical change to existing content or an adjustment to the scope of the versioned material. Each minor revision causes the release number to be increased by one.

Errata Number: Versioned material having version number ‘v’, a release number ‘r’, and an errata number ‘e’ should be backwards compatible with previous revisions of the material with the same version number and release number (“errata versions”). An errata revision of versioned material is limited to minor corrections or clarifications of existing versioned material. An errata revision may be backwards incompatible, if the incompatibility is necessary for correct operation of implementations of the versioned material.

Revision History

The evolution of this document is summarized in Table 1.

Table 1: Revision history
Date Revision Notes
19 September 2016 1.0.0 Initial Release
12 October 2016 1.0.1 General clean up and formatting consistency
A discussion of unused CoS and LoS entries in ServiceCatalog
Improve purpose for many use cases
1 November 2016 1.0.2 Corrected XREF link formatting
24 January 2017 1.0.3 Additional use cases and new document section addressing client considerations
25 April 2017 1.0.4 Update cross-references
3 October 2017 1.0.5 Minor updates and corrections
13 February 2018 1.0.6 Added on-demand replication use cases
12 October 2018 1.0.7 Editorial cleanup of JSON
22 August 2019 1.1.0 Restructured to add features and feature cross references, and many new use cases added:
    Create Volume for multiple scenarios (including Redfish Storage)
    Create Storage Pool for multiple scenarios
    Replication use cases using single Volume
    Replication use cases using Consistency Groups
12 November 2019 1.1.0 Released as Technical Position
12 November 2019 1.1.0a Released as Corrected Technical Position
    Formatting fixes – word wrap in pdf doc format to fix truncated lines
    Added cross referencing of Features to use cases
    Editorial changes and cleanup
18 August 2020 1.2.1 Added NVMe-specific use cases
31 October 2020 1.2.1c Released as SNIA Approved Publication
2 March 2021 1.2.2 Added cross-references to NVMe mapping document
Added new use cases for StoragePool actions.
Errata fixes.

About SNIA

The Storage Networking Industry Association (SNIA) is a non-profit organization made up of member companies spanning information technology. A globally recognized and trusted authority, SNIA’s mission is to lead the storage industry in developing and promoting vendor-neutral architectures, standards and educational services that facilitate the efficient management, movement and security of information.

Acknowledgements

The SNIA Scalable Storage Management Technical Work Group, which developed and reviewed this work in progress, would like to recognize the significant contributions made by the following members listed in Table 2.

Table 2: Contributors
Member Representatives
(* – prior employer)
Broadcom Inc. Richelle Ahlvers*
Cisco Systems, Inc. Krishnakumar Gowravaram
Dell Inc. Patrick Boyd
George Ericson
Jim Pendergraft
Sean McGinnis
Michael Raineri
Rich Roscoe
Futurewei Inc. Sean McGinnis*
Hitachi Data Systems Eric Hibbard
Hewlett Packard Enterprise Curtis Ballard
Jeff Hilland
Chris Lionetti
John Mendonca
Doug Voigt
Inova Development Inc. Karl Schopmeyer
Intel Corporation Richelle Ahlvers
Rajalaxmi Angadi
Klaudia Jablonska
Mariusz Krzywienski
Mateusz Mania
Slawek Putyrski
Paul von Behren
Microsemi Corporation Anand Nagarjan
Microsoft Corporation Hector Linares
Jim Pinkerton
Michael Pizzo
Scott Seligman
NetApp, Inc. Don Deel
Fred Knight
Nilesh Maheshwari
ScienceLogic Patrick Strick
VMware, Inc. Murali Rajagopal

Table of Contents


1. Introduction
1.1. Audience
1.2. Documentation structure
1.3. Implementation scope assumptions
1.4. Base implementation assumptions
1.5. Knowledge assumptions
1.6. Related documents
2. General query syntax
2.1. Query method
2.2. Query Headers
2.2.1. Request headers
2.2.2. Response headers
2.3. Service root
2.4. Resource path
2.5. Query options
2.6. Filter expressions
2.7. HTTP status codes
3. Actors
3.1. Actors
3.2. CloudAdmin
3.2.1. Use Cases
3.3. DevOps
3.3.1. Use Cases
3.4. Storage Admin
3.4.1. Use Cases
4. Management domains
4.1. Management Domain Overview
4.2. Application storage management domain
4.2.1. Use cases
4.3. Block storage management domain
4.3.1. Use Cases
4.4. Service catalog management domain
4.4.1. Data protection
4.4.2. Data security
4.4.3. Data storage
4.4.4. IO connectivity
4.4.5. IO performance
4.4.6. Use cases
4.5. File system storage management domain
4.5.1. Use cases
5. User Guidance
6. Features
6.1. Overview
6.2. Block provisioning feature
6.2.1. Overview
6.2.2. Feature-specific Guidance
6.2.3. Block provisioning use cases
6.3. Capacity management feature
6.3.1. Overview
6.3.2. Feature-specific Guidance
6.3.3. Capacity management use cases
6.4. Class of Service Features
6.4.1. Overview
6.4.2. Feature-specific Guidance
6.4.2.1. Default Class of Service
6.4.3. Class of service use cases
6.5. Event notification feature
6.5.1. Overview
6.5.2. Feature-specific Guidance
6.5.3. Event notification use cases
6.6. File provisioning feature
6.6.1. Overview
6.6.2. Feature-specific Guidance
6.6.3. File provisioing use cases
6.7. Block IO performance feature
6.7.1. Overview
6.7.2. Feature-specific Guidance
6.7.3. IO performance use cases
6.8. Block mapping and masking feature
6.8.1. Overview
6.8.2. Feature-specific Guidance
6.8.3. Mapping and masking use cases
6.9. NVMe Support feature
6.9.1. Overview
6.9.2. Feature-specific Guidance
6.9.3. NVMe use cases
6.10. Replication Feature
6.10.1. Overview
6.10.2. Feature-specific Guidance
6.10.3. Replication use cases
7. Use cases
7.1. Use cases by feature
7.1.1. Uncategorized Use Cases
7.1.2. Block provisioning use cases
7.1.3. Capacity management use cases
7.1.4. Class of service use cases
7.1.5. Event notification use cases
7.1.6. File provisioing use cases
7.1.7. IO performance use cases
7.1.8. Mapping and masking use cases
7.1.9. NVMe use cases
7.1.10. Replication use cases
7.2. Alphabetic list of use cases
7.2.1. Create a New Replication Relationship by Assigning a Target Volume
7.2.2. Attach a Namespace
7.2.3. Create an on-demand snapshot of a Volume
7.2.4. Create class of service
7.2.5. Create file share
7.2.6. Create file system
7.2.7. Create file system
7.2.8. Create line of service
7.2.9. Create storage pool using Specified Set of Drives and RAIDTypes
7.2.10. Create storage pool using Specified Set of Drives
7.2.11. Create storage pool
7.2.12. Create StorageGroup
7.2.13. Create Volume from an Existing Storage Pool
7.2.14. Create Volume using the Volume Collection
7.2.15. Make a New Replication Relationship by Creating a Target Volume
7.2.16. Provision a Namespace
7.2.17. Remove Replication Relationship for a Consistency Group
7.2.18. Remove Replication Relationship
7.2.19. Report Namespace Capacity
7.2.20. Report Remaining Life for a Namespace
7.2.21. Resume the Replication Synchronization Activity for a Consistency Group
7.2.22. Resume the Replication Synchronization Activity
7.2.23. Reverse a Replication Relationship for Consistency Groups
7.2.24. Reverse a Replication Relationship
7.2.25. Split a Replica
7.2.26. Split a set of Replicas in Consistency Groups
7.2.27. Subscribe to Threshold Events

1. Introduction

1.1. Audience

This guide is intended to provide a common repository of best practices, common tasks and education for the users of the Swordfish API. Each use case includes an indication of the classes of API users who are most likely to find the case useful.

1.2. Documentation structure

This document begins with a set of information intended to provide a solid foundation for readers new to restful APIs in general and Swordfish in particular. While this material is no replacement for a thorough understanding of the Swordfish specification and the material that it references, it is intended as a stand alone document that can provide a solid introduction to Swordfish.

Based on that foundational material, this document then presents a set of Use Cases intended to capture common tasks and best practices that can be used to exercise the breadth and strength of the Swordfish API. In general, the guide is structured to provide more basic use cases first, and examine common refinements and options at the same time. More advanced tasks are handled later in the guide, and assume the prior skills and assumptions have been mastered.

For each use case, this guide will use a common template. Table 3 lists each field of the template and its description.

Table 3: Guidelines for the Use Case Template
Name Description
Title A description of the high-level scope of the Use Case
Summary A high-level summary of the use case
Purpose The intended goals or motivations for the use case
Who The Actor(s) who are likely to use this use case. The actor description also includes a list of other use cases of interest for a named actor
Management Domain The Management Domain(s) applicable to this use case. The domain description also includes a list of other use cases of interest for the named management domains
Triggers A description of likely business conditions or goals that would make this use case useful
Detailed Context A detailed description of the operations environment and configuration assumptions for this use case
Preconditions Pre-existing knowledge, configurations or capabilities
Inputs A set of parameters and values that are used to adapt a generic use case to a specific business needs. Where appropriate, the parameter description will include a data type (e.g., {CAPACITY}: desired storage capacity (int64))
Basic Course of Events A sequence of API requests, including required headers, the body of the request, and the expected reply
Configuration Impacts Changes to the storage configurations caused by the use case
Failure Scenario Common failure conditions encountered in this use case
See Also Other Use Cases that may be of interest

1.3. Implementation scope assumptions

The precise scope of a given Swordfish implementation can vary widely. Some installations will opt to deploy a basic level of the API that only extends the Redfish standard slightly. Others will decide to implement a number of features, providing a broader range of functionality. While this guide cannot provide examples of all possible configurations and situations, it does attempt to cover a range of possible functionality options. Use cases that assume functionality that correspond to specific features are clearly identified.

1.4. Base implementation assumptions

This document assumes that some fundamental configuration issues have been properly implemented, and will not need to be addressed in any detail. In particular, this document assumes:

1.5. Knowledge assumptions

The Swordfish API conforms to the standards defined in the Redfish API. More generally, it is provides a RESTful interface. The reader is assumed to be familiar with common conventions for RESTful APIs. Those readers who are interested in additional background information are encouraged to refer to the following sources:

This User’s Guide is part of the documentation suite for the Swordfish API. Readers are encouraged to refer to the following for additional information: - Swordfish API Specification - Swordfish Tutorials - Swordfish NMVe Mapping Guide - Swordfish Profile Bundle

2. General query syntax

2.1. Query method

Swordfish queries support four query methods. Each query URL must include exactly one of of the query methods listed in Table 4.

Table 4: Query methods
Method Action
GET Retrieve the current state or settings of the named Resource Path as seen through the Service Root
POST Create a new object under the named Resource Path
PUT Replace the object referenced by the named Resource Path
DELETE Delete the object referenced by the named Resource Path
PATCH Update the object referenced by the named Resource Path
HEAD Validates a GET request against the named Resource Path without returning the HTML headers for the response without the result of the query

2.2. Query Headers

All HTTP requests and responses in a compliant Swordfish implementation support the HTTP headers required by the Redfish Protocol Specification. The supported headers are reproduced here for convenience.

2.2.1. Request headers

HTTP request headers that are commonly used in Swordfish queries are summarized in Table 5.

Table 5: Request headers
Header Supported Values Notes
Accept RFC 7231 Indicates to the server what media type(s) this client is prepared to accept. Services shall support requests for resources with an Accept header including application/json or application/json;charset=utf-8. Services shall support requests for metadata with an Accept header including application/xml or application/xml;charset=utf-8.
Content-Type RFC 7231 Describes the type of representation used in the message body. Content-Type shall be required in requests that include a request body. Services shall accept Content-Type values of application/json or application/json;charset=utf-8.
Table 5: Request headers, cont.
Header Supported Values Notes
OData-Version 4.0 Services shall reject requests which specify an unsupported OData version. If a service encounters a version that it does not support, the service should reject the request with status code 412. If client does not specify an Odata-Version header, the client is outside the boundaries of this specification.
Authorization RFC 7235, Section 4.2 Required for Basic Authentication
User-Agent RFC 7231 Required for tracing product tokens and their version. Multiple product tokens may be listed.
Host RFC 7230 Required to allow support of multiple origin hosts at a single IP address.
Origin W3C CORS, Section 5.7 Used to allow web applications to consume Redfish Service while preventing CSRF attacks.
If-Match RFC 7232 If-Match shall be supported on PUT and PATCH requests for resources for which the service returns ETags, to ensure clients are updating the resource from a known state.
X-Auth-Token Opaque encoded octet strings Used for authentication of user sessions. The token value shall be indistinguishable from random.

2.2.2. Response headers

HTTP response headers that are commonly used in Swordfish queries are summarized in Table 6.

Table 6: Response headers
Header Supported Values Notes
OData-Version 4.0 Describes the OData version of the payload that the response conforms to.
Content-Type RFC 7231 Describes the type of representation used in the message body. Services shall specify a Content-Type of application/json when returning resources as JSON, and application/xml when returning metadata as XML. ;charset=utf-8 shall be appended to the Content-Type if specified in the chosen media-type in the Accept header for the request.
ETag RFC 7232 An identifier for a specific version of a resource, often a message digest. Etags shall be included on responses to GETs of ManagerAccount objects.
Server RFC 7231 Required to describe a product token and its version. Multiple product tokens may be listed.
Link   Link headers shall be returned as described in the clause on Link Headers
Location RFC 7231 Indicates a URI that can be used to request a representation of the resource. Shall be returned if a new resource was created. Location and X-Auth-Token shall be included on responses which create user sessions.
Table 6: Response headers, cont.
Header Supported Values Notes
Cache-Control RFC 7234 This header shall be supported and is meant to indicate whether a response can be cached or not.
Access-Control-Allow-Origin W3C CORS, Section 5.7 Prevents or allows requests based on originating domain. Used to prevent CSRF attacks.
Allow POST, PUT, PATCH, DELETE, GET, HEAD Shall be returned with a 405 (Method Not Allowed) response to indicate the valid methods for the specified Request URI. Should be returned with any GET or HEAD operation to indicate the other allowable operations for this resource.
WWW-Authenticate RFC 7234, Section 4.1 Required for Basic and other optional authentication mechanisms. See the Security clause for details.
X-Auth-Token Opaque encoded octet strings Used for authentication of user sessions. The token value shall be indistinguishable from random.

2.3. Service root

This is the base of all Swordfish URL’s. A GET request to the Service Root will return an overview of the services provided by a given Swordfish service. In addition, the Service Root will include versioning information.

All Service Root URLs that are compliant with the Swordfish specification will be of the form https://hostName/redfish/v1, where hostName specifies the system (and optionally port number), of the Swordfish service provider.

2.4. Resource path

The Resource Path identifies the specific object (or collection of objects) that is the target of the Swordfish query. Swordfish Resource Paths can identify:

At the highest level, Swordfish systems are discoverable in the Storage Systems collection in the ServiceRoot.

2.5. Query options

Swordfish queries can include arbitrary sets of query options to further refine the target of given query or the actions being requested of that target. These general query options are summarized in Table 7.

Note: Additional query options may be supported (or constrained) for a specific query target or resource path. These target-specific query options will be addressed in specific use case descriptions, as required.

Table 7: Query Options
Parameter Name Arguments Notes
$skip=n Integer Omit the first n entries in the collection from the returned set of objects (required by redfish)
$top=n Integer Return, at most, the first n entries in the returned set of objects (required by redfish)
$filter=condition Filter Expression Returns only the members of the named collection that match the provided logical expression (required by swordfish)
$expand=target Expand Expression Expand additional detail on the target property(s) in the returned result set (required by swordfish)
$select=property list Comma-separated list of object properties Return the named properties for each object in the result set, rather than the entire object (required by swordfish)
$orderby=filter condition Filter Expression sort the result set by the output values from the filter expression (required by swordfish)

2.6. Filter expressions

 

  1. Simple example $filter=(age gt 30) A group of people never to trust.

For more information see Filter Expression in the OData specification.

2.7. HTTP status codes

Swordfish clients may receive any of the standard HTTP status codes. Both the Redfish specification and the Swordfish specification define a detailed mapping from the generic HTTP codes to domain-specific situations, and probable causes. In addition, the server can return extended status information as a simple JSON object to further clarify the handling and outcome of a particular API request. For more information, see the Swordfish Specification and the Redfish Specification.

3. Actors

3.1. Actors

This document covers a broad range of common use cases and storage management operations.

In an attempt to serve as both a introductory text and as a reference tool, the use cases have been grouped in a number of different ways:

3.2. CloudAdmin

A Cloud Administrator (CloudAdmin) is a converged infrastructure administrator, working with systems that are:

The CloudAdmin role in an enterprise or service provider is the individual or group primarily responsible for managing the operational lifecycle of a cloud, virtualization, converged environment that consists of the workloads, resource abstractions, storage, networking, and compute.

Also referred to as a “cloud architect”, this role:

3.2.1. Use Cases

3.3. DevOps

A member of the DevOps group:

This role is typically aligned with the business unit. Their focus is the delivery, deployment, and maintenance of apps on IaaS and PaaS resources. This role is not typically a deep subject matter expert in compute, storage, or networking. From a development perspective, their desire is to treat the infrastructure as a programmable subsystem that presents resources on-demand.

This role:

3.3.1. Use Cases

3.4. Storage Admin

A storage administrator designs storage solutions for modern environments, including:

The storage admin role in an enterprise or service provider can have responsibility for managing the operational lifcycle of storage in the datacenter. In particular:

3.4.1. Use Cases

4. Management domains

4.1. Management Domain Overview

This document covers a broad range of common use cases and storage management operations.

In an attempt to serve as both a introductory text and as a reference tool, the use cases have been grouped in a number of different ways:

4.2. Application storage management domain

This domain manages the interface between applications and the storage that they rely upon.

StorageGroups provide a means to collectively manage the Volumes and FileShares utilized by an Application. The StorageGroup specifies whether the collected resources are managed so that storage is updated or replicated consistently across all members. Additionally, the StorageGroup provides the means to atomically expose (or hide) the collected resources to (or from) host endpoints.

4.2.1. Use cases

4.3. Block storage management domain

Many devices and services provide their storage capacity to external devices and applications through block-based protocols to storage devices. This domain includes the management of resources that provide block-based access to storage.

Block-based storage is represented by a Volume. This domain provides for the discovery and provisioning of Volumes and for maintaining relationships to Device, Endpoint, StorageService, StorageGroup, StoragePool, and ComputerSystem resources.

4.3.1. Use Cases

4.4. Service catalog management domain

Swordfish supports access to, and management of, a catalog of service options, (see ITIL glossary and abbreviations), supported by storage services.

When the Swordfish Class of Service Feature is implemented, the ClassOfService resource represents a service option that may be used to specify requirements for utility or warranty when provisioning a resource. Currently ClassOfService is defined for use in the Block Storage, File System, and ApplicationStorage domains.

The service catalog for each StorageService is represented by a collection of references to supported ClassOfService resources. Each ClassOfService is known minimally by a Name and a unique Identifier. When a ClassOfService is specified for a resource, the StorageService shall attempt to maintain that resource in compliance to the requirements of that ClassOfService. The requirements may be specified informally by text in the Description property or may be specified formally by the property values of embedded options related to specific lines of service.

The embedded service options are described by values of complex types representing lines of service.

Over time, as the service catalog is continually updated to match evolving user needs and service provider offerings, it is expected that the catalog will contain entries (one or more ClassOfSerice or LineOfService instances) that are not currently active.

4.4.1. Data protection

The primary storage is described by a ClassOfService resource. That ClassOfService may aggregate any number of data protection service options. Each instance of a data protection service option describes the characteristics a replication session that shall be maintained for the containing primary storage resource.

For additional information, see the definitions for DataProtectionLineOfService and DataProtectionLoSCapabilities.

4.4.2. Data security

An instance of a data security service option describes an optional set of data security requirements. A data security Service option is typically aggregated into a ClassOfService resource that is associated with storage. At most one data security service option may be aggregated into a ClassOfService resource. When storage is provisioned with that ClassOfService, it will provide the currently specified data security characteristics.

A data security service option may specify data security characteristics that enable the storage system to be used in an environment where compliance with an externally-specified security standard or standards is required. Examples of such standards include FIPS-140, HIPAA and PCI. In this case, the names of the standard or standards can usefully be included in the user/admin-visible name of the instance. With the notable exception of FIPS-140, compliance requires measures well beyond the means of a storage system to provide (e.g., both HIPAA and PCI impose significant requirements on administration and operation of the data center), so this approach promises that the storage system will do its part in supporting compliance, but does not (and cannot) promise that the storage system will deliver full compliance by itself.

The description attribute value may include human readable information including:

NOTE For comparable cryptographic strengths, (see NIST SP 800-57 part 1)

NOTE For symmetric encryption algorithm key sizes, 112 bits is the 3DES key size and 128, 192, and 256 bits are options for AES key sizes.`

NOTE MediaEncryptionStrength includes the case where metadata about the data must be encrypted. (e.g. data presence vs. absence in a thin volume, array filesystem metadata) The implementation may be self-encrypting drives or encryption in the storage system’s drive controller. Keys may be drive or array resident or externally managed (e.g., via KMIP).

For additional information, see the definitions for DataSecurityLineOfService and DataSecurityLoSCapabilities.

4.4.3. Data storage

Each data storage service option describes characteristics of the storage at a particular location. A class of service will have at most one data storage service option, which describes the storage specified by that class of Service.

For additional information, see the DataStorageLineOfService and DataProtectionLoSCapabilities.

4.4.4. IO connectivity

An IO connectivity service option specifies the characteristics of storage connectivity. For each value of AccessProtocol, at most one IO connectivity service option may be aggregated into a class of service.

NOTE: If used within a ClassOfService for Storage Provisioning, this value constrains the set of connections used to expose that storage.

For additional information, see the IOConnectivityLineOfService and IOConnectivityLoSCapabilities.

4.4.5. IO performance

An IO performance service option specifies a choice of performance characteristics as viewed through the data path to the storage. This is affected by choices of storage and connection technologies.
At most one IO performance service option may be aggregated into a ClassOfService for a storage resource. When storage is provisioned with that ClassOfService, it should provide at least the specified performance.

For additional information, see the IOConnectivityLineOfService and IOConnectivityLoSCapabilities.

4.4.6. Use cases

4.5. File system storage management domain

FileSystems provide access to byte-accessible storage through file-based protocols. This domain includes the management of resources that provide file-based access to storage.

File-based storage is represented by a FileSystem resources. Remote access to portions of a FileSystem is provided by FileShare resources.

4.5.1. Use cases

5. User Guidance

Swordfish supports a range of possible features. Clients use the Features registry to determine what SupportedFeatures a specific instance of an implementation is capable of. These range from discovery (read-only functionality), to event notification, to performance instrumentation, to multiple levels of block and file provisioning capabilities.

Supporting the granular feature definition is a detailed profile description that includes precise definitions of what functionality must be implemented in order to advertise support for each feature.

For use cases specified in this document, there is an expectation that specific features have been implemented to support the corresponding use case. For example, the “AssignReplicaTarget” use case highlights functionality for either local or remote replication, depending on the selected target volume’s system (either the same or different than the source volume). In either case, the client is working with the presumption that the feature has been advertised.

6. Features

6.1. Overview

This guide covers use cases for both installations that have opted to deploy a basic level of the API, and only extends the Redfish standard slightly, and those that implement a number of advanced features, providing a broader range of functionality. Use cases that assume functionality or features beyond a basic Swordfish implementation are clearly identified below, and are group with one another.

This version of the Users’ Guide incorporates the functionality defined in v1.1.0 of the Swordfish specification, which defines a number of features. In addition to basic use cases, this document includes cases that rely on the implementation of each of those features:

6.2. Block provisioning feature

6.2.1. Overview

This feature provides basic, block-based storage provisioning.

 

 

6.2.2. Feature-specific Guidance

None defined.

6.2.3. Block provisioning use cases

The use cases defined for block provisioning are summarized in Table 8.

Table 8: Block provisioning use cases
Title Description
Add Drives to a StoragePool Add multiple drives to an existing StoragePool
Create Volume from a StoragePool Create Volume from an Existing Storage Pool
Create Volume using the Volume Collection Create Volume using the Volume Collection
Delete Drives from a StoragePool Add multiple drives from an existing StoragePool

6.3. Capacity management feature

6.3.1. Overview

This feature provide the management and alteration of storage once it has been allocated.

6.3.2. Feature-specific Guidance

None defined.

6.3.3. Capacity management use cases

The use cases defined for capacity management are summarized in Table 9.

Table 9: capacity management use cases
Title Description
Expand Volume Expand capacity of a Volume

6.4. Class of Service Features

6.4.1. Overview

This feature provides support for automated storage management based on ClassOfService and LineOfService modeling.

6.4.2. Feature-specific Guidance

6.4.2.1. Default Class of Service

If a pool, storage volume or other construct is created with no specified class of service when a class of service exists, the implementation will attempt to apply the DefaultClassOfService.

6.4.3. Class of service use cases

The use cases defined for class of service are summarized in Table 10.

Table 10: Class of service use cases
Title Description
Create class of service Create a class of service
Create file system Create a files system
Create line of service Create a line of service
Create Volume specifying Class of Service Create Volume specifying Class of Service
Create Volume using Default Class of Service Create Volume using Default Class of Service
Create an on-demand snapshot of a Volume Create an on-demand snapshot of a Volume

6.5. Event notification feature

6.5.1. Overview

This feature provides basic eventing.

6.5.2. Feature-specific Guidance

None defined.

6.5.3. Event notification use cases

The use cases defined for event notification are summarized in Table 11.

Table 11: Event notification use cases
Title Description
Subscribe to thresholds events Subscribe to Threshold Events

6.6. File provisioning feature

6.6.1. Overview

This feature provides file-based storage provisioning.

6.6.2. Feature-specific Guidance

None defined.

6.6.3. File provisioing use cases

The use cases defined for file provisioning are summarized in Table 12.

Table 12: File provisioning use cases
Title Description
Create file share Create a file share
Create file system Create a file system

6.7. Block IO performance feature

6.7.1. Overview

This feature provides basic performance metrics.

6.7.2. Feature-specific Guidance

None defined.

6.7.3. IO performance use cases

The use cases defined for IO performance are summarized in Table 13.

Table 13: IO performance use cases
Title Description
Subscribe to thresholds events Subscribe to Threshold Events

6.8. Block mapping and masking feature

6.8.1. Overview

This feature provides block-based mapping and assignment of storage volumes.

6.8.2. Feature-specific Guidance

None defined.

6.8.3. Mapping and masking use cases

The use cases defined for mapping and masking are summarized in Table 14.

Table 14: Mapping and masking use cases
Title Description
Create StorageGroup Create a StorageGroup

6.9. NVMe Support feature

6.9.1. Overview

This feature provides NVMe-specific use cases.

6.9.2. Feature-specific Guidance

The detailed mapping between Swordfish objects and the NVMe object model can be found in Swordfish NVMe Model Overview and Mapping Guide.

6.9.3. NVMe use cases

Title Description
Attach a Namespace Attach a Namespace
Deprovision a Namespace Deprovision a Namespace
Detach a Namespace Detach a Namespace
Provision a Namespace Provision a Namespace
Provision a Namespace with NVMSet Provision a Namespace associated with an NVMSet
Report capacity for a Namespace Report capacity for a Namespace
Report remaining life for a Namespace Report remaining life for a Namespace

6.10. Replication Feature

6.10.1. Overview

This set of features (local replication and remote replication) provides support for a broad range of storage redundancy protections.

6.10.2. Feature-specific Guidance

Replication can be implemented many ways. The use cases defined for this feature illustrate two possible approaches, one using volumes and the other using consistency groups. Those use cases employing consistency groups will include “CG” in their titles, to avoid confusion.

6.10.3. Replication use cases

The use cases defined for replication are summarized in Table 15.

Table 15: Replication use cases
Title Description
Assign Replica Target Create a New Replication Relationship by Assigning a Target Volume
Assign Replica Target (CG) Create a New Replication Relationship by Assigning an existing Target Consistency Group
Create Replica Target Make a New Replication Relationship by Creating a Target Volume
Create Replica Target (CG) Make a New Replication Relationship by Creating a Target Consistency Group
Remove Replication Relationship Remove Replication Relationship
Remove Replication Relationship (CG) Remove Replication Relationship for a Consistency Group
Resume the Replication Synchronization Activity Resume the Replication Synchronization Activity
Resume the Replication Synchronization Activity (CG) Resume the Replication Synchronization Activity for a Consistency Group
Reverse a Replication Relationship Reverse a Replication Relationship
Reverse a Replication Relationship (CG) Reverse a Replication Relationship for Consistency Groups
Split a Replica Split a Replica
Split a Replica (CG) Split a set of Replicas in Consistency Groups
Suspend Replication Synchronization Activity Suspend Replication Synchronization Activity
Suspend Replication Synchronization Activity (CG) Suspend Replication Synchronization Activity between Consistency Groups

7. Use cases

7.1. Use cases by feature

7.1.1. Uncategorized Use Cases

The use cases that don’t align with a particular feature are summarized in Table 16.

Table 16: Block provisioning use cases
Title Description
Create Storage Pool Create a StoragePool
Create Storage Pool by drives Create a StoragePool using a specific set of drives
Create Storage Pool with drives and RAIDType Create storage pool using Specified Set of Drives and RAIDTypes
Subscribe to thresholds events Subscribe to Threshold Events

7.1.2. Block provisioning use cases

The use cases defined for block provisioning are summarized in Table 17.

Table 17: Block provisioning use cases
Title Description
Add Drives to a StoragePool Add multiple drives to an existing StoragePool
Create Volume from a StoragePool Create Volume from an Existing Storage Pool
Create Volume using the Volume Collection Create Volume using the Volume Collection
Delete Drives from a StoragePool Add multiple drives from an existing StoragePool

7.1.3. Capacity management use cases

The use cases defined for capacity management are summarized in Table 18.

Table 18: capacity management use cases
Title Description
Expand Volume Expand capacity of a Volume

7.1.4. Class of service use cases

The use cases defined for class of service are summarized in Table 19.

Table 19: Class of service use cases
Title Description
Create class of service Create a class of service
Create file system Create a files system
Create line of service Create a line of service
Create Volume specifying Class of Service Create Volume specifying Class of Service
Create Volume using Default Class of Service Create Volume using Default Class of Service
Create an on-demand snapshot of a Volume Create an on-demand snapshot of a Volume

7.1.5. Event notification use cases

The use cases defined for event notification are summarized in Table 20.

Table 20: Event notification use cases
Title Description
Subscribe to thresholds events Subscribe to Threshold Events

7.1.6. File provisioing use cases

The use cases defined for file provisioning are summarized in Table 21.

Table 21: File provisioning use cases
Title Description
Create file share Create a file share
Create file system Create a file system

7.1.7. IO performance use cases

The use cases defined for IO performance are summarized in Table 22.

Table 22: IO performance use cases
Title Description
Subscribe to thresholds events Subscribe to Threshold Events

7.1.8. Mapping and masking use cases

The use cases defined for mapping and masking are summarized in Table 23.

Table 23: Mapping and masking use cases
Title Description
Create StorageGroup Create a StorageGroup

7.1.9. NVMe use cases

Title Description
Attach a Namespace Attach a Namespace
Deprovision a Namespace Deprovision a Namespace
Detach a Namespace Detach a Namespace
Provision a Namespace Provision a Namespace
Provision a Namespace with NVMSet Provision a Namespace associated with an NVMSet
Report capacity for a Namespace Report capacity for a Namespace
Report remaining life for a Namespace Report remaining life for a Namespace

7.1.10. Replication use cases

The use cases defined for replication are summarized in Table 24.

Table 24: Replication use cases
Title Description
Assign Replica Target Create a New Replication Relationship by Assigning a Target Volume
Assign Replica Target (CG) Create a New Replication Relationship by Assigning an existing Target Consistency Group
Create Replica Target Make a New Replication Relationship by Creating a Target Volume
Create Replica Target (CG) Make a New Replication Relationship by Creating a Target Consistency Group
Remove Replication Relationship Remove Replication Relationship
Remove Replication Relationship (CG) Remove Replication Relationship for a Consistency Group
Resume the Replication Synchronization Activity Resume the Replication Synchronization Activity
Resume the Replication Synchronization Activity (CG) Resume the Replication Synchronization Activity for a Consistency Group
Reverse a Replication Relationship Reverse a Replication Relationship
Reverse a Replication Relationship (CG) Reverse a Replication Relationship for Consistency Groups
Split a Replica Split a Replica
Split a Replica (CG) Split a set of Replicas in Consistency Groups
Suspend Replication Synchronization Activity Suspend Replication Synchronization Activity
Suspend Replication Synchronization Activity (CG) Suspend Replication Synchronization Activity between Consistency Groups

7.2. Alphabetic list of use cases

7.2.1. Create a New Replication Relationship by Assigning a Target Volume

Summary: Establish a replication relationship by assigning an existing volume to serve as a target replica for an existing source volume.

Purpose: Leverage an existing volume resource to provide expanded data protection through a replica relationship with the specified source volume.

Who: StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to provide expanded data protection through a replica relationship with the specified source volume.

Detailed Context: The admin needs to provide expanded data protection for the specified source volume, and the configuration includes pre-existing volume that can be repurposed as a replication target.

Preconditions: User has already identified an existing volume to use for the target replica (including the target system and storage pool properties), the type of replica, and the replica update mode (sync vs async).

Feature(s): Replication (both local and remote)

Inputs:

Basic Course of Events:

  1. Post (as an Action) the request on the source Volume.

This instructs the service to use the identified Volume as the source Volume for the specified replication relationship. For any additional details required, the service will rely on default values.

Request: POST /redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/1/Volume.AssignReplicaTarget

Headers: No additional headers required.

Body:

{
 "ReplicaUpdateMode": "Synchronous",
 "TargetVolume": "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/650973452245",
 "ReplicaType": "Mirror"
 }

Postconditions: The selected volume has an updated ReplicaTargets entry for the new relationship. Elsewhere, there is a volume “650973452245” in the system that has a ReplicaInfo which points back to this volume and which contains all of the Replica configuration information.

Failure Scenario: None defined

See also: Assign Replica Target (CG).

Create a New Replication Relationship by Assigning an existing Target Consistency Group

Summary: Establish a replication relationship by assigning an existing consistency group to serve as the target in the replication relationship for an existing consistency group.

Purpose: Leverage an existing consistency group resource to provide expanded data protection by creating a replication relationship with the specified source consistency group.

Who: StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to provide expanded data protection through a replica relationship with the specified source consistency group.

Detailed Context: The admin needs to provide expanded data protection for the specified source consistency group, and the configuration includes a pre-existing consistency group that can be repurposed as the replication target.

Preconditions: User has already identified an existing consistency group to use for the target replicas (including the target system and storage pool properties), the type of replica(s), and the replica update mode (sync vs async).

Feature(s): Replication (both local and remote)

Inputs:

Basic Course of Events:

  1. Post (as an Action) the request on the source ConsistencyGroup.

This instructs the service to use the identified ConsistencyGroup as the source ConsistencyGroup for the specified replication relationship. For any additional details required, the service will rely on default values.

Request: POST /redfish/v1/Storage/1/ConsistencyGroup/CG_DB1/ConsistencyGroup.AssignReplicaTarget

Headers: No additional headers required.

Body:

{
 "ReplicaUpdateMode": "Synchronous",
 "TargetConsistencyGroup": "/redfish/v1/Storage/1/ConsistencyGroup/CG_DB2",
 "ReplicaType": "Mirror"
 }

Postconditions: The selected ConsistencyGroup has an updated ReplicaTargets entry for the new relationship. Elsewhere, there is a ConsistencyGroup “CG_DB2” in the system that has a ReplicaInfo which points back to this ConsistencyGroup and which contains all of the Replica configuration information.

Failure Scenario: None defined

See also: Assign Replica Target.

7.2.2. Attach a Namespace

Summary: Attach a Namespace

Purpose: Provide visibility to a namespace by attaching it to an IO Controller.

Who: StorageAdmin; CloudAdmin

Management Domain: Block storage management

Triggers: None defined.

Detailed Context: Attach a Namespace to an IO Controller to make it visible to the hosts that connect to that IO Conttoller, and accessible for block storage operations.

Preconditions: The IO Controller and Namespaces need to exist, and be fully defined.

Feature(s): NMVe

Inputs:

Basic Course of Events:

  1. PATCH the AttachedVolumes array in the IO Controller with the Namespace.

Postconditions: The Namespace has been configured as an AttachedVolume to the IO Controller. This means that the Namespace is visible to hosts connected to the IO Controller.

Failure Scenario: None defined.

See also: None defined.

7.2.3. Create an on-demand snapshot of a Volume

Summary: Create an on-demand snapshot of a volume

Purpose: Create a snapshot of an existing volume. The resulting snapshot can then be used either as a backup or as a separate copy to test against.

Who: CloudAdmin, StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need an on-demand snapshot of a Volume

Detailed Context: To take a snapshot of a volume, we need to find a DataProtectionLineOfService that can describe the new Snapshot.

The DataProtectionLineOfService must have no schedule set to be able to provide on-demand behavior.

Preconditions: None.

Feature(s): Class of Service

Inputs:

Basic Course of Events:

  1. The first step is to get the current supported DataProtectionLineOfService entries, and find one that provides appropriate snapshot support (i.e., has no schedule set, and meets any other criteria the client may have).

    Request:
    GET /redfish/v1/StorageServices/1/Links/DataProtectionLoSCapabilities/SupportedLinesOfService

  1. This looks like the right line of service for an on-demand snap. Note that since this is an on-demand snapshot, it has no schedule specified. So, let’s use this to create the snapshot. We’ll copy by value.

Request:
POST /redfish/v1/StorageServices/1/Links/DataProtectionLoSCapabilities/SupportedLinesOfService/OnDemandSnapshot.CreateReplicas

  [ {  
      "ReplicaPriority": "Same",  
      "ReplicaReadOnlyAccess": "ReplicaElement",  
      "UndiscoveredElement": null,  
      "WhenSynced": "20171024T142000-00500",  
      "SyncMaintained": null,  
      "ReplicaRecoveryMode": null,  
      "ReplicaUpdateMode": "Synchronous",  
      "PercentSynced": 100,  
      "FailedCopyStopsHostIO": null,  
      "WhenActivated": "20171024T142000-00500",  
      "WhenDeactivated": null,  
      "WhenEstablished": "20171024T142000-00500",  
      "WhenSuspended": null,  
      "WhenSynchronized": null,  
      "ReplicaSkewBytes": null,  
      "ReplicaType": "Snapshot",  
      "ReplicaProgressStatus": "Completed",  
      "ReplicaState": "Synchronized",  
      "ConsistencyEnabled": false,  
      "ConsistencyType": null,  
      "ConsistencyState": null,  
      "ConsistencyStatus": null,  
      "ReplicaRole": "Target",  
      "Replica": {"odata.id": "/redfish/v1/StorageServices/1/StoragePools/BasePool/AllocatedVolumes/MySnapshot"},  
      "DataProtectionLineOfService": "/redfish/v1/StorageServices/1/Links/DataProtectionLoSCapabilities/SupportedLinesOfService/OnDemandSnapshot"}  
  ]      

Postconditions:
The original Volume (/redfish/v1/StorageServices/1/StoragePools/BasePool/AllocatedVolumes/1) now has a snapshot volume (/redfish/v1/StorageServices/1/StoragePools/BasePool/AllocatedVolumes/MySnapshot) that is available through its ReplicaTargets collection. All replication information (ReplicaInfo) is available on the snapshot (/redfish/v1/StorageServices/1/Volumes/MySnapshot) volume to describe the relationship.

Failure Scenario:
None defined.

See also:
None defined.

7.2.4. Create class of service

Summary: Create a class of service

Purpose: Create a new class of service in the service catalog to match a newly available type of storage

Who: StorageAdmin

Management Domain: Block storage management, Service catalog management

Triggers: The administrator has determined that a new class of service needs to be created to reflect a new class of SSD storage in the infrastructure.

Detailed Context: This is a simple scenario where the primary characteristic is the enhanced performance available of SSD drives.

Preconditions: None defined.

Feature(s): Class of Service

Inputs:

Basic Course of Events:

  1. Create ClassOfService
  1. Response:

Postconditions: The requested class of service is added to the ClassesOfService collection.

Failure Scenario: None defined.

See also: None defined.

7.2.5. Create file share

Summary: Create a file share

Purpose: Share an existing file system as /Shares/MyShare

Who: CloudAdmin, StorageAdmin, DevOps

Management Domain: File system storage management

Triggers: None defined.

Detailed Context: Create a share starting at /Shares/MyShare.

Preconditions: None defined.

Feature(s): File provisioning

Inputs:

Basic Course of Events:

1. Create a file share

{
        "Name" : "MyShare",
        "Description" : "Share of files under MyShare.",
    "SharedFilePath" : "/Shares/MyShare"
    }

Postconditions: The requested file share is added to the ExportedShares collection for the file system.

Failure Scenario: None defined.

See also: None defined.

7.2.6. Create file system

Summary: Create a file system

Purpose: Create a file system with a given capacity and performance level.

Who: StorageAdmin

Management Domain: File system storage management

Triggers: None defined.

Detailed Context: Create a 100 TB file system based on SSD class storage.

Preconditions: None defined.

Feature(s): Class of Service

Inputs:

Postconditions: The requested file system is added to the FileSystems collection for the Storage Service.

Failure Scenario: None defined.

See also: None defined.

7.2.7. Create file system

Summary: Create a file system

Purpose: Create a file system with a given capacity and performance level.

Who: StorageAdmin

Management Domain: File system storage management

Triggers: None defined.

Detailed Context: Create a 100 TB file system based on SSD class storage.

Preconditions: None defined.

Feature(s): File provisioning

Inputs:

Postconditions: The requested file system is added to the FileSystems collection for the Storage Service.

Failure Scenario: None defined.

See also: None defined.

7.2.8. Create line of service

Summary: Create a line of service to reflect the performance characteristics of SSD storage

Purpose: The definition is created here in preparation of creating ClassOfService instances that include a requirement for SSD storage performance.

Who: StorageAdmin

Management Domain: Block storage management, Service catalog management

Triggers: None defined.

Detailed Context: SSD storage is introduced and need a new performance line of service to reflect their capability.

Preconditions: None defined.

Feature(s): Class of Service

Inputs:

1. Get existing supported lines of service

2. Create new line of service

Postconditions: The requested line of service is added to the SupportedIOPerformanceLinesOfService of the Storage Service.

Failure Scenario: None defined.

See also: None defined.

7.2.9. Create storage pool using Specified Set of Drives and RAIDTypes

Summary: Create a StoragePool

Purpose: Create a StoragePool using a Specified set of drives and a specified set of supported RAIDTypes

Who: StorageAdmin

Management Domain: Block storage management

Triggers: Users need to allocate storage.

Detailed Context: Create a storage pool containing an amount of storage that can be used to create volumes with the specified set of RAIDTypes.

Preconditions: The user has the information about the set of drives.

Feature(s): None.

Inputs:

    {
    "Drives": [
    {"odata.id": "/redfish/v1/Storage/1/Drive/1"},
    {"odata.id": "/redfish/v1/Storage/1/Drive/2"},
    {"odata.id": "/redfish/v1/Storage/1/Drive/3"},
    {"odata.id": "/redfish/v1/Storage/1/Drive/4"},
    {"odata.id": "/redfish/v1/Storage/1/Drive/5"},
    {"odata.id": "/redfish/v1/Storage/1/Drive/6"},
    {"odata.id": "/redfish/v1/Storage/1/Drive/7"},
    {"odata.id": "/redfish/v1/Storage/1/Drive/8"}  
    ]
}
{
"SupportedRAIDTypes": ["RAID1","RAID5","RAID50"]
}

Basic Course of Events:

  1. Create StoragePool

Location=/redfish/v1/Storage/1/StoragePools/SSD

Post-Conditions: The requested StoragePool is added to the collection for Storage.

Failure Scenario: None defined.

See also: None defined.

7.2.10. Create storage pool using Specified Set of Drives

Summary: Create a StoragePool

Purpose: Create a StoragePool using a specified set of drives

Who: StorageAdmin

Management Domain: Block storage management

Triggers: Users need to allocate storage.

Detailed Context: Create a storage pool containing an amount of storage that can be used to create volumes with the specified set of RAIDTypes.

Preconditions: The user has the information about the set of drives.

Feature(s): None.

Inputs:

      {
      "Drives": [
          {"odata.id": "/redfish/v1/Storage/1/Drive/1"}
       ]
     }

Basic Course of Events:

  1. Create StoragePool
        {
          "Name": "SSD",
          "Description": "Storage Pool 1",
          "Drives": [
            {"odata.id": "/redfish/v1/Storage/1/Drive/1"}
          ]
        }

Post-Conditions: The requested StoragePool is added to the collection for Storage.

Failure Scenario: None defined.

See also: None defined.

7.2.11. Create storage pool

Summary: Create a StoragePool

Purpose: Create a StoragePool

Who: StorageAdmin

Management Domain: Block storage management

Triggers: Users need to allocate storage with characteristics satisfied by a class of service.

Detailed Context: Create a storage pool containing an amount of storage that can be used to create a requested class of service. The storage pool implementation will attempt to find and allocate enough storage that will satisfy the request. No metadata or snapshot storage is reserved.

Preconditions: None defined.

Feature(s): Class of Service

Inputs:

{
    "Data": {
        "ProvisionedBytes": 100000000000000,
        "IsThinProvisioned": false
    }
}

Basic Course of Events:

  1. Create StoragePool
{
    "Name": "SSD",
    "Description": "100 TB pool of SSD class storage.",
    "Capacity": {
        "Data": {
            "ProvisionedBytes": 100000000000000
        },
        "IsThinProvisioned": false
    },
    "ClassesOfService": {
        "Members": [{
            "@odata.id": "/redfish/v1/StorageServices/Members/1/ClassesOfService/SSD"
        }]
    }
}

Post-Conditions: The requested StoragePool is added to the collection for the Storage Service.

Failure Scenario: None defined.

See also: None defined.

7.2.12. Create StorageGroup

Summary: Create a StorageGroup

Purpose: Create a StorageGroup

Who: CloudAdmin

Management Domain: Block storage management

Triggers: None defined.

Detailed Context: Create a collection of application storage that is exposed to an application and managed as a unit.

Preconditions: None defined.

Feature(s): Mapping and masking

Inputs:

Basic Course of Events:

  1. Create StorageGroup

Postconditions: The requested StorageGroup is added to the Members collection for the Storage Service.

Failure Scenario: None defined.

See also: None defined.

7.2.13. Create Volume from an Existing Storage Pool

Summary: Create a new Volume from a Storage Pool.

Purpose: Create a new volume, with a specified capacity, from a previously created StoragePool.

Who: CloudAdmin, StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to allocate storage for a new application.

Detailed Context: The admin needs to satisfy a user or application request to provide a given amount of capacity with a specified RAIDType, and wants to leverage a preconfigured Storage Pool.

Preconditions: User has already selected a Pool and checked the supported RAIDType properties.

Feature(s): Block provisioning

Inputs:

Basic Course of Events:

  1. Post the definition of the new volume to the Volumes resource collection.

This instructs the service to use the identified StoragePool to allocate a new volume of the requested size that meets the requirements of the specified protection level. Since additional details are not provided, the service will rely on default values as required.

Request: POST /redfish/v1/Storage/1/StoragePools/PrimaryPool

Headers: No additional headers required.

Body:

{
 "Name" : "MyVolume",
 "CapacityBytes" : 1099511627776,
 "RAIDType" : "RAID1"
 }

Postconditions: The selected volume is added to the AllocatedVolumes collection within the selected storage pool.

Failure Scenario: None defined

See also: None defined.

7.2.14. Create Volume using the Volume Collection

Summary: Add a new Volume to the Volume Collection

Purpose: Create a new volume with a specified capacity, RAID Type, and set of drives.

Who: CloudAdmin, StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to allocate storage for a new application.

Detailed Context: The admin needs to satisfy a user or application request to provide a given amount of capacity, and to assure a given protection level.

Preconditions: None.

Feature(s): Block provisioning

Inputs:

Basic Course of Events:

  1. Post the definition of the new volume to the Volumes resource collection.

This instructs the service to allocate a new volume of the requested size that meets the requirements of the specified protection level. Since additional details are not provided, the service will rely on default values as required.

Request: POST /redfish/v1/Storage/1/Volumes

Headers: No additional headers required.

Body:

{  
 "Name" : "MyVolume",  
 "CapacityBytes" : 1099511627776,
 "RAIDType" : "RAID1",
 "Drives" : [
         {"odata.id" : "/redfish/v1/Storage/1/Drive/1"},
         {"odata.id" : "/redfish/v1/Storage/1/Drive/2"}
     ]
 }

Response:

Headers: Location = /redfish/v1/Storage/1/Volumes/1

Body:

    {  
    "@SSM.Copyright": "Copyright (c) 2014-2021 SNIA. All rights reserved.",  
    "@odata.context": "/redfish/v1/$metadata#Volume.Volume",  
    "@odata.id": "/redfish/v1/Storage/1/Volumes/1",  
    "@odata.type": "#Volume_1_4_0.Volume",  
    "Name": "MyVolume",  
    "Id": "1",  
    "Description": "",
    "RAIDType": "RAID1",
    "Identifiers": [
      {
        "DurableNameFormat": "NAA",
        "DurableName": "65456765456761001234076100123487"
      }
    ],
    "Status": {
      "State": "Enabled",
      "Health": "OK"
    },
    "CapacityBytes": 1099511627776,
    "Links" : {
        "Drives": [  
          {"odata.id": "/redfish/v1/Storage/1/Drive/1"},
          {"odata.id": "/redfish/v1/Storage/1/Drive/2"}
        ]
    }
 }

Postconditions: The selected volume is added to the Volume collection for Storage.

Failure Scenario: None defined

See also: None defined.

Create Volume specifying Class of Service

Summary: Create a Volume

Purpose: Create a Volume with a known capacity and class of service.

Who: CloudAdmin, StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to allocate storage for a new application.

Detailed Context: The admin needs to satisfy a service request to provide a given amount of storage to an application, and to assure a given class of service.

Preconditions: None.

Feature(s): Class of Service

Inputs:

Basic Course of Events:

  1. Post the definition of the new volume to the Volumes resource collection.

This instructs the service to allocate a new volume of the requested size that meets the requirements of the specified class of service. Since additional details are not provided, the service is free to allocate the storage from any of its storage pools that can satisfy the request.

{  
    "Name": "Snapshot1",  
    "CapacityBytes": 1099511627776,  
    "Links": {  
    "ClassOfService": {"odata.id":
    "/redfish/v1/StorageServices/1/ClassesofService/BostonBunker"}  
    }  
}

Location = /redfish/v1/StorageServices/1/Volumes/3

{  
   "\@SSM.Copyright": "Copyright (c) 2014-2021 SNIA. All rights reserved.",  
   "\@odata.context": "/redfish/v1/\$metadata\#Volume.Volume",  
   "\@odata.id": "/redfish/v1/StorageServices/1/Volumes/3",  
   "\@odata.type": "\#Volume_1_0_0.Volume",  
   "Name": "Snapshot1",  
   "Id": "3",  
   "Description": "",  
   "Identifiers": [  
      {  
         "DurableNameFormat": "NAA6",  
         "DurableName": "65456765456761001234076100123487"  
      }  
   ],  
   "Manufacturer": "SuperDuperSSD",  
   "Model": "Drive Model string",  
   "Status": {  
      "State": "Enabled",  
      "Health": "OK"  
   },  
   "AccessCapabilities": [  
      "Read",  
      "Write",  
      "Append",  
      "Streaming"  
   ],  
   "BlockSizeBytes": 512,  
   "CapacitySources": [
      {  
         "ConsumedBytes": 0,  
         "AllocatedBytes": 10737418240,  
         "GuaranteedBytes": 536870912,  
         "ProvisionedBytes": 1099511627776,  
         "Links": {  
            "ClassOfService": {  
                "\@odata.id": "/redfish/v1/StorageServices/1/Links/ClassesOfService/SilverBoston"
            },  
            "ProvidingPool": {  
               "\@odata.id": "/redfish/v1/StorageServices/1/StoragePools/SpecialPool"  
            }  
         }  
   }],  
   "CapacityBytes": 1099511627776,  
   "Capacity": {  
      "Data": {  
         "ConsumedBytes": 0,  
         "AllocatedBytes": 10737418240,  
         "GuaranteedBytes": 1099511627776,  
         "ProvisionedBytes": 1099511627776  
      },  
      "Metadata": {  
         "ConsumedBytes": 536870912,  
         "AllocatedBytes": 536870912  
      }  
   },  
   "Links": {  
      "ClassofService": {  
         "\@odata.id":
            "/redfish/v1/StorageServices/1/Links/ClassesofService/BostonBunker"  
      }  
   }  
}

Postconditions: The selected volumes are added to the collection for the Storage Group.

Failure Scenario: None defined

See also: None defined.

Deprovision a Namespace

Summary: Deprovision a Namespace

Purpose: Deprovision (delete) a Namespace that is no longer needed.

Who: StorageAdmin CloudAdmin

Management Domain: Block storage management

Triggers: None defined.

Detailed Context: Delete the namespace and free resources reserved for it. This can happen regardless of the controller attachment state of the namespace.

Preconditions: None defined.

Feature(s): NVMe

Inputs:

Basic Course of Events:

  1. Delete the Namespace.

Postconditions: The requested namespace has been deprovisioned.

Failure Scenario: None defined.

See also: None defined.

Expand capacity of a storage volume

Summary: Retrieve storage capacity information for a storage pool to check available capacity before expanding a storage volume.

Purpose:

Who: StorageAdmin at an enterprise

Management domain: Block storage management

Trigger: Low available capacity warning

Detailed context: The enterprise administrator offers managed storage services to business units in her organization. The administrator has established an SLA with application owners for storage volume expansion:

The application monitoring tool sends a warning alert to the administrator’s datacenter monitoring tool indicating that a storage volume’s capacity is at 80% and must be increased to ensure the application does not experience unplanned downtime. The administrator first checks the available capacity on the storage pool for a given storage class of service. Since the storage system is new, there is sufficient capacity available. Next the administrator figures out that the storage volume has never been expanded based on the original size tag. At the start of the maintenance window, non-business hours, the administrator initiates the expand action. For this particular storage system, the expand is a long running action so the administrator tracks the progress using the associated task.

Preconditions:

Feature(s): Block capacity management

Inputs:

Basic Course of Events:

  1. uses GET operations to look at information about storage volume and confirm low capacity and the current size is less than 2TB
{
  "@Redfish.Copyright": "Copyright 2015-2021 SNIA. All rights reserved.",
  "@odata.context": "/redfish/v1/$metadata#Volume.Volume",
  "@odata.id": "/redfish/v1/StorageServices/1/Volumes/61001234876545676100123487654567",
  "@odata.type": "#Volume_1_0_0.Volume",
  "Id": "61001234876545676100123487654567",
  "Name": "Volume 1",
  "Description": "application storage",
  "Identifiers": [
    {
      "DurableNameFormat": "NAA6",
      "DurableName": "61001234876545676100123487654567"
    }
  ],
  "Manufacturer": "SuperDuperStorageProvider",
  "Status": {
    "State": "Enabled",
    "Health": "OK"
  },
  "BlockSizeBytes": 512,
  "LowSpaceWarningThresholdPercent": [
    80,
    null,
    null,
    null,
    null
  ],
  "Capacity": {
    "Data": {
      "ConsumedBytes": 879609302221,
      "AllocatedBytes": 879609302221,
      "GuaranteedBytes": 549755813888,
      "ProvisionedBytes": 1099511627776
    },
  }
}
  1. Uses GET operations to look at information about storage pool to confirm it has more than 25% available capacity
  1. Use expand action to increase size of storage volume by 25%.

Note that there are two different properties that can be used to report available capacity, depending on the implementation - either CapacityBytes or Capacity->Data->AllocatedBytes. This use case shows how to do this function using the latter property, but would work equally if the implementation supported this function using the CapacityBytes property instead.

Postconditions: The volume’s capacity expands by 25%. Administrator needs to track the associated task to know when the volume expansion completes.

See also: None defined.

Health updates

Summary: Retrieve storage metrics information for a storage volume.

Purpose:

Who: DevOps at an enterprise

Management domain: Block storage management

Trigger: Lower than expected application requests completed per second

Detailed context: Devops creates diagnostics scripts that retrieve performance information from multiple layers in the application stack, including infrastructure, to help identify potential bottlenecks during production hours. Devops already understand that the issue is not in the application layers so now they have to dig deeper. Members of devops are typically not experts in infrastructure compute, storage, and networking so they need simple scripts that can provide the information they require without a deep understanding of underlying hardware. With the storage administrator’s help, devops use a few simple GETs on storage objects related to their application. To help simplify the query, the storage administrator tags the volumes associated with the application. Devops can use stack wide performance metrics to quickly isolate potential bottlenecks that may be contributing to the slow down in the application.

Preconditions:

Feature(s): Block IO performance

Inputs:

Basic course of events:

  1. uses GET operations to look at metrics of the storage volume

Postconditions: None defined.

See also: None defined.

Make a New Replication Relationship by Creating a Target Consistency Group

Summary: Create a new Consistency Group to serve as the target in the replication relationship for an existing source Consistency Group.

Purpose: Create a new ConsistencyGroup resource to provide expanded data protection through a replica relationship with the specified source ConsistencyGroup.

Who: StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to create a replication relationship for a source ConsistencyGroup when there are no existing ConsistencyGroups that can be assigned as the target.

Detailed Context: The admin needs to satisfy a user or application request for a copy of some sort of the original ConsistencyGroup.

Preconditions: User has already selected the type of replica, the replica update mode (sync vs async), and the target system and storage pool from which to create the new ConsistencyGroup to serve as the replica.

Feature(s): Replication (both local and remote)

Inputs:

Basic Course of Events:

  1. Post (as an Action) the request on the source ConsistencyGroup.

This instructs the service to use the identified ConsistencyGroup as the source ConsistencyGroup for the specified replication relationship. For any additional details required, the service will rely on default values.

Request: POST /redfish/v1/Storage/1/ConsistencyGroups/CG_DB1/ConsistencyGroup.CreateReplicaTarget

Headers: No additional headers required.

Body:

{
 "ConsistencyGroupName" : "CG_DB2",
 "ReplicaUpdateMode" : "Synchronous",
 "TargetStoragePool" : "/redfish/v1/Storage/1/StoragePools/PrimaryPool",
 "ReplicaType" : "Mirror"
 }

Postconditions: The selected ConsistencyGroup has a new ReplicaTargets property with the link to the new ConsistencyGroup. Elsewhere, there is a new ConsistencyGroup in the system (Name == “CG_DB2”, the id set by the system to 23423) that has a ReplicaInfo pointing back to this ConsistencyGroup and which contains all of the replication properties.

Failure Scenario: None defined

See also: Create Replica Target

7.2.15. Make a New Replication Relationship by Creating a Target Volume

Summary: Create a new volume to serve as a target replica for an existing source volume.

Purpose: Create a new volume resource to provide expanded data protection through a replica relationship with the specified source volume.

Who: StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to create a replication relationship for a source volume when there are no existing volumes that can be assigned as the target.

Detailed Context: The admin needs to satisfy a user or application request for a copy of some sort of the original volume.

Preconditions: User has already selected the type of replica, the replica update mode (sync vs async), and the target system and storage pool from which to create the new volume to serve as the replica.

Feature(s): Replication (both local and remote)

Inputs:

Basic Course of Events:

  1. Post (as an Action) the request on the source Volume.

This instructs the service to use the identified Volume as the source Volume for the specified replication relationship. For any additional details required, the service will rely on default values.

Request: POST /redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/1/Volume.CreateReplicaTarget

Headers: No additional headers required.

Body:

   {
    "VolumeName" : "Mirror of Volume 65",
    "ReplicaUpdateMode" : "Synchronous",
    "TargetStoragePool" : "/redfish/v1/Storage/1/StoragePools/PrimaryPool",
    "ReplicaType" : "Mirror"
    }
    {
    "@SSM.Copyright": "Copyright (c) 2014-2021 SNIA. All rights reserved.",
    "@odata.id": "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/1",
    "@odata.type": "#Volume_1_6_0.Volume",
    "Name": "Volume 65",
    "Id": "1",
    "Description": "",
    "ReplicaTargets":[{"@odata.id":"/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/2345"}]
   }

Postconditions: The selected volume has a new ReplicaTargets property with the link to the new volume. Elsewhere, there is a new volume in the system (Name == “Mirror of Volume 65”, the id set by the system to 2345) that has a ReplicaInfo pointing back to this volume and which contains all of the replication properties.

Failure Scenario: None defined

See also: Create Replica Target (CG)

7.2.16. Provision a Namespace

Summary: Provision a Namespace

Purpose: Provision a Namespace from a simple NVMe device that does not support Endurance Groups and NVM Sets.

Who: StorageAdmin CloudAdmin

Management Domain: Block storage management

Triggers: None defined.

Detailed Context: Create a namespace, and allocate resources reserved for it, from an NVMe device that does not support Endurance Groups and NVM Sets. The Create Namespace request is performed on the Volume Collection in this configuration. The admin needs to satisfy a user or application request to provide a given amount of capacity by creating a new Namespace. Note that this specific use case does not include the assignment of this namespace to an IO Controller.

Preconditions: User has already selected the desired capacity.

Feature(s): NVMe

Inputs:

Basic Course of Events:

  1. Post the definition of the new Namespace to the Volume resource collection on the NVM Subsystem.

This instructs the service to provision (create) a new Namespace of the requested size. Any additional protection properties will be inherited from the NVM Subsystem.

Postconditions: The selected Namespace has been created and is added to the NVM Subsystem.

Failure Scenario: None defined.

See also: NVMe use case to Attach a Namespace, and to Provision a Namespace with NVMSet.

7.2.17. Remove Replication Relationship for a Consistency Group

Summary: Disable data synchronization between a source and target Consistency Group, remove the replication relationship, and optionally delete the target Consistency Group.

Purpose: The administrator wants to completely delete the relationship between the target and source ConsistencyGroups.

Who: StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to remove a replication relationship due to changing system or environment requirements.

Detailed Context: The identified replication relationship is no longer needed, and is to be completely removed from the configuration.

Preconditions: User has already identified which replication relationship to delete, and whether or not to retain the target ConsistencyGroup.

Feature(s): Replication (both local and remote)

Inputs:

Basic Course of Events:

  1. Post (as an Action) the request on the source ConsistencyGroup.

This instructs the service to delete the specified replication relationship. For any additional details required, the service will rely on default values.

Request: POST /redfish/v1/Storage/1/ConsistencyGroups/CG_DB1/ConsistencyGroup.RemoveReplicaRelationship

Headers: No additional headers required.

Body:


   {
    "TargetConsistencyGroup": "/redfish/v1/Storage/1/ConsistencyGroups/CG_DB2",
    "DeleteTargetConsistencyGroup": "false"
    }

    {
    "@SSM.Copyright": "Copyright (c) 2014-2021 SNIA. All rights reserved.",
    "@odata.context": "/redfish/v1/$metadata#ConsistencyGroup.ConsistencyGroup",
    "@odata.id": "/redfish/v1/Storage/1/ConsistencyGroups/CG_DB1",
    "@odata.type": "#ConsistencyGroup_1_0_0.ConsistencyGroup",
    "Name": "ConsistencyGroup DB1",
    "Id": "1",
    "Description": "Database group 1 primary"
   }

Postconditions: The ConsistencyGroup will no longer have an entry in “ReplicaTargets” for the former replication relationship (the property is not returned in the above example if it were null). Elsewhere, the ConsistencyGroup “CG_DB2” in the system will still exist but will no longer have a StorageReplicaInfo which points back to this ConsistencyGroup.

Failure Scenario: None defined

See also: Remove Replication Relationship

7.2.18. Remove Replication Relationship

Summary: Disable data synchronization between a source and target volume, remove the replication relationship, and optionally delete the target volume.

Purpose: The administrator wants to completely delete the relationship between the target and source volumes.

Who: StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to remove a replication relationship due to changing system or environment requirements.

Detailed Context: The identified replication relationship is no longer needed, and is to be completely removed from the configuration.

Preconditions: User has already identified which replication relationship to delete, and whether or not to retain the target volume.

Feature(s): Replication (both local and remote)

Inputs:

Basic Course of Events:

  1. Post (as an Action) the request on the source Volume.

This instructs the service to delete the specified replication relationship. For any additional details required, the service will rely on default values.

Request: POST /redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/1/Volume.RemoveReplicaRelationship

Headers: No additional headers required.

Body:

   {
    "TargetVolume" : "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/650973452245",
    "DeleteTargetVolume" : "false"
    }

Postconditions: The volume will no longer have an entry in “ReplicaTargets” for the former replication relationship (the property is not returned in the above example if it were null). Elsewhere, the volume “650973452245” in the system will still exist but will no longer have a StorageReplicaInfo which points back to this volume.

Failure Scenario: None defined

See also: Remove Replication Relationship (CG)

7.2.19. Report Namespace Capacity

Summary: Report Namespace Capacity

Purpose: Report Namespace Capacity

Who: StorageAdmin CloudAdmin

Management Domain: Block storage management

Triggers: None defined.

Detailed Context: The namespace capacity information is provided as properties in the namespace object. The NVMe capacity information reported via the Redfish/Swordfish data structures maps the NVMe native capacity information into the RF/SF capacity structures, showing the capacity presented by the namespace to the consumer as AllocatedBytes (e.g., the addressable capacity), and the total available capacity of the namespace as ProvisionedBytes (e.g., the amount of addressable capacity that may actually be used). Note that for a thin provisioned system these values are expected to be different.

Preconditions: None defined.

Feature(s): NVMe

Inputs:

Basic Course of Events:

  1. Get the designated Namespace and find the Capacity.Data.AllocatedBytes property within the returned JSON data:

Postconditions: The requested capacity information is returned in the GET request:

    {
           "Capacity": {
           "Data": {
             "ConsumedBytes": 0,
             "AllocatedBytes": 10737418240,
             "ProvisionedBytes": 10737418240
           }

    }     

Failure Scenario: None defined.

See also: None defined.

7.2.20. Report Remaining Life for a Namespace

Summary: Report Remaining Life for a Namespace

Purpose: Report Remaining Life for a Namespace

Who: StorageAdmin CloudAdmin

Management Domain: Block storage management

Triggers: None defined.

Detailed Context: The namespace itself doesn’t have the notion of “remaining life”. Instead, the user should go to the corresponding drive object, and retrieve the “PredictedMediaLifeLeftPercent” property. Note, for a system that has endurance groups and sets, the endurance group also has this property, and the namespace could take the related “PredictedMediaLifeLeftPercent” from its related endurance group as well.

Preconditions: The namespace object has a direct link (in the Links property) to its related Drive. This path may not exist in certain types of NVMe devices, such as an Opaque Array.

Feature(s): NVMe

Inputs:

Basic Course of Events:

  1. GET the Namespace of interest.

        {
          "@Redfish.Copyright": "Copyright 2014-2021 SNIA. All rights reserved.",
          "@odata.id": "/redfish/v1/Systems/Sys-1/Storage/SimplestNVMeSSD/Volumes/SimpleNamespace",
          "@odata.type": "#Volume.v1_5_0.Volume",
          "Id": "1",
          "Name": "Namespace 1",
          "LogicalUnitNumber": 1,
          "Status": {
              "State": "Enabled",
              "Health": "OK"
          },
          "Identifiers": [
              {
                "DurableNameFormat": "NQN",
                "DurableName": "nqn.2014-08.org.nvmexpress:uuid:6c5fe566-10e6-4fb6-aad4-8b4159029384"
              }
          ],
          "Capacity": {
              "Data": {
                "ConsumedBytes": 0,
                "AllocatedBytes": 10737418240
              },
              "Metadata": {
                "AllocatedBytes": 536870912
              }
          },
          "NVMeNamespaceProperties": {
              "NamespaceId": "0x22F",
              "NamespaceFeatures": {
                "SupportsThinProvisioning": false,
                "SupportsAtomicTransactionSize": false,
                "SupportsDeallocatedOrUnwrittenLBError": false,
                "SupportsNGUIDReuse": false,
                "SupportsIOPerformanceHints": false
              },
              "NumberLBAFormats": 0,
              "FormattedLBASize": "LBAFormat0Support",
              "MetadataTransferredAtEndOfDataLBA": false,
              "NVMeVersion": "1.4"
          },
          "Links": {
              "Drives": {
                  "@odata.id": "/redfish/v1/Chassis/SimplestNVMeSSD/Drives/SimplestNVMeSSD"
                }
              }
        }
  1. GET the Drive related to the Namespace.
    {
    "@odata.id": "/redfish/v1/Chassis/SimplestNVMeSSD/Drives/SimplestNVMeSSD",
    "@odata.type": "#Drive.v1_9_0.Drive",
    "IndicatorLED": "Lit",
    "Model": "ST9146802SS",
    "Revision": "S20A",
    "Status": {
          "State": "Enabled",
          "Health": "OK"
    },
    "CapacityBytes": 899527000000,
    "FailurePredicted": false,
    "PredictedMediaLifeLeftPercent": 18,
    "Protocol": "NVMe",
    "MediaType": "SSD",
    "Manufacturer": "Contoso",
    "SerialNumber": "72D0A037FRD26",
    "PartNumber": "SG0GP8811253178M02GJA00",
    "Identifiers": [
          {
          "DurableNameFormat": "NAA",
          "DurableName": "500003942810D13A"
          }
    ],
    "Links": {
          "Volumes": [
            {
              "@odata.id": "/redfish/v1/Systems/Sys-1/Storage/SimplestNVMeSSD/Volumes/SimpleNamespace"
            }
          ]
    },
    "Actions": {
          "#Drive.Reset": {
              "target": "/redfish/v1/Chassis/SimplestNVMeSSD/Drives/SimplestNVMeSSD/Actions/Drive.Reset"
          }
    }
    }

Postconditions: The drive object returned a “PredictedMediaLifeLeftPercent” value of 18. The user can use this value as the apparent namespace life value.

Failure Scenario: None defined.

See also: None defined.

7.2.21. Resume the Replication Synchronization Activity for a Consistency Group

Summary: Resume the active data synchronization between a source and target Consistency Group, without otherwise altering the replication relationship.

Purpose: The administrator wants to restore the relationship between the target and source ConsistencyGroups, since the temporary condition that led to a suspension of replication has passed.

Who: StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to re-activate a suspended replication relationship.

Detailed Context: The temporary condition that led to a suspension of replication has passed, and the admin needs to resume replication using the existing replication relationship.

Preconditions: User has already identified which target ConsistencyGroup to resume, and implementation preserves replication information what a relationship is suspended.

Feature(s): Replication (both local and remote)

Inputs:

Basic Course of Events:

  1. Post (as an Action) the request on the source ConsistencyGroup.

This instructs the service to use the identified ConsistencyGroup as the source ConsistencyGroup for the specified replication relationship. For any additional details required, the service will rely on default values.

Request: POST /redfish/v1/Storage/1/ConsistencyGroups/DB_CG1/ConsistencyGroup.ResumeReplication

Headers: No additional headers required.

Body:


   {
    "TargetConsistencyGroup": "/redfish/v1/Storage/1/ConsistencyGroups/CG_DB2"
    }

    {
    "@SSM.Copyright": "Copyright (c) 2014-2021 SNIA. All rights reserved.",
    "@odata.context": "/redfish/v1/$metadata#ConsistencyGroup.ConsistencyGroup",
    "@odata.id": "/redfish/v1/Storage/1/ConsistencyGroups/CG_DB1",
    "@odata.type": "#ConsistencyGroup_1_0_0.ConsistencyGroup",
    "Name": "ConsistencyGroup DB1",
    "Id": "1",
    "Description": "Database group 1 primary",
    "ReplicaTargets":[{"@odata.id":"/redfish/v1/Storage/1/ConsistencyGroups/CG_DB2"}]
   }

Postconditions: The selected ConsistencyGroup has an updated ReplicaTargets entry for the new relationship. Elsewhere, there is a ConsistencyGroup “CG_DB2” in the system that has a ReplicaInfo which points back to this ConsistencyGroup and which contains all of the Replica configuration information. The replica state in the target ConsistencyGroup has been updated according to the requested action (e.g., from “suspended” to “active”).

Failure Scenario: None defined

See also: Resume the Replication Synchronization Activity

7.2.22. Resume the Replication Synchronization Activity

Summary: Resume the active data synchronization between a source and target volume, without otherwise altering the replication relationship.

Purpose: The administrator wants to restore the relationship between the target and source volumes, since the temporary condition that led to a suspension of replication has passed.

Who: StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to re-activate a suspended replication relationship.

Detailed Context: The temporary condition that led to a suspension of replication has passed, and the admin needs to resume replication using the existing replication relationship.

Preconditions: User has already identified which target volume to resume, and implementation preserves replication information what a relationship is suspended.

Feature(s): Replication (both local and remote)

Inputs:

Basic Course of Events:

  1. Post (as an Action) the request on the source Volume.

This instructs the service to use the identified Volume as the source Volume for the specified replication relationship. For any additional details required, the service will rely on default values.

Request: POST /redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/1/Volume.ResumeReplication

Headers: No additional headers required.

Body:


   {
    "TargetVolume" : "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/650973452245"
    }

    {
    "@SSM.Copyright": "Copyright (c) 2014-2021 SNIA. All rights reserved.",
    "@odata.id": "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/1",
    "@odata.type": "#Volume_1_6_0.Volume",
    "Name": "Volume 65",
    "Id": "1",
    "Description": "",
    "ReplicaTargets":[{"@odata.id":"/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/650973452245"}]
   }

Postconditions: The selected volume has an updated ReplicaTargets entry for the new relationship. Elsewhere, there is a volume “650973452245” in the system that has a ReplicaInfo which points back to this volume and which contains all of the Replica configuration information. The replica state in the target volume has been updated according to the requested action (e.g., from “suspended” to “active”).

Failure Scenario: None defined

See also: Resume the Replication Synchronization Activity (CG)

7.2.23. Reverse a Replication Relationship for Consistency Groups

Summary: Reverse the replication relationship between a source and target Consistency Group.

Purpose: The administrator wants to reconfigure the relationship between the target and source ConsistencyGroups, reversing their roles.

Who: StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to reconfigure existing storage due to changing system or environment requirements.

Detailed Context: The admin needs to satisfy a user or application request swapping the target/source roles in a replication relationship.

Preconditions: User has already identified which target ConsistencyGroup and replication relationship to reverse.

Feature(s): Replication (both local and remote)

Inputs:

Basic Course of Events:

  1. Post (as an Action) the request on the source ConsistencyGroup.

This instructs the service to use the identified ConsistencyGroup as the source ConsistencyGroup for the specified replication relationship. For any additional details required, the service will rely on default values.

Request: POST /redfish/v1/Storage/1/ConsistencyGroups/DB_CG1/ConsistencyGroup.ReverseReplicationRelationship

Headers: No additional headers required.

Body:


   {
    "TargetConsistencyGroup": "/redfish/v1/Storage/1/ConsistencyGroups/DB_CG2"
    }

    {
    "@SSM.Copyright": "Copyright (c) 2014-2021 SNIA. All rights reserved.",
    "@odata.context": "/redfish/v1/$metadata#ConsistencyGroup.ConsistencyGroup",
    "@odata.id": "/redfish/v1/Storage/1/ConsistencyGroups/CG_DB1",
    "@odata.type": "#ConsistencyGroup_1_0_0.ConsistencyGroup",
    "Name": "ConsistencyGroup DB1",
    "Id": "1",
    "Description": "Database group 1 primary",
    "ReplicaInfos": [{
      "ReplicaState": "Failedover",
      "ReplicaType": "Snapshot",
      "ReplicaPriority": "Default",
      "ReplicaRecoveryMode": "Manual",
      "ReplicaUpdateMode": "Asynchronous",
      "Replica": {"@odata.id": "/redfish/v1/Storage/1/ConsistencyGroups/DB_CG2"}
    }],
   }

Postconditions: The selected ConsistencyGroup will now have an updated ReplicaInfo for the relationship, which contains the replication attributes and a pointer to the source replica. Elsewhere, there is a ConsistencyGroup “DB_CG2” in the system that now has an ReplicaTargets entry that points back to this ConsistencyGroup (“@odata.id”: “/redfish/v1/Storage/1/ConsistencyGroups/DB_CG1”).

Failure Scenario: None defined

See also: Reverse a Replication Relationship

7.2.24. Reverse a Replication Relationship

Summary: Reverse the replication relationship between a source and target volume.

Purpose: The administrator wants to reconfigure the relationship between the target and source volumes, reversing their roles.

Who: StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to reconfigure existing storage due to changing system or environment requirements.

Detailed Context: The admin needs to satisfy a user or application request swapping the target/source roles in a replication relationship.

Preconditions: User has already identified which target volume and replication relationship to reverse.

Feature(s): Replication (both local and remote)

Inputs:

Basic Course of Events:

  1. Post (as an Action) the request on the source Volume.

This instructs the service to use the identified Volume as the source Volume for the specified replication relationship. For any additional details required, the service will rely on default values.

Request: POST /redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/1/Volume.ReverseReplicationRelationship

Headers: No additional headers required.

Body:


   {
    "TargetVolume" : "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/650973452245"
    }

    {
    "@SSM.Copyright": "Copyright (c) 2014-2021 SNIA. All rights reserved.",
    "@odata.id": "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/1",
    "@odata.type": "#Volume_1_6_0.Volume",
    "Name": "Volume 65",
    "Id": "1",
    "Description": "",
    "ReplicaInfos": [{
      "ReplicaState": "Failedover",
      "ReplicaType": "Snapshot",
      "ReplicaPriority": "Default",
      "ReplicaRecoveryMode": "Manual",
      "ReplicaUpdateMode": "Asynchronous",
      "Replica": {"@odata.id": "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/650973452245"}
    }],
   }

Postconditions: The selected volume will now have an updated ReplicaInfo for the relationship, which contains the replication attributes and a pointer to the source replica. Elsewhere, there is a volume “650973452245” in the system that now has an ReplicaTargets entry that points back to this volume (“@odata.id”: “/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/1”).

Failure Scenario: None defined

See also: Reverse a Replication Relationship (CG)

7.2.25. Split a Replica

Summary: Split the replication relationship and suspend data synchronization between a source and target volume.

Purpose: The administrator wants to reconfigure the relationship between the target and source volumes.

Who: StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to reconfigure existing storage due to changing system or environment requirements.

Detailed Context: The admin needs to satisfy a user or application request to change the existing configuration between the target and source volumes in a replication relationship.

Preconditions: User has already identified which target volume and replication relationship to split.

Feature(s): Replication (both local and remote)

Inputs:

Basic Course of Events:

  1. Post (as an Action) the request on the source Volume.

This instructs the service to use the identified Volume as the source Volume for the specified replication relationship. For any additional details required, the service will rely on default values.

Request: POST /redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/1/Volume.SplitReplication

Headers: No additional headers required.

Body:


   {
    "TargetVolume": "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/650973452245"
    }
    {
    "@SSM.Copyright": "Copyright (c) 2014-2021 SNIA. All rights reserved.",
    "@odata.id": "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/1",
    "@odata.type": "#Volume_1_6_0.Volume",
    "Name": "Volume 65",
    "Id": "1",
    "Description": "",
    "ReplicaTargets":[{"@odata.id":"/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/650973452245"}]
   }

Postconditions: The selected volume has a new ReplicaTargets property with the link to the volume. Elsewhere, there is a volume “650973452245” in the system that has a ReplicaInfo pointing back to this volume and which contains all of the Replica configuration information. The replica state in the target volume has been updated according to the requested action (e.g., from “active” to “suspended / split”).

Failure Scenario: None defined

See also: Split a Replica (CG)

7.2.26. Split a set of Replicas in Consistency Groups

Summary: Split the replication relationship and suspend data synchronization between a source and target ConsistencyGroup.

Purpose: The administrator wants to reconfigure the relationship between the target and source ConsistencyGroups.

Who: StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to reconfigure existing storage due to changing system or environment requirements.

Detailed Context: The admin needs to satisfy a user or application request to change the existing configuration between the target and source ConsistencyGroups in a replication relationship.

Preconditions: User has already identified which target ConsistencyGroup and replication relationship to split.

Feature(s): Replication (both local and remote)

Inputs:

Basic Course of Events:

  1. Post (as an Action) the request on the source ConsistencyGroup.

This instructs the service to use the identified ConsistencyGroup as the source ConsistencyGroup for the specified replication relationship. For any additional details required, the service will rely on default values.

Request: POST /redfish/v1/Storage/1/ConsistencyGroups/CG_DB1/ConsistencyGroup.SplitReplication

Headers: No additional headers required.

Body:


   {
    "TargetConsistencyGroup" : "/redfish/v1/Storage/1/ConsistencyGroups/CG_DB2"
    }

    {
    "@SSM.Copyright": "Copyright (c) 2014-2021 SNIA. All rights reserved.",
    "@odata.context": "/redfish/v1/$metadata#ConsistencyGroup.ConsistencyGroup",
    "@odata.id": "/redfish/v1/Storage/1/ConsistencyGroups/CG_DB1",
    "@odata.type": "#ConsistencyGroup_1_0_0.ConsistencyGroup",
    "Name": "ConsistencyGroup DB1",
    "Id": "1",
    "Description": "Database group 1 primary",
    "ReplicaTargets":[{"@odata.id":"/redfish/v1/Storage/1/ConsistencyGroups/CG_DB2"}]
   }

Postconditions: The selected ConsistencyGroup has a new ReplicaTargets property with the link to the ConsistencyGroup. Elsewhere, there is a ConsistencyGroup “650973452245” in the system that has a ReplicaInfo pointing back to this ConsistencyGroup and which contains all of the Replica configuration information. The replica state in the target ConsistencyGroup has been updated according to the requested action (e.g., from “active” to “suspended / split”).

Failure Scenario: None defined

See also: Split a Replica

7.2.27. Subscribe to Threshold Events

Summary: Subscribe to Trigger/Clear events for LowSpaceWarningThresholds for a named Volume.

Purpose: Provide an event stream to support utilization management. This is used in conjunction with LowSpaceWarningThresholds to provide a means for on-going monitoring of resource consumption.

Who: CloudAdmin, StorageAdmin, DevOps

Management domain: Block storage management, Application storage management

Triggers: None defined.

Detailed Context: This provides the basis for monitoring capacity consumption.

Preconditions: None defined.

Feature(s): Event notification

Inputs:

Basic course of events:

  1. Retrieve the event destination

Postconditions: Newly-created event subscription is added to the EventService.

Failure Scenario: None defined.

See also: None defined.

Suspend Replication Synchronization Activity between Consistency Groups

Summary: Suspend active data synchronization between a source and target ConsistencyGroup, without otherwise altering the replication relationship.

Purpose: Due to temporarily changed environmental constraints, the administrator wants to change the level of data protection between the target and source ConsistencyGroups.

Who: StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to reconfigure existing storage due to changing system or environment requirements.

Detailed Context: The admin needs to satisfy a user or application request to change the existing configuration between the existing target and source ConsistencyGroups in a replication relationship, without deleting the relationship.

Preconditions: User has already identified which target ConsistencyGroup to suspend.

Feature(s): Replication (both local and remote)

Inputs:

Basic Course of Events:

  1. Post (as an Action) the request on the source ConsistencyGroup.

This instructs the service to use the identified ConsistencyGroup as the source ConsistencyGroup for the specified replication relationship. For any additional details required, the service will rely on default values.

Request: POST /redfish/v1/Storage/1/ConsistencyGroups/CG_DB1/ConsistencyGroup.SuspendReplication

Headers: No additional headers required.

Body:


   {
    "TargetConsistencyGroup": "/redfish/v1/Storage/1/ConsistencyGroups/CG_DB2"
    }
    {
    "@SSM.Copyright": "Copyright (c) 2014-2021 SNIA. All rights reserved.",
    "@odata.context": "/redfish/v1/$metadata#ConsistencyGroup.ConsistencyGroup",
    "@odata.id": "/redfish/v1/Storage/1/ConsistencyGroups/CG_DB1",
    "@odata.type": "#ConsistencyGroup_1_0_0.ConsistencyGroup",
    "Name": "ConsistencyGroup DB1",
    "Id": "1",
    "Description": "Database group 1 primary",
    "ReplicaTargets":[{"@odata.id":"/redfish/v1/Storage/1/ConsistencyGroups/CG_DB2"}]
   }

Postconditions: The selected ConsistencyGroup has an updated ReplicaTargets entry for the new relationship. Elsewhere, there is a ConsistencyGroup “CG_DB2” in the system that has a ReplicaInfo which points back to this ConsistencyGroup and which contains all of the Replica configuration information. The replica state in the target ConsistencyGroup has been updated according to the requested action (e.g., from “Active” to “Suspended”).

Failure Scenario: None defined

See also: Suspend Replication Synchronization Activity

Suspend Replication Synchronization Activity

Summary: Suspend active data synchronization between a source and target volume, without otherwise altering the replication relationship.

Purpose: Due to temporarily changed environmental constraints, the administrator wants to change the level of data protection between the target and source volumes.

Who: StorageAdmin, DevOps

Management Domain: Block storage management

Triggers: Need to reconfigure existing storage due to changing system or environment requirements.

Detailed Context: The admin needs to satisfy a user or application request to change the existing configuration between the existing target and source volumes in a replication relationship, without deleting the relationship.

Preconditions: User has already identified which target volume to suspend.

Feature(s): Replication (both local and remote)

Inputs:

Basic Course of Events:

  1. Post (as an Action) the request on the source Volume.

This instructs the service to use the identified Volume as the source Volume for the specified replication relationship. For any additional details required, the service will rely on default values.

Request: POST /redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/1/Volume.SuspendReplication

Headers: No additional headers required.

Body:


   {
    "TargetVolume": "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/650973452245"
    }
    {
    "@SSM.Copyright": "Copyright (c) 2014-2021 SNIA. All rights reserved.",
    "@odata.context": "/redfish/v1/$metadata#Volume.Volume",
    "@odata.id": "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/1",
    "@odata.type": "#Volume_1_4_0.Volume",
    "Name": "Volume 65",
    "Id": "1",
    "Description": "",
    "ReplicaTargets":[{"@odata.id":"/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/650973452245"}]
   }

Postconditions: The selected volume has an updated ReplicaTargets entry for the new relationship. Elsewhere, there is a volume “650973452245” in the system that has a ReplicaInfo which points back to this volume and which contains all of the Replica configuration information. The replica state in the target volume has been updated according to the requested action (e.g., from “Active” to “Suspended”).

Failure Scenario: None defined

See also: Suspend Replication Synchronization Activity (CG)