FirewallerAPI provides access to the Firewaller API facade.

Hierarchy

  • default

Implements

Constructors

Properties

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

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>

  • GetExposeInfo returns the expose flag and per-endpoint expose settings for the specified applications.

    Parameters

    Returns Promise<ExposeInfoResults>

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

  • ModelFirewallRules returns the firewall rules that this model is configured to open

    Parameters

    • params: any

    Returns Promise<IngressRulesResult>

  • OpenedMachinePortRanges returns a list of the opened port ranges for the specified machines where each result is broken down by unit. The list of opened ports for each unit is further grouped by endpoint name and includes the subnet CIDRs that belong to the space that each endpoint is bound to.

    Parameters

    Returns Promise<OpenMachinePortRangesResults>

  • SetRelationsStatus sets the status for the specified relations.

    Parameters

    Returns Promise<ErrorResults>

  • SpaceInfos returns a comprehensive representation of either all spaces or a filtered subset of the known spaces and their associated subnet details.

    Parameters

    Returns Promise<SpaceInfos>

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

  • WatchModelFirewallRules returns a NotifyWatcher that notifies of potential changes to a model's configured firewall rules

    Parameters

    • params: any

    Returns Promise<NotifyWatchResult>

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

  • WatchSubnets returns a new StringsWatcher that watches the specified subnet tags or all tags if no entities are specified.

    Parameters

    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