10 バックアップ、スケジュールおよびリストアのコマンド

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

10.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 
--authentication-method password|key-based
--destination-policy policy_name

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",
      "destinationPolicy" : "#VALUE"
    }
  }
}

パラメータ

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

--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アドレスの変更、クラスタ・ノードへの変換などが含まれますが、これらに限定されているわけではありません。

--destination-policy / destinationPolicy

オプション

バックアップ先ポリシーの名前を指定します。

既存のバックアップ先ポリシーを調べるには、okv backup destination-policy listコマンドを実行します。

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",
          "destinationPolicy" : "#VALUE"
        }
      }
    }
  2. 生成された入力をファイル(たとえば、bkup_srvr_dest_create.json)に保存し、それを編集してバックアップ・サーバーの宛先を作成します。
    {
      "service" : {
        "category" : "backup",
        "resource" : "destination",
        "action" : "create",
        "options" : {
          "name" : "prod_okv_backup_dest",
          "transferMethod" : "scp",
          "hostName" : "192.0.2.34",
          "port" : "22",
          "path" : "/opt/okv/backups",
          "userName" : "psmith",
          "authenticationMethod" : "password",
          "destinationPolicy" : "global_dest_pol"
        }
      }
    }
  3. 生成されたJSONファイルを使用して、okv backup destination createコマンドを実行します。
    okv backup destination create --from-json bkup_srvr_dest_create.json

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

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

10.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"
    }

10.3 okv backup destination delete-backupコマンド

okv backup destination delete-backupコマンドでは、ローカルのOracle Key Vaultバックアップを手動で削除できます。

必要な権限

システム管理者ロール

構文

okv backup destination delete-backup --destination backup_destination --backup-file backup_file_name

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

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

パラメータ

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

--destination / destination

必須

バックアップ先の名前を指定します。LOCALと入力します。

okv backup destination delete-backupコマンドでは、Oracle Key Vaultバックアップをそのバックアップ・ファイル名で削除します。これは、LOCAL宛先でのみサポートされています。

--backup-file / backupFile

必須

バックアップ・ファイルの名前を指定します。

既存のバックアップ・ファイル名を調べるには、okv backup destination list-backupsコマンドを実行します。

JSONの例

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

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

    {
      "service" : {
         "category" : "backup",
         "resource" : "destination",
          "action" : "delete-backup",
         "options" : {
           "backupFile" : "#VALUE",
           "destination" : "#VALUE"
          }
       }
    }
  2. 生成された入力をファイル(たとえば、backup_local_del.json)に保存し、それを編集して、バックアップ・ファイル名およびバックアップ先名(つまり、local)を指定します。
    {
      "service" : {
         "category" : "backup",
         "resource" : "destination",
          "action" : "delete-backup",
         "options" : {
            "backupFile" : "okvbackup_onetime_onetime_20210118175804",
            "destination" : "local"
          }
       }
    }
  3. 生成されたJSONファイルを使用して、okv backup destination delete-backupコマンドを実行します。
    okv backup destination delete-backup --from-json backup_local_del.json

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

    {
      "result" : "Success"
    }

10.4 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

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

    {
      "result" : "Success",
      "value" : {
        "authenticationMethod" : "Password",
        "hostName" : "192.0.2.34",
        "name" : "PROD_OKV_BACKUP_DEST",
        "path" : "/opt/okv/backups",
        "policyName" : "GLOBAL_DEST_POL",
        "policyState" : "Active",
        "port" : "22",
        "transferMethod" : "scp",
        "userName" : "psmith"
      }
    }

10.5 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_list.json)に保存します。
  3. 生成されたJSONファイルを使用して、okv backup destination listコマンドを実行します。
    okv backup destination list --from-json bkup_srvr_dest_list.json

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

    {
      "result" : "Success",
      "destinations" : [
        {
          "authenticationMethod" : " ",
          "hostName" : "localhost",
          "name" : "LOCAL",
          "path" : "-",
          "transferMethod" : "-",
          "userName" : "-"
        },
        {
          "authenticationMethod" : "Password",
          "hostName" : "192.0.2.34",
          "name" : "PROD_OKV_BACKUP_DEST",
          "path" : "/opt/okv/backups",
          "port" : "22",
          "transferMethod" : "scp",
          "userName" : "psmith"
        }
      ]
    }

10.6 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

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

    {
      "result" : "Success",
      "backups" : [
        {
          "file" : "okvbackup_periodic_incr_20211030162206",
          "time" : "2021-10-30 16:22:06",
          "type" : "Periodic"
        }, {
          "file" : "okvbackup_periodic_full_20211029162206",
          "time" : "2021-10-29 16:22:06",
          "type" : "Periodic"
        }, {
          "file" : "okvbackup_onetime_onetime_20211028012206",
          "time" : "2021-10-28 01:22:06",
          "type" : "One-Time"
        }
      ]
    }

10.7 okv backup destination-policy createコマンド

okv backup destination-policy createコマンドでは、バックアップ先ポリシーを作成します。

必要な権限

システム管理者ロール

構文

okv backup destination-policy create --destination-policy policy_name --recent-backups-to-preserve number_of_recent_backups_to_preserve --purge-backup-after number_of_days_after_which_backup_purged

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

{
  "service" : {
     "category" : "backup",
     "resource" : "destination-policy",
      "action" : "create",
     "options" : {
       "destinationPolicy" : "#VALUE",
       "recentBackupsToPreserve" : "#VALUE", 
       "purgeBackupAfter" :  "#VALUE"
      }
   }
}

パラメータ

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

--destination-policy / destinationPolicy

必須

作成するバックアップ先ポリシーの名前を指定します。

既存のバックアップ先ポリシーを調べるには、okv backup destination-policy listコマンドを実行します。

--recent-backups-to-preserve / recentBackupsToPreserve

オプション

保持する最新のバックアップの数。1から999までの値を入力します。たとえば、最新の15個のバックアップを保持するには、この値に15を指定します。デフォルト設定は、10です。

--purge-backup-after / purgeBackupAfter

オプション

バックアップをパージできるまでの日数を指定します。1から999までの値を入力します。たとえば、値を45にすると、45日より古いバックアップがパージされます。ただし、この日数よりも古いバックアップを使用できることがあります。バックアップは、--purge-backup-after / purgeBackupAfterパラメータで指定された日数よりも古くなり、--recent-backups-to-preserve / recentBackupsToPreserveパラメータで指定されたバックアップ数よりも多くのバックアップが残っている場合にパージされるためです。デフォルト設定は、30です。

この値は、ISO 8601標準を使用して入力します。たとえば、25日を指定するにはP25Dと入力します。

JSONの例

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

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

    {
      "service" : {
         "category" : "backup",
         "resource" : "destination-policy",
          "action" : "create",
         "options" : {
           "destinationPolicy" : "#VALUE",
           "recentBackupsToPreserve" : "#VALUE", 
           "purgeBackupAfter" :  "#VALUE"
          }
       }
    }
  2. 生成された入力をファイル(たとえば、backup_dest_policy_create.json)に保存し、それを編集してバックアップ先ポリシーを作成します。
    {
      "service" : {
         "category" : "backup",
         "resource" : "destination-policy",
          "action" : "create",
         "options" : {
           "destinationPolicy" : "global_dest_pol",
           "recentBackupsToPreserve" : "15",
           "purgeBackupAfter" : "P45D"
          }
       }
    }
  3. 生成されたJSONファイルを使用して、okv backup destination-policy createコマンドを実行します。
    okv backup destination-policy create --from-json backup_dest_policy_create.json

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

    {
      "result" : "Success"
    }

10.8 okv backup destination-policy deleteコマンド

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

必要な権限

システム管理者ロール

構文

okv backup destination-policy delete --destination_policy policy_name

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

{
  "service" : {
     "category" : "backup",
     "resource" : "destination-policy",
     "action" : "delete",
     "options" : {
       "destinationPolicy" : "#VALUE"
      }
   }
}

パラメータ

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

--destination-policy / destinationPolicy

必須

削除するバックアップ先ポリシーの名前を指定します。

既存のバックアップ先ポリシーを調べるには、okv backup destination-policy listコマンドを実行します。

JSONの例

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

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

    {
      "service" : {
         "category" : "backup",
         "resource" : "destination-policy",
         "action" : "delete",
         "options" : {
           "destinationPolicy" : "#VALUE"
          }
       }
    }
  2. 生成された入力をファイル(たとえば、backup_dest_policy_delete.json)に保存し、それを編集して、削除するバックアップ先ポリシーを指定します。
    {
      "service" : {
         "category" : "backup",
         "resource" : "destination-policy",
         "action" : "delete",
         "options" : {
           "destinationPolicy" : "global_dest_pol"
          }
       }
    }
  3. 生成されたJSONファイルを使用して、okv backup destination-policy deleteコマンドを実行します。
    okv backup destination-policy delete --from-json backup_dest_policy_delete.json

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

    {
      "result" : "Success"
    }

10.9 okv backup destination-policy getコマンド

okv backup destination-policy getコマンドでは、バックアップ先ポリシーに関する詳細情報を取得します。

必要な権限

システム管理者ロール

構文

okv backup destination-policy get --destination-policy policy_name 

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

{
  "service" : {
     "category" : "backup",
     "resource" : "destination-policy",
     "action" : "get",
     "options" : {
       "destinationPolicy" : "#VALUE"
      }
   }
}

パラメータ

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

--destination-policy / destinationPolicy

必須

取得するバックアップ先ポリシーの名前を指定します。

既存のバックアップ先ポリシーを調べるには、okv backup destination-policy listコマンドを実行します。

JSONの例

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

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

    {
      "service" : {
         "category" : "backup",
         "resource" : "destination-policy",
         "action" : "get",
         "options" : {
           "destinationPolicy" : "#VALUE"
          }
       }
    }
  2. 生成された入力をファイル(たとえば、backup_dest_policy_get.json)に保存し、それを編集してバックアップ先ポリシーを取得します。
    {
      "service" : {
         "category" : "backup",
         "resource" : "destination-policy",
         "action" : "get",
         "options" : {
           "destinationPolicy" : "global_dest_pol"
          }
       }
    }
  3. 生成されたJSONファイルを使用して、okv backup destination-policy getコマンドを実行します。
    okv backup destination-policy get --from-json backup_dest_policy_get.json

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

    {
      "result" : "Success",
      "value" : {
        "destinationPolicy" : "GLOBAL_DEST_POL",
        "purgeBackupAfter" : "P45D",
        "recentBackupsToPreserve" : "15"
      }
    }

10.10 okv backup destination-policy listコマンド

okv backup destination-policy listコマンドでは、既存のバックアップ先ポリシーとその設定をリストします。

必要な権限

システム管理者ロール

構文

okv backup destination-policy list

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

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

パラメータ

パラメータなし

JSONの例

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

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

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

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

    {
      "result" : "Success",
      "value" : {
        "destinationPolicies" : [
          {
            "destinationPolicy" : "GLOBAL_DEST_POL",
            "recentBackupsToPreserve" : "15",
            "purgeBackupAfter" : "P45D"
          }, {
            "destinationPolicy" : "RAC_DEST_POL",
            "recentBackupsToPreserve" : "5",
            "purgeBackupAfter" : "P60D"
          }
        ],
        "fetchedDestinationPolicyCount" : "2"
      }
    }

10.11 okv backup destination-policy list-purged-backupsコマンド

okv backup destination-policy list-purged-backupsコマンドでは、バックアップ先ポリシーによってパージされたバックアップをリストします。

必要な権限

システム管理者ロール

構文

okv backup destination-policy list-purged-backups --destination-policy policy_name --destination destination_name

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

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

パラメータ

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

--destination-policy / destinationPolicy

必須

パージされたバックアップをリストするバックアップ先ポリシーの名前を指定します。

既存のバックアップ先ポリシーを調べるには、okv backup destination-policy listコマンドを実行します。

--destination / destination

オプション

リモート・バックアップ先の名前。既存のバックアップ先の名前を調べるには、okv backup destination listコマンドを実行します。この設定を省略すると、指定したバックアップ先ポリシーによってパージされた、すべてのバックアップ先のバックアップがリストされます。

JSONの例

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

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

    {
      "service" : {
         "category" : "backup",
         "resource" : "destination-policy",
         "action" : "list-purged-backups",
         "options" : {
           "destinationPolicy" : "#VALUE",
           "destination" : "#VALUE"
          }
       }
    }
  2. 生成された入力をファイル(たとえば、backup_dest_policy_list_purged.json)に保存し、それを編集して、バックアップ先ポリシー名およびバックアップ先名を含めます。
    {
      "service" : {
         "category" : "backup",
         "resource" : "destination-policy",
         "action" : "list-purged-backups",
         "options" : {
           "destinationPolicy" : "global_dest_pol",
           "destination" : "prod_okv_backup_dest"
          }
       }
    }
  3. 生成されたJSONファイルを使用して、okv backup destination-policy list-purged-backupsコマンドを実行します。
    okv backup destination-policy list-purged-backups --from-json backup_dest_policy_list_purged.json

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

    {
      "result" : "Success",
      "value" : {
        "fetchedPurgedBackupCount" : "2",
        "purgedBackups" : [
          {
            "backupFile" : "okvbackup_periodic_incr_20211030162206",
            "status" : "Purged",
            "purgeTime" : "2021-12-14 19:15:06",
            "destination" : "PROD_OKV_BACKUP_DEST",
            "hostName" : "192.0.2.34",
            "port" : "22",
            "userName" : "psmith",
            "path" : "/opt/okv/backups"
          }, {
            "backupFile" : "okvbackup_onetime_onetime_20211028012206",
            "status" : "Unknown",
            "purgeTime" : "2021-12-12 17:38:06",
            "destination" : "PROD_OKV_BACKUP_DEST",
            "hostName" : "192.0.2.34",
            "port" : "22",
            "userName" : "psmith",
            "path" : "/opt/okv/backups"
          }
        ]
      }
    }

10.12 okv backup destination-policy updateコマンド

okv backup destination-policy updateコマンドでは、バックアップ先ポリシーを更新します。

必要な権限

システム管理者ロール

構文

okv backup destination-policy update --destination-policy policy_name --recent-backups-to-preserve number_of_recent_backups_to_preserve --purge-backup-after number_of_days_after_which_backup_purged

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

{
  "service" : {
     "category" : "backup",
     "resource" : "destination-policy",
     "action" : "update",
     "options" : {
       "destinationPolicy" : "#VALUE",
       "recentBackupsToPreserve" : "#VALUE",
       "purgeBackupAfter" :  "#VALUE"
      }
   }
}

パラメータ

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

--destination-policy / destinationPolicy

必須

更新するバックアップ先ポリシーの名前を指定します。

既存のバックアップ先ポリシーを調べるには、okv backup destination-policy listコマンドを実行します。

--recent-backups-to-preserve / recentBackupsToPreserve

オプション

保持する最新のバックアップの数。1から999までの値を入力します。たとえば、最新の15個のバックアップを保持するには、この値に15を指定します。デフォルト設定は、10です。

--purge-backup-after / purgeBackupAfter

オプション

バックアップをパージできるまでの日数を指定します。1から999までの値を入力します。たとえば、値を45にすると、45日より古いバックアップがパージされます。ただし、この日数よりも古いバックアップを使用できることがあります。バックアップは、--purge-backup-after / purgeBackupAfterパラメータで指定された日数よりも古くなり、--recent-backups-to-preserve / recentBackupsToPreserveパラメータで指定されたバックアップ数よりも多くのバックアップが残っている場合にパージされるためです。デフォルト設定は、30です。

この値は、ISO 8601標準を使用して入力します。たとえば、25日を指定するにはP25Dと入力します。

JSONの例

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

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

    {
      "service" : {
         "category" : "backup",
         "resource" : "destination-policy",
         "action" : "update",
         "options" : {
           "destinationPolicy" : "#VALUE",
           "recentBackupsToPreserve" : "#VALUE",
           "purgeBackupAfter" :  "#VALUE"
          }
       }
    }
  2. 生成された入力をファイル(たとえば、backup_dest_policy_update.json)に保存し、それを編集してバックアップ先ポリシーを更新します。
    {
      "service" : {
         "category" : "backup",
         "resource" : "destination-policy",
         "action" : "update",
         "options" : {
           "destinationPolicy" : "global_dest_pol",
           "recentBackupsToPreserve" : "20",
           "purgeBackupAfter" : "P60D"
          }
       }
    }
  3. 生成されたJSONファイルを使用して、okv backup destination-policy updateコマンドを実行します。
    okv backup destination-policy update --from-json backup_dest_policy_update.json

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

    {
      "result" : "Success"
    }

10.13 okv backup destination resume-policyコマンド

okv backup destination resume-policyコマンドでは、指定したバックアップ先に関連付けられたバックアップ先ポリシーの操作を再開します。

必要な権限

システム管理者ロール

構文

okv backup destination resume-policy --destination destination_name

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

{
  "service" : {
     "category" : "backup",
     "resource" : "destination",
     "action" : "resume-policy",
     "options" : {
       "destination" : "#VALUE"
      }
   }
}

パラメータ

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

--destination / destination

必須

バックアップ先の名前を指定します。

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

JSONの例

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

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

    {
      "service" : {
         "category" : "backup",
         "resource" : "destination",
         "action" : "resume-policy",
         "options" : {
           "destination" : "#VALUE"
          }
       }
    }
  2. 生成された入力をファイル(たとえば、backup_dest_pol_resume.json)に保存し、それを編集して、再開するバックアップ先ポリシーを指定します。
    {
      "service" : {
         "category" : "backup",
         "resource" : "destination",
         "action" : "resume-policy",
         "options" : {
           "destination" : "prod_okv_backup_dest"
          }
       }
    }
  3. 生成されたJSONファイルを使用して、okv backup destination resume-policyコマンドを実行します。
    okv backup destination resume-policy --from-json backup_dest_pol_resume.json

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

    {
      "result" : "Success"
    }

10.14 okv backup destination suspend-policyコマンド

okv backup destination suspend-policyコマンドでは、指定したバックアップ先に関連付けられたバックアップ先ポリシーの操作を一時停止します。

必要な権限

システム管理者ロール

構文

okv backup destination suspend-policy --destination destination_name

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

{
  "service" : {
     "category" : "backup",
     "resource" : "destination",
     "action" : "suspend-policy",
     "options" : {
       "destination" : "#VALUE"
      }
   }
}

パラメータ

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

--destination / destination

必須

バックアップ先の名前。

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

JSONの例

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

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

    {
      "service" : {
         "category" : "backup",
         "resource" : "destination",
         "action" : "suspend-policy",
         "options" : {
           "destination" : "#VALUE"
          }
       }
    }
  2. 生成された入力をファイル(たとえば、backup_dest_pol_suspend.json)に保存し、それを編集して、一時停止するバックアップ先ポリシーを指定します。
    {
      "service" : {
         "category" : "backup",
         "resource" : "destination",
         "action" : "suspend-policy",
         "options" : {
           "destination" : "prod_okv_backup_dest"
          }
       }
    }
  3. 生成されたJSONファイルを使用して、okv backup destination suspend-policyコマンドを実行します。
    okv backup destination suspend-policy --from-json backup_dest_pol_suspend.json

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

    {
      "result" : "Success"
    }

10.15 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
--destination-policy destination_policy_name

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

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

パラメータ

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

--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アドレスの変更、クラスタ・ノードへの変換などが含まれますが、これらに限定されているわけではありません。

--destination-policy / destinationPolicy

オプション

バックアップ先ポリシーを指定します。

既存のバックアップ先ポリシーを調べるには、okv backup destination-policy listコマンドを実行します。

  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",
          "destinationPolicy" : "#VALUE"
        }
      }
    }
  2. 生成された入力をファイル(たとえば、update_bkup_srvr_dest.json)に保存し、それを編集してバックアップ・サーバーの宛先を更新します。
    {
      "service" : {
        "category" : "backup",
        "resource" : "destination",
        "action" : "update",
        "options" : {
          "name" : "prod_okv_backup_dest",
          "port" : "22",
          "userName" : "psmith",
          "authenticationMethod" : "password",
          "destinationPolicy" : "rac_dest_pol"
        }
      }
    }
  3. 生成されたJSONファイルを使用して、okv backup destination updateコマンドを実行します。
    okv backup destination update --from-json update_bkup_srvr_dest.json

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

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

10.16 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" : {
        "object" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDRLparTgrf5F2IExZ1IMZecobMw2ptj5WWlr6l2ww9GHZ5YgMiTNBCiAjr68KgLgJ9eRkOSSz7tsnYzcw8th45abB344LzMBLREqtqbV4U0PYHMmt1ovhd+djhsYnJbXptfiSAfe2f+1/XPlIYcZNo3m5imffgaIsrn9WlIYxOnP7rrZW3mQkPRLADElTAMWl7zDj71mZrenNBInTd70CBX/L7C4NABikPu1E7TxpASQRW9y/n5zdGR4TVww06nAEseCfwfzV1ToNK7CFwFWv/OdIARVVSqwCkCDrwP/pNYr7WjzXR939xBfuXaWNZpoDkN1Yxb5sk1NEYRT+cs/SD\n"
      }
    }

10.17 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" : "prod_okv_backup_dest"
        }
      }
    }
  3. 生成されたJSONファイルを使用して、okv backup destination reset-host-keyコマンドを実行します。
    okv backup destination reset-host-key --from-json reset_host_key.json

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

    {
      "result" : "Success"
    }

10.18 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",
      "name" : "#VALUE",
      "type" : "#ONE-TIME|PERIODIC",
      "destination" : "#LOCAL|VALUE"
    }
  }
}

パラメータ

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

--max / max

必須

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

--type / type

オプション

エンドポイント・プラットフォーム。使用可能な値は次のとおりです。

  • ONE-TIME
  • PERIODIC

カンマ区切り値の組合せを指定することもできます。フィルタは各値に個別に適用され、返される結合された結果では、OR演算が効果的にサポートされます。

--destination /destination

オプション

バックアップ先名。

複数のバックアップ先名の値をカンマ区切りで指定することもできます。フィルタは各バックアップ先名に個別に適用され、返される結合された結果では、OR演算が効果的にサポートされます。

--name / name

オプション

バックアップ名。

複数のバックアップ先名をカンマで区切って指定することもできます。フィルタは各バックアップ先名に個別に適用され、返される結合された結果では、OR演算が効果的にサポートされます。

JSONの例

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

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

    {
      "service" : {
        "category" : "backup",
        "resource" : "history",
        "action" : "list",
        "options" : {
          "max" : "#VALUE",
          "name" : "#VALUE",
          "type" : "#ONE-TIME|PERIODIC",
          "destination" : "#LOCAL|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

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

    {
      "result" : Success",
      "backups": [
        {
          "backupTime": "2020-11-30 03:59:36",
          "destination": "PROD_OKV_BACKUP_DEST",
          "interval": "0:1:0",
          "lastFullBackupTime": "2020-11-30 01:27:31",
          "name": "OKV_BACKUP_HOURLY",
          "runError": " ",
          "runIndex": "2",
          "scheduleTime": "2020-11-30 01:09:56",
          "startTime": "2020-11-30 03:42:09",
          "status": "DONE",
          "type": "PERIODIC"
        },
        {
          "backupTime": "2020-11-30 02:13:36",
          "destination": "LOCAL",
          "interval": "0:0:0",
          "lastFullBackupTime": "2020-11-30 02:13:36",
          "name": "LOCAL_BACKUP",
          "runError": " ",
          "runIndex": "1",
          "scheduleTime": "2020-11-30 01:40:28",
          "startTime": "2020-11-30 02:00:02",
          "status": "DONE",
          "type": "ONE-TIME"
        },
        {
          "backupTime": "2020-11-30 01:27:31",
          "destination": "PROD_OKV_BACKUP_DEST",
          "interval": "0:1:0",
          "lastFullBackupTime": "2020-11-30 01:27:31",
          "name": "OKV_BACKUP_HOURLY",
          "runError": " ",
          "runIndex": "1",
          "scheduleTime": "2020-11-30 01:09:56",
          "startTime": "2020-11-30 01:10:00",
          "status": "DONE",
          "type": "PERIODIC"
        }
      ]
    }

10.19 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" : "#VALUE",
      "type" : "#ONE-TIME|PERIODIC",
      "destination" : "#LOCAL|VALUE",
      "interval" : {
        "days" : "#0-99",
        "hours" : "#0-23",
        "mins" : "#0-59"
      }
    }
  }
}

パラメータ

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

--name / name

必須

バックアップ・スケジュール・ジョブの名前。

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

--start-time / startTime

必須

スケジュール済バックアップを開始する時刻。

日付と時間を設定するには、様々な方法を使用できます。次に各例を示します。

"startTime" : "now" --starts immediately
"startTime" : "now+PT10M" --starts 10 minutes from now
"startTime" : "2021-12-20 10:30:00" --starts at this date and time
"startTime" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time

UTC書式で時間を表示するには、Linuxのdateコマンドを使用します。たとえば:

$ date --utc "+%F %T"
2021-03-15 20:31:37

--destination / destination

必須

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

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

--type / type

オプション

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

  • PERIODIC

デフォルト値は次のとおりです。

  • ONE-TIME

--interval / interval

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

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

days:hours:minutes

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" : "#VALUE",
          "type" : "#ONE-TIME|PERIODIC",
          "destination" : "#LOCAL|VALUE",
          "interval" : {
            "days" : "#0-99",
            "hours" : "#0-23",
            "mins" : "#0-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"
    }

10.20 okv backup schedule getコマンド

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

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

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

必要な権限

システム管理者ロール

構文

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

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

    {
      "result" : "Success",
      "value" : {
        "destination" : "PROD_OKV_BACKUP_DEST",
        "interval" : "0:1:0",
        "name" : "OKV_BACKUP_HOURLY",
        "runIndex" : "0",
        "scheduleTime" : "2021-01-16 18:37:15",
        "startTime" : "2021-03-31 18:36:00",
        "status" : "ACTIVE",
        "type" : "PERIODIC"
      }
    }

10.21 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.json

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

    {
      "result" : "Success",
      "value" : {
        "schedules" : [
          "OKV_BACKUP_HOURLY",
          "LOCAL_BACKUP"
        ]
      }
    }

10.22 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"
    }

10.23 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"
    }

10.24 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"
    }

10.25 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" : "#VALUE",
      "interval" : {
        "days" : "#0-99",
        "hours" : "#0-23",
        "mins" : "#0-59"
      }
    }
  }
}

パラメータ

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

--name / name

必須

バックアップ・スケジュール・ジョブの名前。

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

--start-time / startTime

オプション

スケジュール済バックアップを開始する時刻。

日付と時間を設定するには、様々な方法を使用できます。次に各例を示します。

"startTime" : "now" --starts immediately
"startTime" : "now+PT10M" --starts 10 minutes from now
"startTime" : "2021-12-20 10:30:00" --starts at this date and time
"startTime" : "2021-12-20 10:30:00+PT10M" --starts 10 minutes after this date and time

UTC書式で時間を表示するには、Linuxのdateコマンドを使用します。たとえば:

$ date --utc "+%F %T"
2021-03-15 20:31:37

--interval / interval

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

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

days:hours:minutes

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" : "#VALUE",
          "interval" : {
            "days" : "#0-99",
            "hours" : "#0-23",
            "mins" : "#0-59"
          }
        }
      }
    }
  2. 生成された入力をファイル(たとえば、bkup_sched_update.json)に保存し、それを編集してバックアップ・スケジュールを更新します。
    {
      "service" : {
        "category" : "backup",
        "resource" : "schedule",
        "action" : "update",
        "options" : {
          "name" : "okv_backup_hourly",
          "startTime" : "2020-12-20 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"
    }

10.26 okv backup restore startコマンド

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

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

必要な権限

システム管理者ロール

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

構文

okv backup restore start --name backup_file_name --destination destination_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コマンドを実行します。

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" : "okvbackup_onetime_onetime_20210118175804",
          "destination" : "prod_okv_backup_dest"
        }
      }
    }
  3. 生成されたJSONファイルを使用して、okv backup restore startコマンドを実行します。
    okv backup restore start --from-json bkup_restore_start.json

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

    {
      "result" : "Success"
    }

10.27 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",
      "value" : 
        {
          "destination" : "LOCAL",
          "status" : "ONGOING",
          "time" : "2020-12-18 11:49:30"
        }
    }

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

    {
      "result" : "Success",
      "value" : 
        {
          "destination" : "LOCAL",
          "status" : "DONE",
          "time" : "2020-12-18 11:52:02"
        }
    }