This page is huge and keeps growing. So:
* Move additional topics to sub-documents.
* Move ESP creation to the install guide (it's not even
  Redfish-specific).
* Create a generic firmware updates document.

Provide a feature listing at the top for easier navigation.

Change-Id: Ic58c139da5e1e60f5ce4d2cec18972ebee9e2485

2024-06-13 12:37:11 +02:00

2.3 KiB

Raw Blame History

Node Vendor Passthru Methods

Method	Description
`create_subscription`	Create a new subscription on the Node
`delete_subscription`	Delete a subscription of a Node
`get_all_subscriptions`	List all subscriptions of a Node
`get_subscription`	Show a single subscription of a Node
`eject_vmedia`	Eject attached virtual media from a Node

Create Subscription

Request
Name	In	Type	Description
Destination	body	string	The URI of the destination Event Service
EventTypes (optional)	body	array	List of types of events that shall be sent to the destination
Context (optional)	body	string	A client-supplied string that is stored with the event destination subscription
Protocol (optional)	body	string	The protocol type that the event will use for sending the event to the destination

Example JSON to use in create_subscription:

{
    "Destination": "https://someurl",
    "EventTypes": ["Alert"],
    "Context": "MyProtocol",
    "args": "Redfish"
}

Delete Subscription

Request
Name	In	Type	Description
id	body	string	The Id of the subscription generated by the BMC

Example JSON to use in delete_subscription:

{
    "id": "<id of the subscription generated by the BMC>"
}

Get Subscription

Request
Name	In	Type	Description
id	body	string	The Id of the subscription generated by the BMC

Example JSON to use in get_subscription:

{
    "id": "<id of the subscription generated by the BMC>"
}

Get All Subscriptions

The get_all_subscriptions doesn't require any parameters.

Eject Virtual Media

Request
Name	In	Type	Description
boot_device (optional)	body	string	Type of the device to eject (all devices by default)

2.3 KiB Raw Blame History