Oracle Cloud Infrastructureドキュメント

Oracle Database CLIリファレンス

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

ノート

データベースCLIはExadata DBシステムでは使用できません。

使用上の注意

  • データベースのCLIコマンドは、rootユーザーとして実行する必要があります。

  • dbcli/opt/oracle/dcs/bin/ディレクトリにあります。

    このディレクトリは、ルート・ユーザー環境のパスに含まれています。

  • Oracle Databaseは、dbcliコマンド出力のログを、/opt/oracle/dcs/log/ディレクトリのdcscli.logおよびdcs-agent.logファイルに保持します。

  • データベースのCLIコマンドとほとんどのパラメータは、大文字と小文字が区別され、次のように入力する必要があります。 いくつかのパラメータは、パラメータの説明に示されているように、大/小文字の区別がなく、大文字または小文字で入力できます。

警告

データベースCLIコマンドを使用する場合は、機密情報を含むパラメータ値の指定は避けることをお薦めします。

構文

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

dbcli command [parameters]

説明:

  • commandは、create-databaseなどの動詞-オブジェクトの組み合わせです。
  • parametersには、コマンドの追加オプションが含まれています。 ほとんどのパラメータ名の前には、2つのダッシュが付いています(例:--help)。 省略されたパラメータ名の前には、たとえば-hのように1つのダッシュが付いています。
  • ユーザー指定のパラメータ値は、山カッコで囲まれた赤いテキストで表示されます(例:<db_home_id>)。 これらの値を指定する場合は、山カッコを省略してください。
  • helpパラメータはすべてのコマンドで使用できます。

このトピックの残りの部分では、コマンドの構文とその他の詳細について説明します。

CLIアップデート・コマンド

場合によっては、新しいコマンドがデータベースCLIに追加され、他のコマンドが新しい機能をサポートするように更新されることがあります。 次のコマンドを使用して、データベースCLIを更新できます:

cliadm update-dbcli

cliadm update-dbcliコマンドを使用して、最新の新規および更新されたコマンドでデータベースCLIを更新します。

ノート

cliadm update-dbcliコマンドは、2ノードのRAC DBシステムでは使用できません。

構文

cliadm update-dbcli [-h] [-j]

パラメータ

パラメータ 完全名 説明
-h --help (オプション)コマンドの使用に関するヘルプを表示します。
-j --json (オプション)JSON出力を表示します。

次のコマンドは、dbcliを更新します:

[root@dbsys ~]# cliadm update-dbcli
{
  "jobId" : "dc9ce73d-ed71-4473-99cd-9663b9d79bfd",
  "status" : "Created",
  "message" : "Dcs cli will be updated",
  "reports" : [ ],
  "createTimestamp" : "January 18, 2017 10:19:34 AM PST",
  "resourceList" : [ ],
  "description" : "dbcli patching",
  "updatedTime" : "January 18, 2017 10:19:34 AM PST"
}

エージェント・コマンド

エージェントを管理するには、次のコマンドを使用できます:

dbcli ping-agent

エージェントの到達可能性をテストするには、dbcli ping-agentコマンドを使用します。

構文

dbcli ping-agent [-h] [-j]

パラメータ

パラメータ 完全名 説明
-h --help (オプション)コマンドの使用に関するヘルプを表示します。
-j --json (オプション)JSON出力を表示します。

dbcli list-agentConfigParameters

dbcli list-agentConfigParametersコマンドを使用して、エージェント構成パラメータをリストします。

構文

dbcli list-agentConfigParameters [-n] [-h] [-j]

パラメータ

パラメータ 完全名 説明
-h --help (オプション)コマンドの使用に関するヘルプを表示します。
-j --json (オプション)JSON出力を表示します。
-n -name (オプション)パラメータ名。

dbcli update-agentConfigParameters

dbcli update-agentConfigParametersコマンドを使用して、エージェント構成パラメータを更新します。

構文

dbcli update-agentConfigParameters -n <parameter> [-v <value>] [-a] [-c] [-d] [-u] [-r] [-h] [-j]

パラメータ

パラメータ 完全名 説明
-a --append (オプション)指定した値を指定したパラメータに貼り付けます。 パラメータの名前と値が複数ある例: -n p1 -v v1 -n p2 -v v2 -a
-c --comment (オプション)パラメータに対するコメントを追加します。 デフォルト: [ ]
-d --description (オプション)パラメータの説明を追加します。 デフォルト: [ ]
-h --help (オプション)コマンドの使用に関するヘルプを表示します。
-j --json (オプション)JSON出力を表示します。
-n --name パラメータ名 パラメータの名前と値が複数ある例: -n p1 -v v1 -n p2 -v v2デフォルト:[ ]
-r --reset (オプション)パラメータをデフォルト値にリセットします。 複数のパラメータのリセット例: -n p1 -n p2 -rデフォルト:false
-u --update (オプション)指定したパラメータ値を指示どおりに置き換えます。 パラメータの名前と値が複数ある例: -n p1 -v v1 -n p2 -v v2 -uデフォルト:false
-v --value (オプション)パラメータ値。 パラメータの名前と値が複数ある例: -n p1 -v v1 -n p2 -v v2デフォルト:[ ]

Autologcleanpolicyコマンド

次のコマンドは、ログの自動クリーンアップ(パージ)のポリシーを管理するために使用できます。

dbcli create-autoLogCleanPolicy

ログの自動クリーンアップ(パージ)のポリシーを作成するには、dbcli create-autoLogCleanPolicyコマンドを使用します。

構文

dbcli create-autoLogCleanPolicy [-c {gi|database|dcs}] [-f <number>] [-o <number>] [-u {Day|Hour|Minute}] [-uMB <number>] [-uPer <number>] [-h] [-j]

パラメータ

パラメータ 完全名 説明
-c --components (オプション)パージするコンポーネント。 使用可能な値は、gi、databaseおよびdcsです。 複数の値は、カンマで区切ってください。 例: gi,dcs
-f --freeSpaceBelowPercentage (オプション)空きディスク領域が合計パーティション・サイズの指定したパーセンテージ未満になると、ログをパージします。 有効範囲: 20-50. デフォルト: 20
-h --help (オプション)コマンドの使用に関するヘルプを表示します。
-j --json (オプション)JSON出力を表示します。
-o --olderthan (オプション)時間間隔の数量部分。 デフォルト: 30 指定した時間間隔(-oおよび-u)より古いログをクリーンアップします。
-u --olderThanUnit (オプション)時間間隔の単位部分。 使用可能な値: 日、時または分。 デフォルト: Day. 指定した時間間隔(-oおよび-u)より古いログをクリーンアップします。
-uMB --usageOverMB (オプション)ログの使用量がMegaBytes (MB)の指定数を超えると、ログをパージします。 有効範囲: 合計パーティション・サイズの10から50%。
-uPer --usageOverPercentage (オプション)ログの使用量が合計パーティション・サイズの指定したパーセンテージを超えると、ログをパージします。 有効範囲: 10-50.

dbcli list-autoLogCleanPolicy

dbcli list-autoLogCleanPolicyコマンドを使用して、ログの自動クリーンアップのポリシーをリストします。

構文

dbcli list-autoLogCleanPolicy [-c {gi|database|dcs}] [-h] [-j]

パラメータ

パラメータ 完全名 説明
-c --components (Optional) Components 使用可能な値は、gi、databaseおよびdcsです。 複数の値は、カンマで区切ってください。 例: gi,dcs
-h --help (オプション)コマンドの使用に関するヘルプを表示します。
-j --json (オプション)JSON出力を表示します。

バックアップ・コマンド

次のコマンドを使用して、データベースをバックアップできます:

ノート

dbcliを使用するかわりに、コンソールまたはAPIを使用して、ベアメタルまたは仮想マシンDBシステム・データベースのオブジェクト・ストレージへのバックアップを管理できます。 ただし、dbcliを使用して管理バックアップを使用するように切り替えると、新しいバックアップ構成が作成されてデータベースに関連付けられるため、dbcliを使用して作成したバックアップには、マネージドのバックアップ・インタフェースからアクセスできなくなります。 管理対象バックアップの詳細は、「Oracle Cloud Infrastructure Object Storageへのデータベースのバックアップ」を参照してください。

dbcli create-backupコマンドを使用してデータベースをバックアップする前に、以下を行う必要があります:

  1. dbcli create-backupconfigコマンドを使用してバックアップ構成を作成します。
  2. dbcli update-databaseコマンドを使用して、バックアップ構成をデータベースに関連付けます。

データベースがバックアップ構成に関連付けられたら、cronジョブのdbcli create-backupコマンドを使用して、バックアップを自動的に実行できます。 CronMakerなどのcronユーティリティを使用すると、式の作成に役立ちます。 詳細は、http://www.cronmaker.comを参照してください。

dbcli create-backup

dbcli create-backupコマンドを使用して、データベースのバックアップを作成します。

構文

dbcli create-backup -in <db_name> -i <db_id> [-bt {Regular-L0|Regular-L1|Longterm|ArchiveLog}] [-c {Database|TdeWallet}] [-k <n>] [-t <tag>] [-h] [-j]

パラメータ

パラメータ 完全名 説明
-bt --backupType

(オプション)バックアップ・タイプ。 使用可能な値は、Regular-L0、Regular-L1、LongtermおよびArchiveLogです。 Regular-L0および通常のL1は、増分L0およびL1バックアップに対応します。 Longtermはフル・バックアップに対応します。 ArchiveLogは、アーカイブredoログのバックアップに対応しています。 デフォルト値はRegular-L1です。 値では大文字と小文字は区別されません。 省略した場合は、デフォルト値が使用されます。

-c --component

(オプション) コンポーネント。 使用可能な値は、データベースおよびTdeWalletです。 デフォルト値はデータベースです。 TdeWalletの値によってTDEウォレットがバックアップされます。 値では大文字と小文字は区別されません。 省略した場合は、デフォルト値が使用されます。

ノート

TDEウォレットは、次の状況で自動的にバックアップされます:

  • データベースは、「オブジェクト・ストレージ」バックアップ構成を使用して作成されます。
  • 「オブジェクト・ストレージ」バックアップ構成を持つデータベースが更新されます。
  • 「オブジェクト・ストレージ」のバックアップ構成が更新されます。
  • Longterm型のバックアップが作成されます。
  • データベースのTDEキーがローテーションされます。
  • データベースがバックアップされ、TDEウォレット・バックアップはまだ存在しません。
-h --help (オプション)コマンドの使用に関するヘルプを表示します。
-i --dbid バックアップするデータベースのID。 dbcli list-databasesコマンドを使用してデータベースIDを取得します。
-in --dbName バックアップするデータベースの名前。 dbcli list-databasesコマンドを使用して、データベース名を取得します。
-j --json (オプション)JSON出力を表示します。
-k --keepDays

(オプション)バックアップまたはコピーが保持されるまでの時間を指定します。 バックアップの保存方針の設定に関係なく、この期限を過ぎるとバックアップは不要とされます。 Longtermバックアップ・タイプの場合のみ。

-t --tag

(Longtermバックアップ・タイプに必須)バックアップ・セットにユーザー指定のタグ名を指定して、このタグをコマンドで生成される出力ファイルに適用します。 この値では、大文字と小文字は区別されません。 有効な文字数: 1から30. 使用する文字は、ターゲット・ファイル・システムのファイル名に使用できる有効な文字に限定されています。 たとえば、ASMでは、内部的に使用されるファイル名でのハイフン(-)文字の使用はサポートされていないため、ウィーク増分はASMディスク・グループ内のバックアップの有効なタグ名ではありません。 TAGパラメータには、環境変数を含めることはできません。

次のコマンドは、データベースIDを使用して、指定したデータベースのバックアップを作成します。

[root@dbsys ~]# dbcli create-backup -i 573cadb2-0cc2-4c1c-9c31-595ab8963d5b

次のコマンドは、データベース名("mydb")を使用して、指定したデータベースのバックアップを作成します。

[root@dbsys ~]# dbcli create-backup -in mydb

dbcli getstatus-backup

dbcli getstatus-backupコマンドを使用して、バックアップのステータスを表示します。

構文

dbcli getstatus-backup -t <backup_type> [i <id>] [-in <name>] [-l] [-h] [-j]

パラメータ

パラメータ 完全名 説明
-h --help (オプション)コマンドの使用に関するヘルプを表示します。
-i --dbId (オプション)データベース・リソースID。
-in --dbName (オプション)データベース・リソース名。
-j --json (オプション)JSON出力を表示します。
-l --isLatestBackupReport (オプション)最新のバックアップ・レポート。 デフォルト: true。
-t --backupType バックアップのタイプ。

dbcli schedule-backup

dbcli schedule-backupコマンドは、データベースのバックアップをスケジュールする場合に使用します。

構文

dbcli schedule-backup -t <backup_type> -f <number> [i <id>] [-in <name>] [-h] [-j]

パラメータ

パラメータ 完全名 説明
-f --frequency 頻度(分)。
-h --help (オプション)コマンドの使用に関するヘルプを表示します。
-i --dbId (オプション)データベース・リソースID。
-in --dbName (オプション)データベース・リソース名。
-j --json (オプション)JSON出力を表示します。
-t --backupType バックアップのタイプ。

Backupconfigコマンド

バックアップ構成によって、データベース・バックアップのバックアップ先とリカバリ・ウィンドウが決定されます。 dbcli update-databaseコマンドを使用してバックアップ構成を作成し、それをデータベースに関連付けることができます。

警告

これらのコマンドを使用して変更を加えた場合、コンソールを使用して構成されたバックアップは使用できなくなる可能性があります。
コンソールを使用して構成されたバックアップの場合は、これらのコマンドをサポート・ガイドとしてのみ使用してください。

ノート

dbcliを使用するかわりに、コンソールまたはAPIを使用して、ベアメタルまたは仮想マシンDBシステム・データベースのオブジェクト・ストレージへのバックアップを管理できます。 管理対象バックアップの詳細は、「Oracle Cloud Infrastructure Object Storageへのデータベースのバックアップ」を参照してください。

データベースがバックアップ構成に関連付けられたら、cronジョブのdbcli create-backupコマンドを使用して、バックアップを自動的に実行できます。 CronMakerなどのcronユーティリティを使用すると、式の作成に役立ちます。 詳細は、http://www.cronmaker.comを参照してください。

バックアップ構成を管理するには、次のコマンドを使用できます:

dbcli create-backupconfig

dbcli create-backupconfigコマンドを使用して、バックアップ先とリカバリ・ウィンドウを定義するバックアップ構成を作成します。

構文

dbcli create-backupconfig -d {DISK|OBJECTSTORE|NONE} -c <bucket>  -o <object_store_swift_id> -on <object_store_swift_name> -w <n> -n <name> [-cr|-no-cr] [-h] [-j]

パラメータ

パラメータ 完全名 説明
-c --container

Oracle Cloud Infrastructure Object Storageサービス内の既存のバケットの名前。 コンソール APIまたはオブジェクト・ストレージ APIを使用してバケットを作成できます。 詳細は、「バケットの管理」を参照してください。

また、--backupdestination objectstore--objectstoreswiftIdパラメータも指定する必要があります。

-cr

-no-cr

--crosscheck

--no-crosscheck

(オプション)クロスチェック操作を有効にするかどうかを示します。 この操作により、ディスクまたはメディア管理カタログ上のファイルがRMANリポジトリのデータに対応するかどうかが決定されます。 省略すると、デフォルト設定が使用されます(デフォルトではクロスチェックが有効化されています)。

-d --backupdestination

バックアップ先は次のいずれかです(これらの値は大文字と小文字が区別されません):

DISK - ローカル高速リカバリ領域。

OBJECTSTORE - Oracle Cloud Infrastructure Object Storageサービス。 また、--containerおよび--objectstoreswiftIdパラメータも指定する必要があります。

NONE - バックアップを無効にします。

-h --help (オプション)コマンドの使用に関するヘルプを表示します。
-j --json (オプション)JSON出力を表示します。
-n --name バックアップ構成の名前。
-o --objectstoreswiftId

Oracle Cloud Infrastructure Object Storageサービスのエンドポイントと資格証明を含むオブジェクト・ストアのID。 オブジェクト・ストアIDを取得するには、dbcli list-objectstoreswiftsコマンドを使用します。 オブジェクト・ストアを作成するには、dbcli create-objectstoreswiftコマンドを使用します。

また、--backupdestination objectstore--containerパラメータも指定する必要があります。

-on --objectstoreswiftName

Oracle Cloud Infrastructure Object Storageサービスのエンドポイントおよび資格証明を含むオブジェクト・ストアの名前。 dbcli list-objectstoreswiftsコマンドを使用して、オブジェクト・ストア名を取得します。 オブジェクト・ストアを作成するには、dbcli create-objectstoreswiftコマンドを使用します。

また、--backupdestination objectstore--containerパラメータも指定する必要があります。

-w --recoverywindow

バックアップおよびアーカイブREDOログが維持される日数。 現在時刻を終点とし、指定された日数を遡る期間です。

DISKバックアップ先の場合は、1〜14日を指定します。

OBJECTSTOREバックアップ先には、1〜30日を指定します。

次のコマンドは、dbbkcfg1という名前のバックアップ構成を作成します:

[root@dbsys ~]# dbcli create-backupconfig -d Disk -w 7 -n dbbkcfg1
{
  "jobId" : "4e0e6011-db53-4142-82ef-eb561658a0a9",
  "status" : "Success",
  "message" : null,
  "reports" : [ {
    "taskId" : "TaskParallel_919",
    "taskName" : "persisting backup config metadata",
    "taskResult" : "Success",
    "startTime" : "November 18, 2016 20:21:25 PM UTC",
    "endTime" : "November 18, 2016 20:21:25 PM UTC",
    "status" : "Success",
    "taskDescription" : null,
    "parentTaskId" : "TaskSequential_915",
    "jobId" : "4e0e6011-db53-4142-82ef-eb561658a0a9",
    "tags" : [ ],
    "reportLevel" : "Info",
    "updatedTime" : "November 18, 2016 20:21:25 PM UTC"
  } ],
  "createTimestamp" : "November 18, 2016 20:21:25 PM UTC",
  "description" : "create backup config:dbbkcfg1",
  "updatedTime" : "November 18, 2016 20:21:25 PM UTC"
}

dbcli list-backupconfigs

dbcli list-backupconfigsコマンドを使用して、DBシステムのすべてのバックアップ構成をリストします。

構文

dbcli list-backupconfigs [-h] [-j]

パラメータ

パラメータ 完全名 説明
-h --help (オプション)コマンドの使用に関するヘルプを表示します。
-j --json (オプション)JSON出力を表示します。

次のコマンドは、バックアップ構成をリストします:

[root@dbsys ~]# dbcli list-backupconfigs


ID                                       Name                 RecoveryWindow     BackupDestination CreateTime
---------------------------------------- -------------------- ------------------ ----------------- -----------------------------
ccdd56fe-a40b-4e82-b38d-5f76c265282d     dbbkcfg1             7                  Disk              July 10, 2016 12:24:08 PM UTC
 

dbcli describe-backupconfig

特定のバックアップ構成の詳細を表示するには、dbcli describe-backupconfigコマンドを使用します。

構文

dbcli describe-backupconfig -i <id> -in <name> [-h] [-j]

パラメータ

パラメータ 完全名 説明
-h --help (オプション)コマンドの使用に関するヘルプを表示します。
-i --backupconfigid バックアップ構成ID。 IDを取得するには、dbcli list-backupconfigsコマンドを使用します。
-in --backupconfigname バックアップ構成名。 dbcli list-backupconfigsコマンドを使用して名前を取得します。
-j --json (オプション)JSON出力を表示します。

次のコマンドは、バックアップ構成の詳細を表示します:

[root@dbsys ~]# dbcli describe-backupconfig -i ccdd56fe-a40b-4e82-b38d-5f76c265282d

Backup Config details
----------------------------------------------------------------
                     ID: ccdd56fe-a40b-4e82-b38d-5f76c265282d
                   Name: dbbkcfg1
         RecoveryWindow: 7
      BackupDestination: Disk
            CreatedTime: July 10, 2016 12:24:08 PM UTC
            UpdatedTime: July 10, 2016 12:24:08 PM UTC

dbcli update-backupconfig

既存のバックアップ構成を更新するには、dbcli update-backupconfigコマンドを使用します。

構文

dbcli update-backupconfig -i <id> -in <name> -w <n> -c <bucket> -o <object_store_swift_id> -on <object_store_swift_name> [-cr|-no-cr] [-h] [-j]

パラメータ

パラメータ 完全名 説明
-c --container

Oracle Cloud Infrastructure Object Storageサービス内の既存のバケットの名前。 コンソール APIまたはオブジェクト・ストレージ APIを使用してバケットを作成できます。 詳細は、「バケットの管理」を参照してください。

また、--backupdestination objectstore--objectstoreswiftIdパラメータも指定する必要があります。

-cr

-no-cr

--crosscheck

--no-crosscheck

(オプション)クロスチェック操作を有効にするかどうかを示します。 この操作により、メディア管理カタログのディスク上のファイルがRMANリポジトリのデータに対応するかどうかが決定されます。 省略すると、デフォルト設定が使用されます(デフォルトではクロスチェックが有効化されています)。

-h --help (オプション)コマンドの使用に関するヘルプを表示します。