Preparing for Data Export

Open the Transfer Job page and click Request at the top. Otherwise, you are prompted to request the entitlement when attempting to create your first export job.

Once requested, the status of your request is visible at the top of the Transfer Job page. For example:

Data Transfer Appliance Entitlement: Granted

It can take a while to get the Data Transfer Appliance Entitlement approved. After Oracle receives your request, a Terms and Conditions Agreement is sent to the account owner via DocuSign to use the appliance. The entitlement request is approved once the signature is received. The Data Transfer Appliance Entitlement is a tenancy-wide entitlement that you need to request once for each tenancy.

Use the oci dts appliance request-entitlement command and required parameters to request an appliance entitlement:

oci dts appliance request-entitlement --compartment-id compartment_id --name name --email email

name is the name of the requester.

email is the email address of the requester.

For example:

oci dts appliance request-entitlement --compartment-id ocid.compartment.oc1..exampleuniqueID --name "John Doe" --email jdoe@mycompany.com
					
{
  "data": {
    "compartment-id": "ocid.compartment.oc1..exampleuniqueID",
    "creation-time": "2019-12-18T18:29:15+00:00",
	"defined-tags": {},
	"display-name": null,
	"freeform-tags": {},
	"id": "ocid1.datatransferapplianceentitlement.oc1..exampleuniqueID",
	"lifecycle-state": "CREATING",
	"lifecycle-state-details": "REQUESTED",
	"requestor-email": "rsmith@example.com",
	"requestor-name": "Robert Smith",
    "update-time": "2019-12-20T19:04:09+00:00"
  }
}

Use the dts export create command and required parameters to create an export job.

oci dts export create --compartment-id compartment_id --bucket-name bucket_name --display-name display_name --addressee addressee --care-of care_of --address address --city-or-locality city_or_locality --state-province-region state_province_region --country country --zip-postal-code zip_postal_code --phone-number phone_number --email email [OPTIONS]

display_name is the name of the export job as it appears.

addressee is the company or person to receiving the appliance.

care_of is the contact associated with the addressee.

address is the required address of the addressee.

city_or_locality is city or locality of the addressee.

state_province_region is the state, province, or region of the addressee.

country is the country of the addressee.

zip_postal_code is the zip or postal code of the addressee.

phone_number is the phone number of the addressee or contact.

email is the email address of the addressee or contact.

For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

For example:

oci dts export create --compartment-id ocid.compartment.oc1..exampleuniqueID 
--bucket-name MyBucket1 --display-name MyExportJob1 --addressee "Example, Inc." --care-of "Robert Smith" 
--address1 "2300 Oracle Way" --city-or-locality Austin --state-province-region TX --country USA 
--zip-postal-code 78741 --phone-number 6035550100 --email jsmith@example.com

{
  "data": {
    "appliance-decryption-passphrase": "********",
    "appliance-delivery-tracking-number": null,
    "appliance-delivery-vendor": null,
    "appliance-return-delivery-tracking-number": null,
    "appliance-serial-number": null,
    "bucket-access-policies": [
    "POLICIES CREATION IN PROGRESS"
    ],
    "bucket-name": "MyExportJobs",
    "compartment-id": "ocid.compartment.oc1..exampleuniqueID",
    "creation-time": "2020-06-18T17:24:13+00:00",
    "customer-shipping-address": {
      "address1": "2300 Oracle Way",
      "address2": null,
      "address3": null,
      "address4": null,
      "addressee": "Example, Inc.",
      "care-of": "Robert Smith",
      "city-or-locality": "Austin",
      "country": "USA",
      "email": "rsmith@example.com",
      "phone-number": "6035550100",
      "state-or-region": "TX",
      "zipcode": "78741"
    },
    "defined-tags": {},
    "display-name": "MyExportJob1",
    "first-object": null,
    "freeform-tags": {},
    "id": "ocid1.datatransferapplianceexportjob.oc1..exampleuniqueID",
    "last-object": null,
    "lifecycle-state": "CREATING",
    "lifecycle-state-details": "PENDING_MANIFEST_GENERATION",
    "manifest-file": null,
    "manifest-md5": null,
    "next-object": null,
    "number-of-objects": null,
    "prefix": null,
    "range-end": null,
    "range-start": null,
    "receiving-security-tie": null,
    "sending-security-tie": null,
    "total-size-in-bytes": null
  },
  "etag": "4--gzip"
}

Notifications To include notifications, include the --setup-notifications option. See Setting Up Export Job Notifications for more information on this feature.

Use the oci dts export list command and required parameters to get the details of an export job:

oci dts export list --compartment-id compartment_id

For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

For example:

oci dts export list --compartment-id ocid.compartment.oc1..exampleuniqueID
				
{
  "data": [
    {
      "bucket-name": "MyExportJobs",
      "creation-time": "2020-06-18T17:24:13+00:00",
      "defined-tags": {},
      "display-name": "MyExportJob1",
      "freeform-tags": {},
      "id": "ocid1.datatransferapplianceexportjob.oc1..exampleuniqueID",
      "lifecycle-state": "CREATING",
      "lifecycle-state-details": "PENDING_MANIFEST_GENERATION"
    },
    {
      "bucket-name": "MyTestExportJobs",
      "creation-time": "2020-06-18T18:07:59+00:00",
      "defined-tags": {},
      "display-name": "MyTestExportJob",
      "freeform-tags": {},
      "id": "ocid1.datatransferapplianceexportjob.oc1..exampleuniqueID",
      "lifecycle-state": "CREATING",
      "lifecycle-state-details": "PENDING_MANIFEST_GENERATION"
    }
  ]
}

The ID for each export job is included in the return:

"id": "ocid1.datatransferapplianceexportjob.oc1..exampleuniqueID"

Use the oci dts export generate-manifest command and required parameters to generate the export manifest file:

oci dts export generate-manifest --compartment-id compartment_id --job-id job_id --bucket bucket [OPTIONS]

For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

Use the oci dts export create-policy command and required parameters to create a data export policy.

oci dts export create-policy --job-id job_id

For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

For example:

oci dts export create-policy --job-id ocid1.datatransferapplianceentitlement.oc1..exampleuniqueID

Setting up the following policies in the root compartment. If the following operation fails it means that you do not have enough privileges to create policies. Re-run the below command with the correct user
NOTE: Sometimes you will need to replace a single quote with '"'"'
oci iam policy create --name e2e-export-test-af3df5176d46_Policy --compartment-id $ROOT_COMPARTMENT --statements '["DEFINE TENANCY OCI_TENANCY AS ocid1.tenancy.oc1..exampleuniqueID", "DEFINE GROUP OCI_EXPORT_GROUP AS ocid1.group.region1..exampleuniqueID", "ADMIT GROUP OCI_EXPORT_GROUP OF TENANCY OCI_TENANCY TO read objects IN TENANCY where target.bucket.name='dtsTestBucket'", "ADMIT GROUP OCI_EXPORT_GROUP OF TENANCY OCI_TENANCY TO read objectstorage-namespaces IN TENANCY"]' --description "The policies to allow DTS to process the export job"

{
  "data": {
    "compartment-id": "ocid1.tenancy.region1..exampleuniqueID",
    "defined-tags": {},
    "description": "The policies to allow DTS to process the export job",
    "freeform-tags": {},
    "id": "ocid1.policy.region1..uniqueID",
    "inactive-status": null,
    "lifecycle-state": "ACTIVE",
    "name": "e2e-export-test-af3df5176d46_Policy",
    "statements": [
      "DEFINE TENANCY OCI_TENANCY AS ocid1.tenancy.oc1..exampleuniqueID",
      "DEFINE GROUP OCI_EXPORT_GROUP AS ocid1.group.region1..exampleuniqueID",
      "ADMIT GROUP OCI_EXPORT_GROUP OF TENANCY OCI_TENANCY TO read objects IN TENANCY where target.bucket.name='dtsTestBucket'",
      "ADMIT GROUP OCI_EXPORT_GROUP OF TENANCY OCI_TENANCY TO read objectstorage-namespaces IN TENANCY"
    ],
    "time-created": "2020-07-09T18:37:23.332000+00:00",
    "version-date": null
  },
  "etag": "20eb7654cd14fcfcaf8648de3c6dcc84d553069f"
}

Use the dts export request-appliance command and required parameters to request an export appliance.

oci dts export request-appliance --job-id job_id

For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

For example:

oci dts export request-appliance --job-id ocid1.datatransferapplianceentitlement.oc1..exampleuniqueID
					
{
  "data": {
    "appliance-decryption-passphrase": null,
    "appliance-delivery-tracking-number": null,
    "appliance-delivery-vendor": null,
    "appliance-return-delivery-tracking-number": null,
    "appliance-serial-number": null,
    "bucket-access-policies": [
      "DEFINE TENANCY OCI_TENANCY AS ocid1.tenancy.oc1..exampleuniqueID",
      "DEFINE GROUP OCI_EXPORT_GROUP AS ocid1.group.region1..exampleuniqueID",
      "ADMIT GROUP OCI_EXPORT_GROUP OF TENANCY OCI_TENANCY TO read objects IN TENANCY where target.bucket.name='MyExportBucket'",
      "ADMIT GROUP OCI_EXPORT_GROUP OF TENANCY OCI_TENANCY TO read objectstorage-namespaces IN TENANCY"
    ],
    "bucket-name": "MyExportBucket",
    "compartment-id": "ocid1.compartment.region1..exampleuniqueID",
    "creation-time": "2020-07-09T18:36:59+00:00",
    "customer-shipping-address": {
      "address1": "2300 Oracle Way",
      "address2": null,
      "address3": null,
      "address4": null,
      "addressee": "Example, Inc.",
      "care-of": "Robert Smith",
      "city-or-locality": "Austin",
      "country": "USA",
      "email": "rsmith@example.com",
      "phone-number": "6035550100",
      "state-or-region": "TX",
      "zipcode": "78741"
    },
    "defined-tags": {},
    "display-name": "e2e-export-test-af3df5176d46",
    "first-object": "oci_data_export_export-job-37",
    "freeform-tags": {},
    "id": "ocid1.datatransferapplianceexportjob.region1..exampleuniqueID",
    "last-object": "oci_data_export_export-job-40",
    "lifecycle-state": "ACTIVE",
    "lifecycle-state-details": "PENDING_APPROVAL",
    "manifest-file": "oci_data_export_manifest_ocid1.datatransferapplianceexportjob.region1..exampleuniqueID",
    "manifest-md5": "NcEMgcgK2fK8HfvUV3eWAA==",
    "next-object": null,
    "number-of-objects": "2",
    "prefix": null,
    "range-end": "oci_data_export_export-job-50",
    "range-start": "oci_data_export_export-job-37",
    "receiving-security-tie": null,
    "sending-security-tie": null,
    "total-size-in-bytes": "85585303"
  },
  "etag": "1"
}

oci dts export show --job-id job_id [OPTIONS]

oci dts export show --job-id ocid1.datatransferapplianceexportjob.oc1..exampleuniqueID

{
  "data": {
    "appliance-decryption-passphrase": "********",
    "appliance-delivery-tracking-number": null,
    "appliance-delivery-vendor": null,
    "appliance-return-delivery-tracking-number": null,
    "appliance-serial-number": null,
    "bucket-access-policies": [
      "POLICIES CREATION IN PROGRESS"
    ],
    "bucket-name": "MyExportJobs",
    "compartment-id": "ocid.compartment.oc1..exampleuniqueID",
    "creation-time": "2020-06-18T17:24:13+00:00",
    "customer-shipping-address": {
      "address1": "2300 Oracle Way",
      "address2": null,
      "address3": null,
      "address4": null,
      "addressee": "Example, Inc.",
      "care-of": "Robert Smith",
      "city-or-locality": "Austin",
      "country": "US",
      "email": "rsmith@example.com",
      "phone-number": "6035550100",
      "state-or-region": "TX",
      "zipcode": "78741"
    },
    "defined-tags": {},
    "display-name": "MyExportJob1",
    "first-object": null,
    "freeform-tags": {},
    "id": "ocid1.datatransferapplianceexportjob.oc1..exampleuniqueID",
    "last-object": null,
    "lifecycle-state": "CREATING",
    "lifecycle-state-details": "PENDING_MANIFEST_GENERATION",
    "manifest-file": null,
    "manifest-md5": null,
    "next-object": null,
    "number-of-objects": null,
    "prefix": null,
    "range-end": null,
    "range-start": null,
    "receiving-security-tie": null,
    "sending-security-tie": null,
    "total-size-in-bytes": null
    },
  "etag": "1--gzip"
}

The status of the requested export appliance is listed in the appliance attributes in the returned information.