riaps.rfab package

Subpackages

• riaps.rfab.api package
  • Submodules
    • riaps.rfab.api.deplo module
      • DeploDisable
      • DeploEnable
      • DeploJournal
      • DeploRestart
      • DeploStart
      • DeploStartManual
      • DeploStatus
      • DeploStop
    • riaps.rfab.api.exceptions module
      • RFabException
    • riaps.rfab.api.riaps module
      • GetAppLogsTask
      • PycomInstallTask
      • PycomUninstallTask
      • ResetTask
      • SetSecurityTask
      • TimesyncInstallTask
      • TimesyncUninstallTask
      • UpdateAptKey
      • UpdateControl
      • UpdateLogConfig
      • UpdateNodeKey
      • UpdateRemote
      • UpdateRiapsConfig
    • riaps.rfab.api.sys module
      • SysArch
      • SysCheck
      • SysClearJournal
      • SysFlushIPTables
      • SysGet
      • SysGetConfig
      • SysPut
      • SysReboot
      • SysRun
      • SysShutdown
      • SysSudo
    • riaps.rfab.api.task module
      • BadExit
      • Result
      • Result_to_log()
      • STATE
      • SkipResult
      • Task
      • TaskRunner
      • TransferResult_to_log()
    • riaps.rfab.api.timesync module
      • TimeConfig
      • TimeDate
      • TimeRdate
      • TimeRestart
      • TimeStatus
    • riaps.rfab.api.utils module
      • isIPaddress()
      • load_hostfile()
      • load_role()
      • make_log_folder()
  • Module contents

Submodules

• riaps.rfab.main module
  • main()
• riaps.rfab.test module

Module contents

class riaps.rfab.RfabProgram(version: str | None = None, namespace: Collection | None = None, name: str | None = None, binary: str | None = None, loader_class: Type[Loader] | None = None, executor_class: Type[Executor] | None = None, config_class: Type[Config] | None = None, binary_names: List[str] | None = None)

Bases: Program

core_args() → List[Argument]

Return default core .Argument objects, as a list.

New in version 1.0.

update_config(merge: bool = True) → None

Update the previously instantiated .Config with parsed data.

For example, this is how --echo is able to override the default config value for run.echo.

Parameters:

merge (bool) – Whether to merge at the end, or defer. Primarily useful for subclassers. Default: True.

New in version 1.0.