Service - SecurityServer

Class: VMware.Hv.SecurityServer
See also: MapEntry, SecurityServerId, SecurityServerInfo
Since: Horizon View 6.0

Service Description

Service interface for View Security Server Edit.

Methods

Methods defined in this Service
SecurityServer_Get, SecurityServer_List, SecurityServer_Update

SecurityServer_Get

Get the SecurityServerInfo.

Privileges

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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the SecurityServer used to make the method call.
id	SecurityServerId	The Id of the Security Server.

Return Value

Type	Description
SecurityServerInfo	Description of a Security Server.

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="SecurityServer_Get" type="vdi:SecurityServer_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="SecurityServer_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:SecurityServerInfo"/>
               </sequence>
            </complexType>
         </element>

SecurityServer_List

Get the SecurityServerInfo objects of all the security servers.

Privileges

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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the SecurityServer used to make the method call.

Return Value

Type	Description
SecurityServerInfo[]	List of all SecurityServerInfo objects.

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="SecurityServer_List" type="vdi:SecurityServer_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="SecurityServer_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:SecurityServerInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

SecurityServer_Update

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

Privileges

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

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the SecurityServer used to make the method call.

SecurityServerId

The Id of the Security Server.

updates

MapEntry[]

Key value pairs describing attributes to be updated.

This parameter is an update map based on SecurityServerInfo.

Return Value

Type	Description
None

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="SecurityServer_Update" type="vdi:SecurityServer_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="SecurityServer_UpdateResponse">
            <complexType/>
         </element>