Class

# VMware_VCloud_SDK_AdminOrg

class VMware_VCloud_SDK_AdminOrg 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
VMware_VCloud_API_ReferenceType | getAdminOrgRef() Get a reference to a VMware vCloud admin organization entity. |
VMware_VCloud_API_AdminOrgType | getAdminOrg() Get a VMware vCloud admin organization entity. |
string | getId() Constructs vCloud ID of this organization from its UUID. |
VMware_VCloud_API_LinkType|null | getOrgRef() Get a link to a VMware vCloud organization entity. |
VMware_VCloud_API_OrgType|null | getOrg() Get a VMware vCloud organization entity. |
VMware_VCloud_API_AdminOrgType | modify(VMware_VCloud_API_AdminOrgType $adminOrg) Modify a VMware vCloud admin organization. |
boolean | isEnabled() Check whether the organization is enabled. |
null | enable(boolean $enable = true) Enable the organization. |
null | disable() Disable the organization. |
null | delete() Delete the organization. |
VMware_VCloud_API_AdminVdcType | createAdminVdc(VMware_VCloud_API_AdminVdcType $adminVdc) Allocate a vDC to the organization. |
VMware_VCloud_API_AdminVdcType | createAdminOrgVdc(VMware_VCloud_API_CreateVdcParamsType $params) Create an organization vDC. |
VMware_VCloud_API_AdminCatalogType | createCatalog(VMware_VCloud_API_AdminCatalogType $catalog) Create a catalog. |
VMware_VCloud_API_UserType | createUser(VMware_VCloud_API_UserType $user) Create or import a user. |
VMware_VCloud_API_GroupType | importGroup(VMware_VCloud_API_GroupType $group) Import a group. |
VMware_VCloud_API_OrgNetworkType | addOrgNetwork(VMware_VCloud_API_OrgNetworkType $orgNetwork) Add a network in an organization. |
array | getUserRefs(string $name = null) Get reference(s) for all users or named user in this organization. |
array | getUsers(string $name = null) Get users. |
array | getGroupRefs(string $name = null) Get reference(s) for all groups or named group in this organization. |
array | getGroups(string $name = null) Get groups. |
array | getAdminCatalogRefs(string $name = null) Get references for all catalogs or named catalog in this organization. |
array | getAdminCatalogs(string $name = null) Get catalogs. |
array | getAdminVdcRefs(string $name = null) Get references for all vDCs or named vDC in this organization. |
array | getAdminVdcs(string $name = null) Get vDCs. |
array | getAdminNetworkRefs(string $name = null) Get reference(s) for all organization networks or organization networks with the given name in administrative representation. |
array | getAdminNetworks(string $name = null) Get organization networks entities or organization networks with the given name in administrative representation. |
VMware_VCloud_API_OrgSettingsType | getOrgSettings() Gets organizational settings for this organization. |
VMware_VCloud_API_OrgSettingsType | updateOrgSettings(VMware_VCloud_API_OrgSettingsType $settings) Updates organization settings for this organization. |
VMware_VCloud_API_OrgEmailSettingsType | getOrgEmailSettings() Gets email settings of this organization. |
VMware_VCloud_API_OrgEmailSettingsType | updateOrgEmailSettings(VMware_VCloud_API_OrgEmailSettingsType $settings) Updates organization email settings for this organization. |
VMware_VCloud_API_OrgFederationSettingsType | getOrgFederationSettings() Retrieve other organization settings. |
VMware_VCloud_API_OrgFederationSettingsType | updateOrgFederationSettings(VMware_VCloud_API_OrgFederationSettingsType $settings) Update other organization settings. |
VMware_VCloud_API_OrgPasswordPolicySettingsType | getOrgPasswordPolicySettings() Retrieves the password policy settings for the organization. |
VMware_VCloud_API_OrgPasswordPolicySettingsType | updateOrgPasswordPolicySettings(VMware_VCloud_API_OrgPasswordPolicySettingsType $settings) Updates the organization password policy settings. |
VMware_VCloud_API_OrgLeaseSettingsType | getOrgVAppLeaseSettings() Gets organization vApp lease settings on the level of vApp. |
VMware_VCloud_API_OrgLeaseSettingsType | updateOrgVAppLeaseSettings(VMware_VCloud_API_OrgLeaseSettingsType $settings) Updates organization vApp lease settings on the level of vApp. |
VMware_VCloud_API_OrgVAppTemplateLeaseSettingsType | getOrgVAppTemplateLeaseSettings() Gets organization vApp template lease settings on the level of vApp. |
VMware_VCloud_API_OrgVAppTemplateLeaseSettingsType | updateOrgVAppTemplateLeaseSettings(VMware_VCloud_API_OrgVAppTemplateLeaseSettingsType $settings) Updates organization vApp template lease settings on the level of vApp. |
VMware_VCloud_API_OrgGeneralSettingsType | getOrgGeneralSettings() Gets organization general settings. |
VMware_VCloud_API_OrgGeneralSettingsType | updateOrgGeneralSettings(VMware_VCloud_API_OrgGeneralSettingsType $settings) Updates organization general settings. |
VMware_VCloud_API_OrgLdapSettingsType | getOrgLdapSettings() Gets organization LDAP settings. |
VMware_VCloud_API_OrgLdapSettingsType | updateOrgLdapSettings(VMware_VCloud_API_OrgLdapSettingsType $settings) Updates organization LDAP settings. |
| resetLdapCertificate() Resets organization LDAP SSL certificate. |
| resetLdapKeyStore() Resets organization LDAP keystore. |
| resetLdapSspiKeytab() Resets organization LDAP keytab. |
VMware_VCloud_API_CertificateUploadSocketType | updateLdapCertificate(VMware_VCloud_API_CertificateUpdateParamsType $params) Updates organization LDAP SSL certificate. |
VMware_VCloud_API_KeystoreUploadSocketType | updateLdapKeyStore(VMware_VCloud_API_KeystoreUpdateParamsType $params) Updates organization LDAP keystore. |
VMware_VCloud_API_SspiKeytabUploadSocketType | updateLdapSspiKeytab(VMware_VCloud_API_SspiKeytabUpdateParamsType $params) Updates organization LDAP SSPI keytab. |
VMware_VCloud_API_MetadataType| | getMetadata(string $key = null, string $domain = null) Get metadata associated with the organization or metadata associated with the organization for the specified key in the specified domain. |
VMware_VCloud_API_TaskType | mergeMetadata(VMware_VCloud_API_MetadataType $meta) Merges the metadata for the organization with the information provided. |
VMware_VCloud_API_TaskType | setMetadataByKey(string $key, VMware_VCloud_API_MetadataValueType $value, string $domain = null) Sets the metadata for the particular key in the specified domain for the organization to the value provided. |
VMware_VCloud_API_TaskType | deleteMetadataByKey($key, $domain = null) Deletes the metadata for the particular key in the specified domain for the organization. |
VMware_VCloud_SDK_Org|null | getSdkOrg() Return an alternate SDK orgznization object. |
null | postExtEvent(VMware_VCloud_API_EventType $event) Posts external event to the system. |
VMware_VCloud_API_OrgGuestPersonalizationSettingsType | getGuestPersonalizationSettings() Retrieve organization defaults for guest personalization settings. |
VMware_VCloud_API_OrgGuestPersonalizationSettingsType | modifyGuestPersonalizationSettings(VMware_VCloud_API_OrgGuestPersonalizationSettingsType $settings) Modify organization defaults for guest personalization settings. |
VMware_VCloud_API_OrgOperationLimitsSettingsType | getOperationLimitsSettings() Retrieve organization operation limits settings. |
VMware_VCloud_API_OrgOperationLimitsSettingsType | modifyOperationLimitsSettings(VMware_VCloud_API_OrgOperationLimitsSettingsType $settings) Modify organization operation limits settings. |

## Details

###
in VMware_VCloud_SDK_Abstract at line 85
`public string getEntityId()`

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

#### Return Value

string |

###
at line 10
`public VMware_VCloud_API_ReferenceType getAdminOrgRef()`

Get a reference to a VMware vCloud admin organization entity.

#### Return Value

VMware_VCloud_API_ReferenceType |

###
at line 22
`public VMware_VCloud_API_AdminOrgType getAdminOrg()`

Get a VMware vCloud admin organization entity.

#### Return Value

VMware_VCloud_API_AdminOrgType |

###
at line 33
`public string getId()`

Constructs vCloud ID of this organization from its UUID.

#### Return Value

string |

###
at line 44
`public VMware_VCloud_API_LinkType|null getOrgRef()`

Get a link to a VMware vCloud organization entity.

#### Return Value

VMware_VCloud_API_LinkType|null |

###
at line 56
`public VMware_VCloud_API_OrgType|null getOrg()`

Get a VMware vCloud organization entity.

#### Return Value

VMware_VCloud_API_OrgType|null |

###
at line 69
`public VMware_VCloud_API_AdminOrgType modify(VMware_VCloud_API_AdminOrgType $adminOrg)`

Modify a VMware vCloud admin organization.

#### Parameters

VMware_VCloud_API_AdminOrgType | $adminOrg |

#### Return Value

VMware_VCloud_API_AdminOrgType |

###
at line 81
`public boolean isEnabled()`

Check whether the organization is enabled.

#### Return Value

boolean |

###
at line 93
`public null enable(boolean $enable = true)`

Enable the organization.

#### Parameters

boolean | $enable | To enable, set to true; to disable, set to false

#### Return Value

null |

###
at line 113
`public null disable()`

Disable the organization.

#### Return Value

null |

###
at line 124
`public null delete()`

Delete the organization.

#### Return Value

null |

###
at line 139
`public VMware_VCloud_API_AdminVdcType createAdminVdc(VMware_VCloud_API_AdminVdcType $adminVdc)`

Allocate a vDC to the organization.

#### Parameters

VMware_VCloud_API_AdminVdcType | $adminVdc |

#### Return Value

VMware_VCloud_API_AdminVdcType |

###
at line 153
`public VMware_VCloud_API_AdminVdcType createAdminOrgVdc(VMware_VCloud_API_CreateVdcParamsType $params)`

Create an organization vDC.

#### Parameters

VMware_VCloud_API_CreateVdcParamsType | $params |

#### Return Value

VMware_VCloud_API_AdminVdcType |

###
at line 167
`public VMware_VCloud_API_AdminCatalogType createCatalog(VMware_VCloud_API_AdminCatalogType $catalog)`

Create a catalog.

#### Parameters

VMware_VCloud_API_AdminCatalogType | $catalog |

#### Return Value

VMware_VCloud_API_AdminCatalogType |

###
at line 181
`public VMware_VCloud_API_UserType createUser(VMware_VCloud_API_UserType $user)`

Create or import a user.

#### Parameters

VMware_VCloud_API_UserType | $user |

#### Return Value

VMware_VCloud_API_UserType |

###
at line 195
`public VMware_VCloud_API_GroupType importGroup(VMware_VCloud_API_GroupType $group)`

Import a group.

#### Parameters

VMware_VCloud_API_GroupType | $group |

#### Return Value

VMware_VCloud_API_GroupType |

###
at line 210
`public VMware_VCloud_API_OrgNetworkType addOrgNetwork(VMware_VCloud_API_OrgNetworkType $orgNetwork)`

Add a network in an organization.

#### Parameters

VMware_VCloud_API_OrgNetworkType | $orgNetwork |

#### Return Value

VMware_VCloud_API_OrgNetworkType |

###
at line 224
`public array getUserRefs(string $name = null)`

Get reference(s) for all users or named user in this organization.

#### Parameters

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

#### Return Value

array | VMwareVCloudAPI_ReferenceType object array

###
at line 237
`public array getUsers(string $name = null)`

Get users.

#### Parameters

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

#### Return Value

array | VMwareVCloudAPI_UserType object array

###
at line 250
`public array getGroupRefs(string $name = null)`

Get reference(s) for all groups or named group in this organization.

#### Parameters

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

#### Return Value

array | VMwareVCloudAPI_ReferenceType object array

###
at line 263
`public array getGroups(string $name = null)`

Get groups.

#### Parameters

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

#### Return Value

array | VMwareVCloudAPI_GroupType object array

###
at line 276
`public array getAdminCatalogRefs(string $name = null)`

Get references for all catalogs or named catalog in this organization.

#### Parameters

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

#### Return Value

array | VMwareVCloudAPI_ReferenceType object array

###
at line 289
`public array getAdminCatalogs(string $name = null)`

Get catalogs.

#### Parameters

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

#### Return Value

array | VMwareVCloudAPI_AdminCatalogType object array

###
at line 308
`public array getAdminVdcRefs(string $name = null)`

Get references for all vDCs or named vDC in this organization.

For System/Cloud Administrators, this method returns Admin Vdc references which can be used in {@link AdminVdc#getAdminVdcRef()} For Organization/Tenant Administrators/Users this method returns Vdc references which can be used in {@link Vdc#getVdcRef()}

#### Parameters

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

#### Return Value

array | VMwareVCloudAPI_ReferenceType object array

###
at line 327
`public array getAdminVdcs(string $name = null)`

Get vDCs.

For System/Cloud Administrators, this method returns Admin Vdc references which can be used in {@link AdminVdc#getAdminVdcRef()} For Organization/Tenant Administrators/Users this method returns Vdc references which can be used in {@link Vdc#getVdcRef()}

#### Parameters

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

#### Return Value

array | VMwareVCloudAPI_AdminVdcType object array

###
at line 343
`public array getAdminNetworkRefs(string $name = null)`

Get reference(s) for all organization networks or organization networks with the given name in administrative representation.

#### Parameters

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

#### Return Value

array | VMwareVCloudAPI_ReferenceType object array

###
at line 360
`public array getAdminNetworks(string $name = null)`

Get organization networks entities or organization networks with the given name in administrative representation.

#### Parameters

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

#### Return Value

array | VMwareVCloudAPI_OrgNetworkType object array for API 1.5

###
at line 372
`public VMware_VCloud_API_OrgSettingsType getOrgSettings()`

Gets organizational settings for this organization.

#### Return Value

VMware_VCloud_API_OrgSettingsType |

###
at line 385
`public VMware_VCloud_API_OrgSettingsType updateOrgSettings(VMware_VCloud_API_OrgSettingsType $settings)`

Updates organization settings for this organization.

#### Parameters

VMware_VCloud_API_OrgSettingsType | $settings |

#### Return Value

VMware_VCloud_API_OrgSettingsType |

###
at line 398
`public VMware_VCloud_API_OrgEmailSettingsType getOrgEmailSettings()`

Gets email settings of this organization.

#### Return Value

VMware_VCloud_API_OrgEmailSettingsType |

###
at line 411
`public VMware_VCloud_API_OrgEmailSettingsType updateOrgEmailSettings(VMware_VCloud_API_OrgEmailSettingsType $settings)`

Updates organization email settings for this organization.

#### Parameters

VMware_VCloud_API_OrgEmailSettingsType | $settings |

#### Return Value

VMware_VCloud_API_OrgEmailSettingsType |

###
at line 425
`public VMware_VCloud_API_OrgFederationSettingsType getOrgFederationSettings()`

Retrieve other organization settings.

#### Return Value

VMware_VCloud_API_OrgFederationSettingsType |

###
at line 439
`public VMware_VCloud_API_OrgFederationSettingsType updateOrgFederationSettings(VMware_VCloud_API_OrgFederationSettingsType $settings)`

Update other organization settings.

#### Parameters

VMware_VCloud_API_OrgFederationSettingsType | $settings |

#### Return Value

VMware_VCloud_API_OrgFederationSettingsType |

###
at line 452
`public VMware_VCloud_API_OrgPasswordPolicySettingsType getOrgPasswordPolicySettings()`

Retrieves the password policy settings for the organization.

#### Return Value

VMware_VCloud_API_OrgPasswordPolicySettingsType |

###
at line 465
`public VMware_VCloud_API_OrgPasswordPolicySettingsType updateOrgPasswordPolicySettings(VMware_VCloud_API_OrgPasswordPolicySettingsType $settings)`

Updates the organization password policy settings.

#### Parameters

VMware_VCloud_API_OrgPasswordPolicySettingsType | $settings |

#### Return Value

VMware_VCloud_API_OrgPasswordPolicySettingsType |

###
at line 479
`public VMware_VCloud_API_OrgLeaseSettingsType getOrgVAppLeaseSettings()`

Gets organization vApp lease settings on the level of vApp.

#### Return Value

VMware_VCloud_API_OrgLeaseSettingsType |

###
at line 492
`public VMware_VCloud_API_OrgLeaseSettingsType updateOrgVAppLeaseSettings(VMware_VCloud_API_OrgLeaseSettingsType $settings)`

Updates organization vApp lease settings on the level of vApp.

#### Parameters

VMware_VCloud_API_OrgLeaseSettingsType | $settings |

#### Return Value

VMware_VCloud_API_OrgLeaseSettingsType |

###
at line 505
`public VMware_VCloud_API_OrgVAppTemplateLeaseSettingsType getOrgVAppTemplateLeaseSettings()`

Gets organization vApp template lease settings on the level of vApp.

#### Return Value

VMware_VCloud_API_OrgVAppTemplateLeaseSettingsType |

###
at line 518
`public VMware_VCloud_API_OrgVAppTemplateLeaseSettingsType updateOrgVAppTemplateLeaseSettings(VMware_VCloud_API_OrgVAppTemplateLeaseSettingsType $settings)`

Updates organization vApp template lease settings on the level of vApp.

#### Parameters

VMware_VCloud_API_OrgVAppTemplateLeaseSettingsType | $settings |

#### Return Value

VMware_VCloud_API_OrgVAppTemplateLeaseSettingsType |

###
at line 532
`public VMware_VCloud_API_OrgGeneralSettingsType getOrgGeneralSettings()`

Gets organization general settings.

#### Return Value

VMware_VCloud_API_OrgGeneralSettingsType |

###
at line 545
`public VMware_VCloud_API_OrgGeneralSettingsType updateOrgGeneralSettings(VMware_VCloud_API_OrgGeneralSettingsType $settings)`

Updates organization general settings.

#### Parameters

VMware_VCloud_API_OrgGeneralSettingsType | $settings |

#### Return Value

VMware_VCloud_API_OrgGeneralSettingsType |

###
at line 559
`public VMware_VCloud_API_OrgLdapSettingsType getOrgLdapSettings()`

Gets organization LDAP settings.

#### Return Value

VMware_VCloud_API_OrgLdapSettingsType |

###
at line 573
`public VMware_VCloud_API_OrgLdapSettingsType updateOrgLdapSettings(VMware_VCloud_API_OrgLdapSettingsType $settings)`

Updates organization LDAP settings.

#### Parameters

VMware_VCloud_API_OrgLdapSettingsType | $settings |

#### Return Value

VMware_VCloud_API_OrgLdapSettingsType |

###
at line 585
`public resetLdapCertificate()`

Resets organization LDAP SSL certificate.

###
at line 596
`public resetLdapKeyStore()`

Resets organization LDAP keystore.

###
at line 607
`public resetLdapSspiKeytab()`

Resets organization LDAP keytab.

###
at line 619
`public VMware_VCloud_API_CertificateUploadSocketType updateLdapCertificate(VMware_VCloud_API_CertificateUpdateParamsType $params)`

Updates organization LDAP SSL certificate.

#### Parameters

VMware_VCloud_API_CertificateUpdateParamsType | $params |

#### Return Value

VMware_VCloud_API_CertificateUploadSocketType |

###
at line 632
`public VMware_VCloud_API_KeystoreUploadSocketType updateLdapKeyStore(VMware_VCloud_API_KeystoreUpdateParamsType $params)`

Updates organization LDAP keystore.

#### Parameters

VMware_VCloud_API_KeystoreUpdateParamsType | $params |

#### Return Value

VMware_VCloud_API_KeystoreUploadSocketType |

###
at line 645
`public VMware_VCloud_API_SspiKeytabUploadSocketType updateLdapSspiKeytab(VMware_VCloud_API_SspiKeytabUpdateParamsType $params)`

Updates organization LDAP SSPI keytab.

#### Parameters

VMware_VCloud_API_SspiKeytabUpdateParamsType | $params |

#### Return Value

VMware_VCloud_API_SspiKeytabUploadSocketType |

###
at line 664
`public VMware_VCloud_API_MetadataType| getMetadata(string $key = null, string $domain = null)`

Get metadata associated with the organization or metadata associated with the organization for the specified key in the specified domain.

#### Parameters

string | $key |
string | $domain |

#### Return Value

VMware_VCloud_API_MetadataType| | VMwareVCloudAPI_MetadataValueType|null

###
at line 676
`public VMware_VCloud_API_TaskType mergeMetadata(VMware_VCloud_API_MetadataType $meta)`

Merges the metadata for the organization with the information provided.

#### Parameters

VMware_VCloud_API_MetadataType | $meta |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 695
`public VMware_VCloud_API_TaskType setMetadataByKey(string $key, VMware_VCloud_API_MetadataValueType $value, string $domain = null)`

Sets the metadata for the particular key in the specified domain for the organization to the value provided.

Note: This will replace any existing metadata information.

#### Parameters

string | $key |
VMware_VCloud_API_MetadataValueType | $value |
string | $domain |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 711
`public VMware_VCloud_API_TaskType deleteMetadataByKey($key, $domain = null)`

Deletes the metadata for the particular key in the specified domain for the organization.

#### Parameters

| $key |
| $domain |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 723
`public VMware_VCloud_SDK_Org|null getSdkOrg()`

Return an alternate SDK orgznization object.

#### Return Value

VMware_VCloud_SDK_Org|null |

###
at line 736
`public null postExtEvent(VMware_VCloud_API_EventType $event)`

Posts external event to the system.

#### Parameters

VMware_VCloud_API_EventType | $event |

#### Return Value

null |

###
at line 749
`public VMware_VCloud_API_OrgGuestPersonalizationSettingsType getGuestPersonalizationSettings()`

Retrieve organization defaults for guest personalization settings.

#### Return Value

VMware_VCloud_API_OrgGuestPersonalizationSettingsType |

###
at line 763
`public VMware_VCloud_API_OrgGuestPersonalizationSettingsType modifyGuestPersonalizationSettings(VMware_VCloud_API_OrgGuestPersonalizationSettingsType $settings)`

Modify organization defaults for guest personalization settings.

#### Parameters

VMware_VCloud_API_OrgGuestPersonalizationSettingsType | $settings |

#### Return Value

VMware_VCloud_API_OrgGuestPersonalizationSettingsType |

###
at line 777
`public VMware_VCloud_API_OrgOperationLimitsSettingsType getOperationLimitsSettings()`

Retrieve organization operation limits settings.

#### Return Value

VMware_VCloud_API_OrgOperationLimitsSettingsType |

###
at line 790
`public VMware_VCloud_API_OrgOperationLimitsSettingsType modifyOperationLimitsSettings(VMware_VCloud_API_OrgOperationLimitsSettingsType $settings)`

Modify organization operation limits settings.

#### Parameters

VMware_VCloud_API_OrgOperationLimitsSettingsType | $settings |

#### Return Value

VMware_VCloud_API_OrgOperationLimitsSettingsType |