copyFromSFTP

Copies a file directly from a secure SFTP server to an Oracle Fusion Cloud Enterprise Performance Management environment.

Using this command, you can copy a file directly from an SFTP server without first downloading it to another server using an SFTP client and then using EPM Automate or the REST API to upload it to Cloud EPM.

If IP allowlist is enabled for the SFTP server, you must add the outbound IP address of the OCI region that hosts the Cloud EPM environments to the IP allowlist of the SFTP server. See Outbound IP Addresses of Cloud EPM Data Centers and Regions in the Operations Guide for the outbound IP addresses of OCI regions.

Note:

This command supports SFTP server running on port 22 only. This command supports these ciphers, MACs, key exchange algorithms, and host key algorithms. The SFTP server must have at least one of them in each required category.

Table 2-2 Supported Cryptographic Algorithms

Cryptographic Algorithm Type	Supported Algorithms
Ciphers	[e-mail], aes128-ctr, aes192-ctr, aes256-ctr, [e-mail], [e-mail], aes128-cbc,aes192-cbc, aes256-cbc
MACs	[e-mail], [e-mail], [e-mail], hmac-sha2-256, hmac-sha2-512, hmac-sha1
Key Exchange Algorithms	sntrup761x25519-sha512, [e-mail], curve25519-sha256, [e-mail], curve448-sha512, ecdh-sha2-nistp521, ecdh-sha2-nistp384, ecdh-sha2-nistp256, diffie-hellman-group-exchange-sha256, diffie-hellman-group18-sha512, diffie-hellman-group17-sha512, diffie-hellman-group16-sha512, diffie-hellman-group15-sha512, diffie-hellman-group14-sha256
Host Key Algorithms	[e-mail], [e-mail], [e-mail], [e-mail], [e-mail], [e-mail], ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, ecdsa-sha2-nistp521, ssh-ed25519, [e-mail], [e-mail], rsa-sha2-512,rsa-sha2-256, ssh-rsa

Applies to

Planning, Planning Modules, FreeForm, Financial Consolidation and Close, Tax Reporting, Account Reconciliation, Profitability and Cost Management, Enterprise Profitability and Cost Management, Oracle Enterprise Data Management Cloud, Narrative Reporting, Strategic Workforce Planning, and Sales Planning.

Required Roles

• Service Administrator
• Any predefined role and the Migrations - Administer granular role

Usage

epmautomate copyFromSftp SFTP_SERVER_URL FILE_NAME username=USERNAME [password=PASSWORD] [privateKey=KEY_FILE] [passPhrase=PASSPHRASE] where:

• SFTP_SERVER_URL is the URL of the SFTP server including the location and name of the file you want to copy from the server.
• FILE_NAME is the file name for the file in the Cloud EPM environment. Specify the path, for example, if you are not copying to the default upload location.
• USERNAME is the ID of a user who has the required access rights on SFTP server.
• PASSWORD, optionally, is the SFTP user password. Required if you are not using a private key to access the SFTP server.
• KEY_FILE, optionally, is the name and path of the private key (PEM) file stored on your computer. Required if you are not using a plain text password to authenticate the user.
• PASSPHRASE, optionally, is the passphrase used to protect the encryption key. Required only if a passphrase is used to encrypt the private key.

Examples

• Using a username and plain text password:

  epmautomate copyFromSftp sftp://mySFTP_Server/someDirectory/someFile.csv myFile.csv username=jdoe password=Sftpwelcome

• Using a username and unprotected private key for authentication:

  epmautomate copyFromSftp sftp://mySFTP_Server/someDirectory/someFile.csv myFile.csv username=jdoe privateKey= ~/.oci/sftp_key.pem

• Using a username and a passphrase-protected private key for authentication:

  epmautomate copyFromSftp sftp://mySFTP_Server/someDirectory/some_file.csv myFile.csv username=jDoe privateKey=~/.oci/sftp_key.pem passphrase=myPassPhrase