oracle.oci.oci_dts_transfer_appliance – Manage a TransferAppliance resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.3.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_transfer_appliance.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to update and delete a TransferAppliance resource in Oracle Cloud Infrastructure

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).
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
  • security_token
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.
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.
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
This parameter is updatable.
address1
string / required
This parameter is updatable.
address2
string
This parameter is updatable.
address3
string
This parameter is updatable.
address4
string
This parameter is updatable.
addressee
string / required
This parameter is updatable.
care_of
string
This parameter is updatable.
city_or_locality
string / required
This parameter is updatable.
country
string / required
This parameter is updatable.
email
string
This parameter is updatable.
phone_number
string
This parameter is updatable.
state_or_region
string / required
This parameter is updatable.
zipcode
string / required
This parameter is updatable.
expected_return_date
string
Expected return date from customer for the device, time portion should be zero.
This parameter is updatable.
id
string / required
ID of the Transfer Job
lifecycle_state
string
    Choices:
  • PREPARING
  • FINALIZED
  • RETURN_LABEL_REQUESTED
  • RETURN_LABEL_GENERATING
  • RETURN_LABEL_AVAILABLE
  • DELETED
  • CUSTOMER_NEVER_RECEIVED
  • CANCELLED
This parameter is updatable.
minimum_storage_capacity_in_terabytes
integer
Minimum storage capacity of the device, in terabytes. Valid options are 50, 95 and 150.
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.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
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 TransferAppliance.
Use state=present to update an existing a TransferAppliance.
Use state=absent to delete a TransferAppliance.
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
transfer_appliance_label
string / required
Label of the Transfer Appliance
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: Update transfer_appliance
  oci_dts_transfer_appliance:
    # required
    id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    transfer_appliance_label: transfer_appliance_label_example

    # optional
    lifecycle_state: PREPARING
    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
    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
    minimum_storage_capacity_in_terabytes: 56

- name: Delete transfer_appliance
  oci_dts_transfer_appliance:
    # required
    id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    transfer_appliance_label: transfer_appliance_label_example
    state: absent

Return Values

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

Key Returned Description
transfer_appliance
complex
on success
Details of the TransferAppliance resource acted upon by the current operation

Sample:
{'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', 'creation_time': '2013-10-20T19:20:30+01:00', 'customer_received_time': '2013-10-20T19:20:30+01:00', 'customer_returned_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'}, 'delivery_security_tie_id': 'ocid1.deliverysecuritytie.oc1..xxxxxxEXAMPLExxxxxx', 'expected_return_date': '2013-10-20T19:20:30+01:00', 'label': 'label_example', 'lifecycle_state': 'REQUESTED', 'minimum_storage_capacity_in_terabytes': 56, 'next_billing_time': '2013-10-20T19:20:30+01:00', 'pickup_window_end_time': '2013-10-20T19:20:30+01:00', 'pickup_window_start_time': '2013-10-20T19:20:30+01:00', 'return_security_tie_id': 'ocid1.returnsecuritytie.oc1..xxxxxxEXAMPLExxxxxx', 'return_shipping_label_uri': 'return_shipping_label_uri_example', 'serial_number': 'serial_number_example', 'transfer_job_id': 'ocid1.transferjob.oc1..xxxxxxEXAMPLExxxxxx', 'upload_status_log_uri': 'upload_status_log_uri_example'}
 
appliance_delivery_tracking_number
string
on success

Sample:
appliance_delivery_tracking_number_example
 
appliance_delivery_vendor
string
on success

Sample:
appliance_delivery_vendor_example
 
appliance_return_delivery_tracking_number
string
on success

Sample:
appliance_return_delivery_tracking_number_example
 
creation_time
string
on success

Sample:
2013-10-20T19:20:30+01:00
 
customer_received_time
string
on success

Sample:
2013-10-20T19:20:30+01:00
 
customer_returned_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
 
delivery_security_tie_id
string
on success

Sample:
ocid1.deliverysecuritytie.oc1..xxxxxxEXAMPLExxxxxx
 
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
 
label
string
on success
Unique alpha-numeric identifier for a transfer appliance auto generated during create.

Sample:
label_example
 
lifecycle_state
string
on success

Sample:
REQUESTED
 
minimum_storage_capacity_in_terabytes
integer
on success
Minimum storage capacity of the device, in terabytes. Valid options are 50, 95 and 150.

Sample:
56
 
next_billing_time
string
on success

Sample:
2013-10-20T19:20:30+01:00
 
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
 
return_security_tie_id
string
on success

Sample:
ocid1.returnsecuritytie.oc1..xxxxxxEXAMPLExxxxxx
 
return_shipping_label_uri
string
on success

Sample:
return_shipping_label_uri_example
 
serial_number
string
on success

Sample:
serial_number_example
 
transfer_job_id
string
on success

Sample:
ocid1.transferjob.oc1..xxxxxxEXAMPLExxxxxx
 
upload_status_log_uri
string
on success

Sample:
upload_status_log_uri_example


Authors

  • Oracle (@oracle)