Class default

RebootAPI provides access to the Upgrader API facade.

Hierarchy

  • default

Implements

Constructors

constructor

Properties

NAME VERSION _info _transport NAME VERSION

Methods

clearReboot getRebootAction requestReboot watchForRebootEvent

Constructors

constructor

Properties

NAME

NAME: string = "Reboot"

VERSION

VERSION: number = 2

_info

_info: ConnectionInfo

_transport

_transport: Transport

Static NAME

NAME: string = "Reboot"

Static VERSION

VERSION: number = 2

Methods

clearReboot

  • ClearReboot will clear the reboot flag on provided machines, if it exists.

    Parameters

    Returns Promise<ErrorResults>

getRebootAction

  • GetRebootAction returns the action a machine agent should take. If a reboot flag is set on the machine, then that machine is expected to reboot (params.ShouldReboot). a reboot flag set on the machine parent or grandparent, will cause the machine to shutdown (params.ShouldShutdown). If no reboot flag is set, the machine should do nothing (params.ShouldDoNothing).

    Parameters

    Returns Promise<RebootActionResults>

requestReboot

  • RequestReboot sets the reboot flag on the provided machines

    Parameters

    Returns Promise<ErrorResults>

watchForRebootEvent

  • WatchForRebootEvent starts a watcher to track if there is a new reboot request on the machines ID or any of its parents (in case we are a container).

    Parameters

    • params: any

    Returns Promise<NotifyWatchResult>

Settings

Member Visibility

Theme

Generated using TypeDoc