oracle.oci.oci_dts_appliance_export_job – Manage an ApplianceExportJob resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_dts_appliance_export_job.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete an ApplianceExportJob resource in Oracle Cloud Infrastructure

  • For state=present, creates a new Appliance Export Job that corresponds with customer’s logical dataset

  • This resource has the following action operations in the oracle.oci.oci_dts_appliance_export_job_actions module: change_compartment.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
appliance_export_job_id
string
ID of the Appliance Export Job
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
bucket_name
string
Required for create using state=present.
This parameter is updatable.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
customer_shipping_address
dictionary
Required for create using state=present.
This parameter is updatable.
address1
string / required
address2
string
address3
string
address4
string
addressee
string / required
care_of
string
city_or_locality
string / required
country
string / required
email
string
phone_number
string
state_or_region
string / required
zipcode
string / required
defined_tags
dictionary
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 parameter is updatable.
display_name
string
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
expected_return_date
string
Expected return date from customer for the device, time portion should be zero.
This parameter is updatable.
first_object
string
First object in the list of objects that are exported in this job.
This parameter is updatable.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
This parameter is updatable.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
last_object
string
Last object in the list of objects that are exported in this job.
This parameter is updatable.
lifecycle_state
string
    Choices:
  • CREATING
  • ACTIVE
  • INPROGRESS
  • SUCCEEDED
  • FAILED
  • CANCELLED
  • DELETED
This parameter is updatable.
lifecycle_state_details
string
A property that can contain details on the lifecycle.
This parameter is updatable.
manifest_file
string
Manifest File associated with this export job.
This parameter is updatable.
manifest_md5
string
md5 digest of the manifest file.
This parameter is updatable.
next_object
string
First object from which the next potential export job could start.
This parameter is updatable.
number_of_objects
string
Total number of objects that are exported in this job.
This parameter is updatable.
pickup_window_end_time
string
End time for the window to pickup the device from customer.
This parameter is updatable.
pickup_window_start_time
string
Start time for the window to pickup the device from customer.
This parameter is updatable.
prefix
string
List of objects with names matching this prefix would be part of this export job.
This parameter is updatable.
range_end
string
Object names returned by a list query must be strictly less than this parameter.
This parameter is updatable.
range_start
string
Object names returned by a list query must be greater or equal to this parameter.
This parameter is updatable.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
state
string
    Choices:
  • present ←
  • absent
The state of the ApplianceExportJob.
Use state=present to create or update an ApplianceExportJob.
Use state=absent to delete an ApplianceExportJob.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
total_size_in_bytes
string
Total size of objects in Bytes that are exported in this job.
This parameter is updatable.
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create appliance_export_job
  oci_dts_appliance_export_job:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    bucket_name: bucket_name_example
    display_name: display_name_example
    customer_shipping_address:
      # required
      addressee: addressee_example
      address1: address1_example
      city_or_locality: city_or_locality_example
      state_or_region: us-phoenix-1
      zipcode: zipcode_example
      country: country_example

      # optional
      care_of: care_of_example
      address2: address2_example
      address3: address3_example
      address4: address4_example
      phone_number: phone_number_example
      email: email_example

    # optional
    prefix: prefix_example
    range_start: range_start_example
    range_end: range_end_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update appliance_export_job
  oci_dts_appliance_export_job:
    # required
    appliance_export_job_id: "ocid1.applianceexportjob.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    bucket_name: bucket_name_example
    prefix: prefix_example
    range_start: range_start_example
    range_end: range_end_example
    display_name: display_name_example
    lifecycle_state: CREATING
    lifecycle_state_details: lifecycle_state_details_example
    manifest_file: manifest_file_example
    manifest_md5: manifest_md5_example
    number_of_objects: number_of_objects_example
    total_size_in_bytes: total_size_in_bytes_example
    first_object: first_object_example
    last_object: last_object_example
    next_object: next_object_example
    expected_return_date: expected_return_date_example
    pickup_window_start_time: pickup_window_start_time_example
    pickup_window_end_time: pickup_window_end_time_example
    customer_shipping_address:
      # required
      addressee: addressee_example
      address1: address1_example
      city_or_locality: city_or_locality_example
      state_or_region: us-phoenix-1
      zipcode: zipcode_example
      country: country_example

      # optional
      care_of: care_of_example
      address2: address2_example
      address3: address3_example
      address4: address4_example
      phone_number: phone_number_example
      email: email_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update appliance_export_job using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_dts_appliance_export_job:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    bucket_name: bucket_name_example
    prefix: prefix_example
    range_start: range_start_example
    range_end: range_end_example
    lifecycle_state: CREATING
    lifecycle_state_details: lifecycle_state_details_example
    manifest_file: manifest_file_example
    manifest_md5: manifest_md5_example
    number_of_objects: number_of_objects_example
    total_size_in_bytes: total_size_in_bytes_example
    first_object: first_object_example
    last_object: last_object_example
    next_object: next_object_example
    expected_return_date: expected_return_date_example
    pickup_window_start_time: pickup_window_start_time_example
    pickup_window_end_time: pickup_window_end_time_example
    customer_shipping_address:
      # required
      addressee: addressee_example
      address1: address1_example
      city_or_locality: city_or_locality_example
      state_or_region: us-phoenix-1
      zipcode: zipcode_example
      country: country_example

      # optional
      care_of: care_of_example
      address2: address2_example
      address3: address3_example
      address4: address4_example
      phone_number: phone_number_example
      email: email_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete appliance_export_job
  oci_dts_appliance_export_job:
    # required
    appliance_export_job_id: "ocid1.applianceexportjob.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete appliance_export_job using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_dts_appliance_export_job:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
appliance_export_job
complex
on success
Details of the ApplianceExportJob resource acted upon by the current operation

Sample:
{'appliance_decryption_passphrase': 'appliance_decryption_passphrase_example', 'appliance_delivery_tracking_number': 'appliance_delivery_tracking_number_example', 'appliance_delivery_vendor': 'appliance_delivery_vendor_example', 'appliance_return_delivery_tracking_number': 'appliance_return_delivery_tracking_number_example', 'appliance_serial_number': 'appliance_serial_number_example', 'bucket_access_policies': [], 'bucket_name': 'bucket_name_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'creation_time': '2013-10-20T19:20:30+01:00', 'customer_shipping_address': {'address1': 'address1_example', 'address2': 'address2_example', 'address3': 'address3_example', 'address4': 'address4_example', 'addressee': 'addressee_example', 'care_of': 'care_of_example', 'city_or_locality': 'city_or_locality_example', 'country': 'country_example', 'email': 'email_example', 'phone_number': 'phone_number_example', 'state_or_region': 'us-phoenix-1', 'zipcode': 'zipcode_example'}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'expected_return_date': '2013-10-20T19:20:30+01:00', 'first_object': 'first_object_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'last_object': 'last_object_example', 'lifecycle_state': 'CREATING', 'lifecycle_state_details': 'lifecycle_state_details_example', 'manifest_file': 'manifest_file_example', 'manifest_md5': 'manifest_md5_example', 'next_object': 'next_object_example', 'number_of_objects': 'number_of_objects_example', 'pickup_window_end_time': '2013-10-20T19:20:30+01:00', 'pickup_window_start_time': '2013-10-20T19:20:30+01:00', 'prefix': 'prefix_example', 'range_end': 'range_end_example', 'range_start': 'range_start_example', 'receiving_security_tie': 'receiving_security_tie_example', 'return_shipping_label_uri': 'return_shipping_label_uri_example', 'sending_security_tie': 'sending_security_tie_example', 'total_size_in_bytes': 'total_size_in_bytes_example'}
 
appliance_decryption_passphrase
string
on success
Passphrase associated with the Appliance.

Sample:
appliance_decryption_passphrase_example
 
appliance_delivery_tracking_number
string
on success
Tracking number associated with the shipment while shipping the Appliance to Customer.

Sample:
appliance_delivery_tracking_number_example
 
appliance_delivery_vendor
string
on success
Shipping Vendor selected to ship the Appliance associated with this job.

Sample:
appliance_delivery_vendor_example
 
appliance_return_delivery_tracking_number
string
on success
Tracking number associated with the shipment while shipping the Appliance back to Oracle.

Sample:
appliance_return_delivery_tracking_number_example
 
appliance_serial_number
string
on success
Serial Number of the Appliance associated with this Export Job.

Sample:
appliance_serial_number_example
 
bucket_access_policies
list / elements=string
on success
Polices to grant Data Transfer Service to access objects in the Bucket

 
bucket_name
string
on success

Sample:
bucket_name_example
 
compartment_id
string
on success

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
creation_time
string
on success

Sample:
2013-10-20T19:20:30+01:00
 
customer_shipping_address
complex
on success

   
address1
string
on success

Sample:
address1_example
   
address2
string
on success

Sample:
address2_example
   
address3
string
on success

Sample:
address3_example
   
address4
string
on success

Sample:
address4_example
   
addressee
string
on success

Sample:
addressee_example
   
care_of
string
on success

Sample:
care_of_example
   
city_or_locality
string
on success

Sample:
city_or_locality_example
   
country
string
on success

Sample:
country_example
   
email
string
on success

Sample:
email_example
   
phone_number
string
on success

Sample:
phone_number_example
   
state_or_region
string
on success

Sample:
us-phoenix-1
   
zipcode
string
on success

Sample:
zipcode_example
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success

Sample:
display_name_example
 
expected_return_date
string
on success
Expected return date from customer for the device, time portion should be zero.

Sample:
2013-10-20T19:20:30+01:00
 
first_object
string
on success
First object in the list of objects that are exported in this job.

Sample:
first_object_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
last_object
string
on success
Last object in the list of objects that are exported in this job.

Sample:
last_object_example
 
lifecycle_state
string
on success

Sample:
CREATING
 
lifecycle_state_details
string
on success
A property that can contain details on the lifecycle.

Sample:
lifecycle_state_details_example
 
manifest_file
string
on success
Url of the Manifest File associated with this export job.

Sample:
manifest_file_example
 
manifest_md5
string
on success
md5 digest of the manifest file.

Sample:
manifest_md5_example
 
next_object
string
on success
First object from which the next potential export job could start.

Sample:
next_object_example
 
number_of_objects
string
on success
Total number of objects that are exported in this job.

Sample:
number_of_objects_example
 
pickup_window_end_time
string
on success
End time for the window to pickup the device from customer.

Sample:
2013-10-20T19:20:30+01:00
 
pickup_window_start_time
string
on success
Start time for the window to pickup the device from customer.

Sample:
2013-10-20T19:20:30+01:00
 
prefix
string
on success
List of objects with names matching this prefix would be part of this export job.

Sample:
prefix_example
 
range_end
string
on success
The name of the last object in the range of objects that are expected to be part of this export job.

Sample:
range_end_example
 
range_start
string
on success
The name of the first object in the range of objects that are expected to be part of this export job.

Sample:
range_start_example
 
receiving_security_tie
string
on success
Unique number associated with the return security tie used to seal the Appliance case.

Sample:
receiving_security_tie_example
 
return_shipping_label_uri
string
on success

Sample:
return_shipping_label_uri_example
 
sending_security_tie
string
on success
Unique number associated with the security tie used to seal the Appliance case.

Sample:
sending_security_tie_example
 
total_size_in_bytes
string
on success
Total size of objects in Bytes that are exported in this job.

Sample:
total_size_in_bytes_example


Authors

  • Oracle (@oracle)