File system Download
CertifiedDownload a file over SMB
File system Download
Download a file over SMB
Fetches a single file from an SMB/CIFS share to internal storage. Default port 445.
type: io.kestra.plugin.fs.smb.DownloadExamples
id: fs_smb_download
namespace: company.team
tasks:
- id: download
type: io.kestra.plugin.fs.smb.Download
host: localhost
port: "445"
username: foo
password: "{{ secret('SMB_PASSWORD') }}"
from: "/my_share/file.txt"
Download a file and fail if its SHA-256 checksum does not match
id: fs_smb_download_checksum
namespace: company.team
tasks:
- id: download
type: io.kestra.plugin.fs.smb.Download
host: localhost
port: "445"
username: foo
password: "{{ secret('SMB_PASSWORD') }}"
from: "/my_share/file.txt"
validateChecksum: true
checksumExpected: "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
Properties
from *Requiredstring
Source URI to download
host *Requiredstring
Remote host
checksumAlgorithm string
SHA_256MD5SHA_1SHA_256SHA_512Checksum algorithm to use
Defaults to SHA_256. The computed checksum is always exposed on the output as checksum. MD5 and SHA_1 are deprecated and considered weak; prefer SHA_256 or SHA_512.
checksumExpected string
Expected checksum value to compare against the downloaded file
Required when validateChecksum is true. Comparison is case-insensitive.
password string
Password
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
port string
445Remote port
username string
Username
validateChecksum booleanstring
falseValidate the downloaded file against an expected checksum
When enabled, the task fails if the computed checksum does not match checksumExpected. The downloaded file is not stored in internal storage if validation fails.
Outputs
checksum string
Checksum of the downloaded file
Hex-encoded digest computed with checksumAlgorithm. Populated whenever the file is downloaded successfully.
from string
uriThe fully-qualified URIs that point to source data
to string
uriThe fully-qualified URIs that point to destination path
