Service - Site
Java Class
com.omnissa.vdi.vlsi.binding.vdi.federation.Site
See also
Since
Horizon View 6.0
Service Description¶
The interface representing a site in a PodFederation. A site is basically a grouping of pods that utilize shared resources: networking, storage, etc. Usually a site comprises of pods in the same datacenter.
Methods
Methods defined in this Service: Site_Create, Site_Delete, Site_Get, Site_List, Site_Update
Create a new Site. After creation, this site will have no Pod in it. To move a pod to a site, use Pod.upate()
Privileges
| Privilege | Description |
|---|---|
| FEDERATED_LDAP_MANAGE | Global LDAP management is required to create a site. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Site used to make the method call. |
| base | SiteBase | SiteBase data containing site name and description |
Return Value
| Type | Description |
|---|---|
| SiteId | Unique identifier for the created site. |
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 the PodFederation is not 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_SITE_CREATE_SUCCESS | If the site was successfully created. |
| VLSI_SITE_CREATE_FAILURE | If the site could not be created. |
Show WSDL type definition
Delete a site. This can only be done when the site has no pods in it.
Privileges
| Privilege | Description |
|---|---|
| FEDERATED_LDAP_MANAGE | Global LDAP management is required to delete a site. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Site used to make the method call. |
| id | SiteId | Id of the site 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. |
| InvalidState | Thrown if PodFederation has not been initialized or if the site has pods in it. |
| 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_SITE_DELETE_SUCCESS | If the site was successfully deleted. |
| VLSI_SITE_DELETE_FAILURE | If the site could not be deleted. |
Show WSDL type definition
Retrieve the information about a Site.
Privileges
| Privilege | Description |
|---|---|
| FEDERATED_LDAP_VIEW | Global LDAP read is required to read a site. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Site used to make the method call. |
| id | SiteId | Id of a site |
Return Value
| Type | Description |
|---|---|
| SiteInfo | SiteInfo |
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 PodFederation 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. |
Show WSDL type definition
List all the sites in the PodFederation.
Privileges
| Privilege | Description |
|---|---|
| FEDERATED_LDAP_VIEW | Global LDAP read is required to list sites. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Site used to make the method call. |
Return Value
| Type | Description |
|---|---|
| SiteInfo[] | SiteInfo |
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 the PodFederation 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. |
Show WSDL type definition
Update displayName or description of a site. To change site for a pod, use MapEntry[]).
Privileges
| Privilege | Description |
|---|---|
| FEDERATED_LDAP_MANAGE | Global LDAP management is required to update a site. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Site used to make the method call. |
| id | SiteId | Id of a site |
| updates | MapEntry[] | name value pairs for update. 1 |
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 map contains invalid fields. |
| InvalidState | Thrown if PodFederation 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_SITE_UPDATE_SUCCESS | If the site was successfully updated. |
| VLSI_SITE_UPDATE_FAILURE | If the site could not be updated. |
Show WSDL type definition