Installation
Running the Server
Environment Variables
OCI_CONFIG_PROFILE- OCI configuration profile name (default: “DEFAULT”)
Available Tools
The server provides over 150 tools for comprehensive database management:Autonomous Database Tools
| Tool Name | Description |
|---|---|
list_autonomous_databases | List Autonomous Databases in a compartment |
get_autonomous_database | Get details of the specified Autonomous Database |
list_autonomous_database_backups | List Autonomous Database backups by database ID or compartment |
get_autonomous_database_backup | Get information about the specified Autonomous Database backup |
list_autonomous_database_clones | List clones for a specific Autonomous Database |
list_autonomous_database_dataguard_associations | List Autonomous Data Guard associations for an Autonomous Database |
get_autonomous_database_dataguard_association | Get an Autonomous Data Guard-enabled database associated with the specified Autonomous Database |
list_autonomous_database_character_sets | List supported character sets for Autonomous Databases |
list_autonomous_db_versions | List supported versions for Autonomous Databases |
list_autonomous_db_preview_versions | List supported preview versions for Autonomous Databases |
get_autonomous_database_wallet | Get the wallet details for the specified Autonomous Database |
get_autonomous_database_regional_wallet | Get the Autonomous Database regional wallet details |
list_autonomous_database_software_images | List Autonomous Database Software Images in a compartment |
get_autonomous_database_software_image | Get information about the specified Autonomous Database Software Image |
Autonomous Container Database Tools
| Tool Name | Description |
|---|---|
list_autonomous_container_databases | List Autonomous Container Databases in a compartment |
get_autonomous_container_database | Get information about the specified Autonomous Container Database |
list_autonomous_container_database_versions | List supported Autonomous Container Database versions |
list_autonomous_container_database_dataguard_associations | List Autonomous Data Guard associations for an Autonomous Container Database |
get_autonomous_container_database_dataguard_association | Get an Autonomous Container Database enabled with Autonomous Data Guard |
get_autonomous_container_database_resource_usage | Get resource usage details for the specified Autonomous Container Database |
Pluggable Database (PDB) Tools
| Tool Name | Description |
|---|---|
list_pluggable_databases | Get a list of pluggable databases in a database or compartment |
get_pluggable_database | Get information about a specific pluggable database |
create_pluggable_database | Create and start a pluggable database |
create_pluggable_database_from_local_clone | Create a pluggable database from a local clone |
create_pluggable_database_from_remote_clone | Create a pluggable database by cloning from a remote source CDB |
create_pluggable_database_from_relocate | Relocate (move) a pluggable database from a source CDB into the target CDB |
update_pluggable_database | Update a specific pluggable database |
delete_pluggable_database | Delete a specific pluggable database |
Database System Tools
| Tool Name | Description |
|---|---|
list_db_systems | List DB systems in a compartment |
get_db_system | Get information about the specified DB system |
list_db_system_shapes | Get a list of shapes available for launching a new DB system |
list_db_system_compute_performances | Get a list of expected compute performance for a VM DB system |
list_db_system_storage_performances | Get a list of expected storage performance for a VM DB system |
list_db_system_patches | List patches applicable to a DB system |
get_db_system_patch | Get information about the specified patch |
get_db_system_patch_history_entry | Get the details of the specified patch operation on the specified DB system |
get_db_system_upgrade_history_entry | Get the details of the specified operating system upgrade operation for the specified DB system |
Database & Database Home Tools
| Tool Name | Description |
|---|---|
list_databases | List databases in a specified Database Home |
get_database | Get information about the specified database |
list_db_homes | List Database Homes in a DB system and compartment |
get_db_home | Get information about the specified Database Home |
list_db_home_patches | List patches applicable to a Database Home |
get_db_home_patch | Get information about a specified patch package |
list_db_home_patch_history_entries | List patch history for a Database Home |
get_db_home_patch_history_entry | Get the patch history details for the specified patchHistoryEntryId |
list_db_versions | Get a list of supported Oracle Database versions |
get_database_upgrade_history_entry | Get the upgrade history for a specified database |
Exadata Infrastructure Tools
| Tool Name | Description |
|---|---|
list_cloud_exadata_infrastructures | List cloud Exadata infrastructure resources in a compartment |
get_cloud_exadata_infrastructure | Get information about the specified cloud Exadata infrastructure resource |
get_cloud_exadata_infrastructure_unallocated_resources | Get unallocated resources information for the specified Cloud Exadata infrastructure |
list_exadata_infrastructures | List Exadata Cloud@Customer infrastructure resources in a compartment |
get_exadata_infrastructure | Get information about the specified Exadata infrastructure |
get_exadata_infrastructure_ocpus | Get details of the available and consumed OCPUs for the specified Autonomous Exadata Infrastructure resource |
get_exadata_infrastructure_un_allocated_resources | Get un allocated resources information for the specified Exadata infrastructure |
get_infrastructure_target_versions | Get details of the Exadata Infrastructure target system software versions |
VM Cluster Tools
| Tool Name | Description |
|---|---|
list_vm_clusters | List VM clusters in a compartment |
get_vm_cluster | Get information about the VM cluster |
list_cloud_vm_clusters | List cloud VM clusters in a compartment |
get_cloud_vm_cluster | Get information about the specified cloud VM cluster |
list_autonomous_vm_clusters | List Exadata Cloud@Customer Autonomous VM clusters in a compartment |
get_autonomous_vm_cluster | Get information about the specified Autonomous VM cluster for an Exadata Cloud@Customer system |
list_cloud_autonomous_vm_clusters | List Autonomous Exadata VM clusters in the Oracle cloud |
get_cloud_autonomous_vm_cluster | Get information about the specified Autonomous Exadata VM cluster in the Oracle cloud |
list_vm_cluster_patches | List patches applicable to a VM cluster |
list_vm_cluster_updates | List maintenance updates for a VM cluster |
get_vm_cluster_update | Get information about a specified maintenance update package for a VM cluster |
list_cloud_vm_cluster_updates | List maintenance updates for a specific cloud VM cluster |
get_cloud_vm_cluster_update | Get information about a specified maintenance update package for a cloud VM cluster |
Exascale Infrastructure Tools
| Tool Name | Description |
|---|---|
list_exascale_db_storage_vaults | List Exadata Database Storage Vaults in a compartment |
get_exascale_db_storage_vault | Get information about the specified Exadata Database Storage Vaults |
list_exadb_vm_clusters | List Exadata VM clusters on Exascale Infrastructure in a compartment |
get_exadb_vm_cluster | Get information about the specified Exadata VM cluster on Exascale Infrastructure |
list_exadb_vm_cluster_updates | List maintenance updates for an Exadata VM cluster on Exascale |
get_exadb_vm_cluster_update | Get information about a specified maintenance update package for an Exadata VM cluster on Exascale |
Backup & Data Guard Tools
| Tool Name | Description |
|---|---|
list_backups | List database backups by database ID or compartment |
get_backup | Get information about the specified backup |
list_backup_destination | List backup destinations in a compartment |
get_backup_destination | Get information about the specified backup destination |
list_data_guard_associations | List Data Guard associations for a database |
get_data_guard_association | Get the specified Data Guard association’s configuration information |
External Database Tools
| Tool Name | Description |
|---|---|
list_external_container_databases | List external container databases in a compartment |
get_external_container_database | Get information about the specified external container database |
list_external_non_container_databases | List external non-container databases in a compartment |
get_external_non_container_database | Get information about a specific external non-container database |
list_external_pluggable_databases | List external pluggable databases in a compartment |
list_external_database_connectors | List external database connectors in a compartment |
get_external_database_connector | Get information about the specified external database connector |
Maintenance & Scheduling Tools
| Tool Name | Description |
|---|---|
list_maintenance_runs | Get a list of maintenance runs in a compartment |
get_maintenance_run | Get information about the specified maintenance run |
list_maintenance_run_history | Get a list of maintenance run histories in a compartment |
get_maintenance_run_history | Get information about the specified maintenance run history |
list_scheduling_policies | List Scheduling Policy resources in a compartment |
get_scheduling_policy | Get information about the specified Scheduling Policy |
list_scheduling_plans | List Scheduling Plan resources in a compartment |
get_scheduling_plan | Get information about the specified Scheduling Plan |
list_scheduling_windows | List Scheduling Window resources in a compartment |
get_scheduling_window | Get information about the specified Scheduling Window |
list_scheduled_actions | List Scheduled Action resources in a compartment |
get_scheduled_action | Get information about the specified Scheduled Action |
list_execution_windows | List execution window resources in a compartment |
get_execution_window | Get information about the specified execution window |
list_execution_actions | List execution action resources in a compartment |
get_execution_action | Get information about the specified execution action |
Additional Tools
| Tool Name | Description |
|---|---|
list_db_nodes | List database nodes in a DB system and compartment |
get_db_node | Get information about the specified database node |
list_db_servers | List Exadata DB servers for an Exadata infrastructure |
get_db_server | Get information about the Exadata Db server |
list_key_stores | Get a list of key stores in the specified compartment |
get_key_store | Get information about the specified key store |
list_console_connections | List console connections for a database node |
get_console_connection | Get the specified database node console connection’s information |
list_console_histories | List console histories for a database node |
get_console_history | Get information about the specified database node console history |
list_database_software_images | List database software images in a compartment |
get_database_software_image | Get information about the specified database software image |
list_oneoff_patches | List one-off patches in a compartment |
get_oneoff_patch | Get information about the specified one-off patch |
Usage Examples
Autonomous Database Management
Pluggable Database Operations
Database System Management
Backup Management
Data Guard Configuration
Maintenance Operations
Authentication
The server uses OCI CLI configuration from~/.oci/config. Configure with:
Required Permissions
Your OCI user or instance principal needs appropriate IAM permissions: Full Database Management:Common Use Cases
Autonomous Database Deployment
- Provision new Autonomous Databases
- Configure auto-scaling
- Download connection wallets
- Monitor database metrics
Database Lifecycle Management
- Create and manage pluggable databases
- Clone databases for testing
- Perform backups and restores
- Apply patches and updates
High Availability
- Configure Data Guard for disaster recovery
- Monitor Data Guard associations
- Perform switchover operations
- Track replication lag
Exadata Management
- Monitor Exadata infrastructure
- Manage VM clusters
- Track resource allocation
- Plan capacity
Related Services
- Object Storage - Store database backups
- Networking - Configure database network access
- Monitoring - Monitor database performance
- Identity - Manage database access
