close-servers - Amazon DCV Session Manager
SynopsisOptionsExample
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

close-servers

Closes one or more Amazon DCV servers. When you close a Amazon DCV server, you make it unavailable for Amazon DCV session placement. You can't create Amazon DCV sessions on closed servers. Closing a server ensures that no sessions are running on it and that users can't create new sessions on it.

Synopsis

close-servers
--server-ids <value>
[--force]

Options

--server-ids

The comma-separated list of IDs of the Amazon DCV servers to close.

Type: String

Required: Yes

--force

Operation that forces the server to close. By default, this is disabled.

Type: Boolean

Required: No

Example

dcvsm close-servers --server-ids "server123,server456"