Interface IOpenShellClient

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

The entry point to the OpenShell gateway API, for mocking and dependency injection.

public interface IOpenShellClient : IDisposable

Inherited Members

IDisposable.Dispose()

Properties

Config

Sandbox and gateway configuration.

IConfigClient Config { get; }

Property Value

IConfigClient

Exec

Command execution.

IExecClient Exec { get; }

Property Value

IExecClient

Files

File transfer.

IFileClient Files { get; }

Property Value

IFileClient

Health

Health and identity.

IHealthClient Health { get; }

Property Value

IHealthClient

Policy

Draft policy review and policy revisions.

IPolicyClient Policy { get; }

Property Value

IPolicyClient

Providers

Providers, profiles and credential refresh.

IProviderClient Providers { get; }

Property Value

IProviderClient

Rootfs

Local rootfs tar staging for drivers that boot from an archive.

IRootfsClient Rootfs { get; }

Property Value

IRootfsClient

SandboxProviders

Provider attachment and readiness for sandboxes.

ISandboxProviderClient SandboxProviders { get; }

Property Value

ISandboxProviderClient

Sandboxes

Sandbox lifecycle.

ISandboxClient Sandboxes { get; }

Property Value

ISandboxClient

Services

Service exposure.

IServiceClient Services { get; }

Property Value

IServiceClient

Ssh

SSH relay sessions and tunnels.

ISshClient Ssh { get; }

Property Value

ISshClient

Tcp

TCP forwarding to sandbox ports.

ITcpClient Tcp { get; }

Property Value

ITcpClient

Templates

Reusable sandbox workload templates.

ISandboxTemplateClient Templates { get; }

Property Value

ISandboxTemplateClient

Watch

Watch streams and logs.

ISandboxWatchClient Watch { get; }

Property Value

ISandboxWatchClient

Workspace

The workspace this view operates in.

string Workspace { get; }

Property Value

string

Workspaces

Workspace and membership management.

IWorkspaceClient Workspaces { get; }

Property Value

IWorkspaceClient

Methods

InWorkspace(string)

Returns a view of this client bound to another workspace; the connection is shared.

IOpenShellClient InWorkspace(string workspace)

Parameters

workspace string

Returns

IOpenShellClient