Back to Redis

Sch

content/operate/rs/clusters/configure/sch.md

latest1.1 KB
Original Source

Smart client handoffs (SCH) is a feature of Redis Cloud and Redis Software servers that lets them actively notify clients about planned server maintenance shortly before it happens. This lets a client reconnect or otherwise respond gracefully without significant interruptions in service. See [Smart client handoffs]({{< relref "/develop/clients/sch" >}}) for more information about SCH.

{{< note >}}SCH is supported only for [rolling upgrades]({{< relref "/operate/rs/installing-upgrading/upgrading/upgrade-cluster#rolling-upgrade" >}}). {{< /note >}}

To enable SCH on a Redis Software server, you must use the [/v1/cluster]({{< relref "/operate/rs/references/rest-api/requests/cluster#put-cluster" >}}) REST API request to set the client_maint_notifications option to true. The example below shows how to do this using the curl command line utility:

bash
curl -k -X PUT -H "accept: application/json" \
    -H "content-type: application/json" \
    -u "<username>:<password>" \
    -d '{ "client_maint_notifications": true }' \
    https://<host>:<port>/v1/cluster