Class

VMware_VCloud_SDK_Extension

class VMware_VCloud_SDK_Extension extends VMware_VCloud_SDK_Abstract

Methods

string getEntityId()

Get vCloud ID of the vCloud resource entity from its data object.

from VMware_VCloud_SDK_Abstract
__construct($svc)

Constructor

VMware_VCloud_API_Extension_VMWExtensionType getExtension()

Get the VMware vCloud admin extension entry point.

array getHostRefs(string $name = null)

Get the references to all the hosts.

array getHosts(string $name = null)

Get all hosts.

array getVimServerRefs(string $name = null)

Get references to VMware vim servers.

array getVimServers(string $name = null)

Get VMware vim server objects.

array getVMWProviderVdcRefs(string $name = null)

Get references to VMware provider vDCs.

array getVMWProviderVdcQueryRefs(string $name = null)

Get list of provider vDCs by using REST API general QueryHandler.

VMware_VCloud_API_Extension_AdminServiceType createService(VMware_VCloud_API_Extension_AdminServiceType $params)

Create a Extension service.

list getExtensionService()

Get a Extension service.

array getVMWProviderVdcs(string $name = null)

Get VMware provider vDC objects.

array getVMWExternalNetworkRefs(string $name = null)

Get references to VMware external network.

array getVMWExternalNetworks(string $name = null)

Get external network objects.

array getVMWNetworkPoolRefs(string $name = null)

Get references to VMware network pools.

array getVMWNetworkPools(string $name = null)

Get VMware network pool objects.

array getDatastoreRefs(string $name = null)

Get the references of data stores.

array getDatastores(string $name = null)

Get the data store objects.

array getBlockingTaskRefs()

Get the references of the blocking tasks.

array getBlockingTasks()

Get the blocking tasks objects.

array getLicensingReportRefs()

Get the references of the licensing report objects.

array getLicensingReports()

Get the licensing report objects.

VMware_VCloud_API_Extension_VMWProviderVdcType createVMWProviderVdc(VMware_VCloud_API_Extension_VMWProviderVdcType $providerVdc)

Create a provider vDC.

VMware_VCloud_API_Extension_VMWProviderVdcType createProviderVdc(VMware_VCloud_API_Extension_VMWProviderVdcParamsType $params)

Create a provider vDC.

VMware_VCloud_API_Extension_VMWExternalNetworkType createVMWExternalNetwork(VMware_VCloud_API_Extension_VMWExternalNetworkType $externalNet)

Create an external network.

VMware_VCloud_API_Extension_PortGroupPoolType createVMWNetworkPool(VMware_VCloud_API_Extension_PortGroupPoolType $vmwNetPool)

Create a network pool.

VMware_VCloud_API_Extension_RegisterVimServerParamsType registerVimServer(VMware_VCloud_API_Extension_RegisterVimServerParamsType $params)

Register a Vim Server and a vShield manager.

VMware_VCloud_API_TaskType unregisterVimServer(VMware_VCloud_API_ReferenceType $vimServerRef, boolean $disable = true)

Unregister Vim Server and vShield manager.

VMware_VCloud_API_Extension_SystemSettingsType getSystemSettings()

Retrieves the system settings.

VMware_VCloud_API_Extension_SystemSettingsType updateSystemSettings(VMware_VCloud_API_Extension_SystemSettingsType $settings)

Updates the system settings.

VMware_VCloud_API_Extension_AmqpSettingsType getAmqpSettings()

Retrieves the AMQP settings.

VMware_VCloud_API_Extension_AmqpSettingsType updateAmqpSettings(VMware_VCloud_API_Extension_AmqpSettingsType $settings)

Updates the AMQP settings.

resetAmqpCertificate()

Resets AMQP certificate.

resetAmqpTruststore()

Resets AMQP truststore.

VMware_VCloud_API_CertificateUploadSocketType updateAmqpCertificate(VMware_VCloud_API_CertificateUpdateParamsType $params)

Updates AMQP certificate.

VMware_VCloud_API_TrustStoreUploadSocketType updateAmqpTruststore(VMware_VCloud_API_TrustStoreUpdateParamsType $params)

Updates AMQP trust store.

boolean testAmqpConnection(VMware_VCloud_API_Extension_AmqpSettingsType $settings)

Tests the AMQP connection.

VMware_VCloud_API_Extension_BlockingTaskSettingsType getBlockingTaskSettings()

Returns global blocking task settings.

VMware_VCloud_API_Extension_BlockingTaskSettingsType updateBlockingTaskSettings(VMware_VCloud_API_Extension_BlockingTaskSettingsType $settings)

Updates global blocking task settings.

VMware_VCloud_API_TaskOperationListType getEnabledBlockingTaskOperations()

Gets blocking task operations which are enabled.

VMware_VCloud_API_TaskOperationListType updateEnabledBlockingTaskOperations(VMware_VCloud_API_TaskOperationListType $list)

Updates the blocking task operations which are enabled.

VMware_VCloud_API_Extension_BrandingSettingsType getBrandingSettings()

Retrieves the product branding settings.

VMware_VCloud_API_Extension_BrandingSettingsType updateBrandingSettings(VMware_VCloud_API_Extension_BrandingSettingsType $settings)

Updates the product branding settings.

VMware_VCloud_API_Extension_EmailSettingsType getEmailSettings()

Retrieves the email related settings.

VMware_VCloud_API_Extension_EmailSettingsType updateEmailSettings(VMware_VCloud_API_Extension_EmailSettingsType $settings)

Updates email related settings.

VMware_VCloud_API_Extension_GeneralSettingsType getGeneralSettings()

Retrieves the general settings.

VMware_VCloud_API_Extension_GeneralSettingsType updateGeneralSettings(VMware_VCloud_API_Extension_GeneralSettingsType $settings)

Updates the general settings.

resetVcTrustsore()

Resets vCenter trust store.

VMware_VCloud_API_Extension_VcTrustStoreUploadSocketType updateVcTrustsore(VMware_VCloud_API_Extension_VcTrustStoreUpdateParamsType $params)

Updates vCenter trust store.

VMware_VCloud_API_Extension_LdapSettingsType getLdapSettings()

Retrieves the LDAP settings.

VMware_VCloud_API_Extension_LdapSettingsType updateLdapSettings(VMware_VCloud_API_Extension_LdapSettingsType $settings)

Updates the LDAP settings.

resetLdapCertificate()

Resets system LDAP SSL certificate.

resetLdapKeyStore()

Resets system LDAP keystore.

resetLdapSspiKeytab()

Resets system LDAP SSPI key tab.

VMware_VCloud_API_CertificateUploadSocketType updateLdapCertificate(VMware_VCloud_API_CertificateUpdateParamsType $params)

Updates system LDAP SSL certificate.

VMware_VCloud_API_KeystoreUploadSocketType updateLdapKeyStore(VMware_VCloud_API_KeystoreUpdateParamsType $params)

Updates system LDAP keystore.

VMware_VCloud_API_SspiKeytabUploadSocketType updateLdapSspiKeytab(VMware_VCloud_API_SspiKeytabUpdateParamsType $params)

Updates system LDAP SSPI key tab.

VMware_VCloud_API_Extension_LicenseType getLicenseSettings()

Retrieves the license settings.

VMware_VCloud_API_Extension_LicenseType updateLicenseSettings(VMware_VCloud_API_Extension_LicenseType $settings)

Updates the license settings.

VMware_VCloud_API_Extension_NotificationsSettingsType getNotificationsSettings()

Retrieves the notifications settings.

VMware_VCloud_API_Extension_NotificationsSettingsType updateNotificationsSettings(VMware_VCloud_API_Extension_NotificationsSettingsType $settings)

Updates the notifications settings.

boolean isNotificationEnabled()

Checks non-blocking extensions is enabled or not.

VMware_VCloud_API_Extension_NotificationsSettingsType enableNotification($enable = true)

Enables non-blocking extensions.

VMware_VCloud_API_Extension_NotificationsSettingsType disableNotification()

Disables non-blocking extensions.

VMware_VCloud_API_Extension_SystemPasswordPolicySettingsType getPasswordPolicySettings()

Retrieves the password policy settings at the system level.

VMware_VCloud_API_Extension_SystemPasswordPolicySettingsType updatePasswordPolicySettings(VMware_VCloud_API_Extension_SystemPasswordPolicySettingsType $settings)

Updates the system password policy settings.

VMware_VCloud_API_Extension_KerberosSettingsType getKerberosSettings()

Retrieves the kerberos settings.

VMware_VCloud_API_Extension_KerberosSettingsType updateKerberosSettings(VMware_VCloud_API_Extension_KerberosSettingsType $settings)

Updates the system kerberos settings.

VMware_VCloud_API_Extension_LookupServiceSettingsType getLookUpServiceSettings()

Retrieves the lookupService settings.

VMware_VCloud_API_Extension_TaskType updateLookUpServiceSettings(VMware_VCloud_API_Extension_LookupServiceParamsType $settings)

Register / unregister Lookup Service to / from vCD.

VMware_VCloud_API_Extension_CatalogSettingsType getCatalogSettings()

Retrieve vCloud Director catalog setting details.

VMware_VCloud_API_Extension_CatalogSettingsType updateCatalogSettings(VMware_VCloud_API_Extension_CatalogSettingsType $settings)

Update catalog settings details.

VMware_VCloud_API_Extension_StrandedItemType getStrandedItems()

Gets the representation of a strandedItem.

null clearUnusedRights()

Clears all the rights that are not associated with a role or acl rule and which extension service is already deleted.

null clearUnusedLocalizationBundles()

Cleanup for unused external localization resources.

boolean isAuthorized(VMware_VCloud_API_Extension_AuthorizationCheckParamsType $params)

Checks user authorization for all services with enabled authorization, URL and request verb.

VMware_VCloud_API_Extension_BundleUploadSocketType initiatesLocalizationBundles(VMware_VCloud_API_Extension_BundleUploadParamsType $params)

Initiates localization bundle upload.

VMware_VCloud_API_ReferenceType getQueryExtensionServices()

Retrieve extension services query.

Details

public string getEntityId()

Get vCloud ID of the vCloud resource entity from its data object.

Return Value

string

at line 7
public __construct($svc)

Constructor

Parameters

$svc

at line 18
public VMware_VCloud_API_Extension_VMWExtensionType getExtension()

Get the VMware vCloud admin extension entry point.

at line 30
public array getHostRefs(string $name = null)

Get the references to all the hosts.

Parameters

string $name Name of the host to get. If null, returns all

Return Value

array VMwareVCloudAPI_ReferenceType object array

at line 45
public array getHosts(string $name = null)

Get all hosts.

Parameters

string $name Name of the host. If null, returns all

Return Value

array VMwareVCloudAPIExtensionHostType object array

at line 58
public array getVimServerRefs(string $name = null)

Get references to VMware vim servers.

Parameters

string $name Name of the vim server to get. If null, returns all

Return Value

array VMwareVCloudAPI_ReferenceType object array

at line 74
public array getVimServers(string $name = null)

Get VMware vim server objects.

Parameters

string $name Name of the vim server to get. If null, returns all.

Return Value

array VMwareVCloudAPIExtensionVimServerType object array.

at line 88
public array getVMWProviderVdcRefs(string $name = null)

Get references to VMware provider vDCs.

Parameters

string $name Name of the VMware provider vDC to get. If null, returns all.

Return Value

array VMwareVCloudAPI_ReferenceType object array.

at line 104
public array getVMWProviderVdcQueryRefs(string $name = null)

Get list of provider vDCs by using REST API general QueryHandler.

This is read only list and is not bound to specific states. If filter is provided it will be applied to the corresponding result set. Format determines the elements representation - references, records or idrecords. Default format is records.

Parameters

string $name Name of the VMware provider vDC query to get. If null, returns all.

Return Value

array VMwareVCloudAPI_ReferenceType object array.

at line 117
public VMware_VCloud_API_Extension_AdminServiceType createService(VMware_VCloud_API_Extension_AdminServiceType $params)

Create a Extension service.

at line 131
public list getExtensionService()

Get a Extension service.

Return Value

list of all the extension services.

at line 146
public array getVMWProviderVdcs(string $name = null)

Get VMware provider vDC objects.

Parameters

string $name Name of the VMware provider vDC to get. If null, returns all

Return Value

array VMwareVCloudAPIExtensionVMWProviderVdcType objects array

at line 161
public array getVMWExternalNetworkRefs(string $name = null)

Get references to VMware external network.

Parameters

string $name Name of the VMware external network to get. If null, returns all

Return Value

array VMwareVCloudAPI_ReferenceType object array

at line 178
public array getVMWExternalNetworks(string $name = null)

Get external network objects.

Parameters

string $name Name of the external network to get. If null, returns all

Return Value

array VMwareVCloudAPIExtensionVMWExternalNetworkType object array

at line 192
public array getVMWNetworkPoolRefs(string $name = null)

Get references to VMware network pools.

Parameters

string $name Name of the VMware network pool. If null, returns all

Return Value

array VMwareVCloudAPI_ReferenceType object array

at line 208
public array getVMWNetworkPools(string $name = null)

Get VMware network pool objects.

Parameters

string $name Name of the VMware network pool. If null, returns all

Return Value

array VMwareVCloudAPIExtensionVMWNetworkPoolType object array.

at line 221
public array getDatastoreRefs(string $name = null)

Get the references of data stores.

Parameters

string $name Name of the data store to get. If null, returns all

Return Value

array VMwareVCloudAPI_ReferenceType object array

at line 236
public array getDatastores(string $name = null)

Get the data store objects.

Parameters

string $name Name of the data store to get. If null, returns all.

Return Value

array VMwareVCloudAPIExtensionDatastoreType object array.

at line 248
public array getBlockingTaskRefs()

Get the references of the blocking tasks.

Return Value

array VMwareVCloudAPI_ReferenceType object array

at line 262
public array getBlockingTasks()

Get the blocking tasks objects.

Return Value

array VMwareVCloudAPIExtensionBlockingTaskType object array.

at line 275
public array getLicensingReportRefs()

Get the references of the licensing report objects.

Return Value

array VMwareVCloudAPI_LinkType object array

at line 289
public array getLicensingReports()

Get the licensing report objects.

Return Value

array VMwareVCloudAPIExtensionLicensingReportType object array

at line 303
public VMware_VCloud_API_Extension_VMWProviderVdcType createVMWProviderVdc(VMware_VCloud_API_Extension_VMWProviderVdcType $providerVdc)

Create a provider vDC.

at line 317
public VMware_VCloud_API_Extension_VMWProviderVdcType createProviderVdc(VMware_VCloud_API_Extension_VMWProviderVdcParamsType $params)

at line 331
public VMware_VCloud_API_Extension_VMWExternalNetworkType createVMWExternalNetwork(VMware_VCloud_API_Extension_VMWExternalNetworkType $externalNet)

Create an external network.

at line 349
public VMware_VCloud_API_Extension_PortGroupPoolType createVMWNetworkPool(VMware_VCloud_API_Extension_PortGroupPoolType $vmwNetPool)

Create a network pool.

Parameters

VMware_VCloud_API_Extension_PortGroupPoolType $vmwNetPool | VMwareVCloudAPIExtensionVlanPoolType | VMwareVCloudAPIExtensionFencePoolType $vmwNetPool

Return Value

VMware_VCloud_API_Extension_PortGroupPoolType | VMwareVCloudAPIExtensionVlanPoolType | VMwareVCloudAPIExtensionFencePoolType

at line 363
public VMware_VCloud_API_Extension_RegisterVimServerParamsType registerVimServer(VMware_VCloud_API_Extension_RegisterVimServerParamsType $params)

Register a Vim Server and a vShield manager.

at line 382
public VMware_VCloud_API_TaskType unregisterVimServer(VMware_VCloud_API_ReferenceType $vimServerRef, boolean $disable = true)

Unregister Vim Server and vShield manager.

Parameters

VMware_VCloud_API_ReferenceType $vimServerRef Reference to the vim server to be unregistered
boolean $disable Indicates whether disable the vim server first.

Return Value

VMware_VCloud_API_TaskType

Exceptions

VMware_VCloud_SDK_Exception

at line 411
public VMware_VCloud_API_Extension_SystemSettingsType getSystemSettings()

Retrieves the system settings.

at line 424
public VMware_VCloud_API_Extension_SystemSettingsType updateSystemSettings(VMware_VCloud_API_Extension_SystemSettingsType $settings)

Updates the system settings.

at line 437
public VMware_VCloud_API_Extension_AmqpSettingsType getAmqpSettings()

Retrieves the AMQP settings.

at line 450
public VMware_VCloud_API_Extension_AmqpSettingsType updateAmqpSettings(VMware_VCloud_API_Extension_AmqpSettingsType $settings)

Updates the AMQP settings.

at line 462
public resetAmqpCertificate()

Resets AMQP certificate.

at line 473
public resetAmqpTruststore()

Resets AMQP truststore.

at line 485
public VMware_VCloud_API_CertificateUploadSocketType updateAmqpCertificate(VMware_VCloud_API_CertificateUpdateParamsType $params)

Updates AMQP certificate.

AMQP certificate and trust store are mutually exclusive. Overrides AMQP trust store, if update is successful.

at line 498
public VMware_VCloud_API_TrustStoreUploadSocketType updateAmqpTruststore(VMware_VCloud_API_TrustStoreUpdateParamsType $params)

Updates AMQP trust store.

AMQP certificate and trust store are mutually exclusive. Overrides AMQP certificate, if update is successful.

at line 511
public boolean testAmqpConnection(VMware_VCloud_API_Extension_AmqpSettingsType $settings)

Tests the AMQP connection.

Parameters

VMware_VCloud_API_Extension_AmqpSettingsType $settings

Return Value

boolean

at line 525
public VMware_VCloud_API_Extension_BlockingTaskSettingsType getBlockingTaskSettings()

Returns global blocking task settings.

at line 538
public VMware_VCloud_API_Extension_BlockingTaskSettingsType updateBlockingTaskSettings(VMware_VCloud_API_Extension_BlockingTaskSettingsType $settings)

Updates global blocking task settings.

at line 552
public VMware_VCloud_API_TaskOperationListType getEnabledBlockingTaskOperations()

Gets blocking task operations which are enabled.

at line 565
public VMware_VCloud_API_TaskOperationListType updateEnabledBlockingTaskOperations(VMware_VCloud_API_TaskOperationListType $list)

Updates the blocking task operations which are enabled.

at line 579
public VMware_VCloud_API_Extension_BrandingSettingsType getBrandingSettings()

Retrieves the product branding settings.

at line 592
public VMware_VCloud_API_Extension_BrandingSettingsType updateBrandingSettings(VMware_VCloud_API_Extension_BrandingSettingsType $settings)

Updates the product branding settings.

at line 605
public VMware_VCloud_API_Extension_EmailSettingsType getEmailSettings()

Retrieves the email related settings.

at line 618
public VMware_VCloud_API_Extension_EmailSettingsType updateEmailSettings(VMware_VCloud_API_Extension_EmailSettingsType $settings)

Updates email related settings.

at line 631
public VMware_VCloud_API_Extension_GeneralSettingsType getGeneralSettings()

Retrieves the general settings.

at line 644
public VMware_VCloud_API_Extension_GeneralSettingsType updateGeneralSettings(VMware_VCloud_API_Extension_GeneralSettingsType $settings)

Updates the general settings.

at line 656
public resetVcTrustsore()

Resets vCenter trust store.

at line 669
public VMware_VCloud_API_Extension_VcTrustStoreUploadSocketType updateVcTrustsore(VMware_VCloud_API_Extension_VcTrustStoreUpdateParamsType $params)

at line 683
public VMware_VCloud_API_Extension_LdapSettingsType getLdapSettings()

Retrieves the LDAP settings.

at line 697
public VMware_VCloud_API_Extension_LdapSettingsType updateLdapSettings(VMware_VCloud_API_Extension_LdapSettingsType $settings)

Updates the LDAP settings.

at line 709
public resetLdapCertificate()

Resets system LDAP SSL certificate.

at line 720
public resetLdapKeyStore()

Resets system LDAP keystore.

at line 731
public resetLdapSspiKeytab()

Resets system LDAP SSPI key tab.

at line 744
public VMware_VCloud_API_CertificateUploadSocketType updateLdapCertificate(VMware_VCloud_API_CertificateUpdateParamsType $params)

Updates system LDAP SSL certificate.

at line 758
public VMware_VCloud_API_KeystoreUploadSocketType updateLdapKeyStore(VMware_VCloud_API_KeystoreUpdateParamsType $params)

Updates system LDAP keystore.

at line 772
public VMware_VCloud_API_SspiKeytabUploadSocketType updateLdapSspiKeytab(VMware_VCloud_API_SspiKeytabUpdateParamsType $params)

Updates system LDAP SSPI key tab.

at line 785
public VMware_VCloud_API_Extension_LicenseType getLicenseSettings()

Retrieves the license settings.

at line 798
public VMware_VCloud_API_Extension_LicenseType updateLicenseSettings(VMware_VCloud_API_Extension_LicenseType $settings)

Updates the license settings.

at line 811
public VMware_VCloud_API_Extension_NotificationsSettingsType getNotificationsSettings()

Retrieves the notifications settings.

at line 824
public VMware_VCloud_API_Extension_NotificationsSettingsType updateNotificationsSettings(VMware_VCloud_API_Extension_NotificationsSettingsType $settings)

Updates the notifications settings.

at line 837
public boolean isNotificationEnabled()

Checks non-blocking extensions is enabled or not.

Return Value

boolean

at line 849
public VMware_VCloud_API_Extension_NotificationsSettingsType enableNotification($enable = true)

Enables non-blocking extensions.

at line 862
public VMware_VCloud_API_Extension_NotificationsSettingsType disableNotification()

Disables non-blocking extensions.

at line 873
public VMware_VCloud_API_Extension_SystemPasswordPolicySettingsType getPasswordPolicySettings()

Retrieves the password policy settings at the system level.

at line 886
public VMware_VCloud_API_Extension_SystemPasswordPolicySettingsType updatePasswordPolicySettings(VMware_VCloud_API_Extension_SystemPasswordPolicySettingsType $settings)

Updates the system password policy settings.

at line 900
public VMware_VCloud_API_Extension_KerberosSettingsType getKerberosSettings()

Retrieves the kerberos settings.

at line 913
public VMware_VCloud_API_Extension_KerberosSettingsType updateKerberosSettings(VMware_VCloud_API_Extension_KerberosSettingsType $settings)

Updates the system kerberos settings.

at line 926
public VMware_VCloud_API_Extension_LookupServiceSettingsType getLookUpServiceSettings()

Retrieves the lookupService settings.

at line 940
public VMware_VCloud_API_Extension_TaskType updateLookUpServiceSettings(VMware_VCloud_API_Extension_LookupServiceParamsType $settings)

Register / unregister Lookup Service to / from vCD.

In LookupServiceParamsType 1. If LookupServiceUrl is set and not empty, the action is for register lookup service. 2. If LookupServiceUrl is unset or empty, the action is for unregister lookup service.

Parameters

VMware_VCloud_API_Extension_LookupServiceParamsType $settings

Return Value

VMware_VCloud_API_Extension_TaskType

at line 954
public VMware_VCloud_API_Extension_CatalogSettingsType getCatalogSettings()

Retrieve vCloud Director catalog setting details.

at line 968
public VMware_VCloud_API_Extension_CatalogSettingsType updateCatalogSettings(VMware_VCloud_API_Extension_CatalogSettingsType $settings)

Update catalog settings details.

at line 981
public VMware_VCloud_API_Extension_StrandedItemType getStrandedItems()

Gets the representation of a strandedItem.

at line 993
public null clearUnusedRights()

Clears all the rights that are not associated with a role or acl rule and which extension service is already deleted.

Return Value

null

at line 1005
public null clearUnusedLocalizationBundles()

Cleanup for unused external localization resources.

Return Value

null

at line 1017
public boolean isAuthorized(VMware_VCloud_API_Extension_AuthorizationCheckParamsType $params)

Checks user authorization for all services with enabled authorization, URL and request verb.

Parameters

VMware_VCloud_API_Extension_AuthorizationCheckParamsType $params

Return Value

boolean

at line 1032
public VMware_VCloud_API_Extension_BundleUploadSocketType initiatesLocalizationBundles(VMware_VCloud_API_Extension_BundleUploadParamsType $params)

Initiates localization bundle upload.

at line 1046
public VMware_VCloud_API_ReferenceType getQueryExtensionServices()

Retrieve extension services query.