ISO/IEC 5965:2023
(Main)Information technology — Swordfish Scalable Storage Management API Specification
Information technology — Swordfish Scalable Storage Management API Specification
This document defines a RESTful interface and a standardized data model to provide a scalable, customer-centric interface for managing storage and related data services. It extends the Redfish Scalable Platforms Management API Specification (DSP0266) from the DMTF.
Titre manque
General Information
Relations
Standards Content (Sample)
INTERNATIONAL ISO/IEC
STANDARD 5965
Second edition
2023-05
Information technology — Swordfish
Scalable Storage Management API
Specification
Reference number
© ISO/IEC 2023
© ISO/IEC 2023
All rights reserved. Unless otherwise specified, or required in the context of its implementation, no part of this publication may
be reproduced or utilized otherwise in any form or by any means, electronic or mechanical, including photocopying, or posting on
the internet or an intranet, without prior written permission. Permission can be requested from either ISO at the address below
or ISO’s member body in the country of the requester.
ISO copyright office
CP 401 • Ch. de Blandonnet 8
CH-1214 Vernier, Geneva
Phone: +41 22 749 01 11
Email: copyright@iso.org
Website: www.iso.org
Published in Switzerland
ii
© ISO/IEC 2023 – All rights reserved
Foreword
ISO (the International Organization for Standardization) and IEC (the International Electrotechnical
Commission) form the specialized system for worldwide standardization. National bodies that are
members of ISO or IEC participate in the development of International Standards through technical
committees established by the respective organization to deal with particular fields of technical activity.
ISO and IEC technical committees collaborate in fields of mutual interest. Other international
organizations, governmental and non-governmental, in liaison with ISO and IEC, also take part in the
work.
The procedures used to develop this document and those intended for its further maintenance are
described in the ISO/IEC Directives, Part 1. In particular, the different approval criteria needed for the
different types of document should be noted (see www.iso.org/directives or
www.iec.ch/members_experts/refdocs).
Attention is drawn to the possibility that some of the elements of this document may be the subject of
patent rights. ISO and IEC shall not be held responsible for identifying any or all such patent rights. Details
of any patent rights identified during the development of the document will be in the Introduction and/or
on the ISO list of patent declarations received (see www.iso.org/patents) or the IEC list of patent
declarations received (see https://patents.iec.ch).
Any trade name used in this document is information given for the convenience of users and does not
constitute an endorsement.
For an explanation of the voluntary nature of standards, the meaning of ISO specific terms and
expressions related to conformity assessment, as well as information about ISO's adherence to the World
Trade Organization (WTO) principles in the Technical Barriers to Trade (TBT),
see www.iso.org/iso/foreword.html. In the IEC, see www.iec.ch/understanding-standards.
This document was prepared by SNIA (as Swordfish Scalable Storage Management API Specification,
Version, 1.2.4a) and drafted in accordance with its editorial rules. It was adopted, under the JTC 1 PAS
procedure, by Joint Technical Committee ISO/IEC JTC 1, Information technology.
This second edition cancels and replaces the first edition (ISO/IEC 5965:2021), which has been
technically revised.
The main changes are as follows:
— document has been aligned with DMTF’s Redfish Forum 2021.1 release of the Redfish Specification,
schema bundle, and other supporting materials;
— support for NVMe and NVMe-oF has been added, expanding the API to support the management of
NVMe and NVMe-oF devices and systems;
— the Swordfish Standalone Configuration has been added in the /Storage collection at the ServiceRoot.
This simplification of the hierarchy features Storage systems at the ServiceRoot and makes
standalone implementations easier to instrument;
— substantial schema changes have been made, including:
— enhancements to Volume, including new Actions (e.g., ChangeRAIDLayout, ForceEnable);
addition of InitializeMethod, IOPerfModeEnabled, and OwningStorageResource and link to
JournalingMedia; added InitializeMethod property; added IsBootCapable,
© ISO/IEC 2023 – All rights reserved iii
— enhancements to StoragePools,
— addition of NVMeDomain schema, and Split NVMeFirmwareImage and NVMeDomains schemas,
— deprecation of use of NetworkPort; replacement with Port;
— security has been improved, including:
— new requirements added to NVMeDrive to conform to schema updates for SecureErase,
— enhancement of CHAP definitions and usage in StorageGroup;
— Profiles have been expanded, including:
— addition of new profiles for Access Rights management, Connectivity Rights management,
Management Controllers, NVMe EBOF, PCIe JBOF, and NVMe-oF,
— movement of Swordfish profiles to SwordfishInteroperabilityProfile as base – extends Redfish
Interoperability Profile, adding support for “conditionals” and comparison for Required Profiles,
— update of FeaturesRegistry to v1.3.0 to correspond to latest versions of all profiles,
— updates in multiple profiles to correct conformance to interoperability schema.
Modifications to support change for new RequiredProfiles conditionals support.
— addition of new profile for Swordfish NVMe Front End (used by complex devices such as arrays),
— enhancement of profiles to include support / requirements for /Storage (move support to v1.1.0
level),
— addition of NVMe drive, Advanced Features and Ethernet Attach profiles,
— enhancement of Swordfish event profile,
— addition of SupportedPoolTypes to StoragePool Profiles.
Any feedback or questions on this document should be directed to the user’s national standards body. A
complete listing of these bodies can be found at www.iso.org/members.html and www.iec.ch/national-
committees.
iv © ISO/IEC 2023 – All rights reserved
Swordfish Scalable Storage Management API Specification Version 1.2.4a
Contents
USAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
DISCLAIMER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Current Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Contact SNIA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
FEEDBACK AND INTERPRETATIONS . . . . . . . . . . . . . . . . . . . 13
INTENDED AUDIENCE . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
VERSIONING POLICY . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
About SNIA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1 Abstract 23
2 Scope 24
2.1 Document Goals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2.2 Audience Assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3 Normative References 26
3.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.2 Approved references . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.3 References under development . . . . . . . . . . . . . . . . . . . . . 28
3.4 Other references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
4 Terms and Definitions 29
4.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
4.2 Swordfish-specific Terms . . . . . . . . . . . . . . . . . . . . . . . . . 29
4.2.1 Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
4.2.2 Symbols and abbreviated terms . . . . . . . . . . . . . . . . 30
4.3 Reference to Redfish terms . . . . . . . . . . . . . . . . . . . . . . . . 30
4.4 Keywords (normative language terms) . . . . . . . . . . . . . . . . . 30
5 Swordfish Overview 32
5.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
5.2 Relation to Redfish . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
5.3 Storage System Models . . . . . . . . . . . . . . . . . . . . . . . . . . 33
5.4 The ServiceRoot and ServiceContainer entities . . . . . . . . . . . . . 37
5.4.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
5.4.2 The Storage resource collection . . . . . . . . . . . . . . . . . 37
12 July 2022 SNIA Standard 2
© ISO/IEC 2023 – All rights reserved
Swordfish Scalable Storage Management API Specification Version 1.2.4a
5.4.3 The Systems resource collection . . . . . . . . . . . . . . . . 38
5.4.4 The Chassis resource collection . . . . . . . . . . . . . . . . . 38
5.4.5 The StorageSystems resource collection . . . . . . . . . . . . 38
5.5 Swordfish model overview . . . . . . . . . . . . . . . . . . . . . . . . 39
5.5.1 The Storage resource . . . . . . . . . . . . . . . . . . . . . . 39
5.5.2 The StorageController resource . . . . . . . . . . . . . . . . . 40
5.5.3 The Endpoint resource . . . . . . . . . . . . . . . . . . . . . . 40
5.5.4 The Endpoint Collection resource . . . . . . . . . . . . . . . . 40
5.5.5 The ConsistencyGroup resource . . . . . . . . . . . . . . . . . 40
5.5.6 The ConsistencyGroup Collection resource . . . . . . . . . . . 40
5.5.7 The StorageGroup resource . . . . . . . . . . . . . . . . . . . 40
5.5.8 The StoragePool resource . . . . . . . . . . . . . . . . . . . . 41
5.5.9 The Volume resource . . . . . . . . . . . . . . . . . . . . . . 41
5.5.10 The FileSystem resource . . . . . . . . . . . . . . . . . . . . . 42
6 Features and Profiles 43
6.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
6.2 Requirement for SupportedFeatures . . . . . . . . . . . . . . . . . . 43
6.3 EnergyStar for Storage Feature . . . . . . . . . . . . . . . . . . . . . 44
6.4 Class of Service Feature . . . . . . . . . . . . . . . . . . . . . . . . . 44
6.4.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
6.4.2 Class of Service Model . . . . . . . . . . . . . . . . . . . . . . 44
6.4.3 ServiceRoot Additions . . . . . . . . . . . . . . . . . . . . . . 49
6.4.4 The StorageService resource . . . . . . . . . . . . . . . . . . 49
7 Schema Considerations 53
7.1 Schema Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.1.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
7.1.2 Swordfish Extension of the Redfish ServiceRoot . . . . . . . . 53
7.2 Default values and NULLABLE attributes . . . . . . . . . . . . . . . . 53
7.3 Common schema annotations . . . . . . . . . . . . . . . . . . . . . . 54
7.4 Property implementation requirements . . . . . . . . . . . . . . . . . 56
7.5 Schema repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
7.6 Referencing other schemas . . . . . . . . . . . . . . . . . . . . . . . 56
8 Implementation requirements 57
8.1 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
8.2 General constraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
8.2.1 Redfish elements . . . . . . . . . . . . . . . . . . . . . . . . . 57
12 July 2022 SNIA Standard 3
© ISO/IEC 2023 – All rights reserved
Swordfish Scalable Storage Management API Specification Version 1.2.4a
8.2.2 Storage Events . . . . . . . . . . . . . . . . . . . . . . . . . . 57
8.3 Discovering Swordfish resources . . . . . . . . . . . . . . . . . . . . 58
8.4 ClassOfService requirements . . . . . . . . . . . . . . . . . . . . . . 59
8.5 StorageSystems requirements . . . . . . . . . . . . . . . . . . . . . . 59
8.6 Entity Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
8.7 Addressing entities within a collection . . . . . . . . . . . . . . . . . 60
8.8 Addressing members of a ResourceCollection . . . . . . . . . . . . . 60
8.9 HTTP status codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
8.9.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
8.9.2 Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
8.9.3 Update, Replace, Delete . . . . . . . . . . . . . . . . . . . . . 62
8.9.4 Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
9 Swordfish type definitions 65
9.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
9.2 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
9.3 Universal properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
9.4 Frequently used properties . . . . . . . . . . . . . . . . . . . . . . . 67
9.5 Common Swordfish Objects . . . . . . . . . . . . . . . . . . . . . . . 69
9.5.1 Capacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
9.5.2 CapacityInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
9.5.3 Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
9.5.4 IOStatistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
9.5.5 IOWorkload . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
9.5.6 IOWorkloadComponent . . . . . . . . . . . . . . . . . . . . . 78
9.5.7 Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
9.5.8 Oem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
9.5.9 ReplicaInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
9.5.10 ReplicaRequest . . . . . . . . . . . . . . . . . . . . . . . . . . 119
9.5.11 Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
9.5.12 Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
9.6 Swordfish Schema Types . . . . . . . . . . . . . . . . . . . . . . . . . 133
9.6.1 CapacitySource 1.2.0 . . . . . . . . . . . . . . . . . . . . . . . 133
9.6.2 CapacitySourceCollection . . . . . . . . . . . . . . . . . . . . 138
9.6.3 ClassOfService 1.2.0 . . . . . . . . . . . . . . . . . . . . . . . 140
9.6.4 ClassOfServiceCollection . . . . . . . . . . . . . . . . . . . . 145
9.6.5 ConsistencyGroup 1.1.0 . . . . . . . . . . . . . . . . . . . . . 147
9.6.6 ConsistencyGroupCollection . . . . . . . . . . . . . . . . . . 163
9.6.7 DataProtectionLineOfService 1.3.0 . . . . . . . . . . . . . . . 165
12 July 2022 SNIA Standard 4
© ISO/IEC 2023 – All rights reserved
Swordfish Scalable Storage Management API Specification Version 1.2.4a
9.6.8 DataProtectionLoSCapabilities 1.2.0 . . . . . . . . . . . . . . 174
9.6.9 DataSecurityLineOfService 1.1.1 . . . . . . . . . . . . . . . . 182
9.6.10 DataSecurityLoSCapabilities 1.2.0 . . . . . . . . . . . . . . . 190
9.6.11 DataStorageLineOfService 1.3.1 . . . . . . . . . . . . . . . . . 199
9.6.12 DataStorageLo
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.