Activities

Create Resource Pool
Edit Resource Pool
Get Resource Pool
Get Resource Pool Properties
List Resource Pools
Remove Resource Pool

Create Resource Pool

This activity creates a new Resource Pool on the existing Resource Pool or the specified Cluster.

Activity Parameters

The Create Resource Pool activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Name (text box editor type) (type: string): the name of the new Resource Pool.
Parent ID (text box editor type) (type: string): the ID of the Parent Location chosen where you wish to create the new Resource Pool.
The value can also be obtained from activity: Get Cluster using the following steps:
- use a Get Cluster activity to extract the ClusterID:
- bind the obtained ClusterID(stored in variable) to the Parent ID field from Create Resource Pool activity:
Parent Type (combo box control) (type: string): the Parent Location Type for the new resource pool, whether it is an existing Resource Pool or a Cluster.

Resources (parameters):

CPU Limit (text box editor type) (type: int32): limit the utilization of the resource pool,and it will not exceed it even if there are available resources. This is typically used to ensure a consistent performance of resource pools independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MHz. E.g. 40 and this number should be higher than CPU reservation parameter.
CPU Reservation (text box editor type) (type: int32): amount of resource that is guaranteed available to the resource pool. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MHz. E.g. 20 and this number should be lower than CPU Limit parameter.
CPU Shares (text box editor type) (type: int32): the number of shares allocated. Used to determine resource allocation in case of resource contention. This value is only set if level is set to custom. If level is not set to custom, this value is ignored. Therefore, only shares with custom values can be compared.
CPU Shares Level (combo box control) (type: string): set the allocation level, it is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. If the shares value does not map to a predefined size, then the level is set as custom.If custom -> Shares value is specified in the 'shares' parameter, if high -> Shares = 2000 * number of virtual CPUs, if low -> Shares = 500 * number of virtual CPUs, or if normal -> Shares = 1000 * number of virtual CPUs
Expandable CPU Reservation (combo box control) (type: string): in a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value, if the parent resource pool has unreserved resources. A non-expandable reservation is called a fixed reservation.
Expandable Memory Reservation (combo box control) (type: string): in a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value, if the parent resource pool has unreserved resources. A non-expandable reservation is called a fixed reservation.
Memory Limit (text box editor type) (type: int32): limit the utilization of the resource pool,and it will not exceed it even if there are available resources. This is typically used to ensure a consistent performance of resource pools independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MB. E.g. 40 and this number should be higher than Memory reservation parameter.
Memory Reservation (text box editor type) (type: int32): amount of resource that is guaranteed available to the resource pool. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MB. E.g. 20 and this number should be lower than Memory Limit parameter.
Memory Shares (text box editor type) (type: int32): the number of shares allocated. Used to determine resource allocation in case of resource contention. This value is only set if level is set to custom. If level is not set to custom, this value is ignored. Therefore, only shares with custom values can be compared.
Memory Shares Level (combo box control) (type: string): this is the allocation level, it is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. If the shares value does not map to a predefined size, then the level is set as custom.

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: string): outputs the new created Resource Pool ID.
Output Status (type: boolean): outputs True if the operation succeeded otherwise False.

Edit Resource Pool

This activity edits the specified Resource Pool.

Activity Parameters

The Edit Resource Pool activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Name (text box editor type) (type: string): the new name of the Resource Pool.
Resource Pool ID (text box editor type) (type: string): the ID of the Resource Pool.
The value can also be obtained from activity: Get Resource Pool using the following steps:
- use a Get Resource Pool activity to extract the ResourcePoolID:
- bind the obtained ResourcePoolID(stored in variable) to the Resource Pool ID field from Edit Resource Pool activity:

Resources (parameters):

CPU Limit (text box editor type) (type: int32): limit the utilization of the resource pool, and it will not exceed it even if there are available resources. This is typically used to ensure a consistent performance of resource pools independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MHz.
CPU Reservation (text box editor type) (type: int32): amount of resource that is guaranteed available to the resource pool. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MHz.
CPU Shares (text box editor type) (type: int32): the number of shares allocated. Used to determine resource allocation in case of resource contention. This value is only set if level is set to custom. If level is not set to custom, this value is ignored. Therefore, only shares with custom values can be compared.
CPU Shares Level (combo box control) (type: string): set the allocation level, it is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. If the shares value does not map to a predefined size, then the level is set as custom.If custom -> Shares value is specified in the 'shares' parameter, if high -> Shares = 2000 * number of virtual CPUs, if low -> Shares = 500 * number of virtual CPUs, or if normal -> Shares = 1000 * number of virtual CPUs.
Expandable CPU Reservation (combo box control) (type: string): in a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value, if the parent resource pool has unreserved resources. A non-expandable reservation is called a fixed reservation.
Expandable Memory Reservation (combo box control) (type: string): in a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value, if the parent resource pool has unreserved resources. A non-expandable reservation is called a fixed reservation.
Memory Limit (text box editor type) (type: int32): limit the utilization of the resource pool,and it will not exceed it even if there are available resources. This is typically used to ensure a consistent performance of resource pools independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MB.
Memory Reservation (text box editor type) (type: int32): amount of resource that is guaranteed available to the resource pool. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MB.
Memory Shares (text box editor type) (type: int32): the number of shares allocated. Used to determine resource allocation in case of resource contention. This value is only set if level is set to custom. If level is not set to custom, this value is ignored. Therefore, only shares with custom values can be compared.
Memory Shares Level (combo box control) (type: string): this is the allocation level, it is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. If the shares value does not map to a predefined size, then the level is set as custom.

The Read Only Output variable are the possible output values that the activity will provide:

Output Status (type: boolean): outputs True if the operation succeeded otherwise False.

Get Resource Pool

This activity returns the specified Resource Pool ID.

Activity Parameters

The Get Resource Pool activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Cluster Name (text box editor type) (type: string): the name of the Cluster.
Datacenter Name (text box editor type) (type: string): the name of the Datacenter.
Path (text box editor type) (type: string): the path where the desired Resource Pool is. If left empty it will return the Parent Resource Pool. For example: ResourcePoolName1/ResourcePoolName2/DesiredResourcePool.

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: string): outputs the resulting Resource Pool ID.

Execution: The example below is an execution where a resource pool id is returned from DemoCluster cluster:

Get Resource Pool Properties

This activity retrieves all the runtime information for a resource pool

Activity Parameters

The Get Resource Pool Properties activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Resource Pool ID (text box editor type) (type: string): the ResourcePool ID. The value can also be obtained from activity: Get Resource Pool using the following steps:
- use a Get Resource Pool activity to extract the ResourcePoolID:
- bind the obtained ResourcePoolID(stored in variable) to the Resource Pool ID field from Get Resource Pool Properties activity:

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: collection<string>): outputs a collection of Properties and their corresponding values.To use the elements of the collection, use Get Element From Collection activity where the Input Collection parameter should be bound to this parameter.

In order to extract the values from the ResPoolProperties collection, For Each and Log Track Data activities should be used:

Execution: The example below is an execution where all properties are returned for resource pool with ID: resgroup-697:

List Resource Pools

This activity retrieves a list of all the resource pools.

Activity Parameters

The List Resource Pools activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Datacenter Name (text box editor type) (type: string): the name of the Datacenter.
Cluster Name (text box editor type) (type: string): the name of the Cluster.
Path (text box editor type) (type: string): thepath where the desired Resource Pool is. If left empty it will return the Parent Resource Pool. For example: ResourcePoolName1/ResourcePoolName2/DesiredResourcePool.

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: collection<string>): outputs a collection of Resource Pools found on the specified path.

In order to extract the values from the ListResPools output collection , For Each and Log Track Data activities should be used:

Execution: The example below is an execution where all resource pools from DemoCluster cluster:

Remove Resource Pool

This activity removes the specified Resource Pool.

Activity Parameters

The Remove Resource Pool activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Resource Pool ID (text box editor type) (type: string): the ID of the Resource Pool.
The value can also be obtained from activity: Get Resource Pool using the following steps:
- use a Get Resource Pool activity to extract the ResourcePoolID:
- bind the obtained ResourcePoolID(stored in variable) to the Resource Pool ID field from Remove Resource Pool activity:

The Read Only Output variable are the possible output values that the activity will provide:

Output Status (type: boolean): outputs True if the operation succeeded otherwise False.

Browser not supported