Get RDS Server | VMware Horizon Server API

Get RDS Server

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 should have permission to this privilege to read the registered RDS Server that is part of farm.

Request

URI

GET

https://{api_host}/rest/inventory/v1/rds-servers/{id}

COPY

Path Parameters

string

Required

RDS Server ID

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

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'. This property can be used for sorting.

string

agent_version

Optional

The Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.

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'. This property can be used for sorting.

string

dns_name

Optional

DNS name of the machine.
Supported Filters : 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.

boolean

enabled

Optional

Indicates if RDS server is enabled.
Supported Filters : 'Equals'. This property can be used for sorting.

string

farm_id

Optional

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

string

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. This property can be used for sorting.

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. This property can be used for sorting.

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.
LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.
NORMAL: RDS Server is experiencing normal 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, LIGHT, NORMAL, UNKNOWN,

string

logoff_policy

Optional

The user log off behavior at the time of maintenance. This property can be used for sorting.

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. This property can be used for sorting.

string

message_security_mode

Optional

The current JMS message security mode used by this machine.
Supported Filters : 'Equals'. This property can be used for sorting.

DISABLED: Message security mode is disabled.
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.
MIXED: Message security mode is enabled but not enforced.

Possible values are : DISABLED, ENABLED, ENHANCED, MIXED,

string

name

Optional

Name of the RDS Server.
Supported Filters : 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.

string

operating_system

Optional

The machine operating system.

LINUX_SERVER_OTHER: Linux Server (other)
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

Possible values are : LINUX_SERVER_OTHER, UNKNOWN, WINDOWS_SERVER_2003, WINDOWS_SERVER_2008, WINDOWS_SERVER_2008_R2, WINDOWS_SERVER_2012, WINDOWS_SERVER_2012_R2, WINDOWS_SERVER_2016_OR_ABOVE,

string

operation

Optional

The current maintenance operation on the RDS Server.
Supported Filters : 'Equals'. This property can be used for sorting.

ARCHIVE: An archive operation.
ATTACH: A persistent disk attach operation.
DETACH: A persistent disk detach operation.
PUSH_IMAGE: A push image operation.
TAGGING: A tagging operation.

Possible values are : ARCHIVE, ATTACH, DETACH, PUSH_IMAGE, TAGGING,

string

operation_state

Optional

The state of the current maintenance operation on the RDS Server.
Supported Filters : 'Equals'. This property can be used for sorting.

CANCELLING: The operation has been cancelled.
COMPLETED: The operation has completed.
CREATE: The operation is being initiated.
FAULT: The operation has encountered an error.
HOLDING: The operation has been paused.
PROGRESSING: The operation is in progress.
SCHEDULED: The operation is scheduled for future execution.
STANDBY: The operation is on standby for a selective resync.
UNDEFINED: The operation state is unrecognized.

Possible values are : CANCELLING, COMPLETED, CREATE, FAULT, HOLDING, PROGRESSING, SCHEDULED, STANDBY, UNDEFINED,

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'. This property can be used for sorting.

string

remote_experience_agent_version

Optional

The remote experience Horizon Agent version.
Supported Filters : 'Equals'. This property can be used for sorting.

integer As int32 As int32

session_count

Optional

RDS server session count.
This property can be used for sorting.

string

state

Optional

The state of the RDS server.
Supported Filters : 'Equals'. This property can be used for sorting.

AGENT_CONFIG_ERROR: The RDS Server has configuration error. Ex: Remote Desktop Service role is not enabled.
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.
AGENT_ERR_DISABLED: The Horizon Agent is disabled.
AGENT_ERR_DOMAIN_FAILURE: The RDS Server has an invalid domain.
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_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_UNREACHABLE: Connection Server cannot establish communication with View Agent on a RDS Server.
ALREADY_USED: The RDS Server cannot accept new sessions.
AVAILABLE: The RDS Server is powered on and ready for an active connection.
BLOCKED_AGENT_VERSION: The Horizon Agent version is blocked from establishing sessions.
CONNECTED: The RDS Server is in an active session.
CUSTOMIZING: The RDS Server is being customized.
DELETING: The RDS Server is marked for deletion. It will be deleted soon.
DISABLED: The RDS Server is disabled.
DISABLE_IN_PROGRESS: Disabled RDS server still has some brokered sessions. It can still accept re-connections.
DISCONNECTED: The RDS Server is in an active session but is disconnected.
ERROR: An unknown error occurred in the RDS Server.
IN_PROGRESS: There is a RDS Server operation in progress.
MAINTENANCE: The RDS Server is in maintenance mode.
PROVISIONED: The RDS Server has been provisioned.
PROVISIONING: The RDS Server is being provisioned.
PROVISIONING_ERROR: An error occurred during provisioning.
UNKNOWN: Could not determine the state of the RDS Server.
VALIDATING: The connection server is synchronizing state information with the agent.
WAIT_FOR_AGENT: Connection Server is waiting to establish communication with View Agent on a RDS Server.

Possible values are : AGENT_CONFIG_ERROR, AGENT_DRAIN_MODE, AGENT_DRAIN_UNTIL_RESTART, AGENT_ERR_DISABLED, AGENT_ERR_DOMAIN_FAILURE, AGENT_ERR_INVALID_IP, AGENT_ERR_NEED_REBOOT, AGENT_ERR_PROTOCOL_FAILURE, AGENT_ERR_STARTUP_IN_PROGRESS, AGENT_UNREACHABLE, ALREADY_USED, AVAILABLE, BLOCKED_AGENT_VERSION, CONNECTED, CUSTOMIZING, DELETING, DISABLED, DISABLE_IN_PROGRESS, DISCONNECTED, ERROR, IN_PROGRESS, MAINTENANCE, PROVISIONED, PROVISIONING, PROVISIONING_ERROR, UNKNOWN, VALIDATING, WAIT_FOR_AGENT,

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

Description

Request