Get Resource Pool Properties Activity
Applies To: System Center 2012 - Orchestrator, System Center 2012 R2 Orchestrator, System Center 2012 SP1 - Orchestrator
The Get Resource Pool Properties activity is used in a runbook to retrieve all the runtime information (and, in System Center 2012 SP1 only, static configuration information) for a resource pool. This allows the runbook to retrieve the runtime information of a resource pool and populate a performance report.
Prior to System Center 2012 SP1, this activity was known as the Get Resource Pool Runtime Info activity
The following tables list the required and optional properties and published data for this activity.
The activity publishes all of the data from the required and optional properties into published data. Additional published data is generated based on the class that you select when you define the activity.
Get Resource Pool Properties Activity Required Properties
| Element | Description | Valid Values | Look up |
|---|---|---|---|
ResourcePool Path |
The path to the resource pool. |
String |
Yes |
Get Resource Pool Properties Activity Optional Properties
No optional properties are provided for this activity. |
Get Resource Pool Properties Activity Published Data
| Name | Description | Value Type |
|---|---|---|
CPUmaxUsage |
The maximum available CPU cycles for the resource pool (in megahertz). |
Integer |
CPUoverallUsage |
The amount of CPU cycles used by the resource pool and VMs (in megahertz). |
Integer |
CPUreservationUsed |
The amount of CPU cycles currently being used by the pool (in megahertz). |
Integer |
CPUreservationUsedforVm |
The amount of CPU cycles currently being used by the VMs (in megahertz). |
Integer |
CPUunreservedForPool |
The amount of CPU cycles not currently being used by the pool (in megahertz). |
Integer |
CPUunreservedforVm |
The amount of CPU cycles not currently being used by the VMs (in megahertz). |
Integer |
CpuSharesLevel (available only in System Center 2012 SP1) |
CPU allocation shares level. Can be the preset levels Low, Normal, High, or Custom. If Custom, the allocation is described in the CPUShares property. |
String |
CpuShares (available only in System Center 2012 SP1) |
The number of CPU Shares allocated. Set to -1 if CpuSharesLevel has a preset level. |
Integer |
CpuReservation (available only in System Center 2012 SP1) |
The guaranteed CPU MHz allocation available to the resource pool. |
Integer |
CpuLimit (available only in System Center 2012 SP1) |
The CPU MHz limit of the resource pool. |
Integer |
CpuExpandableReservation (available only in System Center 2012 SP1) |
True if the amount of reserved CPU can grow beyond the value that is specified in CpuReservation |
Boolean |
CpuUnlimited (available only in System Center 2012 SP1) |
True if the CPU usage is unlimited. Otherwise, False. |
Boolean |
MemoryExpandableReservation (available only in System Center 2012 SP1) |
True if the memory reservation can grow beyond the value specified in MemoryReservation. |
Boolean |
MemoryLimit (available only in System Center 2012 SP1) |
The memory limit for the resource pool, in megabytes. Set to -1 if the memory usage is unlimited. |
Integer |
MemoryMaxUsage |
The maximum amount of RAM available (in bytes). |
Integer |
MemoryOverallUsage |
The amount of memory that is currently being used (in bytes). |
Integer |
MemoryReservation (available only in System Center 2012 SP1) |
The guaranteed memory allocation that is available to the resource pool, in megabytes. |
Integer |
MemoryReservationUsed |
The amount of memory that is in use for the pool (in bytes). |
Integer |
MemoryReservationUsedForVm |
The amount of memory that is in use for the VMs (in bytes). |
Integer |
MemorySharesLevel (available only in System Center 2012 SP1) |
Memory allocation shares level. Can be the preset levels Low, Normal, High or Custom. If set to Custom, the allocation is described in the MemoryShares property. |
String |
MemoryShares (available only in System Center 2012 SP1) |
The number of Memory Shares allocated. Set to -1 if MemorySharesLevel has a preset level. |
Integer |
MemoryUnlimited (available only in System Center 2012 SP1) |
True, if the memory usage is unlimited. Otherwise, False. |
Boolean |
MemoryUnreservedForPool |
The amount of memory that is not in use for the pool (in bytes). |
Integer |
MemoryUnreservedForVm |
The amount of memory that is not in use for the VMs (in bytes). |
Integer |
Overall Health |
The overall health of the resource pool. Green indicates under committed; yellow indicates overcommitted, and red indicates inconsistent. |
String |
Resource Pool Path |
The path of the resource pool. |
String |
Virtual Machine Path |
The paths of all the virtual machines in the resource pool. |
String |
Configuring the Get Resource Pool Properties Activity
The following procedure describes the steps required to configure a Get Resource Pool Properties activity.
To configure the Get Resource Pool Properties activity
From the Activities pane, drag a Get Resource Pool Properties activity to the active runbook.
Double-click the Get Resource Pool Properties activity icon. The Properties dialog box opens.
Configure the settings in the Properties tab as follows:
In the Configuration section, click the ellipsis button (...), and then select the VMware vSphere server connection that you want to use for this activity. Click OK.
In the Properties section, enter a value for each of the required properties and the applicable optional properties. If the property is Lookup-enabled, you can click the ellipsis (…) button next to the text box to browse for a value.
You can also use published data to automatically populate the value of the property from the data output by a previous activity in the workflow.
Click Finish.