Baseboard

Schema Definition

This is the schema definition for the Baseboard 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.
#Baseboard.Reset {	Object			read-write	This action is used to reset all systems hosted on this Baseboard.
target	String			read-write	Link to invoke action Format: uri
title	String			read-write	Friendly action name
}
Oem { }	Object			read-write
}
BaseboardType	String	Yes		read-only	The type of the Baseboard. Possible Values: COMExpress: This Baseboard can host COM Express nodes. Apalis: This Baseboard can host Apalis nodes. Jetson: This Baseboard can host Jetson nodes.
BladeSlot	Int64			read-only	The one-based position of the blade slot containing this Baseboard within the Chassis. Minimum: 1
Chassis {	Reference(Chassis)			read-only	The Chassis hosting this Baseboard
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
ComputerSystems {	Reference(ComputerSystemCollection)			read-only	This is a link to a collection of ComputerSystems hosted on this Baseboard.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
Description	String	Yes		read-only	Provides a description of this resource and is used for commonality in the schema definitions.
ExpansionBoardInserted	Boolean			read-only	Indicates, if an expansion board is inserted into this baseboard.
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.
PCIeDevices {	Reference(PCIeDeviceCollection)			read-only	This is a link to a collection of PCIeDevices hosted on this Baseboard.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}
Power {	Reference(Power)			read-only	A reference to the power properties (power supplies, power policies, sensors) of this baseboard.
@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.
}
Thermal {	Reference(Thermal)			read-only	A reference to the thermal properties (fans, cooling, sensors) of this baseboard.
@odata.id	String			read-only	The unique identifier for a resource. Format: uri
}

Actions

#Baseboard.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/Baseboards/Baseboard1/Actions/Baseboard.Reset
Content-Type: application/json
{
"ResetType": "On"
}

Response

HTTP/1.1 204
Location: http://{IP}:{PORT}/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1

Operations

GET

Request

GET /redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1
Content-Type: application/json

Response

{
    "@odata.context": "uri",
    "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1",
    "@odata.type": "String",
    "Actions": {
        "#Baseboard.Reset": {
            "target": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/Actions/Baseboard.Reset",
            "ResetType@Redfish.AllowableValues": ["On", "ForceOff", "GracefulShutdown", "GracefulRestart", "ForceRestart", "ForceOn", "PushPowerButton"],
            "title": "String"
        }
        "Oem": { }
    }
    "BaseboardType": "COMExpress",
    "BladeSlot": 1,
    "Chassis": {
        "@odata.id": "/redfish/v1/Chassis/Chassis1"
    },
    "ComputerSystems": {
        "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/ComputerSystems"
    },
    "Description": "String",
    "ExpansionBoardInserted": false,
    "Id": "String",
    "Links": {
        "Oem": { }
    }
    "Name": "String",
    "Oem": { },
    "PCIeDevices": {
        "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/PCIeDevices"
    },
    "Power": {
        "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/Power"
    },
    "Status": {
        "Health": "OK",
        "HealthRollup": "OK",
        "Oem": { },
        "State": "Enabled"
    }
    "Thermal": {
        "@odata.id": "/redfish/v1/Chassis/Chassis1/Baseboards/Baseboard1/Thermal"
    }
}

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

Baseboard

Schema Definition

Properties

Actions

#Baseboard.Reset

Parameters

Request

Response

Operations

GET

Request

Response

POST

PATCH

DELETE