com.vmware.vcloud.sdk.admin.extensions
Class VMWProviderVdc

java.lang.Object
  com.vmware.vcloud.sdk.VcloudResource<T>
      com.vmware.vcloud.sdk.VcloudEntity<com.vmware.vcloud.api.rest.schema.extension.VMWProviderVdcType>
          com.vmware.vcloud.sdk.admin.extensions.VMWProviderVdc

public class VMWProviderVdc
extends VcloudEntity<com.vmware.vcloud.api.rest.schema.extension.VMWProviderVdcType>

Helper class for the VMWProviderVdc Resource in vCloud Admin Extension API.

Author:

Administrator

Method Summary

Task	delete() Delete VMWProviderVdc
static Task	delete(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType vmwProviderVdcRef) Delete VMWProviderVdc
void	disable() Disable the VMW Provider Vdc
static void	disable(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType vmwProviderVdcRef) Disable the VMW Provider Vdc
void	disableResourcePool(String morefValue) Disable the resource pool.
void	enable() Enable the VMW Provider Vdc
static void	enable(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType vmwProviderVdcRef) Enable the VMW Provider Vdc
void	enableResourcePool(String morefValue) Enable the resource pool.
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getAdminVdcRefsByName() Returns a HashMap of the AdminVdc References By Name
List<com.vmware.vcloud.api.rest.schema.extension.VMWStorageProfileType>	getAvailableVMWProviderVdcStorageProfiles() Returns a list of all the available storage profiles in this provider vdc.
HashMap<String,com.vmware.vcloud.api.rest.schema.extension.VimObjectRefType>	getDatastoreVimRefsByMoref() Returns the datastore vim object references by moref name
com.vmware.vcloud.api.rest.schema.ReferenceType	getExternalNetworkRefByName(String name) Returns the ExternalNetwork reference by name
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getExternalNetworkRefs() Returns the ExternalNetwork referencess
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getExternalNetworkRefsByName() Returns the ExternalNetwork references by name
com.vmware.vcloud.api.rest.schema.ReferenceType	getProviderVdcReference() Returns the provider vdc reference.
HashMap<String,com.vmware.vcloud.api.rest.schema.extension.VMWProviderVdcResourcePoolType>	getResourcePoolsByMoref() Get the VMW Provider Vdc's backing resource pools by moref.
static HashMap<String,com.vmware.vcloud.api.rest.schema.extension.VMWProviderVdcResourcePoolType>	getResourcePoolsByMoref(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType vmwProvVdcRef) Get the VMW Provider Vdc's backing resource pools by moref.
List<com.vmware.vcloud.api.rest.schema.extension.VimObjectRefType>	getResourcePoolVimRefs() Returns the Resource Pool vim object references
ReferenceResult	getVMs(String resourcePoolMoref) List the VMs on a resource pool.
com.vmware.vcloud.api.rest.schema.ReferenceType	getVMWHostRefByName(String name) Returns the vmw host reference by name
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getVMWHostRefs() Returns the vmw host referencess
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getVMWHostRefsByName() Returns the vmw host references by name
com.vmware.vcloud.api.rest.schema.ReferenceType	getVMWNetworkPoolRefByName(String name) Returns the vmw network pool reference by name
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getVMWNetworkPoolRefs() Returns the vmw network pool referencess
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getVMWNetworkPoolRefsByName() Returns the vmw network pool references by name
static VMWProviderVdc	getVMWProviderVdcById(VcloudClient client, String vCloudId) Get VMWProviderVdc helper using the vCloud ID
static VMWProviderVdc	getVMWProviderVdcByReference(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType reference) Returns the VMWProviderVdc Helper for the given provider vdc reference
List<com.vmware.vcloud.api.rest.schema.ReferenceType>	getVMWProviderVdcStorageProfileRefs() Returns a list of all the vmw provider vdc storage profile references.
List<com.vmware.vcloud.api.rest.schema.ReferenceType>	getVMWVimServerRefs() Returns the vim server references
Task	mergeProviderVdcs(List<com.vmware.vcloud.api.rest.schema.ReferenceType> vmwProvVdcRefs) Merge a provider vdc with other provider vdcs.
Task	migrateVms(String sourceResourcePoolMoref, List<com.vmware.vcloud.api.rest.schema.ReferenceType> vmRefs, com.vmware.vcloud.api.rest.schema.extension.VimObjectRefType resourcePoolVimRef) Migrate Vms to a different resource pool.
Task	updateResourcePools(List<com.vmware.vcloud.api.rest.schema.extension.VimObjectRefType> resourcePoolVimRefs, List<com.vmware.vcloud.api.rest.schema.ReferenceType> resourcePoolRefs) Add/Delete the resource pools.
VMWProviderVdc	updateVMWProviderVdc(com.vmware.vcloud.api.rest.schema.extension.VMWProviderVdcType vmwProviderVdcType) Update the VMWProviderVdc
Task	updateVMWProviderVdcStorageProfiles(List<String> addStorageProfiles, List<com.vmware.vcloud.api.rest.schema.ReferenceType> removeStorageProfiles) Updating the provider vdc storage profiles.

Methods inherited from class com.vmware.vcloud.sdk.VcloudEntity

getMetadata, getReference, getTasks

Methods inherited from class com.vmware.vcloud.sdk.VcloudResource

getResource

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getVMWProviderVdcByReference

public static VMWProviderVdc getVMWProviderVdcByReference(VcloudClient client,
                                                          com.vmware.vcloud.api.rest.schema.ReferenceType reference)
                                                   throws VCloudException

Returns the VMWProviderVdc Helper for the given provider vdc reference

Parameters:

client -

reference -

Returns:

VMWProviderVdc

Throws:

VCloudException

getVMWProviderVdcById

public static VMWProviderVdc getVMWProviderVdcById(VcloudClient client,
                                                   String vCloudId)
                                            throws VCloudException

Get VMWProviderVdc helper using the vCloud ID

Parameters:

client - VcloudClient

vCloudId - format - The vCloud ID is of the form: "urn:vcloud:type:uuid". For example: "urn:vcloud:media:d9d976ba-e0ec-4682-a67d-380af49b54e1". String

Returns:

VMWProviderVdc

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getProviderVdcReference

public com.vmware.vcloud.api.rest.schema.ReferenceType getProviderVdcReference()
                                                                        throws VCloudException

Returns the provider vdc reference.

Returns:

ReferenceType

Throws:

VCloudException

updateVMWProviderVdc

public VMWProviderVdc updateVMWProviderVdc(com.vmware.vcloud.api.rest.schema.extension.VMWProviderVdcType vmwProviderVdcType)
                                    throws VCloudException

Update the VMWProviderVdc

Parameters:

vmwProviderVdcType - VMWProviderVdcType

Returns:

VMWProviderVdc

Throws:

VCloudException

delete

public Task delete()
            throws VCloudException

Delete VMWProviderVdc

Returns:

Task

Throws:

VCloudException

delete

public static Task delete(VcloudClient client,
                          com.vmware.vcloud.api.rest.schema.ReferenceType vmwProviderVdcRef)
                   throws VCloudException

Delete VMWProviderVdc

Parameters:

client - vCloud Client VcloudClient

vmwProviderVdcRef - VMWProviderVdc Ref

Returns:

Task

Throws:

VCloudException

disable

public void disable()
             throws VCloudException

Disable the VMW Provider Vdc

Throws:

VCloudException

disable

public static void disable(VcloudClient client,
                           com.vmware.vcloud.api.rest.schema.ReferenceType vmwProviderVdcRef)
                    throws VCloudException

Disable the VMW Provider Vdc

Parameters:

client - VcloudClient

vmwProviderVdcRef -

Throws:

VCloudException

enable

public void enable()
            throws VCloudException

Enable the VMW Provider Vdc

Throws:

VCloudException

enable

public static void enable(VcloudClient client,
                          com.vmware.vcloud.api.rest.schema.ReferenceType vmwProviderVdcRef)
                   throws VCloudException

Enable the VMW Provider Vdc

Parameters:

client - VcloudClient

vmwProviderVdcRef -

Throws:

VCloudException

getAdminVdcRefsByName

public HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType> getAdminVdcRefsByName()
                                                                                      throws VCloudException

Returns a HashMap of the AdminVdc References By Name

Returns:

HashMap

Throws:

VCloudException

getVMWVimServerRefs

public List<com.vmware.vcloud.api.rest.schema.ReferenceType> getVMWVimServerRefs()

Returns the vim server references

Returns:

List<ReferenceType>

Since:

API 1.5, SDK 1.5

getResourcePoolVimRefs

public List<com.vmware.vcloud.api.rest.schema.extension.VimObjectRefType> getResourcePoolVimRefs()
                                                                                          throws VCloudException

Returns the Resource Pool vim object references

Returns:

List<VimObjectRefType>

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getResourcePoolsByMoref

public HashMap<String,com.vmware.vcloud.api.rest.schema.extension.VMWProviderVdcResourcePoolType> getResourcePoolsByMoref()
                                                                                                                   throws VCloudException

Get the VMW Provider Vdc's backing resource pools by moref.

Returns:

HashMap<String, VMWProviderVdcResourcePoolType>

Throws:

VCloudException

VCloudException

Since:

API 1.5, SDK 1.5

getResourcePoolsByMoref

public static HashMap<String,com.vmware.vcloud.api.rest.schema.extension.VMWProviderVdcResourcePoolType> getResourcePoolsByMoref(VcloudClient client,
                                                                                                                                 com.vmware.vcloud.api.rest.schema.ReferenceType vmwProvVdcRef)
                                                                                                                          throws VCloudException

Get the VMW Provider Vdc's backing resource pools by moref.

Parameters:

client - VcloudClient

vmwProvVdcRef - ReferenceType

Returns:

HashMap<String, VMWProviderVdcResourcePoolType>

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

updateResourcePools

public Task updateResourcePools(List<com.vmware.vcloud.api.rest.schema.extension.VimObjectRefType> resourcePoolVimRefs,
                                List<com.vmware.vcloud.api.rest.schema.ReferenceType> resourcePoolRefs)
                         throws VCloudException

Add/Delete the resource pools.

Parameters:

resourcePoolVimRefs - - To be added resource pool vim object refs List< VimObjectRefType >

resourcePoolRefs - - To be deleted resource pool references List< ReferenceType>

Returns:

Task

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getDatastoreVimRefsByMoref

public HashMap<String,com.vmware.vcloud.api.rest.schema.extension.VimObjectRefType> getDatastoreVimRefsByMoref()

Returns the datastore vim object references by moref name

Returns:

HashMap<String, VimObjectRefType>

disableResourcePool

public void disableResourcePool(String morefValue)
                         throws VCloudException

Disable the resource pool.

Parameters:

morefValue - - Resource Pool Moref. String

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

enableResourcePool

public void enableResourcePool(String morefValue)
                        throws VCloudException

Enable the resource pool.

Parameters:

morefValue - - Resource Pool Moref. String

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

mergeProviderVdcs

public Task mergeProviderVdcs(List<com.vmware.vcloud.api.rest.schema.ReferenceType> vmwProvVdcRefs)
                       throws VCloudException

Merge a provider vdc with other provider vdcs.

Parameters:

vmwProvVdcRefs - - VMW ProviderVdc references.

Returns:

Task

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

getExternalNetworkRefsByName

public HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType> getExternalNetworkRefsByName()

Returns the ExternalNetwork references by name

Returns:

HashMap

getExternalNetworkRefByName

public com.vmware.vcloud.api.rest.schema.ReferenceType getExternalNetworkRefByName(String name)

Returns the ExternalNetwork reference by name

Parameters:

name -

Returns:

ReferenceType

getExternalNetworkRefs

public Collection<com.vmware.vcloud.api.rest.schema.ReferenceType> getExternalNetworkRefs()

Returns the ExternalNetwork referencess

Returns:

Collection

getVMWNetworkPoolRefsByName

public HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType> getVMWNetworkPoolRefsByName()

Returns the vmw network pool references by name

Returns:

HashMap

getVMWNetworkPoolRefByName

public com.vmware.vcloud.api.rest.schema.ReferenceType getVMWNetworkPoolRefByName(String name)

Returns the vmw network pool reference by name

Parameters:

name -

Returns:

ReferenceType

getVMWNetworkPoolRefs

public Collection<com.vmware.vcloud.api.rest.schema.ReferenceType> getVMWNetworkPoolRefs()

Returns the vmw network pool referencess

Returns:

Collection

getVMWHostRefsByName

public HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType> getVMWHostRefsByName()

Returns the vmw host references by name

Returns:

HashMap

getVMWHostRefByName

public com.vmware.vcloud.api.rest.schema.ReferenceType getVMWHostRefByName(String name)

Returns the vmw host reference by name

Parameters:

name -

Returns:

ReferenceType

getVMWHostRefs

public Collection<com.vmware.vcloud.api.rest.schema.ReferenceType> getVMWHostRefs()

Returns the vmw host referencess

Returns:

Collection

getVMWProviderVdcStorageProfileRefs

public List<com.vmware.vcloud.api.rest.schema.ReferenceType> getVMWProviderVdcStorageProfileRefs()
                                                                                          throws VCloudException

Returns a list of all the vmw provider vdc storage profile references.

Returns:

List<ReferenceType>

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

getAvailableVMWProviderVdcStorageProfiles

public List<com.vmware.vcloud.api.rest.schema.extension.VMWStorageProfileType> getAvailableVMWProviderVdcStorageProfiles()
                                                                                                                  throws VCloudException

Returns a list of all the available storage profiles in this provider vdc.

Returns:

List<VMWStorageProfileType>

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

updateVMWProviderVdcStorageProfiles

public Task updateVMWProviderVdcStorageProfiles(List<String> addStorageProfiles,
                                                List<com.vmware.vcloud.api.rest.schema.ReferenceType> removeStorageProfiles)
                                         throws VCloudException

Updating the provider vdc storage profiles. Can add and delete the storage profiles.

Parameters:

addStorageProfiles - - list of storage profiles which can be added to this provider vdc.

removeStorageProfiles - - list of storage profile references which needs to be removed from this provider vdc.

Returns:

Task

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

migrateVms

public Task migrateVms(String sourceResourcePoolMoref,
                       List<com.vmware.vcloud.api.rest.schema.ReferenceType> vmRefs,
                       com.vmware.vcloud.api.rest.schema.extension.VimObjectRefType resourcePoolVimRef)
                throws VCloudException

Migrate Vms to a different resource pool.

Parameters:

sourceResourcePoolMoref - - the source resource pool moref where the vms currently reside.

vmRefs - - virtual machine references which will be migrated. At least one Vm should be provided for migrating to the target resource pool. List< ReferenceType>

resourcePoolVimRef - - Vim object reference to a resource pool to which the virtual machine will be migrated. This parameter is optional. If it is not provided, the system will automatically choose a target resource pool and migrate the VMs to it. VimObjectRefType

Returns:

Task

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

getVMs

public ReferenceResult getVMs(String resourcePoolMoref)
                       throws VCloudException

List the VMs on a resource pool.

Parameters:

resourcePoolMoref - - the resource pool moref for which VMs need to be listed.

Returns:

ReferenceResult

Throws:

VCloudException

Since:

API 5.1, SDK 5.1