com.vmware.vcloud.sdk.admin
Class AdminOrganization

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

public class AdminOrganization
extends VcloudEntity<com.vmware.vcloud.api.rest.schema.AdminOrgType>

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

See Also:

AdminOrgType

Method Summary

AdminVdc	createAdminVdc(com.vmware.vcloud.api.rest.schema.AdminVdcType adminVdcType) Deprecated. API 5.1, SDK 5.1, use AdminOrganization createAdminVdc(CreateVdcParamsType)
AdminVdc	createAdminVdc(com.vmware.vcloud.api.rest.schema.CreateVdcParamsType vdcParams) Creating a Admin Vdc
AdminCatalog	createCatalog(com.vmware.vcloud.api.rest.schema.AdminCatalogType adminCatalogType) Creating a Catalog
void	createEvent(com.vmware.vcloud.api.rest.schema.EventType eventType) Creating custom events.
Task	createOrgAssociation(com.vmware.vcloud.api.rest.schema.OrgAssociationType orgAssociation) Adds a new member to organization's associations.
AdminOrgNetwork	createOrgNetwork(com.vmware.vcloud.api.rest.schema.OrgNetworkType orgNetworkType) Deprecated. API 5.1, SDK 5.1
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	createOrgSelectorExtension(com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType) Creates a Selector Extension for selector org.
User	createUser(com.vmware.vcloud.api.rest.schema.UserType userType) Creating a User
void	delete() Delete Admin Organization for version till 5.6, added support for Higher version backward compatibility is maintained since a task is waited for and not returned.
static void	delete(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgRef) Static Delete Admin Organization for version till 5.6
Task	deleteAdminOrg(boolean force, boolean recrusive) Delete Admin Organization for version greater than 5.6.
Task	deleteOrgAssociationByName(String memberName) Removes the specified member from this organization's associations.
void	deleteOrgSelectorExtensionById(String selectorExtensionId) Deletes a Selector Extensions that is associated with this Org.
void	disable() Disable the Organization
static void	disable(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgRef) Disable the Organization
void	enable() Enable the Organization
static void	enable(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType orgRef) Enable the Organization
static AdminOrganization	getAdminOrgById(VcloudClient client, String vCloudId) Get Admin Organization helper using the vCloud ID
static AdminOrganization	getAdminOrgByReference(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType orgRef) Returns the Admin Organization helper By 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.
com.vmware.vcloud.api.rest.schema.ReferenceType	getAdminVdcRefByName(String name) Returns the admin vdc reference by name For System/Cloud Administrators, this method returns an Admin Vdc reference which can be used in AdminVdc.getAdminVdcByReference(VcloudClient, ReferenceType) For Organization/Tenant Administrators/Users this method returns a Vdc reference which can be used in Vdc#getVdcByReference(VcloudClient, ReferenceType)
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getAdminVdcRefs() Returns Vdc References.
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getAdminVdcRefsByName() Returns Vdc References By Name.
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getCatalogRefs() Returns Catalog References
com.vmware.vcloud.api.rest.schema.OrgEmailSettingsType	getEmailSettings() Retrieves the organization email settings
static com.vmware.vcloud.api.rest.schema.OrgEmailSettingsType	getEmailSettings(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference) Retrieves the organization email settings
com.vmware.vcloud.api.rest.schema.OrgFederationSettingsType	getFederationSettings() Retrieves the organization federation settings
static com.vmware.vcloud.api.rest.schema.OrgFederationSettingsType	getFederationSettings(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference) Retrieves the organization federation settings
com.vmware.vcloud.api.rest.schema.OrgGeneralSettingsType	getGeneralSettings() Retrieves the organization general settings
static com.vmware.vcloud.api.rest.schema.OrgGeneralSettingsType	getGeneralSettings(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference) Retrieves the organization general settings
com.vmware.vcloud.api.rest.schema.ReferenceType	getGroupRefByName(String name) Returns the group reference by name
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getGroupRefs() Returns Group References
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getGroupRefsByName() Returns Group References By Name
com.vmware.vcloud.api.rest.schema.OrgGuestPersonalizationSettingsType	getGuestPersonalizationSettings() Retrieves the organization guest personlization settings
com.vmware.vcloud.api.rest.schema.OrgLdapSettingsType	getLdapSettings() Deprecated. API 5.1, SDK 5.1
static com.vmware.vcloud.api.rest.schema.OrgLdapSettingsType	getLdapSettings(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference) Deprecated. API 5.1, SDK 5.1
com.vmware.vcloud.api.rest.schema.OrgOperationLimitsSettingsType	getOperationLimitsSettings() Retrieves the organization operation limit settings
com.vmware.vcloud.api.rest.schema.OrgAssociationType	getOrgAssociationByName(String memberName) Retrieves a specific member from the organization's associations as identified by OrgAssociation Name included in the request
com.vmware.vcloud.api.rest.schema.OrgAssociationsType	getOrgAssociations() Retrieves the complete list of Organizations associated with this organization
static com.vmware.vcloud.api.rest.schema.OrgAssociationsType	getOrgAssociations(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference) Retrieves the complete list of Organizations associated with this organization
static com.vmware.vcloud.api.rest.schema.OrgOAuthSettingsType	getOrgOAuthSettings(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference) Retrieves the organization Oauth settings
com.vmware.vcloud.api.rest.schema.ReferenceType	getOrgReference() Returns the Organization ReferenceType in the Vcloud User API
List<com.vmware.vcloud.api.rest.schema.SelectorExtensionType>	getOrgSelectorExtension() Retrieves a list of Selector Extensions that are associated with this org.
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	getOrgSelectorExtensionById(String selectorExtensionId) Retrieves a Selector Extensions that is associated with this Org.
com.vmware.vcloud.api.rest.schema.OrgSettingsType	getOrgSettings() Returns the Admin Organization Settings
static com.vmware.vcloud.api.rest.schema.OrgSettingsType	getOrgSettings(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference) Retrieves the organization settings
com.vmware.vcloud.api.rest.schema.OrgPasswordPolicySettingsType	getPasswordPolicySettings() Retrieves the organization password policy settings
static com.vmware.vcloud.api.rest.schema.OrgPasswordPolicySettingsType	getPasswordPolicySettings(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference) Retrieves the organization password policy settings
com.vmware.vcloud.api.rest.schema.ReferenceType	getTaskListReference() Returns the TaskList reference in the Vcloud User API
com.vmware.vcloud.api.rest.schema.ReferenceType	getUserRefByName(String name) Returns the user reference by name
Collection<com.vmware.vcloud.api.rest.schema.ReferenceType>	getUserRefs() Returns User References
HashMap<String,com.vmware.vcloud.api.rest.schema.ReferenceType>	getUserRefsByName() Returns User References By Name
com.vmware.vcloud.api.rest.schema.OrgLeaseSettingsType	getvAppLeaseSettings() Retrieves the organizations vapp lease settings.
static com.vmware.vcloud.api.rest.schema.OrgLeaseSettingsType	getvAppLeaseSettings(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference) Retrieves the organizations vapp lease settings.
com.vmware.vcloud.api.rest.schema.OrgVAppTemplateLeaseSettingsType	getvAppTemplateLeaseSettings() Retrieves the organizaitons vapp template lease settings.
static com.vmware.vcloud.api.rest.schema.OrgVAppTemplateLeaseSettingsType	getvAppTemplateLeaseSettings(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference) Retrieves the organizaitons vapp template lease settings.
Group	importGroup(com.vmware.vcloud.api.rest.schema.GroupType groupType) Creating a Group
void	regenerateFederationCertificate() Regenerates the certificates used to establish trust between an organization and its identity provider
static void	regenerateFederationCertificate(VcloudClient client, com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference) Regenerates the certificates used to establish trust between an organization and its identity provider
void	resetLdapCertificate() Resets organization LDAP SSL certificate
void	resetLdapKeyStore() Resets organization LDAP keystore
void	resetLdapSspiKeytab() Resets organization LDAP SSPI key tab.
AdminOrganization	updateAdminOrg(com.vmware.vcloud.api.rest.schema.AdminOrgType adminOrgType) Updating the Admin Organization
com.vmware.vcloud.api.rest.schema.OrgEmailSettingsType	updateEmailSettings(com.vmware.vcloud.api.rest.schema.OrgEmailSettingsType orgEmailSettingsType) Updates the organization email settings.
com.vmware.vcloud.api.rest.schema.OrgFederationSettingsType	updateFederationSettings(com.vmware.vcloud.api.rest.schema.OrgFederationSettingsType orgFederationSettingsType) Updates the organization federation settings.
com.vmware.vcloud.api.rest.schema.OrgGeneralSettingsType	updateGeneralSettings(com.vmware.vcloud.api.rest.schema.OrgGeneralSettingsType orgGeneralSettingsType) Updates the organization general settings.
com.vmware.vcloud.api.rest.schema.OrgGuestPersonalizationSettingsType	updateGuestPersonalizationSettings(com.vmware.vcloud.api.rest.schema.OrgGuestPersonalizationSettingsType orgGuestPersonalizationSettingsType) Updates the organization guest personalization settings.
com.vmware.vcloud.api.rest.schema.CertificateUploadSocketType	updateLdapCertificate(com.vmware.vcloud.api.rest.schema.CertificateUpdateParamsType certificateUpdateParamsType) Updates organization LDAP SSL certificate.
com.vmware.vcloud.api.rest.schema.KeystoreUploadSocketType	updateLdapKeyStore(com.vmware.vcloud.api.rest.schema.KeystoreUpdateParamsType keystoreUpdateParamsType) Updates organization LDAP keystore.
com.vmware.vcloud.api.rest.schema.OrgLdapSettingsType	UpdateLdapSettings(com.vmware.vcloud.api.rest.schema.OrgLdapSettingsType orgLdapSettingsType) Deprecated. API 5.1, SDK 5.1
com.vmware.vcloud.api.rest.schema.SspiKeytabUploadSocketType	updateLdapSspiKeytab(com.vmware.vcloud.api.rest.schema.SspiKeytabUpdateParamsType sspiKeytabUpdateParamsType) Updates organization LDAP SSPI keytab.
com.vmware.vcloud.api.rest.schema.OrgOperationLimitsSettingsType	updateOperationLimitsSettings(com.vmware.vcloud.api.rest.schema.OrgOperationLimitsSettingsType operationLimitsSettingsType) Updates the organization operation limit settings.
Task	updateOrgAssociations(com.vmware.vcloud.api.rest.schema.OrgAssociationsType orgAssociations) Replaces the organization's current list of association members with the specified list of members If the list is empty, all existing members will be deleted.
com.vmware.vcloud.api.rest.schema.OrgOAuthSettingsType	updateOrgOauthSettings(com.vmware.vcloud.api.rest.schema.OrgOAuthSettingsType orgOAuthSettings) Update organization OAuth settings.
com.vmware.vcloud.api.rest.schema.SelectorExtensionType	updateOrgSelectorExtensionById(String selectorExtensionId, com.vmware.vcloud.api.rest.schema.SelectorExtensionType selectorExtensionType) Updates a Selector Extensions that is associated with this Org.
com.vmware.vcloud.api.rest.schema.OrgSettingsType	updateOrgSettings(com.vmware.vcloud.api.rest.schema.OrgSettingsType orgSettingsType) Updates the organization settings.
com.vmware.vcloud.api.rest.schema.OrgPasswordPolicySettingsType	updatePasswordPolicySettings(com.vmware.vcloud.api.rest.schema.OrgPasswordPolicySettingsType orgPasswordPolicySettingsType) Updates the organization password policy settings.
com.vmware.vcloud.api.rest.schema.OrgLeaseSettingsType	updatevAppLeaseSettings(com.vmware.vcloud.api.rest.schema.OrgLeaseSettingsType orgVAppLeaseSettingsType) Updates the organizations vApp lease settings.
com.vmware.vcloud.api.rest.schema.OrgVAppTemplateLeaseSettingsType	updatevAppTemplateLeaseSettings(com.vmware.vcloud.api.rest.schema.OrgVAppTemplateLeaseSettingsType orgVAppTemplateLeaseSettingsType) Updates the organizations vApp template lease settings.

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

getAdminOrgByReference

public static AdminOrganization getAdminOrgByReference(VcloudClient client,
                                                       com.vmware.vcloud.api.rest.schema.ReferenceType orgRef)
                                                throws VCloudException

Returns the Admin Organization helper By ReferenceType

Parameters:

client - VcloudClient

orgRef - ReferenceType

Returns:

AdminOrganization

Throws:

VCloudException

See Also:

VcloudAdmin.getAdminOrgRefs(), VcloudAdmin.getAdminOrgRefsByName(), VcloudAdmin.getAdminOrgRefByName(String)

getAdminOrgById

public static AdminOrganization getAdminOrgById(VcloudClient client,
                                                String vCloudId)
                                         throws VCloudException

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

AdminOrganization

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getOrgSettings

public com.vmware.vcloud.api.rest.schema.OrgSettingsType getOrgSettings()

Returns the Admin Organization Settings

Returns:

OrgSettingsType

getOrgSettings

public static com.vmware.vcloud.api.rest.schema.OrgSettingsType getOrgSettings(VcloudClient client,
                                                                               com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference)
                                                                        throws VCloudException

Retrieves the organization settings

Parameters:

client - - VcloudClient

adminOrgReference - - ReferenceType to the admin organization

Returns:

OrgSettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

updateOrgSettings

public com.vmware.vcloud.api.rest.schema.OrgSettingsType updateOrgSettings(com.vmware.vcloud.api.rest.schema.OrgSettingsType orgSettingsType)
                                                                    throws VCloudException

Updates the organization settings.

Parameters:

orgSettingsType - OrgSettingsType - organization settings.

Returns:

OrgSettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

createCatalog

public AdminCatalog createCatalog(com.vmware.vcloud.api.rest.schema.AdminCatalogType adminCatalogType)
                           throws VCloudException

Creating a Catalog

Parameters:

adminCatalogType - AdminCatalogType

Returns:

AdminCatalog

Throws:

VCloudException

createUser

public User createUser(com.vmware.vcloud.api.rest.schema.UserType userType)
                throws VCloudException

Creating a User

Parameters:

userType - UserType

Returns:

User

Throws:

VCloudException

importGroup

public Group importGroup(com.vmware.vcloud.api.rest.schema.GroupType groupType)
                  throws VCloudException

Creating a Group

Parameters:

groupType - GroupType

Returns:

Group

Throws:

VCloudException

createAdminVdc

public AdminVdc createAdminVdc(com.vmware.vcloud.api.rest.schema.AdminVdcType adminVdcType)
                        throws VCloudException

Deprecated. API 5.1, SDK 5.1, use AdminOrganization createAdminVdc(CreateVdcParamsType)

Creating a Admin Vdc

Parameters:

adminVdcType - AdminVdcType

Returns:

AdminVdc

Throws:

VCloudException

createAdminVdc

public AdminVdc createAdminVdc(com.vmware.vcloud.api.rest.schema.CreateVdcParamsType vdcParams)
                        throws VCloudException

Creating a Admin Vdc

Parameters:

vdcParams - CreateVdcParamsType

Returns:

AdminVdc

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

createOrgNetwork

public AdminOrgNetwork createOrgNetwork(com.vmware.vcloud.api.rest.schema.OrgNetworkType orgNetworkType)
                                 throws VCloudException

Deprecated. API 5.1, SDK 5.1

Creating a Org Network

Parameters:

orgNetworkType - OrgNetworkType

Returns:

AdminOrgNetwork

Throws:

VCloudException

getOrgReference

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

Returns the Organization ReferenceType in the Vcloud User API

Returns:

ReferenceType

Throws:

VCloudException

getTaskListReference

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

Returns the TaskList reference in the Vcloud User API

Returns:

ReferenceType

Throws:

VCloudException

getvAppTemplateLeaseSettings

public static com.vmware.vcloud.api.rest.schema.OrgVAppTemplateLeaseSettingsType getvAppTemplateLeaseSettings(VcloudClient client,
                                                                                                              com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference)
                                                                                                       throws VCloudException

Retrieves the organizaitons vapp template lease settings.

Parameters:

client - - VcloudClient

adminOrgReference - - ReferenceType to the admin organization

Returns:

OrgVAppTemplateLeaseSettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getvAppTemplateLeaseSettings

public com.vmware.vcloud.api.rest.schema.OrgVAppTemplateLeaseSettingsType getvAppTemplateLeaseSettings()
                                                                                                throws VCloudException

Retrieves the organizaitons vapp template lease settings.

Returns:

OrgVAppTemplateLeaseSettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

updatevAppTemplateLeaseSettings

public com.vmware.vcloud.api.rest.schema.OrgVAppTemplateLeaseSettingsType updatevAppTemplateLeaseSettings(com.vmware.vcloud.api.rest.schema.OrgVAppTemplateLeaseSettingsType orgVAppTemplateLeaseSettingsType)
                                                                                                   throws VCloudException

Updates the organizations vApp template lease settings.

Parameters:

orgVAppTemplateLeaseSettingsType - vappTemplate lease settings OrgVAppTemplateLeaseSettingsType

Returns:

OrgVAppTemplateLeaseSettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getvAppLeaseSettings

public static com.vmware.vcloud.api.rest.schema.OrgLeaseSettingsType getvAppLeaseSettings(VcloudClient client,
                                                                                          com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference)
                                                                                   throws VCloudException

Retrieves the organizations vapp lease settings.

Parameters:

client - - VcloudClient

adminOrgReference - - ReferenceType to the admin organization

Returns:

OrgLeaseSettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getvAppLeaseSettings

public com.vmware.vcloud.api.rest.schema.OrgLeaseSettingsType getvAppLeaseSettings()
                                                                            throws VCloudException

Retrieves the organizations vapp lease settings.

Returns:

OrgLeaseSettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

updatevAppLeaseSettings

public com.vmware.vcloud.api.rest.schema.OrgLeaseSettingsType updatevAppLeaseSettings(com.vmware.vcloud.api.rest.schema.OrgLeaseSettingsType orgVAppLeaseSettingsType)
                                                                               throws VCloudException

Updates the organizations vApp lease settings.

Parameters:

orgVAppLeaseSettingsType - OrgLeaseSettingsType - vapp lease settings.

Returns:

OrgLeaseSettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getFederationSettings

public static com.vmware.vcloud.api.rest.schema.OrgFederationSettingsType getFederationSettings(VcloudClient client,
                                                                                                com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference)
                                                                                         throws VCloudException

Retrieves the organization federation settings

Parameters:

client - - VcloudClient

adminOrgReference - - ReferenceType to the admin organization

Returns:

OrgFederationSettingsType

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

getFederationSettings

public com.vmware.vcloud.api.rest.schema.OrgFederationSettingsType getFederationSettings()

Retrieves the organization federation settings

Returns:

OrgFederationSettingsType

Since:

API 5.1, SDK 5.1

updateFederationSettings

public com.vmware.vcloud.api.rest.schema.OrgFederationSettingsType updateFederationSettings(com.vmware.vcloud.api.rest.schema.OrgFederationSettingsType orgFederationSettingsType)
                                                                                     throws VCloudException

Updates the organization federation settings.

Parameters:

orgFederationSettingsType - OrgFederationSettingsType - email settings.

Returns:

OrgFederationSettingsType

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

getEmailSettings

public static com.vmware.vcloud.api.rest.schema.OrgEmailSettingsType getEmailSettings(VcloudClient client,
                                                                                      com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference)
                                                                               throws VCloudException

Retrieves the organization email settings

Parameters:

client - - VcloudClient

adminOrgReference - - ReferenceType to the admin organization

Returns:

OrgEmailSettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getEmailSettings

public com.vmware.vcloud.api.rest.schema.OrgEmailSettingsType getEmailSettings()

Retrieves the organization email settings

Returns:

OrgEmailSettingsType

Since:

API 1.5, SDK 1.5

updateEmailSettings

public com.vmware.vcloud.api.rest.schema.OrgEmailSettingsType updateEmailSettings(com.vmware.vcloud.api.rest.schema.OrgEmailSettingsType orgEmailSettingsType)
                                                                           throws VCloudException

Updates the organization email settings.

Parameters:

orgEmailSettingsType - OrgEmailSettingsType - email settings.

Returns:

OrgEmailSettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getGeneralSettings

public static com.vmware.vcloud.api.rest.schema.OrgGeneralSettingsType getGeneralSettings(VcloudClient client,
                                                                                          com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference)
                                                                                   throws VCloudException

Retrieves the organization general settings

Parameters:

client - - VcloudClient

adminOrgReference - - ReferenceType to the admin organization

Returns:

OrgGeneralSettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getGeneralSettings

public com.vmware.vcloud.api.rest.schema.OrgGeneralSettingsType getGeneralSettings()

Retrieves the organization general settings

Returns:

OrgGeneralSettingsType

Since:

API 1.5, SDK 1.5

updateGeneralSettings

public com.vmware.vcloud.api.rest.schema.OrgGeneralSettingsType updateGeneralSettings(com.vmware.vcloud.api.rest.schema.OrgGeneralSettingsType orgGeneralSettingsType)
                                                                               throws VCloudException

Updates the organization general settings.

Parameters:

orgGeneralSettingsType - OrgGeneralSettingsType - general settings.

Returns:

OrgGeneralSettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getPasswordPolicySettings

public static com.vmware.vcloud.api.rest.schema.OrgPasswordPolicySettingsType getPasswordPolicySettings(VcloudClient client,
                                                                                                        com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference)
                                                                                                 throws VCloudException

Retrieves the organization password policy settings

Parameters:

client - - VcloudClient

adminOrgReference - - ReferenceType to the admin organization

Returns:

OrgPasswordPolicySettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

getPasswordPolicySettings

public com.vmware.vcloud.api.rest.schema.OrgPasswordPolicySettingsType getPasswordPolicySettings()

Retrieves the organization password policy settings

Returns:

OrgPasswordPolicySettingsType

Since:

API 1.5, SDK 1.5

updatePasswordPolicySettings

public com.vmware.vcloud.api.rest.schema.OrgPasswordPolicySettingsType updatePasswordPolicySettings(com.vmware.vcloud.api.rest.schema.OrgPasswordPolicySettingsType orgPasswordPolicySettingsType)
                                                                                             throws VCloudException

Updates the organization password policy settings.

Parameters:

orgPasswordPolicySettingsType - OrgPasswordPolicySettingsType - password policy settings.

Returns:

OrgPasswordPolicySettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 1.5

updateAdminOrg

public AdminOrganization updateAdminOrg(com.vmware.vcloud.api.rest.schema.AdminOrgType adminOrgType)
                                 throws VCloudException

Updating the Admin Organization

Parameters:

adminOrgType - AdminOrgType

Returns:

AdminOrganization

Throws:

VCloudException

delete

public void delete()
            throws VCloudException,
                   TimeoutException

Delete Admin Organization for version till 5.6, added support for Higher version backward compatibility is maintained since a task is waited for and not returned.

Throws:

VCloudException

TimeoutException

deleteAdminOrg

public Task deleteAdminOrg(boolean force,
                           boolean recrusive)
                    throws VCloudException

Delete Admin Organization for version greater than 5.6.

Parameters:

force - Boolean - delete operation to forcibly remove the entity.

recrusive - Boolean - delete operation to remove child objects

Throws:

VCloudException

delete

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

Static Delete Admin Organization for version till 5.6

Parameters:

client - vCloud Client VcloudClient

adminOrgRef - Admin Organization Ref

Throws:

VCloudException

enable

public void enable()
            throws VCloudException

Enable the Organization

Throws:

VCloudException

enable

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

Enable the Organization

Parameters:

client - VcloudClient

orgRef -

Throws:

VCloudException

disable

public void disable()
             throws VCloudException

Disable the Organization

Throws:

VCloudException

disable

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

Disable the Organization

Parameters:

client - VcloudClient

adminOrgRef -

Throws:

VCloudException

getUserRefsByName

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

Returns User References By Name

Returns:

HashMap

getUserRefs

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

Returns User References

Returns:

Collection

getUserRefByName

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

Returns the user reference by name

Parameters:

name -

Returns:

ReferenceType

getGroupRefsByName

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

Returns Group References By Name

Returns:

HashMap

getGroupRefs

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

Returns Group References

Returns:

Collection

getGroupRefByName

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

Returns the group reference by name

Parameters:

name -

Returns:

ReferenceType

getCatalogRefs

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

Returns Catalog References

Returns:

Collection

getAdminVdcRefsByName

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

Returns Vdc References By Name. For System/Cloud Administrators, this method returns Admin Vdc references which can be used in AdminVdc.getAdminVdcByReference(VcloudClient, ReferenceType) For Organization/Tenant Administrators/Users this method returns Vdc references which can be used in Vdc#getVdcByReference(VcloudClient, ReferenceType)

Returns:

HashMap

getAdminVdcRefs

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

Returns Vdc References. For System/Cloud Administrators, this method returns Admin Vdc references which can be used in AdminVdc.getAdminVdcByReference(VcloudClient, ReferenceType) For Organization/Tenant Administrators/Users this method returns Vdc references which can be used in Vdc#getVdcByReference(VcloudClient, ReferenceType)

Returns:

Collection

getAdminVdcRefByName

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

Returns the admin vdc reference by name For System/Cloud Administrators, this method returns an Admin Vdc reference which can be used in AdminVdc.getAdminVdcByReference(VcloudClient, ReferenceType) For Organization/Tenant Administrators/Users this method returns a Vdc reference which can be used in Vdc#getVdcByReference(VcloudClient, ReferenceType)

Parameters:

name -

Returns:

ReferenceType

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 org Network 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()).getNetworks() 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 org Network 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()).getNetworks() 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()).getNetworks() and get the complete list of network references.

Parameters:

name -

Returns:

ReferenceType

createEvent

public void createEvent(com.vmware.vcloud.api.rest.schema.EventType eventType)
                 throws VCloudException

Creating custom events.

Parameters:

eventType - - EventType

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

getGuestPersonalizationSettings

public com.vmware.vcloud.api.rest.schema.OrgGuestPersonalizationSettingsType getGuestPersonalizationSettings()
                                                                                                      throws VCloudException

Retrieves the organization guest personlization settings

Returns:

OrgGuestPersonalizationSettingsType

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

getOperationLimitsSettings

public com.vmware.vcloud.api.rest.schema.OrgOperationLimitsSettingsType getOperationLimitsSettings()
                                                                                            throws VCloudException

Retrieves the organization operation limit settings

Returns:

OrgOperationLimitsSettingsType

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

updateGuestPersonalizationSettings

public com.vmware.vcloud.api.rest.schema.OrgGuestPersonalizationSettingsType updateGuestPersonalizationSettings(com.vmware.vcloud.api.rest.schema.OrgGuestPersonalizationSettingsType orgGuestPersonalizationSettingsType)
                                                                                                         throws VCloudException

Updates the organization guest personalization settings.

Parameters:

orgGuestPersonalizationSettingsType - OrgGuestPersonalizationSettingsType - guest personalization settings.

Returns:

OrgGuestPersonalizationSettingsType

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

updateOperationLimitsSettings

public com.vmware.vcloud.api.rest.schema.OrgOperationLimitsSettingsType updateOperationLimitsSettings(com.vmware.vcloud.api.rest.schema.OrgOperationLimitsSettingsType operationLimitsSettingsType)
                                                                                               throws VCloudException

Updates the organization operation limit settings.

Parameters:

operationLimitsSettingsType - OrgOperationLimitsSettingsType - operation limit settings.

Returns:

OrgOperationLimitsSettingsType

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

getLdapSettings

public com.vmware.vcloud.api.rest.schema.OrgLdapSettingsType getLdapSettings()
                                                                      throws VCloudException

Deprecated. API 5.1, SDK 5.1

Retrieves the organization OrgLdapSettings

Returns:

OrgLdapSettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 5.1

getLdapSettings

public static com.vmware.vcloud.api.rest.schema.OrgLdapSettingsType getLdapSettings(VcloudClient client,
                                                                                    com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference)
                                                                             throws VCloudException

Deprecated. API 5.1, SDK 5.1

Retrieves the organization OrgLdapSettings

Parameters:

client - VcloudClient

adminOrgReference - ReferenceType

Returns:

OrgLdapSettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 5.1

UpdateLdapSettings

public com.vmware.vcloud.api.rest.schema.OrgLdapSettingsType UpdateLdapSettings(com.vmware.vcloud.api.rest.schema.OrgLdapSettingsType orgLdapSettingsType)
                                                                         throws VCloudException

Deprecated. API 5.1, SDK 5.1

Update Ldap Settings

Parameters:

orgLdapSettingsType -

Returns:

OrgLdapSettingsType

Throws:

VCloudException

Since:

API 1.5, SDK 5.1

resetLdapCertificate

public void resetLdapCertificate()
                          throws VCloudException

Resets organization LDAP SSL certificate

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

resetLdapKeyStore

public void resetLdapKeyStore()
                       throws VCloudException

Resets organization LDAP keystore

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

resetLdapSspiKeytab

public void resetLdapSspiKeytab()
                         throws VCloudException

Resets organization LDAP SSPI key tab.

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

updateLdapCertificate

public com.vmware.vcloud.api.rest.schema.CertificateUploadSocketType updateLdapCertificate(com.vmware.vcloud.api.rest.schema.CertificateUpdateParamsType certificateUpdateParamsType)
                                                                                    throws VCloudException

Updates organization LDAP SSL certificate.

Parameters:

certificateUpdateParamsType - CertificateUpdateParamsType

Returns:

CertificateUploadSocketType

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

updateLdapKeyStore

public com.vmware.vcloud.api.rest.schema.KeystoreUploadSocketType updateLdapKeyStore(com.vmware.vcloud.api.rest.schema.KeystoreUpdateParamsType keystoreUpdateParamsType)
                                                                              throws VCloudException

Updates organization LDAP keystore.

Parameters:

keystoreUpdateParamsType - KeystoreUpdateParamsType

Returns:

KeystoreUploadSocketType

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

updateLdapSspiKeytab

public com.vmware.vcloud.api.rest.schema.SspiKeytabUploadSocketType updateLdapSspiKeytab(com.vmware.vcloud.api.rest.schema.SspiKeytabUpdateParamsType sspiKeytabUpdateParamsType)
                                                                                  throws VCloudException

Updates organization LDAP SSPI keytab.

Parameters:

sspiKeytabUpdateParamsType - SspiKeytabUpdateParamsType

Returns:

SspiKeytabUploadSocketType

Throws:

VCloudException

Since:

API 5.1, SDK 5.1

regenerateFederationCertificate

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

Regenerates the certificates used to establish trust between an organization and its identity provider

Throws:

VCloudException

Since:

API 5.6, SDK 5.6

regenerateFederationCertificate

public void regenerateFederationCertificate()
                                     throws VCloudException

Regenerates the certificates used to establish trust between an organization and its identity provider

Parameters:

client - - VcloudClient

adminOrgReference - - ReferenceType to the admin organization

Throws:

VCloudException

Since:

API 5.6, SDK 5.6

createOrgAssociation

public Task createOrgAssociation(com.vmware.vcloud.api.rest.schema.OrgAssociationType orgAssociation)
                          throws VCloudException

Adds a new member to organization's associations.

Parameters:

OrgAssociationType - - ReferenceType to the admin organization

Returns:

TaskType

Throws:

VCloudException

Since:

API 5.7, SDK 5.7

getOrgAssociations

public com.vmware.vcloud.api.rest.schema.OrgAssociationsType getOrgAssociations()

Retrieves the complete list of Organizations associated with this organization

Returns:

OrgAssociationsType

Since:

API 5.7, SDK 5.7

getOrgAssociations

public static com.vmware.vcloud.api.rest.schema.OrgAssociationsType getOrgAssociations(VcloudClient client,
                                                                                       com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference)
                                                                                throws VCloudException

Retrieves the complete list of Organizations associated with this organization

Parameters:

client - - VcloudClient

ReferenceType - - ReferenceType to the admin organization

Returns:

OrgAssociationsType

Throws:

VCloudException

Since:

API 5.7, SDK 5.7

updateOrgAssociations

public Task updateOrgAssociations(com.vmware.vcloud.api.rest.schema.OrgAssociationsType orgAssociations)
                           throws VCloudException

Replaces the organization's current list of association members with the specified list of members If the list is empty, all existing members will be deleted.

Parameters:

OrgAssociationsType - - ReferenceType to the admin organizations

Returns:

TaskType

Throws:

VCloudException

Since:

API 5.7, SDK 5.7

getOrgAssociationByName

public com.vmware.vcloud.api.rest.schema.OrgAssociationType getOrgAssociationByName(String memberName)
                                                                             throws VCloudException

Retrieves a specific member from the organization's associations as identified by OrgAssociation Name included in the request

Parameters:

String - - memberName

Returns:

OrgAssociationType

Throws:

VCloudException

Since:

API 5.7, SDK 5.7

deleteOrgAssociationByName

public Task deleteOrgAssociationByName(String memberName)
                                throws VCloudException

Removes the specified member from this organization's associations.

Parameters:

String - - memberName

Returns:

TaskType

Throws:

VCloudException

Since:

API 5.7, SDK 5.7

getOrgOAuthSettings

public static com.vmware.vcloud.api.rest.schema.OrgOAuthSettingsType getOrgOAuthSettings(VcloudClient client,
                                                                                         com.vmware.vcloud.api.rest.schema.ReferenceType adminOrgReference)
                                                                                  throws VCloudException

Retrieves the organization Oauth settings

Parameters:

client - - VcloudClient

adminOrgReference - - ReferenceType to the admin organization

Returns:

OrgOAuthSettingsType

Throws:

VCloudException

Since:

API 9.0, SDK 8.0

updateOrgOauthSettings

public com.vmware.vcloud.api.rest.schema.OrgOAuthSettingsType updateOrgOauthSettings(com.vmware.vcloud.api.rest.schema.OrgOAuthSettingsType orgOAuthSettings)
                                                                              throws VCloudException

Update organization OAuth settings.

Parameters:

OrgOAuthSettingsType - orgOAuthSettings - organization OAuth settings.

Returns:

OrgOAuthSettingsType

Throws:

VCloudException

Since:

API 9.0, SDK 8.0

createOrgSelectorExtension

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

Creates a Selector Extension for selector org.

Parameters:

SelectorExtensionType -

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

getOrgSelectorExtension

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

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

Returns:

List SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

getOrgSelectorExtensionById

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

Retrieves a Selector Extensions that is associated with this Org.

Parameters:

string - selectorExtensionId

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

updateOrgSelectorExtensionById

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

Updates a Selector Extensions that is associated with this Org.

Parameters:

SelectorExtensionType - SelectorExtensionType

String - SelectorExtensionId

Returns:

SelectorExtensionType

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10

deleteOrgSelectorExtensionById

public void deleteOrgSelectorExtensionById(String selectorExtensionId)
                                    throws VCloudException

Deletes a Selector Extensions that is associated with this Org.

Parameters:

String - SelectorExtensionId

Throws:

VCloudException

Since:

API Version 20.0, SDK Version 8.10