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

NameTypeDescription
_thisManagedObjectReference A reference to the Pod used to make the method call.
idPodId

the id of the pod to get

Return Value

Type Description
PodInfoPodInfo for the pod

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.
InvalidStateThrown if this pod is not part of a Pod Federation
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference 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
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.
InvalidStateThrown if this pod is not part of a Pod Federation
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the Pod used to make the method call.
idPodId

the id of the pod to be updated.
updatesMapEntry[]

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
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.
InvalidRequestThrown if the update map contains invalid or non-permitted fields
InvalidStateThrown if the Pod Federation has not been initialized.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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