460 lines
21 KiB
JSON
460 lines
21 KiB
JSON
{
|
|
"$schema": "http://schemas.dmtf.org/redfish/v1/redfish-schema.0.96.0",
|
|
"title": "ComputerSystem.0.96.0",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"@odata.context": {
|
|
"$ref": "odata.4.0.0.json#context"
|
|
},
|
|
"@odata.id": {
|
|
"$ref": "odata.4.0.0.json#id"
|
|
},
|
|
"@odata.type": {
|
|
"$ref": "odata.4.0.0.json#type"
|
|
},
|
|
"Oem": {
|
|
"$ref": "Resource.0.96.0.json#Oem",
|
|
"description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
|
|
"longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
|
|
},
|
|
"Id": {
|
|
"$ref": "Resource.0.96.0.json#Id"
|
|
},
|
|
"Description": {
|
|
"$ref": "Resource.0.96.0.json#Description"
|
|
},
|
|
"Name": {
|
|
"$ref": "Resource.0.96.0.json#Name"
|
|
},
|
|
"SystemType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Physical",
|
|
"Virtual",
|
|
"OS",
|
|
"PhysicallyPartitioned",
|
|
"VirtuallyPartitioned"
|
|
],
|
|
"enumDescriptions": {
|
|
"Physical": "A computer system",
|
|
"Virtual": "A virtual machine instance running on this system",
|
|
"OS": "An operating system instance",
|
|
"PhysicallyPartitioned": "A hardware-based partition of a computer system",
|
|
"VirtuallyPartitioned": "A virtual or software-based partition of a computer system"
|
|
},
|
|
"readonly": true,
|
|
"description": "The type of computer system represented by this resource.",
|
|
"longDescription": "An enumeration that indicates the kind of system that this resource represents."
|
|
},
|
|
"Links": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"Oem": {
|
|
"$ref": "Resource.0.96.0.json#Oem",
|
|
"description": "Oem extension object.",
|
|
"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."
|
|
},
|
|
"Chassis": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"@odata.id" :{
|
|
"$ref": "odata.4.0.0.json#Id"
|
|
}
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"description": "An array of references to the chassis in which this system is contained",
|
|
"longDescription": "The value of this property shall reference a resource of type Chassis that represents the physical container associated with this resource."
|
|
},
|
|
"Processors": {
|
|
"type": "object",
|
|
"properties": {
|
|
"@odata.id" :{
|
|
"$ref": "odata.4.0.0.json#Id"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"description": "A reference to the collection of Processors associated with this system",
|
|
"longDescription": "The value of this property shall be a link to a processor collection."
|
|
},
|
|
"ManagedBy": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"@odata.id" :{
|
|
"$ref": "odata.4.0.0.json#Id"
|
|
}
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"description": "An array of references to the Managers responsible for this system",
|
|
"longDescription": "The value of this property shall reference a resource of type manager that represents the resource with management responsibility for this resource."
|
|
},
|
|
"EthernetInterfaces": {
|
|
"type": "object",
|
|
"properties": {
|
|
"@odata.id" :{
|
|
"$ref": "odata.4.0.0.json#Id"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"description": "A reference to the Ethernet interfaces associated with this system",
|
|
"longDescription": "The value of this property shall be a link to a collection of EthernetInterfaces."
|
|
},
|
|
"SimpleStorage": {
|
|
"type": "object",
|
|
"properties": {
|
|
"@odata.id" :{
|
|
"$ref": "odata.4.0.0.json#Id"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"description": "A reference to the storage devices associated with this system",
|
|
"longDescription": "The value of this property shall be a link to a collection of SimpleStorages."
|
|
},
|
|
"LogServices": {
|
|
"type": "object",
|
|
"properties": {
|
|
"@odata.id" :{
|
|
"$ref": "odata.4.0.0.json#Id"
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"description": "A reference to the Log Service associated with this system",
|
|
"longDescription": "The value of this property shall be a link to a collection of LogServices."
|
|
},
|
|
"PoweredBy": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"@odata.id" :{
|
|
"$ref": "odata.4.0.0.json#Id"
|
|
}
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"description": "An array of ID[s] of resources that power this computer system. Normally the ID will be a chassis or a specific set of powerSupplies",
|
|
"longDescription": "The value of this property shall be an array of IDs containing pointers to the resource that powers this computer system."
|
|
},
|
|
"CooledBy": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"@odata.id" :{
|
|
"$ref": "odata.4.0.0.json#Id"
|
|
}
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"description": "An array of ID[s] of resources that cool this computer system. Normally the ID will be a chassis or a specific set of fans.",
|
|
"longDescription": "The value of this property shall be an array of IDs containing pointers to the resource that powers this computer system."
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"description": "Contains links to other resources that are related to this resource."
|
|
},
|
|
"AssetTag": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"readonly": false,
|
|
"description": "The user definable tag that can be used to track this computer system for inventory or other client purposes",
|
|
"longDescription": "The value of this property shall contain the value of the asset tag of the system."
|
|
},
|
|
"Manufacturer": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"readonly": true,
|
|
"description": "The manufacturer or OEM of this system.",
|
|
"longDescription": "The value of this property shall contain a value that represents the manufacturer of the system."
|
|
},
|
|
"Model": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"readonly": true,
|
|
"description": "The model number for this system",
|
|
"longDescription": "The value of this property shall contain the information about how the manufacturer references this system."
|
|
},
|
|
"SKU": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"readonly": true,
|
|
"description": "The manufacturer SKU for this system",
|
|
"longDescription": "The value of this property shall contain the Stock Keeping Unit (SKU) for the system."
|
|
},
|
|
"SerialNumber": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"readonly": true,
|
|
"description": "The serial number for this system",
|
|
"longDescription": "The value of this property shall contain the serial number for the system."
|
|
},
|
|
"PartNumber": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"readonly": true,
|
|
"description": "The part number for this system",
|
|
"longDescription": "The value of this property shall contain the part number for the system as defined by the manufacturer."
|
|
},
|
|
"UUID": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"readonly": true,
|
|
"description": "The universal unique identifier (UUID) for this system",
|
|
"longDescription": "The value of this property shall contain the universal unique identifier number for the system."
|
|
},
|
|
"HostName": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"description": "The DNS Host Name, without any domain information",
|
|
"longDescription": "The value of this property shall be the host name for this system, as reported by the operating system or hypervisor."
|
|
},
|
|
"IndicatorLED": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"enum": [
|
|
"Unknown",
|
|
"Lit",
|
|
"Blinking",
|
|
"Off"
|
|
],
|
|
"enumDescriptions": {
|
|
"Unknown": "The state of the Indicator LED cannot be determined.",
|
|
"Lit": "The Indicator LED is lit.",
|
|
"Blinking": "The Indicator LED is blinking.",
|
|
"Off": "The Indicator LED is off."
|
|
},
|
|
"readonly": false,
|
|
"description": "The state of the indicator LED, used to identify the system",
|
|
"longDescription": "The value of this property shall contain the indicator light state for the indicator light associated with this system."
|
|
},
|
|
"PowerState": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"enum": [
|
|
"On",
|
|
"Off",
|
|
"Unknown",
|
|
"Reset"
|
|
],
|
|
"readonly": true,
|
|
"description": "This is the current power state of the system",
|
|
"longDescription": "The value of this property shall contain the power state of the system."
|
|
},
|
|
"Boot": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"BootSourceOverrideTarget": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"enum": [
|
|
"None",
|
|
"Pxe",
|
|
"Floppy",
|
|
"Cd",
|
|
"Usb",
|
|
"Hdd",
|
|
"BiosSetup",
|
|
"Utilities",
|
|
"Diags",
|
|
"UefiShell",
|
|
"UefiTarget"
|
|
],
|
|
"enumDescriptions": {
|
|
"None": "Boot from the normal boot device",
|
|
"Pxe": "Boot from the Pre-Boot EXecution (PXE) environment",
|
|
"Floppy": "Boot from the floppy disk drive",
|
|
"Cd": "Boot from the CD/DVD disc",
|
|
"Usb": "Boot from a USB device as specified by the system BIOS",
|
|
"Hdd": "Boot from a hard drive",
|
|
"BiosSetup": "Boot to the BIOS Setup Utility",
|
|
"Utilities": "Boot the manufacturer's Utilities program(s)",
|
|
"Diags": "Boot the manufacturer's Diagnostics program",
|
|
"UefiShell": "Boot to the UEFI Shell",
|
|
"UefiTarget": "Boot to the UEFI Device specified in the UefiTargetBootSourceOverride property"
|
|
},
|
|
"readonly": false,
|
|
"description": "The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnabled is true.",
|
|
"longDescription": "The value of this property shall contain the source to boot the system from, overriding the normal boot order. The valid values for this property are specified through the DMTF.AllowableValues annotation. Pxe indicates to PXE boot from the primary NIC; Floppy, Cd, Usb, Hdd indicates to boot from their devices respectively. BiosSetup indicates to boot into the native BIOS screen setup. Utilities and Diags indicate to boot from the local utilities or diags partitions and UefiTarget indicates to boot from the UEFI device path found in UefiTargetBootSourceOverride."
|
|
},
|
|
"BootSourceOverrideEnabled": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"enum": [
|
|
"Disabled",
|
|
"Once",
|
|
"Continuous"
|
|
],
|
|
"enumDescriptions": {
|
|
"Disabled": "The system will boot as normal",
|
|
"Once": "On its next boot cycle, the system will boot (one time) to the Boot Source Override Target.",
|
|
"Continuous": "The system will boot to the target specified in the BootSourceOverrideTarget until this property is set to Disabled."
|
|
},
|
|
"readonly": false,
|
|
"description": "Describes the state of the Boot Source Override feature",
|
|
"longDescription": "The value of this property shall be Once if this is a one time boot override and Continuous if this selection should remain active until cancelled."
|
|
},
|
|
"UefiTargetBootSourceOverride": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"readonly": false,
|
|
"description": "This property is the Uefi Device Path of the device to boot from when BootSourceOverrideSupported is UefiTarget.",
|
|
"longDescription": "The value of this property shall be the UEFI device path of the override boot target. The valid values for this property are specified through the DMTF.AllowableValues annotation. BootSourceOverrideEnabled = Continuous is not supported for Uefi Boot Source Override as this setting is defined in UEFI as a one time boot only."
|
|
}
|
|
},
|
|
"description": "This object contains the boot information for the current resource."
|
|
},
|
|
"BiosVersion": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"description": "The version of the system BIOS or primary system firmware.",
|
|
"longDescription": "The value of this property shall be the version string of the currently installed and running BIOS (for x86 systems). For other systems, the value may contain a version string representing the primary system firmware."
|
|
},
|
|
"ProcessorSummary": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"Count": {
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
],
|
|
"readonly": true,
|
|
"description": "The number of processors in the system.",
|
|
"longDescription": "This property shall contain the number of central processors in the system."
|
|
},
|
|
"Model": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"readonly": true,
|
|
"description": "The processor model for the primary or majority of processors in this system.",
|
|
"longDescription": "This property shall contain the processor model for the central processors in the system, per the description in Table 22 of the SMBIOS Specification DSP0134 2.8 or later."
|
|
},
|
|
"Status": {
|
|
"$ref": "Resource.0.96.0.json#Status"
|
|
}
|
|
},
|
|
"description": "This object describes the central processors of the system in general detail."
|
|
},
|
|
"MemorySummary": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"TotalSystemMemoryGiB": {
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
],
|
|
"readonly": true,
|
|
"description": "This is the total amount of memory in the system measured in GiB.",
|
|
"longDescription": "This property shall contain the amount of system general purpose volatile (RAM) memory as measured in gibibytes."
|
|
},
|
|
"Status": {
|
|
"$ref": "Resource.0.96.0.json#Status"
|
|
}
|
|
},
|
|
"description": "This object describes the central memory of the system in general detail."
|
|
},
|
|
"Actions": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"Oem": {
|
|
"type": [
|
|
"object",
|
|
"null"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
|
|
}
|
|
},
|
|
"#ComputerSystem.Reset": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"title": {
|
|
"type": "string",
|
|
"description": "Friendly action name"
|
|
},
|
|
"target": {
|
|
"type": "string",
|
|
"description": "Link to invoke action"
|
|
},
|
|
"ResetType@DMTF.AllowableValues": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"On",
|
|
"ForceOff",
|
|
"GracefulRestart",
|
|
"ForceRestart",
|
|
"Nmi",
|
|
"ForceOn",
|
|
"PushPowerButton"
|
|
],
|
|
"enumDescriptions": {
|
|
"On": "Turn the system on",
|
|
"ForceOff": "Turn the system off immediately (non-graceful) shutdown",
|
|
"GracefulRestart": "Perform a graceful system shutdown followed by a restart of the system",
|
|
"ForceRestart": "Perform an immediate (non-graceful) shutdown, followed by a restart of the system",
|
|
"Nmi": "Generate a Non-Maskable Interrupt to cause an immediate system halt",
|
|
"ForceOn": "Turn the system on immediately",
|
|
"PushPowerButton": "Simulate the pressing of the physical power button on this system"
|
|
}
|
|
},
|
|
"description": "The type of reset to be performed",
|
|
"longDescription": "This defines the property name for the action."
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"readonly": true,
|
|
"description": "The Actions object contains the available custom actions on this resource."
|
|
},
|
|
"Status": {
|
|
"$ref": "Resource.0.96.0.json#Status"
|
|
}
|
|
},
|
|
"description": "This schema defines a computer system and its respective properties. A computer system represents a machine (physical or virtual) and the local resources such as memory, cpu and other devices that can be accessed from that machine.",
|
|
"longDescription": "This resource shall be used to represent resources that represent a computing system in the Redfish specification."
|
|
}
|