Service - ConnectionServer

Class
VMware.Hv.ConnectionServer
See also
ConnectionServerId, ConnectionServerInfo, MapEntry
Since
Horizon View 6.0


Service Description

Service interface for View Server Edit.

Methods

Methods defined in this Service
ConnectionServer_BackupNow, ConnectionServer_Get, ConnectionServer_GetKnownDomains, ConnectionServer_GetTags, ConnectionServer_List, ConnectionServer_Update

ConnectionServer_BackupNow

Provides the ability to trigger backup immediately on a given ConnectionServer of the POD.

Privileges

Privilege Description
GLOBAL_CONFIG_MANAGEMENT Global configuration management privilege is required to initiate Ldap backup.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConnectionServer used to make the method call.
idConnectionServerId

The Id of the Connection Server.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Events

Event Description
VLSI_CONNECTION_SERVER_BACKUP_INITIATED Fired once connection server backup is initiated.
VLSI_CONNECTION_SERVER_BACKUP_FAILED Fired if the backup initiation fails.

Show WSDL type definition



ConnectionServer_Get

Get the ConnectionServerInfo.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW Global configuration view privilege is required to retrieve information about a Connection Server.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConnectionServer used to make the method call.
idConnectionServerId

The Id of the Connection Server.

Return Value

Type Description
ConnectionServerInfoDescription of a Connection Server.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



ConnectionServer_GetKnownDomains

Returns the known Active Directory domains for the connection server.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW Global configuration view privilege is required to retrieve information about a Connection Server.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConnectionServer used to make the method call.

Return Value

Type Description
xsd:string[]Array of all the known Active Directory domain DNS names.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



ConnectionServer_GetTags

Returns the tags of all connection servers of the POD. Requires at least one of the listed privileges.

Privileges

Privilege Description
POOL_VIEW privilege is required to get the list of Connection server tags.
GLOBAL_CONFIG_VIEW privilege is required to get the list of Connection server tags.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConnectionServer used to make the method call.

Return Value

Type Description
xsd:string[]An Array containing the tags on all connection servers.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



ConnectionServer_List

Get the ConnectionServerInfo objects of all the connection servers.

Privileges

Privilege Description
GLOBAL_CONFIG_VIEW Global configuration view privilege is required to retrieve information about a Connection Server.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConnectionServer used to make the method call.

Return Value

Type Description
ConnectionServerInfo[]List of all ConnectionServerInfo objects.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



ConnectionServer_Update

Update ConnectionServer configuration with the set of attributes in the map.

Privileges

Privilege Description
GLOBAL_CONFIG_MANAGEMENT Global configuration management privilege is required to update Connection Server information.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConnectionServer used to make the method call.
idConnectionServerId

The Id of the Connection Server.
updatesMapEntry[]

Key value pairs describing attributes to be updated.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Events

Event Description
ADMIN_CONNECTION_BROKER_UPDATED Fired once for each attribute changed in the connection broker
ADMIN_CONNECTION_BROKER_UPDATE_FAILED Fired if the update failed.

Show WSDL type definition