ComposedNodeCollection

Schema Definition

Properties

PropertyTypeNullableRequiredPermissionDescription
@odata.contextStringread-onlyThe OData description of a payload.
Format: uri
@odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
@odata.typeStringread-onlyThe type of a resource.
Actions {Objectread-writeThe available actions for this resource.
    #ComposedNodeCollection.Allocate {Objectread-writeThis action is used to allocate a composed node.
        targetStringread-writeLink to invoke action
Format: uri
        titleStringread-writeFriendly action name
    }
    Oem { }Objectread-write
}
DescriptionStringYesread-onlyProvides a description of this resource and is used for commonality in the schema definitions.
Members [ {Array[Reference(ComposedNode)]read-onlyContains the members of this collection.
    @odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
} ]
Members@odata.countInt32read-onlyThe number of items in a collection.
NameStringread-onlyThe name of the resource or array element.
Oem { }Objectread-writeThis is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.

Actions

#ComposedNodeCollection.Allocate

Parameters

PropertyTypeNullableRequiredPermissionDescription
ComposedNodes [ {Array[Object]Yesread-writeThe requirements for a ComposedNode
    Resource {Reference(ComposedNode)Yesread-writeThe URI of a ComposedNode resource. If this property is set, all other ComposedNode requirements are ignored.
        @odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
    }
} ]
DescriptionStringPOSTread-writeThe description of the ComposedNode
Devices [ {Array[Object]Yesread-writeThe requirements for a PCIe device
    Baseboard {Reference(Baseboard)Yesread-writeThe Baseboard where applicable resources are located
        @odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
    }
    HSLLInterface {ObjectYesread-writeThe requirements for a HSLL interface
        AvailableWidthInt32Yesread-writeThe number of unused lanes of the HSLL interface
        MaxSpeedGbpsInt32Yesread-writeThe minimal value of the maximum speed of the HSLL interface
Unit: GBytes/s
        MaxWidthInt32Yesread-writeThe minimal value of the maximum lanes of the HSLL interface
        Resource {Reference(HSLLInterface)Yesread-writeThe URI of a HSLLInterface resource. If this property is set, all other HSLL interface requirements are ignored.
            @odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
        }
    }
    PCIeFunctions [ {Array[Object]read-writeThe minimal required set of PCIe functions exposed by the PCIe device
        ClassCodeStringYesread-writeThe Class Code of this PCIe function.
Pattern: ^0[xX](([a-fA-F]|[0-9]){2}){3}$
        DeviceClassStringYesread-writeThe 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.
        DeviceIdStringYesread-writeThe Device ID of this PCIe function.
Pattern: ^0[xX](([a-fA-F]|[0-9]){2}){2}$
        FunctionTypeStringYesread-writeThe type of the PCIe Function
Possible Values:
  • Physical: A physical PCie function.
  • Virtual: A virtual PCIe function.
        RevisionIdStringYesread-writeThe Revision ID of this PCIe function.
Pattern: ^0[xX](([a-fA-F]|[0-9]){2}){1}$
        SubsystemIdStringYesread-writeThe Subsystem ID of this PCIe function.
Pattern: ^0[xX](([a-fA-F]|[0-9]){2}){2}$
        SubsystemVendorIdStringYesread-writeThe Subsystem Vendor ID of this PCIe function.
Pattern: ^0[xX](([a-fA-F]|[0-9]){2}){2}$
        VendorIdStringYesread-writeThe Vendor ID of this PCIe function.
Pattern: ^0[xX](([a-fA-F]|[0-9]){2}){2}$
    } ]
    Resource {Reference(PCIeDevice)Yesread-writeThe URI of a PCIeDevice resource. If this property is set, all other PCIe device requirements are ignored.
        @odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
    }
    SerialNumberStringYesread-writeThe exact serial number of the PCIe device
    TypeStringYesread-writeThe 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.
} ]
NameStringPOSTread-writeThe name of the ComposedNode
Ports [ {Array[Object]Yesread-writeThe requirements for a port of a PCIeSwitch or a ComposedNode
    DeviceIndexInt32Yesread-writeThe zero-based index of the device in the devices array, whose PCIe Port is required. SystemIndex and DeviceIndex cannot be used together.
Minimum: 0
    SystemIndexInt32Yesread-writeThe 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]Yesread-writeThe requirements for a system
    Baseboard {Reference(Baseboard)Yesread-writeThe Baseboard where applicable resources are located
        @odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
    }
    EthernetInterfaces [ {Array[Object]read-writeThe requirements for one or more ethernet interfaces
        Resource {Reference(EthernetInterface)Yesread-writeThe URI of a EthernetInterface resource. If this property is set, all other ethernet interface requirements are ignored.
            @odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
        }
        SpeedMbpsInt32Yesread-writeThe minimum speed of the ethernet interface
Unit: Mbit/s
        VLANs [ {Array[Object]read-writeThe VLANs of the ethernet interface
            TaggedBooleanYesread-writeThe tagged value of the VLAN
            VLANIdInt64Yesread-writeThe ID of the VLAN
Minimum: 1
Maximum: 4080
        } ]
    } ]
    HSLLInterface {ObjectYesread-writeThe requirements for a HSLL interface
        AvailableWidthInt32Yesread-writeThe number of unused lanes of the HSLL interface
        MaxSpeedGbpsInt32Yesread-writeThe minimal value of the maximum speed of the HSLL interface
Unit: GBytes/s
        MaxWidthInt32Yesread-writeThe minimal value of the maximum lanes of the HSLL interface
        Resource {Reference(HSLLInterface)Yesread-writeThe URI of a HSLLInterface resource. If this property is set, all other HSLL interface requirements are ignored.
            @odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
        }
    }
    Processors [ {Array[Object]read-writeThe requirements for one or more processors
        AchievableSpeedMHzInt32Yesread-writeThe minimum speed of the processor
Unit: MHz
        InstructionSetStringYesread-writeThe 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.
        ModelStringYesread-writeThe exact model of the processor
        ProcessorArchitectureStringYesread-writeThe architecture of the processor
Possible Values:
  • x86: x86 or x86-64.
  • ARM: ARM.
        ProcessorTypeStringYesread-writeThe type of processor
Possible Values:
  • CPU: A Central Processing Unit.
  • GPU: A Graphics Processing Unit.
  • FPGA: A Field Programmable Gate Array.
        Resource {Reference(Processor)Yesread-writeThe URI of a Processor resource. If this property is set, all other processor requirements are ignored.
            @odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
        }
        TotalCoresInt32Yesread-writeThe minimum number of cores of the processor
    } ]
    Resource {Reference(ComputerSystem)Yesread-writeThe URI of a ComputerSystem resource. If this property is set, all other system requirements are ignored.
        @odata.idStringread-onlyThe unique identifier for a resource.
Format: uri
    }
    TotalProcessorCoreCountInt64Yesread-writeThe 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