Skip to main content

PATCH – Telemetry Service

Request​

PATCH https://{{ip}}/redfish/v1/TelemetryService
Content-Type: application/json

Request body​

Please refer to the properties that are patchable in Telemetry Service Properties for which read-only is False that can be sent as Request body in json format.

Request example​

Editing ServiceEnabled

{
    "ServiceEnabled": < Either true or false >
}

Editing SupportedCollectionFunctions

{
    "SupportedCollectionFunctions": [
        "Maximum",
        "Minimum",
        "Summation"
    ]
}

Behavior​

  1. If the value of the ServiceEnabled attribute available under the Telemetry Service Resource (i.e./redfish/v1/TelemetryService) is true, it signifies that the Telemetry Service is in Enabled state and the PATCH Request will succeed.

  2. If it is false, it signifies that the Telemetry Service is in Disabled state and it will fail with an error message stating, the operation failed because this service is disabled can no longer take incoming requests.

  3. Two attributes are patchable ServiceEnabled and SupportedCollectionFunctions, out of which the above mentioned scenario applies to SupportedCollectionFunctions attribute alone.

Response​

The response status is success with status code as 204 and no body.

For Error Responses, please refer to Error Response.