Swordfish Scalable Storage Management API User’s Guide

Version 1.1.0a

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.

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. Suggestions for revision should be directed to http://www.snia.org/feedback/.

Technical Position

Last Updated 12 November 2019

USAGE

Copyright (c) 2016 - 2019 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:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of The Storage Networking Industry Association (SNIA) nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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

Revision History

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.

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:

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.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.3. DevOps
3.4. Storage Admin
4. Management domains
4.1. Management Domain Overview
4.2. Application storage management domain
4.3. Block storage management domain
4.4. Service catalog management domain
4.5. File system storage management domain
5. User Guidance
6. Features
6.1. Overview
6.2. Block provisioning feature
6.3. Capacity management feature
6.4. Class of Service Features
6.5. Event notification feature
6.6. File provisioning feature
6.7. Block IO performance feature
6.8. Block mapping and masking feature
6.9. Replication Feature
7. Use cases
7.1. Use cases by feature
7.2. Alphabetic list of use cases

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.

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:

• An appropriate security infrastructure (e.g., TLS 1.2)
• A functional Swordfish/Redfish installation, in either a standalone, aggregator, or distributed configuration
• Any required login credentials

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:

• For RESTful APIs: Wikipedia
• For Redfish standards: Redfish Specification
• For HTTP standards: Wikipedia

1.6. Related documents

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

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.

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.

Request headers

Response headers

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:

• A singleton object (e.g., a specific storage LUN or Volume)
• A collection of objects (e.g., the list of all LUNs provided by a specific storage array)

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: Query Options.

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.

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:

• Alphabetically. Each use case is ordered according to a self-expanatory title, to make it easier for an experienced user to find a specifc piece of guidance.
• By management domain. While each organization will allocate responsibilities differently, there are general broad classes of storage management that share tasks. These are called management domains.
• By actor. Similarly, the precise titles and responsibilities within storage management organizations will differ from one organization to the next, but this guide has identified three broad functional roles, and identfied the use cases that are most applicable to those roles:
  • Cloud Admin: tasked with managing all aspects of cloud-based infrastructure including storage;
  • Storage Admin: tasked with operational storage tasks, such as storage lifecycle planning and day-to-day storage administration;
  • DevOps: tasked with leveraging storage configurations to automate and scale business operations.

3.2. CloudAdmin

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

• Hyper-converged
• Rack-converged
• Hyper-scale

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:

• designates a group of people to build and maintain a virtualized, converged, and/or cloud environment
• spans compute, storage, and networking disciplines as their job is to manage the operational lifecycle of the entire environment
• focuses on automation that involves scripting and potentially formal programming
• This role’s value is to keep the environment that hosts applications available and responding. Deep subject matter expertise is less valuable unless it helps solve an issue.
• The focus for this role is to streamline the deployment of applications into the infrastructure including all the network and storage configuration.
• This role gets involved in the physical deployment of capacity in the datacenter.
• This role deals with software defined infrastructure deployment and management.
• Applications can span physical, virtual machine, container, PaaS building blocks. This role is expected to know how to best configure the “stack” to consume the underlying physical infrastructure.

Use Cases

• Create StorageGroup
• Create Volume from an Existing Storage Pool
• Create an on-demand snaphot of a Volume
• Create file share
• Subscribe to threshold events

3.3. DevOps

A member of the DevOps group:

• Consumes infrastructure capacity offered as a service/building blocks.
• Develops and deploys programmatic requests for capacity (fully automated, no ticketing or human intervention)
• Provisions storage as a virtual appliance on-premises or in the cloud as part of a larger application deployment
• Deploys ‘cloud born apps’ to consume object storage APIs (S3, Swift)

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:

• does not get involved in the physical deployment of capacity in the datacenter
• is responsible for automating infrastructure provisioning as part of the E2E deployment and management of an application with minimal or no human intervention
• consumes higher level services and protocols from the infrastructure; understanding how the device works is not interesting
• expects to consume the programmable interfaces of a device using their existing tools (REST, Python, Ansible, Puppet, Chef, Ruby etc.)

Use Cases

• Create a New Replication Relationship by Assigning a Target Volume
• Create a New Replication Relationship by Assigning an existing Target Consistency Group
• Create an on-demand snapshot of a Volume
• Create class of service
• Create file share
• Create file system
• Create line of service
• Create storage pool
• Create storage pool using Specified Set of Drives
• Create storage pool using Specified Set of Drives and RAIDTypes
• Create Volume from an Existing Storage Pool
• Expand capacity of a storage volume
• Health updates
• Make a New Replication Relationship by Creating a Target Consistency Group
• Make a New Replication Relationship by Creating a Target Volume
• Remove Replication Relationship
• Remove Replication Relationship for a Consistency Group
• Resume the Replication Synchronization Activity
• Resume the Replication Synchronization Activity for a Consistency Group
• Reverse a Replication Relationship
• Reverse a Replication Relationship for Consistency Groups
• Split a Replica
• Split a set of Replicas in Consistency Groups
• Subscribe to Threshold Events
• Suspend Replication Synchronization Activity
• Suspend Replication Synchronization Activity between Consistency Groups

3.4. Storage Admin

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

• Virtualization (traditional virtualization VMware, Hyper-V)
• private cloud (self-service portal)
• hybrid cloud (can span private, colo, hosted, and public cloud)
• IaaS/PaaS stacks (modern app/devops)

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:

• Organizations can have one or more people exclusively assigned to operating lifecycle of storage in the datacenter.
• The storage admin role is typically tasked with “figuring out” storage needs for the company
  
• The admin role can consist of level 2 operators and level 3 engineers and architects.
• The admin role deals with multiple storage devices from multiple vendors across one or more datacenters.
• Storage devices attached to multiple operating systems (Linux, Windows, Mainframe, Unix, virtualized, bare metal).
• The Admin role consists of deep storage subject matter expertise, may or may have general practitioners across all disciplines
• Members of this role are typically skilled at scripting and formal programming
• In a converged environment (storage, compute, and networking converged in to a rack), the storage admin role may choose to avoid/minimize involvement in the support of storage WITHIN the rack. (e.g. in virtualization, a single physical port can host 1000s of VMs).

Use Cases

• Create a New Replication Relationship by Assigning a Target Volume
• Create a New Replication Relationship by Assigning an existing Target Consistency Group
• Create an on-demand snapshot of a Volume
• Create class of service
• Create file share
• Create file system
• Create line of service
• Create storage pool
• Create storage pool using Specified Set of Drives
• Create storage pool using Specified Set of Drives and RAIDTypes
• Create Volume from an Existing Storage Pool
• Expand capacity of a storage volume
• Health updates
• Make a New Replication Relationship by Creating a Target Consistency Group
• Make a New Replication Relationship by Creating a Target Volume
• Remove Replication Relationship
• Remove Replication Relationship for a Consistency Group
• Resume the Replication Synchronization Activity
• Resume the Replication Synchronization Activity for a Consistency Group
• Reverse a Replication Relationship
• Reverse a Replication Relationship for Consistency Groups
• Scalable storage management API user’s guide
• Split a Replica
• Split a set of Replicas in Consistency Groups
• Subscribe to Threshold Events
• Suspend Replication Synchronization Activity
• Suspend Replication Synchronization Activity between Consistency Groups

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:

• Alphabetically. Each use case is ordered according to a self-expanatory title, to make it easier for an experienced user to find a specifc piece of guidance.

• By actor. While the precise titles and responsibilities within storage management organizations will differ from one organization to the next, this guide has identified three broad functional roles, known as actorsand identfied the use cases that are most applicable to those roles;

• By management domain. Similarly, while each organization will allocate responsibilities differently, there are general broad classes of storage management that share tasks. This guide has identified four management domains:

  • Application Storage Management: which manages the interface between applications and the storage that they rely upon;
  • Block Storage Management: focused on the management of resources that provide block-based access to storage;
  • File System Management: which provides access to byte-accessible storage through file-based protocols;
  • Service Catalog Management: which supports access to, and management of, a catalog of service options.

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.

Use cases

• Subscribe to Threshold Events

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.

Use Cases

• Create a New Replication Relationship by Assigning a Target Volume
• Create a New Replication Relationship by Assigning an existing Target Consistency Group
• Create an on-demand snaphot of a Volume
• Create class of service
• Create line of service
• Create storage pool
• Create storage pool using Specified Set of Drives
• Create storage pool using Specified Set of Drives and RAIDTypes
• Create StorageGroup
• Create Volume from an Existing Storage Pool
• Expand capacity of a storage volume
• Health updates
• Make a New Replication Relationship by Creating a Target Consistency Group
• Make a New Replication Relationship by Creating a Target Volume
• Remove Replication Relationship
• Remove Replication Relationship for a Consistency Group
• Resume the Replication Synchronization Activity
• Resume the Replication Synchronization Activity for a Consistency Group
• Reverse a Replication Relationship
• Reverse a Replication Relationship for Consistency Groups
• Split a Replica
• Split a set of Replicas in Consistency Groups
• Subscribe to Threshold Events
• Suspend Replication Synchronization Activity
• Suspend Replication Synchronization Activity between Consistency Groups

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.

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.

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:

• Whether encryption keys are drive or array resident or externally managed (e.g., via KMIP).

• Information on how the array supports compliance to a standard identified in the name of the Service option. (e.g., specific algorithms employed that are FIPS-140 compliant, information about the validated cryptographic module and its validation certificate, relationship of the security functionality to specific PCI or HIPAA requirements).

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.

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.

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.

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.

Use cases

• Create class of service
• Create line of service

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.

Use cases

• Create file share
• Create file system

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:

• Block capacity management
• Block IO performance
• Block provisioning
• Discovery
• EnergyStar
• Event notification
• File provisioning
• File capacity management
• Mapping and masking
• Replication (both local and remote)

6.2. Block provisioning feature

Overview

This feature provides basic, block-based storage provisioning.

Feature-specific Guidance

None defined.

Block provisioning use cases

6.3. Capacity management feature

Overview

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

Feature-specific Guidance

None defined.

Capacity management use cases

6.4. Class of Service Features

Overview

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

Feature-specific Guidance

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.

Class of service use cases

6.5. Event notification feature

Overview

This feature provides basic eventing.

Feature-specific Guidance

None defined.

Event notification use cases

6.6. File provisioning feature

Overview

This feature provides file-based storage provisioning.

Feature-specific Guidance

None defined.

File provisioing use cases

6.7. Block IO performance feature

Overview

This feature provides basic performance metrics.

Feature-specific Guidance

None defined.

IO performance use cases

6.8. Block mapping and masking feature

Overview

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

Feature-specific Guidance

None defined.

Mapping and masking use cases

6.9. Replication Feature

Overview

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

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.

Replication use cases

7. Use cases

7.1. Use cases by feature

Uncategorized Use Cases

Block provisioning use cases

Capacity management use cases

Class of service use cases

Event notification use cases

File provisioing use cases

IO performance use cases

Mapping and masking use cases

Replication use cases

7.2. Alphabetic list of use cases

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:

• URL for target volume: /redfish/v1/Storage/1/Volumes/650973452245

• Requested replica type: Mirror

• ReplicaUpdateMode: Synchronous

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/Volumes/1/Volume.AssignReplicaTarget

Headers: No additional headers required.

Body:

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

• Response contains the details of the created volume.

  Response:

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

  Body:

  {
  "@SSM.Copyright": "Copyright (c) 2014-2019 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": "Volume 65",
  "Id": "1",
  "Description": "",
  "ReplicaTargets": [
  {
  "@odata.id" : "/redfish/v1/Storage/1/Volumes/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.

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:

• URL for target volume: /redfish/v1/Storage/1/ConsistencyGroup/CG_DB2

• Requested replica type: Mirror

• ReplicaUpdateMode: Synchronous

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"
 }

• Response contains the details of the created volume.

  Response:

  Headers: Location = /redfish/v1/Storage/1/ConsistencyGroup/CG_DB1

  Body:

  {
  "@SSM.Copyright": "Copyright (c) 2014-2019 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/ConsistencyGroup/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.

Failure Scenario: None defined

See also: Assign Replica Target.

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:

• URL for storage service: /redfish/v1/StorageServices/1
• URL for the volume: /redfish/v1/StorageServices/1/Volumes/1

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

• Headers:
  No additional headers required.
  

• Body:
  None
  

• Response:
  200 Success
  

• Headers:
  No additional headers required.
  

• Body:

  {  
      "SupportedLinesOfService": [  
          {   
              "@odata.id": "/redfish/v1/StorageServices/1/Links/DataProtectionLoSCapabilities/SupportedLinesOfService/OnDemandSnapshot",  
              "Name": "OnDemandSnapshot",  
              "RecoveryGeographicObjective": "Server",  
              "ReplicaType": "Snapshot",  
          }  
      ]  
  }

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

• Headers:
  No additional headers required.

• Body:

  {
      "ReplicaRequests": [{
          "ReplicaSource": {"@odata.id": "/redfish/v1/StorageServices/1/Volumes/1"},
          "ReplicaName": "MySnapshot"
      }]
  }

• Response:
  200 Success

• Headers:
  No additional headers required.

• Body:
  

  [ {  
      "@odata.context": "/redfish/v1/$metadata#StorageReplicaInfo.v1_1_0.StorageReplicaInfo",  
      "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/Volumes/MySnapshot"},  
      "DataProtectionLineOfService": "/redfish/v1/StorageServices/1/Links/DataProtectionLoSCapabilities/SupportedLinesOfService/OnDemandSnapshot"}  
  ]      

Postconditions:
The original Volume (/redfish/v1/StorageServices/1/Volumes/1) now has a snapshot volume (/redfish/v1/StorageServices/1/Volumes/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.

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:

• URL for Storage Service: /redfish/v1/StorageServices(1)

• New class of service characteristics

  • Name: "SSD"

  • Description: "Minimal SSD class of service."

  • IOPerformanceLineOfService

    • “Name”: "SSDLoS"
    • “IOOperationsPerSecondIsLimited”: false
    • “MaxIOOperationsPerSecondPerTerabyte”: 100000
    • “AverageIOOperationLatencyMicroseconds”: 10

Basic Course of Events:

1. Create ClassOfService

• Request: POST /redfish/v1/StorageServices(1)/ClassesOfService/Members

  • Headers: No additional headers required.

  • Body:

  {
    "Name": "SSD",
    "Description": "Minimal SSD class of service.",
    "LinesOfService": {
        "IOPerformanceLinesOfService": [ {
            "Name": "SSDLoS",
            "IOOperationsPerSecondIsLimited": false,
            "MaxIOOperationsPerSecondPerTerabyte": 100000,
            "AverageIOOperationLatencyMicroseconds": 10
      }]
    }
  }

2. Response:

• Headers:

  Location= /redfish/v1/StorageServices(1)/ClassesOfService(SSD)

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

Failure Scenario: None defined.

See also: None defined.

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:

• URL for the filesystem: /redfish/v1/StorageServices/1/FileSystems/QuickFiles
• The path to the shared file: "/Shares/MyShare"
• Description: "Share of files under MyShare."

Basic Course of Events:

1. Create a file share

• Request: POST /redfish/v1/StorageServices/1/FileSystems/QuickFiles/ExportedShares

  • Headers: No additional headers required.

  • Body:

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

• Response:

  • Headers:

    Location= /redfish/v1/StorageServices/1/FileSystems/QuickFiles/ExportedShares/MyShare

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

Failure Scenario: None defined.

See also: None defined.

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:

• URL for storage service: /redfish/v1/StorageServices/1

• Name for the new file system: "QuickFiles"

• Description: "100 TB FileSystem having SSD class storage."

• URL for class of service: /redfish/v1/StorageServices/1/Links/ClassesOfService/SSD

• File system capacity:

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

  Basic Course of Events:

  1. Create FileSystem

• Request: POST /redfish/v1/StorageServices/1/FileSystems

  • Headers: No additional headers required.

  • Body:

    {
      "Name": "QuickFiles",
      "Description": "100 TB FileSystem having SSD class storage.",
      "Capacity": {
          "Data": {
              "ProvisionedBytes": 100000000000000
          },
          "IsThinProvisioned": true
      },
      "Links" : {
          "ClassOfService": {"odata.id":
              "/redfish/v1/StorageServices/1/Links/ClassesOfService/SSD"}
      }
    }

• Response:

  • Headers:
    Location= /redfish/v1/StorageServices/1/FileSystems/QuickFiles

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

Failure Scenario: None defined.

See also: None defined.

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:

• URL for storage service: /redfish/v1/StorageServices/1

• Name for the new file system: "QuickFiles"

• Description: "100 TB FileSystem having SSD class storage."

• URL for class of service: /redfish/v1/StorageServices/1/Links/ClassesOfService/SSD

• File system capacity:

  {
    "Data":
    {
        "ProvisionedBytes": 100000000000000;
        "IsThinProvisioned": true;
      }
  }

  Basic Course of Events:

  1. Create FileSystem

• Request: POST /redfish/v1/StorageServices/1/FileSystems

  • Headers: No additional headers required.

  • Body:

    {
      "Name": "QuickFiles",
      "Description": "100 TB FileSystem having SSD class storage.",
      "Capacity": {
          "Data": {
              "ProvisionedBytes": 100000000000000
          },
          "IsThinProvisioned": true
      },
      "Links" : {
          "ClassOfService": {"odata.id":
              "/redfish/v1/StorageServices/1/Links/ClassesOfService/SSD"}
      }
    }

• Response:

  • Headers:
    Location= /redfish/v1/StorageServices/1/FileSystems/QuickFiles

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

Failure Scenario: None defined.

See also: None defined.

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:

• URL for Storage Service: /redfish/v1/StorageServices/1

• New IO performance line of service

  {
  "Name": "NewSSDLoS",
  "IoOperationsPerSecondIsLimitedBoolean": false,
  "MaxIoOperationsPerSecondPerTerabyte": 100000,
  "AverageIoOperationLatencyMicroseconds": 10
  }

  Basic Course of Events:

1. Get existing supported lines of service

• Request:

  GET /redfish/v1/StorageServices/1/Links/IOPerformanceLoSCapabilities/SupportedIOPerformanceLinesOfService

  • Headers: No additional headers required.

• Reply:

  • Headers: `ETag: “123-a”``

  • Body:

    {
    "Value": [{
       "Name": "LoS1",
       "IoOperationsPerSecondIsLimitedBoolean": false,
       "SamplePeriodSeconds": 60,
       "MaxIoOperationsPerSecondPerTerabyte": 83,
       "AverageIoOperationLatencyMicroseconds": 8000,
    },
    {
       "Name": "LoS2",
       "IoOperationsPerSecondIsLimitedBoolean": "false",
       "SamplePeriodSeconds": 60,
       "MaxIoOperationsPerSecondPerTerabyte": 133,
       "AverageIoOperationLatencyMicroseconds": 5000,
       "IOWorkload": {
          "Name": "Duplicon: OLTP"
       }
    }]
    }

2. Create new line of service

• Request:

  PATCH /redfish/v1/StorageServices/1/Links/IOPerformanceLoSCapabilities

  • Headers:

    `If-Match: "123-a"`

  • Body:

    {
      "SupportedIOPerformanceLinesOfService":[{
          "Name": "LoS1",
          "IoOperationsPerSecondIsLimitedBoolean": false,
          "SamplePeriodSeconds": 60,
          "MaxIoOperationsPerSecondPerTerabyte": 83,
          "AverageIoOperationLatencyMicroseconds": 8000
      },
      {
          "Name": "LoS2",
          "IoOperationsPerSecondIsLimitedBoolean": "false",
          "SamplePeriodSeconds": 60,
          "MaxIoOperationsPerSecondPerTerabyte": 133,
          "AverageIoOperationLatencyMicroseconds": 5000,
          "IOWorkload": {
              "Name": "Duplicon: OLTP"
              }
      },
      {
          "Name": "NewSSDLoS",
          "IoOperationsPerSecondIsLimitedBoolean": "false",
          "MaxIoOperationsPerSecondPerTerabyte": 100000,
          "AverageIoOperationLatencyMicroseconds": 10
      }]
    }

• Response:

  • Headers: None defined.
  • Body: None defined.

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

Failure Scenario: None defined.

See also: None defined.

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:

• URL for storage pool collection:

  • NSB: /redfish/v1/Storage/1/StoragePool

  • (Also applicable to SB: /redfish/v1/StorageServices/1/StoragePool)

• Name for the new storage pool: "SSD"

• Description: "SSD Storage Pool"

• Set of Drives:

    {
    "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"}  
    ]
}

• Set of Supported RAIDTypes:

{
"SupportedRAIDTypes": ["RAID1","RAID5","RAID50"]
}

Basic Course of Events:

1. Create StoragePool

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

  • Headers: No additional headers required.

  • Body:

  {
  "Name": "SSD",
  "Description": "Storage Pool for RAID1, 5 or 50.",
  "RAIDTypes": ["RAID1","RAID5","RAID50"],
  "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"}
  ]

• Response: None.

• Headers:

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.

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:

• URL for storage pool collection:

  • NSB: /redfish/v1/Storage/1/StoragePool

  • (Also applicable to SB: /redfish/v1/StorageServices/1/StoragePool)

• Name for the new storage pool: "SP1"

• Description: "Storage Pool 1"

• Set of Drives:

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

Basic Course of Events:

1. Create StoragePool

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

  • Headers: No additional headers required.

  • Body:

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

• Response:

• Headers:

  `Location=/redfish/v1/Storage/1/StoragePools/SP1`

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

Failure Scenario: None defined.

See also: None defined.

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:

• URL for storage service: /redfish/v1/StorageServices/1
• Name for the new storage pool: "SSD"
• Description: "100 TB pool of SSD class storage."
• URL for class of service: /redfish/v1/StorageServices/1/ClassesOfService/SSD
• Storage pool capacity

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

Basic Course of Events:

1. Create StoragePool

• Request: POST /redfish/v1/StorageServices/1/StoragePools/Members

  • Headers: No additional headers required.

  • Body:

{
    "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"
        }]
    }
}

• Response:

  • Headers:

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

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

Failure Scenario: None defined.

See also: None defined.

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:

• URL for storage service: /redfish/v1/StorageService
• The proposed name of the new StorageGroup (string): “HillOfBeans1”
• A description of the new StorageGroup (string): “New storage group to support accounting”
• A consistency requirement for the new StorageGroup (boolean). When TRUE, all copies of data within a StorageGroup must be kept in sync: true

Basic Course of Events:

1. Create StorageGroup

• Request: POST /redfish/v1/StorageService/StorageGroups/Members

  • Headers: No additional headers required.

  • Body:

    {
    "Name" : "HillOfBeans1",
    "Description" : "New storage group to support accounting",
    "MembersAreConsistent" : true
    }

• Response: None defined.

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

Failure Scenario: None defined.

See also: None defined.

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:

• URL for Storage Pool: /redfish/v1/Storage/1/StoragePools/PrimaryPool
• Requested volume size in bytes (1 TiB, here): 1099511627776
• Requested name of volume: "MyVolume"
• RAIDType: RAID1

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"
 }

• Response contains the details of the created volume.

  Response:

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

  Body:

  
   {
   "@SSM.Copyright": "Copyright (c) 2014-2019 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": {
       "StoragePool": "/redfish/v1/Storage/1/StoragePools/1"
   }
  }

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

Failure Scenario: None defined

See also: None defined.

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:

• URL for Volume Collection: /redfish/v1/Storage/1/Volumes
• Requested volume size in bytes (1 TiB, here): 1099511627776
• Requested name of volume: "MyVolume"
• RAIDType: RAID1
• Drives: Two drives (to satisfy the requested RAID level) from /redfish/v1/Storage/1/Drives: - /redfish/v1/Storage/1/Drive/1 - /redfish/v1/Storage/1/Drive/2

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 contains the details of the created volume.

Response:

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

Body:

    {  
    "@SSM.Copyright": "Copyright (c) 2014-2019 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:

• URL for Storage Service: /redfish/v1/StorageServices/1
• Requested volume size in bytes (for 1TiB in this example): 1099511627776
• URL for requested class of service: /redfish/v1/StorageServices/1/ClassesofService/BostonBunker
• Requested name of volume (string): "Snapshot1"

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.

• Request: POST /redfish/v1/StorageServices/1/Volumes/Members

• Headers: No additional headers required.

• Body:

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

• Response:

• Headers:

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

• Body:

{  
   "\@SSM.Copyright": "Copyright (c) 2014-2016 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.

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:

• Application monitoring tool warns the admin that a storage volume used by a critical application is at 80% capacity
• Storage volumes can be expanded during the week without approval during non-business hours
• Administrator checks the available capacity on the storage pool based on the class of service required to ensure the storage volume expansion is possible
• During proper maintenance window, administrator expands storage volume based on predefined SLA established with application owner

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:

• Low storage capacity warning and critical alerts only apply to storage volumes with application data (the storage administrator is not responsible for the OS disks of the servers)
• Administrator can expand the storage volume by 25% up to 3 times without additional approvals for a maintenance window as long as the work is done during non-business hours (business hours are 7AM - 7PM local).
• Storage volumes for this application cannot exceed 2TB.
• Storage volume will be tagged with metadata to indicate the original size of the volume.
• Administrator is responsible for informing the application owner if the storage system is running low and overall capacity putting the SLA at risk. Administrator and application owner must plan for a migration of the application if waiting for additional storage disks/shelves to arrive is not feasible.

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:

• Storage system has at least one storage pool with at least one storage volume
• Storage pool has enough available capacity to expand the storage volume by 25%

Feature(s): Block capacity management

Inputs:

• URL for the Swordfish service: /redfish/v1/StorageService/1
• Storage pool name: BasePool
• Storage volume name: 61001234876545676100123487654567

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

• Request: GET /redfish/v1/StorageServices/1/Volumes/61001234876545676100123487654567

• Response:

{
  "@Redfish.Copyright": "Copyright 2015-2016 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

• Request: GET /redfish/v1/StorageServices/1/StoragePools/BasePool

• Response:

  {
  "@Redfish.Copyright": "Copyright 2015-2016 SNIA. All rights reserved.",
  "@odata.context": "/redfish/v1/$metadata#StoragePool.StoragePool",
  "@odata.id": "/redfish/v1/StorageServices/1/StoragePools/BasePool",
  "@odata.type": "#StoragePool.1_0_0.StoragePool",
  "Id": "BasePool",
  "Name": "BasePool",
  "Description": "Base storage pool for this storage service",
  "Status": {
  "State": "Enabled",
  "Health": "OK",
  "HealthRollUp": "Degraded"
  },
  "BlockSizeBytes": 8192,
  "Capacity": {
  "Data": {
  "ConsumedBytes": 824633720832,
  "AllocatedBytes": 1099511627776
  },
  "Metadata": null,
  "Snapshot": null
  },
  "CapacitySources": [
  {
  "ProvidedCapacity": {
    "ConsumedBytes": 70368744177664,
    "AllocatedBytes": 140737488355328,
    "GuaranteedBytes": 17592186044416,
    "ProvisionedBytes": 562949953421312
  },
  "Links": {
    "ClassOfService": {
      "@odata.id": "/redfish/v1/StorageServices/1/ClassesOfService/GoldBoston"
    },
    "ProvidingPool": null,
    "ProvidingVolume": null
  }
  }
  ],
  "LowSpaceWarningThresholdPercent": [
  70,
  80,
  90
  ],
  "Links": {
  "AllocatedPools": [],
  "AllocatedVolumes": [
  {
    "@odata.id": "/redfish/v1/StorageServices/1/Volumes/61001234876545676100123487654567"
  }
  ],
  "SupportedClassesOfService": [
  {
    "@odata.id": "/redfish/v1/StorageServices/1/ClassesOfService/GoldBoston"
  },
  {
    "@odata.id": "/redfish/v1/StorageServices/1/ClassesOfService/SilverBoston"
  }
  ]
  }
  }

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

• Request: PATCH /redfish/v1/StorageServices/1/Volumes/61001234876545676100123487654567

  • Headers: No additional headers required

  • Body:

    
      {
        "Capacity": {
          "Data": {
            "AllocatedBytes": 1374389534720
           }
         }  
      }

• Response:

  {
  "taskid":"ExpandTask123"
  }

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:

• Application monitoring tool warns devops that the application is processing less requests based on a predefined threshold
• Devops has a simple script that queries Redfish capable infrastructure and pulls performance metrics
• Devops collect infrastructure performance metrics as part of an end-to-end diagnostics workflow to help identify potential bottlenecks

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:

• Storage system has at least one storage pool with at least one storage volume
• Storage volume is exposed to at least one initiator
• Initiator is driving I/O to the volume

Feature(s): Block IO performance

Inputs:

• URL of the Swordfish storage service: /redfish/v1/StorageServices/1
• Storage pool volume name: 4

Basic course of events:

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

• Request: GET /redfish/v1/StorageServices/1/Volumes/4/Metrics

  • Headers: No additoinal headers required.
  • Body: None defined.

• Response:

  {
  "@Redfish.Copyright": "Copyright 2015-2016 SNIA. All rights reserved.",
  "@odata.context": "/redfish/v1/$metadata#VolumeMetrics.VolumeMetrics",
  "@odata.id": "/redfish/v1/StorageServices/1/Volumes/4/Metrics",
  "@odata.type": "#VolumeMetrics.v1_0_0.VolumeMetrics",
  "Id": "Metrics",
  "Name": "Volume 1 Metrics",
  "CurrentPeriod": {
  "BlocksRead": 125534,
  "BlocksWritten": 542653
  },
  "Lifetime": {
  "BlocksRead": 125534,
  "BlocksWritten": 542653
  },
  "PerformanceData": {
  "AverageSecondsPerRead": 1,
  "AverageSecondsPerWrite": 1,
  "AverageSecondsPerTransfer": 1,
  "ReadsPerSecond": 2134,
  "WritesPerSecond": 4325,
  "TransfersPerSecond": 6459,
  "WriteBlocksPerSecond": 3085784,
  "ReadBlocksPerSecond": 9257350,
  "BlocksPerSecond": 12343134
  },
  "Actions": {
  "#Volume.ClearCurrentPeriod": {
      "target": "/redfish/v1/StorageServices/1/Volumes/4/Actions/Volume.ClearCurrentPeriod"
  },
  "Oem": {}
  },
  "Oem": {}
  }

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:

• URL for Storage Pool: /redfish/v1/Storage/1/StoragePools/PrimaryPool

• Requested replica type: Mirror

• Requested name of ConsistencyGroup (string): CG_DB2

• ReplicaUpdateMode: Synchronous

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"
 }

• Response contains the details of the created ConsistencyGroup.

  Response:

  Headers: Location = /redfish/v1/Storage/1/ConsistencyGroups/CG_DB1

  Body:

  {
  "@SSM.Copyright": "Copyright (c) 2014-2019 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/23423"}]
  }

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

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:

• URL for Storage Pool: /redfish/v1/Storage/1/StoragePools/PrimaryPool

• Requested replica type: Mirror

• Requested name of volume (string): Mirror of Volume 65

• ReplicaUpdateMode: Synchronous

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/Volumes/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"
    }

• Response contains the details of the created volume.

  Response:

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

  Body:

    {
    "@SSM.Copyright": "Copyright (c) 2014-2019 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": "Volume 65",
    "Id": "1",
    "Description": "",
    "ReplicaTargets":[{"@odata.id":"/redfish/v1/Storage/1/Volumes/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)

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:

• URL for target replica: /redfish/v1/Storage/1/ConsistencyGroups/CG_DB2
• Boolean value to determine whether target ConsistencyGroup should be retained or not: false

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"
    }

• Response contains the details of the source ConsistencyGroup.

  Response:

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

  Body:

    {
    "@SSM.Copyright": "Copyright (c) 2014-2019 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

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:

• URL for target replica: /redfish/v1/Storage/1/Volumes/650973452245
• Boolean value to determine whether target volume should be retained or not: false

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/Volumes/1/Volume.RemoveReplicaRelationship

Headers: No additional headers required.

Body:

   {
    "TargetVolume" : "/redfish/v1/Storage/1/Volumes/650973452245",
    "DeleteTargetVolume" : "false"
    }

• Response contains the details of the source volume.

  Response:

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

  Body:

  {
  "@SSM.Copyright": "Copyright (c) 2014-2019 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": "Volume 65",
  "Id": "1",
  "Description": ""
  }

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)

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:

• URL for target replica: /redfish/v1/Storage/1/ConsistencyGroups/CG_DB2

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"
    }

• Response contains the details of the source ConsistencyGroup.

  Response:

  Headers: Location = /redfish/v1/Storage/1/ConsistencyGroups/CG_DB1

  Body:

    {
    "@SSM.Copyright": "Copyright (c) 2014-2019 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

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:

• URL for target replica: /redfish/v1/Storage/1/Volumes/650973452245

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/Volumes/1/Volume.ResumeReplication

Headers: No additional headers required.

Body:

   {
    "TargetVolume" : "/redfish/v1/Storage/1/Volumes/650973452245"
    }

• Response contains the details of the source volume.

  Response:

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

  Body:

    {
    "@SSM.Copyright": "Copyright (c) 2014-2019 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": "Volume 65",
    "Id": "1",
    "Description": "",
    "ReplicaTargets":[{"@odata.id":"/redfish/v1/Storage/1/Volumes/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)

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:

• URL for target replica: /redfish/v1/Storage/1/ConsistencyGroups/CG_DB2

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"
    }

• Response contains the details of the source ConsistencyGroup.

  Response:

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

  Body:

    {
    "@SSM.Copyright": "Copyright (c) 2014-2019 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

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:

• URL for target replica: /redfish/v1/Storage/1/Volumes/650973452245

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/Volumes/1/Volume.ReverseReplicationRelationship

Headers: No additional headers required.

Body:

   {
    "TargetVolume" : "/redfish/v1/Storage/1/Volumes/650973452245"
    }

• Response contains the details of the source volume.

  Response:

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

  Body:

    {
    "@SSM.Copyright": "Copyright (c) 2014-2019 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": "Volume 65",
    "Id": "1",
    "Description": "",
    "ReplicaInfos": [{
      "ReplicaState": "Failedover",
      "ReplicaType": "Snapshot",
      "ReplicaPriority": "Default",
      "ReplicaRecoveryMode": "Manual",
      "ReplicaUpdateMode": "Asynchronous",
      "Replica": {"@odata.id": "/redfish/v1/Storage/1/Volumes/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/Volumes/1”).

Failure Scenario: None defined

See also: Reverse a Replication Relationship (CG)

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:

• URL for target replica: /redfish/v1/Storage/1/Volumes/650973452245

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/Volumes/1/Volume.SplitReplication

Headers: No additional headers required.

Body:

   {
    "TargetVolume": "/redfish/v1/Storage/1/Volumes/650973452245"
    }

• Response contains the details of the source volume.

  Response:

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

  Body:

    {
    "@SSM.Copyright": "Copyright (c) 2014-2019 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": "Volume 65",
    "Id": "1",
    "Description": "",
    "ReplicaTargets":[{"@odata.id":"/redfish/v1/Storage/1/Volumes/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)

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:

• URL for target replica: /redfish/v1/Storage/1/ConsistencyGroups/CG_DB2

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"
    }

• Response contains the details of the source ConsistencyGroup.

  Response:

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

  Body:

    {
    "@SSM.Copyright": "Copyright (c) 2014-2019 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

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:

• The URL of the StorageService: /redfish/v1/StorageServices/Simple1

• The Volume to be monitored: Vol1

• The subscription destination: "http://www.dnsname.com/Destination1"

• An array of events to be subscribed:

  ["LowSpaceWarningThresholdTriggered", "LowSpaceWarningThresholdCleared"]

Basic course of events:

1. Retrieve the event destination

• Request: POST /redfish/v1/EventService/Subscriptions/Members

  • Headers: No additional headers required.

  • Body:

    {
    "@Redfish.Copyright": "Copyright 2016-2017 Storage Networking Industry Association (SNIA), USA. All rights reserved. For the full SNIA copyright policy, see http://www.snia.org/about/corporate_info/copyright",
    "@odata.context": "/redfish/v1/$metadata#EventDestination.EventDestination",
    "@odata.type": "#EventDestination.v1_0_2.EventDestination",
    "Name": "Volume1 Usage Threshold",
    "Destination": "http://www.dnsname.com/Destination1",
    "EventTypes": [
    "Alert"
    ],
    "Context": "WebUser3",
    "Protocol": "Redfish",
    "OriginResources": [{"odata.id" : "/redfish/v1/StorageServices/Simple1/Volumes/Vol1"}],
    "MessageIds": ["LowSpaceWarningThresholdTriggered", "LowSpaceWarningThresholdCleared"]
    }

• Response: 201 - Created

  {
  "Location": "/redfish/v1/EventService/Subscriptions/1/Members/1e7da"
  }

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:

• URL for target replica: /redfish/v1/Storage/1/ConsistencyGroups/CG_DB2

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"
    }

• Response contains the details of the source ConsistencyGroup.

  Response:

  Headers: Location = /redfish/v1/Storage/1/ConsistencyGroups/CG_DB1

  Body:

    {
    "@SSM.Copyright": "Copyright (c) 2014-2019 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:

• URL for target replica: /redfish/v1/Storage/1/Volumes/650973452245

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/Volumes/1/Volume.SuspendReplication

Headers: No additional headers required.

Body:

   {
    "TargetVolume": "/redfish/v1/Storage/1/Volumes/650973452245"
    }

• Response contains the details of the source volume.

  Response:

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

  Body:

    {
    "@SSM.Copyright": "Copyright (c) 2014-2019 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": "Volume 65",
    "Id": "1",
    "Description": "",
    "ReplicaTargets":[{"@odata.id":"/redfish/v1/Storage/1/Volumes/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)