StaticPool class
The StaticPool class represents a resource pool with a fixed membership.
StaticPool class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the StaticPool class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
create | POST | Creates a StaticPool object. | |
delete | DELETE | Deletes a StaticPool object. | |
modify | PUT | Modifies a StaticPool object. | |
get | GET | Retrieves a StaticPool object. | |
update | POST | Updates a StaticPool object. | |
search | POST | Searches for StaticPool objects. |
Operation APIs
Name | HTTP | URI | Description |
|---|---|---|---|
addContent | POST | Adds objects to the static pool. | |
available | POST |
| |
inUse | POST |
| |
members | POST |
| |
removeContent | POST | Removes objects from the static pool. |
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the forNetworkContainer relationship. | |
relation | GET | Retrieves the forZone relationship. | |
relation | GET | Retrieves the inPod relationship. | |
relation | GET | Retrieves the pooledObjects relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | Retrieves the tags relationship. |
StaticPool class relationships and attributes
The following tables list the relationships and attributes of the StaticPool class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
forNetworkContainer | 0..* | Network containers to which the static pool is mapped | |
forZone | 0..* | Zones to which the static pool is mapped | |
inPod | 0..1 | Pod that the static pool is in | |
pooledObjects | 1..* | Set of objects in the pool | |
tickets | 0..* |
| |
cloudClass | 1 | Fully-qualified name of the class to which the object belongs | |
provider | 1 | Provider that created the object | |
tags | 0..* | Tags associated with the object |
Attributes
Name | Type | Multi- | Description |
|---|---|---|---|
isDefault | Boolean | 1 | Indicates whether this pool is the default pool for all onboarded objects not assigned to other pools. The cloud can have only one default pool. |
poolCategory | 0..1 |
| |
pooledObjectType | String | 0..1 | Type of the objects in the static pool |
actual | Integer | 1 | Current count of cloud objects in the pool. |
highWaterMark | Integer | 0..1 | Highest amount of the resource that has been present in the pool at any time |
lowWaterMark | Integer | 0..1 | Lowest amount of the resource that has been present in the pool at any time |
maximum | Integer | 0..1 | Maximum count of the cloud object that is allowed to be in the pool at any time |
minimum | Integer | 0..1 | Minimum count of the cloud object that is allowed to be in the pool at any time |
externalID | String | 0..1 | Identifier used for the object by an external provider |
owner | String | 0..1 | Name of the owner of the object |
reconciliationID | String | 0..1 | Reconciliation identity value for the object from the BMC Atrium CMDB |
tokenID | String | 0..1 | Token identifier |
description | String | 0..1 | Text that describes the object |
guid | String | 1 | Globally unique identifier for the object |
labels | String | 0..* |
|
modifiedDate | 0..1 | Date the Cloudobject was modified | |
name | String | 1 | Human-readable name of the object |