Syntax

 odacli create-dbsystem [-f] [-p json_payload_path] [-t template] [-ta] [-j] [-h]

Parameters

Usage Notes

For example JSON files that you can use to create the DB system, see the Example JSON File to Create a High-Availability DB System and Example JSON File to Create a Single-Node DB System topics in this guide.

Example

Syntax

 odacli modify-dbsystem -n name [-cp cpu_pool_name] [-no-cp] [-r] 
 [-avd v_disk_to_attach] [-avn v_network] 
 [-dvd v_disk_to_detach] [-dvn v_networks_to_detach] [-en] [-gw gateway] 
 [-ip ip_address] [-nm netmask] [-tvm vm_name]
[-sip scan_ip_address] [-sn scan_name] [-s shape]  
 [-vips vip_address] [-vt v_network_type] [-m] [-j] [-h]

Parameters

Usage Notes

• The odacli modify-dbsystem command supports the following use cases:
  • attach or detach the shared DB system cpupools.
    Attaching a CPU pool:

    odacli modify-dbsystem --name dbsystem_name -cp cpupool

    Detaching a CPU pool:

    odacli modify-dbsystem --name dbsystem_name --no-cp

  • Change DB system shape, that is, scale up (increase) or scale down (decrease):

    odacli modify-dbsystem -n dbsystem name -s new_shape

  • Enable NUMA for the existing DB system. NUMA is enabled on Oracle Database Appliance release 19.12 and later. For existing DB sytems created before release 19.12, use the odacli modify-dbsystem --enable_numa command to enable the NUMA for the DB system. This command includes enabling the NUMA for the VM configuration, operation system, and the database inside the DB system.

    odacli modify-dbsystem --name dbsystem name --enable_numa

  • Attach or detach new network to the DB system. Before attaching a vnetwork, ensure that the vnetwork exists. You must specify the IP address and netmask to configure the new network interface inside the DB system. If the network type is database or dataguard, specify the VIPs, SCAN name, and SCAN IPs.

    odacli modify-dbsystem -n dbsystem1 -avn vnet2 -t Dataguard -ip 192.168.10.119,192.168.10.120 -nm 255.255.240.0 -gw 192.168.10.1 -sn scan1 -sip 192.168.10.30,192.168.10.31 -vips vip1:0:192.168.15.57,vip2:1:192.168.15.58

    To detach a network from DB system:

    odacli modify-dbsystem -n dbsystem1 -dvn vnet2

• Starting with Oracle Database Appliance release 19.23, the odacli modify-dbsystem --shape command only changes the shape of the DB system; it does not change the shapes of the database inside the DB system any more. You must modify database shapes accordingly based on the new shape of the DB system. Ensure that you scale up database shapes after the DB system shape is scaled up. Similarly, scale down database shapes before DB system shape is scaled down, otherwise databases could fail to start because of reduced DB system memory.
• To attach a vdisk to a DB system, note the following:
  • The vdisk must already exist.
  • When you attach a vdisk, the vdisk attaches to the DB system and displays in the DBVM operating system as a block device, for example, /dev/vdc. You must format and create a file system with the block device and maintain the device in the DB system.
  • For high-availability systems, you must specify the DB system to attach the vdisk, using the --target-vm option. Specify the VM host name without the domain name in the --target-vm option. You can view the VM host name with the odacli describe-dbsystem command.
  • On high-availability systems, the vdisk attached to the two nodes on the DB system is local to the DBVM it is attached to. The vdisk is not shared and cannot be shared between two DBVMs in the DB system.
• To detach a vdisk from a DB system, note the following:
  • Detaching a vdisk from the DB system removes the vdisk from the DBVM. The block device, for example, /dev/vdc is removed from the DBVM operating system level. You must ensure that sufficient care is exercised at the operating system level, for example, properly back up the content of the file system, remove the block device from logical volume manager, or remove the block device from /etc/fstab, before you detach the vdisk. Without proper handling, the DBVM could fail to restart after running the detach vdisk operation.
  • For high-availability systems, you must specify the DB system from which to detach the vdisk, using the --target-vm option. Specify the VM host name without the domain name in the --target-vm option. You can view the VM host name with the odacli describe-dbsystem command.
  • If the detach vdisk operation fails, then you can retry the detach operation with the --force, -f parameter to ensure that the vdisk is detached from the device block list and the metadata as well.
• The attach and detach vdisk operations restart the DB system.

Example: Modify a KVM DB system

# odacli modify-dbsystem -n example_system1 -cp example_pool -s new_shape

Example: Increase the DB System memory to 24 GB

The command supports increasing the DB system memory. To reduce the DB system memory, use the --shape option with the command odacli modify-dbsystem.

# odacli modify-dbsystem -n dbsystem_name -m 24G

Syntax

 odacli modify-dbfileattributes [-in db_name] [-j] [-h]

Parameters

Usage Notes

• 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.26, 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. The creation of dbsystem fails, and you are prompted to run the odacli modify-dbfileattributes command to set up the file ownership and permission. Since there can be many files on Oracle ASM disk group, the user can run this step at their own convenience. Use the odacli modify-dbfileattributes command to set up the file ownerships.
• This command sets the file attributes (permissions and ownership) of all files on Oracle ASM disk group. The files include database files and also Oracle Clusterware files such as OCR (Oracle Clusterware Registry). Before creating the first DB system, set up attributes for files owned by both Oracle Grid Infrastructure and Oracle Database by running the odacli modify-dbfileattributes command with no arguments.
• If the overall operation was successful for many files, but failed for some files, then you can run the command again by specifying the database names.

Example

# odacli modify-dbfileattributes -in example_db_name

Syntax

 odacli list-dbsystems [-j] [-h]

Parameters

Example

Syntax

 odacli describe-dbsystem -n db_system_name [-p payload] [-j] [-h]

Parameters

Usage Notes

            Image version: 19.25.0.0.0
          Current version: 19.26.0.0.0

Example

Syntax

 odacli describe-dbsystem-image [-j] [-h]

Parameters

Example

View details of a KVM database system image

# odacli describe-dbsystem-image
DB System Image details
--------------------------------------------------------------------------------
Component Name Supported Versions Available Versions
-------------------- -------------------- --------------------
DBVM            19.10.0.0.0        19.10.0.0.0
GI              19.10.0.0.210119   19.10.0.0.210119
DB              19.10.0.0.210119   19.10.0.0.210119

View details of a system where KVM database system image is not available

# odacli describe-dbsystem-image
DB System Image details
--------------------------------------------------------------------------------
Component Name Supported Versions Available Versions
-------------------- -------------------- --------------------
DBVM            19.10.0.0.0        not-available
GI              19.10.0.0.210119   19.10.0.0.210119
DB              19.10.0.0.210119   19.10.0.0.210119

The output shows that the KVM Database System image is not yet available on the system. Download the image and run the odacli update-repository to import the image to the repository. The output shows that the Oracle Grid Infrastructure and Oracle Database clones are already available on the system.

Syntax

 odacli start-dbsystem -n dbsystem_name [-nn node_name] [-j] [-h]

Parameters

Example

Syntax

 odacli stop-dbsystem -n dbsystem_name [-nn node_name] [-f] [-j] [-h]

Parameters

Example

Syntax

 odacli delete-dbsystem -n dbsystem_name [-f] [-j] [-h]

Parameters

Usage Notes

• If you do not specify the -f option, then the delete DB system operation validates that the DB system does not contain any database. If there are any databases within the DB system, then the following error message is displayed:

  DB System 'name' must not have any database in order to be deleted, found following databases: list_of_databases

• Specify the -f option to delete the DB system, the Oracle Clusterware files, and the database files.
• The odacli delete-dbsystem command does not delete the database files. This is expected behavior so that you can archive the database files, if required, or manually restore the database with these database files. Use the --force option to delete the database files completely.

Example

Syntax

 odacli create-vmstorage -n name -s size -dg disk_group [-r {MIRROR|HIGH}] [-j] [-h]

Parameters

Example

Syntax

 odacli list-vmstorages [-j] [-h]

Parameters

Example

# odacli list-vmstorages

Syntax

 odacli describe-vmstorage -n name [-j] [-h]

Parameters

Example: Describing a VM Storage named share1

# odacli describe-vmstorage -n share1

Syntax

 odacli modify-vmstorage -n name -i increment [-r {MIRROR|HIGH}] [-s decrement] [-j] [-h]

Parameters

Example

Increase the size of a VM storage named share1 by 10 gigabytes.

# odacli modify-vmstorage -n share1 -i 10G

Syntax

 odacli delete-vmstorage -n name [-f] [-j] [-h]

Parameters

Example

Delete a VM storage named share1.

odacli delete-vmstorage -n share1

Syntax

 odacli create-vdisk -n name -vms vmstorage_name -s size -sh -sp [-j] [-h]

Parameters

Example

Create a 2 GB non-sparse and shareable Virtual Disk named vdisk1 inside the VM storage vms1.

odacli create-vdisk -n vdisk1 -vms vms1 -s 2G -sh

Syntax

 odacli list-vdisks [-j] [-h]

Parameters

Example

odacli list-vdisks

Syntax

 odacli describe-vdisk -n name [-j] [-h]

Parameters

Example: Describing a Virtual Disk named vdisk1

odacli describe-vdisk -n vdisk1

Syntax

 odacli modify-vdisk -n name -i [-no-s|-s] [-j] [-h]

Parameters

Example

Increase the size of a virtual disk named vdisk1 by 4 gigabytes.

# odacli modify-vdisk -n vdisk1 -i 4G

Syntax

 odacli clone-vdisk -n name -cn clone_name [-j] [-h]

Parameters

Example

Create a clone of a virtual disk named 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

Syntax

 odacli delete-vdisk -n name [-f] [-j] [-h]

Parameters

Example

Delete a virtual disk named vdisk1.

# odacli delete-vdisk -n vdisk1

Syntax

 odacli create-cpupool -n name -c number_of_cores {-bm|-vm} [-nn node_name] [-s socket] [-dbs]  [-urc] [-j] [-h]

Parameters

Usage Notes

• Attach the BM CPU pool to databases. Bare metal CPU pools can be assigned to multiple databases.
• Attach VM CPU pool VM to guest machines. VM CPU pools can be assigned to multiple VMs.
• Attach dbsystem CPU pool to DB systems. dbsystem CPU pool can be assigned to multiple DB systems. After you create a dbsystem CPU pool, you can create a new DB system with this CPU pool by adding the new CPU pool parameter in the create-dbsystem json file, or modify-dbsystem to attach CPU pool to an existing DB system.
• Resources in CPU pools cannot overlap, that is, CPU pools cannot share CPUs.
• After you create a BM CPU pool, you can associate this CPU pool to a database using the create-database or modify-database command.
• After you create a VM CPU pool, you can associate this CPU pool to a VM using the create-vm or modify-vm command.
• Number of cores must be an even number between 2 and the total number of available cores on the system.
• By default, a CPU in the CPU pool is allocated across two sockets in release 19.12 and later. Optionally, you can choose to allocate the CPU based on the socket number (0 or 1). This is especially useful to support Standard Edition licensing. It is recommended that you use the default allocation and do not mix two types of allocation.
• By default, the first core of the socket is reserved and cannot be used by the VM and DB system CPU pools for optimal performance. Use the --use-reserved-cores option to enable use of the first core of socket for VM and DB system CPU pools.

Example

Syntax

 odacli remap-cpupools -f -urc [-j] [-h]

Parameters

Usage Notes

If the odacli remap-cpupools command fails with the error DCS-10001:Internal error encountered: Not enough physical CPUs available for CPU Pool 'cpupool_name' on node 'node_name', run the odacli remap-cpupools command again with the --use_reserved-cores option.

Use the --force option to remap CPU pools even if the CPU pool is marked as NUMA-enabled. You must use odacli remap-cpupools command, after updating the bare metal CPU cores with the command odacli modify-cpucores for CPU core number changes.

By default, the first core of the socket is reserved and cannot be used by the VM and DB system CPU pools for optimal performance. Use the --use-reserved-cores option to enable use of the first core of socket for VM and DB system CPU pools.

Example

# odacli remap-cpupools

Syntax

 odacli list-cpupools [-j] [-h]

Parameters

Example

# odacli list-cpupools

Syntax

 odacli describe-cpupool -n name [-j] [-h]

Parameters

Example: Describing a CPU pool named cpupool1

# odacli describe-cpupool -n cpupool1

Syntax

 odacli modify-cpupool -n name -c cores -f -l [-j] [-h]

Parameters

Usage Notes

For VM CPU pool, if --live is not specified, then the changes are applied to the VM configuration file and will be activated next time the VM is started. If --live is specified, then the changes will be applied to both VM configuration file and to the running VM.

Example

Set the size of a CPU Pool cpupool1 to 10. If --live is not specified, the change is applied to the VM configuration file and will be activated next time the VM is started.

# odacli modify-cpupool -n cpupool1 -c 10

Syntax

 odacli delete-cpupool -n name -f [-j] [-h]

Parameters

Example

Delete a CPU pool named cpupool1.

# odacli delete-cpupool -n cpupool1

Syntax

 odacli list-auditrecords -du dcs-username -f from_date-range -l latest -nn node_name -ot operation_type -ou OS_username -rn resource_name -rt resource_type -t to_date-range [-j] [-h]

Parameters

Example

# odacli list-auditrecords
ID                                    Resource type         Resource name         Operation type   DCS username     OS username      Timestamp              
------------------------------------  --------------------  --------------------  ---------------  ---------------  ---------------  -----------------------
41295d99-f263-4284-b6d9-2aff1ae0f850  BM_CPU_POOL           testbmpool            CREATE           oda-admin        root             2020-10-08 13:27:05 UTC
0f07a013-5bb4-4cd8-bd49-04dc61fcd454  BM_CPU_POOL           pool_9f74a8e9-        DELETE           oda-admin        root             2020-10-08 12:26:30 UTC
d858269b-6c28-4bc2-af71-79004f3561e6  BM_CPU_POOL           pool_9f74a8e9-        CREATE           oda-admin        root             2020-10-08 12:24:36 UTC
9d7852c1-93fb-410e-9e0c-8c0a95ed3f0c  VM_CPU_POOL           pool_d48e81e4-        DELETE           oda-admin        root             2020-10-08 12:06:45 UTC
0235cc84-9345-40bc-ac4f-7de3f63202e2  VM_CPU_POOL           pool_4fe0b4f4-        DELETE           oda-admin        root             2020-10-08 12:06:45 UTC
762f7263-7bd9-4b12-b891-48305165bf36  VM_CPU_POOL           pool_4fe0b4f4-        MODIFY           oda-admin        root             2020-10-08 12:06:22 UTC
0bd2a25d-2327-4918-bd47-8c00f7406f92  VM_CPU_POOL           pool_4fe0b4f4-        MODIFY           

Syntax

 odacli describe-auditrecord -i [-j] [-h]

Parameters

Example

# odacli describe-auditrecord -i 41295d99-f263-4284-b6d9-2aff1ae0f850
Audit Record details                                                            
--------------------------------------------------------------------------------
 Event details            
--------------------------
                Record ID:  41295d99-f263-4284-b6d9-2aff1ae0f850
         Record timestamp:  2020-10-08 13:27:05 UTC
             DCS username:  oda-admin
              OS username:  root
               Cluster ID:  test_cluster-c
                  Node ID:  test_cluster

 Resource/Operation       
--------------------------
            Resource type:  BM_CPU_POOL
              Resource ID:  b17cb623-bf79-491f-86d8-d8502987e26c
            Resource name:  testbmpool
           Operation type:  CREATE
    Operation description:  Created with '2' cores and allocation 'test_cluster:1-2,17-18'

Syntax

 odacli create-vnetwork -n name -if interface-name -t type -br bridge -g gateway -ip IP-address -nm netmask -u uniform -vlan VLAN-network ID [-j] [-h]

Parameters

Usage Notes

If you did not specify the IP address, or netmask, or gateway during vnetwork creation, then you can add them later using the odacli modify-vnetwork command.

Example

# odacli create-vnetwork -n vnet1 -if btbond2 -type bridged

Syntax

 odacli list-vnetworks [-j] [-h]

Parameters

Example

# odacli list-vnetworks

Syntax

 odacli describe-vnetwork -n [-j] [-h]

Parameters

Example: Describing a VM Network named vnet1

# odacli describe-vnetwork -n vnet1

Syntax

 odacli start-vnetwork -n name [-j] [-h]

Parameters

Example

Start a virtual network named vnet1.

# odacli start-vnetwork -n vnet1

Syntax

 odacli stop-vnetwork -n name [-j] [-h]

Parameters

Example

Stop a virtual network named vnet1.

# odacli stop-vnetwork -n vnet1

Syntax

 odacli modify-vnetwork -n name -if -t -br -gw -ip -nm -u -vlan [-j] [-h]

Parameters

Example

Syntax

 odacli delete-vnetwork -n name [-j] [-h]

Parameters

Example

Delete a VM network named vnet1.

# odacli delete-vnetwork -n vnet1

Syntax

 odacli create-vm -n name -m memory -bo boot_options -src source -vc vcpus -vms vmstorage -cp cpupool -d description -g graphics
-mm max-mem-size -mvc max-vcpu-count -osv os_variant -pn preferred_node -s disk_size -vd vdisks
-vn virtual_network_names -ea extra_args -esrc extra_srcs [-j] [-h]

Parameters

Usage Notes

• Use the --extra-args parameter to add kickstart configuration file, kernel parameters for example, serial console. For example: --extra-args "console=tty0 console=ttyS0,115200 ks=http://192.168.122.100:80/ks.txt"

Example

Create a VM named vm1 with 8 vcpus and 8 GB memory. The VM is stored in the VM Storage vms1. The source used for the installation is located on /u01/OL7.iso.

# odacli create-vm -n vm1 -vc 8 -m 8G -vms vs1 -src /u01/OL7.iso

Example

If the installation source is located through network, the network configuration of the VM must be provided by --extra-args so that the network can be setup at the bootstrap of the VM, to reach the installation source over the network. For example, to create a VM from source https://example.com/iso/OracleLinux/OL7/u9/x86_64/OracleLinux-R7-U9-Server-x86_64-dvd/:

# odacli create-vm -vn pubnet -m 4G -vc 8 -src https://example.com/iso/OracleLinux/OL7/u9/x86_64/OracleLinux-R7-U9-Server-x86_64-dvd/ -vd vmstorage_vdisk2 -vms vmstore -g vnc,listen=0.0.0.0,port=5949 -n vm1 -s 20G --extra-args "dns=<dns_server_ip_addr> ip=<vm1_ip_addr>::<gateway_ip>:<netmask>:<vm1_hostname>:ens3:none"

Syntax

 odacli list-vms [-j] [-h]

Parameters

Example

# odacli list-vms

Syntax

 odacli describe-vm -n name [-j] [-h]

Parameters

Example: Describing a Virtual Machine named vm1

# odacli describe-vm -n vm1

Syntax

 odacli modify-vm -n name -as -en -bo boot_options -cfg -avd attach_vdisks -avn attach_vnetworks -dev device -d description -dn -dvd detach-vdisk -dvn detach-vnetworks -mm max-memory -mvc max-vcpuc -m memory -no-cp -pn preferred-node -vc vcpu_count -di disk-increment -en -fo -g graphics -l -no-as [-f] [-g] [-j] [-h]

Parameters

Usage Tips

• --live: The change is applied to the running VM instance, but does not persist after the VM stops.
• --enable-numa: Use this option to enable NUMA for an existing VM.
• --config: The change persists in the configuration of VM instance and takes effect on subsequent reboots.
• If neither --live or --config is specified, then the default behavior is --config.
• You can specify both the --live or --config options if you want the modification to take effect immediately and on subsequent boots.
• 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.

Modifying CPU Count and Memory for a VM

Update the configuration of a VM named 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 -vc 6 -mm 6G --live --config

Enabling NUMA

# odacli modify-vm --name name --enable-numa

Modifying a VM to attach a vnetwork

# odacli modify-vm -n vm_name -avn vnetwork_name

Modifying a VM to change the bus type for the VM image

# odacli modify-vm -dev "bus=sata" -n winvm

Modifying a VM to change the bus type for a specific vdisk attached to the VM

# odacli modify-vm -dev "vdisk=vdisk_name, bus=sata" -n winvm

The command changes the winvm bus type of vdisk_name to sata. If you do not specify the vdisk parameter, the command changes the bus type to the vdisk that holds the VM image.

Syntax

 odacli start-vm -n name -nn [-j] [-h]

Parameters

Usage Notes

• 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.
• If you specify the node name -n, then the VM starts on the specified node, even if the preferred node is defined.

Example

Start a virtual machine named vm1.

# odacli start-vm -n vm1

Syntax

 odacli stop-vm -n name [-f] [-j] [-h]

Parameters

Example

Stop a virtual machine named vm1.

# odacli stop-vm -n vm1

Syntax

 odacli migrate-vm -n name -th node_name [-j] [-h]

Parameters

Example

Migrate a virtual machine named vm1 to node named oda1.

odacli migrate-vm -n vm1 -th oda1

Syntax

# odacli clone-vm -n name_of_vm_to_clone_from -cn clone_name [-j] [-h]

Parameters

Example

Create a clone of a virtual machine named 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

Syntax

 odacli delete-vm -n name [-f] [-j] [-h]

Parameters

Example

Delete a virtual machine named vm1.

odacli delete-vm -n vm1