Skip to main content

PATCH– Update event service properties

Use the PATCH method to update the event service resource properties.

Request URL​

PATCH https://<BMC_IPADDR>/redfish/v1/EventService

Request body​

FieldTypeDescription

SMTP

Object

Expanded

 

Authentication

String

The authentication method for the SMTP server.

 

Port

Number

The destination SMTP port.

 

Password

String

The password for authentication with the SMTP server. The value is `null` in responses.

 

Username

String

The username for authentication with the SMTP server.

 

ServerAddress

String

The address of the SMTP server.

 

FromAddress

String

The 'from' email address of the outgoing email.

Response​

The response returns same content as GET operation with updated properties.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example is PATCH body

{
    "SMTP": {
        "Password": "PASSW0RD",
        "Username": "USERID",
        "Port": 25,
        "ServerAddress": "0.0.0.0",
        "Authentication": "None",
        "FromAddress": "userid@lenovo.com"
    }
}

After the PATCH operation runs successfully, querying the update service resource returns below example JSON response:

{
    "DeliveryRetryIntervalSeconds": 60,
    "DeliveryRetryAttempts": 3,
    "ServerSentEventUri": "/redfish/v1/EventService/ServerSentEvent",
    "IncludeOriginOfConditionSupported": true,
    "RegistryPrefixes": [
        "Base",
        "EventRegistry",
        "ExtendedError",
        "LenovoExtendedWarning",
        "LenovoFirmwareUpdateRegistry",
        "ResourceEvent",
        "TaskEvent"
    ],
    "SubordinateResourcesSupported": true,
    "EventFormatTypes": [
        "Event",
        "MetricReport"
    ],
    "SMTP": {
        "Password": null,
        "ServiceEnabled": true,
        "Authentication": "None",
        "Username": "USERID",
        "Port": 25,
        "ServerAddress": "0.0.0.0",
        "Authentication@Redfish.AllowableValues": [
            "None",
            "Login",
            "CRAM_MD5"
        ],
        "ConnectionProtocol": "AutoDetect",
        "FromAddress": "userid@lenovo.com",
        "ConnectionProtocol@Redfish.AllowableValues": [
            "AutoDetect"
        ]
    },
    "@odata.etag": "\"b84bdec2d6f72e14f9c04\"",
    "ServiceEnabled": true,
    "Name": "Event Service",
    "Description": "This resource represents an event service for a Redfish implementation.",
    "Id": "EventService",
    "Actions": {
        "#EventService.SubmitTestEvent": {
            "title": "SubmitTestEvent",
            "target": "/redfish/v1/EventService/Actions/EventService.SubmitTestEvent"
        }
    },
    "SSEFilterPropertiesSupported": {
        "RegistryPrefix": true,
        "OriginResource": true,
        "ResourceType": true,
        "MessageId": true,
        "EventFormatType": true,
        "SubordinateResources": true,
        "MetricReportDefinition": true
    },
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    },
    "@odata.id": "/redfish/v1/EventService",
    "@odata.type": "#EventService.v1_6_0.EventService",
    "ResourceTypes": [
        "LogService"
    ],
    "Subscriptions": {
        "@odata.id": "/redfish/v1/EventService/Subscriptions"
    }
}