Remove-SFTPItem

NAME Remove-SFTPItem



SYNOPSIS

Deletes the specified item on a SFTP session.





SYNTAX

Remove-SFTPItem [-SessionId] <Int32[]> [-Path] <String> [-Force] [<CommonParameters>]



Remove-SFTPItem [-SFTPSession] <SftpSession[]> [-Path] <String> [-Force] [<CommonParameters>]





DESCRIPTION

Deletes the specified item on a SFTP session.





PARAMETERS

-SessionId <Int32[]>

SFTP Session Id of an exiting session.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Path <String>

Path of item to be removed on remote host.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

Force the deletion of a none empty directory by recursively deleting all files in it.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-SFTPSession <SftpSession[]>

SFTP Session Object of an exiting session.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.Int32[]





SSH.SftpSession[]







OUTPUTS



NOTES









Example 1



PS C:\\> {{ Add example code here }}



{{ Add example description here }}



RELATED LINKS

Online Version: https://github.com/darkoperator/Posh-SS ... aster/docs