Version: 1.2.2a Swordfish Property Guide - SNIA
←
→
Page content transcription
If your browser does not render page correctly, please read the page content below
Swordfish Property Guide Version: 1.2.2a Abstract: The Swordfish Property Guide provides a high-level reference of prop- erty usage throughout the Swordfish schema and object model. SNIA Approved Publication This document has been released and approved by the SNIA. The SNIA believes that the ideas, methodologies, and technologies described in this document accurately represent the SNIA goals and are appropriate for widespread distribution. Suggestion for revision should be directed to http://www.snia.org/feedback/. Last Updated: 14 June 2021
Swordfish Property Guide Version 1.2.2a
Contents
USAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
DISCLAIMER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Current Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Contact SNIA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
FEEDBACK AND INTERPRETATIONS . . . . . . . . . . . . . . . . . . . 5
INTENDED AUDIENCE . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
VERSIONING POLICY . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
0.0.1 Revision History . . . . . . . . . . . . . . . . . . . . . . . . . 6
About SNIA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1 Introduction 8
1.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.2 Who should read this document? . . . . . . . . . . . . . . . . . . . . 8
1.3 Using this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2 Property Index 10
As of 14 June 2021 SNIA Approved Publication 2Swordfish Property Guide Version 1.2.2a List of Tables 1 Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 2 Contributors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 As of 14 June 2021 SNIA Approved Publication 3
Swordfish Property Guide Version 1.2.2a
USAGE
Copyright (c) 2021 SNIA. All rights reserved. All other trademarks or registered trade-
marks 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
Copyright (c) 2021, The Storage Networking Industry Association.
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.
As of 14 June 2021 SNIA Approved Publication 4Swordfish Property Guide Version 1.2.2a THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBU- TORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. DISCLAIMER The information contained in this publication is subject to change without notice. The SNIA makes no warranty of any kind with regard to this publication, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The SNIA shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance, or use. Suggestions for revisions should be directed to http://www.snia.org/feedback/. Current Revision SNIA is actively engaged in expanding and refining the Swordfish documen- tation. The most current revision can be found on the SNIA web site at https://www.snia.org/tech_activities/standards/curr_standards/swordfish. Contact SNIA 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 de- fect reports are welcome. They should be sent via the SNIA Feedback Portal at As of 14 June 2021 SNIA Approved Publication 5
Swordfish Property Guide Version 1.2.2a 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. 0.0.1 Revision History The evolution of this document is summarized in Table 1. As of 14 June 2021 SNIA Approved Publication 6
Swordfish Property Guide Version 1.2.2a
Table 1: Revision History
Date Rev Notes
2 March 2021 Initial Version Released as v1.2.2 to match bundle version
About SNIA
The Storage Networking Industry Association (SNIA) is a non-profit organization made
up of member companies spanning information technology. A globally recognized
and trusted authority, SNIA’s mission is to lead the storage industry in developing
and promoting vendor-neutral architectures, standards and educational services that
facilitate the efficient management, movement and security of information.
Acknowledgements
The SNIA Scalable Storage Management Technical Work Group, which developed and
reviewed this work in progress, would like to recognize the significant contributions
made by the following members listed in Table 2.
Table 2: Contributors
Member Representatives (* – prior employer)
Intel Corporation Richelle Ahlvers
As of 14 June 2021 SNIA Approved Publication 7Swordfish Property Guide Version 1.2.2a 1 Introduction 1.1 Overview The Swordfish Scalable Storage Management API (“Swordfish”) defines a RESTful interface and a standardized data model to provide a scalable, customer-centric inter- face for managing storage and related data services. It extends the Redfish Scalable Platforms Management API Specification to manage block storage, file systems, object storage, and storage network infrastructure, with a focus on common operational and business concerns of storage management. The Swordfish API is defined using CSDL, JSON, and/or YAML schema. However, Sword- fish is a REST-based API and can be used by clients without requiring an explicit knowl- edge of the underlying schema. This document provides a comprehensive reference for the properties defined within the schema that can be provided by the Swordfish API. 1.2 Who should read this document? This document is intended primarily for end users and other consumers of Swordfish data to look up property definitions, without requiring a detailed knowledge of the schema as a whole. Schema authors may also use this document to locate existing property definitions within the Swordfish Schema. 1.3 Using this guide Every Redfish API response consists of a JSON payload containing properties that are strictly defined by a Schema for that Resource. The Schema defining a particular Resource can be determined from the value of the “@odata.type” property returned in every Redfish response. This guide details the definitions for every Redfish standard property defined in the DMTF-published Redfish Schemas. The property-level details include: As of 14 June 2021 SNIA Approved Publication 8
Swordfish Property Guide Version 1.2.2a
Column Purpose
Property Name The name of the JSON property as it
appears, case sensitive, in the JSON
payload.
Defined in Schemas The names of the Redfish Schemas where
this property is defined, and therefore in
which Resources it may appear. For
properties that appear within embedded
JSON objects, the object name appears in
parentheses.
Type The JSON data types for the property,
which can include boolean, number, string,
or object. String types that use defined
enumerations state (enum). Number types
state units, where used.
Description The description of the property, as copied
directly from the Schema Description
definition, or, for properties that appear in
multiple Schemas, a general description of
its usage in any of the listed Schemas.
As of 14 June 2021 SNIA Approved Publication 9Swordfish Property Guide Version 1.2.2a
2 Property Index
Defined In
Property Name Schema(s) Type Description
Acces FileSystem array An array of
sCapabilities supported IO
access capabilities.
DataStora array Required access
geLineOfService capabilities.
Volume array Supported IO
access capabilities.
Acc essCapability StorageGroup string (enum) Supported IO
(MappedVolumes) access capability.
Ac cessProtocols IOConnectivi array SupportedA
tyLineOfService ccessProtocols.
AccessState StorageGroup string (enum) AccessState for this
storage group.
Actions various ( object The available
CapacitySource, actions for this
ClassOfService ... ) resource.
AddDrives StoragePool object This action is used
(Action) (Actions) to add an
additional drive, or
set of drives, to a
capacity source for
the storage pool.
A llocatedBytes CapacitySource (P integer (bytes) The number of
rovidedCapacity > bytes currently
Data), allocated by the
CapacitySource (P storage system in
rovidedCapacity > this data store for
Metadata), this data type.
CapacitySource (P
rovidedCapacity >
Snapshot)
As of 14 June 2021 SNIA Approved Publication 10Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
A llocatedPools StoragePool object A reference to the
collection of
storage pools
allocated from this
storage pool.
Volume object An array of
references to
StoragePools
allocated from this
Volume.
All StoragePool object A reference to the
ocatedVolumes collection of
volumes allocated
from this storage
pool.
AntivirusE DataSecuri string AntiVirus provider.
ngineProvider tyLineOfService
Antiviru DataSecuri array Policy for
sScanPolicies tyLineOfService triggering an
AntiVirus scan.
AntiVir DataSecuri string (enum) Types of antivirus
usScanTrigger tyLineOfService scan triggers.
(Antiviru
sScanPolicies),
DataSecurity
LoSCapabilities (S
upportedAntivir
usScanPolicies)
As of 14 June 2021 SNIA Approved Publication 11Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Assi C onsistencyGroup object This action is used
gnReplicaTarget (Actions) to establish a
(Action) replication
relationship by
assigning an
existing
consistency group
to serve as a target
replica for an
existing source
consistency group.
Volume (Actions) object This action is used
to establish a
replication
relationship by
assigning an
existing volume to
serve as a target
replica for an
existing source
volume.
Asso NVMeDomain array An array of links to
ciatedDomains (Links) associated
domains.
AssociatedFea Volume object A reference to the
turesRegistry (Operations) task associated
with the operation
if any.
Authent StorageGroup string (enum) The Authentication
icationMethod method used for
the Endpoints
involved in this
StorageGroup.
As of 14 June 2021 SNIA Approved Publication 12Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Authe DataSecurity string (enum) Enumeration of
nticationType LoSCapabilities authentication
(Supp algorithms.
ortedHostAuthen
ticationTypes),
DataSecurity
LoSCapabilities
(Sup
portedUserAuthe
nticationTypes)
AvailableF NVMeDomain array A collection of
irmwareImages available firmware
images.
A verageIOBytes IOPerformance integer (bytes) Average I/O Size for
LoSCapabilities this component.
(Suppo
rtedIOWorkloads >
Components)
AverageIO IOPerforman integer (us) Expected average
OperationLatenc ceLineOfService IO latency.
yMicroseconds
B lockSizeBytes FileSystem integer (bytes) Block size of the
file system in
bytes.
StoragePool integer (bytes) Maximum Block
size in bytes.
Volume integer (bytes) The size of the
smallest
addressable unit
(Block) of this
volume in bytes.
As of 14 June 2021 SNIA Approved Publication 13Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Cac Volume (Links) array A pointer to the
heDataVolumes data volumes this
volume serves as a
cache volume.
Cach Volume (Links) object A pointer to the
eVolumeSource cache volume
source for this
volume.
Capacity FileSystem object Capacity allocated
to the file system.
StoragePool, object Capacity
Volume utilization.
CapacityBytes Volume integer (bytes) The size in bytes of
this Volume.
C apacitySource StoragePool object The capacity
(Actions > source to be
AddDrives (Action)) extended.
Ca pacitySources FileSystem array An array of
capacity sources
for the file system.
StoragePool array An array of space
allocations to this
store.
Volume array An array of space
allocations to this
volume.
CasePreserved FileSystem boolean The case of file
names is preserved
by the file system.
CaseSensitive FileSystem boolean Case sensitive file
names are
supported by the
file system.
As of 14 June 2021 SNIA Approved Publication 14Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
CASupported FileShare boolean Continuous
Availability is
supported.
Client/Server
mediated recovery
from network and
server failure with
application
transparency.
C hangeRAIDLay- Volume (Actions) object Request system
out (Action) change the RAID
layout of the
volume.
ChannelEncry DataSecuri string (enum) Key size for
ptionStrength tyLineOfService transport channel
encryption.
ChapInfo StorageGroup array The credential
information used
to authenticate the
endpoints in this
StorageGroup.
• StorageGroup string The password for
*CHAPPassword**
(ChapInfo) CHAP
authentication.
CHAPUser StorageGroup string The username for
(ChapInfo) CHAP
authentication.
Cha FileSystem array An array of the
racterCodeSet character sets or
encodings
supported by the
file system.
As of 14 June 2021 SNIA Approved Publication 15Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
FileSystem (Ch string (enum) Supported
aracterCodeSet) character code
standards for
different alphabets
and languages.
C Volume (Actions) object This action is used
heckConsistency to force a check of
(Action) the Volume’s parity
or redundant data
to ensure it
matches
calculated values.
Child StorageGroup array Child
StorageGroups (Links) StorageGroups.
Cla ssesOfService StoragePool object The C
lassesOfService
supported by this
storage pool.
StorageService object The C
lassesOfService
that all storage in
this StorageService
can support.
C lassOfService FileShare (Links) object A link to the
ClassOfService for
this file share.
FileSystem (Links) object The ClassOfService
of this file system.
StorageGroup object The ClassOfService
(Links) that all storage in
this StorageGroup
conforms to.
As of 14 June 2021 SNIA Approved Publication 16Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Volume (Links) object The ClassOfService
that this storage
volume conforms
to.
ClassOfS ClassOfService string The value
erviceVersion identifies the
current version of
this class of service
definition.
ClientE StorageGroup array Groups of client
ndpointGroups endpoints in this
storage group.
StorageService object Client endpoint
groups.
Cl ientEndpoints Volume (Links) array An array of
references to the
client Endpoints
associated with
this volume.
Clu sterSizeBytes FileSystem integer (bytes) A value indicating
the minimum file
allocation size
imposed by the file
system.
Components IOPerformance array An array of IO
LoSCapabilities workload
(Suppor component
tedIOWorkloads) descriptions.
Compressed StoragePool boolean Indicator of
whether or not the
StoragePool has
compression
enabled.
As of 14 June 2021 SNIA Approved Publication 17Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Volume boolean Indicator of
whether or not the
Volume has
compression
enabled.
Compr StoragePool boolean Indicates whether
essionEnabled or not compression
is enabled on the
storage pool.
Consist C onsistencyGroup string The Name for the
encyGroupName (Actions > Crea new target
teReplicaTarget consistency group.
(Action))
Cons Volume (Links) array An array of
istencyGroups references to the
Co
nsistencyGroups
associated with
this volume.
StorageService object Con
sistencyGroups.
Cons C onsistencyGroup string (enum) The consistency
istencyMethod method used by
this group.
Co nsistencyType C onsistencyGroup string (enum) The consistency
type used by this
group.
As of 14 June 2021 SNIA Approved Publication 18Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
ConsumedBytes CapacitySource (P integer (bytes) The number of
rovidedCapacity > bytes consumed in
Data), this data store for
CapacitySource (P this data type.
rovidedCapacity >
Metadata),
CapacitySource (P
rovidedCapacity >
Snapshot)
• DataProtecti object This action creates
*CreateReplicas onLineOfService an on-demand
(Action)** (Actions) replica.
Crea C onsistencyGroup object This action is used
teReplicaTarget (Actions) to create a new
(Action) consistency group
resource to
provide expanded
data protection
through a replica
relationship with
the specified
source consistency
group.
Volume (Actions) object This action is used
to create a new
volume resource to
provide expanded
data protection
through a replica
relationship with
the specified
source volume.
As of 14 June 2021 SNIA Approved Publication 19Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Data CapacitySource (Pr object The capacity
ovidedCapacity) information
relating to the user
data.
DataProtectionL ClassOfService array A collection of
inesOfService DataProtection
line of service
elements.
D ataProtectionLo StorageService, object The data
SCapabilities StorageService protection
(Links) capabilities of this
service.
DataSanit DataSecuri string (enum) Data sanitization
izationPolicy tyLineOfService policy.
DataSecurity string (enum) Types of data
LoSCapabilities sanitization
(Supp policies.
ortedDataSaniti
zationPolicies)
DataSecurityL ClassOfService array A collection of
inesOfService DataSecurity line
of service
elements.
• StorageService, object The data security
*DataSecurityLoStorageService capabilities of this
SCapabili- (Links) service.
ties**
DataStorageL ClassOfService array A collection of
inesOfService DataStorage line of
service elements.
DataStorageLo StorageService, object The data storage
SCapabilities StorageService capabilities of this
(Links) service.
As of 14 June 2021 SNIA Approved Publication 20Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
DataUnitsRead StoragePool integer The property
(NVMeEndurance contains the total
GroupProperties > number of data
EndGrpLifetime) units read from
this endurance
group.
Dat aUnitsWritten StoragePool integer The property
(NVMeEndurance contains the total
GroupProperties > number of data
EndGrpLifetime) units written from
this endurance
group.
Dedicat StoragePool array An array of
edSpareDrives (Links) references to the
drives which are
dedicated spares
for this
StoragePool.
Volume (Links) array An array of
references to the
drives which are
dedicated spares
for this volume.
• StoragePool boolean Indicator of
*Deduplicated** whether or not the
StoragePool has
deduplication
enabled.
Volume boolean Indicator of
whether or not the
Volume has
deduplication
enabled.
As of 14 June 2021 SNIA Approved Publication 21Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Dedupli StoragePool boolean Indicates whether
cationEnabled or not
deduplication is
enabled on the
storage pool.
DefaultAcces FileShare array An array of default
sCapabilities access capabilities
for the file share.
The types of
default access can
include Read,
Write, and/or
Execute.
DefaultC StorageService, object The default class of
lassOfService StorageService service for entities
(Links) allocated by this
storage service.
StoragePool, object The default class of
StoragePool service for entities
(Links) allocated from this
storage pool.
DefaultCompre StoragePool boolean Indicates the
ssionBehavior default dedupe
behavior applied
to the child
resource (E.g.,
volume or storage
pool) created out
of the storage pool
if the ‘Compressed’
property is not set
on the create
request.
As of 14 June 2021 SNIA Approved Publication 22Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
DefaultDeduplic StoragePool boolean Indicates the
ationBehavior default
deduplication
behavior applied
to the child
resource (E.g.,
volume or storage
pool) created out
of the storage pool
if the
‘Deduplicated’
property is not set
on the create
request.
DefaultEncry StoragePool boolean Indicates the
ptionBehavior default dedupe
behavior applied
to the child
resource (E.g.,
volume or storage
pool) created out
of the storage pool
if the ‘Encrypted’
property is not set
on the create
request.
DeleteTargetCon C onsistencyGroup boolean Indicate whether
sistencyGroup (Actions > or not to delete the
RemoveRepl target consistency
icaRelationship group as part of
(Action)) the operation.
As of 14 June 2021 SNIA Approved Publication 23Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Delet Volume (Actions > boolean Indicate whether
eTargetVolume RemoveRepl or not to delete the
icaRelationship target volume as
(Action)) part of the
operation.
DHChapInfo StorageGroup array The credential
information used
to authenticate the
endpoints in this
StorageGroup for
DHCHAP.
DisplayName Volume string A us
er-configurable
string to name the
volume.
DomainMembers NVMeDomain array The members of
the domain.
Drives Volume (Links) array An array of
references to the
drives which
contain this
volume. This will
reference Drives
that either wholly
or only partly
contain this
volume.
Volume (Actions > array An array of the
C drives to be used
hangeRAIDLayout by the volume.
(Action))
StoragePool array The drive(s) to be
(Actions > added.
AddDrives (Action))
As of 14 June 2021 SNIA Approved Publication 24Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
StoragePool array The drive(s) to be
(Actions > removed.
RemoveDrives
(Action))
StorageService object The set of drives
managed by this
storage service.
Duration IOPerformance string (seconds) Duration that this
LoSCapabilities component is
(Suppo active.
rtedIOWorkloads >
Components)
Enable StoragePool boolean This property
(Actions > SetC indicates the
ompressionState desired
(Action)) compression state
of the storage pool.
StoragePool boolean This property
(Actions > SetDed indicates the
uplicationState desired
(Action)) deduplication state
of the storage pool.
StoragePool boolean This property
(Actions > Set indicates the
EncryptionState desired encryption
(Action)) state of the storage
pool.
Encrypted StoragePool boolean Indicator of
whether or not the
StoragePool has
encryption
enabled.
As of 14 June 2021 SNIA Approved Publication 25Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Volume boolean Is this Volume
encrypted.
Encr StoragePool boolean Indicates whether
yptionEnabled or not encryption
is enabled on the
storage pool.
EncryptionKey StorageService string The encryption key
(Actions > S to set on the
etEncryptionKey storage subsystem.
(Action))
En cryptionTypes Volume array The types of
encryption used by
this Volume.
E ndGrpLifetime StoragePool object This property
(NVMeEnduranceG contains the
roupProperties) Endurance Group
Lifetime
properties.
E ndpointGroups StorageService object Client and Server
endpoint groups.
Endpoints StorageService object Endpoints.
Endu StoragePool integer This property
ranceEstimate (NVMeEndurance contains an
GroupProperties > estimate of the
EndGrpLifetime) total number of
data bytes that
may be written to
the Endurance
Group over the
lifetime of the
Endurance Group
assuming a write
amplication of 1.
As of 14 June 2021 SNIA Approved Publication 26Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
EnduranceGr StoragePool (NVM string A 16-bit hex value
oupIdentifier eSetProperties) that contains the
endurance group
identifier.
E rrorInformation StoragePool integer This property
LogEntryCount (NVMeEndurance contains the
GroupProperties > number of error
EndGrpLifetime) information log
entries over the life
of the controller
for the endurance
group.
Ether FileShare object A link to the
netInterfaces collection of
Ethernet interfaces
that provide access
to this file share.
E xecuteSupport FileShare boolean Execute access is
supported by the
file share.
E xportedShares FileSystem object An array of
exported file
shares of this file
system.
ExposeVolumes StorageGroup object Expose the storage
(Action) (Actions) volumes of this
group.
Failu DataProtection string (enum) Values of this
reDomainScope LoSCapabilities enumeration
(Supporte represent a
dRecoveryGeogra geographic scope
phicObjectives) of a failure domain.
As of 14 June 2021 SNIA Approved Publication 27Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Features F eaturesRegistry object The pattern
property indicates
that a free-form
string is the unique
identifier for the
feature within the
registry.
• FileShare (FileSh string (enum) The file sharing
*FileProtocol** aringProtocols) protocols
supported by the
file system.
FileSharePath FileShare string A path to an
exported file or
directory on the
file system where
this file share is
hosted.
FileS FileShare string (enum) Specifies the type
hareQuotaType of quota
enforcement.
FileShareRemain FileShare integer (bytes) The number of
ingQuotaBytes remaining bytes
that may be used
by this file share.
FileShareTo FileShare integer (bytes) The maximum
talQuotaBytes number of bytes
that may be used
by this file share.
FileSha FileShare array An array of file
ringProtocols sharing protocols
supported by this
file share.
As of 14 June 2021 SNIA Approved Publication 28Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
FileSystem FileShare (Links) object A link to the file
system containing
the file share.
FileSystems StorageService object FileSystems.
Fi rmwareVersion NV string The firmware
MeFirmwareImage version of the
available NVMe
firmware image.
ForceEnable Volume (Actions) object Request system
(Action) force the volume
to an enabled state
regardless of data
loss.
For Volume string The LBA data size
mattedLBASize (NVMeNames and metadata size
paceProperties) combination that
the namespace has
been formatted
with.
Gu aranteedBytes CapacitySource (P integer (bytes) The number of
rovidedCapacity > bytes the storage
Data), system guarantees
CapacitySource (P can be allocated in
rovidedCapacity > this data store for
Metadata), this data type.
CapacitySource (P
rovidedCapacity >
Snapshot)
HideVolumes StorageGroup object Hide the storage
(Action) (Actions) volumes of this
group.
As of 14 June 2021 SNIA Approved Publication 29Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
HostAuthe DataSecuri string (enum) Authentication
nticationType tyLineOfService type for hosts
(servers) or
initiator endpoints.
HostingSystem StorageService object The hosting system
(Links) or storage
controller hosting
this storage
service.
HostRea StoragePool integer This property
dCommandCount (NVMeEndurance contains the
GroupProperties > number of read
EndGrpLifetime) commands
completed by all
controllers in the
NVM subsystem for
the Endurance
Group.
HostWrit StoragePool integer This property
eCommandCount (NVMeEndurance contains the
GroupProperties > number of write
EndGrpLifetime) commands
completed by all
controllers in the
NVM subsystem for
the Endurance
Group.
Identifier FileSystem object Any additional
(Identifiers), identifiers for a
Volume resource.
(Identifiers)
As of 14 June 2021 SNIA Approved Publication 30Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
ClassOfService, object The value
DataProtectionL identifies this
oSCapabilities, resource.
DataSecurityL
oSCapabilities,
DataStorageL
oSCapabilities,
IOConnectivityL
oSCapabilities,
IOPerformanceL
oSCapabilities,
StorageGroup,
StoragePool,
StorageService
Identifiers Volume array The Durable names
for the volume.
FileSystem array The durable names
for this file system.
I mportedShares FileSystem array An array of
imported file
shares.
As of 14 June 2021 SNIA Approved Publication 31Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Initialize (Action) Volume (Actions) object This action is used
to prepare the
contents of the
volume for use by
the system. If I
nitializeMethod is
not specified in the
request body, but
the property I
nitializeMethod is
specified, the
property I
nitializeMethod
value should be
used. If neither is
specified, the I
nitializeMethod
should be
Foreground.
Ini tializeMethod Volume string (enum) Indicates the
Initialization
Method used for
this volume. If I
nitializeMethod is
not specified, the I
nitializeMethod
should be
Foreground.
Volume (Actions > string (enum) The type of
Initialize (Action)) initialization to be
performed.
I nitializeType Volume (Actions > string (enum) The type of
Initialize (Action)) initialization to be
performed.
As of 14 June 2021 SNIA Approved Publication 32Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Initiato StorageGroup string The shared secret
rCHAPPassword (ChapInfo) for Mutual (2-way)
CHAP
authentication by
the initiator.
Init StorageGroup string The Initiator
iatorCHAPUser (ChapInfo) username for
Mutual (2-way)
CHAP
authentication by
the initiator.
IO AccessPattern IOPerformance string (enum) Expected access
LoSCapabilities pattern for this
(Suppo component.
rtedIOWorkloads >
Components)
IOConnectivityL ClassOfService array A collection of
inesOfService IOConnectivity line
of service
elements.
I OConnectivityLo StorageService, object The IO connectivity
SCapabilities StorageService capabilities of this
(Links) service.
IOLimiti IOPerformance boolean Limiting IOPS is
ngIsSupported LoSCapabilities supported.
IO IOPerforman boolean Limit the IOPS.
OperationsPerSe ceLineOfService
condIsLimited
IOPe Volume boolean Indicates the IO
rfModeEnabled performance mode
setting for the
volume.
As of 14 June 2021 SNIA Approved Publication 33Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
• ClassOfService array A collection of
*IOPerformanceL IOPerformance
inesOfSer- line of service
vice** elements.
IOPerformanceLo StorageService, object The IO
SCapabilities StorageService performance
(Links) capabilities of this
service.
• FileSystem object Statistics for this
*IOStatistics** FileSystem.
StoragePool object Statistics for this
StoragePool.
StorageService object Statistics for this
StorageService.
Volume object Statistics for this
volume.
IOWorkload IOPerforman object A description of
ceLineOfService the expected
workload.
• C onsistencyGroup boolean This value is true
*IsConsistent** when the
consistency group
is in a consistent
state.
IsIsolated DataProtecti boolean The replica is in a
onLineOfService separate fault
domain.
IsShareable Volume boolean Indicates the
(NVMeNames namespace is
paceProperties) shareable.
As of 14 June 2021 SNIA Approved Publication 34Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
IsS paceEfficient DataStora boolean True implies
geLineOfService compression or
deduplication of
storage.
IsTh CapacitySource (Pr boolean Marks that the
inProvisioned ovidedCapacity) capacity is not
necessarily fully
allocated.
Jo urnalingMedia Volume (Links) object A pointer to the
Resource that
serves as a
journaling media
for this volume.
KeySize DataSecurity string (enum) Enumeration of
LoSCapabilities Key sizes in a
(Support symmetric
edChannelEncryp encryption
tionStrengths), algorithm, (see
DataSecurity NIST SP 800-57
LoSCapabilities part 1 (http:/c
(Supp src.nist.gov/pu
ortedMediaEncry blications/nist
ptionStrengths) pubs/800-57/sp8
00-57_part1_rev
3_general.pdf).
Language F eaturesRegistry string This is the RFC
5646 compliant
language code for
the registry.
L inesOfService StorageService array The LinesOService
defined for this
StorageService.
As of 14 June 2021 SNIA Approved Publication 35Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Links Co nsistencyGroup, object Contains links to
DataProtectionL other resources
oSCapabilities, that are related to
FileSystem, Sp this resource.
areResourceSet,
StorageGroup,
StorageService
Volume object Contains
references to other
resources that are
related to this
resource.
FileShare, object The links object
StoragePool contains the links
to other resources
that are related to
this resource.
NVMeDomain object The links to other
resources that are
related to this
resource.
LocalDHC StorageGroup string The local DHCHAP
HAPAuthSecret (DHChapInfo) auth secret for
DHCHAP
authentication.
Logi Volume integer Indicates the
calUnitNumber host-visible Lo
gicalUnitNumber
assigned to this
Volume.
StorageGroup string A SCSI Logical Unit
(MappedVolumes) Number for a
Volume.
As of 14 June 2021 SNIA Approved Publication 36Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
LowS FileShare array (%) An array of low
paceWarningThre space warning
sholdPercents threshold
percentages for
the file share.
FileSystem array (%) An array of low
space warning
threshold
percentages for
the file system.
StoragePool array (%) Low space warning
threshold specified
in percents.
Volume array (%) Low space
warning.
• Volume string The manufacturer
*Manufacturer** or OEM of this
storage volume.
MappedVolumes StorageGroup array Mapped Volumes
in this storage
group.
MaxB Volume integer (bytes) Max Block size in
lockSizeBytes bytes.
StoragePool integer (bytes) Maximum Block
size in bytes.
MaxB IOConnectivi integer (By/s) The maximum
ytesPerSecond tyLineOfService Bandwidth in
bytes per second
that a connection
can support.
As of 14 June 2021 SNIA Approved Publication 37Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
MaxFileNa FileSystem integer (bytes) A value indicating
meLengthBytes the maximum
length of a file
name within the
file system.
MaximumCa NVMeDomain integer (bytes) The maximum
pacityPerEndura capacity per
nceGroupBytes endurance group
in bytes of this
NVMe Domain.
MaximumRe DataStorage integer Maximum number
coverableCapaci LoSCapabilities of capacity source
tySourceCount resources for the
purpose of
recovery from a
failure.
MaxIOOp IOPerforman integer (1/s/TBy) The amount of
erationsPerSeco ceLineOfService IOPS a volume of a
ndPerTerabyte given committed
size can support.
MaxIOPS IOConnectivi integer ([IO]/s) The maximum
tyLineOfService supported IOs per
second that the
connection will
support for the
selected access
protocol.
Ma IOPerformance string (seconds) Maximum
xSamplePeriod LoSCapabilities sampling period
over which average
values are
calculated.
As of 14 June 2021 SNIA Approved Publication 38Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
MaxSupportedB IOConnectivity integer (By/s) The maximum
ytesPerSecond LoSCapabilities Bandwidth in
bytes per second
that a connection
can support.
Max IOConnectivity integer ([IO]/s) The maximum
SupportedIOPS LoSCapabilities IOPS that a
connection can
support.
Med StoragePool integer This property
iaAndDataIntegr (NVMeEndurance contains the
ityErrorCount GroupProperties > number of
EndGrpLifetime) occurences where
the controller
detected an
unrecovered data
integrity error for
the Endurance
Group.
MediaEncry DataSecuri string (enum) Key size for media
ptionStrength tyLineOfService encryption.
M ediaSpanCount Volume integer Indicates the
number of media
elements used per
span in the
secondary RAID for
a hierarchical RAID
type.
As of 14 June 2021 SNIA Approved Publication 39Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Volume (Actions > integer The requested
C number of media
hangeRAIDLayout elements used per
(Action)) span in the
secondary RAID for
a hierarchical RAID
type.
Medi StoragePool integer The property
aUnitsWritten (NVMeEndurance contains the total
GroupProperties > number of data
EndGrpLifetime) units written from
this endurance
group.
Members Hosted array The value of each
StorageServices member
references a
StorageService
resource.
Members@o Hosted string The URI to the
data.nextLink StorageServices resource
containing the next
set of partial
members.
Members StorageGroup boolean Members are kept
AreConsistent in a consistent
state.
Metadata CapacitySource (Pr object The capacity
ovidedCapacity) information
relating to
metadata.
As of 14 June 2021 SNIA Approved Publication 40Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Metad Volume boolean This property
ataTransferredA (NVMeNames indicates whether
tEndOfDataLBA paceProperties) or not the
metadata is
transferred at the
end of the LBA
creating an
extended data LBA.
MinLifetime DataProtecti string Minimum lifetime
onLineOfService (seconds) that
replica must be
maintained.
Mi IOPerformance string (seconds) Minimum sampling
nSamplePeriod LoSCapabilities period over which
average values are
calculated.
• IOPerformance integer (us) Minimum
LoSCapabilities
*MinSupportedIo supported average
OperationLa- IO latency.
tenc
yMicrosec-
onds**
Model Volume string The model number
for this storage
volume.
Name Volume object This property
spaceFeatures (NVMeNames contains a set of
paceProperties) Namespace
Features.
NamespaceId Volume string The NVMe
(NVMeNames Namespace
paceProperties) Identifier for this
namespace.
As of 14 June 2021 SNIA Approved Publication 41Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Num Volume integer (bytes) The number of LBA
berLBAFormats (NVMeNames data size and
paceProperties) metadata size
combinations
supported by this
namespace. The
value of this
property is
between 0 and 16.
N VMeDeviceType NV string (enum) The type of NVMe
MeFirmwareImage Device this image
is associated with.
NVMeEn- StoragePool object This property
duranceGr contains
oupProperties properties to use
when StoragePool
is used to describe
an NVMe
Endurance Group.
NVMeNamesp Volume object This property
aceProperties contains
properties to use
when Volume is
used to describe
an NVMe
Namespace.
• StoragePool ( string (enum) Indicates whether
*NVMePoolType**
NVMeProperties) the StoragePool is
used as an
EnduranceGroup
or an NVMSet.
N VMeProperties StoragePool object NVMe properties
for this storage
pool.
As of 14 June 2021 SNIA Approved Publication 42Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
NVMe StoragePool object This property
SetProperties contains
properties to use
when StoragePool
is used to describe
an NVMe Set.
NVMeVersion Volume string The version of the
(NVMeNames NVMe Base
paceProperties) Specification
supported.
O nHandLocation S pareResourceSet object Location where
this set of spares is
kept.
• S pareResourceSet array The type of
(Links)
*OnHandSpares** resources in the
set.
OnLine S pareResourceSet boolean This set is available
online.
OperationName Volume string The name of the
(Operations) operation.
Operations Volume array The operations
currently running
on the Volume.
OptimalW StoragePool (NVM integer (bytes) This property
riteSizeBytes eSetProperties) contains the
Optimal Write Size
in Bytes for this
NVMe Set.
Optim Volume integer (bytes) The size in bytes of
umIOSizeBytes this Volume’s
optimum IO size.
As of 14 June 2021 SNIA Approved Publication 43Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
• F eaturesRegistry string This is the
*OwningEntity** organization or
company that
publishes this
registry.
OwningSt StoragePool object A pointer to the
orageResource (Links) Storage resource
that owns or
contains this
StoragePool.
Volume (Links) object A pointer to the
Storage resource
that owns or
contains this
volume.
OwningS Volume (Links) object A pointer to the
torageService StorageService
that owns or
contains this
volume.
Parent StorageGroup array Parent
StorageGroups (Links) StorageGroups.
PeerDHC StorageGroup string The peer DHCHAP
HAPAuthSecret (DHChapInfo) auth secret for
DHCHAP
authentication.
Perce Volume integer The percentage of
ntageComplete (Operations) the operation that
has been
completed.
As of 14 June 2021 SNIA Approved Publication 44Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
PercentOfData IOPerformance integer (%) Percent of data for
LoSCapabilities this workload
(Suppo component.
rtedIOWorkloads >
Components)
PercentOfIOPS IOPerformance integer (%) Percent of total
LoSCapabilities IOPS for this
(Suppo workload
rtedIOWorkloads > component.
Components)
PercentUsed StoragePool integer A vendor-specific
(NVMeEndurance estimate of the
GroupProperties > percent life used
EndGrpLifetime) for the endurance
group based on the
actual usage and
the manufacturer
prediction of NVM
life.
PoolType StoragePool array Pool usage type for
this storage pool.
P redictedMediaLi StoragePool number (%) The percentage of
feLeftPercent (NVMeEnduranceG reads and writes
roupProperties) that are predicted
to be available for
the media.
Pro CapacitySource object The amount of
videdCapacity space that has
been provided
from the P
rovidingDrives, Pr
ovidingVolumes,
ProvidingMemory
or ProvidingPools.
As of 14 June 2021 SNIA Approved Publication 45Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
ProvidedC CapacitySource object The ClassOfService
lassOfService provided from the
P rovidingDrives,
Pr ovidingVolumes,
Providi
ngMemoryChunks,
ProvidingMemory
or ProvidingPools.
Pr ovidingDrives CapacitySource object The drive or drives
that provide this
space.
Pr CapacitySource object The memory that
ovidingMemory provides this
space.
Providin CapacitySource object The memory
gMemoryChunks chunks that
provide this space.
P rovidingPools CapacitySource object The pool or pools
that provide this
space.
Pro CapacitySource object The volume or
vidingVolumes volumes that
provide this space.
Pro visionedBytes CapacitySource (P integer (bytes) The maximum
rovidedCapacity > number of bytes
Data), that can be
CapacitySource (P allocated in this
rovidedCapacity > data store for this
Metadata), data type.
CapacitySource (P
rovidedCapacity >
Snapshot)
As of 14 June 2021 SNIA Approved Publication 46Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Provi DataStora string (enum) Provisioning policy
sioningPolicy geLineOfService for storage.
DataStorage string (enum) Space provisioning
LoSCapabilities (S policy.
upportedProvisi
oningPolicies),
StoragePool (
SupportedProvis
ioningPolicies)
Volume string (enum) This property
specifies the
volume’s storage
allocation, or
provisioning
policy.
RAIDType Volume string (enum) The RAID type of
this volume.
Volume (Actions > string (enum) The requested
C RAID type for the
hangeRAIDLayout volume.
(Action))
Ra StoragePool (NVM integer Indicates the
ndom4kReadTypic eSetProperties) typical time to
alNanoSeconds complete a 4k read
in 100
nano-second units
when the NVM Set
is in a Predictable
Latency Mode
Deterministic
Window and there
is 1 outstanding
command per NVM
Set.
As of 14 June 2021 SNIA Approved Publication 47Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Re adCachePolicy Volume string (enum) Indicates the read
cache policy
setting for the
Volume.
Re FileSystem, integer Current number of
coverableCapaci StoragePool, capacity source
tySourceCount Volume resources that are
available as
replacements.
DataStora integer Required
geLineOfService minimum number
of available
capacity source
resources.
Recove DataProtection string (enum) An enumeration
ryAccessScope LoSCapabilities that represents the
(Sup relative time
portedRecoveryT required to make a
imeObjectives), replica available as
DataStorage a source.
LoSCapabilities
(Su
pportedRecovery
TimeObjectives)
• DataProtecti string (enum) Geographic
*RecoveryGeogra
onLineOfService distribution
phicObjec- scopes.
tive**
RecoveryPoint DataProtecti string Time interval
ObjectiveTime onLineOfService defining how much
source data that
can be lost on
failure.
As of 14 June 2021 SNIA Approved Publication 48Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Recovery DataProtecti string (enum) An enumeration
TimeObjective onLineOfService value that
indicates the
expected time to
access an alternate
replica.
RecoveryT DataStora string (enum) Expectations for
imeObjectives geLineOfService time to access the
primary store after
disaster recover.
Redundancy StorageService array Redundancy
information for the
storage subsystem.
R egistryPrefix F eaturesRegistry string This is the single
word prefix used to
form a Feature ID
structure.
Re gistryVersion F eaturesRegistry string This is the feature
registry version
which is used in
the middle portion
of a Feature ID.
Rema FileSystem object Remaining
iningCapacity capacity allocated
to the file system.
RemainingCa FileShare integer The percentage of
pacityPercent the capacity
remaining in the
FileShare.
FileSystem integer The percentage of
the capacity
remaining in the
FileSystem.
As of 14 June 2021 SNIA Approved Publication 49Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
StoragePool integer The percentage of
the capacity
remaining in the
StoragePool.
Volume integer The percentage of
the capacity
remaining in the
Volume.
RemoveDrives StoragePool object This action is used
(Action) (Actions) to remove drive(s)
from the capacity
source for the
StoragePool.
RemoveRepl C onsistencyGroup object This action is used
icaRelationship (Actions) to disable data
(Action) synchronization
between a source
and target
consistency group,
remove the
replication
relationship, and
optionally delete
the target
consistency group.
As of 14 June 2021 SNIA Approved Publication 50Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Volume (Actions) object This action is used
to disable data
synchronization
between a source
and target volume,
remove the
replication
relationship, and
optionally delete
the target volume.
Replace S pareResourceSet array Other spare sets
mentSpareSets (Links) that can be utilized
to replenish this
spare set.
ReplicaA DataProtecti object Location that
ccessLocation onLineOfService supplies data
access to the
replica.
ReplicaC DataProtecti object The replica’s class
lassOfService onLineOfService of service.
Repl icaCollection FileSystem (Links) array An array of links to
replicas for this file
system.
ReplicaInfo Co nsistencyGroup, object Describes this
StorageGroup storage group in its
role as a target for
replication.
Volume object Describes this
storage volume in
its role as a target
replica.
As of 14 June 2021 SNIA Approved Publication 51Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
FileSystem object This value
describes the
replica attributes if
this file system is a
replica.
Replica DataProtecti object The data
LineOfService onLineOfService protection line of
(Actions > service this action
CreateReplicas is bound to.
(Action))
ReplicaName DataProtecti string The name of the
onLineOfService new replica.
(Actions >
CreateReplicas
(Action) > R
eplicaRequests)
Re plicaRequests DataProtecti array Specifies the
onLineOfService resources to
(Actions > replicate and a
CreateReplicas name for the
(Action)) replica.
ReplicaSource DataProtecti object A resource to be
onLineOfService replicated.
(Actions >
CreateReplicas
(Action) > R
eplicaRequests)
R eplicaTargets Co nsistencyGroup, array The resources that
FileSystem, are target replicas
StorageGroup, of this source.
Volume
As of 14 June 2021 SNIA Approved Publication 52Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
ReplicaType C onsistencyGroup string (enum) The type of replica
(Actions > Assi relationship to be
gnReplicaTarget created (e.g.,
(Action)), C Clone, Mirror,
onsistencyGroup Snap).
(Actions > Crea
teReplicaTarget
(Action))
Volume (Actions > string (enum) The type of replica
Assi relationship to be
gnReplicaTarget created.
(Action)), Volume
(Actions > Crea
teReplicaTarget
(Action))
DataProtecti string (enum) Type of replica.
onLineOfService
DataProtection string (enum) Values of
LoSCapabilities ReplicaType
(Support describe the
edReplicaTypes) intended outcome
of the replication.
As of 14 June 2021 SNIA Approved Publication 53Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Repl C onsistencyGroup string (enum) The replica update
icaUpdateMode (Actions > Assi mode
gnReplicaTarget (synchronous vs
(Action)), C asynchronous).
onsistencyGroup
(Actions > Crea
teReplicaTarget
(Action)), Volume
(Actions > Assi
gnReplicaTarget
(Action)), Volume
(Actions > Crea
teReplicaTarget
(Action))
• S pareResourceSet string The type of
*ResourceType** resources in the
set.
Re C onsistencyGroup object This action is used
sumeReplication (Actions) to resume the
(Action) active data
synchronization
between a source
and target
consistency group,
without otherwise
altering the
replication
relationship.
As of 14 June 2021 SNIA Approved Publication 54Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
Volume (Actions) object This action is used
to resume the
active data
synchronization
between a source
and target volume,
without otherwise
altering the
replication
relationship.
ReverseReplicat C onsistencyGroup object This action is used
ionRelationship (Actions) to reverse the
(Action) replication
relationship
between a source
and target
consistency group.
Volume (Actions) object This action is used
to reverse the
replication
relationship
between a source
and target volume.
RootAccess FileShare boolean Root access is
allowed by the file
share.
• IOPerforman string Sampling period
*SamplePeriod**ceLineOfService over which average
values are
calculated.
Schedule DataProtecti object A schedule for
onLineOfService making periodic
point in time
replicas.
As of 14 June 2021 SNIA Approved Publication 55Swordfish Property Guide Version 1.2.2a
Defined In
Property Name Schema(s) Type Description
IOPerformance object Specifies when to
LoSCapabilities apply this
(Suppo workload
rtedIOWorkloads > component.
Components)
SecureCh DataSecuri string (enum) Protocol that
annelProtocol tyLineOfService provide encrypted
communication.
DataSecurity string (enum) Types of Secure
LoSCapabilities channel protocols.
(Su
pportedSecureCh
annelProtocols)
ServerE StorageGroup array Groups of server
ndpointGroups endpoints in this
storage group.
StorageService object Server endpoint
groups.
Se rverEndpoints Volume (Links) array An array of
references to the
server Endpoints
associated with
this volume.
SetC StoragePool object This action is used
ompressionState (Actions) to set the
(Action) compression state
of the pool.
SetDed StoragePool object This action is used
uplicationState (Actions) to set the dedupe
(Action) state of the pool.
As of 14 June 2021 SNIA Approved Publication 56You can also read
