Managed Object - TenantTenantManager(vim.tenant.TenantManager)

Property of: ServiceContent
See also: ManagedEntity
Since: vSphere API 6.9.1

Managed Object Description

A singleton managed object for managing vCenter tenants.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
MarkServiceProviderEntities, RetrieveServiceProviderEntities, UnmarkServiceProviderEntities

MarkServiceProviderEntities(markServiceProviderEntities)

Define a set of ManagedEntity objects as used for tenant management. Those entities are a starting point of an inventory hierarchy (sub-tree) that functionally exists in the tenant's inventory but are owned by the system user of the vCenter Server. The operations which the tenant may perform on these objects depend on the permissions granted to the tenant by the SaaS provisioning layer. Permissions that the tenant may create on the parent objects of the management entities do not propagate to the hierarchies of management entities and thus have no effect on them. This operation will fail for all the entities if any of them does not exist. The method behaviour is transactional - either all entities are marked or none if an error occurs while processing them. The user calling this method should hold TenantManager.Update on the root folder and TenantManager.Update on each entity currently being marked as a service provider one. These are strict privilege requirements allowing only administrators to call the method.

Required Privileges: TenantManager.Update

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the TenantTenantManager used to make the method call.

entity* P

ManagedObjectReference[]
to a ManagedEntity[]

an array of management entities.

Since vSphere API 6.9.1

*Need not be set P Required privilege: entity

Return Value

Type	Description
None

Faults

Type	Description
AuthMinimumAdminPermission	Thrown if this change will leave the system with no Administrator permission on the root folder of the service provider inventory.
ManagedObjectNotFound	Thrown if any of the entities doesn't exist.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="MarkServiceProviderEntities" type="pbm:MarkServiceProviderEntitiesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="MarkServiceProviderEntitiesResponse">
                  <complexType/>
               </element>

RetrieveServiceProviderEntities(retrieveServiceProviderEntities)

Retrieves the list of tenant management entities.

Required Privileges: TenantManager.Query

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the TenantTenantManager used to make the method call.

Return Value

Type	Description
ManagedObjectReference[] to a ManagedEntity[]	The array of tenant management resources.

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="RetrieveServiceProviderEntities" type="pbm:RetrieveServiceProviderEntitiesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="RetrieveServiceProviderEntitiesResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="pbm:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

UnmarkServiceProviderEntities(unmarkServiceProviderEntities)

Resets the management type of an array of ManagedEntity objects. This operation will fail if any of the entities does not exist. The method behaviour is transactional - either all entities are unmarked or none if an error occurs while processing them. The user calling this method should hold TenantManager.Update on the root folder and TenantManager.Update on each entity currently being unmarked as a service provider one. These are strict privilege requirements allowing only administrators to call the method.

Required Privileges: TenantManager.Update

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the TenantTenantManager used to make the method call.

entity* P

ManagedObjectReference[]
to a ManagedEntity[]

an array of management entities.

Since vSphere API 6.9.1

*Need not be set P Required privilege: entity

Return Value

Type	Description
None

Faults

Type	Description
ManagedObjectNotFound	Thrown if any of the entities doesn't exist.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="UnmarkServiceProviderEntities" type="pbm:UnmarkServiceProviderEntitiesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="UnmarkServiceProviderEntitiesResponse">
                  <complexType/>
               </element>