infra_db_scale
This job updates a node(s) of the cluster and updates the database configuration.
Mandatory parameters
Parameter name | Data type | Description |
---|---|---|
db_name | string | The name of the database. The database will be stopped. |
instance_type | string | Enter the instance type that fits your database needs. Valid values include: 5d.large, r5d.xlarge, and r5d.2xlarge. |
Optional parameters
Parameter name | Data type | Description |
---|---|---|
offload_enabled | boolean | Whether or not offload is enabled for this worker db |
offload_force | boolean | All sessions which cannot be moved will have their currently running statements killed |
offload_timeout | integer | The client/statement will wait up to timeout in seconds for the sessions to be moved. |
Substitute parameters
There are no substitute parameters.
Allowed users
The following users are allowed to run this job:
- root
Allowed groups
The following groups are allowed to run this job:
- root
- exaadm
- exadbadm
Examples
The following examples show how to run this job in a Python program using XML-RPC or on the command line using confd_client.