ComposedNodeCollection

Schema Definition

Properties

Property	Type	Nullable	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 available actions for this resource.
#ComposedNodeCollection.Allocate {	Object		read-write	This action is used to allocate a composed node.
target	String		read-write	Link to invoke action Format: uri
title	String		read-write	Friendly action name
}
Oem { }	Object		read-write
}
Description	String	Yes	read-only	Provides a description of this resource and is used for commonality in the schema definitions.
Members [ {	Array[Reference(ComposedNode)]		read-only	Contains the members of this collection.
@odata.id	String		read-only	The unique identifier for a resource. Format: uri
} ]
Members@odata.count	Int32		read-only	The number of items in a collection.
Name	String		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.

Actions

#ComposedNodeCollection.Allocate

Parameters

Property	Type	Nullable	Required	Permission	Description
ComposedNodes [ {	Array[Object]	Yes		read-write	The requirements for a ComposedNode
Resource {	Reference(ComposedNode)	Yes		read-write	The URI of a ComposedNode resource. If this property is set, all other ComposedNode requirements are ignored.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
} ]
Description	String		POST	read-write	The description of the ComposedNode
Devices [ {	Array[Object]	Yes		read-write	The requirements for a PCIe device
Baseboard {	Reference(Baseboard)	Yes		read-write	The Baseboard where applicable resources are located
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
HSLLInterface {	Object	Yes		read-write	The requirements for a HSLL interface
AvailableWidth	Int32	Yes		read-write	The number of unused lanes of the HSLL interface
MaxSpeedGbps	Int32	Yes		read-write	The minimal value of the maximum speed of the HSLL interface Unit: GBytes/s
MaxWidth	Int32	Yes		read-write	The minimal value of the maximum lanes of the HSLL interface
Resource {	Reference(HSLLInterface)	Yes		read-write	The URI of a HSLLInterface resource. If this property is set, all other HSLL interface requirements are ignored.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
}
PCIeFunctions [ {	Array[Object]			read-write	The minimal required set of PCIe functions exposed by the PCIe device
ClassCode	String	Yes		read-write	The Class Code of this PCIe function. Pattern: ^0[xX](([a-fA-F]\|[0-9]){2}){3}$
DeviceClass	String	Yes		read-write	The class for this PCIe Function Possible Values: UnclassifiedDevice: An unclassified device. MassStorageController: A mass storage controller. NetworkController: A network controller. DisplayController: A display controller. MultimediaController: A multimedia controller. MemoryController: A memory controller. Bridge: A bridge. CommunicationController: A communication controller. GenericSystemPeripheral: A generic system peripheral. InputDeviceController: An input device controller. DockingStation: A docking station. Processor: A processor. SerialBusController: A serial bus controller. WirelessController: A wireless controller. IntelligentController: An intelligent controller. SatelliteCommunicationsController: A satellite communications controller. EncryptionController: An encryption controller. SignalProcessingController: A signal processing controller. ProcessingAccelerators: A processing accelerators. NonEssentialInstrumentation: A non-essential instrumentation. Coprocessor: A coprocessor. UnassignedClass: An unassigned class. Other: A other class. The function Device Class Id needs to be verified.
DeviceId	String	Yes		read-write	The Device ID of this PCIe function. Pattern: ^0[xX](([a-fA-F]\|[0-9]){2}){2}$
FunctionType	String	Yes		read-write	The type of the PCIe Function Possible Values: Physical: A physical PCie function. Virtual: A virtual PCIe function.
RevisionId	String	Yes		read-write	The Revision ID of this PCIe function. Pattern: ^0[xX](([a-fA-F]\|[0-9]){2}){1}$
SubsystemId	String	Yes		read-write	The Subsystem ID of this PCIe function. Pattern: ^0[xX](([a-fA-F]\|[0-9]){2}){2}$
SubsystemVendorId	String	Yes		read-write	The Subsystem Vendor ID of this PCIe function. Pattern: ^0[xX](([a-fA-F]\|[0-9]){2}){2}$
VendorId	String	Yes		read-write	The Vendor ID of this PCIe function. Pattern: ^0[xX](([a-fA-F]\|[0-9]){2}){2}$
} ]
Resource {	Reference(PCIeDevice)	Yes		read-write	The URI of a PCIeDevice resource. If this property is set, all other PCIe device requirements are ignored.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
SerialNumber	String	Yes		read-write	The exact serial number of the PCIe device
Type	String	Yes		read-write	The exact type of the PCIe device Possible Values: SingleFunction: A single-function PCIe device. MultiFunction: A multi-function PCIe device. Simulated: A PCIe device which is not currently physically present, but is being simulated by the PCIe infrastructure.
} ]
Name	String		POST	read-write	The name of the ComposedNode
Ports [ {	Array[Object]	Yes		read-write	The requirements for a port of a PCIeSwitch or a ComposedNode
DeviceIndex	Int32	Yes		read-write	The zero-based index of the device in the devices array, whose PCIe Port is required. SystemIndex and DeviceIndex cannot be used together. Minimum: 0
SystemIndex	Int32	Yes		read-write	The zero-based index of the system in the systems array, whose PCIe Port is required. SystemIndex and DeviceIndex cannot be used together. Minimum: 0
} ]
Systems [ {	Array[Object]	Yes		read-write	The requirements for a system
Baseboard {	Reference(Baseboard)	Yes		read-write	The Baseboard where applicable resources are located
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
EthernetInterfaces [ {	Array[Object]			read-write	The requirements for one or more ethernet interfaces
Resource {	Reference(EthernetInterface)	Yes		read-write	The URI of a EthernetInterface resource. If this property is set, all other ethernet interface requirements are ignored.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
SpeedMbps	Int32	Yes		read-write	The minimum speed of the ethernet interface Unit: Mbit/s
VLANs [ {	Array[Object]			read-write	The VLANs of the ethernet interface
Tagged	Boolean	Yes		read-write	The tagged value of the VLAN
VLANId	Int64	Yes		read-write	The ID of the VLAN Minimum: 1 Maximum: 4080
} ]
} ]
HSLLInterface {	Object	Yes		read-write	The requirements for a HSLL interface
AvailableWidth	Int32	Yes		read-write	The number of unused lanes of the HSLL interface
MaxSpeedGbps	Int32	Yes		read-write	The minimal value of the maximum speed of the HSLL interface Unit: GBytes/s
MaxWidth	Int32	Yes		read-write	The minimal value of the maximum lanes of the HSLL interface
Resource {	Reference(HSLLInterface)	Yes		read-write	The URI of a HSLLInterface resource. If this property is set, all other HSLL interface requirements are ignored.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
}
Processors [ {	Array[Object]			read-write	The requirements for one or more processors
AchievableSpeedMHz	Int32	Yes		read-write	The minimum speed of the processor Unit: MHz
InstructionSet	String	Yes		read-write	The instruction set of the processor Possible Values: x86: x86 32-bit. x86-64: x86 64-bit. ARM-A32: ARM 32-bit. ARM-A64: ARM 64-bit.
Model	String	Yes		read-write	The exact model of the processor
ProcessorArchitecture	String	Yes		read-write	The architecture of the processor Possible Values: x86: x86 or x86-64. ARM: ARM.
ProcessorType	String	Yes		read-write	The type of processor Possible Values: CPU: A Central Processing Unit. GPU: A Graphics Processing Unit. FPGA: A Field Programmable Gate Array.
Resource {	Reference(Processor)	Yes		read-write	The URI of a Processor resource. If this property is set, all other processor requirements are ignored.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
TotalCores	Int32	Yes		read-write	The minimum number of cores of the processor
} ]
Resource {	Reference(ComputerSystem)	Yes		read-write	The URI of a ComputerSystem resource. If this property is set, all other system requirements are ignored.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
TotalProcessorCoreCount	Int64	Yes		read-write	The total amount of processor cores for this system.
} ]

Request

POST /redfish/v1/Chassis/Chassis1/ComposedNodes/Actions/ComposedNodeCollection.Allocate
Content-Type: application/json
{
    "ComposedNodes": [{
        "Resource": {
            "@odata.id": "/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1"
        }
    }]
    "Description": "String",
    "Devices": [{
        "Baseboard": {
            "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1"
        },
        "HSLLInterface": {
            "AvailableWidth": 0,
            "MaxSpeedGbps": 0,
            "MaxWidth": 0,
            "Resource": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/Ports/Port1/HSLLInterface"
            }
        }
        "PCIeFunctions": [{
            "ClassCode": "String",
            "DeviceClass": "UnclassifiedDevice",
            "DeviceId": "String",
            "FunctionType": "Physical",
            "RevisionId": "String",
            "SubsystemId": "String",
            "SubsystemVendorId": "String",
            "VendorId": "String"
        }]
        "Resource": {
            "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/PCIeDevices/PCIeDevice1"
        },
        "SerialNumber": "String",
        "Type": "SingleFunction"
    }]
    "Name": "String",
    "Ports": [{
        "DeviceIndex": 0,
        "SystemIndex": 0
    }]
    "Systems": [{
        "Baseboard": {
            "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1"
        },
        "EthernetInterfaces": [{
            "Resource": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1/EthernetInterfaces/EthernetInterface1"
            },
            "SpeedMbps": 0,
            "VLANs": [{
                "Tagged": false,
                "VLANId": 1
            }]
        }]
        "HSLLInterface": {
            "AvailableWidth": 0,
            "MaxSpeedGbps": 0,
            "MaxWidth": 0,
            "Resource": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/Ports/Port1/HSLLInterface"
            }
        }
        "Processors": [{
            "AchievableSpeedMHz": 0,
            "InstructionSet": "x86",
            "Model": "String",
            "ProcessorArchitecture": "x86",
            "ProcessorType": "CPU",
            "Resource": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1/Processors/Processor1"
            },
            "TotalCores": 0
        }]
        "Resource": {
            "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems/ComputerSystem1"
        },
        "TotalProcessorCoreCount": 0
    }]
}

Response

HTTP/1.1 201
Location: http://{IP}:{PORT}/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1

Operations

GET

Request

GET /redfish/v1/ComposedNodes
Content-Type: application/json

Response

{
    "@odata.context": "uri",
    "@odata.id": "/redfish/v1/ComposedNodes",
    "@odata.type": "String",
    "Actions": {
        "#ComposedNodeCollection.Allocate": {
            "target": "/redfish/v1/Chassis/Chassis1/ComposedNodes/Actions/ComposedNodeCollection.Allocate",
            "title": "String"
        }
        "Oem": { }
    }
    "Description": "String",
    "Members": [{
        "@odata.id": "/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1"
    }],
    "Members@odata.count": 1,
    "Name": "String",
    "Oem": { }
}

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

ComposedNodeCollection

Schema Definition

Properties

Actions

#ComposedNodeCollection.Allocate

Parameters

Request

Response

Operations

GET

Request

Response

POST

PATCH

DELETE