fwRelik.SSHSetup 1.0.2

dotnet add package fwRelik.SSHSetup --version 1.0.2
NuGet\Install-Package fwRelik.SSHSetup -Version 1.0.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="fwRelik.SSHSetup" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add fwRelik.SSHSetup --version 1.0.2
#r "nuget: fwRelik.SSHSetup, 1.0.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install fwRelik.SSHSetup as a Cake Addin
#addin nuget:?package=fwRelik.SSHSetup&version=1.0.2

// Install fwRelik.SSHSetup as a Cake Tool
#tool nuget:?package=fwRelik.SSHSetup&version=1.0.2

fwRelik.SSHSetup

Provides the ability to install and configure OpenSSH for Windows.

Under the hood, the process mainly uses the fwRelik.Terminal library.

SSHConfigurator Class

  • Namespace: fwRelik.SSHSetup
  • Assembly: fwRelik.SSHSetup.dll

Is a general assembler of main classes. Initializes the core services at the time the SSHConfigurator is declared.

📋 Methods

Methods Description
FirewallRule Returns the FirewallRuleControl instance.
Package Returns the PackageControl instance.
SSHService Returns the SSHServiceControl instance.
NetworkInfo Returns the NetworkInfo instance.

FirewallRuleControl Class

  • Namespace: fwRelik.SSHSetup.Extensions
  • Assembly: fwRelik.SSHSetup.dll

📋 Fields

Fields Description
RuleState Provides the state of the firewall rule, default is false.

📋 Methods

Methods Description
SetFirewallRule Sets the rule for the firewall.
RemoveFirewallRule Removes the rule for the firewall.
GetFirewallRule Receives the rule of the firewall.

PackageControl Class

  • Namespace: fwRelik.SSHSetup.Extensions
  • Assembly: fwRelik.SSHSetup.dll

📋 Methods

Methods Description
CheckPackage Returns the condition of all packages.
PackageManagment Selectively installing or deleting the specified packages. If true, the packages are installed. Otherwise, they will be removed. Default value: true
CheckPackageForInitializaitonValue Returns the logical value if all the necessary packages are installed. Will return true if all the necessary packages are installed.
GetPackagesState Returns the state of the packages from the class instance. Does not in any way check for the presence of packages, it simply returns a status that is determined by actions such as installing and removing packages. To initialize the correct state, use the CheckPackageForInitializaitonValue or CheckPackage method.

SSHServiceControl Class

  • Namespace: fwRelik.SSHSetup.Extensions
  • Assembly: fwRelik.SSHSetup.dll

📋 Fields

Fields Description
ServiceStatus Service state for this session.
ServiceStartupType Display service start mode.

📋 Methods

Methods Description
Set Sets the service to the given value. Default value is SSHServiceStartupType.Automatic. The name of the "sshd" service, currently cannot be changed.
Start Starts the service. If the status of the SSHServiceStartupType.Disabled service will throw out the exception, since the deactivated service cannot be launched.
Restart Restart the service. If the status of the SSHServiceStartupType.Disabled service will throw out the exception, since the deactivated service cannot be launched.
Stop Stop the service.
GetServiceStatus Receives the state of the service.

NetworkInfo Class

  • Namespace: fwRelik.SSHSetup.Extensions
  • Assembly: fwRelik.SSHSetup.dll

📋 Fields

Fields Description
HostName Host name this device.
UserName The name of the current user.
IpAddresses IP address belonging to this device.
ConnectionCount The number of connections to this device.

📋 Methods

Methods Description
GetNetworkConnectionStatus Checks network connectivity.
GetConnections Receives all connections to this device.
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.2 226 3/10/2023
1.0.1 205 3/8/2023
1.0.0 204 3/4/2023
0.1.3 226 3/2/2023
0.1.2 205 3/2/2023
0.1.0 227 3/1/2023