Class

VMware_VCloud_SDK_Admin

class VMware_VCloud_SDK_Admin 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_VCloudType getVCloud()

Get a VMware vCloud admin entity.
VMware_VCloud_API_LinkType|null getAddRoleRef()

Get a link for adding a role operation.
VMware_VCloud_API_LinkType|null getAddOrgRef()

Get a link for adding an organization operation.
array getAdminOrgRefs(string $name = null)

Get references to admin organization entities.
array getAdminOrgs(string $name = null)

Get all admin organization or admin organization with the given name.
array getProviderVdcRefs(string $name = null)

Get references to all provider vDCs or provider vDC with the given name.
array getProviderVdcs(string $name = null)

Get all provider vDCs or provider vDC with the given name.
array getRightRefs(string $name = null)

Get references to all right entities or right entity with the given name.
array getRights(string $name = null)

Get all right entities or right entity with the given name.
array getRoleRefs(string $name = null)

Get references to all role entities or role entity with the given name.
array getRoles(string $name = null)

Get all role entities or role entity with the given name.
array getExternalNetworkRefs(string $name = null)

Get references to all external network entities or external network entity with the given name.
array getExternalNetworks(string $name = null)

Get all external network entities or external network entity with the given name.
VMware_VCloud_API_AdminOrgType|null createOrganization(VMware_VCloud_API_AdminOrgType $adminOrg)

Create an organization entity in vCloud.
VMware_VCloud_API_RoleType createRole(VMware_VCloud_API_RoleType $role)

Create a role in vCloud.
VMware_VCloud_API_LinkType|null getSystemOrgRef()

Get a link to the system organization.
VMware_VCloud_API_AdminOrgType|null getSystemOrg()

Get a system organization data object.
VMware_VCloud_API_ReferenceType getGroupQuery()

Retrieves a list of groups for organization the org admin belongs to by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set.

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 7
public __construct($svc)

Constructor

Parameters

$svc

at line 18
public VMware_VCloud_API_VCloudType getVCloud()

Get a VMware vCloud admin entity.

Return Value

VMware_VCloud_API_VCloudType

at line 29
public VMware_VCloud_API_LinkType|null getAddRoleRef()

Get a link for adding a role operation.

Return Value

VMware_VCloud_API_LinkType|null

at line 41
public VMware_VCloud_API_LinkType|null getAddOrgRef()

Get a link for adding an organization operation.

Return Value

VMware_VCloud_API_LinkType|null

at line 55
public array getAdminOrgRefs(string $name = null)

Get references to admin organization entities.

Parameters

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

Return Value

array VMwareVCloudAPI_OrganizationReferenceType object array

at line 70
public array getAdminOrgs(string $name = null)

Get all admin organization or admin organization with the given name.

Parameters

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

Return Value

array VMwareVCloudAPI_AdminOrgType object array

at line 83
public array getProviderVdcRefs(string $name = null)

Get references to all provider vDCs or provider vDC with the given name.

Parameters

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

Return Value

array VMwareVCloudAPI_ReferenceType object array

at line 97
public array getProviderVdcs(string $name = null)

Get all provider vDCs or provider vDC with the given name.

Parameters

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

Return Value

array VMwareVCloudAPI_ProviderVdcType object array

at line 110
public array getRightRefs(string $name = null)

Get references to all right entities or right entity with the given name.

Parameters

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

Return Value

array VMwareVCloudAPI_ReferenceType object array

at line 123
public array getRights(string $name = null)

Get all right entities or right entity with the given name.

Parameters

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

Return Value

array VMwareVCloudAPI_RightType object array

at line 136
public array getRoleRefs(string $name = null)

Get references to all role entities or role entity with the given name.

Parameters

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

Return Value

array VMwareVCloudAPI_ReferenceType object array

at line 149
public array getRoles(string $name = null)

Get all role entities or role entity with the given name.

Parameters

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

Return Value

array VMwareVCloudAPI_RoleType object array

at line 163
public array getExternalNetworkRefs(string $name = null)

Get references to all external network entities or external network entity with the given name.

Parameters

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

Return Value

array VMwareVCloudAPI_ReferenceType object array

at line 177
public array getExternalNetworks(string $name = null)

Get all external network entities or external network entity with the given name.

Parameters

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

Return Value

array VMwareVCloudAPI_ExternalNetworkType object array

at line 190
public VMware_VCloud_API_AdminOrgType|null createOrganization(VMware_VCloud_API_AdminOrgType $adminOrg)

Create an organization entity in vCloud.

Parameters

VMware_VCloud_API_AdminOrgType $adminOrg

Return Value

VMware_VCloud_API_AdminOrgType|null

at line 204
public VMware_VCloud_API_RoleType createRole(VMware_VCloud_API_RoleType $role)

Create a role in vCloud.

Parameters

VMware_VCloud_API_RoleType $role

Return Value

VMware_VCloud_API_RoleType

at line 217
public VMware_VCloud_API_LinkType|null getSystemOrgRef()

Get a link to the system organization.

Return Value

VMware_VCloud_API_LinkType|null

at line 229
public VMware_VCloud_API_AdminOrgType|null getSystemOrg()

Get a system organization data object.

Return Value

VMware_VCloud_API_AdminOrgType|null

at line 241
public VMware_VCloud_API_ReferenceType getGroupQuery()

Retrieves a list of groups for organization the org admin belongs to by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set.

Format determines the elements representation - references or records. Default format is references.

Return Value

VMware_VCloud_API_ReferenceType