Swordfish Schema Index


Primary Swordfish Schema Files

The following files are the primary schemas defined for JSON resources conforming to the Swordfish effort. Each schema definition is available in both CSDL (XML) and json-schema formats.
Capacity
[csdl[json-schema] [yaml]
v1.2.0This is the schema definition for the Capacity of a device. It represents the properties for capacity for any data store.
ClassOfService
[csdl[json-schema] [yaml]
v1.2.0A service option composed of one or more service options.
ConsistencyGroup
[csdl[json-schema] [yaml]
v1.0.1A collection of volumes grouped together to ensure write order consistency across all those volumes.
DataProtectionLineOfService
[csdl[json-schema] [yaml]
v1.3.0Describes a data protection service option.
DataProtectionLoSCapabilities
[csdl[json-schema] [yaml]
v1.2.0The capabilities to protect data from loss by the use of a replica.
DataSecurityLineOfService
[csdl[json-schema] [yaml]
v1.1.1Describes data security service level requirements.
DataSecurityLoSCapabilities
[csdl[json-schema] [yaml]
v1.2.0Describe data security capabilities.
DataStorageLineOfService
[csdl[json-schema] [yaml]
v1.3.1Describe data storage and provisioning capabilities.
DataStorageLineOfStorage
[json-schema] [yaml]
v1.1.0
DataStorageLoSCapabilities
[csdl[json-schema] [yaml]
v1.2.2Describe data storage and provisioning capabilities.
EndpointGroup
[csdl[json-schema] [yaml]
v1.2.1A group of endpoints that are managed as a unit.
FeaturesRegistry
[csdl[json-schema] [yaml]
v1.1.0This is the schema definition for all Features Registries. It represents the properties for the registries themselves. The FeatureId is formed per the Redfish specification. It consists of the RegistryPrefix concatenated with the version concatenated with the unique identifier for the feature registry entry.
FileShare
[csdl[json-schema] [yaml]
v1.2.0An instance of a shared set of files with a common directory structure.
FileSystem
[csdl[json-schema] [yaml]
v1.2.2An instance of a hierarchical namespace of files.
IOConnectivityLineOfService
[csdl[json-schema] [yaml]
v1.2.1A service option within the IO Connectivity line of service.
IOConnectivityLoSCapabilities
[csdl[json-schema] [yaml]
v1.2.0Describe IO Connectivity capabilities.
IOPerformanceLineOfService
[csdl[json-schema] [yaml]
v1.1.1Describe service option within the IO performance line of service.
IOPerformanceLoSCapabilities
[csdl[json-schema] [yaml]
v1.3.0Describe IO performance capabilities.
IOStatistics
[csdl[json-schema] [yaml]
v1.0.3The properties of this type represent IO statistics.
LineOfService
[csdl[json-schema] [yaml]
v1.1.0Describes a service option.
Location
[csdl[json-schema]
v1.0.0The location of a resource.
NVMeDomain
[csdl[json-schema] [yaml]
v1.1.0Properties for the Domain.
NVMeFirmwareImage
[csdl[json-schema] [yaml]
v1.1.0NVMe Domain firmware image information.
Schedule
[csdl[json-schema] [yaml]
v1.1.1Schedule a series of occurrences.
SpareResourceSet
[csdl[json-schema] [yaml]
v1.0.1A description of a set of spare resources.
StorageAccessCapability
[csdl[json-schema] [yaml]
v1.0.0Values of StorageAccessCapability describe abilities to read or write storage.
StorageGroup
[csdl[json-schema] [yaml]
v1.5.0Collection of resources that are managed and exposed to hosts as a group.
StoragePool
[csdl[json-schema] [yaml]
v1.6.0A container of data storage.
StorageReplicaInfo
[csdl[json-schema] [yaml]
v1.3.0Defines the characteristics of a Storage Replica.
StorageService
[csdl[json-schema] [yaml]
v1.5.0Collection of resources that are managed and exposed to hosts as a group.
Swordfish
[json-schema]
v1.0.2
SwordfishFeatureRegistry
[json-schema]
v1.0.2
Volume
[csdl[json-schema] [yaml]
v1.6.2Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.
openapi
[yaml]

Supporting Swordfish Schema Files

The following files are supporting Swordfish schema files, used primarily for programmatic validation of schemas or conformance testing.
Capacity
[json-schema]
This is the schema definition for the Capacity of a device. It represents the properties for capacity for any data store.
CapacitySourceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of CapacitySourceCollection.
ClassOfService
[json-schema]
A service option composed of one or more other service options.
ClassOfServiceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ClassOfServiceCollection.
ConsistencyGroup
[json-schema]
A collection of volumes grouped together to ensure write order consistency across all those volumes.
ConsistencyGroupCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ConsistencyGroupCollection.
DataProtectionLineOfService
[json-schema]
Describes a data protection service option.
DataProtectionLoSCapabilities
[json-schema]
The capabilities to protect data from loss by the use of a replica.
DataSecurityLineOfService
[json-schema]
The capabilities to protect the system data from loss.
DataSecurityLoSCapabilities
[json-schema]
Describe data security capabilities.
DataStorageLineOfService
[json-schema]
Describe data storage and provisioning capabilities.
DataStorageLoSCapabilities
[json-schema]
Describe data storage and provisioning capabilities.
DriveCollection
[csdl[json-schema] [yaml]
Unversioned root definition of DriveCollection.
EndpointCollection
[csdl[json-schema] [yaml]
Unversioned root definition of EndpointCollection.
EndpointGroup
[json-schema]
A group of endpoints that are managed as a unit.
EndpointGroupCollection
[csdl[json-schema] [yaml]
Unversioned root definition of EndpointGroupCollection.
FeaturesRegistry
[json-schema]
This is the schema definition for all Features Registries. It represents the properties for the registries themselves. The FeatureId is formed per the Redfish specification. It consists of the RegistryPrefix concatenated with the version concatenated with the unique identifier for the feature registry entry.
FileShare
[json-schema]
A shared set of files.
FileShareCollection
[csdl[json-schema] [yaml]
Unversioned root definition of FileShareCollection.
FileSystem
[json-schema]
A hierarchical namespace of files.
FileSystemCollection
[csdl[json-schema] [yaml]
Unversioned root definition of FileSystemCollection.
HostedStorageServices
[csdl] [yaml]
IOConnectivityLineOfService
[json-schema]
A service option within the IO Connectivity line of service.
IOConnectivityLoSCapabilities
[json-schema]
Describe IO connectivity capabilities.
IOPerformanceLineOfService
[json-schema]
Describe service option within the IO performance line of service.
IOPerformanceLoSCapabilities
[json-schema]
Describe IO performance capabilities.
IOStatistics
[json-schema]
The properties of this type represent IO statistics.
LineOfService
[json-schema]
Describes a service option.
LineOfServiceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of LineOfServiceCollection.
Location
[json-schema]
The location of a resource.
NVMeDomain
[json-schema]
This is the schema definition for domain.
NVMeDomainCollection
[csdl[json-schema] [yaml]
Unversioned root definition of NVMeDomainCollection.
NVMeFirmwareImage
[json-schema]
This is the schema definition for NVMe Domain firmware image properties.
Schedule
[json-schema]
Schedule a series of occurrences.
SpareResourceSet
[json-schema]
A description of a set of spare resources.
StorageAccessCapability
[json-schema]
Values of StorageAccessCapability describe abilities to read or write storage.
StorageGroup
[json-schema]
Collection of resources that are managed and exposed to hosts as a group.
StorageGroupCollection
[csdl[json-schema] [yaml]
Unversioned root definition of StorageGroupCollection.
StoragePool
[json-schema]
A container of data storage.
StoragePoolCollection
[csdl[json-schema] [yaml]
Unversioned root definition of StoragePoolCollection.
StorageReplicaInfo
[json-schema]
Defines the characteristics of a Storage Replica.
StorageService
[json-schema]
A storage service.
StorageServiceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of StorageServiceCollection.
StorageSystemCollection
[csdl[json-schema] [yaml]
v1.0.1Unversioned root definition of StorageSystemCollection.
Volume
[json-schema]
Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.
VolumeCollection
[csdl[json-schema] [yaml]
Unversioned root definition of VolumeCollection.