Service - GlobalSettings

Class: VMware.Hv.GlobalSettings
See also: EnvironmentSettings, GatewayCertificateInfo, GatewayCertificateSpec, GlobalFeatureSettings, GlobalPreLogonSettings, GlobalSettingsInfo, MapEntry
Since: Horizon View 6.0

Service Description

Service for specifying global settings.

Methods

Methods defined in this Service
GlobalSettings_AddGatewayCertificate, GlobalSettings_DeleteGatewayCertificate, GlobalSettings_Get, GlobalSettings_GetEnvironmentSettings, GlobalSettings_GetFeatureSettings, GlobalSettings_GetPreLogonSettings, GlobalSettings_ListGatewayCertificates, GlobalSettings_Update

GlobalSettings_AddGatewayCertificate

Add gateway certificate.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global management is required to add gateway certificate.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalSettings used to make the method call.
gatewayCertificateSpec	GatewayCertificateSpec	attributes needed to add gateway certificate.

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
VLSI_GATEWAY_CERTIFICATE_ADDED	If gateway certificate was added successfully.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSettings_AddGatewayCertificate" type="vdi:GlobalSettings_AddGatewayCertificateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSettings_AddGatewayCertificateResponse">
            <complexType/>
         </element>

GlobalSettings_DeleteGatewayCertificate

Delete gateway certificate.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global management is required to add gateway certificate.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalSettings used to make the method call.
certificateName	xsd:string	Certificate identifier in the system.

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
VLSI_GATEWAY_CERTIFICATE_DELETED	If gateway certificate was deleted successfully.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSettings_DeleteGatewayCertificate" type="vdi:GlobalSettings_DeleteGatewayCertificateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSettings_DeleteGatewayCertificateResponse">
            <complexType/>
         </element>

GlobalSettings_Get

Gets the Global Settings info for this View cluster.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global configuration (read-only) is required to get global settings information.

Parameters

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

Return Value

Type	Description
GlobalSettingsInfo	The GlobalSettingsInfo object.

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="GlobalSettings_Get" type="vdi:GlobalSettings_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSettings_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GlobalSettingsInfo"/>
               </sequence>
            </complexType>
         </element>

GlobalSettings_GetEnvironmentSettings

Fetches the settings of the environment.

Parameters

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

Return Value

Type	Description
EnvironmentSettings	The EnvironmentSettingsInfo object.

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="GlobalSettings_GetEnvironmentSettings" type="vdi:GlobalSettings_GetEnvironmentSettingsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSettings_GetEnvironmentSettingsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:EnvironmentSettings"/>
               </sequence>
            </complexType>
         </element>

GlobalSettings_GetFeatureSettings

Gets the feature settings.

Parameters

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

Return Value

Type	Description
GlobalFeatureSettings	The FeatureSettings object.

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="GlobalSettings_GetFeatureSettings" type="vdi:GlobalSettings_GetFeatureSettingsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSettings_GetFeatureSettingsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GlobalFeatureSettings"/>
               </sequence>
            </complexType>
         </element>

GlobalSettings_GetPreLogonSettings

Gets the Global Settings info that are required without any user authentication on the login page.

Parameters

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

Return Value

Type	Description
GlobalPreLogonSettings	The PreLogonSettings object.

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="GlobalSettings_GetPreLogonSettings" type="vdi:GlobalSettings_GetPreLogonSettingsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSettings_GetPreLogonSettingsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GlobalPreLogonSettings"/>
               </sequence>
            </complexType>
         </element>

GlobalSettings_ListGatewayCertificates

List of gateway certificates configured.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global configuration (read-only) is required to list gateway certificates information.

Parameters

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

Return Value

Type	Description
GatewayCertificateInfo[]	List of GatewayCertificateInfo 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="GlobalSettings_ListGatewayCertificates" type="vdi:GlobalSettings_ListGatewayCertificatesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSettings_ListGatewayCertificatesResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GatewayCertificateInfo" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

GlobalSettings_Update

Updates the global settings for this View cluster.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global management is required to update global settings information.

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

updates

MapEntry[]

key value pairs describing attributes to be updated

This parameter is an update map based on GlobalSettingsInfo.

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
VLSI_GLOBAL_SETTINGS_UPDATED	If all members were successfully updated, this will be sent for each updated member in the update map.
VLSI_GLOBAL_SETTINGS_UPDATE_FAILED	If any member could not be updated.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSettings_Update" type="vdi:GlobalSettings_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSettings_UpdateResponse">
            <complexType/>
         </element>