Get RDS Server

Get RDS Server

Required Privileges : (This server version allows only Administrators on Root access group to login. These privileges are NOT relevant currently but will be applicable in later server versions.)

At least one of the listed privileges is required -

Privileges Description
MACHINE_VIEW Caller should have permission to this privilege, on the associated access group of RDS Server's farm.
POOL_VIEW Caller should have permission to this privilege, on the associated access group of RDS Server's farm.
GLOBAL_CONFIG_VIEW Caller's permission of this privilege is sufficient to read RDS Servers.
Request
URI
GET
https://{api_host}//localhost/rest/inventory/v1/rds-servers/{id}
COPY
Path Parameters
string
id
Required

RDS Server ID

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RDSServerInfo of type(s) */* 
{
    "access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
    "agent_build_number": 22673015,
    "agent_version": 7.12,
    "base_vm_id": "vm-23",
    "base_vm_snapshot_id": "snapshot-2",
    "description": "New RDS Server.",
    "dns_name": "machine1.example.com",
    "enabled": true,
    "farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
    "id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
    "image_management_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
    "image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
    "load_index": 60,
    "load_preference": "NORMAL",
    "logoff_policy": "FORCE_LOGOFF",
    "max_sessions_count": 123,
    "max_sessions_count_configured": 123,
    "max_sessions_type": "LIMITED",
    "max_sessions_type_configured": "LIMITED",
    "message_security_enhanced_mode_supported": true,
    "message_security_mode": "MIXED",
    "name": "server1",
    "operating_system": "WINDOWS_SERVER_2012",
    "operation": "REFRESH",
    "operation_state": "AVAILABLE",
    "pending_base_vm_id": "vm-8",
    "pending_base_vm_snapshot_id": "snapshot-7",
    "pending_image_management_stream_id": "ec88b3a5-e7d0-4ad6-a1e3-37168dd1fa25",
    "pending_image_management_tag_id": "c9896e51-48a2-4d82-ae9e-a0246981b47d",
    "remote_experience_agent_build_number": 32573985,
    "remote_experience_agent_version": 7.12,
    "session_count": 35,
    "state": "AVAILABLE"
}
string
access_group_id
Optional

The id of the Access Group that the RDS Server belongs to.
Supported Filters : 'Equals'.

string
agent_build_number
Optional

The Horizon Agent build number.
Supported Filters : 'Equals'.

string
agent_version
Optional

The Horizon Agent version.
Supported Filters : 'Equals'.

string
base_vm_id
Optional

The base vm id.
Supported Filters : 'Equals'.

string
base_vm_snapshot_id
Optional

The base vm snapshot id.
Supported Filters : 'Equals'.

string
description
Optional

Description of the RDS Server.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'.

string
dns_name
Optional

DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'.

boolean
enabled
Optional

Indicates if RDS server is enabled.
Supported Filters : 'Equals'.

string
farm_id
Optional

The id of the Farm that the RDS Server belongs to.
Supported Filters : 'Equals'.

string
id
Optional

Unique ID representing the RDS Server.
Supported Filters : 'Equals'.

string
image_management_stream_id
Optional

The id of the image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.
Supported Filters : 'Equals'.

string
image_management_tag_id
Optional

The id of the image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.
Supported Filters : 'Equals'.

integer As int32 As int32
load_index
Optional

This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.

string
load_preference
Optional

Based on the current load of this RDS Server, gives a measure of how preferential this server is to be chosen for new application sessions.

  • BLOCK: RDS Server is blocked and new sessions will not be accepted.
  • HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.
  • NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.
  • LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.
  • UNKNOWN: RDS Server did not report a load preference. This is potentially a configuration issue if other RDS Servers in the same Farm do report load preferences.
Possible values are : BLOCK, HEAVY, NORMAL, LIGHT, UNKNOWN,
string
logoff_policy
Optional

The user log off behavior at the time of maintenance.

  • FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.
  • WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.
Possible values are : FORCE_LOGOFF, WAIT_FOR_LOGOFF,
integer As int32 As int32
max_sessions_count
Optional

Maximum number of sessions for RDS server as reported by the Horizon Agent. This will be unset if the value is not configured.

integer As int32 As int32
max_sessions_count_configured
Optional

Maximum number of sessions for RDS server as configured by administrator. This will be unset if the value is not configured.

string
max_sessions_type
Optional

RDS Server max sessions type as reported by the Horizon Agent.

  • UNLIMITED: The RDS Server has an unlimited number of sessions.
  • LIMITED: The RDS Server has a limited number of sessions.
Possible values are : UNLIMITED, LIMITED,
string
max_sessions_type_configured
Optional

The configured RDS Server max sessions type. If the RDS Server is part of an automated farm, this value is inherited from the farm configuration. This property has a default value of UNCONFIGURED.

  • UNLIMITED: The RDS Server has an unlimited number of sessions.
  • LIMITED: The RDS Server has a limited number of sessions.
  • UNCONFIGURED: The max number of sessions has not yet been defined for the RDSServer.
Possible values are : UNLIMITED, LIMITED, UNCONFIGURED,
boolean
message_security_enhanced_mode_supported
Optional

Indicates whether ENHANCED message security mode is currently supported by this machine.

string
message_security_mode
Optional

The current JMS message security mode used by this machine.
Supported Filters : 'Equals'.

  • DISABLED: Message security mode is disabled.
  • MIXED: Message security mode is enabled but not enforced.
  • ENABLED: Message security mode is enabled. Unsigned messages are rejected by Horizon components.
  • ENHANCED: Message Security mode is Enhanced. Message signing and validation is performed based on the current Security Level and desktop Message Security mode.
Possible values are : DISABLED, MIXED, ENABLED, ENHANCED,
string
name
Optional

Name of the RDS Server.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'.

string
operating_system
Optional

The machine operating system.

  • UNKNOWN: Unknown
  • WINDOWS_SERVER_2003: Windows Server 2003
  • WINDOWS_SERVER_2008: Windows Server 2008
  • WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
  • WINDOWS_SERVER_2012: Windows Server 2012
  • WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
  • WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
  • LINUX_SERVER_OTHER: Linux Server (other)
Possible values are : UNKNOWN, WINDOWS_SERVER_2003, WINDOWS_SERVER_2008, WINDOWS_SERVER_2008_R2, WINDOWS_SERVER_2012, WINDOWS_SERVER_2012_R2, WINDOWS_SERVER_2016_OR_ABOVE, LINUX_SERVER_OTHER,
string
operation
Optional

The current maintenance operation on the RDS Server.
Supported Filters : 'Equals'.

  • REFRESH: A refresh operation.
  • RECOMPOSE: A recompose operation.
  • REBALANCE: A rebalance operation.
  • ATTACH: A persistent disk attach operation.
  • DETACH: A persistent disk detach operation.
  • REPLACE: A persistent disk replace operation.
  • CHECKPOINT: A checkpoint operation.
  • PUSH_IMAGE: A push image operation.
Possible values are : REFRESH, RECOMPOSE, REBALANCE, ATTACH, DETACH, REPLACE, CHECKPOINT, PUSH_IMAGE,
string
operation_state
Optional

The state of the current maintenance operation on the RDS Server.
Supported Filters : 'Equals'.

  • UNDEFINED: The operation state is unrecognized.
  • SCHEDULED: The operation is scheduled for future execution.
  • PROGRESSING: The operation is in progress.
  • COMPLETED: The operation has completed.
  • FAULT: The operation has encountered an error.
  • CANCELLING: The operation has been cancelled.
  • HOLDING: The operation has been paused.
  • CREATE: The operation is being initiated.
Possible values are : UNDEFINED, SCHEDULED, PROGRESSING, COMPLETED, FAULT, CANCELLING, HOLDING, CREATE,
string
pending_base_vm_id
Optional

The pending base vm id.
Supported Filters : 'Equals'.

string
pending_base_vm_snapshot_id
Optional

The pending base vm snapshot id.
Supported Filters : 'Equals'.

string
pending_image_management_stream_id
Optional

The id of the pending image management stream. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.
Supported Filters : 'Equals'.

string
pending_image_management_tag_id
Optional

The id of the pending image management tag. This will be populated only for RDS server belonging to Instant Clone farms created using image catalog.
Supported Filters : 'Equals'.

string
remote_experience_agent_build_number
Optional

The remote experience Horizon Agent build number.
Supported Filters : 'Equals'.

string
remote_experience_agent_version
Optional

The remote experience Horizon Agent version.
Supported Filters : 'Equals'.

integer As int32 As int32
session_count
Optional

RDS server session count.
Supported Filters : 'Equals'.

string
state
Optional

The state of the RDS server.
Supported Filters : 'Equals'.

  • WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.
  • AGENT_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.
  • AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.
  • AVAILABLE: The RDS Server is powered on and ready for an active connection.
  • DISABLED: The RDS Server is disabled.
  • DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.
  • PROVISIONING: The RDS Server is being provisioned.
  • PROVISIONING_ERROR: An error occurred during provisioning.
  • CUSTOMIZING: The RDS Server is being customized.
  • DELETING: The RDS Server is marked for deletion. It will be deleted soon.
  • MAINTENANCE: The RDS Server is in maintenance mode.
  • ERROR: An unknown error occurred in the RDS Server.
  • PROVISIONED: The RDS Server has been provisioned.
  • CONNECTED: The RDS Server is in an active session.
  • DISCONNECTED: The RDS Server is in an active session but is disconnected.
  • AGENT_ERR_STARTUP_IN_PROGRESS: The Horizon Agent has started on the virtual machine, but other required services such as the display protocol are still starting.
  • AGENT_ERR_DISABLED: The Horizon Agent is disabled.
  • AGENT_ERR_INVALID_IP: The Horizon Agent has an invalid IP.
  • AGENT_ERR_NEED_REBOOT: The Horizon Agent needs reboot.
  • AGENT_ERR_PROTOCOL_FAILURE: Protocol such as RDP or PCoIP is not enabled.
  • AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.
  • AGENT_DRAIN_MODE: The RDS Server is configured for drain mode.
  • AGENT_DRAIN_UNTIL_RESTART: The RDS Server is configured a mode to drain until restart.
  • ALREADY_USED: The RDS Server cannot accept new sessions.
  • IN_PROGRESS: There is a RDS Server operation in progress.
  • VALIDATING: The connection server is synchronizing state information with the agent.
  • UNKNOWN: Could not determine the state of the RDS Server.
Possible values are : WAIT_FOR_AGENT, AGENT_UNREACHABLE, AGENT_CONFIG_ERROR, AVAILABLE, DISABLED, DISABLE_IN_PROGRESS, PROVISIONING, PROVISIONING_ERROR, CUSTOMIZING, DELETING, MAINTENANCE, ERROR, PROVISIONED, CONNECTED, DISCONNECTED, AGENT_ERR_STARTUP_IN_PROGRESS, AGENT_ERR_DISABLED, AGENT_ERR_INVALID_IP, AGENT_ERR_NEED_REBOOT, AGENT_ERR_PROTOCOL_FAILURE, AGENT_ERR_DOMAIN_FAILURE, AGENT_DRAIN_MODE, AGENT_DRAIN_UNTIL_RESTART, ALREADY_USED, IN_PROGRESS, VALIDATING, UNKNOWN,

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page
Inventory Operations
POST
Add Local Application Pools To GAE
POST
Add Local Desktop Pools To GDE
POST
Add Machines
POST
Add Machines By Name
POST
Assign Machine Aliases
POST
Assign Users
POST
Cancel Desktop Pool Task
POST
Cancel Scheduled Push Image
POST
Create Application Pool
POST
Create Global Desktop Entitlement
DELETE
Delete Application Pool
DELETE
Delete Machine
DELETE
Delete Machines
DELETE
Delete Physical Machine
DELETE
Delete RDS Server
POST
Disconnect Sessions
POST
Enter Maintenance
POST
Exit Maintenance
GET
Get Application Icon
GET
Get Application Pool
GET
Get Application Pool V2
GET
Get Desktop Pool
GET
Get Desktop Pool Task
GET
Get Desktop Pool V2
GET
Get Desktop Pool V3
GET
Get Farm
GET
Get Global Application Entitlement
GET
Get Global Desktop Entitlement
GET
Get Machine
GET
Get Machine V2
GET
Get Physical Machine
GET
Get RDS Server
GET
Get Session Info
GET
List Application Icons
GET
List Application Pools
GET
List Application Pools V2
GET
List Compatible Local Application Pools
GET
List Compatible Local Desktop Pools
GET
List Desktop Pools
GET
List Desktop Pools V2
GET
List Desktop Pools V3
GET
List Desktop Pool Tasks
GET
List Farms
GET
List Global Application Entitlements
GET
List Global Desktop Entitlements
GET
List Installed Applications On Desktop Pool
GET
List Installed Applications On Farm
GET
List Local Application Pools
GET
List Local Desktop Pools
GET
List Machines
GET
List Machines V2
GET
List Physical Machines
GET
List RDS Servers
GET
List Session Info
POST
Log Off Sessions
POST
Rebuild Machines
POST
Recover Machines
POST
Recover RDS Servers
POST
Register Physical Machine
POST
Register RDS Server
DELETE
Remove Local Application Pools From GAE
DELETE
Remove Local Desktop Pools From GDE
POST
Remove Machines
POST
Reset Machines
POST
Reset Sessions
POST
Restart Machines
POST
Restart Sessions
POST
Schedule Push Image
POST
Send Message To Sessions
POST
Unassign Machine Aliases
POST
Unassign Users
PUT
Update Application Pool
PUT
Update RDS Server