Receive-SftpFile #

ÜBERSICHT #

Lädt eine Datei von einem SFTP-Server herunter und speichert diese lokal.

SYNTAX #

Receive-SftpFile [-Server] <string> [[-Port] <int>] [[-Certificate] <string>] [-User] <string>
    [[-Password] <securestring>] [[-PlainPassword] <string>] [[-PasswordPath] <string>]
    [[-RemoteFolder] <string>] [-RemoteFile] <string> [[-LocalFolder] <string>] [[-LocalFile]
    <string>] [<CommonParameters>]

BESCHREIBUNG #

Diese Funktion verbindet sich per SFTP zu einem Remote-Server und lädt eine angegebene Datei herunter. Unterstützt werden unterschiedliche Methoden zur Authentifizierung wie Klartext-Passwort, SecureString, Passwort-Datei und Zertifikat.

Der lokale Zielordner wird automatisch erstellt, falls er nicht existiert. Bei abweichendem lokalem Dateinamen nutzt die Funktion intern einen temporären Ordner, um Anforderungen der POSH-SSH-Bibliothek gerecht zu werden.

Benötigt das Modul POSH-SSH.

PARAMETER #

-Server #

Type: string

Hostname oder IP-Adresse des SFTP-Servers.

-Port #

Type: int
Default: 22

TCP-Port für die SFTP-Verbindung (Standard: 22).

-User #

Type: string

Benutzername zur Anmeldung am SFTP-Server.

-Password #

Type: securestring

Sicheres Passwort als SecureString (ParameterSet ‘secure’).

-PlainPassword #

Type: string

Passwort im Klartext (ParameterSet ‘plain’).

-PasswordPath #

Type: string

Pfad zu einer Datei mit Passwort (ParameterSet ‘file’).

-Certificate #

Type: string

Pfad zu einer privaten Schlüsseldatei (optional, z.B. *.ppk, *.pem).

-RemoteFolder #

Type: string
Default: ""

Ordner auf dem SFTP-Server (optional).

-RemoteFile #

Type: string

Name der Datei auf dem SFTP-Server (erforderlich).

-LocalFolder #

Type: string

Lokales Zielverzeichnis. Wenn dieser nicht angegeben ist, wird das aktuelle Verzeichnis über Get-Location verwendet.

-LocalFile #

Type: string

Optionaler lokaler Dateiname; wenn nicht angegeben, wird der Remote-Dateiname genutzt.

AUSGABEN #

string, void

Gibt den vollständigen lokalen Pfad der heruntergeladenen Datei zurück.

BEISPIELE #

# Lädt 'log.txt' herunter und speichert die Datei in 'C:\temp\log.txt'.
Receive-SftpFile -Server "sftp.example.com" -User "admin" -PlainPassword "secret" -RemoteFile "log.txt" -LocalFolder "C:\temp"

# Lädt 'log.txt' herunter und speichert sie lokal als 'logfile.txt' im Ordner 'C:\temp'.
Receive-SftpFile -Server "sftp.example.com" -User "admin" -Password $securePwd -RemoteFile "log.txt" -LocalFolder "C:\temp" -LocalFile "logfile.txt"

HINWEISE #

Benötigt das Modul POSH-SSH. Installation: Install-Module -Name POSH-SSH -Repository PSGallery
Intern geöffnete SFTP-Sitzungen werden automatisch nach Beendigung dieser Funktion geschlossen.