14 Managing an Oracle Database Appliance KVM Deployment
KVM virtualization uses a kernel-based virtual machine (KVM) to create a virtualized environment for your Linux applications.
Understand the Oracle Database Appliance KVM architecture, and procedures to deploy a guest virtual machine, manage high availability, manage CPU pools, and configure network settings for Oracle Database Appliance KVM deployment.
- About Oracle Database Appliance KVM Deployment
You can use Oracle KVM to optimize your system resource use for databases and applications. - About Oracle Database Appliance KVM Virtualization Architecture
Review this topic to understand how Oracle Database Appliance KVM deployment works with Oracle Database Appliance hardware. - About Virtual Machines and Oracle Database Appliance KVM Deployments
Oracle Database Appliance KVM deployment is designed to run and deploy virtual machines to manage system resources. - About KVM Database Systems on Oracle Database Appliance
Understand how you can deploy KVM-based database systems on Oracle Database Appliance to run your Oracle Database environments. - Managing Database Systems in KVM Deployment
Use ODACLI to create, list, describe, start, stop, and delete database systems in an Oracle Database Appliance KVM deployment. - Setting Up and Configuring a KVM Deployment for Applications
Understand the steps to set up and configure KVM deployment for applications. - Managing VM Storage in KVM Deployment
Use ODACLI to create, view, modify, and delete VM storage in an Oracle Database Appliance KVM deployment. - Managing Virtual Networks in KVM Deployment
Use ODACLI to create, view, start, stop, and delete virtual networks in an Oracle Database Appliance KVM deployment. - Managing Virtual Disks in KVM Deployment
Use ODACLI to create, view, clone, modify, and delete virtual disks on Oracle Database Appliance KVM deployment. - Managing Virtual Machines in KVM Deployment
Use ODACLI to create, view, clone, modify, start, stop, and delete virtual machines in an Oracle Database Appliance KVM deployment. - Example JSON File to Create a Single-Node DB System
Follow the JSON file example to create a JSON file to deploy a single-node DB System, with role separation, with the commandodacli create-dbsystem
. - Example JSON File to Create a High-Availability DB System
Follow the JSON file example to create a JSON file to deploy a two-node DB System, with role separation, with the commandodacli create-dbsystem
.
About Oracle Database Appliance KVM Deployment
You can use Oracle KVM to optimize your system resource use for databases and applications.
You can deploy a KVM-based virtual platform on Oracle Database Appliance. With Oracle Database Appliance KVM deployments, you can use the capabilities of Oracle KVM to effectively allocate resources to databases and applications running on the same physical Oracle Database Appliance. Rather than simply disabling unnecessary server cores, you can use the excess capacity to host other workloads. This enables consolidation of both databases and applications, while retaining the ease of deployment and management associated with Oracle Database Appliance.
The Kernel-based Virtual Machine (KVM) feature provides a set of modules that enable you to use the Oracle Linux kernel as a hypervisor. KVM supports both x86_64 and aarch64 processor architectures. By default, KVM is built into the Unbreakable Enterprise Kernel (UEK) release. KVM features are actively developed and may vary depending on platform and kernel release. If you are using Unbreakable Enterprise Kernel, you should refer to the release notes for the kernel release that you are currently using to obtain information about features and any known issues or limitations that may apply. KVM is supported on Oracle Linux 7.
What are the differences between KVM and Oracle VM Virtualization?
Oracle KVM makes it easy to setup and manage the virtualized environment with little virtualization expertise. With the KVM deployment, you can consolidate entire multi-tier environments within a single Oracle Database Appliance system.
The following are some of the advantages of deploying Oracle Database Appliance with the KVM option:
-
Deploy database and applications in a single hardware environment.
-
Use your CPU cores (and memory) efficiently.
-
Use virtual local area networks (VLANs) to provide separate networks to different virtual machines.
-
Use VM storage to grow storage for the virtual machine repository.
- Enables easy resource management per VM and maintainence of quality of service (QoS)
- Provides solution-in-a-box with application, middleware, and databases.
-
Improves data center efficiency by increasing space utilization and reducing energy consumption and cooling costs.
- Oracle KVM virtualization is available on bare metal deployments of Oracle Database Appliance, whereas Oracle VM virtualization on Oracle Database Appliance requires Virtualized Platform setup.
- Oracle Database Appliance supports KVM on all hardware models, whereas Virtualized Platform deployments using Oracle VM are supported on only Oracle Database Appliance High-Availability models.
- Oracle Database Appliance KVM deployments use Type 2 host operating system-based hypervisor, whereas Oracle Database Appliance Virtualized Platform deployments use Type 1 bare metal hypervisor.
- KVM is the virtualization technology used in Oracle Cloud Infrastructure (OCI), where as Oracle Database Appliance Virtualized Platform is based on Xen technology.
Parent topic: Managing an Oracle Database Appliance KVM Deployment
About Oracle Database Appliance KVM Virtualization Architecture
Review this topic to understand how Oracle Database Appliance KVM deployment works with Oracle Database Appliance hardware.
Oracle Database Appliance KVM deployment provides virtualization technology that enables multiple applications to share the same physical server. The Oracle Database Appliance KVM architecture is engineered specifically to leverage the Oracle Database Appliance hardware capabilities. Oracle Database Appliance KVM stack is integrated with Oracle Clusterware. The KVM resources such as VM storages and Virtual Machines are registered as CRS resources and are automatically managed by CRS for high availability.
Parent topic: Managing an Oracle Database Appliance KVM Deployment
About Virtual Machines and Oracle Database Appliance KVM Deployments
Oracle Database Appliance KVM deployment is designed to run and deploy virtual machines to manage system resources.
Configure virtual machines on Oracle Database Appliance KVM deployment to manage your application use of resources, such as the CPU pool, memory, and other shared resources.
Understand the terminology of the various components you need to set up for an Oracle Database Appliance KVM deployment. The ODACLI tooling handles all the required configuration for your Oracle Database Appliance KVM deployment.
VM Storage
A vm storage is a central location for storing resources that are essential to creating and managing virtual machines. These resources include ISO files (virtual DVD images), virtual machine configuration files, and virtual disks. Virtual storage is configured on an Oracle Automatic Storage Management Cluster File System (Oracle ACFS) and then presented to the Oracle Database Appliance nodes that need access to those resources. Oracle Database Appliance Virtualized Platform uses virtual storage to optimize available disk space usage in the environment, and for easy reallocation of virtual machines if a physical server fails. The virtual machine files can be stored on shared disks, providing shared storage for the virtual machines. You can:
-
Create one or more virtual machines on the virtual storage.
-
Use ODACLI commands to create and manage virtual storage, virtual disks, and their virtual machines, and the underlying architecture shown in the illustration.
Virtual Networks
Oracle Database Appliance KVM virtual network supports two type of networks, bridged and bridged-vlan. The above figure is an example of the KVM virtual network on Oracle Database Appliance X8-2 hardware models.
In a bridged network, a Linux bridge is created and the
network interface or bond interface, is attached to the bridge. A
default bridge network named pubnet is created on the public network
selected during the appliance deployment. Any VM that wants to
access this public network can be attached using this pubnet
vnetwork. This pubnet vnetwork cannot be modified or deleted. In the
above diagram, btbond1 is used for the public network, and default
vnetwork pubnet is created with btbond1
.
eth0
of VMs are attached to this pubnet
vnetwork. Except for the default pubnet bridge, no other bridged
network is allowed to be created on this public network interface.
Additional bridged vnetwork can be created on other interfaces that
are not used for the public network. In the above diagram, the
mgmtNet
bridged network is created with
btbond2
. eth1
of VM3 is
attached to this mgmtNet
vnetwork.
odacli create-vnetwork --name mgmtNet --bridge mgmtNet --type bridged --interface btbond2 --ip ip_address --gateway gateway --netmask netmask
In a bridged-vlan network, VLAN can be created on all
available public interfaces, including the interface where public
network is already configured. For example, you can create a VLAN on
both btbond1
and btbond2
. Follow
proper procedures to configure the VLAN on the switch before
creating the bridged-vlan network. In the figure above,
backupVLan
and AppsVlan1
are created from btbond1
and attached to
eth1
and eth2
of VM1 and
VM2 respectively.
odacli create-vnetwork --name backupvlan --bridge backupvlan --type bridged-vlan --vlan-id 12 --interface btbond1 --ip ip_address --gateway gateway --netmask netmask
vnetwork is not supported on private interfaces and secondary interfaces of the bond interface.
Virtual Disks
In addition to virtual machines, you can create virtual disks in virtual storage. Virtual disks provide additional storage options for virtual machines by enabling you to attach additional block storage to your virtual machines. Similarly, you can detach the disk if you no longer need the additional space. You can use virtual disks to expand existing file system storage inside the virtual machine by extending the storage volume onto a virtual disk, or by creating a new file system on a virtual disk. Virtual disks can optionally be attached to multiple virtual machines.
Virtual Machines
A virtual machine is granted virtual resources, and can be started, stopped,
cloned, and restarted independently. By default, virtual machines
are created with autostart and failover enabled for
high-availability models. During failover, the VM is automatically
started during the reboot, and there will be attempt to restart once
before failing over to a different node on high-availability models.
You can enable or disable autostart and failover using the
odacli modify-vm
command options. The
option to autostart is also available on single-node Oracle Database
Appliance models.
Parent topic: Managing an Oracle Database Appliance KVM Deployment
About KVM Database Systems on Oracle Database Appliance
Understand how you can deploy KVM-based database systems on Oracle Database Appliance to run your Oracle Database environments.
About KVM Database Systems
KVM database systems enable hard partitioning for Oracle Database licensing, where each KVM database system has its own CPU pool that is automatically assigned during KVM database system creation. Oracle Database Appliance simplifies the management of KVM database systems with the built-in Browser User Interface (BUI) or ODACLI Command Line Interface (ODACLI).
About KVM Database System Architecture
You can provision and configure a database system on an Oracle KVM. The database can be a single-instance Oracle Database or an Oracle RAC Database with two instances.
About KVM Database System Networks
- Public network: In Oracle Database Appliance database system on KVM, the default vnetwork pubnet is created based on the public interface you select for GI provisioning. The pubnet network is selected by default as the public network of the database system. You can also create a different vnetwork and use it as public network for the dbsystem.
- Oracle ASM network and database system cluster interconnect network are created and managed internally. 192.168.16.0/24 and 192.168.17.0/24 are reserved for the use of these two internal networks. So, ensure that the IP addresses 192.168.16.0/24 and 192.168.17.0/24 are available for use by Oracle Database Appliance database system on KVM.
Restrictions When Deploying KVM Database System
The following restrictions apply when you deploy KVM database system on Oracle Database Appliance:
- You can create only one database for each database system.
- The shape of the database system is derived from the shape you select for the database. The CPU cores for the database system is set as defined in the database shape. For example, if you select odb4 as the database shape, in which the database uses 4 cores, then the database system is created with 4 cores. odb1s and odb1 shapes are not supported by the database system.
-
You cannot use Oracle ACFS for storage within the database system. The database system uses Oracle ASM storage.
-
Only Oracle Database release 19.11 is supported within the database system.
-
You cannot configure CPU Pools or run VM commands within the database system.
Parent topic: Managing an Oracle Database Appliance KVM Deployment
Managing Database Systems in KVM Deployment
Use ODACLI to create, list, describe, start, stop, and delete database systems in an Oracle Database Appliance KVM deployment.
- Creating a Database System in a KVM Deployment
Use ODACLI commands or the Browser User Interface to create a database system in a KVM deployment. - Listing Database Systems in a KVM Deployment
Use ODACLI commands or the Browser User Interface to list database systems in a KVM deployment. - Describing a Database System in a KVM Deployment
Use ODACLI commands or the Browser User Interface to describe a database system in a KVM deployment. - Modifying a Database System in a KVM Deployment
Use ODACLI commands or the Browser User Interface to modify a database system in a KVM deployment. - Starting a Database System in a KVM Deployment
Use ODACLI commands or the Browser User Interface to start a database system in a KVM deployment. - Stopping a Database System in a KVM Deployment
Use ODACLI commands or the Browser User Interface to stop a database system in a KVM deployment. - Deleting a Database System in a KVM Deployment
Use ODACLI commands or the Browser User Interface to delete a database system in a KVM deployment. - Managing Shared CPU Pool with Database System in a KVM Deployment
Use ODACLI commands or the Browser User Interface to manage shared CPU pool with database system in a KVM deployment. - Managing Backup, Restore, and Recovery on a Database System in a KVM Deployment
Understand the backup, restore, and recovery operations supported on a database system in a KVM deployment. - Managing Oracle Data Guard on a Database System in a KVM Deployment
Understand the Oracle Data Guard operations supported on a database system in a KVM deployment.
Parent topic: Managing an Oracle Database Appliance KVM Deployment
Creating a Database System in a KVM Deployment
Use ODACLI commands or the Browser User Interface to create a database system in a KVM deployment.
Important:
Your bare metal deployment must be on Oracle Database Appliance release 19.11 before you can create a KVM database system running Oracle Database 19.12 or 21.3. If your system is patched to Oracle Database Appliance release 19.11, then download release 19.11 or 21.3 Oracle Grid Infrastructure and Oracle Database clone files separately, before you create the Oracle KVM Database System.
Remember:
To create the database system, access control must be enabled in
Oracle ASM running on bare metal system. When the bare metal system is newly
provisioned or patched to Oracle Database Appliance release 19.11, access control is already enabled. This
helps you set appropriate file ownerships for all the files created in DB
systems and on bare metal. Before you create the database system, the files on
Oracle ASM disk groups that do not have file ownership must be set up with
ownership. Otherwise, creation of database system fails. Use the odacli
modify-dbfileattributes
command to set up the file ownerships.
Using ODACLI to Create a KVM Database System
Use the command odacli create-dbsystem
to
create a KVM database system.
- Download the Oracle Database Appliance KVM DB System Image
(patch 32451228) from My Oracle Support to a temporary location on an
external client. Refer to the release notes for details about the software
for the latest
release.
p32451228_1912000_Linux-x86-64.zip
- Unzip the software — it contains README.html and one or more
zip files for the
patch.
unzip p32451228_1912000_Linux-x86-64.zip odacli-dcs-19.11.0.0.0-ODAVM.zip
- Update the repository with the image. The database system
version must be the same as the Oracle Database Appliance
version.
# /opt/oracle/dcs/bin/odacli update-repository -f /tmp/odacli-dcs-19.11.0.0.0-ODAVM.zip
- Run the
odacli describe-dbsystem-image
command to query the supported Oracle Grid Infrastructure and Oracle Database versions for this database system KVM image.# odacli describe-dbsystem-image DB System Image details -------------------------------------------------------------------------------- Component Name Supported Versions Available Versions -------------------- -------------------- -------------------- DBVM 19.12.0.0.0 19.12.0.0.0 GI 21.3.0.0.210720 21.3.0.0.210720 19.12.0.0.210720 19.12.0.0.210720 DB 21.3.0.0.210720 21.3.0.0.210720 19.12.0.0.210720 19.12.0.0.210720
- If the
odacli describe-dbsystem-image
command output shows any component asnot-available
on the system, then download the component withsupported versions
and run theodacli update-repository
to import the component to the repository. - Create the
prov.json
file as per examples provided in this chapter. - Run the
odacli create-dbsystem
command with theprov.json
file on the host.# odacli create-dbsystem -p prov.json
- If the
odacli create-dbsystem
command prompts "ASM ACL setup is not completed, please run 'odacli modify-dbfileattributes' command", then run theodacli modify-dbfileattributes
command, and make sure the job finishes successfully before running theodacli create-dbsystem
command. - If the
odacli create-dbsystem
command prompts "css_critical configuration should be different on both nodes" on a high-availability environment, then follow the instructions below to set css_critical and ensure that the dbsystem functions properly when interconnect fails.- Run "crsctl set server css_critical yes" on the first BM host. You must restart the Oracle Clusterware stack on the node for the values to take effect.
- Run "crsctl set server css_critical no" on the second BM host. You must restart the Oracle Clusterware stack on the node for the values to take effect.
- Run "crsctl get server css_critical" to verify the value.
Refer to Oracle Clusterware Administration and Deployment Guide for more details about setting css_critical.
Using Browser User Interface to Create a KVM Database System
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click DB Systems to display the DB Systems page.
- In the page, if no DB System exists, then click Create DB System.
- In the Create DB System page, provide the DB system values.
- If you want to use an existing configuration file, click Browse and select the configuration file. The system information from the file is populated in the relevant fields.
- In the System Information section, specify the values as
follows.
- DB System Name: Enter the DB System name. The name cannot end with a dash (-). Do not exceed 15 characters.
- Domain Name: Enter the domain name.
- Region: Select the region of the world where the Oracle Database Appliance is located.
- Time Zone: Select the time zone where the Oracle Database Appliance is located.
- Disk Group for VM Storage: Select the disk group that is used for hosting the KVM storage. Note that this is different from the database file storage for the database that runs in the KVM.
- System Password and
Confirm Password: Enter the system
password in both fields. The system password is the password set for
UNIX and
root
users. The password must contain at least two characters each from: uppercase letters, lowercase letters, numbers (0-9), and allowed special characters #, - or _. The password must have a minimum of 9 characters and a maximum of 30 characters. - (Optional) DNS Servers: Enter addresses for one or more DNS servers.
- (Optional) NTP Servers: Enter addresses for one or more NTP servers.
- In the Network Information section, specify the client access
network details, depending on whether it is a single-node or two-node Oracle
Database Appliance deployment:
- Node Name: For Node0, enter the host name for the primary client access network.
- IP Address: Enter the virtual IP address that is shared between the nodes.
- Subnet Mask: Enter the subnet mask address for the primary client access network.
- Gateway: Enter the gateway address for the primary client access network.
For two-node deployments, provide the above values for both nodes. In addition, you must also specify the following:- VIP: Specify the Virtual IP address.
- SCAN: Specify the Single Client Access Name (SCAN).
- Determine how you want to configure your users and groups and whether or not
you want to allow operating system role separation:
- Two users with six groups: Customize Users and Groups, select No. Allow OS Role Separation, select Yes. This is the default configuration.
- Two customized users with six customized groups: Customize Users and Groups, select Yes. Allow OS Role Separation, select Yes.
- Single user with two groups: Customize Users and Groups, select No. Allow OS Role Separation, select No.
- Single user with six groups: Customize Users and Groups, select Yes. Allow OS Role Separation, select No.
- Specify the GI User, DB User, Install Group, DBA Oper Group, DBA Group, ASM Admin Group, ASM Oper Group, ASM DBA Group, and the User and Group IDs.
- Enter the following information to configure the database:
- DB Name: Enter a name for the database. The name must contain alphanumeric characters and cannot exceed 8 characters.
- (Optional) DB Unique Name: Enter
a globally unique name for the database.
Databases with the same DB Name within the same domain (for example, copies of a database created for reporting or a physical standby) must have a different DB Unique Name that is unique within the enterprise. The name must begin with a lowercase or uppercase letter, and contain only alphanumeric characters and underscores(_). The name must not contain dollar ($), and pound (#) characters. The name cannot exceed 30 characters.
- CDB: Select Yes or No to specify whether or not you want a Container Database (CDB).
- PDB Name: Enter a name for the pluggable database (PDB).
- PDB Admin User: Enter an Admin user name for the pluggable database (PDB). The name must begin with an alphanumeric character. You can specify alphanumeric characters and underscore (_) in the name.
- Database Edition: Select the Oracle Database edition, either Standard Edition and Enterprise Edition. Your license determines which database edition you are eligible to create in the DB System.
- Password and Confirm Password: Provide a password for the database.
- Shape: Select a database shape from the list.
- In the Database Class field, select a database class from the drop-down list. If an option is not available in the list, it is not supported for the database edition on the Oracle Database Appliance or the version that you selected. The default is OLTP.
- Configure EM Express: Select Yes or No. Select Yes to configure the Oracle Enterprise Manager Database Express (EM Express) console.
- Character set: Select a character set.
- National Characterset: Select a national characterset.
- Language: Select the database language.
- Territory: Select a territory or location from the list.
- For Oracle Database Enterprise Edition 18c or later, you can choose to enable Transparent Database Encryption (TDE). Select Yes or No in the Enable TDE option. Specify and confirm the TDE Password. By default, the TDE option is disabled.
- Click Create.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Listing Database Systems in a KVM Deployment
Use ODACLI commands or the Browser User Interface to list database systems in a KVM deployment.
Using ODACLI to List KVM Database Systems
odacli list-dbsystems
to
list KVM database systems.
# odacli list-dbsystems
Using Browser User Interface to List KVM Database Systems
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click DB Systems to display the DB Systems page.
- In the page, click on the DB System for which you want to view details.
Describing a Database System in a KVM Deployment
Use ODACLI commands or the Browser User Interface to describe a database system in a KVM deployment.
Using ODACLI to Describe a KVM Database System
odacli describe-dbsystem
to describe a KVM database system.
# odacli describe-dbsystem -n dbsystem_name
Using Browser User Interface to Describe a KVM Database System
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click DB Systems to display the DB Systems page.
- In the page, click on the DB System for which you want to view details or click on the Actions drop down and select View Details to view the DB System details.
- Click on the System Information tab for the DB System details, associated CPU Pool, Storage details, and associated VMs.
- Click on the Database Information tab to view the associated database details.
- Click on the Network Information tab to view the network details for single node or high-availability deployments.
Modifying a Database System in a KVM Deployment
Use ODACLI commands or the Browser User Interface to modify a database system in a KVM deployment.
Using ODACLI to Modify a KVM Database System
odacli modify-dbsystem
to
change the database shape or the CPU pool association for the KVM database system.
# odacli modify-dbsystem -n dbsystem_name [-cp cpu_pool_name] [-no-cp] [-s shape]
You can attach a CPU pool to the database system, or remove the CPU pool from the database system.
You can only scale up (increase) the database shape with the odacli
modify-dbsystem
command. To modify the database shape, after running
the odacli modify-dbsystem
command, manually run the odacli
modify-database
command inside the dbsystem to change the database
shape.
odacli modify-dbsystem
to attach or detach
the shared dbsystem CPU pool. Attaching shared dbsystem CPU pool removes the
internal CPU pool created when the dbsystem is created. When detaching shared CPU
pool from the dbsystem, an internal CPU pool is automatically created and attached
to the dbsystem. One shared dbsystem CPU pool can be attached to multiple dbsystems.
Oversubscribing to shared dbsystem CPU pool is allowed, but there could be potential
performance impact if shared CPU pool is oversuscribed.
Note:
Theodacli
modify-dbsystem -s shape
command only works on Oracle Database
Appliance release 19.11 and later dbsystems. The CPU pool commands are available
on Oracle Database Appliance release 19.11 and later dbsystems.
Using Browser User Interface to Modify a KVM Database System
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click DB Systems to display the DB Systems page.
- In the page, click on the DB System for which you want to view details or click on the Actions drop down and select Modify to change the DB System shape or attach or detach CPU pool for the DB System.
- Select the new shape and CPU pool and click
Modify
. - Confirm your action to submit the job to modify the DB System.
You can manually run the
odacli modify-database
command inside the dbsystem to change the database shape.
Starting a Database System in a KVM Deployment
Use ODACLI commands or the Browser User Interface to start a database system in a KVM deployment.
Using ODACLI to start a KVM Database System
odacli start-dbsystem
to
start a KVM database system.
# odacli start-dbsystem -n dbsystem_name
Using Browser User Interface to Start a KVM Database System
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click DB Systems to display the DB Systems page.
- In the page, click on the DB System which you want to start.
- Click on the System Information tab and then click Start.
- For high-availability deployments, select the node on which you want to start the DB System. Click Yes.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID. - When the DB System starts, the state displays as ONLINE.
Stopping a Database System in a KVM Deployment
Use ODACLI commands or the Browser User Interface to stop a database system in a KVM deployment.
Using ODACLI to Stop a KVM Database System
odacli stop-dbsystem
to
stop a KVM database system.
# odacli stop-dbsystem -n dbsystem_name
Using Browser User Interface to Stop a KVM Database System
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click DB Systems to display the DB Systems page.
- In the page, click on the DB System which you want to stop.
- Click on the System Information tab and then click Stop.
- For high-availability deployments, select the node on which you want to stop the DB System. Click Yes.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID. - When the DB System stops, the state displays as OFFLINE.
Deleting a Database System in a KVM Deployment
Use ODACLI commands or the Browser User Interface to delete a database system in a KVM deployment.
Using ODACLI to Delete a KVM Database System
odacli delete-dbsystem
to
delete a KVM database system.
# odacli delete-dbsystem -n dbsystem_name -f
If you do not specify the -f
option, then the operation deletes the
database system and Oracle Clusterware files, and retains the database files. With
the -f
option, the operation deletes the database system, Oracle
Clusterware files, and the database files.
Using Browser User Interface to Delete a KVM Database System
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click DB Systems to display the DB Systems page.
- In the page, for DB System which you want to delete, click on the Actions drop down list and select Delete.
- Confirm that you want to delete the DB System. Select Force Delete if you want to delete the database system, Oracle Clusterware files, and the database files during the delete operation. Click Yes.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Managing Shared CPU Pool with Database System in a KVM Deployment
Use ODACLI commands or the Browser User Interface to manage shared CPU pool with database system in a KVM deployment.
Using ODACLI to Manage Shared CPU Pool with Database System
Creating a dbsystem automatically creates an internal dbsystem CPU pool associated with this dbsystem. The internal dbsystem CPU pool is created and managed internally. It cannot be created, modified, or deleted manually. Starting with release 19.11, you can create a new type of shared CPU pool using the odacli create-cpupool --dbsystem/-dbs -n cores command. Similarly to VM and BM types, this CPU pool must not overlap with other CPU pools. In high-availability environments, the dbsystem CPU pool cannot be local, it must exist on both nodes always.
Associating shared DB System CPU Pool
odacli
modify-dbsystem
command to associate the CPU pool to an existing
dbsystem.# odacli modify-dbsystem -n dbsystem_name -cp dbspool1
the cores of the DB System (based on its shape) must fit into the shared
DB System CPU pool. Associating a shared dbsystem CPU pool to an existing dbsystem
removes the internal CPU pool associated to the dbsystem. A single shared DB System
CPU pool can be shared by multiple DB Systems, Oversubscription to the dbsystem
cpupool is allowed, but performance may be impacted if CPU pool is oversubscribed.
The list of associated DB systems can be queried using odacli
list-cpupool
or odacli describe-cpupool
commands.
Use odacli describe-dbsystem
to check the details of the
CPU pool associated to the dbsystem:
# odacli describe-dbsystem -n dbs4e912c
CPU Pool
--------------------------
Name: ce3f42bb28
Number of cores: 2
Host: n1
Effective CPU set: 9-10,29-30
Online CPUs: 9, 10, 29, 30
Offline CPUs: NONE
Host: n2
Effective CPU set: 9-10,29-30
Online CPUs: 9, 10, 29, 30
Offline CPUs: NONE
Use odacli list-cpupools
to view the dbsystem CPU pool
type and associated dbsystems. The internal dbsystem CPU pool has type "DB_SYSTEM"
and shared dbsystem CPU pool has type "DB_SYSTEM_SHARED".
# odacli list-cpupools
Name Type Configured on Cores Associated resources Created Updated
-------------------- ------------------ ------------------------- ----- ------------------------------ ----------------------- -----------------------
bmpool1 BM n1, 2 NONE 2021-03-30 17:54:59 UTC 2021-03-30 17:55:00 UTC
n2
vmpool1 VM n1, 2 NONE 2021-03-30 17:54:48 UTC 2021-03-30 17:54:49 UTC
n2
dbspool1 DB_SYSTEM_SHARED n1, 4 NONE 2021-03-30 17:55:11 UTC 2021-03-30 17:55:11 UTC
n2
ce3f42bb28 DB_SYSTEM n1, 2 dbs4e912c 2021-03-30 17:57:43 UTC 2021-03-30 18:01:27 UTC
n2
Use odacli describe-cpupool
to find out more details
about dbsystem CPU pool:
# odacli describe-cpupool -n ce3f42bb28
CPU Pool details
--------------------------------------------------------------------------------
ID: 8e62933b-b394-4bcf-9c32-6a4cea2e0360
Name: ce3f42bb28
Created: 2021-03-30 17:57:43 UTC
Updated: 2021-03-30 18:01:27 UTC
Type: DB_SYSTEM
Number of cores: 2
Associated resources: dbs4e912c
CPU Allocations
--------------------------
Node: n1
Effective CPU set: 9-10,29-30
Online CPUs: 9, 10, 29, 30
Offline CPUs: NONE
Node: n2
Effective CPU set: 9-10,29-30
Online CPUs: 9, 10, 29, 30
Offline CPUs: NONE
Dissociating Shared DB System CPU Pool
A DB System with a shared DB System CPU pool could have the shared CPU
pool detached from it and an internal DB System CPU Pool is created. If the internal
DB system CPU pool cannot be created, then the odacli
modify-dbsystem
command fails.
Dissociating shared DB System CPU Pool:
# odacli modify-dbsystem -n dbs4e912c -no-cp
Modifying Shared DB System CPU Pool
A shared DB System CPU pool could be resized if all the associated DB systems shapes still fit into the cores of the pool (CPU pool size >= individual DB system size) The change is effective immediately on running DB System VMs.
Modifying a DB System while associated to a Shared DB System CPU Pool
If a DB System is associated with a shared DB System CPU Pool and its
shape is modified with the odacli modify-dbsystem
command, then the
new shape of the DB System must fit into the cores of the pool.
Deleting Shared DB System CPU Pool
A shared DB system CPU Pool can be deleted using the odacli
delete-cpupool
command only if it has no associated DB systems.
Managing Backup, Restore, and Recovery on a Database System in a KVM Deployment
Understand the backup, restore, and recovery operations supported on a database system in a KVM deployment.
About Backup, Restore, and Recovery on a Database System
Similar to the bare metal systems, you can use ODACLI commands to
configure and perform backup, restore, and recovery operations on Database Systems.
Since only one database is supported per dbsystem, you must delete the database
using odacli delete-database
in the standby dbsystem before
restoring the database to the dbsystem using iRestore. For information about backup,
restore, and recovery on Oracle Database Appliance, see the chapter Backup, Recover and Restore in this guide.
Related Topics
Parent topic: Managing Database Systems in KVM Deployment
Managing Oracle Data Guard on a Database System in a KVM Deployment
Understand the Oracle Data Guard operations supported on a database system in a KVM deployment.
About Using Oracle Data Guard on a Database System
Similar to the bare metal systems, you can configure and use Oracle Data
Guard on Database Systems using ODACLI commands. Since only one database is
supported per dbsystem, you must delete the database in the standby dbsystem using
odacli delete-database
, before restoring the standby database,
and then configuring Oracle Data Guard. For information about Oracle Data Guard on
Oracle Database Appliance, see the chapter Using Oracle Data Guard
for Disaster Management and Recovery on Oracle Database Appliance in this
guide.
Setting Up and Configuring a KVM Deployment for Applications
Understand the steps to set up and configure KVM deployment for applications.
- Create a VM storage.
- Create a virtual network.
- Create virtual disks.
- Create virtual machines.
The following links provide information about performing these steps:
Managing VM Storage in KVM Deployment
Use ODACLI to create, view, modify, and delete VM storage in an Oracle Database Appliance KVM deployment.
- Creating a VM Storage in a KVM Deployment
Use ODACLI commands or the Browser User Interface to create a VM storage in a KVM deployment. - Viewing VM Storage in a KVM Deployment
Use ODACLI commands or the Browser User Interface to view all VM storage or details about a VM storage in a KVM deployment. - Modifying a Virtual Storage in a KVM Deployment
Use ODACLI commands or the Browser User Interface to modify a virtual storage in a KVM deployment. - Deleting a VM Storage in a KVM Deployment
Use ODACLI commands or the Browser User Interface to delete a VM storage in a KVM deployment.
Parent topic: Managing an Oracle Database Appliance KVM Deployment
Creating a VM Storage in a KVM Deployment
Use ODACLI commands or the Browser User Interface to create a VM storage in a KVM deployment.
Using ODACLI to Create VM Storage
Use the command odacli create-vmstorage
to
create a VM Storage.
share1
of 8
GB.# odacli create-vmstorage -n share1 -s 8G
Using Browser User Interface to Create VM Storage
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click Show VM Instances to display the VM Instances page.
- In the page, select the Create VM Storage option and click Next.
- In the Create VM Storage page, specify the following:
- Storage Name: Name of the VM storage
- Storage Size: Size of the storage to be allocated
- Click Create.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Parent topic: Managing VM Storage in KVM Deployment
Viewing VM Storage in a KVM Deployment
Use ODACLI commands or the Browser User Interface to view all VM storage or details about a VM storage in a KVM deployment.
Using ODACLI to View VM Storage
odacli describe-vmstorage
displays details about VM storage. Use the command odacli
list-vmstorages
to view all VM storages in the
deployment.# odacli list-vmstorages
# odacli describe-vmstorage
Using Browser User Interface to View VM Storage
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the VM Details page.
- Click the Show VM Storage tab to view the list of all configured virtual storages.
- Click on a VM Storage to view the details of the virtual storage.
Parent topic: Managing VM Storage in KVM Deployment
Modifying a Virtual Storage in a KVM Deployment
Use ODACLI commands or the Browser User Interface to modify a virtual storage in a KVM deployment.
Using ODACLI to Modify Virtual Storages
Use the command odacli modify-vmstorage
to
modify VM storage.
share1
by 10
gigabytes.# odacli modify-vmstorage -n share1 -i 10G
Using Browser User Interface to Modify VM Storage
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the VM Details page.
- Click the Show VM Storage tab.
- In the page, select a Virtual Storage, select the Modify option and click Next.
- In the Modify VM Storage page, specify Increment in size and click Modify.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Parent topic: Managing VM Storage in KVM Deployment
Deleting a VM Storage in a KVM Deployment
Use ODACLI commands or the Browser User Interface to delete a VM storage in a KVM deployment.
Using ODACLI to Delete VM Storage
Use the command odacli delete-vmstorage
to
delete a VM storage.
vs1
.# odacli delete-vmstorage -n vs1
Using Browser User Interface to Modify VM Storage
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the VM Details page.
- Click the Show VM Storage tab.
- In the page, select a VM Storage, select the Delete option.
- Click Yes to confirm your choice.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Parent topic: Managing VM Storage in KVM Deployment
Managing Virtual Networks in KVM Deployment
Use ODACLI to create, view, start, stop, and delete virtual networks in an Oracle Database Appliance KVM deployment.
- Creating a Virtual Network in a KVM Deployment
Use ODACLI commands or the Browser User Interface to create a virtual network in a KVM deployment. - Viewing Virtual Networks in a KVM Deployment
Use ODACLI commands or the Browser User Interface to view all virtual networks or details about a virtual network in a KVM deployment. - Starting and Stopping Virtual Networks in a KVM Deployment
Use ODACLI commands or the Browser User Interface to start or stop virtual networks in a KVM deployment. - Modifying a Virtual Network in a KVM Deployment
Use ODACLI commands or the Browser User Interface to modify a virtual network in a KVM deployment. - Deleting a Virtual Network in a KVM Deployment
Use ODACLI commands or the Browser User Interface to delete a virtual network in a KVM deployment.
Parent topic: Managing an Oracle Database Appliance KVM Deployment
Creating a Virtual Network in a KVM Deployment
Use ODACLI commands or the Browser User Interface to create a virtual network in a KVM deployment.
Using ODACLI to Create Virtual Network
Use the command odacli create-vnetwork
to
create a virtual network.
bridged
using the interface
btbond2
.# odacli create-vnetwork --name mgmtNet --bridge mgmtNet --type bridged --interface btbond2 --ip 192.168.120.26 --gateway 192.168.120.1 --netmask 255.255.255.0
bridged-vlan
using the
interface
btbond1
.# odacli create-vnetwork --name backupvlan --bridge backupvlan --type bridged-vlan --vlan-id 12 --interface btbond1 --ip 192.168.100.10 --gateway 192.168.100.1 --netmask 255.255.255.0
Using Browser User Interface to Create Virtual Network
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click Show VM Instances to display the VM Instances page.
- In the page, select the Create Virtual Network option and click Next.
- In the Create Virtual Network page, specify the following:
- Name: Name of the virtual network
- IP Address: Virtual network IP address
- Subnet Mask and Gateway: Virtual network subnet mask and gateway
- Network Type: Virtual network type
- Interface: Virtual network interface
- Bridge Name: Name of the network bridge
- VLAN ID: ID of the VLAN network
- Click Create.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Parent topic: Managing Virtual Networks in KVM Deployment
Viewing Virtual Networks in a KVM Deployment
Use ODACLI commands or the Browser User Interface to view all virtual networks or details about a virtual network in a KVM deployment.
Using ODACLI to View Virtual Networks
odacli describe-vnetwork
displays details about a virtual network. Use the command odacli
list-vnetworks
to view all virtual networks in the
deployment.# odacli list-vnetworks
# odacli describe-vnetwork -n vnet1
Using Browser User Interface to Create Virtual Networks
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the VM Details page.
- Click the Show Virtual Networks tab to view the list of all configured virtual networks.
- Click on a Virtual Network to view the details of the virtual network.
Parent topic: Managing Virtual Networks in KVM Deployment
Starting and Stopping Virtual Networks in a KVM Deployment
Use ODACLI commands or the Browser User Interface to start or stop virtual networks in a KVM deployment.
Using ODACLI to Start and Stop Virtual Networks
odacli start-vnetwork
starts a
virtual network. Use the command odacli stop-vnetwork
to stop a virtual network in the
deployment.# odacli start-vnetwork -n vnet1
# odacli stop-vnetwork -n vnet1
Using Browser User Interface to Start and Stop Virtual Networks
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the VM Details page.
- Click the Show Virtual Networks tab to view the list of all configured virtual networks.
- To start a virtual network, click on a Virtual Network, and then click Start.
- To stop a virtual network, click on a virtual network, and then click Stop.
Parent topic: Managing Virtual Networks in KVM Deployment
Modifying a Virtual Network in a KVM Deployment
Use ODACLI commands or the Browser User Interface to modify a virtual network in a KVM deployment.
Using ODACLI to Modify Virtual Network
Use the command odacli modify-vnetwork
to
modify a virtual network.
# odacli modify-vnetwork -n vnet1 -g 10.11.44.41
Using Browser User Interface to Modify Virtual Network
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the VM Details page.
- Click the Show Virtual Networks tab.
- In the page, select a Virtual Network, select the Modify option and click Next.
- In the Modify Virtual Network page, specify any changes in the Subnet Mask, Gateway, or IP Address, and click Modify.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Parent topic: Managing Virtual Networks in KVM Deployment
Deleting a Virtual Network in a KVM Deployment
Use ODACLI commands or the Browser User Interface to delete a virtual network in a KVM deployment.
Using ODACLI to Delete Virtual Networks
Use the command odacli delete-vnetwork
to
delete a virtual network.
vnet1
.# odacli delete-vnetwork -n vnet1
Using Browser User Interface to Modify Virtual Networks
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the VM Details page.
- Click the Show Virtual Networks tab.
- In the page, select a virtual network, select the Delete option.
- Click Yes to confirm your choice.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Parent topic: Managing Virtual Networks in KVM Deployment
Managing Virtual Disks in KVM Deployment
Use ODACLI to create, view, clone, modify, and delete virtual disks on Oracle Database Appliance KVM deployment.
- Creating a Virtual Disk in a KVM Deployment
Use ODACLI commands or the Browser User Interface to create a virtual disk in a KVM deployment. - Viewing Virtual Disks in a KVM Deployment
Use ODACLI commands or the Browser User Interface to view all virtual disks or details about a virtual disk in a KVM deployment. - Cloning a Virtual Disk in a KVM Deployment
Use ODACLI commands or the Browser User Interface to clone a virtual disk in a KVM deployment. - Modifying a Virtual Disk in a KVM Deployment
Use ODACLI commands or the Browser User Interface to modify a virtual disk in a KVM deployment. - Deleting a Virtual Disk in a KVM Deployment
Use ODACLI commands or the Browser User Interface to delete a virtual disk in a KVM deployment.
Parent topic: Managing an Oracle Database Appliance KVM Deployment
Creating a Virtual Disk in a KVM Deployment
Use ODACLI commands or the Browser User Interface to create a virtual disk in a KVM deployment.
Ensure that a VM storage exists before you create a virtual disk.
Using ODACLI to Create Virtual Disks
Use the command odacli create-vdisk
to
create a virtual disk.
Specify the name of the virtual disk in the command odacli
create-vdisk -n name
. Identify the
storage in which you create the virtual disk by using the -st storage
option. Use the option -s
size
to specify the virtual disk
size. If you want to configure the virtual disk as a shared disk, then use the
option -sh
.
vdisk1
inside the VM storage
vms1
.odacli create-vdisk -n vdisk1 -st vms1 -s 2G -sh
Using Browser User Interface to Create Virtual Disks
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the Virtual Disk page.
- Click Create Virtual Disk.
- In the page, select the Create Virtual Disk option and click Next.
- In the Create Virtual Disk page, specify the following:
- Virtual Disk Name: Name assigned to the virtual disk that is unique within the name repository
- VM Storage Name: Name of the VM storage where the virtual disk will be created
- Disk Size: Size of the virtual disk
- Shared: Specify if you want to share the virtual disk
- Sparse or Shared: Specify if the virtual disk is sparse
- Click Create.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Parent topic: Managing Virtual Disks in KVM Deployment
Viewing Virtual Disks in a KVM Deployment
Use ODACLI commands or the Browser User Interface to view all virtual disks or details about a virtual disk in a KVM deployment.
Using ODACLI to View Virtual Disks
odacli describe-vdisk
displays
details about a virtual disk. Use the command odacli
list-vdisks
to view all virtual disks in the
deployment.# odacli list-vdisks
# odacli describe-vdisk -n vdisk_name
Using Browser User Interface to Create Virtual Disks
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the VM Details page.
- Click the Show Virtual Disks tab to view the list of all configured virtual disks.
- Click on a virtual disk to view the details of the virtual disk.
Parent topic: Managing Virtual Disks in KVM Deployment
Cloning a Virtual Disk in a KVM Deployment
Use ODACLI commands or the Browser User Interface to clone a virtual disk in a KVM deployment.
Using ODACLI to Clone Virtual Disks
Use the command odacli clone-vdisk
to
clone an existing virtual disk.
Specify the source vdisk from which you want to clone with the
-n
option, and specify the name of the cloned virtual disk with
the -cn
option.
vdisk1
, with the
name vdisk1_clone
. The cloned disk is created on the same storage
as
vdisk1
.# odacli clone-vdisk -n vdisk1 -cn vdisk1_clone
Using Browser User Interface to Create Virtual Disks
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the Virtual Disk page.
- Click Create Virtual Disk.
- In the page, select the Clone Virtual Disk option and click Next.
- In the Clone Virtual Disk page, specify the following:
- Select the Source Virtual Disk you want to clone
- Specify the name of the cloned virtual disk
- Click Create.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Parent topic: Managing Virtual Disks in KVM Deployment
Modifying a Virtual Disk in a KVM Deployment
Use ODACLI commands or the Browser User Interface to modify a virtual disk in a KVM deployment.
Using ODACLI to Modify Virtual Disks
Use the command odacli modify-vdisk
to
increase the size of a virtual disk.
vdisk1
by 4
gigabytes.# odacli modify-vdisk -n vdisk1 -i 4G
Using Browser User Interface to Modify Virtual Disks
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the VM Details page.
- Click the Show Virtual Disks tab.
- In the page, select a Virtual Disk, select the Modify Virtual Disk option and click Next.
- In the Modify Virtual Disk page, specify Increment in size and if you want to share the virtual disk.
- Click Modify.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Parent topic: Managing Virtual Disks in KVM Deployment
Deleting a Virtual Disk in a KVM Deployment
Use ODACLI commands or the Browser User Interface to delete a virtual disk in a KVM deployment.
Using ODACLI to Delete Virtual Disks
Use the command odacli delete-vdisk
to
delete a virtual disk.
vdisk1
.# odacli delete-vdisk -n vdisk1
Using Browser User Interface to Modify Virtual Disks
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the VM Details page.
- Click the Show Virtual Disks tab.
- In the page, select a Virtual Disk, select the Delete option.
- Click Yes to confirm your choice.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Parent topic: Managing Virtual Disks in KVM Deployment
Managing Virtual Machines in KVM Deployment
Use ODACLI to create, view, clone, modify, start, stop, and delete virtual machines in an Oracle Database Appliance KVM deployment.
- Creating a Virtual Machine in a KVM Deployment
Use ODACLI commands or the Browser User Interface to create a virtual machine in a KVM deployment. - Cloning a Virtual Machine in a KVM Deployment
Use ODACLI commands or the Browser User Interface to clone a virtual machine instance in a KVM deployment. - Modifying a Virtual Machine in a KVM Deployment
Use ODACLI commands or the Browser User Interface to modify a virtual machine in a KVM deployment. - Viewing Virtual Machines in a KVM Deployment
Use ODACLI commands or the Browser User Interface to view all virtual machines or details about a virtual machine in a KVM deployment. - Starting and Stopping Virtual Machines in a KVM Deployment
Use ODACLI commands or the Browser User Interface to start or stop virtual machines in a KVM deployment. - Deleting a Virtual Machine in a KVM Deployment
Use ODACLI commands or the Browser User Interface to delete a virtual machine in a KVM deployment.
Parent topic: Managing an Oracle Database Appliance KVM Deployment
Creating a Virtual Machine in a KVM Deployment
Use ODACLI commands or the Browser User Interface to create a virtual machine in a KVM deployment.
Ensure that a VM storage exists before you create a VM instance.
Using ODACLI to Create Virtual Machine Instance
Use the command odacli create-vm
to create
a VM instance. Specify the preferred node on which to start the virtual machine
after creation (-pn
option).
vm1
with 8 vcpus and 8 GB memory. A VM disk of size 10 GB is
created automatically as /dev/vda
inside the VM for the operating
system installation. The VM disk is stored in the VM storage vms1
.
The source used for the installation is located on /u01/OL7.iso
. If
you want to attach an additional virtual disk to the VM, you can specify
--vdisks vdisk_name
, where
vdisk_name
is an existing virtual disk. This virtual
disk when attached, is shown as /dev/vdb
inside the
VM.# odacli create-vm -n vm1 -vc 8 -m 8G -vms vms1 -src /u01/OL7.iso -size 10G
To use a kickstart configuration file to create the VM instance, include the file in
the --extra-args
parameter. Create a kickstart configuration file,
including the network configuration for the guest VM. Ensure that the kickstart
configuration file is available over the network that guest VM can access.
odacli create-vm --name odaksvm --memory 4G --source /u01/kvm/images/OL77_x86_64.iso --vmstorage myvms --size 10G --vcpus 2 --extra-args "console=tty0 console=ttyS0,115200 ks=http://test:portnumber/ks.txt"
- Run the
odacli create-vm
command and check that it completes successfully. - Use the
odacli describe-vm
command to check the VNC port. - Log in to the VM instance using the VNC port:
host:vncport
. See the section Connecting to the VM instance Using VNC for the steps to connect to the VM instance using VNC. - Complete the installation process by providing your values for the installation screens.
- Log in again to the VM instance using the VNC port:
host:vncport
. See the section Connecting to the VM instance Using VNC for the steps to connect to the VM instance using VNC. - If you specified
--vnetwork
in theodacli create-vm
command, then you can runifconfig -a
to view the network interface in the VM. Configure the network as you would on a Linux system. - After the network is configured, log into the VM using the network and customize the VM instance.
- If you did not specify
--vnetwork
in theodacli create-vm
command, then the VM network is created using the default Network Address Translation (NAT) based KVM bridgevirbr0
. eth0 is configured as DHCP inside the VM.
Connecting to the VM instance Using VNC: Method 1
-
Find out the VNC display port of the VM from the command
odacli describe-vm -n vm_name: 127.0.0.1:1
# odacli describe-vm -n vm1 VM details -------------------------------------------------------------------------------- ID: c280af13-997c-49b1-97ce-0617610535f1 Name: vm1 ... Graphics settings: vnc,listen=127.0.0.1 Display Port: 127.0.0.1:1 <<<< ...
- Run vncserver on the Oracle Database Appliance host. Note down the
vncserver address
odahost:11
.# vncserver New 'odahost:11 (root)' desktop is odahost:11
- Launch vncviewer from your desktop, login to the Oracle Database Appliance host using the vncserver address created in step 2: odahost:11. This launches a vncviewer that logs into the Oracle Database Appliance host.
- From vncviewer launched in step 3, run the
vncviewer
command with the display port from theodacli describe-vm
output. For example, in the previous step, theodacli describe-vm
command shows the display port is127.0.0.1:1
, so typevncviewer 127.0.0.1:1
.
Connecting to the VM instance Using VNC: Method 2
-
Find out the VNC display port of the VM from the command
odacli describe-vm
. For example, the Display Port isDisplay Port: 127.0.0.1:1
, and the current nodemyodahost1
.# odacli describe-vm -n vm1 VM details -------------------------------------------------------------------------------- ID: c280af13-997c-49b1-97ce-0617610535f1 Name: vm1 ... Graphics settings: vnc,listen=127.0.0.1 Display Port: 127.0.0.1:1 <<<< ... Status -------------------------- Current node: myodahost1 <<< Current state: ONLINE Target state: ONLINE
- On Linux or macOS operating systems where you want to launch the
vncviewer, use the following command to create the SSH tunnel:
ssh -L localport:127.0.0.1:vncport root@odahost
where localport is an available port number greater than 1024 on your local machine (for example, 12345) where vnc viewer is launched. vncport is the VNC port displayed in the odacli describe-vm command plus 5900. For example, if
odacli describe-vm
returns the display port as127.0.0.1:1
, then use 5901 as the VNC port.odahost1
is the host name of the Oracle Database Appliance host where the VM is running. 127.0.0.1 is the address where vnc server is listening at. Do not change the127.0.0.1
address. For example:ssh -L 12345:127.0.0.1:5901 root@odahost1
On Windows, use PuTTY to create the SSH tunnel.
- Launch vncviewer from your desktop, enter VNC server address as
localhost:localport
, where localport is one used in the SSH tunnel in step 2 (such as 12345). For example:vncserver: localhost:12345
How to find VM network interface attached to the vnetwork
If you specified --vnetwork
in the odacli
create-vm
command, then you can run ifconfig -a
to
view the network interface in the VM. Find out the VM network interface name that is
attached to the vnetwork by matching the interface MAC address to the MAC address
displayed in the odacli describe-vm
command.
# odacli describe-vm -n vm1
VM details
--------------------------------------------------------------------------------
ID: c280af13-997c-49b1-97ce-0617610535f1
Name: vm1
...
Parameters
--------------------------
...
Config Live
------------------------- -------------------------
Memory: 2.00 GB 2.00 GB
Max Memory: 2.00 GB 2.00 GB
...
vNetworks: pubnet:52:54:00:15:b5:c4 pubnet:52:54:00:15:b5:c4 <<<<
# ip link show
...
3: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel state UP mode DEFAULT group default qlen 1000
link/ether 52:54:00:15:b5:c4 brd ff:ff:ff:ff:ff:ff
Configure the network interface eth0 as you would on a Linux system.
Using Browser User Interface to Create Virtual Machine Instance
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click Show VM Instances to display the VM Instances page.
- In the page, select the Create VM Instance option and click Next.
- In the Create Virtual VM page, specify the following:
- VM Name: Name assigned to the VM instance that is unique within the name repository
- VM Storage Name: Name of the VM storage where the VM instance will be created
- Source Installation: The source from which you want to create the VM
- Preferred Node: Node where you want to run the VM instance
- Memory Size: Size of the memory to be allocated
- CPU Pool Name: Select the CPU Pool
- Number of vCPUs to Use: Number of virtual CPUs to be allocated
- Click Create.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Parent topic: Managing Virtual Machines in KVM Deployment
Cloning a Virtual Machine in a KVM Deployment
Use ODACLI commands or the Browser User Interface to clone a virtual machine instance in a KVM deployment.
Using ODACLI to Clone Virtual Machine Instance
Use the command odacli clone-vm
to clone
an existing virtual machine.
The name of the VM you create is defined by the command odacli
clone-vm -cn name
. Specify the source VM
from which you want to clone.
vm1
, with the
name vm1_clone
. The cloned VM is created on the same storage as
vm1
.# odacli clone-vm -n vm1 -cn vm1_clone
Using Browser User Interface to Clone Virtual Machine Instance
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the VM Instance page.
- Click Create VM Instance.
- In the page, select the Clone VM Instance option and click Next.
- In the Clone VM Instance page, specify the following:
- Select the Source VM you want to clone
- Specify the name and description of the cloned VM instance
- Click Create.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Parent topic: Managing Virtual Machines in KVM Deployment
Modifying a Virtual Machine in a KVM Deployment
Use ODACLI commands or the Browser User Interface to modify a virtual machine in a KVM deployment.
Using ODACLI to Modify Virtual Machines
Use the command odacli modify-vm
to modify
a virtual machine.
vm1
, setting the
CPU count to 6 and the maximum memory to 6 gigabytes on both the running VM and
subsequent
boots.# odacli modify-vm -n vm1 -c 6 -mm 6G --live --config
# odacli modify-vm -n vm_name -avn vnetwork_name
- When an application VM is created, a default network interface is created by default in the VM. This interface is attached to the default kvm bridge (virbr0) at the host. This interface is intended for convenient communication between the host and VM. This interface does not attach to any physical network interface at the host. Do not configure this interface to use for any external communication.
- You must create a vnetwork using the command
odacli create-vnetwork
and attach the vnetwork (odacli modify-vm -avn
) to the VM. This creates a second interface in the VM. Configure this network interface for your network requirement. - The network interface name in the VM depends on the operating system.
Using Browser User Interface to Modify Virtual Machines
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the VM Details page.
- Click the Show VM Instances tab.
- In the page, select a Virtual Machine, select the Modify option and click Next.
- In the Modify VM page, specify Increment in size and if you want to Auto Start or Set Failover.
- You can also modify the CPU Pool, Number of vCPUs to use, Memory Size, and attach and detach virtual disks and virtual networks.
- Select if you want to save the configuration or apply the configuration to a running VM.
- Click Modify.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Parent topic: Managing Virtual Machines in KVM Deployment
Viewing Virtual Machines in a KVM Deployment
Use ODACLI commands or the Browser User Interface to view all virtual machines or details about a virtual machine in a KVM deployment.
Using ODACLI to View Virtual Machines
odacli describe-vm
displays
details about a virtual machine. Use the command odacli
list-vms
to view all virtual machines in the
deployment.# odacli list-vms
# odacli describe-vm -n vm_name
Using Browser User Interface to Create Virtual Machines
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the VM Details page.
- Click the Show VM Instances tab to view the list of all configured virtual machines.
- Click on a VM Instance to view the details of the virtual machine.
Parent topic: Managing Virtual Machines in KVM Deployment
Starting and Stopping Virtual Machines in a KVM Deployment
Use ODACLI commands or the Browser User Interface to start or stop virtual machines in a KVM deployment.
Using ODACLI to Start and Stop Virtual Machines
The command odacli start-vm
starts a
virtual machine. Use the command odacli stop-vm
to
stop a virtual machine in the deployment.
If pref-node
is defined for the VM, then the VM starts
on the pref-node
. If pref-node
is not defined for
the VM, then the VM can start on any node, in a high-availability deployment.
However, if you specify the node name -n
, then the VM starts on the
specified node, even if the preferred node is defined.
# odacli start-vm -n vm1
# odacli stop-vm -n vm1
Using Browser User Interface to Start and Stop Virtual Machines
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the VM Details page.
- Click the Show VM Instances tab to view the list of all configured virtual machines.
- To start a virtual machine, click on a VM Instance, and then click Start and select the node to start the virtual machine.
- To stop a virtual machine, click on a VM Instance, and then click Stop to stop the virtual machine. Click Force Stop to close all running processes and stop the virtual machine.
Parent topic: Managing Virtual Machines in KVM Deployment
Deleting a Virtual Machine in a KVM Deployment
Use ODACLI commands or the Browser User Interface to delete a virtual machine in a KVM deployment.
Using ODACLI to Delete Virtual Machines
Use the command odacli delete-vm
to delete
a virtual machine.
vm1
.# odacli delete-vm -n vm1
Using Browser User Interface to Modify Virtual Machines
- Log into the Browser User Interface:
https://host-ip-address:7093/mgmt/index.html
- Click the Appliance tab.
- Click VM Instances to display the VM Details page.
- Click the Show VM Instances tab.
- In the page, select a VM Instance, select the Delete option.
- Click Yes to confirm your choice.
- When you submit the job, the job ID and a link to the job appears. Click the link to display the job status and details.
- Validate that the job completed. You can track the job in the
Activity tab in the Browser User Interface, or
run the command
odacli describe-job
with the job ID.
Parent topic: Managing Virtual Machines in KVM Deployment
Example JSON File to Create a Single-Node DB System
Follow the JSON file example to create a JSON file to deploy a
single-node DB System, with role separation, with the command odacli
create-dbsystem
.
Use the example JSON file to create a file for your environment.
Note:
It is important to review the readme and the examples carefully before creating your JSON file.Example 14-1 JSON File to Create a Single-Node Oracle KVM Database System with Role Separation
The following is an example of a JSON file that creates a single-node Oracle KVM Database System on Oracle Database Appliance bare metal platform. The example uses role separation. When using the example to create your JSON file, change the definitions to match your environment. The password must meet password requirements.
{
"system": {
"name": "test_example",
"shape": "odb1",
"systemPassword": "",
"timeZone": "America/Los_Angeles",
"diskGroup": "DATA",
"cpuPoolName": "shared_dbsystem_cpupool",
"enableRoleSeparation": true,
"customRoleSeparation": {
"groups": [
{
"name": "oinstall",
"id": 1001,
"role": "oinstall"
},
{
"name": "dbaoper",
"id": 1002,
"role": "dbaoper"
},
{
"name": "dba",
"id": 1003,
"role": "dba"
},
{
"name": "asmadmin",
"id": 1004,
"role": "asmadmin"
},
{
"name": "asmoper",
"id": 1005,
"role": "asmoper"
},
{
"name": "asmdba",
"id": 1006,
"role": "asmdba"
}
],
"users": [
{
"name": "grid",
"id": 1000,
"role": "gridUser"
},
{
"name": "oracle",
"id": 1001,
"role": "oracleUser"
}
]
}
},
"database": {
"name": "db19",
"uniqueName": "db19",
"domainName": "example.com",
"adminPassword": "",
"version": "19.11.0.0.210420",
"edition": "EE",
"type": "SI",
"dbClass": "OLTP",
"shape": "odb1",
"role": "PRIMARY",
"targetNodeNumber": null,
"enableDbConsole": false,
"enableUnifiedAuditing": true,
"redundancy": null,<<< if diskgroup redundancy is FLEX, then database redundancy must be set to one of "HIGH" or "MIRROR", otherwise, can be null
"characterSet": {
"characterSet": "AL32UTF8",
"nlsCharacterset": "AL16UTF16",
"dbTerritory": "AMERICA",
"dbLanguage": "ENGLISH"
},
"rmanBackupPassword": null,
"enableTDE": false,
"isCdb": false
},
"network": {
"domainName": "test_domain",
"ntpServers": [],
"dnsServers": [
"xx.xxx.xx.xxx"
],
"nodes": [
{
"name": "node1",
"ipAddress": "xx.xx.xx.xxx",
"netmask": "xxx.xxx.xxx.x",
"gateway": "xx.xx.xx.x",
"number": 0
}
]
},
"publicVNetwork": "vnet1"
},
"grid": {
"language": "en"
}
}
Example 14-2 JSON File to Create a Single-Node Oracle KVM Database System without Role Separation
The following is an example of a JSON file that creates a single-node Oracle KVM Database System on Oracle Database Appliance bare metal platform, without role separation. When using the example to create your JSON file, change the definitions to match your environment. The password must meet password requirements.
{
"system": {
"name": "test_example",
"shape": "odb1",
"systemPassword": "",
"timeZone": "America/Los_Angeles",
"diskGroup": "DATA",
"cpuPoolName": "shared_dbsystem_cpupool",
"database": {
"name": "db19",
"uniqueName": "db19",
"domainName": "example.com",
"adminPassword": "",
"version": "19.11.0.0.210420",
"edition": "EE",
"type": "SI",
"dbClass": "OLTP",
"shape": "odb4",
"role": "PRIMARY",
"targetNodeNumber": null,
"enableDbConsole": false,
"enableUnifiedAuditing": true,
"redundancy": "HIGH",<<< if diskgroup redundancy is FLEX, then database redundancy must be set to one of "HIGH" or "MIRROR", otherwise, can be null
"characterSet": {
"characterSet": "AL32UTF8",
"nlsCharacterset": "AL16UTF16",
"dbTerritory": "AMERICA",
"dbLanguage": "ENGLISH"
},
"rmanBackupPassword": null,
"enableTDE": false,
"isCdb": false
},
"network": {
"domainName": "test_domain",
"ntpServers": [],
"dnsServers": [
"xx.xxx.xx.xxx"
],
"nodes": [
{
"name": "node1",
"ipAddress": "xx.xx.xx.xxx",
"netmask": "xxx.xxx.xxx.x",
"gateway": "xx.xx.xx.x",
"number": 0
}
]
},
"publicVNetwork": "vnet1"
},
"grid": {
"language": "en"
}
}
Parent topic: Managing an Oracle Database Appliance KVM Deployment
Example JSON File to Create a High-Availability DB System
Follow the JSON file example to create a JSON file to deploy a
two-node DB System, with role separation, with the command odacli
create-dbsystem
.
Use the example JSON file to create a file for your environment.
Example 14-3 JSON File to Create Two-Node Oracle KVM Database System without Role Separation
The following is an example of a JSON file that creates two-node Oracle KVM Database System on Oracle Database Appliance bare metal platform, without role separation. When using the example to create your JSON file, change the definitions to match your environment. The password must meet password requirements.
{
"system": {
"name": "test_system",
"shape": "odb1",
"systemPassword": "",
"timeZone": "America/Los_Angeles",
"diskGroup": "DATA",
"cpuPoolName": "shared_dbsystem_cpupool",
},
"database": {
"name": "dbtest",
"uniqueName": "dbtest",
"domainName": "test_domain",
"adminPassword": "",
"version": "19.11.0.0.210420",
"edition": "SE",
"type": "SI",
"dbClass": "OLTP",
"shape": "odb1",
"role": "PRIMARY",
"targetNodeNumber": "0",
"enableDbConsole": false,
"enableUnifiedAuditing": true,
"redundancy": "MIRROR", <<< if diskgroup redundancy is FLEX, then database redundancy must be set to one of "HIGH" or "MIRROR", otherwise, can be null
"characterSet": {
"characterSet": "AL32UTF8",
"nlsCharacterset": "AL16UTF16",
"dbTerritory": "AMERICA",
"dbLanguage": "AMERICAN"
},
"enableSEHA": true,
"rmanBackupPassword": null,
"enableTDE": false,
"isCdb": false,
"pdbName": "",
"pdbAdminUser": "pdbadmin"
},
"network": {
"domainName": "test_domain",
"ntpServers": [],
"dnsServers": [
"xx.xxx.xx.xxx"
],
"nodes": [
{
"name": "node1",
"ipAddress": "xx.xx.xxx.xx",
"netmask": "xxx.xxx.xxx.x",
"gateway": "xx.xx.xxx.x",
"number": 0,
"vipName": "node1-vip",
"vipAddress": "xx.xx.xxx.xx"
},
{
"name": "node2",
"ipAddress": "xx.xx.xxx.xx",
"netmask": "xxx.xxx.xxx.x",
"gateway": "xx.xx.xxx.x",
"number": 1,
"vipName": "node2-vip",
"vipAddress": "xx.xx.xxx.xx"
}
],
"publicVNetwork": "vnet1"
"scanName": "test-scan",
"scanIps": [
"xx.xx.xxx.xx",
"xx.xx.xxx.xx"
]
},
"grid": {
"language": "en"
}
}
Example 14-4 JSON File to Create Two-Node Oracle KVM Database System with Role Separation
The following is an example of a JSON file that creates two-node Oracle KVM Database System on Oracle Database Appliance bare metal platform. The example uses role separation. When using the example to create your JSON file, change the definitions to match your environment. The password must meet password requirements.
{
"system": {
"name": "test_system",
"shape": "odb1",
"systemPassword": "",
"timeZone": "America/Los_Angeles",
"diskGroup": "DATA",
"cpuPoolName": "shared_dbsystem_cpupool",
"enableRoleSeparation": true,
"customRoleSeparation": {
"groups": [
{
"name": "oinstall",
"id": 1001,
"role": "oinstall"
},
{
"name": "dbaoper",
"id": 1002,
"role": "dbaoper"
},
{
"name": "dba",
"id": 1003,
"role": "dba"
},
{
"name": "asmadmin",
"id": 1004,
"role": "asmadmin"
},
{
"name": "asmoper",
"id": 1005,
"role": "asmoper"
},
{
"name": "asmdba",
"id": 1006,
"role": "asmdba"
}
],
"users": [
{
"name": "grid",
"id": 1000,
"role": "gridUser"
},
{
"name": "oracle",
"id": 1001,
"role": "oracleUser"
}
]
}
},
"database": {
"name": "dbtest",
"uniqueName": "dbtest",
"domainName": "test_domain",
"adminPassword": "",
"version": "19.11.0.0.210420",
"edition": "SE",
"type": "SI",
"dbClass": "OLTP",
"shape": "odb1",
"role": "PRIMARY",
"targetNodeNumber": "0",
"enableDbConsole": false,
"enableUnifiedAuditing": true,
"redundancy": null, <<< if diskgroup redundancy is FLEX, then database redundancy must be set to one of "HIGH" or "MIRROR", otherwise, can be null
"characterSet": {
"characterSet": "AL32UTF8",
"nlsCharacterset": "AL16UTF16",
"dbTerritory": "AMERICA",
"dbLanguage": "AMERICAN"
},
"enableSEHA": true,
"rmanBackupPassword": null,
"enableTDE": false,
"isCdb": false,
"pdbName": "",
"pdbAdminUser": "pdbadmin"
},
"network": {
"domainName": "test_domain",
"ntpServers": [],
"dnsServers": [
"xx.xxx.xx.xxx"
],
"nodes": [
{
"name": "node1",
"ipAddress": "xx.xx.xxx.xx",
"netmask": "xxx.xxx.xxx.x",
"gateway": "xx.xx.xxx.x",
"number": 0,
"vipName": "node1-vip",
"vipAddress": "xx.xx.xxx.xx"
},
{
"name": "node2",
"ipAddress": "xx.xx.xxx.xx",
"netmask": "xxx.xxx.xxx.x",
"gateway": "xx.xx.xxx.x",
"number": 1,
"vipName": "node2-vip",
"vipAddress": "xx.xx.xxx.xx"
}
],
"publicVNetwork": "vnet1"
"scanName": "test-scan",
"scanIps": [
"xx.xx.xxx.xx",
"xx.xx.xxx.xx"
]
},
"grid": {
"language": "en"
}
}
Parent topic: Managing an Oracle Database Appliance KVM Deployment