Class default

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

APIHostPorts returns the API server addresses.

AvailabilityZone returns a provider-specific availability zone for each given machine entity

CACert returns the certificate used to validate the state connection.

Constraints returns the constraints for each given machine entity.

ContainerConfig returns information from the model config that is needed for container cloud-init.

ContainerManagerConfig returns information from the model config that is needed for configuring the container manager.

ControllerAPIInfoForModels returns the controller api connection details for the specified models.

ControllerConfig returns the controller's configuration.

DistributionGroup returns, for each given machine entity, a slice of instance.Ids that belong to the same distribution group as that machine. This information may be used to distribute instances for high availability.

DistributionGroupByMachineId returns, for each given machine entity, a slice of machine.Ids that belong to the same distribution group as that machine. This information may be used to distribute instances for high availability.

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).

FindTools returns a List containing all tools matching the given parameters.

GetContainerInterfaceInfo returns information to configure networking for a container. It accepts container tags as arguments.

GetContainerProfileInfo returns information to configure a lxd profile(s) for a container based on the charms deployed to the container. It accepts container tags as arguments. Unlike machineLXDProfileNames which has the environ write the lxd profiles and returns the names of profiles already written.

HostChangesForContainers returns the set of changes that need to be done to the host machine to prepare it for the containers to be created. Pass in a list of the containers that you want the changes for.

InstanceId returns the provider specific instance id for each given machine or an CodeNotProvisioned error, if not set.

InstanceStatus returns the instance status for each given entity. Only machine tags are accepted.

KeepInstance returns the keep-instance value for each given machine entity.

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

MachinesWithTransientErrors returns status data for machines with provisioning errors which are transient.

MarkMachinesForRemoval indicates that the specified machines are ready to have any provider-level resources cleaned up and then be removed.

ModelConfig returns the current model's configuration.

ModelUUID returns the model UUID that the current connection is for.

PrepareContainerInterfaceInfo allocates an address and returns information to configure networking for a container. It accepts container tags as arguments.

ProvisioningInfo returns the provisioning information for each given machine entity. It supports all positive space constraints.

ReleaseContainerAddresses finds addresses allocated to a container and marks them as Dead, to be released and removed. It accepts container tags as arguments.

Remove removes every given entity from state, calling EnsureDead first, then Remove. It will fail if the entity is not present.

SetCharmProfiles records the given slice of charm profile names.

SetInstanceInfo sets the provider specific machine id, nonce, metadata and network info for each given machine. Once set, the instance id cannot be changed.

SetInstanceStatus updates the instance status for each given entity. Only machine tags are accepted.

SetModificationStatus updates the instance whilst changes are occurring. This is different from SetStatus and SetInstanceStatus, by the fact this holds information about the ongoing changes that are happening to instances. Consider LXD Profile updates that can modify a instance, but may not cause the instance to be placed into a error state. This modification status serves the purpose of highlighting that to the operator. Only machine tags are accepted.

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.

SetPasswords sets the given password for each supplied entity, if possible.

SetStatus sets the status of each given entity.

SetSupportedContainers updates the list of containers supported by the machines passed in args.

Status returns the status of each given entity.

SupportedContainers returns the list of containers supported by the machines passed in args.

Tools finds the tools necessary for the given agents.

WatchAPIHostPorts watches the API server addresses.

WatchAllContainers starts a StringsWatcher to watch all containers deployed to any machine passed in args.

WatchContainers starts a StringsWatcher to watch containers deployed to any machine passed in args.

WatchForModelConfigChanges returns a NotifyWatcher that observes changes to the model configuration. Note that although the NotifyWatchResult contains an Error field, it's not used because we are only returning a single watcher, so we use the regular error return.

WatchMachineErrorRetry returns a NotifyWatcher that notifies when the provisioner should retry provisioning machines with transient errors.

WatchModelMachineStartTimes watches the non-container machines in the model for changes to the Life or AgentStartTime fields and reports them as a batch.

WatchModelMachines returns a StringsWatcher that notifies of changes to the life cycles of the top level machines in the current model.