com.vmware.vcloud.sdk.admin
Class AdminVdc

java.lang.Object
  com.vmware.vcloud.sdk.VcloudResource<T>
      com.vmware.vcloud.sdk.VcloudEntity<com.vmware.vcloud.api.rest.schema.AdminVdcType>
          com.vmware.vcloud.sdk.admin.AdminVdc

public class AdminVdc
extends VcloudEntity<com.vmware.vcloud.api.rest.schema.AdminVdcType>

Helper class for the Admin Vdc Resource in vCloud Admin API.

Author:

Administrator

Method Summary

com.vmware.vcloud.api.rest.schema.SelectorExtensionType	createAdminVdcSelectorExtension(com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType) Creates a Selector Extension for selector VDC.
EdgeGateway	createEdgeGateway(com.vmware.vcloud.api.rest.schema.GatewayType gatewayParams) Creating a edgeGateway.
AdminOrgVdcNetwork	createOrgVdcNetwork(com.vmware.vcloud.api.rest.schema.OrgVdcNetworkType orgVdcNetworkParams) Create an Org vDC Network.
Task	delete() Delete AdminVdc, AdminVdc should be disabled before deletion
static Task	delete(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminVdcRef) Delete AdminVdc, AdminVdc should be disabled before deletion
void	deleteAdminVdcSelectorExtensionById(String selectorExtensionId) Deletes a Selector Extension that is associated with this VDC.
void	disable() Disable the Vdc
static void	disable(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminVdcRef) Disable the Vdc
Task	disableFastProvisioning() Disable fast provisioning
void	enable() Enable the Vdc
static void	enable(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminVdcRef) Enable the Vdc
Task	enableFastProvisioning() Enable fast provisioning.
com.vmware.vcloud.api.rest.schema.ReferenceType	getAdminOrganizationReference() Returns the Parent Admin Organization ReferenceType.
com.vmware.vcloud.api.rest.schema.ReferenceType	getAdminOrgNetworkRefByName(String name) Deprecated. API 5.1, SDK 5.1 Note: When used against API 1.5 it returns the Org Network references. When used against API 5.1 it returns Org Vdc Network references.
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getAdminOrgNetworkRefs() Deprecated. API 5.1, SDK 5.1 Note: When used against API 1.5 it returns the Org Network references. When used against API 5.1 it returns Org Vdc Network references.
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getAdminOrgNetworkRefsByName() Deprecated. API 5.1, SDK 5.1 Note: When used against API 1.5 it returns the Org Network references. When used against API 5.1 it returns Org Vdc Network references.
static AdminVdc	getAdminVdcById(VcloudClient client, String vCloudId) Get Admin Vdc helper using the vCloud ID
static AdminVdc	getAdminVdcByReference(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType vdcRef) Returns AdminVdc using the AdminVdc ref typically obtained from the Organization.
List<com.vmware.vcloud.api.rest.schema.SelectorExtensionType>	getAdminVdcSelectorExtension() Retrieves a list of Selector Extensions that are associated with this VDC.
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	getAdminVdcSelectorExtensionById(String selectorExtensionId) Retrieves a Selector Extension that is associated with this VDC.
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getAdminVdcStorageProfileRefs() Returns the storage profile references for this vdc.
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getDiskRefs() Getting the disk references
ReferenceResult	getEdgeGatewayRefs() Returns the list of all the edgeGateway references.
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getMediaRefs() Returns the media references
com.vmware.vcloud.api.rest.schema.ReferenceType	getNetworkPoolRef() Returns the network pool reference
ReferenceResult	getOrgVdcNetworkRefs() Returns the list of all the org vdc network references.
com.vmware.vcloud.api.rest.schema.ReferenceType	getProviderVdcRef() Returns the provider vdc reference
com.vmware.vcloud.api.rest.schema.extension.VimObjectRefType	getResourcePoolVimRef() Returns the ResourcePool VIM Object reference.
HashMap<String,com.vmware.vcloud.api.rest.schema.extension.VimObjectRefType>	getResourcePoolVimRefsByMoref() Get the Org Vdc's backing resource pool vim object references by moref.
com.vmware.vcloud.api.rest.schema.ReferenceType	getVappRefByName(String name) Returns the vapp reference by name
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getVappRefs() Returns the vapp references
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getVappRefsByName() Returns the vapp references by name
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getVappTemplateRefs() Returns the vapp template references
com.vmware.vcloud.api.rest.schema.ReferenceType	getVdcReference() Returns the Vdc ReferenceType.
Task	registerVapp(com.vmware.vcloud.api.rest.schema.RegisterVAppParamsType registerVappParams) Create a vApp based on a set of .vmx files and resource mappings
Task	updateAdminVdc(com.vmware.vcloud.api.rest.schema.AdminVdcType adminVdcType) Updating the Admin Vdc
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	updateAdminVdcSelectorExtensionById(String selectorExtensionId, com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType) Updates a Selector Extension that is associated with this VDC.
Task	updateAdminVdcStorageProfiles(List<com.vmware.vcloud.api.rest.schema.VdcStorageProfileParamsType> addStorageProfiles, List<com.vmware.vcloud.api.rest.schema.ReferenceType> removeStorageProfiles) Updating the 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

getAdminVdcByReference

public static AdminVdc getAdminVdcByReference(VcloudClient client,
                                              com.vmware.vcloud.api.rest.schema.ReferenceType vdcRef)
                                       throws VCloudException

Returns AdminVdc using the AdminVdc ref typically obtained from the Organization.

Parameters:

client - vCloud API client VcloudClient

vdcRef - Ref to Vdc ReferenceType

Returns:

AdminVdc

Throws:

VCloudException

See Also:

AdminOrganization.getAdminVdcRefs(), AdminOrganization.getAdminVdcRefsByName(), AdminOrganization.getAdminVdcRefByName(String)

getAdminVdcById

public static AdminVdc getAdminVdcById(VcloudClient client,
                                       String vCloudId)
                                throws VCloudException

Get Admin Vdc 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:

AdminVdc

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

updateAdminVdc

public Task updateAdminVdc(com.vmware.vcloud.api.rest.schema.AdminVdcType adminVdcType)
                    throws VCloudException

Updating the Admin Vdc

Parameters:

adminVdcType - AdminVdcType

Returns:

Task

Throws:

VCloudException

delete

public Task delete()
            throws VCloudException

Delete AdminVdc, AdminVdc should be disabled before deletion

Returns:

Task

Throws:

VCloudException

delete

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

Delete AdminVdc, AdminVdc should be disabled before deletion

Parameters:

client - vCloud Client VcloudClient

adminVdcRef - Admin Vdc Ref

Returns:

Task

Throws:

VCloudException

enable

public void enable()
            throws VCloudException

Enable the Vdc

Throws:

VCloudException

enable

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

Enable the Vdc

Parameters:

client - VcloudClient

adminVdcRef -

Throws:

VCloudException

disable

public void disable()
             throws VCloudException

Disable the Vdc

Throws:

VCloudException

disable

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

Disable the Vdc

Parameters:

client - VcloudClient

adminVdcRef -

Throws:

VCloudException

enableFastProvisioning

public Task enableFastProvisioning()
                            throws VCloudException

Enable fast provisioning. Fast provisioning is only supported on VirtualCenter version 5.0 and above

Returns:

Task

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

disableFastProvisioning

public Task disableFastProvisioning()
                             throws VCloudException

Disable fast provisioning

Returns:

Task

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getAdminOrganizationReference

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

Returns the Parent Admin Organization ReferenceType.

Returns:

ReferenceType

Throws:

VCloudException

getVdcReference

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

Returns the Vdc ReferenceType.

Returns:

ReferenceType

Throws:

VCloudException

getResourcePoolVimRef

public com.vmware.vcloud.api.rest.schema.extension.VimObjectRefType getResourcePoolVimRef()
                                                                                   throws VCloudException

Returns the ResourcePool VIM Object reference.

Returns:

VimObjectRefType

Throws:

VCloudException

getResourcePoolVimRefsByMoref

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

Get the Org Vdc's backing resource pool vim object references by moref.

Returns:

HashMap<String, VimObjectRefType>

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getAdminOrgNetworkRefsByName

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

Deprecated. API 5.1, SDK 5.1 Note: When used against API 1.5 it returns the Org Network references. When used against API 5.1 it returns Org Vdc Network references.

Returns Admin OrgNetwork References By Name The network names might not be unique, if there are shared networks. This method might return less number of networks, when there are shared networks It is advisable to use the getResource().getAvailableNetworks() or getOrgVdcNetworkRefs() and get the complete list of network references.

Returns:

HashMap

getAdminOrgNetworkRefs

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

Deprecated. API 5.1, SDK 5.1 Note: When used against API 1.5 it returns the Org Network references. When used against API 5.1 it returns Org Vdc Network references.

Returns Admin OrgNetwork References The network names might not be unique, if there are shared networks. This method might return less number of networks, when there are shared networks It is advisable to use the getResource().getAvailableNetworks() or getOrgVdcNetworkRefs() and get the complete list of network references.

Returns:

Collection

getAdminOrgNetworkRefByName

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

Deprecated. API 5.1, SDK 5.1 Note: When used against API 1.5 it returns the Org Network references. When used against API 5.1 it returns Org Vdc Network references.

Returns the admin org network reference by name The network names might not be unique, if there are shared networks. This method might return less number of networks, when there are shared networks It is advisable to use the getResource().getAvailableNetworks() or getOrgVdcNetworkRefs() and get the complete list of network references.

Parameters:

name -

Returns:

ReferenceType

getVappTemplateRefs

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

Returns the vapp template references

Returns:

the vappTemplateRefs Collection

getMediaRefs

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

Returns the media references

Returns:

the mediaRefs Collection

getVappRefsByName

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

Returns the vapp references by name

Returns:

the vappRefsByName HashMap

getVappRefs

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

Returns the vapp references

Returns:

Collection

getVappRefByName

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

Returns the vapp reference by name

Parameters:

name -

Returns:

ReferenceType

getProviderVdcRef

public com.vmware.vcloud.api.rest.schema.ReferenceType getProviderVdcRef()

Returns the provider vdc reference

Returns:

ReferenceType

getNetworkPoolRef

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

Returns the network pool reference

Returns:

ReferenceType

Throws:

VCloudException

getAdminVdcStorageProfileRefs

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

Returns the storage profile references for this vdc.

Returns:

Collection

Since:

API 5.1, SDK 5.1

getDiskRefs

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

Getting the disk references

Returns:

Collection

Since:

API 5.1, SDK 5.1

updateAdminVdcStorageProfiles

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

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

Parameters:

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

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

Returns:

Task

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

createEdgeGateway

public EdgeGateway createEdgeGateway(com.vmware.vcloud.api.rest.schema.GatewayType gatewayParams)
                              throws VCloudException

Creating a edgeGateway.

Parameters:

gatewayParams - GatewayType

Returns:

EdgeGateway

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

getEdgeGatewayRefs

public ReferenceResult getEdgeGatewayRefs()
                                   throws VCloudException

Returns the list of all the edgeGateway references.

Returns:

ReferenceResult

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

getOrgVdcNetworkRefs

public ReferenceResult getOrgVdcNetworkRefs()
                                     throws VCloudException

Returns the list of all the org vdc network references.

Returns:

ReferenceResult

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

createOrgVdcNetwork

public AdminOrgVdcNetwork createOrgVdcNetwork(com.vmware.vcloud.api.rest.schema.OrgVdcNetworkType orgVdcNetworkParams)
                                       throws VCloudException

Create an Org vDC Network.

Parameters:

orgVdcNetworkParams - OrgVdcNetworkType

Returns:

AdminOrgVdcNetwork

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

registerVapp

public Task registerVapp(com.vmware.vcloud.api.rest.schema.RegisterVAppParamsType registerVappParams)
                  throws VCloudException

Create a vApp based on a set of .vmx files and resource mappings

Parameters:

registerVappParams -

Returns:

Task

Throws:

VCloudException

Since:

API 5.5, SDK 5.5

createAdminVdcSelectorExtension

public com.vmware.vcloud.api.rest.schema.SelectorExtensionType createAdminVdcSelectorExtension(com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType)
                                                                                        throws VCloudException

Creates a Selector Extension for selector VDC.

Parameters:

SelectorExtensionType -

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

getAdminVdcSelectorExtension

public List<com.vmware.vcloud.api.rest.schema.SelectorExtensionType> getAdminVdcSelectorExtension()
                                                                                           throws VCloudException

Retrieves a list of Selector Extensions that are associated with this VDC.

Returns:

List SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

getAdminVdcSelectorExtensionById

public com.vmware.vcloud.api.rest.schema.SelectorExtensionType getAdminVdcSelectorExtensionById(String selectorExtensionId)
                                                                                         throws VCloudException

Retrieves a Selector Extension that is associated with this VDC.

Parameters:

string - selectorExtensionId

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

updateAdminVdcSelectorExtensionById

public com.vmware.vcloud.api.rest.schema.SelectorExtensionType updateAdminVdcSelectorExtensionById(String selectorExtensionId,
                                                                                                   com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType)
                                                                                            throws VCloudException

Updates a Selector Extension that is associated with this VDC.

Parameters:

SelectorExtensionType - SelectorExtensionType

String - SelectorExtensionId

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

deleteAdminVdcSelectorExtensionById

public void deleteAdminVdcSelectorExtensionById(String selectorExtensionId)
                                         throws VCloudException

Deletes a Selector Extension that is associated with this VDC.

Parameters:

String - SelectorExtensionId

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10