CloseServers
Closes one or more NICE DCV servers. When you close a NICE DCV server, you make it unavailable for NICE DCV session placement. You cannot create NICE DCV sessions on closed servers. Closing a server ensures that no sessions are running on it and that users cannot create new sessions on it.
Request parameters
ServerId
-
The ID of the server to close.
Type: String
Required: Yes
Force
-
Forces the close operation. If you specify
true
, the server is closed even if it has running sessions. The sessions continue to run.Type: Boolean
Required: No
Response parameters
RequestId
-
The unique ID of the request.
SuccessfulList
-
Information about the NICE DCV servers that were successfully closed. This data structure includes the following nested response parameter:
ServerId
-
The ID of the server that was successfully closed.
UnsuccessfulList
-
Information about the NICE DCV servers that could not be closed. This data structure includes the following nested response parameters:
CloseServerRequestData
-
Information about the original request that failed. This data structure includes the following nested response parameter:
ServerId
-
The ID of the NICE DCV server that could not be closed.
Force
-
The requested force parameter.
FailureCode
-
The code of the failure.
FailureReason
-
The reason for the failure.