Scripting Object - VcVRPResourceManager

Scripting-object corresponding to
VRPResourceManager
Attribute of
VcInternalServiceInstanceContent

Scripting Object Description

!!! This interface needs to be deleted, however VMOMI lacks the abilility !!! !!! to offer proper backward-compatibility story. See PR 1483287 !!! 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.

Attributes

Name Type Description
allVRPIdsString []

Get the list of Ids of all the Virtual Resource Pools in the system. @since vSphere API 6.0
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, createVRP, deleteVRP, deployVM, getChildRPforHub, getRPSettings, getVRPofVM, getVRPSettings, getVRPUsage, setManagedByVDC, undeployVM, updateVRP

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

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. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

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. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcResourcePool


Return Value

Type Description
VcResourceConfigSpec

getVRPUsage

Get the usage values for a VRP with the given Id. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcVirtualResourcePoolUsage

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. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String

arg1VcVirtualMachine

arg2VcManagedEntity


Return Value

Type Description
None

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. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcVirtualResourcePoolSpec

undeployVM

Undeploy a VM in given VRP, hub pair. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String

arg1VcVirtualMachine

arg2VcManagedEntity


Return Value

Type Description
None

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. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcVirtualMachine


Return Value

Type Description
String

getChildRPforHub

Given the VRP Id and a hub, gets the associated child resource pool. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String

arg1VcManagedEntity


Return Value

Type Description
VcResourcePool

createVRP

Creates a new Virtual Resource Pool. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcVirtualResourcePoolSpec


Return Value

Type Description
String

setManagedByVDC

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

Parameters

NameTypeDescription
arg0VcManagedEntity

arg1Boolean


Return Value

Type Description
None

updateVRP

Updates the configuration of an existing VRP. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcVRPEditSpec


Return Value

Type Description
None