Remove-SftpFile #
ÜBERSICHT #
Löscht eine Datei von einem SFTP-Server.
SYNTAX #
Remove-SftpFile [-Server] <string> [[-Port] <int>] [[-Certificate] <string>] [-User] <string>
[[-Password] <securestring>] [[-PlainPassword] <string>] [[-PasswordPath] <string>]
[[-RemoteFolder] <string>] [-RemoteFile] <string> [<CommonParameters>]
BESCHREIBUNG #
Diese Funktion verbindet sich per SFTP mit einem Server und löscht die angegebene Datei. Unterstützt werden unterschiedliche Methoden zur Authentifizierung wie Klartext-Passwort, SecureString, Passwort-Datei und Zertifikat.
Existiert die angegebene Datei auf dem Server nicht, gibt die Funktion False zurück und erzeugt eine Warnung.
Nutzt intern das Modul POSH-SS
PARAMETER #
-Server #
Type: string
Hostname oder IP des SFTP-Servers.
-Port #
Type: int
Default: 22
TCP-Port des SFTP-Servers (Standard: 22).
-User #
Type: string
Benutzername zur Anmeldung am Server.
-Password #
Type: securestring
Passwort als SecureString (ParameterSet ‘secure’).
-PlainPassword #
Type: string
Klartext-Passwort (ParameterSet ‘plain’). Wird intern zu SecureString konvertiert.
-PasswordPath #
Type: string
Pfad zu einer Datei mit Passwort (ParameterSet ‘file’).
-Certificate #
Type: string
Pfad zu privater Schlüsseldatei (*.ppk, *.pem) für Zertifikats-Authentifizierung.
-RemoteFolder #
Type: string
Default: ""
Ordnerpfad auf dem SFTP-Server. Wird der Parameter nicht angegeben, erfolgt das Löschen der Datei aus dem Benutzer-Home-Verzeichnis.
-RemoteFile #
Type: string
Name der Datei, die gelöscht werden soll.
AUSGABEN #
bool
True bei Erfolg, False bei Fehler.
BEISPIELE #
# Löscht 'test.txt' im Stammverzeichnis.
Remove-SftpFile -Server 'sftp.example.com' -User 'root' -PlainPassword 'secret' -RemoteFile 'test.txt'
VERWANDTE LINKS #
- Get-SftpDir
- Get-SftpFileAge
- Get-SftpFileDate
- Get-SftpFileSize
- Get-SftpOldestFilename
- New-SftpFolder
- Receive-SftpFile
- Remove-SftpFolder
- Rename-SftpFileX
- Rename-SftpFolder
- Send-SftpFile
- Test-SftpFile
- Test-SftpFingerprint
- Test-SftpFolder
- Test-SftpPort
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.