Required Authorization

System Administrator role

Syntax

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
--destination-policy policy_name

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup destination create command.

   okv backup destination create --generate-json-input

   The generated input appears as follows:

   {
     "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. Save the generated input to a file (for example, bkup_srvr_dest_create.json) and then edit it to create the backup server destination.

   {
     "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. Run the okv backup destination create command using the generated JSON file.

   okv backup destination create --from-json bkup_srvr_dest_create.json

   If you specified password for the user authentication method, then you will be prompted for the password. After entering the correct password, output similar to the following appears:

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

Required Authorization

System Administrator role

Syntax

okv backup destination delete --name destination_name

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup destination delete command.

   okv backup destination delete --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, bkup_srvr_dest_del.json) and then edit it to delete the backup server destination.

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

3. Run the okv backup destination delete command using the generated JSON file.

   okv backup destination delete --from-json bkup_srvr_dest_del.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

Required Authorization

System Administrator role

Syntax

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

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup destination delete-backup command.

   okv backup destination delete-backup --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, backup_local_del.json) and then edit it to specify the backup file name and backup destination name (that is, local).

   {
     "service" : {
        "category" : "backup",
        "resource" : "destination",
         "action" : "delete-backup",
        "options" : {
           "backupFile" : "okvbackup_onetime_onetime_20210118175804",
           "destination" : "local"
         }
      }
   }

3. Run the okv backup destination delete-backup command using the generated JSON file.

   okv backup destination delete-backup --from-json backup_local_del.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

Required Authorization

System Administrator role

Syntax

okv backup destination get --name backup_destination_name

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup destination get command.

   okv backup destination get --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, bkup_srvr_dest_get.json) and then edit it to retrieve the backup server destination.

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

3. Run the okv backup destination get command using the generated JSON file.

   okv backup destination get --from-json bkup_srvr_dest_get.json

   Output similar to the following appears:

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

Required Authorization

System Administrator role

Syntax

okv backup destination list

JSON Input File Template

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

Parameters

None

JSON Example

1. Generate JSON input for the okv backup destination list command.

   okv backup destination list --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, bkup_srvr_dest_list.json).
3. Run the okv backup destination list command using the generated JSON file.

   okv backup destination list --from-json bkup_srvr_dest_list.json

   Output similar to the following appears:

   {
     "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"
       }
     ]
   }

Required Authorization

System Administrator role

Syntax

okv backup destination list-backups --name destination_name

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup destination list-backups command.

   okv backup destination list-backups --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, dest_list_backups.json) and then edit it to list the backup server destinations.

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

3. Run the okv backup destination list-backups command using the generated JSON file.

   okv backup destination list-backups --from-json dest_list_backups.json

   Output similar to the following appears:

   {
     "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"
       }
     ]
   }

Required Authorization

System Administrator role

Syntax

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 Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup destination-policy create command.

   okv backup destination-policy create --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, backup_dest_policy_create.json) and then edit it to create the backup destination policy.

   {
     "service" : {
        "category" : "backup",
        "resource" : "destination-policy",
         "action" : "create",
        "options" : {
          "destinationPolicy" : "global_dest_pol",
          "recentBackupsToPreserve" : "15",
          "purgeBackupAfter" : "P45D"
         }
      }
   }

3. Run the okv backup destination-policy create command using the generated JSON file.

   okv backup destination-policy create --from-json backup_dest_policy_create.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

Required Authorization

System Administrator role

Syntax

okv backup destination-policy delete --destination_policy policy_name

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup destination-policy delete command.

   okv backup destination-policy delete --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, backup_dest_policy_delete.json) and then edit it to specify the backup destination policy to delete.

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

3. Run the okv backup destination-policy delete command using the generated JSON file.

   okv backup destination-policy delete --from-json backup_dest_policy_delete.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

Required Authorization

System Administrator role

Syntax

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

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup destination-policy get command.

   okv backup destination-policy get --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, backup_dest_policy_get.json) and then edit it to retrieve the backup destination policy.

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

3. Run the okv backup destination-policy get command using the generated JSON file.

   okv backup destination-policy get --from-json backup_dest_policy_get.json

   Output similar to the following appears:

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

Required Authorization

System Administrator role

Syntax

okv backup destination-policy list

JSON Input File Template

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

Parameters

No parameters

JSON Example

1. Generate JSON input for the okv backup destination-policy list command.

   okv backup destination-policy list --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, backup_dest_policy_list.json).
3. Run the okv backup destination-policy list command using the generated JSON file.

   okv backup destination-policy list --from-json backup_dest_policy_list.json

   Output similar to the following appears:

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

Required Authorization

System Administrator role

Syntax

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

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup destination-policy list-purged-backups command.

   okv backup destination-policy list-purged-backups --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, backup_dest_policy_list_purged.json) and then edit it to include the backup destination policy name and backup destination name.

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

3. Run the okv backup destination-policy list-purged-backups command using the generated JSON file.

   okv backup destination-policy list-purged-backups --from-json backup_dest_policy_list_purged.json

   Output similar to the following appears:

   {
     "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"
         }
       ]
     }
   }

Required Authorization

System Administrator role

Syntax

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 Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup destination-policy update command.

   okv backup destination-policy update --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, backup_dest_policy_update.json) and then edit it to update the backup destination policy.

   {
     "service" : {
        "category" : "backup",
        "resource" : "destination-policy",
        "action" : "update",
        "options" : {
          "destinationPolicy" : "global_dest_pol",
          "recentBackupsToPreserve" : "20",
          "purgeBackupAfter" : "P60D"
         }
      }
   }

3. Run the okv backup destination-policy update command using the generated JSON file.

   okv backup destination-policy update --from-json backup_dest_policy_update.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

Required Authorization

System Administrator role

Syntax

okv backup destination resume-policy --destination destination_name

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup destination resume-policy command.

   okv backup destination resume-policy --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, backup_dest_pol_resume.json) and then edit it to specify the backup destination policy to resume.

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

3. Run the okv backup destination resume-policy command using the generated JSON file.

   okv backup destination resume-policy --from-json backup_dest_pol_resume.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

Required Authorization

System Administrator role

Syntax

okv backup destination suspend-policy --destination destination_name

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup destination suspend-policy command.

   okv backup destination suspend-policy --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, backup_dest_pol_suspend.json) and then edit it to specify the backup destination policy to suspend.

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

3. Run the okv backup destination suspend-policy command using the generated JSON file.

   okv backup destination suspend-policy --from-json backup_dest_pol_suspend.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

Required Authorization

System Administrator role

Syntax

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

JSON Input File Template

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

Parameters

Example

1. Generate JSON input for the okv backup destination update command.

   okv backup destination update --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, update_bkup_srvr_dest.json) and then edit it to update the backup server destination.

   {
     "service" : {
       "category" : "backup",
       "resource" : "destination",
       "action" : "update",
       "options" : {
         "name" : "prod_okv_backup_dest",
         "port" : "22",
         "userName" : "psmith",
         "authenticationMethod" : "password",
         "destinationPolicy" : "rac_dest_pol"
       }
     }
   }

3. Run the okv backup destination update command using the generated JSON file.

   okv backup destination update --from-json update_bkup_srvr_dest.json

   If you specified password for the user authentication method, then you will be prompted for the password. After entering the correct password, output similar to the following appears

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

Copy the public key from the output of this command and paste it in the appropriate configuration file, such as authorized_keys of the backup destination user account, on the backup destination server. Check that the permissions of the configuration file are set to allow access only to the backup user account and to no other group or user. Be aware that certain events may trigger a change of the public key, which means that Oracle Key Vault cannot use the backup destination until the new public key is re-copied from Oracle Key Vault to the appropriate configuration file. These events include but are not limited to certificate rotation, changing the IP address, and conversion to a cluster node.

Required Authorization

System Administrator role

Syntax

okv backup destination get-public-key

JSON Input File Template

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

Parameters

None

JSON Example

1. Generate JSON input for the okv backup destination get-public-key

   okv backup destination get-public-key --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, bkup_dest_get_public_key.json).
3. Run the okv backup destination get-public-key command using the generated JSON file.

   okv backup destination get-public-key --from-json bkup_dest_get_public_key.json

   Output similar to the following appears:

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

Required Authorization

System Administrator role

Syntax

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

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup destination reset-host-key command.

   okv backup destination reset-host-key --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, reset_host_key.json) and then edit it to reset the host key for the destination server.

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

3. Run the okv backup destination reset-host-key command using the generated JSON file.

   okv backup destination reset-host-key --from-json reset_host_key.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

Required Authorization

System Administrator role

Syntax

okv backup history list --max number_of_backup_records

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup history list command.

   okv backup history list --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, bkup_history_list.json) and then edit it to generate the backup history list.

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

3. Run the okv backup history list command using the generated JSON file.

   okv backup history list --from-json bkup_history_list.json

   Output similar to the following appears:

   {
     "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"
       }
     ]
   }

Required Authorization

System Administrator role

Syntax

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

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup schedule create command.

   okv backup schedule create --generate-json-input

   The generated input appears as follows:

   {
     "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. Save the generated input to a file (for example, bkup_sched_create.json) and then edit it to create the backup schedule.

   {
     "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. Run the okv backup schedule create command using the generated JSON file.

   okv backup schedule create --from-json bkup_sched_create.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

Required Authorization

System Administrator role

Syntax

okv backup schedule delete --name backup_schedule_name

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup schedule delete command.

   okv backup schedule delete --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, bkup_sched_del.json) and then edit it so that you can delete the backup schedule.

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

3. Run the okv backup schedule delete command using the generated JSON file.

   okv backup schedule delete --from-json bkup_sched_del.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

The okv backup schedule get command returns the following values:

• Type (for example, periodically @ 1 days 0 hrs 0 mins)
• Destination (for example, local or remote-dest)
• State (ACTIVE, ONGOING, PAUSED, DONE)
• Last run error
• Schedule time
• Start time
• Last backup time
• Last full backup time
• Run count (for periodic backups)

Required Authorization

System Administrator role

Syntax

okv backup schedule get --name backup_schedule_name

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup schedule get command.

   okv backup schedule get --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, bkup_sched_get.json) and then edit it to get the backup schedule.

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

3. Run the okv backup schedule get command using the generated JSON file.

   okv backup schedule get --from-json bkup_sched_get.json

   Output similar to the following appears:

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

Required Authorization

System Administrator role

Syntax

okv backup schedule list

JSON Input File Template

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

Parameters

None

JSON Example

1. Generate JSON input for the okv backup schedule list command.

   okv backup schedule list --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, bkup_sched_list.json).
3. Run the okv backup schedule list command using the generated JSON file.

   okv backup schedule list --from-json bkup_sched_list.json.json

   Output similar to the following appears:

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

Required Authorization

System Administrator role

Syntax

okv backup schedule pause --name backup_schedule_name

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup schedule pause command.

   okv backup schedule pause --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, bkup-sched-pause.json) and then edit it so that you can pause the backup schedule.

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

3. Run the okv backup schedule pause command using the generated JSON file.

   okv backup schedule pause --from-json bkup-sched-pause.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

Required Authorization

System Administrator role

Syntax

okv backup schedule resume --name backup_schedule_name

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup schedule resume command.

   okv backup schedule resume --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, bkup_sched_resume.json) and then edit it to resume the paused backup schedule.

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

3. Run the okv backup schedule resume command using the generated JSON file.

   okv backup schedule resume --from-json bkup_sched_resume.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

Required Authorization

System Administrator role

Syntax

okv backup schedule delete --name backup_schedule_name

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup schedule delete command.

   okv backup schedule delete --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, bkup_sched_del.json) and then edit it to delete the backup schedule.

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

3. Run the okv backup schedule delete command using the generated JSON file.

   okv backup schedule delete --from-json bkup_sched_del.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

Required Authorization

System Administrator role

Syntax

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

JSON Input File Template

{
  "service" : {
    "category" : "backup",
    "resource" : "schedule",
    "action" : "update",
    "options" : {
      "name" : "#VALUE",
      "startTime" : "#VALUE",
      "interval" : {
        "days" : "#0-99",
        "hours" : "#0-23",
        "mins" : "#0-59"
      }
    }
  }
}

Parameters

JSON Example

1. Generate JSON input for the okv backup schedule update command.

   okv backup schedule update --generate-json-input

   The generated input appears as follows:

   {
     "service" : {
       "category" : "backup",
       "resource" : "schedule",
       "action" : "update",
       "options" : {
         "name" : "#VALUE",
         "startTime" : "#VALUE",
         "interval" : {
           "days" : "#0-99",
           "hours" : "#0-23",
           "mins" : "#0-59"
         }
       }
     }
   }

2. Save the generated input to a file (for example, bkup_sched_update.json) and then edit it to update the backup schedule.

   {
     "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. Run the okv backup schedule update command using the generated JSON file.

   okv backup schedule update --from-json bkup_sched_update.json

   Output similar to the following appears:

   {
     "result" : "Success"
   }

This command will require the use of the Oracle Key Vault recovery passphrase.

Required Authorization

System Administrator role

After you begin the restore operation, you can check its status by running the okv backup restore status command.

Syntax

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

JSON Input File Template

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

Parameters

JSON Example

1. Generate JSON input for the okv backup restore start command.

   okv backup restore start --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, bkup_restore_start.json) and then edit it to start the restore of a backup. In the following example, the passphrase is not specified so that the user will be prompted interactively for it.

   {
     "service" : {
       "category" : "backup",
       "resource" : "restore",
       "action" : "start",
       "options" : {
         "name" : "okvbackup_onetime_onetime_20210118175804",
         "destination" : "prod_okv_backup_dest"
       }
     }
   }

3. Run the okv backup restore start command using the generated JSON file.

   okv backup restore start --from-json bkup_restore_start.json

   You will be prompted to enter the recovery passphrase, which must be the one that was effective at the time of the backup that is being restored. After you enter this passphrase, output similar to the following appears:

   {
     "result" : "Success"
   }

Required Authorization

System Administrator role

Syntax

okv backup restore status

JSON Input File Template

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

Parameters

None

JSON Example

1. Generate JSON input for the okv backup restore status command.

   okv backup restore status --generate-json-input

   The generated input appears as follows:

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

2. Save the generated input to a file (for example, bkup_restore_status.json).
3. Run the okv backup restore status command using the generated JSON file.

   okv backup restore status --from-json bkup_restore_status.json

   If restore is ongoing, then output similar to the following appears:

   {
     "result" : "Success",
     "value" : 
       {
         "destination" : "LOCAL",
         "status" : "ONGOING",
         "time" : "2020-12-18 11:49:30"
       }
   }

   If restore is complete, then output similar to the following appears:

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