Client serves client-specific API methods.

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "Client"
VERSION: number = 2
_transport: Transport
NAME: string = "Client"
VERSION: number = 2

Methods

  • APIHostPorts returns the API host/port addresses stored in state.

    Parameters

    • params: any

    Returns Promise<APIHostPortsResult>

  • AbortCurrentUpgrade aborts and archives the current upgrade synchronisation record, if any.

    Parameters

    • params: any

    Returns Promise<any>

  • NOTE: AddCharm is deprecated as of juju 2.9 and charms facade version 3. Please discontinue use and move to the charms facade version.

    TODO: remove in juju 3.0

    Parameters

    Returns Promise<any>

  • AddCharmWithAuthorization adds the given charm URL (which must include revision) to the model, if it does not exist yet. Local charms are not supported, only charm store URLs. See also AddLocalCharm().

    The authorization macaroon, args.CharmStoreMacaroon, may be omitted, in which case this call is equivalent to AddCharm.

    NOTE: AddCharmWithAuthorization is deprecated as of juju 2.9 and charms facade version 3. Please discontinue use and move to the charms facade version.

    TODO: remove in juju 3.0

    Parameters

    Returns Promise<any>

  • AgentVersion returns the current version that the API server is running.

    Parameters

    • params: any

    Returns Promise<AgentVersionResult>

  • CACert returns the certificate used to validate the state connection.

    Parameters

    • params: any

    Returns Promise<BytesResult>

  • DestroyMachines removes a given set of machines.

    Parameters

    Returns Promise<any>

  • FullStatus gives the information needed for juju status over the api

    Parameters

    Returns Promise<FullStatus>

  • GetBundleChanges returns the list of changes required to deploy the given bundle data. The changes are sorted by requirements, so that they can be applied in order. This call is deprecated, clients should use the GetChanges endpoint on the Bundle facade. Note: any new feature in the future like devices will never be supported here.

    Parameters

    Returns Promise<BundleChangesResults>

  • GetModelConstraints returns the constraints for the model.

    Parameters

    • params: any

    Returns Promise<GetConstraintsResults>

  • ModelGet implements the server-side part of the model-config CLI command.

    Parameters

    • params: any

    Returns Promise<ModelConfigResults>

  • ModelInfo returns information about the current model.

    Parameters

    • params: any

    Returns Promise<ModelInfo>

  • ModelSet implements the server-side part of the set-model-config CLI command.

    Parameters

    Returns Promise<any>

  • ModelUnset implements the server-side part of the set-model-config CLI command.

    Parameters

    Returns Promise<any>

  • ModelUserInfo returns information on all users in the model.

    Parameters

    • params: any

    Returns Promise<ModelUserInfoResults>

  • ResolveCharm resolves the best available charm URLs with series, for charm locations without a series specified.

    NOTE: ResolveCharms is deprecated as of juju 2.9 and charms facade version 3. Please discontinue use and move to the charms facade version.

    TODO: remove in juju 3.0

    Parameters

    Returns Promise<ResolveCharmResults>

  • Resolved implements the server side of Client.Resolved.

    Parameters

    Returns Promise<any>

  • RetryProvisioning marks a provisioning error as transient on the machines.

    Parameters

    Returns Promise<ErrorResults>

  • SLALevel returns the current sla level for the model.

    Parameters

    • params: any

    Returns Promise<StringResult>

  • SetModelAgentVersion sets the model agent version.

    Parameters

    Returns Promise<any>

  • SetModelConstraints sets the constraints for the model.

    Parameters

    Returns Promise<any>

  • SetSLALevel sets the sla level on the model.

    Parameters

    Returns Promise<any>

  • WatchAll initiates a watcher for entities in the connected model.

    Parameters

    • params: any

    Returns Promise<AllWatcherId>

Generated using TypeDoc