machinemanager

Documentation

Index

• Variables
• type Client
  • func ConstructClient(clientFacade base.ClientFacade, facadeCaller base.FacadeCaller) *Client
  • func NewClient(st base.APICallCloser, options ...Option) *Client
  • func (client *Client) AddMachines(ctx context.Context, machineParams []params.AddMachineParams) ([]params.AddMachinesResult, error)
  • func (client *Client) DestroyMachinesWithParams(ctx context.Context, force, keep, dryRun bool, maxWait *time.Duration, ...) ([]params.DestroyMachineResult, error)
  • func (c *Client) ModelUUID() (string, bool)
  • func (c *Client) ProvisioningScript(ctx context.Context, args params.ProvisioningScriptParams) (script string, err error)
  • func (c *Client) RetryProvisioning(ctx context.Context, all bool, machines ...names.MachineTag) ([]params.ErrorResult, error)
• type Option

Variables

var WithTracer = base.WithTracer

WithTracer returns an Option that configures the Client to use the supplied tracer.

Types

type Client

type Client struct {
	base.ClientFacade
	// contains filtered or unexported fields
}

Client provides access to the machinemanager, used to add machines to state.

func ConstructClient

func ConstructClient(clientFacade base.ClientFacade, facadeCaller base.FacadeCaller) *Client

ConstructClient is a constructor function for a machine manager client

func NewClient

func NewClient(st base.APICallCloser, options ...Option) *Client

NewClient returns a new machinemanager client.

func (*Client) AddMachines

func (client *Client) AddMachines(ctx context.Context, machineParams []params.AddMachineParams) ([]params.AddMachinesResult, error)

AddMachines adds new machines with the supplied parameters, creating any requested disks.

func (*Client) DestroyMachinesWithParams

func (client *Client) DestroyMachinesWithParams(ctx context.Context, force, keep, dryRun bool, maxWait *time.Duration, machines ...string) ([]params.DestroyMachineResult, error)

DestroyMachinesWithParams removes the given set of machines, the semantics of which is determined by the force and keep parameters.

func (*Client) ModelUUID

func (c *Client) ModelUUID() (string, bool)

ModelUUID returns the model UUID from the client connection.

func (*Client) ProvisioningScript

func (c *Client) ProvisioningScript(ctx context.Context, args params.ProvisioningScriptParams) (script string, err error)

ProvisioningScript returns a shell script that, when run, provisions a machine agent on the machine executing the script.

func (*Client) RetryProvisioning

func (c *Client) RetryProvisioning(ctx context.Context, all bool, machines ...names.MachineTag) ([]params.ErrorResult, error)

RetryProvisioning updates the provisioning status of a machine allowing the provisioner to retry.

type Option

type Option = base.Option

Option is a function that can be used to configure a Client.