SoftwareInventory

Schema Definition

This schema defines an inventory of software components.

Properties

Property	Type	Nullable	Required	Permission	Description
@odata.context	String			read-only	The OData description of a payload. Format: uri
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
@odata.type	String			read-only	The type of a resource.
Actions {	Object			read-write	The Actions object contains the available custom actions on this resource.
Oem { }	Object			read-write	The available OEM specific actions for this resource.
}
Description	String	Yes		read-only	Provides a description of this resource and is used for commonality in the schema definitions.
Id	String		GET	read-only	Uniquely identifies the resource within the collection of like resources.
Name	String		GET	read-only	The name of the resource or array element.
Oem {	Object			read-write	This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
EID_47597 {	Object			read-write	RECS\|Box SoftwareInventory extension
Architecture	String	Yes	POST	read-only	The processor architecture supported by this SoftwareInventory item. Possible Values: x86: x86 or x86-64. ARM: ARM.
Distribution	String	Yes		read-only	The common name of the operating system distribution.
DownloadUrl	String	Yes		read-only	The URL to download the software inventory file Format: uri
Format	String		POST	read-only	The format of the SoftwareInventory file. Possible Values: Raw: This is an unstructured file format. ISO: The SoftwareInventory item is formatted with the read-only ISO 9660 (also known as ECMA-119) filesystem commonly used for CDs and DVDs. MassFlash: A Jetson-Massflash-Image. Unknown: This indicates an unknown file format.
InstructionSet	String	Yes	POST	read-only	The processor instruction set supported by this SoftwareInventory item. Possible Values: x86: x86 32-bit. x86-64: x86 64-bit. ARM-A32: ARM 32-bit. ARM-A64: ARM 64-bit.
SizeBytes	Int64	Yes		read-only	Size of the software inventory file in Byte. Unit: By
State	String			read-only	The current state of the SoftwareInventory item. Possible Values: Absent: No software inventory file present. Uploading: The software inventory file is currently uploading. Active: Denotes an software inventory item that is fully available. Deactivated: Denotes that access to software inventory file is not allowed to any non-admin user.
Type	String		POST	read-only	The processor type supported by this SoftwareInventory item. Possible Values: CPU: A Central Processing Unit. FPGA: A Field Programmable Gate Array.
}
}
RelatedItem [ {	Array[Reference]			read-only	The ID(s) of the resources associated with this software inventory item.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
} ]
RelatedItem@odata.count	Int32			read-only	The number of items in a collection.
SoftwareId	String			read-only	A string representing the implementation-specific ID for identifying this software.
Version	String	Yes		read-only	A string representing the version of this software.

Operations

GET

Request

GET /redfish/v1/Chassis/Chassis1/ImageInventory/SoftwareInventory1
Content-Type: application/json

Response

{
    "@odata.context": "uri",
    "@odata.id": "/redfish/v1/Chassis/Chassis1/ImageInventory/SoftwareInventory1",
    "@odata.type": "String",
    "Actions": {
        "Oem": { }
    }
    "Description": "String",
    "Id": "String",
    "Name": "String",
    "Oem": {
        "EID_47597": {
            "Architecture": "x86",
            "Distribution": "String",
            "DownloadUrl": "uri",
            "Format": "Raw",
            "InstructionSet": "x86",
            "SizeBytes": 0,
            "State": "Absent",
            "Type": "CPU"
        }
    }
    "RelatedItem": [{
        "@odata.id": "uri"
    }],
    "RelatedItem@odata.count": 1,
    "SoftwareId": "String",
    "Version": "String"
}

POST

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

PATCH

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

DELETE

This operation is not supported on this resource and will result in the following response:

HTTP/1.1 405 Method Not Allowed

Schema Navigation

SoftwareInventory

Schema Definition

Properties

Operations

GET

Request

Response

POST

PATCH

DELETE