Remove Sftp Folder
Zuletzt geändert: 14.03.2026 05:56

Remove-SftpFolder #

ÜBERSICHT #

Entfernt ein Verzeichnis auf einem SFTP-Server.

SYNTAX #

Remove-SftpFolder [-Server] <string> [[-Port] <int>] [[-Certificate] <string>] [-User] <string>
    [[-Password] <securestring>] [[-PlainPassword] <string>] [[-PasswordPath] <string>]
    [-RemoteFolder] <string> [-Force] [<CommonParameters>]

BESCHREIBUNG #

Die Funktion löscht das angegebene Verzeichnis auf einem entfernten SFTP-Server. Der angegebene Pfad wird automatisch normalisiert. Das zu löschende Verzeichnis muss leer sein, sofern der Server keine rekursive Löschung unterstützt. Existiert das angegebene Verzeichnis nicht, schlägt der Löschvorgang fehl.

Unterstützt werden unterschiedliche Methoden zur Authentifizierung wie Klartext-Passwort, SecureString, Passwort-Datei und Zertifikat.

Die SFTP-Sitzung wird nach der Ausführung automatisch beendet.

PARAMETER #

-Server #

Type: string

Adresse oder Hostname des SFTP-Servers.

-Port #

Type: int
Default: 22

TCP-Port des SFTP-Servers (Standard: 22).

-Certificate #

Type: string

Pfad zur Privatschlüsseldatei für zertifikatsbasierte Authentifizierung.

-User #

Type: string

Benutzername zur Authentifizierung.

-Password #

Type: securestring

Passwort als SecureString.

-PlainPassword #

Type: string

Passwort im Klartext, intern in SecureString umgewandelt.

-PasswordPath #

Type: string

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

-RemoteFolder #

Type: string

Pfad des zu löschenden Verzeichnisses auf dem SFTP-Server. Der Pfad wird automatisch normalisiert (abschließende ‘/’ werden entfernt). Sollte der Ordner nicht existieren, wird $false zurückgeliefert. Der Ordner muss leer sein, sollen Ordner gelöscht werden die Inhalte haben, so kann der Parameter -Force gesetzt werden.

-Force #

Type: switch

Wird dieser angegeben, so werden auch Ordner mit Inhalten und Unterordnern gelöscht.

AUSGABEN #

bool

Gibt $true zurück, wenn das Löschen erfolgreich war; andernfalls $false. Sollte der Ordner nicht existieren, wird ebenfalls $true zurückgeliefert, aber zusätzlich eine Warnung ausgegeben.

BEISPIELE #

# Löscht das Verzeichnis '/uploads/daten' mit Klartextpasswort
Remove-SftpFolder -Server "sftp.example.com" -User "user1" -PlainPassword "meinPasswort" -RemoteFolder "/uploads/daten"

# Löscht das Verzeichnis '/uploads/daten' mit SecureString-Passwort
$securePwd = ConvertTo-SecureString "meinPasswort" -AsPlainText -Force
Remove-SftpFolder -Server "sftp.example.com" -User "user1" -Password $securePwd -RemoteFolder "/uploads/daten"

# Löscht das Verzeichnis '/uploads/daten' mittels Zertifikatsauthentifizierung
Remove-SftpFolder -Server "sftp.example.com" -User "user1" -Certificate "C:\Keys\privatekey.pem" -RemoteFolder "/uploads/daten"

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.
  • Prüfen Sie, ob das zu löschende Verzeichnis leer ist oder ob der Server rekursive Löschung unterstützt.