Service - Pod

Class: VMware.Hv.Pod
See also: MapEntry, PodId, PodInfo
Since: Horizon View 6.0

Service Description

Interface representing a Pod object in a Multi-DataCenter View Pod Federation.

Methods

Methods defined in this Service
Pod_Get, Pod_List, Pod_Update

Pod_Get

Get information about a specific pod in the Multi-DataCenter View Pod Federation that the local pod is a member of. Requires at least one of the listed privileges.

Privileges

Privilege	Description
FEDERATED_LDAP_VIEW	Global LDAP read is required to read a pod.
FEDERATED_SESSIONS_VIEW	Global sessions read is required to read a pod.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Pod used to make the method call.
id	PodId	the id of the pod to get

Return Value

Type	Description
PodInfo	PodInfo for the pod

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.
InvalidState	Thrown if this pod is not part of a Pod Federation
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="Pod_Get" type="vdi:Pod_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Pod_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:PodInfo"/>
               </sequence>
            </complexType>
         </element>

Pod_List

List all pods in the Multi-DataCenter View Pod Federation that the local pod is a member of. Requires at least one of the listed privileges.

Privileges

Privilege	Description
FEDERATED_LDAP_VIEW	Global LDAP read is required to list pods.
FEDERATED_SESSIONS_VIEW	Global sessions read is required to list pods.

Parameters

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

Return Value

Type	Description
PodInfo[]	All podInfo for the Pod Federation

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.
InvalidState	Thrown if this pod is not part of a Pod Federation
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="Pod_List" type="vdi:Pod_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Pod_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:PodInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

Pod_Update

Update display name, description, or Site for the pod with the given podId. Note endpoints and activeGlobalEntitlements are maintained by the system and can not be updated using this method.

Privileges

Privilege	Description
FEDERATED_LDAP_MANAGE	Global LDAP management is required to update a pod.

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

PodId

the id of the pod to be updated.

updates

MapEntry[]

key value pairs describing attributes to be updated. Only displayName and description are permitted for update.

This parameter is an update map based on PodInfo.

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.
InvalidRequest	Thrown if the update map contains invalid or non-permitted fields
InvalidState	Thrown if the Pod Federation has not been initialized.
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_POD_UPDATE_SUCCESS	If the pod was successfully updated.
VLSI_POD_UPDATE_FAILURE	If the pod 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="Pod_Update" type="vdi:Pod_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Pod_UpdateResponse">
            <complexType/>
         </element>