Skip to content

Table of Contents

Draining server sessions

When administrators need to perform maintenance on on-premises servers, it is important to close out server traffic. The drain mode feature allows a production server to stop creating new sessions while allowing current sessions to continue running until the users close them out.

Drain mode is currently available for the following:

  • Multi-session servers
  • Non-persistent VMs in single-session pools

Use the information in this guide to learn how to:

Immediately drain a server

To immediately put servers or VM pools into drain mode, follow the steps below.

  1. Locate a multi-session server or single-session VM pool to put into drain mode.
    1. Multi-session server
      1. From the “Multi-Session” tab, click/tap on the Manage Server menu button for a production server.
      2. Click/tap on Drain. The system will display a confirmation dialog.
        confirmation dialog for draining the server
      3. Click/tap Drain Server to immediately start drain mode. The system will display a message that the drain will begin in a few minutes.
        confirmation message that server will be in maintenance mode in 5 minutes

        1. If another server in the same pool is accepting connections, then new sessions will be routed to that server.
        2. If there are no other servers in the same pool that are accepting connections, then end users trying to connect will be shown a message saying that no servers are currently available.
        3. Administrators will still be able to connect to the server from within the Servers page.
    2. Single-session VM pool
      1. From the “Single-Session” tab, click/tap on the Manage Pool menu button.
      2. Click/tap on Drain. The system will display a confirmation dialog.
        confirmation dialog for draining a VM pool
      3. Click/tap Drain Pool to immediately start drain mode. The system will display a message that the drain will begin in a few minutes. (It will look similar to the message above for a server.) No new connections will be allowed, though administrators will still be able to connect to the pool’s VMs from within the Servers page.
  2. Once the last session has drained from the server or pool, the system will display a notification to administrators.

Schedule a server drain

COMING SOON

Take a server out of drain mode

To take a server or VM pool out of drain mode, follow the steps below.

  1. Locate a multi-session server or single-session VM pool that is currently in drain mode.
    1. Multi-session server
      1. From the “Multi-Session” tab, click/tap on Manage Server.
      2. Click/tap on Bring Online.
      3. The system will display a message stating that the pool will be brought back online in a minute. (It will look similar to the message below for a server pool.)
    2. Single-session VM pool
      1. From the “Single-Session” tab, click/tap on Manage Pool.
      2. Click/tap on Bring Online.
      3. The system will display a message stating that the pool will be brought back online in a minute.
        confirmation message stating that server pool will be back online in a minute
Live Demo