YaST2 Developers Documentation: Configuration of SSHD

Configuration of SSHD

modules/Sshd.ycp
SSHD settings, input and output functions
  • Lukas Ocilka
  • Representation of the configuration of SSHD.
  • Input and output routines.

This module has an unstable interface.

Imports

  • Message
  • Mode
  • Popup
  • Progress
  • Report
  • SCR
  • Service
  • SuSEFirewall

Structures

Global Functions

Local Variables

Local Functions

local modified -> boolean

Data was modified?

local sl -> integer

Sleep time between Read or Write steps

global GetModified () -> boolean

Returns whether the configuration has been modified.

global SetModified () -> void

Sets that the configuration has been modified.

local SETTINGS -> map <string, list<string> >

map of SSHD settings

local ReadSSHDSettings () -> boolean

Reads current sshd configuration

local WriteSSHDSettings () -> boolean

Writes current sshd configuration

global GetSSHDOption (string option_key) -> list <string>

Returns the SSHD Option as a list of strings.

Parameters:
option_key
Return value:
with option_values
global GetDefaultSSHDOption (string option_key) -> list <string>

Returns default SSHD Option as a list of strings.

Parameters:
option_key
Return value:
with option_values
global SetSSHDOption (string option_key, list <string> option_vals) -> void

Sets values for an option.

Parameters:
option_key
option_vals
local sshd_is_running -> boolean

Describes whether the daemon is running

local ReadSSHDService () -> boolean

Reads current sshd status

global Export () -> map

Exports the current configuration.

Structure $[

   "config" : (map <string, list<string> >) SETTINGS,
   "status" : (boolean) service_status,
 ]
Return value:
of a current configuration
global Import (map import_map) -> boolean

Imports a configuration

Parameters:
import_map
local WriteSSHDService () -> boolean

Restarts the sshd when the daemon was running when starting the configuration

global Abort () -> boolean

Returns a confirmation popup dialog whether user wants to really abort.

global PollAbort () -> boolean

Checks whether an Abort button has been pressed. If so, calls function to confirm the abort call.

Return value:
true if abort confirmed
global Read () -> boolean

Read all SSHD settings

Return value:
true on success
global Write () -> boolean

Write all SSHD settings

Return value:
true on success