View API


Data Object - RDSServerInfo

Class
VMware.Hv.RDSServerInfo
Returned by
RDSServer_Get
See also
RDSNetworkLabelData, RDSServerAgentData, RDSServerBase, RDSServerId, RDSServerMaintenanceData, RDSServerMessageSecurityData, RDSServerRuntimeData, RDSServerSettings
Since
Horizon View 6.0

Data Object Description

RDSServer information; queries require at least one of the listed privileges.

Queryable Data Object

This data object is queryable using QueryService.

Query Privileges

Privilege Description
GLOBAL_CONFIG_VIEW is required to query RDSServers that are not in-use. It is sufficient to get all RDSServers that may or may not be associated with a Farm.
POOL_VIEW is required to query RDSServers that are associated with a Farm. All in-use RDSServers can be queried with POOL_VIEW on the Root access group. With POOL_VIEW privilege on a non-Root Farm access group, only the RDSServers associated with the Farm can be queried.

Data Object Properties

Properties

Name Type Description
idRDSServerId

RDS server entity ID
  • This property cannot be updated.
baseRDSServerBase

RDS server base
messageSecurityDataRDSServerMessageSecurityData

RDS Server message security data.

Since Horizon View 6.1
  • This property cannot be updated.
agentDataRDSServerAgentData

RDSServer agent information
  • This property cannot be updated.
settingsRDSServerSettings

RDS server settings
runtimeDataRDSServerRuntimeData

RDSServer runtime information
  • This property cannot be updated.
rdsServerMaintenanceDataRDSServerMaintenanceData

Maintenance details about the RDS Server. The data will be populated only for Linked clone or Instant clone provisioned RDS Server.

Since Horizon 7.9
  • This property need not be set.
  • This property cannot be updated.
refIdxsd:string

Reference ID used for this RDS Server.

Since Horizon 8.1
  • This property need not be set.
  • This property cannot be updated.
networkLabelsRDSNetworkLabelData[]

The network label(s) associated with this Farm. The network label(s) automatically assigned by Connection Server to this Machine. These may differ from the actual labels if manually changed after automatic assignment or if there was an error in assignment.

Since Horizon 8.11
  • This property need not be set.
  • This property cannot be updated.