MachinerAPI implements the API used by the machiner worker.

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "Machiner"
VERSION: number = 4
_transport: Transport
NAME: string = "Machiner"
VERSION: number = 4

Methods

  • APIAddresses returns the list of addresses used to connect to the API.

    Parameters

    • params: any

    Returns Promise<StringsResult>

  • APIHostPorts returns the API server addresses.

    Parameters

    • params: any

    Returns Promise<APIHostPortsResult>

  • EnsureDead calls EnsureDead on each given entity from state. It will fail if the entity is not present. If it's Alive, nothing will happen (see state/EnsureDead() for units or machines).

    Parameters

    Returns Promise<ErrorResults>

  • Jobs returns the jobs assigned to the given entities.

    Parameters

    Returns Promise<JobsResults>

  • Life returns the life status of every supplied entity, where available.

    Parameters

    Returns Promise<LifeResults>

  • ModelUUID returns the model UUID to connect to the model that the current connection is for.

    Parameters

    • params: any

    Returns Promise<StringResult>

  • RecordAgentStartTime updates the agent start time field in the machine doc.

    Parameters

    Returns Promise<ErrorResults>

  • SetObservedNetworkConfig reads the network config for the machine identified by the input args. This config is merged with the new network config supplied in the same args and updated if it has changed.

    Parameters

    Returns Promise<any>

  • UpdateStatus updates the status data of each given entity. TODO(fwereade): WTF. This method exists only for the convenience of the client API -- and is itself completely broken -- but we still expose it in every facade with a StatusSetter? FFS.

    Parameters

    Returns Promise<ErrorResults>

  • WatchAPIHostPorts watches the API server addresses.

    Parameters

    • params: any

    Returns Promise<NotifyWatchResult>

Generated using TypeDoc