Oracle Cloud Infrastructure Documentation

DTS Transfer Appliance Functions

Package: DBMS_CLOUD_OCI_DTS_TRANSFER_APPLIANCE

CREATE_TRANSFER_APPLIANCE Function

Create a new Transfer Appliance

Syntax

FUNCTION create_transfer_appliance (
  id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  create_transfer_appliance_details dbms_cloud_oci_dts_create_transfer_appliance_details_t DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_appliance_create_transfer_appliance_response_t;

Parameters

Parameter Description

id

(required) ID of the Transfer Job

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

create_transfer_appliance_details

(optional) Creates a New Transfer Appliance

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datatransfer.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_TRANSFER_APPLIANCE_ADMIN_CREDENTIALS Function

Creates an X.509 certificate from a public key

Syntax

FUNCTION create_transfer_appliance_admin_credentials (
  id varchar2,
  transfer_appliance_label varchar2,
  admin_public_key dbms_cloud_oci_dts_transfer_appliance_public_key_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_appliance_create_transfer_appliance_admin_credentials_response_t;

Parameters

Parameter Description

id

(required) ID of the Transfer Job

transfer_appliance_label

(required) Label of the Transfer Appliance

admin_public_key

(required)

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datatransfer.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_TRANSFER_APPLIANCE Function

deletes a transfer Appliance

Syntax

FUNCTION delete_transfer_appliance (
  id varchar2,
  transfer_appliance_label varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_appliance_delete_transfer_appliance_response_t;

Parameters

Parameter Description

id

(required) ID of the Transfer Job

transfer_appliance_label

(required) Label of the Transfer Appliance

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datatransfer.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TRANSFER_APPLIANCE Function

Describes a transfer appliance in detail

Syntax

FUNCTION get_transfer_appliance (
  id varchar2,
  transfer_appliance_label varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_appliance_get_transfer_appliance_response_t;

Parameters

Parameter Description

id

(required) ID of the Transfer Job

transfer_appliance_label

(required) Label of the Transfer Appliance

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datatransfer.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TRANSFER_APPLIANCE_CERTIFICATE_AUTHORITY_CERTIFICATE Function

Gets the x.509 certificate for the Transfer Appliance's dedicated Certificate Authority (CA)

Syntax

FUNCTION get_transfer_appliance_certificate_authority_certificate (
  id varchar2,
  transfer_appliance_label varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_appliance_get_transfer_appliance_certificate_authority_certificate_response_t;

Parameters

Parameter Description

id

(required) ID of the Transfer Job

transfer_appliance_label

(required) Label of the Transfer Appliance

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datatransfer.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TRANSFER_APPLIANCE_ENCRYPTION_PASSPHRASE Function

Describes a transfer appliance encryptionPassphrase in detail

Syntax

FUNCTION get_transfer_appliance_encryption_passphrase (
  id varchar2,
  transfer_appliance_label varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_appliance_get_transfer_appliance_encryption_passphrase_response_t;

Parameters

Parameter Description

id

(required) ID of the Transfer Job

transfer_appliance_label

(required) Label of the Transfer Appliance

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datatransfer.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TRANSFER_APPLIANCES Function

Lists Transfer Appliances associated with a transferJob

Syntax

FUNCTION list_transfer_appliances (
  id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_appliance_list_transfer_appliances_response_t;

Parameters

Parameter Description

id

(required) ID of the Transfer Job

lifecycle_state

(optional) filtering by lifecycleState

Allowed values are: 'REQUESTED', 'ORACLE_PREPARING', 'SHIPPING', 'DELIVERED', 'PREPARING', 'FINALIZED', 'RETURN_LABEL_REQUESTED', 'RETURN_LABEL_GENERATING', 'RETURN_LABEL_AVAILABLE', 'RETURN_DELAYED', 'RETURN_SHIPPED', 'RETURN_SHIPPED_CANCELLED', 'ORACLE_RECEIVED', 'ORACLE_RECEIVED_CANCELLED', 'PROCESSING', 'COMPLETE', 'CUSTOMER_NEVER_RECEIVED', 'ORACLE_NEVER_RECEIVED', 'CUSTOMER_LOST', 'CANCELLED', 'DELETED', 'REJECTED', 'ERROR'

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datatransfer.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_TRANSFER_APPLIANCE Function

Updates a Transfer Appliance

Syntax

FUNCTION update_transfer_appliance (
  id varchar2,
  transfer_appliance_label varchar2,
  update_transfer_appliance_details dbms_cloud_oci_dts_update_transfer_appliance_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_appliance_update_transfer_appliance_response_t;

Parameters

Parameter Description

id

(required) ID of the Transfer Job

transfer_appliance_label

(required) Label of the Transfer Appliance

update_transfer_appliance_details

(required) fields to update

if_match

(optional) The entity tag to match. Optional, if set, the update will be successful only if the object's tag matches the tag specified in the request.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datatransfer.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.