@canonical/jujulib/dist/api/facades/sshclient/SSHClientV2.d.ts

Juju API client

/**
  Juju SSHClient version 2.
  This facade is available on:
    Controller-machine-agent
    Machine-agent
    Unit-agent
    Models

  NOTE: This file was generated using the Juju schema
  from Juju 3.0-beta1 at the git SHA 61c87ab7e1.
  Do not manually edit this file.
*/
import { ConnectionInfo, Transport } from "../../client.js";
import { Facade } from "../../types.js";
export interface Entities {
    entities: Entity[];
}
export interface Entity {
    tag: string;
}
export interface Error {
    code: string;
    info?: AdditionalProperties;
    message: string;
}
export interface SSHAddressResult {
    address?: string;
    error?: Error;
}
export interface SSHAddressResults {
    results: SSHAddressResult[];
}
export interface SSHAddressesResult {
    addresses: string[];
    error?: Error;
}
export interface SSHAddressesResults {
    results: SSHAddressesResult[];
}
export interface SSHProxyResult {
    "use-proxy": boolean;
}
export interface SSHPublicKeysResult {
    error?: Error;
    "public-keys"?: string[];
}
export interface SSHPublicKeysResults {
    results: SSHPublicKeysResult[];
}
export interface AdditionalProperties {
    [key: string]: any;
}
/**
  Facade implements the API required by the sshclient worker.
*/
declare class SSHClientV2 implements Facade {
    static NAME: string;
    static VERSION: number;
    NAME: string;
    VERSION: number;
    _transport: Transport;
    _info: ConnectionInfo;
    constructor(transport: Transport, info: ConnectionInfo);
    /**
      AllAddresses reports all addresses that might have SSH listening for each given
      entity in args. Machines and units are supported as entity types.
      TODO(wpk): 2017-05-17 This is a temporary solution, we should not fetch environ here
      but get the addresses from state. We will be changing it since we want to have space-aware
      SSH settings.
    */
    allAddresses(params: Entities): Promise<SSHAddressesResults>;
    /**
      PrivateAddress reports the preferred private network address for one or
      more entities. Machines and units are supported.
    */
    privateAddress(params: Entities): Promise<SSHAddressResults>;
    /**
      Proxy returns whether SSH connections should be proxied through the
      controller hosts for the model associated with the API connection.
    */
    proxy(params: any): Promise<SSHProxyResult>;
    /**
      PublicAddress reports the preferred public network address for one
      or more entities. Machines and units are supported.
    */
    publicAddress(params: Entities): Promise<SSHAddressResults>;
    /**
      PublicKeys returns the public SSH hosts for one or more
      entities. Machines and units are supported.
    */
    publicKeys(params: Entities): Promise<SSHPublicKeysResults>;
}
export default SSHClientV2;