Oracle Exadata Database Service on
Cloud@Customer provides a variety of management interfaces to fit your use case and automation needs.
Introduction to Exadata Cloud Management Interfaces The Exadata Cloud resources on Oracle Cloud Infrastructure (OCI) are created and managed through a variety of interfaces provided to fit your different management use cases.
Introduction to Exadata Cloud
Management Interfaces ๐
The Exadata Cloud resources on Oracle Cloud Infrastructure (OCI) are created
and managed through a variety of interfaces provided to fit your different management use
cases.
The various interfaces include:
OCI Console interface and automation tools, see Using the
Console
Application Programming Interfaces (APIs)
Command-Line Interfaces (CLIs)
The management interfaces are grouped into two primary categories:
OCI Control Plane Interfaces
Local Exadata Cloud VM CLIs
Note
For more information and best practices on how these interfaces align for various
Exadata Cloud database management use cases, refer to My Oracle Support note:
Exadata Cloud API/CLI Alignment Matrix (Doc ID 2768569.1).
The OCI APIs are typical REST APIs that use HTTPS requests and responses. The OCI Console, an intuitive, graphical interface for creating and managing your Exadata Cloud and other OCI resources, is one of the interfaces to the OCI APIs. When looking to develop automation utilizing the OCI APIs, a number of additional interfaces including: kits, tools and plug-ins, are provided to facilitate development and simplify the management of OCI resources. A subset of these APIs apply to Exadata Cloud resources and its infrastructure. Each of these interfaces can be used to accomplish the same functionality, all calling the OCI APIs, and are provided to enable flexibility and choice depending on preference and use case.
Command Line Interface (CLI): The OCI CLI is a small footprint tool that you
can use on its own or with the Console to complete Exadata Cloud resource and other
OCI tasks. The CLI provides the same core functionality as the Console, plus
additional commands. Some of these, such as the ability to run scripts, extend the
Console's functionality.
Software Development Kits (SDK): OCI provides SDKs to enable the developing
custom solutions for your Exadata Cloud and other OCI based services and
applications.
DevOps Tools and Plug-ins: These tools can simplify provisioning and managing
infrastructure, enable automated processes and facilitate development. Tools include
the OCI Terraform Provider used with Resource Manager and OCI Ansible
Collection.
Cloud Shell: Cloud Shell is a free-to-use, browser-based terminal, accessible
from the OCI Console, that provides access to a Linux shell with pre-authenticated
OCI CLI and other useful developer tools. You can use the shell to interact with
Exadata Cloud and other OCI resources, follow labs and tutorials, and quickly run
OCI CLI commands.
Appendix and Reference: This general reference shows how to configure the
SDKs and other developer tools to integrate with Oracle Cloud Infrastructure
services.
REST APIs: This complete reference provides details on the Oracle
Cloud Infrastructure REST APIs, including descriptions, syntax, endpoints, errors,
and signatures. Exadata Cloud@Customer specific OCI REST APIs can be found
throughout the documentation in the Using the API
sections:
Using the API to Manage Exadata Cloud@Customer
Infrastructure
Using the API to Manage Exadata
Cloud@Customer Backup Destinations
Using the API to Manage Exadata
Cloud@Customer VM Clusters
Using the API to Create Oracle Database Home
on Exadata Cloud@Customer
Using the API to Manage Oracle Database Home
on Exadata Cloud@Customer
Using the API to Manage Oracle Database
Components
Using the API to Manage Data Guard
Associations on an Exadata Cloud@Customer System
Using the API to Manage Database Backup and
Recovery
Using the API to Patch an Exadata
Cloud@Customer System
In addition to the OCI REST-based APIs, CLI utilities located on the VM
guests, provisioned as part of the VM clusters on the Exadata Cloud Infrastructure, are
available to perform various lifecycle and administration operations.
The best practice is to use these utilities when a corresponding OCI API is not available
or the Exadata Cloud@Customer is in a disconnected mode.
The utilities include:
dbaascli: Use the dbaascli utility to
perform various database lifecycle and administration operations on the Exadata
Cloud Service such as
changing the password of a database user
starting a database
managing pluggable databases (PDBs)
scaling the CPU core count in disconnected mode
bkup_api: Use the bkup_api utility to
perform various backup and recovery operations on the Exadata Cloud Service such
as creating an on-demand backup of a complete database or an individual
pluggable database (PDB), or to customize backup
settings used by the automatic backup configuration
ExaCLI: Use the ExaCLI command-line utility to perform
monitoring and management functions on Exadata storage servers in the Exadata
Cloud.
These utilities are provided in addition to, and separate from, the OCI
API-based interfaces listed above. To use the local VM command-line utilities, you must
be connected to a virtual machine in an Exadata Cloud VM cluster and use the VM
operating system user security, not the OCI user security, for execution. The utilities
can be used to perform operations if the Exadata Cloud@Customer is disconnected from the
OCI Control Plane. Most operations executed by these utilities sync their changes back
to the OCI Control Plane using a process called DB Sync. However, there
can be operations not synced with the Control Plane.
The cloud tooling software on the virtual machines, containing these CLI
utilities, is automatically updated by Oracle on a regular basis. If needed, the tooling
can be updated manually by following the instructions in Updating Cloud Tooling Using
dbaascli.