[Oracle Cloud] OCI Database(DBaaS)でDBCLIコマンドを使ってみた |

DBCLIの概要

※マニュアルより抜粋

データベースCLI (dbcli)は、ベア・メタルおよび仮想マシンのDBシステムで使用できるコマンドライン・インタフェースです。
DBシステムに接続したら、データベースCLIを使用して、Oracleデータベース・ホームおよびデータベースの作成などのタスクを実行できます。

使用上の注意
・データベースのCLIコマンドは、rootユーザーとして実行する必要があります。
・dbcliは/opt/oracle/dcs/bin/ディレクトリにあります。
このディレクトリは、ルート・ユーザー環境のパスに含まれています。
・Oracle Databaseは、dbcliコマンド出力のログを、/opt/oracle/dcs/log/ディレクトリのdcscli.logおよびdcs-agent.logファイルに保持します。

・構文
データベースのCLIコマンドでは、次の構文を使用します:
dbcli command [parameters]

-hでヘルプ表示、-jでjson形式での出力も可能。

・注意

2ノードRACに対応していないコマンドなどもある。詳細はマニュアル参照。

実際に使ってみた

準備：特になし（プロビジョニング直後から利用可能となっている）

以下の構成の環境で、dbcliコマンドを実際に触ってみた。
シェイプ：DBaaS(VM)
DBバージョン:18c
構成：Single

パス確認

[opc@dbvmee ~]$ sudo su -
[root@dbvmee ~]# which dbcli
/opt/oracle/dcs/bin/dbcli

構成確認

describeとlistオプションで構成情報を色々と確認してみる。

・dbcli describe-component

DBシステムのサーバー、ストレージ、およびデータベース・ホーム・コンポーネントのインストール済みパッチ・バージョンと使用可能パッチ・バージョンを表示します。

[root@dbvmee ~]# dbcli describe-component
System Version
---------------
18.1.3.1.6

Component Installed Version Available Version
---------------------------------------- -------------------- ------------------ --
GI 18.2.0.0.180417 18.3.0.0.180717
DB 18.2.0.0.180417 18.3.0.0.180717

[root@dbvmee ~]# dbcli describe-component -j
{
"systemVersion" : "18.1.3.1.6",
"errorMsg" : null,
"systemComponents" : [ {
"componentType" : "GI",
"systemSubComponents" : [ {
"componentNames" : [ "OraGrid180" ],
"resourceIds" : [ null ],
"installedVersion" : "18.2.0.0.180417",
"availableVersion" : "18.3.0.0.180717"
} ]
}, {
"componentType" : "DB",
"systemSubComponents" : [ {
"componentNames" : [ "OraDB182_home1" ],
"resourceIds" : [ "1df73e4c-989d-409a-9129-9cdd237a7d25" ],
"installedVersion" : "18.2.0.0.180417",
"availableVersion" : "18.3.0.0.180717"
} ]
} ]
}

・dbcli describe-dbsystem

DBシステムに関する詳細を表示するには、dbcli describe-dbsystemコマンドを使用します。

[root@dbvmee ~]# dbcli describe-dbsystem

DbSystem Information
----------------------------------------------------------------
ID: 7ff0f3b0-632b-49d9-997e-2cac91d70849
Platform: Vmdb
Data Disk Count: 8
CPU Core Count: 1
Created: November 8, 2018 12:50:56 AM UTC

System Information
----------------------------------------------------------------
Name: 4ujfvbxa
Domain Name: xxxxxxxxxx.oraclevcn.com
Time Zone: UTC
DB Edition: EE
DNS Servers:
NTP Servers: 169.254.169.254

Disk Group Information
----------------------------------------------------------------
DG Name Redundancy Percentage
------------------------- ------------------------- ------------
Data External 100
Reco External 100

⇒シェイプタイプやOCPU数、プロビジョニング日時などが確認できる。
検証の際は、このコマンドを叩いて構成情報をとっておくのがよいかも。

・describe-latestpatch

DBシステムに適用可能な最新のパッチを表示し、Oracle Cloud Infrastructure Object Storageで入手できます。

[root@dbvmee ~]# dbcli describe-latestpatch

componentType availableVersion
--------------- --------------------
gi 12.2.0.1.180717
gi 12.1.0.2.180717
gi 18.3.0.0.180717
db 11.2.0.4.180717
db 12.2.0.1.180717
db 12.1.0.2.180717
db 18.3.0.0.180717

・dbcli list-databases

DBシステム上のすべてのデータベースを一覧表示します。

[root@dbvmee ~]# dbcli list-databases

ID DB Name DB Type DB Version CDB Class Shape Storage Status DbHomeID
---------------------------------------- ---------- -------- ------------------- - ---------- -------- -------- ---------- ------------ ------------------------- ---------------
e05345be-6623-4d06-b45b-290d021e8289 dbvmee01 Si 18.2.0.0.180417 true OLTP ASM Configured 1df73e4c-989d-409a-9129-9 cdd237a7d25

・dbcli describe-database

データベースの詳細を表示するには、dbcli describe-databaseコマンドを使用します。

[root@dbvmee ~]# dbcli describe-database -in dbvmee01

Database details
----------------------------------------------------------------
ID: e05345be-6623-4d06-b45b-290d021e8289
Description: dbvmee01
DB Name: dbvmee01
DB Version: 18.2.0.0.180417
DB Type: Si
DB Edition: EE
DBID: 2117958207
Instance Only Database: false
CDB: true
PDB Name: pdb1
PDB Admin User Name: pdbuser
Class: OLTP
Shape:
Storage: ASM
CharacterSet: AL32UTF8
National CharacterSet: AL16UTF16
Language: AMERICAN
Territory: AMERICA
Home ID: 1df73e4c-989d-409a-9129-9cdd237a7d25
Console Enabled: false
Level 0 Backup Day: Sunday
AutoBackup Disabled: true
BackupConfigId: 94ea186e-adee-4ca5-8c5c-2c0194ae6c4a
Created: November 8, 2018 12:50:57 AM UTC
DB Domain Name: xxxxxxxxxx.oraclevcn.com

・dbcli list-dbstorages

DBシステムのデータベース・ストレージを一覧表示します

[root@dbvmee ~]# dbcli list-dbstorages

ID Type DBUnique Name Status
---------------------------------------- ------ -------------------- ----------
88120863-e6da-4017-bb05-e090bb144648 Asm dbvmee01_iad1pt Configured

・dbcli describe-dbstorage

特定のデータベース・ストレージ・リソースに関する詳細情報を表示するには、dbcli describe-dbstorageコマンドを使用します。

[root@dbvmee ~]# dbcli describe-dbstorage -i 88120863-e6da-4017-bb05-e090bb144648
DBStorage details
----------------------------------------------------------------
ID: 88120863-e6da-4017-bb05-e090bb144648
DB Name: dbvmee01
DBUnique Name: dbvmee01_iad1pt
DB Resource ID: e05345be-6623-4d06-b45b-290d021e8289
Storage Type: Asm
DATA Location: DATA
RECO Location: RECO
REDO Location: RECO
FLASH Cache Location:
State: ResourceState(status=Configured)
Created: November 8, 2018 12:50:57 AM UTC
UpdatedTime: November 8, 2018 1:17:04 AM UTC

・dbcli list-jobs

ジョブID、ステータス、およびジョブを含むジョブのリストを表示するには、dbcli list-jobsコマンドを使用します。

[root@dbvmee ~]# dbcli list-jobs

ID Description Created Status
---------------------------------------- --------------------------------------------------------------------------- ----------------------------------- ----------
8c4a70e4-233f-4998-a603-d2d51acb93e9 Authentication key update for DCS_ADMIN November 8, 2018 12:49:13 AM UTC Success
816fab5f-6530-4d02-9f0c-0ce094ab3b8f Provisioning service creation November 8, 2018 12:50:58 AM UTC Success
2f786892-4948-4f4a-8701-75aff3a5d713 SSH keys update November 8, 2018 1:44:39 AM UTC Success
23428148-97f5-4a39-b356-62adaa60c92f SSH key delete November 8, 2018 1:46:52 AM UTC Success
21a008db-2b9e-457f-a673-3b336b98a365 create object store:bORoGUIk4XKJLjD6R74s November 16, 2018 6:22:29 AM UTC Success
a4146916-959a-49d4-bb67-b0f4e5c1c178 create backup config:bORoGUIk4XKJLjD6R74s_BC November 16, 2018 6:22:42 AM UTC Success
1f080502-63b8-4c71-8ad1-a3cea48e9098 update database : dbvmee01 November 16, 2018 6:23:14 AM UTC Success
f2b5d92e-2c0b-4158-a38d-e83a6abb436d Create Regular-L0 Backup with TAG-DBTRegular-L01542348777953UGc for Db:dbvmee01 November 16, 2018 6:32:42 AM UTC Success
ab06bbdd-157c-4e6e-9e12-7f1f2a14541f Delete Backup for Database name: dbvmee01_iad1pt November 16, 2018 6:39:17 AM UTC Success
a1d681a6-018e-459c-a1a2-ea9f04a17161 Update objectstoreSwift:bORoGUIk4XKJLjD6R74s November 20, 2018 6:27:53 AM UTC Success
（中略）
8dac8e98-75e6-495d-a033-c306668e0b12 Update objectstoreSwift:bORoGUIk4XKJLjD6R74s January 10, 2019 6:31:29 AM UTC Success
0ad567f9-02d6-4791-b060-493ce32ee534 Create Regular-L1 Backup with TAG-DBTRegular-L11547100795899HgM for Db:dbvmee01 January 10, 2019 6:37:13 AM UTC Success
c556c450-bdb5-4177-a238-ff010883038f Delete Backup for Database name: dbvmee01_iad1pt January 10, 2019 6:46:08 AM UTC Success

・dbcli describe-job

特定のジョブに関する詳細を表示するには、dbcli describe-jobコマンドを使用します。

[root@dbvmee ~]# dbcli describe-job -i 0ad567f9-02d6-4791-b060-493ce32ee534

Job details
----------------------------------------------------------------
ID: 0ad567f9-02d6-4791-b060-493ce32ee534
Description: Create Regular-L1 Backup with TAG-DBTRegular-L11547100795899HgM for Db:dbvmee01
Status: Success
Created: January 10, 2019 6:37:13 AM UTC
Message:

Task Name Start Time End Time Status
---------------------------------------- ----------------------------------- ----------------------------------- ----------
Database container validation January 10, 2019 6:37:17 AM UTC January 10, 2019 6:37:17 AM UTC Success
libopc existence check January 10, 2019 6:37:17 AM UTC January 10, 2019 6:37:17 AM UTC Success
Backup Validations January 10, 2019 6:37:17 AM UTC January 10, 2019 6:37:46 AM UTC Success
Recovery Window validation January 10, 2019 6:37:46 AM UTC January 10, 2019 6:37:55 AM UTC Success
Archivelog deletion policy configuration January 10, 2019 6:37:55 AM UTC January 10, 2019 6:38:03 AM UTC Success
crosscheck database backup January 10, 2019 6:38:03 AM UTC January 10, 2019 6:38:42 AM UTC Success
Database backup January 10, 2019 6:38:42 AM UTC January 10, 2019 6:40:59 AM UTC Success

ヘルプコマンド確認

他にも色々とオプションが用意されている。使い方はマニュアル＆-hオプションで確認可能。

[root@dbvmee ~]# dbcli -h
usage: dbcli    [-h/--help]
                 [-h/--help]
                 [-h/--help]
                 [-h/--help]
                 []

Commands list (use -h/--help option for help on any command):
        agent:
                ping-agent
        availablePatche:
                list-availablePatches
        backup:
                create-backup
        backupconfig:
                create-backupconfig
                delete-backupconfig
                describe-backupconfig
                list-backupconfigs
                update-backupconfig
        bmccredential:
                create-bmccredential
                delete-bmccredential
                describe-bmccredential
                list-bmccredentials
                update-bmccredential
        component:
                describe-component
        database:
                create-database
                delete-database
                describe-database
                list-databases
                recover-database
                register-database
                update-database
                upgrade-database
        dbhome:
                create-dbhome
                delete-dbhome
                describe-dbhome
                list-dbhomes
                update-dbhome
        dbstorage:
                create-dbstorage
                delete-dbstorage
                describe-dbstorage
                list-dbstorages
        dbsystem:
                describe-dbsystem
        job:
                describe-job
                list-jobs
        latestpatch:
                describe-latestpatch
        logCleanJob:
                create-logCleanJob
                describe-logCleanJob
                list-logCleanJobs
        logSpaceUsage:
                list-logSpaceUsage
        netsecurity:
                describe-netsecurity
                update-netsecurity
        objectstoreswift:
                create-objectstoreswift
                delete-objectstoreswift
                describe-objectstoreswift
                list-objectstoreswifts
                update-objectstoreswift
        pendingjob:
                list-pendingjobs
        rmanbackupreport:
                create-rmanbackupreport
                delete-rmanbackupreport
                describe-rmanbackupreport
                list-rmanbackupreports
        schedule:
                describe-schedule
                list-schedules
                update-schedule
        scheduledExecution:
                list-scheduledExecutions
        server:
                update-server
        tdebackupreport:
                list-tdebackupreports
        tdekey:
                update-tdekey

Operations list (use -h/--help option for help on any command):
        create:
                create-backup
                create-backupconfig
                create-bmccredential
                create-database
                create-dbhome
                create-dbstorage
                create-logCleanJob
                create-objectstoreswift
                create-rmanbackupreport
        delete:
                delete-backupconfig
                delete-bmccredential
                delete-database
                delete-dbhome
                delete-dbstorage
                delete-objectstoreswift
                delete-rmanbackupreport
        describe:
                describe-backupconfig
                describe-bmccredential
                describe-component
                describe-database
                describe-dbhome
                describe-dbstorage
                describe-dbsystem
                describe-job
                describe-latestpatch
                describe-logCleanJob
                describe-netsecurity
                describe-objectstoreswift
                describe-rmanbackupreport
                describe-schedule
        list:
                list-availablePatches
                list-backupconfigs
                list-bmccredentials
                list-databases
                list-dbhomes
                list-dbstorages
                list-jobs
                list-logCleanJobs
                list-logSpaceUsage
                list-objectstoreswifts
                list-pendingjobs
                list-rmanbackupreports
                list-scheduledExecutions
                list-schedules
                list-tdebackupreports
        ping:
                ping-agent
        recover:
                recover-database
        register:
                register-database
        update:
                update-backupconfig
                update-bmccredential
                update-database
                update-dbhome
                update-netsecurity
                update-objectstoreswift
                update-schedule
                update-server
                update-tdekey
        upgrade:
                upgrade-database