Managed Object - VRPResourceManager

See also: ManagedEntity, ResourceConfigSpec, ResourcePool, VirtualMachine, VirtualResourcePoolSpec, VirtualResourcePoolUsage, VRPEditSpec
Since: vSphere API 6.0

Managed Object Description

This managed object type provides a way to manage Virtual Resource Pools (VRP). VRPs can stitch together resource pools from various clusters into a single large virtual pool that acts as a single resource pool. VRPs are composed of hubs, which are either clusters or individal resource pools. These hubs further contain child resource pools, which form a backing for the VRP. A VRP can contain a mixture of hubs, some of which can be clusters and some of them resource pools.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
CreateVRP, DeleteVRP, DeployVM, GetAllVRPIds, GetChildRPforHub, GetRPSettings, GetVRPofVM, GetVRPSettings, GetVRPUsage, SetManagedByVDC, UndeployVM, UpdateVRP

CreateVRP

Creates a new Virtual Resource Pool.

Required Privileges: Global.VCServer

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VRPResourceManager used to make the method call.
spec	VirtualResourcePoolSpec	The VRP is created to have this config. The spec can either have member hubs specified, or the child resource pools. If hubs are specified, a child resource pool will be created within every hub. If child resource pools are specified, the parents of these resource pools will be considered as hubs.

Return Value

Type	Description
xsd:string

Faults

Type	Description
InsufficientResourcesFault	Thrown if the VRP specification cannot be supported by group of backing hubs. Admission control not guaranteed.
InvalidState	Thrown if the hubs/child resource pools do not support this operation in their current state; or if both hubs and child resource pools are specified in the VirtualResourcePoolSpec.
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:vim25="urn:vim25" name="CreateVRP" type="vim25:CreateVRPRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateVRPResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string"/>
               </sequence>
            </complexType>
         </element>

DeleteVRP

Deletes a VRP with the given Id if it exists. During deletion, all of the child resource pools under the hubs will be deleted. If there are any VMs under those resource pools, they will be moved directly under the hub. For hubs that are cluster, those VMs will be moved to the root resource pool.

Required Privileges: Global.VCServer

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VRPResourceManager used to make the method call.
vrpId	xsd:string	The unique Id of the VRP

Return Value

Type	Description
None

Faults

Type	Description
InvalidState	Thrown if the VRP cannot be deleted in its current state.
NotFound	Thrown if the VRP id cannot be found.
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:vim25="urn:vim25" name="DeleteVRP" type="vim25:DeleteVRPRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="DeleteVRPResponse">
            <complexType/>
         </element>

DeployVM

Deploy a VM in a given VRP, hub pair. Before deployment, admission control is performed to make sure that VRP can accomodate the VM's reservations. If the VM is already deployed in the same hub, the VM will remain deployed. The API will just rerun the admission control checks.

Required Privileges: Global.VCServer

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VRPResourceManager used to make the method call.
vrpId	xsd:string	The unique Id of the VRP.
vm	ManagedObjectReference to a VirtualMachine	MoRef of the VM.
cluster	ManagedObjectReference to a ManagedEntity	MoRef of the hub.

Return Value

Type	Description
None

Faults

Type	Description
InsufficientResourcesFault	Thrown if the VM cannot be supported by the VRP due to insufficient resources.
InvalidState	Thrown if the VM cannot be deployed in its current state.
NotFound	Thrown if the VRP or VM or hub cannot be found.
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:vim25="urn:vim25" name="DeployVM" type="vim25:DeployVMRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="DeployVMResponse">
            <complexType/>
         </element>

GetAllVRPIds

Get the list of Ids of all the Virtual Resource Pools in the system.

Required Privileges: Global.VCServer

Parameters

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

Return Value

Type	Description
xsd:string[]

Faults

Type	Description
InvalidState	Thrown if the information cannot be obtained due to invalid data.
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:vim25="urn:vim25" name="GetAllVRPIds" type="vim25:GetAllVRPIdsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="GetAllVRPIdsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

GetChildRPforHub

Given the VRP Id and a hub, gets the associated child resource pool.

Required Privileges: Global.VCServer

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VRPResourceManager used to make the method call.
vrpId	xsd:string	ID of the VRP.
hub	ManagedObjectReference to a ManagedEntity	MoRef of the hub.

Return Value

Type	Description
ManagedObjectReference to a ResourcePool

Faults

Type	Description
InvalidState	Thrown if the data cannot be accessed.
NotFound	Thrown if the VRP/hub cannot be found, or if the hub is not a part of the specified VRP.
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:vim25="urn:vim25" name="GetChildRPforHub" type="vim25:GetChildRPforHubRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="GetChildRPforHubResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>

GetRPSettings

Get ResourceConfigSpec for a resource pool that is under a member hub of some VRP. This is to get the settings that DRS generated for that child resource pool. The setting might be absent for recently added resource pools.

Required Privileges: Global.VCServer

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VRPResourceManager used to make the method call.
resourcePool	ManagedObjectReference to a ResourcePool	MoRef of the resource pool

Return Value

Type	Description
ResourceConfigSpec

Faults

Type	Description
NotFound	Thrown if the resource pool is not found.
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:vim25="urn:vim25" name="GetRPSettings" type="vim25:GetRPSettingsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="GetRPSettingsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ResourceConfigSpec" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>

GetVRPofVM

Get the ID of the VRP a VM belongs to. If the VM does not belong to any VRP, the returned optional string will not be set to any value.

Required Privileges: Global.VCServer

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VRPResourceManager used to make the method call.
vm	ManagedObjectReference to a VirtualMachine	MoRef of the VM.

Return Value

Type	Description
xsd:string

Faults

Type	Description
InvalidState	Thrown if the data cannot be accessed.
NotFound	Thrown if the VM is not found.
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:vim25="urn:vim25" name="GetVRPofVM" type="vim25:GetVRPofVMRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="GetVRPofVMResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>

GetVRPSettings

Get the settings for a VRP with the given Id if it exists. The returned VirtualResourcePoolSpec object will have all of its fields populated.

Required Privileges: Global.VCServer

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VRPResourceManager used to make the method call.
vrpId	xsd:string	Id of the VRP.

Return Value

Type	Description
VirtualResourcePoolSpec

Faults

Type	Description
InvalidState	Thrown if the data cannot be accessed.
NotFound	Thrown if the VRP cannot be found.
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:vim25="urn:vim25" name="GetVRPSettings" type="vim25:GetVRPSettingsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="GetVRPSettingsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VirtualResourcePoolSpec"/>
               </sequence>
            </complexType>
         </element>

GetVRPUsage

Get the usage values for a VRP with the given Id.

Required Privileges: Global.VCServer

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VRPResourceManager used to make the method call.
vrpId	xsd:string	Id of the VRP.

Return Value

Type	Description
VirtualResourcePoolUsage

Faults

Type	Description
InvalidState	Thrown if the data cannot be accessed.
NotFound	Thrown if the VRP cannot be found.
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:vim25="urn:vim25" name="GetVRPUsage" type="vim25:GetVRPUsageRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="GetVRPUsageResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VirtualResourcePoolUsage"/>
               </sequence>
            </complexType>
         </element>

SetManagedByVDC

Sets whether a cluster is managed by a Virtual Datacenter. Setting this to true will prevent users from disabling DRS for the cluster.

Required Privileges: Global.VCServer

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VRPResourceManager used to make the method call.
cluster	ManagedObjectReference to a ManagedEntity	MoRef of the cluster.
status	xsd:boolean	true if the cluster is managed by a Virtual Datacenter

Return Value

Type	Description
None

Faults

Type	Description
InvalidState	Thrown if the cluster cannot be reconfigured due to its state.
NotFound	Thrown if the cluster was not found
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:vim25="urn:vim25" name="SetManagedByVDC" type="vim25:SetManagedByVDCRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="SetManagedByVDCResponse">
            <complexType/>
         </element>

UndeployVM

Undeploy a VM in given VRP, hub pair.

Required Privileges: Global.VCServer

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VRPResourceManager used to make the method call.
vrpId	xsd:string	The unique Id of the VRP.
vm	ManagedObjectReference to a VirtualMachine	MoRef of the VM.
cluster	ManagedObjectReference to a ManagedEntity	MoRef of the hub.

Return Value

Type	Description
None

Faults

Type	Description
InvalidState	Thrown if the VM cannot be un-deployed in its current state.
NotFound	Thrown if the VRP,VM or the hub cannot be found.
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:vim25="urn:vim25" name="UndeployVM" type="vim25:UndeployVMRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UndeployVMResponse">
            <complexType/>
         </element>

UpdateVRP

Updates the configuration of an existing VRP.

Required Privileges: Global.VCServer

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VRPResourceManager used to make the method call.
spec	VRPEditSpec	The VRP is updated to have this config. If any new hub is added, a child resource pool will be created under it. For removed hubs, their child resource pools will be deleted and all the VMs that were under those resource pools will be moved directly under the hub. If the hub is a cluster, the VMs will be moved to the root resource pool.

Return Value

Type	Description
None

Faults

Type	Description
InsufficientResourcesFault	Thrown if the VRP specification cannot be supported by group of backing hubs. Admission control not guaranteed.
InvalidState	Thrown if the VRP does not support the operation in its current state.
NotFound	Thrown if the VRP id cannot be found.
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:vim25="urn:vim25" name="UpdateVRP" type="vim25:UpdateVRPRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateVRPResponse">
            <complexType/>
         </element>