db-pool

This topic describes the verbs, command-line arguments, and API parameters available for the db-pool noun in the BMC Cloud Lifecycle Management SDK.

Note

To delete or list pools, use the pool noun, which applies to all pool types. See pool for more information.

create

Use db-pool-create from the command line to create a new compute pool with the specified databases.

Command-line syntax

python com/bmc/cloud/sdk/commandline/clmcmd.py db-pool-create [-h] [--waitfor TIME_OUT_SECONDS] --poolname NAME --description DESCRIPTION --podname NAME --environmentname NAME --providername NAME --vendorname NAME --dbname NAME

Use db_pool_create in the API to create a new compute pool with the specified databases. This command returns a StaticPool Python object with the same attributes and relationships.

API syntax

obj = db_pool_create(gcac, poolName=None, description=None, listOfResourceNames=None, podName=None, networkContainerName=None, providerName=None)

obj.guid # returns the GUID
obj.name # returns the name
...

Command-line argument	API parameter	Description	Required?
--poolname	poolName	Name of the new pool.	Yes
--description	description	Description of the pool.	Yes
--podname	podName	Name of the pod for the pool.	Yes
--environmentname	networkContainerName	Name of the environment/network container to associate with the pool.	Yes
--providername	providerName	Name of the provider of the database.	Yes
--vendorname		Name of the vendor of the database.	Yes
--dbname	listofResourceNames	Name of the database to add to the pool.	Yes
--waitfor		Time in seconds to wait for response from the server, otherwise return running task details.
	gcac	GenericCloudAPIClient instance/user authentication.

update

Use db-pool-update from the command line to update the compute pool description or the databases in the pool.

Command-line syntax

python com/bmc/cloud/sdk/commandline/clmcmd.py db-pool-update [-h] [--waitfor TIME_OUT_SECONDS] --poolname NAME [--description DESCRIPTION] [--adddbname NAME|id:<GUID>] [--removedbname NAME|id:<GUID>]

Use db_pool_update in the API to update the compute pool description or the databases in the pool. This command returns a StaticPool Python object with the same attributes and relationships.

API syntax

obj = db_pool_update(gcac, pool_name=None, description=None, add_resources=None, remove_resources=None)

obj.guid # returns the GUID
obj.name # returns the name
...

Command-line argument	API parameter	Description	Required?
--poolname	pool_name	Name of the compute pool that needs to be updated.	Yes
--description	description	New description of the compute pool.
--adddbname	add_resources	Name or GUID of a database to add to the compute pool
--removedbname	remove_resources	Name or GUID of a database to remove from the compute pool
--waitfor		Time in seconds to wait for response from the server, otherwise return running task details.
	gcac	GenericCloudAPIClient instance/user authentication.

db-pool

create

update

On this page