machine

Documentation

Overview

The machine package implements the API interfaces used by the machine agent.

Index

• type AgentAPI
  • func NewAgentAPI(st *state.State, auth common.Authorizer) (*AgentAPI, error)
  • func (api *AgentAPI) GetMachines(args params.Entities) params.MachineAgentGetMachinesResults
• type MachinerAPI
  • func NewMachinerAPI(st *state.State, resources *common.Resources, authorizer common.Authorizer) (*MachinerAPI, error)
  • func (m *MachinerAPI) EnsureDead(args params.Entities) (params.ErrorResults, error)
  • func (m *MachinerAPI) SetStatus(args params.MachinesSetStatus) (params.ErrorResults, error)
  • func (m *MachinerAPI) Watch(args params.Entities) (params.NotifyWatchResults, error)

Types

type AgentAPI

type AgentAPI struct {
	*common.PasswordChanger
	// contains filtered or unexported fields
}

func NewAgentAPI

func NewAgentAPI(st *state.State, auth common.Authorizer) (*AgentAPI, error)

NewAgentAPI returns an object implementing the machine agent API with the given authorizer representing the currently logged in client.

func (*AgentAPI) GetMachines

func (api *AgentAPI) GetMachines(args params.Entities) params.MachineAgentGetMachinesResults

type MachinerAPI

type MachinerAPI struct {
	*common.LifeGetter
	// contains filtered or unexported fields
}

MachinerAPI implements the API used by the machiner worker.

func NewMachinerAPI

func NewMachinerAPI(st *state.State, resources *common.Resources, authorizer common.Authorizer) (*MachinerAPI, error)

NewMachinerAPI creates a new instance of the Machiner API.

func (*MachinerAPI) EnsureDead

func (m *MachinerAPI) EnsureDead(args params.Entities) (params.ErrorResults, error)

EnsureDead changes the lifecycle of each given machine to Dead if it's Alive or Dying. It does nothing otherwise.

func (*MachinerAPI) SetStatus

func (m *MachinerAPI) SetStatus(args params.MachinesSetStatus) (params.ErrorResults, error)

SetStatus sets the status of each given machine.

func (*MachinerAPI) Watch

func (m *MachinerAPI) Watch(args params.Entities) (params.NotifyWatchResults, error)

Watch starts an NotifyWatcher for each given machine.