Facade implements the API required by the sshclient worker.

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "SSHClient"
VERSION: number = 4
_transport: Transport
NAME: string = "SSHClient"
VERSION: number = 4

Methods

  • AllAddresses reports all addresses that might have SSH listening for each entity in args. The result is sorted with public addresses first. Machines and units are supported as entity types.

    Parameters

    Returns Promise<SSHAddressesResults>

  • ModelCredentialForSSH returns a cloud spec for ssh purpose. This facade call is only used for k8s model.

    Parameters

    • params: any

    Returns Promise<CloudSpecResult>

  • PrivateAddress reports the preferred private network address for one or more entities. Machines and units are supported.

    Parameters

    Returns Promise<SSHAddressResults>

  • Proxy returns whether SSH connections should be proxied through the controller hosts for the model associated with the API connection.

    Parameters

    • params: any

    Returns Promise<SSHProxyResult>

  • PublicAddress reports the preferred public network address for one or more entities. Machines and units are supported.

    Parameters

    Returns Promise<SSHAddressResults>

Generated using TypeDoc