oracle.oci.oci_dts_transfer_package – Manage a TransferPackage 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_package.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • This resource has the following action operations in the oracle.oci.oci_dts_transfer_package_actions module: detach_devices.

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.
id
string / required
ID of the Transfer Job
lifecycle_state
string
    Choices:
  • SHIPPING
  • CANCELLED
This parameter is updatable.
original_package_delivery_tracking_number
string
This parameter is updatable.
package_delivery_vendor
string
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.
return_package_delivery_tracking_number
string
This parameter is updatable.
state
string
    Choices:
  • present ←
  • absent
The state of the TransferPackage.
Use state=present to update an existing a TransferPackage.
Use state=absent to delete a TransferPackage.
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_package_label
string / required
Label of the Transfer Package
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_package
  oci_dts_transfer_package:
    # required
    id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    transfer_package_label: transfer_package_label_example

    # optional
    original_package_delivery_tracking_number: original_package_delivery_tracking_number_example
    return_package_delivery_tracking_number: return_package_delivery_tracking_number_example
    package_delivery_vendor: package_delivery_vendor_example
    lifecycle_state: SHIPPING

- name: Delete transfer_package
  oci_dts_transfer_package:
    # required
    id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    transfer_package_label: transfer_package_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_package
complex
on success
Details of the TransferPackage resource acted upon by the current operation

Sample:
{'attached_transfer_device_labels': [], 'creation_time': '2013-10-20T19:20:30+01:00', 'label': 'label_example', 'lifecycle_state': 'PREPARING', 'original_package_delivery_tracking_number': 'original_package_delivery_tracking_number_example', 'package_delivery_vendor': 'package_delivery_vendor_example', 'return_package_delivery_tracking_number': 'return_package_delivery_tracking_number_example', 'transfer_job_id': 'ocid1.transferjob.oc1..xxxxxxEXAMPLExxxxxx', 'transfer_site_shipping_address': 'transfer_site_shipping_address_example'}
 
attached_transfer_device_labels
list / elements=string
on success
Transfer Devices attached to this Transfer Package
 
creation_time
string
on success

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

Sample:
label_example
 
lifecycle_state
string
on success

Sample:
PREPARING
 
original_package_delivery_tracking_number
string
on success

Sample:
original_package_delivery_tracking_number_example
 
package_delivery_vendor
string
on success

Sample:
package_delivery_vendor_example
 
return_package_delivery_tracking_number
string
on success

Sample:
return_package_delivery_tracking_number_example
 
transfer_job_id
string
on success

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

Sample:
transfer_site_shipping_address_example


Authors

  • Oracle (@oracle)