DescribeServers
Describes one or more NICE DCV servers.
Request parameters
ServerIds
-
The IDs of the NICE DCV servers to describe. If no IDs are specified, all servers are returned in paginated output.
Type: Array of strings
Required: No
NextToken
-
The token to use to retrieve the next page of results.
Type: String
Required: No
MaxResults
-
The maximum number of results to be returned by the request in paginated output. When this parameter is used, the request returns only the specified number of results in a single page along with a
NextToken
response element. The remaining results of the initial request can be seen by sending another request with the returnedNextToken
value.Valid range: 1 - 1000
Default: 1000
Type: Integer
Required: No
Response parameters
RequestId
-
The unique ID of the request.
Servers
-
Information about the NICE DCV servers. This data structure includes the following nested response parameters:
Id
-
The unique ID of the NICE DCV server.
Ip
-
The IP address of the NICE DCV server.
Hostname
-
The hostname of the NICE DCV server.
Endpoints
-
Information about the NICE DCV server endpoints. This data structure includes the following nested response parameters:
IpAddress
-
The IP address of the server endpoint.
Port
-
The port of the server endpoint.
Protocol
-
The protocol used by the server endpoint. Possible values include:
-
HTTP
— The endpoint uses the WebSocket (TCP) protocol. -
QUIC
— The endpoint uses the QUIC (UDP) protocol.
-
WebUrlPath
-
The web URL path of the server endpoint. Available for the HTTP protocol only.
Version
-
The version of the NICE DCV server.
SessionManagerAgentVersion
-
The version Session Manager Agent running on the NICE DCV server.
Availability
-
The availability of the NICE DCV server. Possible values include:
-
AVAILABLE
— The server is available and ready for session placement. -
UNAVAILABLE
— The server is unavailable and can't accept session placement.
-
UnavailabilityReason
-
The reason for the NICE DCV server's unavailability. Possible values include:
-
SERVER_FULL
— The NICE DCV server has reached the maximum number of concurrent sessions that it can run. -
SERVER_CLOSED
— The NICE DCV server has been made unavailable using the CloseServer API. -
UNREACHABLE_AGENT
— The Session Manager Broker can't communicate with the Session Manager Agent on the NICE DCV server. -
UNHEALTHY_DCV_SERVER
— The Session Manager Agent can't communicate with the NICE DCV server. -
EXISTING_LOGGED_IN_USER
— (Windows NICE DCV servers only) A user is currently logged in to the NICE DCV server using RDP. -
UNKNOWN
— The Session Manager Broker is unable to determine the reason.
-
ConsoleSessionCount
-
The number of console sessions on the NICE DCV server.
VirtualSessionCount
-
The number of virtual sessions on the NICE DCV server.
Host
-
Information about the host server on which the NICE DCV server is running. This data structure includes the following nested response parameters:
Os
-
Information about host server's operating system. This data structure includes the following nested response parameters:
Family
-
The operating system family. Possible values include:
-
windows
— The host server is running a Windows operating system. -
linux
— The host server is running a Linux operating system.
-
Name
-
The name of the operating system.
Version
-
The version of the operating system.
KernelVersion
-
(Linux only) The kernel version of the operating system.
BuildNumber
-
(Windows only) The build number of the operating system.
Memory
-
Information about the host server's memory. This data structure includes the following nested response parameters:
TotalBytes
-
The total memory, in bytes, on the host server.
UsedBytes
-
The used memory, in bytes, on the host server.
Swap
-
Information about the host server's swap file. This data structure includes the following nested response parameters:
TotalBytes
-
The total swap file size, in bytes, on the host server.
UsedBytes
-
The used swap file size, in bytes, on the host server.
Aws
-
Only for NICE DCV servers running on an Amazon EC2 instance. Amazon-specific information. This data structure includes the following nested response parameters:
Region
-
The Amazon Region of the Amazon EC2 instance.
Ec2InstanceType
-
The type of Amazon EC2 instance.
Ec2InstanceId
-
The ID of the Amazon EC2 instance.
Ec2ImageId
-
The ID of the Amazon EC2 image.
CpuInfo
-
Information about the host server's CPUs. This data structure includes the following nested response parameters:
Vendor
-
The vendor of the host server's CPU.
ModelName
-
The model name of the host server's CPU.
Architecture
-
The architecture of the host server's CPU.
NumberOfCpus
-
The number of CPUs on the host server.
PhysicalCorePerCpu
-
The number of CPU cores per CPU.
CpuLoadAverage
-
Information about the host server's CPU load. This data structure includes the following nested response parameters:
OneMinute
-
The average CPU load over the last 1-minute period.
FiveMinutes
-
The average CPU load over the last 5-minute period.
FifteenMinutes
-
The average CPU load over the last 15-minute period.
Gpus
-
Information about the host server's GPUs. This data structure includes the following nested response parameters:
Vendor
-
The vendor of the host server's GPU.
ModelName
-
The model name of the host server's GPU.
LoggedInUsers
-
The users that are currently logged in to the host server. This data structure includes the following nested response parameter:
Username
-
The user name of the logged in user.
Tags
-
The tags assigned to the server. This data structure includes the following nested response parameters:
Key
-
The tag key.
Value
-
The tag value.