Server Evacuate

Moves every stream and consumer off one server, so it can be taken out of the cluster. Each asset keeps its replica count and the server picks the replacement peers. Replacement is best effort: an asset with no qualifying peer is moved off the server anyway and runs under-replicated until one becomes available. The evacuated server is excluded from placement for those assets so they are not handed straight back to it.

Subject

$JS.API.SERVER.EVACUATE

Only works from the system account.

Request

A request to the JetStream $JS.API.SERVER.EVACUATE API

peerstring

The Name of the server to evacuate from the meta group

peer_idstring

Peer ID of the peer to be evacuated. If specified this is used instead of the server name

Response

A response from the JetStream $JS.API.SERVER.EVACUATE API

One of the following:

Option 1 (object)

errorobjectrequired

Option 2 (object)

successbooleanrequired

If the server evacuation was successfully started

Default:false

typeconst: "io.nats.jetstream.api.v1.meta_server_evacuate_response"