ComposedNode

Schema Definition

This is the schema definition for the ComposedNode resource.

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 available actions for this resource.
#ComposedNode.Assemble {	Object			read-write	This action is used to assemble a composed node with concrete connections.
target	String			read-write	Link to invoke action Format: uri
title	String			read-write	Friendly action name
}
#ComposedNode.ExposePort {	Object			read-write	This action is used to expose a port of a composed node.
target	String			read-write	Link to invoke action Format: uri
title	String			read-write	Friendly action name
}
#ComposedNode.Reject {	Object			read-write	This action is used to reject an allocated but not assembled composed node.
target	String			read-write	Link to invoke action Format: uri
title	String			read-write	Friendly action name
}
#ComposedNode.RemovePort {	Object			read-write	This action is used to expose a port of a composed node.
target	String			read-write	Link to invoke action Format: uri
title	String			read-write	Friendly action name
}
#ComposedNode.Reset {	Object			read-write	This action is used to reset all systems within this ComposedNode.
target	String			read-write	Link to invoke action Format: uri
title	String			read-write	Friendly action name
}
Oem { }	Object			read-write
}
ActiveConnectionSet	String	Yes		read-write	The name of the active ConnectionSet within the specified ConnectionSets.
ComposedIn {	Reference(ComposedNode)	Yes		read-only	This is a link to the ComposedNode, this ComposedNode is composed in.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
ComposedNodeState	String	Yes		read-only	Possible Values: Allocating: Allocating resources for node is in progress. Next state can be Allocated or Failed. Allocated: Node resources has been allocated, but assembly not started yet. After ComposedNode.Assemble action state will progress to Assembling. Assembling: Assembly process initiated, but not finished yet. When assembly is done it will change into Assembled. Failed: Allocation or assembly process failed, or in runtime one of composing components was removed or transitioned in error state. Assembled: Node successfully assembled.
ConnectionSets [ {	Array[Reference(HSLLConnectionSet)]			read-only	This is a link to a collection of HSLLConnectionSets that are selectable for this composition.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
} ]
ConnectionSets@odata.count	Int32			read-only	The number of items in a collection.
ContainedResources [ {	Array[Reference]			read-only	An array of references to resources this ComposedNode consists of. This can either be a ComputerSystem, a PCIeDevice or a Port (of a PCIeSwitch or a ComposedNode).
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
} ]
ContainedResources@odata.count	Int32			read-only	The number of items in a collection.
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.
Links {	Object			read-only	The links object contains the links to other resources that are related to this resource.
Oem { }	Object			read-write	Oem extension object.
}
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.
ProvidedPorts {	Reference(PortCollection)			read-only	This is a link to a collection of Ports that are provided by this composition.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
Status {	Object	Yes		read-write	This type describes the status and health of a resource and its children.
Health	String	Yes		read-only	This represents the health state of this resource in the absence of its dependent resources. Possible Values: OK: Normal. Warning: A condition exists that requires attention. Critical: A critical condition exists that requires immediate attention.
HealthRollup	String	Yes		read-only	This represents the overall health state from the view of this resource. Possible Values: OK: Normal. Warning: A condition exists that requires attention. Critical: A critical condition exists that requires immediate attention.
Oem { }	Object			read-write	Oem extension object.
State	String	Yes		read-only	This indicates the known state of the resource, such as if it is enabled. Possible Values: Enabled: This function or resource has been enabled. Disabled: This function or resource has been disabled. StandbyOffline: This function or resource is enabled, but awaiting an external action to activate it. StandbySpare: This function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it. InTest: This function or resource is undergoing testing. Starting: This function or resource is starting. Absent: This function or resource is not present or not detected. UnavailableOffline: This function or resource is present but cannot be used. Deferring: The element will not process any commands but will queue new requests. Quiesced: The element is enabled but only processes a restricted set of commands. Updating: The element is updating and may be unavailable or degraded.
}

Actions

#ComposedNode.Assemble

Parameters

Property	Type	Nullable	Required	Permission	Description
ActiveConnectionSet	String	Yes		read-write	The name of the ConnectionSet within the specified ConnectionSets, that will be activated first. May only be null, if only one set is specified.
ConnectionSets [ {	Array[Object]		POST	read-write
Connections [ {	Array[Object]			read-write	The connections of the ConnectionSet
EndpointA {	Reference(HSLLInterface)			read-write	The first endpoint of this connection
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
EndpointB {	Reference(HSLLInterface)			read-write	The second endpoint of this connection.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
PCIeFunctions [ {	Array[Object]			read-write	The set of PCIe function requirements the PCIeSwitch port shall be assigned. This property is only usable, if one of the endpoints is a port of a PCIe switch. The requirements have to match the functions provided by the switch.
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}$
} ]
Width	Int64			read-write	Connection width of the HSLLConnection specified in number of lanes Minimum: 0
} ]
Description	String	Yes		read-write	The description of the ConnectionSet
Name	String			read-write	The name of the ConnectionSet. It has to be unique within the ComposedNode.
} ]
ResetNetworkSettings	Boolean		POST	read-write	If set to true, all network settings within the composed node are reset.

Request

POST /redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1/Actions/ComposedNode.Assemble
Content-Type: application/json
{
    "ActiveConnectionSet": "String",
    "ConnectionSets": [{
        "Connections": [{
            "EndpointA": {
                "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/Ports/Port1/HSLLInterface"
            },
            "EndpointB": {
                "@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"
            }]
            "Width": 0
        }]
        "Description": "String",
        "Name": "String"
    }]
    "ResetNetworkSettings": false
}

Response

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

#ComposedNode.ExposePort

Parameters

Property	Type	Nullable	Required	Permission	Description
Description	String	Yes		read-write	The description of the Port
HSLLInterface {	Reference(HSLLInterface)		POST	read-write	The URI of a HSLLInterface resource, on which the Port is exposed.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
Name	String		POST	read-write	The name of the Port
PCIeFunctions [ {	Array[Object]	Yes		read-write	An array of PCIeFunctions, provided by this port.
ClassCode	String	Yes		read-write	The Class Code of this PCIe function. Pattern: ^0[xX](([a-fA-F]\|[0-9]){2}){3}$
Description	String	Yes		read-write	The description of the PCIeFunction
DeviceClass	String			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}$
FunctionId	Int64	Yes		read-write	The the PCIe Function identifier.
FunctionType	String			read-write	The type of the PCIe Function. Possible Values: Physical: A physical PCie function. Virtual: A virtual PCIe function.
Name	String	Yes		read-write	The name of the PCIeFunction
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}$
} ]
Width	Int64	Yes		read-write	The number of (usable) lanes that this port contains. All available lanes of the HSLLInterface will be used, if set to null.

Request

POST /redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1/Actions/ComposedNode.ExposePort
Content-Type: application/json
{
    "Description": "String",
    "HSLLInterface": {
        "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/Ports/Port1/HSLLInterface"
    },
    "Name": "String",
    "PCIeFunctions": [{
        "ClassCode": "String",
        "Description": "String",
        "DeviceClass": "UnclassifiedDevice",
        "DeviceId": "String",
        "FunctionId": 0,
        "FunctionType": "Physical",
        "Name": "String",
        "RevisionId": "String",
        "SubsystemId": "String",
        "SubsystemVendorId": "String",
        "VendorId": "String"
    }]
    "Width": 0
}

Response

HTTP/1.1 201
Location: http://{IP}:{PORT}/redfish/v1/Chassis/Chassis1/Switch1/Ports/Port1

#ComposedNode.Reject

Parameters

This action has no parameters.

Request

POST /redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1/Actions/ComposedNode.Reject
Content-Type: application/json
{
}

Response

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

#ComposedNode.RemovePort

Parameters

Property	Type	Required	Permission	Description
Port {	Reference(Port)	POST	read-write	The URI of the Port resource to remove.
@odata.id	String		read-only	The unique identifier for a resource. Format: uri
}

Request

POST /redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1/Actions/ComposedNode.RemovePort
Content-Type: application/json
{
    "Port": {
        "@odata.id": "/redfish/v1/Chassis/Chassis1/Switch1/Ports/Port1"
    }
}

Response

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

#ComposedNode.Reset

Parameters

Property	Type	Nullable	Required	Permission	Description
ResetType	String	Yes		read-write	The type of reset to be performed. Possible Values: On: Turn the unit on. ForceOff: Turn the unit off immediately (non-graceful shutdown). GracefulShutdown: Perform a graceful shutdown and power off. GracefulRestart: Perform a graceful shutdown followed by a restart of the system. ForceRestart: Perform an immediate (non-graceful) shutdown, followed by a restart. ForceOn: Turn the unit on immediately. PushPowerButton: Simulate the pressing of the physical power button on this unit.

Request

POST /redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1/Actions/ComposedNode.Reset
Content-Type: application/json
{
"ResetType": "On"
}

Response

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

Operations

GET

Request

GET /redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1
Content-Type: application/json

Response

{
    "@odata.context": "uri",
    "@odata.id": "/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1",
    "@odata.type": "String",
    "Actions": {
        "#ComposedNode.Assemble": {
            "target": "/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1/Actions/ComposedNode.Assemble",
            "title": "String"
        }
        "#ComposedNode.ExposePort": {
            "target": "/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1/Actions/ComposedNode.ExposePort",
            "title": "String"
        }
        "#ComposedNode.Reject": {
            "target": "/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1/Actions/ComposedNode.Reject",
            "title": "String"
        }
        "#ComposedNode.RemovePort": {
            "target": "/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1/Actions/ComposedNode.RemovePort",
            "title": "String"
        }
        "#ComposedNode.Reset": {
            "target": "/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1/Actions/ComposedNode.Reset",
            "ResetType@Redfish.AllowableValues": ["On", "ForceOff", "GracefulShutdown", "GracefulRestart", "ForceRestart", "ForceOn", "PushPowerButton"],
            "title": "String"
        }
        "Oem": { }
    }
    "ActiveConnectionSet": "String",
    "ComposedIn": {
        "@odata.id": "/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1"
    },
    "ComposedNodeState": "Allocating",
    "ConnectionSets": [{
        "@odata.id": "/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1/HSLLConnectionSet1"
    }],
    "ConnectionSets@odata.count": 1,
    "ContainedResources": [{
        "@odata.id": "uri"
    }],
    "ContainedResources@odata.count": 1,
    "Description": "String",
    "Id": "String",
    "Links": {
        "Oem": { }
    }
    "Name": "String",
    "Oem": { },
    "ProvidedPorts": {
        "@odata.id": "/redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1/ProvidedPorts"
    },
    "Status": {
        "Health": "OK",
        "HealthRollup": "OK",
        "Oem": { },
        "State": "Enabled"
    }
}

POST

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

HTTP/1.1 405 Method Not Allowed

PATCH

Request

PATCH /redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1
Content-Type: application/json
{
"ActiveConnectionSet": "String"
}

Response

HTTP/1.1 204 No Content

DELETE

Request

DELETE /redfish/v1/Chassis/Chassis1/ComposedNodes/ComposedNode1

Response

HTTP/1.1 204 No Content

Schema Navigation

ComposedNode

Schema Definition

Properties

Actions

#ComposedNode.Assemble

Parameters

Request

Response

#ComposedNode.ExposePort

Parameters

Request

Response

#ComposedNode.Reject

Parameters

Request

Response

#ComposedNode.RemovePort

Parameters

Request

Response

#ComposedNode.Reset

Parameters

Request

Response

Operations

GET

Request

Response

POST

PATCH

Request

Response

DELETE

Request

Response