Rebex
Products Downloads Buy Support Contact
Show / Hide Table of Contents

FileServerSettings Class

Namespace: Rebex.Net.Servers
Assembly: Rebex.FileServer.dll (version 8.0.9673)

File server settings.

Syntax
public class FileServerSettings : ServerSettings
Inheritance
Object
ServerSettings
FileServerSettings
Inherited Members
ServerSettings.AllowedAuthenticationMethods
ServerSettings.Banner
ServerSettings.IgnoreKeepAlive
ServerSettings.KeepAlivePeriod
ServerSettings.KeepSessionsAlive
ServerSettings.MaxAuthenticationAttempts
ServerSettings.MaxAuthenticationDuration
ServerSettings.MaxIdleDuration
ServerSettings.MaxPendingConnectionsQueueLength
ServerSettings.MaxSessionDuration
ServerSettings.MaxSessionTransferredBytes
ServerSettings.ReceiveBufferSize
ServerSettings.SendBufferSize
Object.Equals(Object)
Object.Equals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Object.ReferenceEquals(Object, Object)
Object.ToString()

Properties

Name Description
AcceptWindowsPaths

Gets or sets a value indicating whether the SFTP and FTP subsystems accepts Windows-like paths with drive letter, colon and backspaces. If accepted, these paths get normalized from 'd:\directory\file' form to '/d/directory/file' form.

AllowedAuthenticationMethods

Gets or sets authentication methods that server users can use by default. This can be overriden by PreAuthentication event handler. Please note that authentication methods must be enabled at the SSH level using Settings / AuthenticationMethods as well. Inherited from ServerSettings.

Banner

Gets or sets the SSH banner message announced to the client before authentication. Inherited from ServerSettings.

DiffieHellmanParametersCache

Gets or sets Diffie-Hellman parameters cache.

EnableEventsForFailedTransfers

Gets or sets a value indicating whether to raise FileDownloaded and/or FileUploaded events for incomplete transfers.

EnableReverseTunneling

Gets or sets a value indicating whether to enable SSH reverse tunneling.

FileShareMode

Gets or sets flags for controlling the kind of access others can have to an opened file.

ForceShellWelcomeMessage

Gets or sets a value indicating whether to show ShellWelcomeMessage on pseudoterminal-less shell sessions as well. By default, the welcome message is only shown for shell sessions with a pseudoterminal.

FtpAllowListOptions

Gets or sets a value indicating whether the 'LIST' command allows options (such as '-a'). If set to false, the 'LIST -a' command will try to list directory named '-a'. Default is true.

FtpControlProtection

Gets or sets a value indicating TLS protection mode of the control connection.

FtpDataPortRange

Gets or sets allowed port range for data connections in passive mode.

FtpDataProtection

Gets or sets a value indicating TLS protection mode of the data connection.
This option applies only to FTP over TLS in implicit or explicit mode; not applied for plain (unencrypted) FTP.

FtpDataTransferMaxIdleDuration

Gets or sets maximum duration of an idle data transfer (in seconds) before it is aborted by the server.

FtpEncoding

Gets or sets charset to be used by FTP subsystem.

FtpGetServerEndPoint

Gets or sets a function that enables to specify custom server's endpoint in reply to the 'PASV' command. The actual endpoint on which the server will listen for incoming data connection will remain unaffected.

FtpMaxIdleDuration

Gets or sets maximum duration of an idle session (in seconds) before it is closed by the server. If set to null, the value of MaxIdleDuration is used.

FtpRequireDataSessionResumption

Gets or sets a value indicating whether to require TLS session resumption for data connections.

FtpServerAddress

Gets or sets the server's public IPv4 address reported to FTP clients when establishing data connections in passive mode (using 'PASV' command). Usually needed for FTP servers behind firewalls.

FtpSiteCommandHandler

Gets or sets a function that makes it possible to implement simple custom 'SITE' commands.

GetItemInfoRequiresListPermission

Gets or sets a value indicating whether getting item info requires Read or List permission (used for FileServer.PathAccessAuthorization event). Default is false, which means getting item info requires Read permission.

IgnoreKeepAlive

Gets or sets a value indicating whether keep-alive packets are ignored when determining whether the client session has been idle. Inherited from ServerSettings.

KeepAlivePeriod

Gets or sets keep-alive period (in seconds). If the session has been inactive for the specified period, a a keep-alive packet is send to ensure it stays active. Inherited from ServerSettings.

KeepSessionsAlive

Gets or sets a value indicating whether to keep active sessions running when the server is stopped. Inherited from ServerSettings.

MaxAuthenticationAttempts

Gets or sets maximum number of authentication retry attempts on a single session. Inherited from ServerSettings.

MaxAuthenticationDuration

Gets or sets maximum duration of SSH authentication (in seconds) before the session is closed by the server. Inherited from ServerSettings.

MaxIdleDuration

Gets or sets maximum duration of an idle session (in seconds) before it is closed by the server. Inherited from ServerSettings.

MaxPendingConnectionsQueueLength

Specifies the maximum length of the pending connections queue. Inherited from ServerSettings.

MaxSessionDuration

Gets or sets maximum duration of a session (in seconds). When this duration expires, a session renegotiation occurs. Inherited from ServerSettings.

MaxSessionTransferredBytes

Gets or sets maximum number of bytes transferred during a session. When this value is reached, a session renegotiation occurs. Inherited from ServerSettings.

ReceiveBufferSize

Gets or sets a value (in bytes) that specifies the size of the buffer for incoming data. Inherited from ServerSettings.

SendBufferSize

Gets or sets a value (in bytes) that specifies the size of the buffer for outgoing data. Inherited from ServerSettings.

SftpEncoding

Gets or sets charset to be used by SFTP v3.

SftpMaxSendQueueLength

Maximum length of queue of outgoing SFTP response packets. When the queue is full, the SFTP subsystem will not process further SFTP client requests until the client receives some responses. Value of 0 indicates unlimited queue length.

SftpMaxVersion

Gets or sets maximum enabled SFTP version. Allowed values are 3, 4, or 5.

ShellEncoding

Gets or sets charset to be used by SCP subsystem.

ShellHostName

Gets or sets the server's host name for SCP subsystem.

ShellName

Gets or sets the shell name for SCP subsystem.

ShellPrompt

Gets or sets the user's prompt for SCP subsystem.

ShellSystemType

Gets or sets the system type for SCP subsystem.

ShellSystemVersion

Gets or sets the system version for SCP subsystem.

ShellWelcomeMessage

Gets or sets the user's welcome message for SCP subsystem.

ShowHiddenItems

Gets or sets a value indicating whether to show hidden files and directories in listings. Default is true.

SshParameters

Gets or sets SSH parameters.

TlsParameters

Gets or sets various TLS parameters.

UseNativeFilesystem

Gets or sets a value indicating whether to prefer filesystem access through Win32 API (native) or through System.IO.

In This Article
© REBEX ČR s.r.o. Back to top
Privacy policy
Manage cookies