Blame - static/redfish/v1/JsonSchemas/Drive/Drive.json - openbmc/bmcweb

"longDescription": "This property shall contain the hot spare type for the associated drive. If the drive is currently serving as a hot spare its Status.State field shall be 'StandbySpare' and 'Enabled' when it is being used as part of a Volume.",

187

"readonly": true

188

},

189

"Id": {

190

"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",

"readonly": true

},

"Identifiers": {

"description": "The Durable names for the drive.",

195

"items": {

196

"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier"

197

},

198

"longDescription": "This property shall contain a list of all known durable names for the associated drive.",

"type": "array"

},

"IndicatorLED": {

"anyOf": [

{

"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/IndicatorLED"

},

{

"type": "null"

}

],

"description": "The state of the indicator LED, used to identify the drive.",

211

"longDescription": "This value of this property shall contain the indicator light state for the indicator light associated with this drive.",

"readonly": false

},

"Links": {

"$ref": "#/definitions/Links",

216

"description": "Contains references to other resources that are related to this resource.",

217

"longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource."

218

},

219

"Location": {

220

"deprecated": "This property has been Deprecated in favor of the singular property PhysicalLocation found in Drive.v1_4_0.",

221

"description": "The Location of the drive.",

222

"items": {

223

"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location"

224

},

225

"longDescription": "This property shall contain location information of the associated drive.",

"type": "array"

},

"Manufacturer": {

"description": "This is the manufacturer of this drive.",

230

"longDescription": "The value of this property shall be the name of the organization responsible for producing the drive. This organization might be the entity from whom the drive is purchased, but this is not necessarily true.",

"readonly": true,

"type": [

"string",

"null"

]

},

"MediaType": {

"anyOf": [

{

"$ref": "#/definitions/MediaType"

},

{

"type": "null"

}

],

"description": "The type of media contained in this drive.",

247

"longDescription": "This property shall contain the type of media contained in the associated drive.",

"readonly": true

},

"Model": {

"description": "This is the model number for the drive.",

252

"longDescription": "The value of this property shall be the name by which the manufacturer generally refers to the drive.",

"readonly": true,

"type": [

"string",

"null"

]

},

"Name": {

"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",

261

"readonly": true

262

},

263

"NegotiatedSpeedGbs": {

264

"description": "The speed which this drive is currently communicating to the storage controller in Gigabits per second.",

265

"longDescription": "This property shall contain current bus speed of the associated drive.",

"readonly": true,

"type": [

"number",

"null"

],

"units": "Gbit/s"

},

"Oem": {

"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",

275

"description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",

276

"longDescription": "The value of this string shall be of the format for the reserved word *Oem*."

277

},

278

"Operations": {

279

"description": "The operations currently running on the Drive.",

280

"items": {

281

"$ref": "#/definitions/Operations"

282

},

283

"longDescription": "This property shall contain a list of all operations currently running on the Drive.",

"type": "array"

},

"PartNumber": {

"description": "The part number for this drive.",

288

"longDescription": "The value of this property shall be a part number assigned by the organization that is responsible for producing or manufacturing the drive.",

"readonly": true,

"type": [

"string",

"null"

]

},

"PhysicalLocation": {

296

"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location",

297

"description": "The Location of the drive.",

298

"longDescription": "This property shall contain location information of the associated drive."

299

},

300

"PredictedMediaLifeLeftPercent": {

301

"description": "The percentage of reads and writes that are predicted to still be available for the media.",

302

"longDescription": "This property shall contain an indicator of the percentage of life remaining in the Drive's media.",

"readonly": true,

"type": [

"number",

"null"

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

307

],

308

"units": "%"

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

},

"Protocol": {

"anyOf": [

{

"$ref": "http://redfish.dmtf.org/schemas/v1/Protocol.json#/definitions/Protocol"

},

{

"type": "null"

}

],

"description": "The protocol this drive is using to communicate to the storage controller.",

320

"longDescription": "This property shall contain the protocol the associated drive is using to communicate to the storage controller for this system.",

"readonly": true

},

"Revision": {

"description": "The revision of this Drive. This is typically the firmware/hardware version of the drive.",

325

"longDescription": "This property shall contain the revision as defined by the manufacturer for the associated drive.",

"readonly": true,

"type": [

"string",

"null"

]

},

"RotationSpeedRPM": {

333

"description": "The rotation speed of this Drive in Revolutions per Minute (RPM).",

334

"longDescription": "This property shall contain rotation speed of the associated drive.",

"readonly": true,

"type": [

"number",

"null"

],

"units": "RPM"

},

"SKU": {

"description": "This is the SKU for this drive.",

344

"longDescription": "The value of this property shall be the stock-keeping unit number for this drive.",

"readonly": true,

"type": [

"string",

"null"

]

},

"SerialNumber": {

"description": "The serial number for this drive.",

353

"longDescription": "The value of this property shall be a manufacturer-allocated number used to identify the drive.",

"readonly": true,

"type": [

"string",

"null"

]

},

"Status": {

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

361

"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",

362

"description": "This property describes the status and health of the resource and its children.",

363

"longDescription": "This property shall contain any status or health properties of the resource."

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

},

"StatusIndicator": {

"anyOf": [

{

"$ref": "#/definitions/StatusIndicator"

},

{

"type": "null"

}

],

"description": "The state of the status indicator, used to communicate status information about this drive.",

375

"longDescription": "The value of this property shall contain the status indicator state for the status indicator associated with this drive. The valid values for this property are specified through the Redfish.AllowableValues annotation.",

"readonly": false

}

},

"required": [

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

380

"@odata.id",

381

"@odata.type",

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

"Id",

"Name"

],

"type": "object"

},

"EncryptionAbility": {

388

"enum": [

389

"None",

390

"SelfEncryptingDrive",

391

"Other"

392

],

393

"enumDescriptions": {

394

"None": "The drive is not capable of self encryption.",

395

"Other": "The drive is capable of self encryption through some other means.",

396

"SelfEncryptingDrive": "The drive is capable of self encryption per the Trusted Computing Group's Self Encrypting Drive Standard."

},

"type": "string"

},

"EncryptionStatus": {

"enum": [

"Unecrypted",

"Unlocked",

"Locked",

"Foreign",

"Unencrypted"

],

"enumDeprecated": {

"Unecrypted": "This value has been Deprecated in favor of Unencrypted."

410

},

411

"enumDescriptions": {

412

"Foreign": "The drive is currently encrypted, the data is not accessible to the user, and the system requires user intervention to expose the data.",

413

"Locked": "The drive is currently encrypted and the data is not accessible to the user, however the system has the ability to unlock the drive automatically.",

414

"Unecrypted": "The drive is not currently encrypted.",

415

"Unencrypted": "The drive is not currently encrypted.",

416

"Unlocked": "The drive is currently encrypted but the data is accessible to the user unencrypted."

417

},

418

"type": "string"

419

},

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

420

"HotspareReplacementModeType": {

"enum": [

"Revertible",

"NonRevertible"

],

"enumDescriptions": {

426

"NonRevertible": "A hotspare drive that is commissioned due to a drive failure will remain as a data drive and will not revert to a hotspare if the failed drive is replaced.",

427

"Revertible": "A hotspare drive that is commissioned due to a drive failure will revert to being a hotspare once the failed drive is replaced and rebuilt."

428

},

429

"type": "string"

430

},

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

"HotspareType": {

"enum": [

"None",

"Global",

"Chassis",

"Dedicated"

],

"enumDescriptions": {

439

"Chassis": "The drive is currently serving as a hotspare for all other drives in the chassis.",

440

"Dedicated": "The drive is currently serving as a hotspare for a user defined set of drives.",

441

"Global": "The drive is currently serving as a hotspare for all other drives in the storage system.",

442

"None": "The drive is not currently a hotspare."

},

"type": "string"

},

"Links": {

"additionalProperties": false,

448

"description": "Contains references to other resources that are related to this resource.",

449

"longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.",

450

"patternProperties": {

451

"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {

452

"description": "This property shall specify a valid odata or Redfish property.",

453

"type": [

454

"array",

455

"boolean",

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

456

"integer",

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

"number",

"null",

"object",

"string"

]

}

},

"properties": {

"Chassis": {

"$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis",

467

"description": "A reference to the Chassis which contains this Drive.",

468

"longDescription": "The value of this property shall be a reference to a resource of type Chassis that represent the physical container associated with this Drive.",

"readonly": true

},

"Endpoints": {

"description": "An array of references to the endpoints that connect to this drive.",

473

"items": {

474

"$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint"

475

},

476

"longDescription": "The value of this property shall be a reference to the resources that this drive is associated with and shall reference a resource of type Endpoint.",

"readonly": true,

"type": "array"

},

"Endpoints@odata.count": {

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

481

"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

482

},

483

"Oem": {

484

"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",

485

"description": "Oem extension object.",

486

"longDescription": "This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification."

487

},

488

"Volumes": {

489

"description": "An array of references to the volumes contained in this drive. This will reference Volumes that are either wholly or only partly contained by this drive.",

490

"items": {

491

"$ref": "http://redfish.dmtf.org/schemas/v1/Volume.json#/definitions/Volume"

492

},

493

"longDescription": "The value of this property shall be a reference to the resources that this drive is associated with and shall reference a resource of type Volume. This shall include all Volume resources of which this Drive is a member and all Volumes for which this Drive is acting as a spare if the HotspareType is Dedicated.",

"readonly": true,

"type": "array"

},

"Volumes@odata.count": {

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

498

"$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

}

},

"type": "object"

},

"MediaType": {

"enum": [

"HDD",

"SSD",

"SMR"

],

"enumDescriptions": {

510

"HDD": "The drive media type is traditional magnetic platters.",

511

"SMR": "The drive media type is shingled magnetic recording.",

512

"SSD": "The drive media type is solid state or flash memory."

},

"type": "string"

},

"OemActions": {

"additionalProperties": true,

518

"description": "The available OEM specific actions for this resource.",

519

"longDescription": "This type shall contain any additional OEM actions for this resource.",

520

"patternProperties": {

521

"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {

522

"description": "This property shall specify a valid odata or Redfish property.",

523

"type": [

524

"array",

525

"boolean",

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

526

"integer",

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

"number",

"null",

"object",

"string"

]

}

},

"properties": {},

"type": "object"

},

"Operations": {

"additionalProperties": false,

539

"description": "An operation currently running on this resource.",

540

"longDescription": "This type shall describe a currently running operation on the resource.",

541

"patternProperties": {

542

"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {

543

"description": "This property shall specify a valid odata or Redfish property.",

544

"type": [

545

"array",

546

"boolean",

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

547

"integer",

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

"number",

"null",

"object",

"string"

]

}

},

"properties": {

"AssociatedTask": {

"$ref": "http://redfish.dmtf.org/schemas/v1/Task.json#/definitions/Task",

558

"description": "A reference to the task associated with the operation if any.",

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

559

"longDescription": "The value of this property shall be a reference to a resource of type Task that represents the task associated with the operation.",

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

"readonly": true

},

"OperationName": {

"description": "The name of the operation.",

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

564

"longDescription": "This property shall be a string of the name of the operation.",

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

"readonly": true,

"type": [

"string",

"null"

]

},

"PercentageComplete": {

572

"description": "The percentage of the operation that has been completed.",

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

573

"longDescription": "This property shall be an interger of the percentage of the operation that has been completed.",

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

574

"readonly": true,

575

"type": [

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

576

"integer",

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

577

"null"

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

578

],

579

"units": "%"

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

}

},

"type": "object"

},

"SecureErase": {

"additionalProperties": false,

586

"description": "This action is used to securely erase the contents of the drive.",

587

"longDescription": "This action shall perform a secure erase of the drive.",

588

"parameters": {},

589

"patternProperties": {

590

"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {

591

"description": "This property shall specify a valid odata or Redfish property.",

592

"type": [

593

"array",

594

"boolean",

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

595

"integer",

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

"number",

"null",

"object",

"string"

]

}

},

"properties": {

"target": {

"description": "Link to invoke action",

"format": "uri",

"type": "string"

},

"title": {

"description": "Friendly action name",

"type": "string"

}

},

"type": "object"

},

"StatusIndicator": {

"enum": [

"OK",

"Fail",

"Rebuild",

"PredictiveFailureAnalysis",

"Hotspare",

"InACriticalArray",

"InAFailedArray"

],

"enumDescriptions": {

627

"Fail": "The drive has failed.",

628

"Hotspare": "The drive is marked to be automatically rebuilt and used as a replacement for a failed drive.",

629

"InACriticalArray": "The array that this drive is a part of is degraded.",

630

"InAFailedArray": "The array that this drive is a part of is failed.",

631

"OK": "The drive is OK.",

632

"PredictiveFailureAnalysis": "The drive is still working but predicted to fail soon.",

633

"Rebuild": "The drive is being rebuilt."

},

"type": "string"

}

},

"owningEntity": "DMTF",

Ed Tanous

530520e

2019-01-02 13:41:37 -0800

[diff] [blame^]

639

"title": "#Drive.v1_5_0.Drive"

Ed Tanous

118b1c7

2018-09-13 13:45:51 -0700

[diff] [blame]

640

}