1. RESTfulサービス管理者ガイド
  2. バックアップとリストアのコマンド

7 バックアップとリストアのコマンド

バックアップとリストアのコマンドを使用すると、Oracle Key Vaultアプライアンスのバックアップを自動化できます。

7.1 okv backup destination createコマンド

okv backup destination createコマンドでは、Oracle Key Vaultサーバーのリモート・バックアップ先を作成します。

必要な権限

システム管理者ロール

構文

okv backup destination create 
--name destination_name 
--transfer-method scp|sftp 
--host-name host_name 
--port port 
--path destination_path 
--user-name user_name 
--authentiation-method password|key-based

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "create",
    "options" : {
      "name" : "#VALUE",
      "transferMethod" : "#scp|sftp",
      "hostName" : "#VALUE",
      "port" : "#VALUE",
      "path" : "#VALUE",
      "userName" : "#VALUE",
      "authenticationMethod" : "#password|key-based"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--name / name

必須

バックアップ先の名前。既存の名前のリストを表示するには、okv backup destination listコマンドを実行します。

--transfer-method / transferMethod

必須

次のいずれかの値を入力します。

  • scp
  • sftp

--host-name / hostName

必須

バックアップ用リモート・サーバーのホスト名またはIPアドレス。ホスト名を入力する場合は、ホスト名が対応するIPアドレスに変換されるようにDNSを構成してください。リモート・バックアップ先にあるホスト名には、スペース、一重引用符または二重引用符を含めないでください。

--port / port

必須

バックアップ先コンピュータのポート番号。デフォルトは22です。

--path / path

必須

バックアップ・ファイルのコピー先になる外部サーバー上の既存のディレクトリへのパス。バックアップ先を作成した後に、このディレクトリの場所を変更することはできません。このパスを、別のOracle Key Vaultサーバーからのバックアップ先にしないでください。リモート・バックアップ先にあるバックアップ先パスには、スペース、一重引用符または二重引用符を含めないでください。

--user-name / userName

必須

リモート・サーバーのユーザー・アカウントのユーザー名。このユーザーには、scp接続のパス・パラメータで指定したディレクトリへの書込み権限があることを確認します。リモート・バックアップ先にあるユーザー名には、スペース、一重引用符または二重引用符を含めないでください。

--authentication-method / authenticationMethod

必須

次のいずれかの値を入力します。

  • password: --user-name / userNameパラメータで指定したユーザー・アカウントのパスワード。
  • key-based: okv backup destination get-public-keyを使用して、Oracle Key Vault内部ユーザーの公開キーを取得します。このコマンドの出力から公開キーをコピーして、そのキーを宛先サーバーにある適切な構成ファイル(authorized_keysなど)に貼り付けます。バックアップ・アカウントの所有者にのみアクセスを許可し、その他のグループまたはユーザーには許可しないように、構成ファイルの権限が設定されていることを確認してください。特定のイベントによって公開キーの変更がトリガーされる可能性があることに注意してください。つまり、新しい公開キーがOracle Key Vaultから適切な構成ファイルに再コピーされるまで、Oracle Key Vaultはバックアップ先を使用できません。これらのイベントには、証明書のローテーション、IPアドレスの変更、クラスタ・ノードへの変換などが含まれますが、これらに限定されているわけではありません。

JSONの例

  1. okv backup destination createコマンド用にJSON入力を生成します。 
    okv backup destination create --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "create",
    "options" : {
      "name" : "#VALUE",
      "transferMethod" : "#scp|sftp",
      "hostName" : "#VALUE",
      "port" : "#VALUE",
      "path" : "#VALUE",
      "userName" : "#VALUE",
      "authenticationMethod" : "#password|key-based"
    }
  }
}
  2. 生成された入力をファイル(たとえば、bkup-srvr-dest-create.json)に保存して、バックアップ・サーバーの宛先を作成できるように編集します。 
    {
"service": {
        "category": "backup",
        "resource": "destination",
        "action": "create",
        "options": {
            "name": "hr_backup",
            "transferMethod": "scp",
            "hostName": "192.0.2.34",
            "port": "22",
            "path": "/opt/okv/bckups",
            "userName": "psmith",
            "authenticationMethod": "password"
          } 
     }
}
  3. 生成されたJSONファイルを使用して、okv backup destination createコマンドを実行します。 
    okv backup destination create --from-json bkup-srvr-dest-create.json

    ユーザー認証方式にpasswordを指定した場合は、パスワードの入力が求められます。正しいパスワードを入力すると、次のような出力が表示されます。 

    Destination User Password: password
{
  "result" : "Success"
}

親トピック: バックアップとリストアのコマンド

7.2 okv backup destination deleteコマンド

okv backup destination deleteコマンドでは、バックアップ先を削除します。

必要な権限

システム管理者ロール

構文

okv backup destination delete --name destination_name

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "delete",
    "options" : {
      "name" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート 必須かどうか 説明

--name / name

必須

リモート・バックアップ先の名前。既存のバックアップ名を調べるには、okv backup destination listコマンドを実行します。

JSONの例

  1. okv backup destination deleteコマンド用にJSON入力を生成します。 
    okv backup destination delete --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "delete",
    "options" : {
      "name" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、bkup-srvr-dest-del.json)に保存して、バックアップ・サーバーの宛先を削除できるように編集します。 
    {
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "delete",
    "options" : {
      "name" : "prod_okv_backup_dest"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv backup destination deleteコマンドを実行します。 
    okv backup destination delete --from-json bkup-srvr-dest-del.json

    出力は、次のようになります。 

    {
  "result" : "Success"
}

親トピック: バックアップとリストアのコマンド

7.3 okv backup destination getコマンド

okv backup destination getコマンドでは、特定のバックアップ先に関する情報を取得します。

必要な権限

システム管理者ロール

構文

okv backup destination get --name backup_destination_name

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "get",
    "options" : {
      "name" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--name / name

必須

バックアップ先の名前。既存の名前のリストを表示するには、okv backup destination listコマンドを実行します。

JSONの例

  1. okv backup destination getコマンド用にJSON入力を生成します。 
    okv backup destination get --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "get",
    "options" : {
      "name" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、bkup-srvr-dest-get.json)に保存して、バックアップ・サーバーの宛先を取得できるように編集します。 
    {
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "get",
    "options" : {
      "name" : "prod_okv_backup_dest"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv backup destination getコマンドを実行します。 
    okv backup destination get --from-json bkup-srvr-dest-get.json

    出力は、次のようになります。 

    {
  "object" : [ {
    "authenticationMethod" : "Key-based",
    "filePath" : "/net/okv_backup_dest",
    "hostName" : "192.0.2.1",
    "name" : "PROD_OKV_BACKUP_DEST",
    "port" : "22",
    "transferType" : "scp",
    "userName" : "psmith"
  } ]
}

親トピック: バックアップとリストアのコマンド

7.4 okv backup destination listコマンド

okv backup destination listコマンドでは、現在のOracle Key Vaultサーバーのバックアップ先の名前のリストを表示します。

必要な権限

システム管理者ロール

構文

okv backup destination list

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "list"
  }
}

パラメータ

なし

JSONの例

  1. okv backup destination listコマンド用にJSON入力を生成します。 
    okv backup destination list --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "list"
  }
}
  2. 生成された入力をファイル(たとえば、bkup-srvr-dest.json)に保存します。
  3. 生成されたJSONファイルを使用して、okv backup destination listコマンドを実行します。 
    okv backup destination list --from-json bkup-srvr-dest.json

    出力は、次のようになります。 

    {
  "object" : [ {
    "authenticationMethod" : " ",
    "filePath" : "-",
    "hostName" : "localhost",
    "name" : "LOCAL",
    "transferType" : "-",
    "userName" : "-"
  }, {
    "authenticationMethod" : "Key-based",
    "filePath" : "/net/okv_backup_dest",
    "hostName" : "10.247.130.99",
    "name" : "PROD_OKV_BACKUP_DEST",
    "port" : "22",
    "transferType" : "scp",
    "userName" : "psmith"
  } ]
}

親トピック: バックアップとリストアのコマンド

7.5 okv backup destination list-backupsコマンド

okv backup destination list-backupsコマンドでは、リストア操作に使用できる宛先のバックアップをリストします。

必要な権限

システム管理者ロール

構文

okv backup destination list-backups --name destination_name

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "list-backups",
    "options" : {
      "name" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--name / name

必須

バックアップ先の名前。既存のバックアップ先の名前を調べるには、okv backup destination listコマンドを実行します。

JSONの例

  1. okv backup destination list-backupsコマンド用にJSON入力を生成します。 
    okv backup destination list-backups --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "list-backups",
    "options" : {
      "name" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、dest-list-backups.json)に保存して、バックアップ・サーバーの宛先をリストできるように編集します。 
    {
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "list-backups",
    "options" : {
      "name" : "prod_okv_backup_dest"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv backup destination list-backupsコマンドを実行します。 
    okv backup destination list-backups --from-json dest-list-backups.json

    出力は、次のようになります。 

    {
  "object" : [ {
    "file" : "okvbackup_periodic_full_20201130011214",
    "time" : "10656-03-16 23:51:00.1636804072 UTC",
    "type" : "Periodic"
  } ]
}

親トピック: バックアップとリストアのコマンド

7.6 okv backup destination updateコマンド

okv backup destination updateコマンドでは、保存されているバックアップ先の設定を更新します。

必要な権限

システム管理者ロール

構文

okv backup destination update 
--name destination_name 
--port port 
--user-name user_name 
--authentication-method authentication_method

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "update",
    "options" : {
      "name" : "#VALUE",
      "port" : "#VALUE",
      "userName" : "#VALUE",
      "authenticationMethod" : "#password|key-based"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--name / name

必須

バックアップ先の名前。既存のバックアップ先の名前をリスト表示するには、okv backup destination listコマンドを実行します。

--port / port

オプション

バックアップ先コンピュータのポート番号。デフォルトは22です。

--user-name / userName

オプション

リモート・サーバーのユーザー・アカウントのユーザー名。このユーザーには、scp接続のパス・パラメータで指定したディレクトリへの書込み権限があることを確認します。リモート・バックアップ先にあるユーザー名には、スペース、一重引用符または二重引用符を含めないでください。

--authentication-method / authenticationMethod

オプション

次のいずれかの値を入力します。

  • password: --user-name / userNameパラメータで指定したユーザー・アカウントのパスワード。
  • key-based: okv backup destination get-public-keyを使用して、Oracle Key Vault内部ユーザーの公開キーを取得します。このコマンドの出力から公開キーをコピーして、そのキーを宛先サーバーにある適切な構成ファイル(authorized_keysなど)に貼り付けます。バックアップ・アカウントの所有者にのみアクセスを許可し、その他のグループまたはユーザーには許可しないように、構成ファイルの権限が設定されていることを確認してください。特定のイベントによって公開キーの変更がトリガーされる可能性があることに注意してください。つまり、新しい公開キーがOracle Key Vaultから適切な構成ファイルに再コピーされるまで、Oracle Key Vaultはバックアップ先を使用できません。これらのイベントには、証明書のローテーション、IPアドレスの変更、クラスタ・ノードへの変換などが含まれますが、これらに限定されているわけではありません。

例

  1. okv backup destination updateコマンド用にJSON入力を生成します。 
    okv backup destination update --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "update",
    "options" : {
      "name" : "#VALUE",
      "port" : "#VALUE",
      "userName" : "#VALUE",
      "authenticationMethod" : "#password|key-based"
    }
  }
}
  2. 生成された入力をファイル(たとえば、update-bkup-srvr-dest.json)に保存して、バックアップ・サーバーの宛先を更新できるように編集します。 
    {
"service": {
        "category": "backup",
        "resource": "destination",
        "action": "update",
        "options": {
            "name": "hr_backup",
            "port": "22",
            "userName": "psmith",
            "authenticationMethod": "password"
          } 
     }
}
  3. 生成されたJSONファイルを使用して、okv backup destination updateコマンドを実行します。 
    okv backup destination update --from-json update-bkup-srvr-dest.json

    ユーザー認証方式にpasswordを指定した場合は、パスワードの入力が求められます。正しいパスワードを入力すると、次のような出力が表示されます 

    Destination User Password: password
{
  "result" : "Success"
}

親トピック: バックアップとリストアのコマンド

7.7 okv backup destination get-public-keyコマンド

okv backup destination get-public-keyコマンドでは、バックアップの実行に使用するOracle Key Vault内部ユーザーのSSH公開キーを取得します。

このコマンドの出力から公開キーをコピーして、バックアップ先サーバーにあるバックアップ先ユーザー・アカウントの適切な構成ファイル(authorized_keysなど)に貼り付けます。バックアップ・アカウントにのみアクセスを許可し、その他のグループまたはユーザーには許可しないように、構成ファイルの権限が設定されていることを確認してください。特定のイベントによって公開キーの変更がトリガーされる可能性があることに注意してください。つまり、新しい公開キーがOracle Key Vaultから適切な構成ファイルに再コピーされるまで、Oracle Key Vaultはバックアップ先を使用できません。これらのイベントには、証明書のローテーション、IPアドレスの変更、クラスタ・ノードへの変換などが含まれますが、これらに限定されているわけではありません。

必要な権限

システム管理者ロール

構文

okv backup destination get-public-key

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "get-public-key"
  }
}

パラメータ

なし

JSONの例

  1. okv backup destination get-public-keyコマンド用にJSON入力を生成します
    okv backup destination get-public-key --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "get-public-key"
  }
}
  2. 生成された入力をファイル(たとえば、bkup-dest-get-public-key.json)に保存します。
  3. 生成されたJSONファイルを使用して、okv backup destination get-public-keyコマンドを実行します。 
    okv backup destination get-public-key --from-json bkup-dest-get-public-key.json

    出力は、次のようになります。 

    {
  "result" : "Success",
  "value" : {
    "output" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDRLparTgrf5F2IExZ1IMZecobMw2ptj5WWlr6l2ww9GHZ5YgMiTNBCiAjr68KgLgJ9eRkOSSz7tsnYzcw8th45abB344LzMBLREqtqbV4U0PYHMmt1ovhd+djhsYnJbXptfiSAfe2f+1/XPlIYcZNo3m5imffgaIsrn9WlIYxOnP7rrZW3mQkPRLADElTAMWl7zDj71mZrenNBInTd70CBX/L7C4NABikPu1E7TxpASQRW9y/n5zdGR4TVww06nAEseCfwfzV1ToNK7CFwFWv/OdIARVVSqwCkCDrwP/pNYr7WjzXR939xBfuXaWNZpoDkN1Yxb5sk1NEYRT+cs/SD\n"
  }
}

親トピック: バックアップとリストアのコマンド

7.8 okv backup destination reset-host-keyコマンド

okv backup destination reset-host-keyコマンドでは、oracleユーザーのknown_hostsファイル内の宛先ホストの公開キーをリセットします。

必要な権限

システム管理者ロール

構文

okv backup destination reset-host-key --name destination_name

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "reset-host-key",
    "options" : {
      "name" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--name / name

必須

バックアップ先の名前。既存のバックアップ先の名前を調べるには、okv backup destination listコマンドを実行します。

JSONの例

  1. okv backup destination reset-host-keyコマンド用にJSON入力を生成します。 
    okv backup destination reset-host-key --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "destination",
    "action" : "reset-host-key",
    "options" : {
      "name" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、reset-host-key.json)に保存して、宛先サーバーのホスト・キーをリセットできるように編集します。 
    {
"service": {
      "category": "backup",
      "resource": "destination",
      "action": "reset-host-key",
      "options": {
            "name": "hr_backup"
      }
    }
}
  3. 生成されたJSONファイルを使用して、okv backup destination reset-host-keyコマンドを実行します。 
    okv backup destination reset-host-key --from-json reset-host-key.json

    出力は、次のようになります。 

    {
  "result" : "Success"
}

親トピック: バックアップとリストアのコマンド

7.9 okv backup history listコマンド

okv backup history listコマンドでは、ランタイム・エラー、バックアップが完了したかどうか、開始時刻と終了時刻など、バックアップ履歴の詳細をリストします。

必要な権限

システム管理者ロール

構文

okv backup history list --max number_of_backup_records

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "history",
    "action" : "list",
    "options" : {
      "max" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--max / max

必須

戻される最新の完全なバックアップ情報レコードの最大数

JSONの例

  1. okv backup history listコマンド用にJSON入力を生成します。 
    okv backup history list --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "history",
    "action" : "list",
    "options" : {
      "max" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、bkup-history-list.json)に保存して、バックアップ履歴のリストを生成できるように編集します。 
    {
  "service" : {
    "category" : "backup",
    "resource" : "history",
    "action" : "list",
    "options" : {
      "max" : "10"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv backup history listコマンドを実行します。 
    okv backup history list --from-json bkup-history-list.json

    出力は、次のようになります。 

    {
  "object" : [ {
    "backupTime" : "2020-11-30 03:59:36.43476 UTC",
    "destination" : "PROD_OKV_BACKUP_DEST",
    "interval" : "0:1:0",
    "lastFullBackupTime" : "2020-11-30 01:27:31.99856 UTC",
    "name" : "OKV_BACKUP_HOURLY",
    "runError" : " ",
    "runIndex" : "2",
    "scheduleTime" : "2020-11-30 01:09:56.179681 UTC",
    "startTime" : "2020-11-30 03:42:09.204637 UTC",
    "status" : "DONE",
    "type" : "PERIODIC"
  }, {
    "backupTime" : "2020-11-30 02:13:36.033108 UTC",
    "destination" : "LOCAL",
    "interval" : "0:0:0",
    "lastFullBackupTime" : "2020-11-30 02:13:36.033116 UTC",
    "name" : "LOCAL_BACKUP",
    "runError" : " ",
    "runIndex" : "1",
    "scheduleTime" : "2020-11-30 01:40:28.302189 UTC",
    "startTime" : "2020-11-30 02:00:02.1479 UTC",
    "status" : "DONE",
    "type" : "ONE-TIME"
  }, {
    "backupTime" : "2020-11-30 01:27:31.998552 UTC",
    "destination" : "PROD_OKV_BACKUP_DEST",
    "interval" : "0:1:0",
    "lastFullBackupTime" : "2020-11-30 01:27:31.99856 UTC",
    "name" : "OKV_BACKUP_HOURLY",
    "runError" : " ",
    "runIndex" : "1",
    "scheduleTime" : "2020-11-30 01:09:56.179681 UTC",
    "startTime" : "2020-11-30 01:10:00.145134 UTC",
    "status" : "DONE",
    "type" : "PERIODIC"
  } ]
}

親トピック: バックアップとリストアのコマンド

7.10 okv backup schedule createコマンド

okv backup schedule createコマンドでは、バックアップ・スケジュール・ジョブを作成します。

必要な権限

システム管理者ロール

構文

okv backup schedule create 
--name backup_schedule_name 
--start-time start_time 
--destination LOCAL|VALUE 
--type ONE-TIME|PERIODIC 
--interval timing

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "create",
    "options" : {
      "name" : "#VALUE",
      "startTime" : "NOW|#yyyy/MM/dd HH:mm:ss",
      "type" : "#ONE-TIME|PERIODIC",
      "destination" : "#LOCAL|VALUE",
      "interval" : {
        "days" : "#1-99",
        "hours" : "#1-23",
        "mins" : "#1-59"
      }
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--name / name

必須

バックアップ・スケジュール・ジョブの名前。既存のスケジュール済バックアップを調べるには、okv backup schedule listコマンドを実行します。

--start-time / startTime

必須

スケジュール済バックアップを開始する時刻。次のいずれかの値を入力します。

  • NOW
  • 次の形式を使用した特定の時刻: yyyy/MM/dd HH:mm:ss

--destination / destination

必須

バックアップ先のタイプまたは名前。次のいずれかの値を入力します。

  • LOCAL
  • リモートの宛先の場合は、その名前を入力します。既存の名前を調べるには、okv backup destination listコマンドを実行します。

--type / type

必須

次のいずれかの値を入力します。

  • ONE-TIME
  • PERIODIC

--interval / interval

定期バックアップの場合は必須

次の形式を使用して、バックアップ間隔の日数、時間数および分数を入力します。

DD:HH24:MI

JSONの例

  1. okv backup schedule createコマンド用にJSON入力を生成します。 
    okv backup schedule create --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "create",
    "options" : {
      "name" : "#VALUE",
      "startTime" : "NOW|#yyyy/MM/dd HH:mm:ss",
      "type" : "#ONE-TIME|PERIODIC",
      "destination" : "#LOCAL|VALUE",
      "interval" : {
        "days" : "#1-99",
        "hours" : "#1-23",
        "mins" : "#1-59"
      }
    }
  }
}
  2. 生成された入力をファイル(たとえば、bkup-sched-create.json)に保存して、バックアップ・スケジュールを作成できるように編集します。 
    {
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "create",
    "options" : {
      "name" : "okv_backup_hourly",
      "startTime" : "2020/11/30 01:10:00",
      "type" : "PERIODIC",
      "destination" : "prod_okv_backup_dest",
      "interval" : {
        "days" : "0",
        "hours" : "1",
        "mins" : "0"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv backup schedule createコマンドを実行します。 
    okv backup schedule create --from-json bkup-sched-create.json

    出力は、次のようになります。 

    {
  "result" : "Success"
}

親トピック: バックアップとリストアのコマンド

7.11 okv backup schedule deleteコマンド

okv backup schedule deleteコマンドでは、スケジュール済のバックアップ・ジョブを削除します。

必要な権限

システム管理者ロール

構文

okv backup schedule delete --name backup_schedule_name

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "delete",
    "options" : {
      "name" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--name / name

必須

バックアップ・スケジュール・ジョブの名前。既存のスケジュール済バックアップを調べるには、okv backup schedule listコマンドを実行します。削除しようとしているバックアップの詳細が必要な場合は、okv backup schedule getを実行します。

JSONの例

  1. okv backup schedule deleteコマンド用にJSON入力を生成します。 
    okv backup schedule delete --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "delete",
    "options" : {
      "name" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、bkup-sched-del.json)に保存して、バックアップ・スケジュールを削除できるように編集します。 
    {
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "delete",
    "options" : {
      "name" : "okv_backup_hourly"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv backup schedule deleteコマンドを実行します。 
    okv backup schedule delete --from-json bkup-sched-del.json

    出力は、次のようになります。 

    {
  "result" : "Success"
}

親トピック: バックアップとリストアのコマンド

7.12 okv backup schedule getコマンド

okv backup schedule getコマンドでは、スケジュール済のOracle Key Vaultサーバー・バックアップに関する詳細情報を取得します。

okv backup schedule getコマンドは、次の値を返します。

  • タイプ(たとえば、periodically @ 1 days 0 hrs 0 mins)
  • 宛先(たとえば、localやremote-dest)
  • 状態(ACTIVE、ONGOING、PAUSED、DONE)
  • 最終実行のエラー
  • スケジュール時刻
  • 開始時刻
  • 最終バックアップ時刻
  • 最終フル・バックアップ時刻
  • 実行回数(定期バックアップの場合)

必要な権限

システム管理者ロール

構文

okv backup schedule get --name backup_schedule_name

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "get",
    "options" : {
      "name" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--name / name

必須

バックアップ・スケジュール・ジョブの名前。既存のスケジュール済バックアップを調べるには、okv backup schedule listコマンドを実行します。

JSONの例

  1. okv backup schedule getコマンド用にJSON入力を生成します。 
    okv backup schedule get --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "get",
    "options" : {
      "name" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、bkup-sched-get.json)に保存して、バックアップ・スケジュールを取得できるように編集します。 
    {
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "get",
    "options" : {
      "name" : "okv_backup_hourly"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv backup schedule getコマンドを実行します。 
    okv backup schedule get --from-json bkup-sched-get.json

    出力は、次のようになります。 

    {
  "object" : [ {
    "backupTime" : "2020-11-30 01:27:31.998552 UTC",
    "destination" : "PROD_OKV_BACKUP_DEST",
    "interval" : "0:1:0",
    "lastFullBackupTime" : "2020-11-30 01:27:31.99856 UTC",
    "name" : "OKV_BACKUP_HOURLY",
    "runError" : " ",
    "runIndex" : "1",
    "scheduleTime" : "2020-11-30 01:09:56.179681 UTC",
    "startTime" : "2020-11-30 02:10:00.079746 UTC",
    "status" : "ACTIVE",
    "type" : "PERIODIC"
  } ]
}

親トピック: バックアップとリストアのコマンド

7.13 okv backup schedule listコマンド

okv backup schedule listコマンドでは、現在スケジュール済のOracle Key Vaultサーバー・バックアップのリストを表示します。

必要な権限

システム管理者ロール

構文

okv backup schedule list

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "list"
  }
}

パラメータ

なし

JSONの例

  1. okv backup schedule listコマンド用にJSON入力を生成します。 
    okv backup schedule list --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "list"
  }
}
  2. 生成された入力をファイル(たとえば、bkup-sched-list.json)に保存します。
  3. 生成されたJSONファイルを使用して、okv backup schedule listコマンドを実行します。 
    okv backup schedule list --from-json bkup-sched-list.json

    出力は、次のようになります。 

    {
  "result" : "Success",
  "value" : {
    "output" : "OKV_BACKUP_HOURLY, LOCAL_BACKUP"
  }
}

親トピック: バックアップとリストアのコマンド

7.14 okv backup schedule pauseコマンド

okv backup schedule pauseコマンドでは、スケジュール済のOracle Key Vaultサーバー・バックアップを一時停止します。

必要な権限

システム管理者ロール

構文

okv backup schedule pause --name backup_schedule_name

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "pause",
    "options" : {
      "name" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--name / name

必須

バックアップ・スケジュール・ジョブの名前。既存のスケジュール済バックアップを調べるには、okv backup schedule listコマンドを実行します。一時停止しようとしているバックアップの詳細が必要な場合は、okv backup schedule getを実行します。

JSONの例

  1. okv backup schedule pauseコマンド用にJSON入力を生成します。 
    okv backup schedule pause --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "pause",
    "options" : {
      "name" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、bkup-sched-pause.json)に保存して、バックアップ・スケジュールを一時停止できるように編集します。 
    {
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "pause",
    "options" : {
      "name" : "okv_backup_hourly"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv backup schedule pauseコマンドを実行します。 
    okv backup schedule pause --from-json bkup-sched-pause.json

    出力は、次のようになります。 

    {
  "result" : "Success"
}

親トピック: バックアップとリストアのコマンド

7.15 okv backup schedule resumeコマンド

okv backup schedule resumeコマンドでは、一時停止したOracle Key Vaultバックアップ・ジョブを再開します。

必要な権限

システム管理者ロール

構文

okv backup schedule resume --name backup_schedule_name

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "resume",
    "options" : {
      "name" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--name / name

必須

バックアップ・スケジュール・ジョブの名前。既存のスケジュール済バックアップを調べるには、okv backup schedule listコマンドを実行します。再開しようとしているバックアップの詳細が必要な場合は、okv backup schedule getを実行します。

JSONの例

  1. okv backup schedule resumeコマンド用にJSON入力を生成します。 
    okv backup schedule resume --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "resume",
    "options" : {
      "name" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、bkup-sched-resume.json)に保存して、一時停止したバックアップ・スケジュールを再開できるように編集します。 
    {
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "resume",
    "options" : {
      "name" : "okv_backup_hourly"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv backup schedule resumeコマンドを実行します。 
    okv backup schedule resume --from-json bkup-sched-resume.json

    出力は、次のようになります。 

    {
  "result" : "Success"
}

親トピック: バックアップとリストアのコマンド

7.16 okv backup schedule updateコマンド

okv backup schedule updateコマンドでは、現在スケジュール済のバックアップを更新します。

必要な権限

システム管理者ロール

構文

okv backup schedule update 
--name backup_schedule_name 
[--start-time start_time] 
[--interval timing]

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "update",
    "options" : {
      "name" : "#VALUE",
      "startTime" : "NOW|#yyyy/MM/dd HH:mm:ss",
      "interval" : {
        "days" : "#1-99",
        "hours" : "#1-23",
        "mins" : "#1-59"
      }
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--name / name

必須

バックアップ・スケジュール・ジョブの名前。既存のスケジュール済バックアップの名前を調べるには、okv backup schedule listコマンドを実行します。更新しようとしているバックアップの詳細を調べるには、okv backup schedule getを実行します。

--start-time / startTime

オプション

スケジュール済バックアップを開始する時刻。次のいずれかの値を入力します。

  • NOW
  • 次の形式を使用した特定の時刻: yyyy/MM/dd HH:mm:ss

--interval / interval

定期バックアップの場合は必須

次の形式を使用して、バックアップ間隔の日数、時間数および分数を入力します。

DD:HH24:MI

JSONの例

  1. okv backup schedule updateコマンド用にJSON入力を生成します。 
    okv backup schedule update --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "update",
    "options" : {
      "name" : "#VALUE",
      "startTime" : "NOW|#yyyy/MM/dd HH:mm:ss",
      "interval" : {
        "days" : "#1-99",
        "hours" : "#1-23",
        "mins" : "#1-59"
      }
    }
  }
}
  2. 生成された入力をファイル(たとえば、bkup-sched-update.json)に保存して、バックアップ・スケジュールを更新できるように編集します。 
    {
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "update",
    "options" : {
      "name" : "hr_backup",
      "startTime" : "12/20/2020 18:00:00",
      "interval" : {
        "days" : "0",
        "hours" : "12",
        "mins" : "0"
      }
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv backup schedule updateコマンドを実行します。 
    okv backup schedule update --from-json bkup-sched-update.json

    出力は、次のようになります。 

    {
  "result" : "Success"
}

親トピック: バックアップとリストアのコマンド

7.17 okv backup restore startコマンド

okv backup restore startコマンドでは、Oracle Key Vaultバックアップのリストア・プロセスを開始します。

このコマンドには、Oracle Key Vaultリカバリ・パスフレーズの使用が必要になります。

必要な権限

システム管理者ロール

リストア操作の開始後、okv backup restore statusコマンドを実行するとステータスを確認できます。

構文

okv backup restore start --name destination_name --destination backup_schedule_name

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "restore",
    "action" : "start",
    "options" : {
      "name" : "#VALUE",
      "destination" : "#VALUE"
    }
  }
}

パラメータ

パラメータ/テンプレート・パラメータ 必須かどうか 説明

--name / name

必須

バックアップ・スケジュール・ジョブの名前。既存のスケジュール済バックアップを調べるには、okv backup schedule listコマンドを実行します。

--destination / destination

必須

バックアップ先ジョブの名前。既存の名前のリストを表示するには、okv backup destination listコマンドを実行します。リストアしようとしているバックアップの詳細が必要な場合は、okv backup schedule getを実行します。

JSONの例

  1. okv backup restore startコマンド用にJSON入力を生成します。 
    okv backup restore start --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "restore",
    "action" : "start",
    "options" : {
      "name" : "#VALUE",
      "destination" : "#VALUE"
    }
  }
}
  2. 生成された入力をファイル(たとえば、bkup-restore-start.json)に保存して、バックアップ・スケジュールのリストアを開始できるように編集します。次の例では、passphraseが指定されていないため、ユーザーは対話形式で入力を求められます。 
    {
  "service" : {
    "category" : "backup",
    "resource" : "restore",
    "action" : "start",
    "options" : {
      "name" : "okv_backup_hourly",
      "destination" : "prod_okv_backup_dest"
    }
  }
}
  3. 生成されたJSONファイルを使用して、okv backup restore startコマンドを実行します。 
    okv backup restore start --from-json bkup-restore-start.json

    リカバリ・パスフレーズの入力を求められます。このパスフレーズは、リストアするバックアップの時点で有効だったパスフレーズにする必要があります。このパスフレーズを入力すると、次のような出力が表示されます。 

    {
  "result" : "Success"
}

親トピック: バックアップとリストアのコマンド

7.18 okv backup restore statusコマンド

okv backup restore statusコマンドでは、Oracle Key Vaultバックアップ・リストア操作のステータスを確認します。

必要な権限

システム管理者ロール

構文

okv backup restore status

JSON入力ファイル・テンプレート

{
  "service" : {
    "category" : "backup",
    "resource" : "restore",
    "action" : "status"
  }
}

パラメータ

なし

JSONの例

  1. okv backup restore statusコマンド用にJSON入力を生成します。 
    okv backup restore status --generate-json-input

    次のような入力が生成されます。 

    {
  "service" : {
    "category" : "backup",
    "resource" : "restore",
    "action" : "status"
  }
}
  2. 生成された入力をファイル(たとえば、bkup-restore-status.json)に保存します。
  3. 生成されたJSONファイルを使用して、okv backup restore statusコマンドを実行します。 
    okv backup restore status --from-json bkup-restore-status.json

    リストアの進行中は、次のような出力が表示されます。 

    {
  "result" : "Success",
  "values" : [ {
    "destination" : "LOCAL",
    "status" : "ONGOING",
    "time" : "2020-12-18 11:49:30.985194 UTC"
  } ]
}

    リストアが完了すると、次のような出力が表示されます。 

    {
  "result" : "Success",
  "values" : [ {
    "destination" : "LOCAL",
    "status" : "DONE",
    "time" : "2020-12-18 11:52:02.191868 UTC"
  } ]
}

親トピック: バックアップとリストアのコマンド