Preparing for Data Export

Prepare phase indicator for data export

This topic describes the tasks associated with preparing for the Data Export job. The Project Sponsor role typically performs these tasks. See Roles and Responsibilities.

Note

You can only run Oracle Cloud Infrastructure CLI commands from a Linux host. This differs from running CLI commands for other Oracle Cloud Infrastructure Services on a variety of host operating systems. Appliance-based commands require validation that is only available on Linux hosts.

Installing and Using the Oracle Cloud Infrastructure Command Line Interface

The Oracle Cloud Infrastructure Command Line Interface (CLI) provides a set of command line-based tools for configuring and running Appliance-Based Data Import. Use the Oracle Cloud Infrastructure CLI as an alternative to running commands from the Console. Sometimes you must use the CLI to complete certain tasks as there is no Console equivalent.

Minimum Required CLI Version

The minimum CLI version required for Data Export is 2.12.1.

Determining CLI Versions

Access the following URL to see the currently available version of the CLI:

https://github.com/oracle/oci-cli/blob/master/CHANGELOG.rst

Enter the following command at the prompt to see the version of the CLI currently installed on your machine:

oci --version

If you have a version on your machine older than the version currently available, install the latest version.

Note

Always update to the latest version of the CLI. The CLI is not updated automatically, and you can only access new or updated CLI features by installing the current version.

Installing the CLI

Installation and configuration of the CLIs is described in detail in Command Line Interface (CLI).

Using the CLI

You can specify CLI options using the following commands:

  • --option <value> or
  • --option=<value>

The basic CLI syntax is:

oci dts <resource> <action> <options>

This syntax is applied to the following:

  • oci dts is the shortened CLI command name
  • job is an example of a <resource>
  • create is an example of an <action>
  • Other strings are <options>

The following command to create an export job shows a typical CLI command construct.

oci dts export create --compartment-id ocid.compartment.oc1..exampleuniqueID --bucket-name MyBucket1 --display-name MyExportJob --addressee "MyCompany Corp" --care-of "John Doe" --address1 "123 Main St." --city-or-locality Anytown --state-province-region CA --country USA --zip-postal-code 12345 --phone-number "555.555.1212" --email jdoe@mycompany.com
Note

In the previous examples, provide a friendly name for the export job using the ‑‑display‑name option. Avoid entering confidential information as part of the display name.

Accessing Command Line Interface Help

All CLI help commands have an associated help component you can access from the command line. To view the help, enter any command followed by the --help or -h option. For example:


oci dts export --help
			
NAME
dts_export -

DESCRIPTION
Data Transfer Service CLI Specification

AVAILABLE COMMANDS
o change-compartment

o configure-physical-appliance

o create

o create-policy

o delete

o generate-manifest
			
o list

o request-appliance

o setup-notifications

o show

o update

When you run the help option (--help or -h) for a specified command, all the subordinate commands and options for that level of CLI are displayed. If you want to access the CLI help for a specific subordinate command, include it in the CLI string, for example:


oci dts export create --help
			
NAME
dts_export_create -

DESCRIPTION
Creates  a  new  Appliance  Export Job that corresponds with customer's
logical dataset

USAGE
oci dts export create [OPTIONS]

REQUIRED PARAMETERS
--address1 [text]

Address line 1.
			
--addressee [text]

Company or person to send the appliance to

--bucket-name [text]

Name of the object storage bucket for this export job

--care-of [text]

Place/person to direct the package to.

--city-or-locality [text]

:

Setting Up the Oracle Cloud Infrastructure Configuration File

Before using the command line utility, create a configuration file that contains the required credentials for working with Oracle Cloud Infrastructure. You can create this file using a setup dialog or manually using a text editor.

Using the Setup CLI

Run the oci setup config command line utility to walk through the first-time setup process. The command prompts you for the information required for the configuration file and the API public/private keys. The setup dialog generates an API key pair and creates the configuration file.

For more information about how to find the required information, see:

Manual Setup

If you want to set up the API public/private keys yourself and write your own config file, see SDK and Tool Configuration.

Tip

Use the oci setup keys command to generate a key pair to include in the config file.

Create the configuration file /root/.oci/config with the following structure:

[DEFAULT]
user=<The OCID for the data transfer administrator>
fingerprint=<The fingerprint of the above user's public key>
key_file=<The _absolute_ path to the above user's private key file on the host machine>
tenancy=<The OCID for the tenancy that owns the data transfer job and bucket>
region=<The region where the transfer job and bucket should exist. Valid values are: 
us-ashburn-1, us-phoenix-1, eu-frankfurt-1, and uk-london-1, and ap-osaka-1.>

For example:

[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=4c:1a:6f:a1:5b:9e:58:45:f7:53:43:1f:51:0f:d8:45
key_file=/home/user/ocid1.user.oc1..exampleuniqueID.pem
tenancy=ocid1.tenancy.oc1..<unique_ID>
region=us-phoenix-1

For the data transfer administrator, you can create a single configuration file that contains different profile sections with the credentials for multiple users. Then use the ‑‑profile option to specify which profile to use in the command. Here is an example of a data transfer administrator configuration file with different profile sections:

[DEFAULT]
user=ocid1.user.oc1..exampleuniqueID
fingerprint=4c:1a:6f:a1:5b:9e:58:45:f7:53:43:1f:51:0f:d8:45
key_file=/home/user/ocid1.user.oc1..exampleuniqueID.pem
tenancy=ocid1.tenancy.oc1..exampleuniqueID
region=us-phoenix-1
[PROFILE1]
user=ocid1.user.oc1..exampleuniqueID
fingerprint=4c:1a:6f:a1:5b:9e:58:45:f7:53:43:1f:51:0f:d8:45
key_file=/home/user/ocid1.user.oc1..exampleuniqueID.pem
tenancy=ocid1.tenancy.oc1..exampleuniqueID
region=us-ashburn-1

By default, the DEFAULT profile is used for all CLI commands. For example:

oci dts export create --compartment-id ocid.compartment.oc1..exampleuniqueID --bucket-name MyBucket --display-name MyDisplay ...

Instead, you can issue any CLI command with the --profile option to specify a different data transfer administrator profile. For example:

oci dts export create --compartment-id ocid.compartment.oc1..exampleuniqueID --bucket-name MyBucket --display-name MyDisplay ... --profile MyProfile

Using the example configuration file above, the <profile_name> would be profile1.

If you created two separate configuration files, use the following command to specify the configuration file to use:

oci dts export create --compartment-id <compartment_id> --bucket <bucket_name> --display-name <display_name>

Creating the Required IAM Policies

Each service in Oracle Cloud Infrastructure integrates with IAM for authentication and authorization.

To use Oracle Cloud Infrastructure, you must be given the required type of access in a policy  written by an administrator, whether you're using the Console or the REST API with an SDK, CLI, or other tool. If you try to perform an action and get a message that you don’t have permission or are unauthorized, confirm with your administrator the type of access you've been granted and which compartment  you should work in.

You provide resource access to the data export administrators group using policies. See Managing Groups for more information.

Create this group using the following policies:

Allow group <group-name> to manage appliance-export-jobs in compartment <compartment-name>
Allow group <group name> to manage buckets in compartment <compartment name>
Allow group <group name> to manage objects in compartment <compartment name>

To enable notifications, add the following policies:

Allow group <group name> to manage ons-topics in tenancy
Allow group <group name> to manage ons-subscriptions in tenancy
Allow group <group name> to manage cloudevents-rules in tenancy
Allow group <group name> to inspect compartments in tenancy

See Getting Started with Policies for more information.

Requesting Appliance Entitlement

If your tenancy is not entitled to use the Data Transfer Appliance, you must request the Data Transfer Appliance Entitlement before creating an export job.

Establishing the Data Transfer Appliance Entitlement Policy

Use the following policy to enable users in a specific group to request a Data Transfer Appliance Entitlement in your tenancy.

Allow group <group_name> to {DTA_ENTITLEMENT_CREATE} in tenancy

Entitlement Eligibility

Your request for a Data Transfer Appliance Entitlement in your tenancy may be denied if you are a free trial customer. If your request is denied, upgrade to a full account. You can also contact your Oracle Customer Support Manager or Oracle Support to determine your options for obtaining the entitlement.

Requesting the Appliance Entitlement

To request the Data Transfer Appliance Entitlement and show status using the Console

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.

To request the Data Transfer Appliance Entitlement using the CLI
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": "jdoe@mycompany.com",
	"requestor-name": "John Doe",
    "update-time": "2019-12-20T19:04:09+00:00"
  }
}
To show the status of a Data Transfer Appliance Entitlement request using the CLI
oci dts appliance show-entitlement --compartment-id <compartment_id>

For example:

oci dts appliance show-entitlement --compartment-id ocid.compartment.oc1..exampleuniqueID 
{
  "data": {
    "compartment-id": ""ocid.compartment.oc1..exampleuniqueID",
    "defined-tags": null,
    "display-name": null,
    "freeform-tags": null,
    "id": null,
    "lifecycle-state": "ACTIVE",
    "lifecycle-state-details": "APPROVED",
    "requestor-email": null,
    "requestor-name": null
  }
}

Setting Up Notifications

Set up rules for the Export Job notification resource that notify the appropriate administrators of the tenancy of events such as when someone creates an export job and when Oracle ships the export appliance.

The types of events you can set up are:

  • CREATE
  • DELETE
  • UPDATE

See Notifications Overview and Overview of Events for more information.

You can also set up notifications for your export job using the CLI. See Setting Up Export Job Notifications from the CLI for more information on this feature.

Notification Policies

Set up the following policies to support notifications for export jobs:

Allow group <group name> to manage ons-topics in tenancy
Allow group <group name> to manage ons-subscriptions in tenancy
Allow group <group name> to manage cloudevents-rules in tenancy
Allow group <group name> to inspect compartments in tenancy

Configuring Firewall Settings

Ensure that your local environment's firewall can communicate with the Data Transfer Service running on the IP address ranges: 140.91.0.0/16. You also need to open access to the Object Storage IP address ranges: 134.70.0.0/17.

Creating Export Jobs

This section describes how to create an export job as part of the preparation for the data export. See Export Jobs for complete details on all tasks related to export jobs.

An export job represents the collection of files that you want to export and signals the intention to copy those files from your Oracle Cloud Infrastructure Object Storage or Archive Storage bucket to your data center using an Oracle-provided export appliance. Create the export job in the same compartment as the bucket and supply a human-readable name for the export job. Avoid entering confidential information when providing export job names.

Note

It is recommended that you create a compartment for each export job to minimize the required access your tenancy.

Creating an export job returns a job ID that you specify in other export tasks. For example:

ocid.compartment.oc1..exampleuniqueID
To create an export job using the Console
  1. Open the navigation menu. Under Core Infrastructure, go to Object Storage and click Data Transfer - Exports.
  2. Select the Compartment you are to use for data exports from the list.

    A list of export jobs that have already been created is displayed in the Export Jobs page.

  3. Click Create Export Job.

    The Create Export Job dialog appears.

  4. Enter a Job Name, and select the Bucket Name from the list.

    Avoid entering confidential information in the export job name.

  5. Complete the following fields:
    • Company Name
    • Recipient Phone
    • Recipient Email
    • Care of - Optional intermediary party responsible for transferring the appliance from the delivery vendor to the intended recipient.
    • Address 1
    • Address 2
    • City/Locality
    • State/Province/Region
    • Zip/Postal Code
    • Country
  6. (Optional) Add any tagging information, including the tag namespace, key, and value in the associated fields.
  7. Click Create.

The export job you created is added to the list of export jobs.

To create an export job using the CLI
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.

<options> are:

  • --prefix: List of objects with names matching this prefix would be part of this export job.
  • --range-start: Object names returned by a list query must be greater or equal to this parameter.
  • --range-end: Object names returned by a list query must be strictly less than this parameter.
  • --freeform-tags: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: `{"Department": "Finance"}` This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax. The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.
  • --defined-tags: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags]. Example: `{"Operations": {"CostCenter":"42"}}` This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax. The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.
  • --wait-for-state: This operation creates, modifies or deletes a resource that has a defined lifecycle state: CREATING, ACTIVE, IN PROGRESS, SUCCEEDED, FAILED, CANCELLED, or DELETED. Specify this option to perform the action and then wait until the resource reaches a given lifecycle state. Multiple states can be specified, returning on the first state. For example, --wait-for-state SUCCEEDED --wait-for-state FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.
  • --max-wait-seconds: The maximum time in seconds to wait for the resource to reach the lifecycle state defined by the --wait-for-state attribute. Default is 1200.
  • --wait-interval-seconds: The check interval in seconds to determine whether the resource to see if it has reached the lifecycle state defined by the --wait-for-state. Default is 30.
  • --address2: Optional address line 2.
  • --address3: Optional address line 3.
  • --address4: Optional address line 4.
  • --from-json: Provide input to this command as a JSON document from a file using the file://path-to/file syntax. The --generate-full-command-json-input option can be used to generate a sample JSON file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id --> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array. Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used. For examples on usage of this option, please see our "using CLI with advanced JSON options" link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions.

For example:

oci dts export create --compartment-id ocid.compartment.oc1..exampleuniqueID --bucket-name MyBucket1 --display-name MyExportJob1 --addressee "MyCompany Corp" --care-of "John Doe" --address1 "123 Main St." --city-or-locality Anytown --state-province-region CA --country USA --zip-postal-code 12345 --phone-number "4085551212" --email jdoe@mycompany.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": "123 Main St.",
      "address2": null,
      "address3": null,
      "address4": null,
      "addressee": "MyCompany Corp",
      "care-of": "John Doe",
      "city-or-locality": "Anytown",
      "country": "USA",
      "email": "jdoe@mycompany.com",
      "phone-number": "4085554321",
      "state-or-region": "CA",
      "zipcode": "12345"
    },
    "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 from the CLI for more information on this feature.

Getting Export Job IDs

Each export job you create has a unique ID within Oracle Cloud Infrastructure. For example:

ocid1.datatransferapplianceexportjob.oc1..exampleuniqueID

You will need to forward this export job ID to the Data Administrator.

To get the export job ID using the Console
  1. Open the navigation menu. Under Core Infrastructure, go to Object Storage and click Data Transfer - Exports.
  2. Select the Compartment from the list.

    The export jobs in that compartment are displayed.

  3. Find the export job for which you want to display the details.
  4. Click the Actions icon (Actions icon), and then click View Details.
To get the export job ID using the CLI
oci dts export list --compartment-id <compartment_id>

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"
Tip

When you create an export job using the oci dts export create CLI, the export job ID is displayed in the CLI's return. You can also run the oci dts export show CLI for that specific job to get the ID.

Setting Up Export Job Notifications from the CLI

You can generate notifications that send messages regarding changes to an export job by using the setup-notifications command through the CLI. Running this command creates a topic, subscription for a list of email addresses, and a rule that notifies you on all events related to the export job's activities and changes in state. This method provides a more convenient way to generate notifications tailored to export jobs.

Running the CLI command prompts you to enter the email addresses of each notification subscriber as a comma separated list. Each recipient is sent an email with a link to confirm they want to receive the notifications.

You can set up notifications when you create an export job using the CLI. You can also set up notifications for existing export jobs.

Setting up Notifications for a New Export Job

To set up notifications when creating an export job, include the --setup notifications option as part of the CLI:

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> --setup-notifications

Setting up Notifications for an Existing Export Job

To set up notifications for an existing export job:

oci dts export setup-notifications

For both of the notification commands, the following is returned:

If the commands fail to run, you can use the OCI CLI to do the setup manually:
export ROOT_COMPARTMENT_OCID=ocidv1:tenancy:oc1:exampleuniqueID
oci ons topic create --compartment-id $ROOT_COMPARTMENT_OCID --name DTSExportTopic --description "Topic for data transfer service export jobs"
oci ons subscription create --protocol EMAIL --compartment-id $ROOT_COMPARTMENT_OCID --topic-id $TOPIC_OCID --endpoint $EMAIL_ID
oci events rule create --display-name DTSExportRule --is-enabled true --compartment-id $ROOT_COMPARTMENT_OCID --actions '{"actions":[{"actionType":"ONS","topicId":"$TOPIC_OCID","isEnabled":true}]}' --condition '{"eventType":["com.oraclecloud.datatransferservice.addapplianceexportjob","com.oraclecloud.datatransferservice.deleteapplianceexportjob","com.oraclecloud.datatransferservice.updateapplianceexportjob","com.oraclecloud.datatransferservice.moveapplianceexportjob"]}' --description "Rule for data transfer service to send notifications for export jobs"
Creating topic for export
		

Generating the Export Manifest File

The data export job requires that you generate a manifest file for the files you want to be exported to you in the Data Transfer Appliance. This manifest file is stored in your export job's bucket. Oracle uses the manifest file to download from that bucket all the files that are listed in the manifest. When the Data Transfer Appliance is sent to you, the download summary is available at the root of the Data Transfer Appliance's mount point, allowing you to compare the manifest against the download summary.

Note

You can only use the CLI command to generate the export manifest file.
To generate an export manifest file using the CLI
oci dts export generate-manifest --compartment-id <compartment_id> --job-id <job_id> --bucket <bucket> <options>

<options> are:

  • --prefix: The subset of objects that needs to be exported whose names start with this prefix.
  • --start: The subset of objects that needs to be exported starting with this object (inclusive).
  • --end: The subset of objects that needs to be exported up to this object (inclusive).

Creating the Data Export Policy

Data export requires you to add the provided policy language to authorize a secure Oracle IAM user to have read-only access to the bucket for export. You must have administrator privileges in your tenancy to create the data export policy.

To create an export policy using the Console
  1. Open the navigation menu. Under Core Infrastructure, go to Object Storage and click Data Transfer - Exports.
  2. Select the Compartment from the list.

    The export jobs in that compartment are displayed.

  3. Click the export job link whose data export policies you want to access.

    The Details page for that export job appears.

  4. Find the export policies under Policy Language in the Details page.
  5. Copy and use these policy statements in the policy you create in the Console.

See Getting Started with Policies for more information.

To create an export policy using the CLI

The export create-policy CLI automates the process of generating policies for export job. You do not need to use the Console to create individual policies if you run this CLI.

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

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

Requesting the Export Appliance

This section describes how to request an export appliance from Oracle.

To request an export appliance for your data export job using the Console
  1. Open the navigation menu. Under Core Infrastructure, go to Object Storage and click Data Transfer - Exports.
  2. Select the Compartment from the list.

    The export jobs in that compartment are displayed.

  3. Click the export job link for which you want to request the export appliance.

    The Details page for that export job appears.

  4. Click Request Export Appliance.

    The Request Export Appliance dialog appears prompting you to review the manifest file before continuing with the export appliance request.

    Review the manifest file to ensure all your export job information, such as the bucket and contact information is correct. If anything is not correct, cancel the application request and correct the export job information before trying again to request an export application.

  5. Click Request.

The Details page is updated to indicate Appliance Requested. The state of your export job is updated to Pending Approval in the list of export jobs.

To request an export appliance for your data export job using the CLI
oci dts export request-appliance --job-id <job_id>

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": "123 Main St.",
      "address2": null,
      "address3": null,
      "address4": null,
      "addressee": "DTS",
      "care-of": "John Doe",
      "city-or-locality": "Anytown",
      "country": "USA",
      "email": "jdoe@mycompany.com",
      "phone-number": "4085551212",
      "state-or-region": "CA",
      "zipcode": "12345"
    },
    "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"
}

Tracking the Export Appliance Delivery

To track the export appliance delivery status using the Console
  1. Open the navigation menu. Under Core Infrastructure, go to Object Storage and click Data Transfer - Exports
  2. Select the Compartment from the list.

    The export jobs in that compartment are displayed.

  3. Click the export job for which you want to display the details.

    As an alternative, you can click the Actions icon (Actions icon) associated with your export job, and then click View Details.

The status of the requested export appliance is listed under Appliance Information.

To track the export appliance delivery status using the CLI
oci dts export show --job-id <job_id>  <options>
<options> are:
  • --from-json: Provide input to this command as a JSON document from a file using the file://path-to/file syntax. The --generate-full-command-json-input option can be used to generate a sample JSON file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id --> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array. Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used. For examples on usage of this option, please see our "using CLI with advanced JSON options" link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions.

For example:

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": "123 Main St.",
      "address2": null,
      "address3": null,
      "address4": null,
      "addressee": "MyCompany",
      "care-of": "John Doe",
      "city-or-locality": "Anytown",
      "country": "US",
      "email": "jdoe@mycompany.com",
      "phone-number": "4085551212",
      "state-or-region": "CA",
      "zipcode": "12345"
    },
    "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.

Notifying the Data Administrator

When you have completed all the tasks in this topic, provide the Data Administrator of the following:

  • IAM login credentials
  • Oracle Cloud Infrastructure CLI configuration files
  • Export job ID