FirewallerAPIV5 provides access to the Firewaller v5 API facade.

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "Firewaller"
VERSION: number = 5
_transport: Transport
NAME: string = "Firewaller"
VERSION: number = 5

Methods

  • AreManuallyProvisioned returns whether each given entity is manually provisioned or not. Only machine tags are accepted.

    Parameters

    Returns Promise<BoolResults>

  • ControllerConfig returns the controller's configuration.

    Parameters

    • params: any

    Returns Promise<ControllerConfigResult>

  • GetAssignedMachine returns the assigned machine tag (if any) for each given unit.

    Parameters

    Returns Promise<StringResults>

  • GetCloudSpec constructs the CloudSpec for a validated and authorized model.

    Parameters

    Returns Promise<CloudSpecResult>

  • GetExposed returns the exposed flag value for each given application.

    Parameters

    Returns Promise<BoolResults>

  • GetMachineActiveSubnets returns the tags of the all subnets that each machine (in args) has open ports on.

    Parameters

    Returns Promise<StringsResults>

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

    Parameters

    Returns Promise<StringResults>

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

    Parameters

    Returns Promise<LifeResults>

  • MacaroonForRelations returns the macaroon for the specified relations.

    Parameters

    Returns Promise<MacaroonResults>

  • ModelConfig returns the current model's configuration.

    Parameters

    • params: any

    Returns Promise<ModelConfigResult>

  • SetRelationsStatus sets the status for the specified relations.

    Parameters

    Returns Promise<ErrorResults>

  • WatchEgressAddressesForRelations creates a watcher that notifies when addresses, from which connections will originate for the relation, change. Each event contains the entire set of addresses which are required for ingress for the relation.

    Parameters

    Returns Promise<StringsWatchResults>

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

    Parameters

    • params: any

    Returns Promise<NotifyWatchResult>

  • WatchIngressAddressesForRelations creates a watcher that returns the ingress networks that have been recorded against the specified relations.

    Parameters

    Returns Promise<StringsWatchResults>

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

    Parameters

    • params: any

    Returns Promise<StringsWatchResult>

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

    Parameters

    • params: any

    Returns Promise<StringsWatchResult>

  • WatchUnits starts a StringsWatcher to watch all units belonging to to any entity (machine or service) passed in args.

    Parameters

    Returns Promise<StringsWatchResults>

Generated using TypeDoc