Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

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
method

URI

Description

create

POST

csm/StaticPool

Creates a StaticPool object.

delete

DELETE

csm/StaticPool/guid

Deletes a StaticPool object.

modify

PUT

csm/StaticPool/guid

Modifies a StaticPool object.

get

GET

csm/StaticPool/guid

Retrieves a StaticPool object.

update

POST

csm/StaticPool/guid/update

Updates a StaticPool object.

search

POST

csm/StaticPool/search

Searches for StaticPool objects.

Operation APIs

Name

HTTP
method

URI

Description

addContent

POST

csm/StaticPool/guid/addContent

Adds objects to the static pool.

available

POST

csm/StaticPool/guid/available

inUse

POST

csm/StaticPool/guid/inUse

members

POST

csm/StaticPool/guid/members

removeContent

POST

csm/StaticPool/guid/removeContent

Removes objects from the static pool.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/StaticPool/guid/forNetworkContainer

Retrieves the forNetworkContainer relationship.

relation

GET

csm/StaticPool/guid/forZone

Retrieves the forZone relationship.

relation

GET

csm/StaticPool/guid/inPod

Retrieves the inPod relationship.

relation

GET

csm/StaticPool/guid/pooledObjects

Retrieves the pooledObjects relationship.

relation

GET

csm/StaticPool/guid/provider

Retrieves the provider relationship.

relation

GET

csm/StaticPool/guid/tags

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-
plicity

Description

forNetworkContainer

NetworkContainer

0..*

Network containers to which the static pool is mapped

forZone

Zone

0..*

Zones to which the static pool is mapped

inPod

Pod

0..1

Pod that the static pool is in

pooledObjects

CloudObject

1..*

Set of objects in the pool

cloudClass

CloudClass

1

Fully-qualified name of the class to which the object belongs

provider

Provider

1

Provider that created the object

tags

Tag

0..*

Tags associated with the object

Attributes

Name

Type

Multi-
plicity

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

StaticPoolCategory

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

name

String

1

Human-readable name of the object

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments