Service - URLRedirection

Class: VMware.Hv.URLRedirection
See also: MapEntry, URLRedirectionId, URLRedirectionInfo, URLRedirectionSpec
Since: Horizon 7.0

Service Description

Service Interface for URLRedirection Setting.

Methods

Methods defined in this Service
URLRedirection_Create, URLRedirection_Delete, URLRedirection_Get, URLRedirection_List, URLRedirection_Update

URLRedirection_Create

Create a new URLRedirection Setting.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global config management privilege is required to create a URLRedirection setting.
FEDERATED_LDAP_MANAGE	Global LDAP management is required to create a global URLRedirection setting.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the URLRedirection used to make the method call.
urlRedirectionSpec	URLRedirectionSpec

Return Value

Type	Description
URLRedirectionId	The id of the new URLRedirection Setting.

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_URL_REDIRECTION_CREATED	if URLRedirection creation succeeds.
VLSI_URL_REDIRECTION_CREATE_FAILED	if URLRedirection creation fails.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="URLRedirection_Create" type="vdi:URLRedirection_CreateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="URLRedirection_CreateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:URLRedirectionId"/>
               </sequence>
            </complexType>
         </element>

URLRedirection_Delete

Delete a given URLRedirection Setting.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global config management privilege is required to delete a URLRedirection setting.
FEDERATED_LDAP_MANAGE	Global LDAP management is required to delete a global URLRedirection setting.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the URLRedirection used to make the method call.
id	URLRedirectionId	The entityId of the URLRedirection to be deleted.

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_URL_REDIRECTION_DELETED	if the URLRedirection is successfully deleted.
VLSI_URL_REDIRECTION_DELETE_FAILED	if the URLRedirection deletion failed.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="URLRedirection_Delete" type="vdi:URLRedirection_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="URLRedirection_DeleteResponse">
            <complexType/>
         </element>

URLRedirection_Get

Get a URLRedirection Setting by Id.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global config view privilege is required to read a URLRedirection setting.
FEDERATED_LDAP_VIEW	Global LDAP view is required to read a global URLRedirection setting.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the URLRedirection used to make the method call.
id	URLRedirectionId	The entityId of the URLRedirection to get.

Return Value

Type	Description
URLRedirectionInfo	requested URLRedirectionInfo entity

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="URLRedirection_Get" type="vdi:URLRedirection_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="URLRedirection_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:URLRedirectionInfo"/>
               </sequence>
            </complexType>
         </element>

URLRedirection_List

List the configured URLRedirection Settings.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global config view privilege is required to list all URLRedirection settings.
FEDERATED_LDAP_VIEW	Global LDAP view is required to list all URLRedirection settings.

Parameters

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

Return Value

Type	Description
URLRedirectionInfo[]

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="URLRedirection_List" type="vdi:URLRedirection_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="URLRedirection_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:URLRedirectionInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

URLRedirection_Update

Update the URLRedirection with the set of attributes in the map.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global config management privilege is required to update a URLRedirection setting.
FEDERATED_LDAP_MANAGE	Global LDAP management is required to update a global URLRedirection setting.

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

URLRedirectionId

The entityId of the URLRedirection to be updated.

updates

MapEntry[]

The key-value pairs describing attributes to be updated.

This parameter is an update map based on URLRedirectionInfo.

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_URL_REDIRECTION_UPDATED	for each URLRedirection attribute that was updated.
VLSI_URL_REDIRECTION_UPDATE_FAILED	if URLRedirection update failed.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="URLRedirection_Update" type="vdi:URLRedirection_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="URLRedirection_UpdateResponse">
            <complexType/>
         </element>

View API

Service - URLRedirection

Service Description

URLRedirection_Create

URLRedirection_Delete

URLRedirection_Get

URLRedirection_List

URLRedirection_Update