Administration and Configuration

This section covers essential tasks for managing and configuring Oracle AI Database environments. It includes commands such as dbaascli admin updateStack for installing or updating the dbaastools RPM, and dbaascli job getStatus for checking the status of specific jobs.

dbaascli admin updateStack
dbaascli job getStatus
dbaascli system scalecpu
dbaascli diag collect
dbaascli diag healthCheck
dbaascli system getDBHomes
dbaascli system getGridHomes

dbaascli admin updateStack

To install or update a dbaastools RPM, use the dbaascli admin updateStack command.

Prerequisites:

Run the command as the root user.

To use the utility, you must connect to an Oracle Base Database Cloud@Customer virtual machine.

See Connecting to a Virtual Machine with SSH.

Syntax:

dbaascli admin updateStack
[--resume]
[--prechecksOnly]
[--nodes]

Parameters:

Parameter	Description
`--resume`	resumes the previous execution
`--prechecksOnly`	runs only the prechecks for this operation
`--nodes`	specifies a comma-delimited list of nodes to install the RPM on. If you do not pass this argument, then the RPM will be installed on all of the cluster nodes

Frequently Asked Questions:

Q: What is the dbaascli admin updateStack command used for?

A: The dbaascli admin updateStack command is used to install or update a dbaastools RPM on Oracle Base Database Cloud@Customer.

Q: What are the prerequisites for using the dbaascli admin updateStack command?

A: You must run the command as the root user and connect to an Oracle Base Database Cloud@Customer virtual machine.

Q: What does the –resume option do?

A: The --resume option resumes the previous execution of the updateStack command if it was interrupted or incomplete.

Q: What is the purpose of the –prechecksOnly option?

A: The --prechecksOnly option runs only the prechecks for the operation without actually performing the installation or update.

Q: How is the –nodes parameter used?

A: The --nodes parameter specifies a comma-delimited list of nodes on which the RPM should be installed. If not provided, the RPM will be installed on all cluster nodes.

Q: What should I do if I encounter issues with the dbaascli admin updateStack command?

A: Ensure you are running the command as the root user and that you are connected to an Oracle Base Database Cloud@Customer virtual machine. Check if there are any specific error messages and consult the command documentation or Oracle support if needed.

Q: How do I connect to an Oracle Base Database Cloud@Customer virtual machine to use the dbaascli admin updateStack command?

A: You need to use SSH to connect to the virtual machine. Refer to the section on Connecting to a Virtual Machine with SSH in the documentation for detailed instructions.

Examples:

Example: Installing or updating the dbaastools RPM on all nodes

dbaascli admin updateStack

Installs or updates the dbaastools RPM on all nodes of the Oracle Base Database Cloud@Customer environment.

Example: Running prechecks only before installing or updating the RPM

dbaascli admin updateStack --prechecksOnly

Runs only the prechecks for the dbaastools RPM update, without actually performing the installation. It ensures that all prerequisites are satisfied before proceeding with the update.

Example: Resuming a previously interrupted updateStack operation

dbaascli admin updateStack --resume

Resumes a previous dbaastools RPM update operation that was interrupted or did not complete successfully.

Example: Installing or updating dbaastools on specific nodes

dbaascli admin updateStack --nodes node1,node2

Installs or updates the dbaastools RPM on the specified nodes node1 and node2 only, without affecting other nodes in the cluster.

Example: Resuming the updateStack process on specific nodes

dbaascli admin updateStack --resume --nodes node3,node4

Resumes the update process for dbaastools on the specific nodes node3 and node4 only, if the previous execution was interrupted.

dbaascli job getStatus

To view the status of a specified job, use the dbaascli job getStatus command.

Prerequisites:

Run the command as the root user.

To use the utility, you must connect to an Oracle Base Database Cloud@Customer virtual machine.

See Connecting to a Virtual Machine with SSH.

Syntax:

dbaascli job getStatus --jobID

Parameters:

Parameter	Description
`--jobID`	specifies the job ID

Frequently Asked Questions:

Q: What is the dbaascli job getStatus command used for?

A: The dbaascli job getStatus command is used to view the status

Examples:

Example: Checking the status of a specific job using job ID

dbaascli job getStatus --jobID 12345

Checks the status of the job with the ID 12345. The output will show the current state of the job (e.g., in progress, completed, or failed).

Example: Checking the status of a patching job using job ID

dbaascli job getStatus --jobID 98765

Retrieves the status of a patching job with the ID 98765 to see whether the patch has been applied successfully or is still running.

Example: Checking the status of a database backup job

dbaascli job getStatus --jobID 45678

Checks the status of a database backup job with the ID 45678. The output will provide details about the progress or completion of the backup.

Example: Checking a long-running job’s progress

dbaascli job getStatus --jobID 23456

Check the progress of a long-running job (ID 23456) to see if it’s still executing or has finished.

Example: Viewing the status of a database creation job

dbaascli job getStatus --jobID 67890

Checks the status of a database creation job identified by the job ID 67890.

CPU Scaling:

Learn how to view and adjust CPU resources in a VM cluster based on workload requirements.

dbaascli system scalecpu

To scale up or down the CPU core count for a virtual machine in a VM cluster when network connectivity between the Control Plane Server and OCI region is disrupted, use the dbaascli cpuscale update command.

Syntax:

dbaascli system scaleCPU
        {
            --coreCount <value> [--message <value>]
            | --status
        }

Parameters:

Parameter	Description
`--coreCount`	Updates the CPU core count for each VM in the cluster to the specified value.
`--message`	Optionally, specifies a text message for the current scaling operation.
`--status`	Displays details of the latest CPU core count update requested from the current VM.

Frequently Asked Questions:

Q: What is the dbaascli system scaleCPU command used for?

A: The dbaascli system scaleCPU command is used to increase or decrease the CPU core count for each VM in a VM cluster.

Q: What does the –coreCount option specify?

A: The --coreCount option specifies the target number of CPU cores for each VM in the VM cluster.

Q: Can I include a message with a CPU scaling operation?

A: Yes. Use the optional --message option to specify a text message for the current scaling operation.

Q: How do I check the status of a CPU scaling operation?

A: Use the --status option to display details of the latest CPU core count update requested from the current VM.

Q: Can I use --coreCount and --status together?

A: No. Specify either --coreCount with an optional --message, or --status.

Examples:

Example: Scaling up CPU cores

To increase the CPU core count for each VM in the VM cluster to 20:

dbaascli system scaleCPU --coreCount 20

The command requests that the CPU core count for each VM in the VM cluster be updated to 20.

Example: Scaling down CPU cores

To decrease the CPU core count for each VM in the VM cluster to 8:

dbaascli system scaleCPU --coreCount 8

The command requests that the CPU core count for each VM in the VM cluster be updated to 8.

Example: Scaling CPU cores with a message

To update the CPU core count to 20 and include a message:

dbaascli system scaleCPU --coreCount 20 --message "Scaling up for increased demand"

The command requests the CPU core count update and associates the specified message with the scaling operation.

Example: Checking the status of a CPU scaling operation

To view details of the latest CPU core count update:

dbaascli system scaleCPU --status

The command displays the details of the latest CPU core count update requested from the current VM.

Example: Checking the status after requesting a CPU scale

After requesting a CPU core count update, you can check the status of the operation by running:

dbaascli system scaleCPU --status

This allows you to verify the details of the latest CPU scaling request.

Diagnostics and Health Checks:

This section covers tools for maintaining the health and diagnosing issues in Oracle AI Database environments. Commands like dbaascli diag collect are used to gather diagnostic data, while dbaascli diag healthCheck allows you to run health checks to identify potential issues. These tools help ensure the system’s stability and performance by proactively monitoring and addressing concerns.

dbaascli diag collect

To collect diagnostics, use the dbaascli diag collect command.

Prerequisites:

Run the command as the root user.

Syntax:

dbaascli diag collect [--components <value>] [--startTime <value>] [--endTime <value>] [--nodes <value>] [--dbNames <value>]
        {
            [--objectStoreBucketUri <value>]
            | [--destLocation <value>]
        }
        [--waitForCompletion <value>]

Parameters:

Parameter	Description
`--components`	specifies a list of components for log collection. Valid values: `db`, `gi`, `os`, `dbaastools`, `all`.
`--startTime`	specifies the start time for log collection. Valid date and time format: `YYYY-MM-DDTHH24:MM:SS`
`--endTime`	specifies the end time for log collection. Valid date and time format: `YYYY-MM-DDTHH24:MM:SS`
`--nodes`	specifies a comma-delimited list of nodes to collect logs
`--dbNames`	specifies the database name for which to collect logs. You can specify only one database name.
`--objectStoreBucketURI`	specifies an Object Storage service pre-authenticated request (PAR) URL used to upload collected logs. Logs are collected from Guest VM. For more information, see Using Pre-Authenticated Requests.
`--destLocation`	specifies the location on Guest VM to collect logs. Default: `/var/opt/oracle/dbaas_acfs`
`--waitForCompletion`	Values: `true` or `false`. Default `true`. Specify `false` to run in the background.

Frequently Asked Questions:

Q: What is the purpose of the dbaascli diag collect command?

A: The dbaascli diag collect command is used to collect diagnostic logs for Oracle AI Database and associated components such as OS, Grid Infrastructure (GI), and DBaaS tools.

Q: How do I specify which components to collect diagnostics for?

A: You can specify the components using the --components option. Valid values are:

db (for database logs)
gi (for Grid Infrastructure logs)
os (for operating system logs)
dbaastools (for DBaaS tools logs)
all (for collecting logs for all components)

Q: How can I collect logs for a specific time range?

A: Use the following options to specify a time range:

--startTime <value> to set the start time for log collection.
--endTime <value> to set the end time for log collection.

The time must be in the format: YYYY-MM-DDTHH24:MM:SS.

Q: What format should the start and end times be in?

A: Both --startTime and --endTime should be in the format YYYY-MM-DDTHH24:MM:SS. For example, 2024-09-01T15:30:00.

Q: How do I specify which nodes to collect diagnostics from?

A: You can use the --nodes option to specify a comma-delimited list of nodes. For example:

--nodes node1,node2

Q: How do I collect logs for a specific database?

A: Use the --dbNames option to specify the name of the database for which you want to collect logs. Only one database name can be specified at a time.

Q: How can I store the collected logs in Object Storage?

A: Use the --objectStoreBucketUri option to specify the pre-authenticated request (PAR) URL for your Object Storage bucket where the logs will be uploaded.

Q: Can I collect logs to a local directory instead of Object Storage?

A: Yes, you can use the --destLocation option to specify a directory on the guest VM where the logs will be collected. The default location is /var/opt/oracle/dbaas_acfs.

Q: What happens if I don’t specify a destination for the logs?

A: If no destination is specified, the collected logs will be stored in the default location /var/opt/oracle/dbaas_acfs on the guest VM.

Q: What does the –waitForCompletion option do?

A: The --waitForCompletion option specifies whether to wait for the command to finish before returning control to the user. The default value is true. If you specify false, the operation runs in the background.

Q: How can I run the log collection in the background?

A: Set the --waitForCompletion option to false to run the log collection process in the background:

dbaascli diag collect --waitForCompletion false

Q: Can I resume a previous log collection session with this command?

A: No, the dbaascli diag collect command does not support resuming previous sessions. You will need to start a new log collection process.

Q: How can I ensure that logs are uploaded directly to the Object Storage?

A: You can provide a valid --objectStoreBucketUri (Object Storage pre-authenticated request URL) where the logs will be uploaded after collection.

Q: Can I collect logs for multiple databases at once?

A: No, you can only specify one database name at a time using the --dbNames option.

Q: What should I do if I want to collect all available logs for all components?

A: Use --components all to collect logs from all components, including the database, Grid Infrastructure, operating system, and DBaaS tools.

Q: What is an example command to collect logs for the database component from a specific time range?

A: Here’s an example command:

dbaascli diag collect --components db --startTime 2024-09-01T12:00:00 --endTime 2024-09-01T14:00:00 --dbname orcl

Q: What is an example command to collect logs and upload them to Object Storage?

A: Here’s an example command:

dbaascli diag collect --components db --objectStoreBucketUri https://objectstorage.example.com/n/namespace-string/b/bucket-name/o/PAR-URL

Q: What is the default behavior if the –components option is not specified?

A: If you do not specify the --components option, the command may not know which logs to collect and could fail. It is recommended to always specify the components you want to collect logs from.

Q: Can I specify both the –objectStoreBucketUri and –destLocation options in the same command?

A: No, you must select one destination-either Object Storage via --objectStoreBucketUri or a local directory via --destLocation.

Q: What should I do if I encounter an error while using the dbaascli diag collect command?

A: Double-check that you have provided valid component names, date/time formats, and destination options. Also, ensure you are running the command as the root user.

dbaascli diag healthCheck

To run diagnostic health checks, use the dbaascli diag healthCheck command.

Prerequisites:

Run the command as the root user.

Syntax:

dbaascli diag healthCheck
[--destLocation]
[--nodes]
[--objectStoreBucketURI]

Parameters:

Parameter	Description
`--destLocation`	specifies the location on Guest VM to collect logs. Default: `/var/opt/oracle/dbaas_acfs`
`--nodes`	specifies a comma-delimited list of nodes to collect logs
`--objectStoreBucketURI`	specifies an Object Storage service pre-authenticated request (PAR) URL used to upload collected logs. Logs are collected from Guest VM. For more information, see Using Pre-Authenticated Requests.

Frequently Asked Questions:

Q: What is the purpose of the dbaascli diag healthCheck command?

A: The dbaascli diag healthCheck command is used to perform diagnostic health checks on an Oracle AI Database running in an Oracle Base Database Cloud@Customer environment.

Q: What are the prerequisites for using the dbaascli diag healthCheck command?

A: The command must be run as the root user, and you must be connected to an Oracle Base Database Cloud@Customer virtual machine.

Q: How do I specify a custom directory for collecting the logs?

A: Use the --destLocation option to specify the directory where the health check logs will be collected. The default location is /var/opt/oracle/dbaas_acfs.

Q: What is the default location for log collection if I don’t specify –destLocation?

A: The default directory for log collection is /var/opt/oracle/dbaas_acfs.

Q: Can I specify which nodes to run the health check on?

A: Yes, you can use the --nodes option to specify a comma-delimited list of nodes where the health check should be run.

Q: How do I upload the health check logs to Object Storage?

A: Use the --objectStoreBucketURI option to provide a pre-authenticated request (PAR) URL from the Object Storage service. This will upload the collected logs to the specified bucket.

Q: Can I collect logs from multiple nodes?

A: Yes, you can specify multiple nodes using the --nodes option in a comma-delimited format. For example: --nodes node1,node2.

Q: What is an example command to run a health check on a specific node?

A: Here’s an example command to run the health check on a specific node:

dbaascli diag healthCheck --nodes node1

Q: How can I store the logs in Object Storage instead of on the local machine?

A: You can provide a pre-authenticated request (PAR) URL using the --objectStoreBucketURI option to store the logs in Object Storage.

Q: Can I specify both –destLocation and –objectStoreBucketURI at the same time?

A: Yes, you can specify both --destLocation for local storage and --objectStoreBucketURI to upload logs to Object Storage.

Q: What should I do if I encounter an error while running the dbaascli diag healthCheck command?

A: Ensure that you are running the command as the root user and have provided valid options for --destLocation, --nodes, or --objectStoreBucketURI. Verify that the node names are valid if specified.

Q: Can I run the health check in the background?

A: The dbaascli diag healthCheck command does not have an explicit background mode, but you can run it in the background by appending & at the end of the command.

Q: What happens if I don’t provide the –nodes option?

A: If the --nodes option is not provided, the health check will be performed on all nodes in the cluster by default.

Q: Can I resume a previous health check session using this command?

A: No, the dbaascli diag healthCheck command does not support resuming previous sessions. You must initiate a new health check each time.

Q: What is an example command to run a health check and upload logs to Object Storage?

A: Here’s an example command:

dbaascli diag healthCheck --objectStoreBucketURI https://objectstorage.example.com/n/namespace-string/b/bucket-name/o/PAR-URL

Q: What is the default behavior if I don’t specify –destLocation or –objectStoreBucketURI?

A: If neither --destLocation nor --objectStoreBucketURI is specified, the health check logs will be collected in the default directory /var/opt/oracle/dbaas_acfs on the local machine.

Q: Can I limit the health check to specific components or logs?

A: No, the dbaascli diag healthCheck command does not allow you to specify individual components or logs. It performs a general diagnostic health check for the system.

Q: What should I verify before running the dbaascli diag healthCheck command?

A: Ensure that you are connected to an Oracle Base Database Cloud@Customer virtual machine and running the command as the root user.

System Management:

This section focuses on overseeing and managing Oracle homes within the system. It includes commands like dbaascli system getDBHomes to view details about all Oracle AI Database homes and dbaascli system getGridHomes to list the details of all Grid Infrastructure homes. These commands provide essential information for maintaining and troubleshooting the overall system environment.

dbaascli system getDBHomes

To view information about all the Oracle homes, use the dbaascli system getDBHomes command.

Prerequisites:

Run the command as the root or oracle user.

Syntax:

dbaascli system getDBHomes

Frequently Asked Questions:

Q: What is the dbaascli system getDBHomes command used for?

A: The dbaascli system getDBHomes command is used to view information about all the Oracle homes on a system.

Q: What user should execute the dbaascli system getDBHomes command?

A: The command should be executed as either the root or oracle user.

Q: Are there any parameters for the dbaascli system getDBHomes command?

A: No, the dbaascli system getDBHomes command does not have any parameters.

Q: What kind of information does the dbaascli system getDBHomes command provide?

A: The command provides details about all Oracle homes on the system, including their paths and other relevant information.

Q: How can I interpret the output from the dbaascli system getDBHomes command?

A: The output will list all Oracle homes with information such as the location of each Oracle home. This information can help in managing and configuring Oracle environments.

Q: What should I do if the dbaascli system getDBHomes command does not return any output?

A: Ensure that you are running the command as the root or oracle user and verify that Oracle homes are properly installed on the system. You may also want to check system permissions and configurations.

Q: What if I receive an error message while executing the dbaascli system getDBHomes command?

A: Check the error message for specific details, verify that you have the appropriate permissions, and ensure that the dbaascli tool is correctly installed and configured.

Q: Can I run dbaascli system getDBHomes on a non-Oracle system?

A: No, the dbaascli system getDBHomes command is specific to Oracle systems and requires Oracle software to be installed.

Example: dbaascli system getDBHomes

dbaascli system getDBHomes

dbaascli system getGridHomes

To list the details of all Grid homes, use the dbaascli system getGridHomes command.

Prerequisites:

Run the command as the root or oracle user.

Syntax:

dbaascli system getGridHomes

Frequently Asked Questions:

Q: What is the dbaascli system getGridHomes command used for?

A: The dbaascli system getGridHomes command is used to list the details of all Grid homes on a system.

Q: What user should execute the dbaascli system getGridHomes command?

A: The command should be executed as either the root or oracle user.

Q: Are there any parameters for the dbaascli system getGridHomes command?

A: No, the dbaascli system getGridHomes command does not have any parameters.

Q: What kind of information does the dbaascli system getGridHomes command provide?

A: The command provides details about all Grid homes on the system, including their locations and other relevant information.

Q: How can I interpret the output from the dbaascli system getGridHomes command?

A: The output will list all Grid homes with information such as their paths and configurations. This helps in managing and configuring Oracle Grid infrastructure.

Q: What should I do if the dbaascli system getGridHomes command does not return any output?

A: Ensure you are running the command as the root or oracle user and verify that Oracle Grid homes are properly installed on the system. Check system permissions and configurations if needed.

Q: What if I receive an error message while executing the dbaascli system getGridHomes command?

A: Review the error message for specific details, ensure you have the appropriate permissions, and verify that the dbaascli tool is properly installed and configured.

Q: Can I run dbaascli system getGridHomes on a system without Oracle Grid infrastructure?

A: No, the dbaascli system getGridHomes command is specific to systems with Oracle Grid infrastructure installed. If no Grid homes are present, the command may not return any results.