> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo/gym/v0.4.0/nemo-gym/nemo_gym/sandbox/providers/opensandbox/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nemo/gym/_mcp/server.

# nemo_gym.sandbox.providers.opensandbox

OpenSandbox provider package.

## Submodules

* **[`nemo_gym.sandbox.providers.opensandbox.cleanup_sandboxes`](/nemo/gym/nemo-gym/nemo_gym/sandbox/providers/opensandbox/cleanup_sandboxes)**
* **[`nemo_gym.sandbox.providers.opensandbox.failures`](/nemo/gym/nemo-gym/nemo_gym/sandbox/providers/opensandbox/failures)**
* **[`nemo_gym.sandbox.providers.opensandbox.provider`](/nemo/gym/nemo-gym/nemo_gym/sandbox/providers/opensandbox/provider)**
* **[`nemo_gym.sandbox.providers.opensandbox.pty`](/nemo/gym/nemo-gym/nemo_gym/sandbox/providers/opensandbox/pty)**
* **[`nemo_gym.sandbox.providers.opensandbox.resource_telemetry`](/nemo/gym/nemo-gym/nemo_gym/sandbox/providers/opensandbox/resource_telemetry)**
* **[`nemo_gym.sandbox.providers.opensandbox.snapshots`](/nemo/gym/nemo-gym/nemo_gym/sandbox/providers/opensandbox/snapshots)**

## Package Contents

### Classes

| Name                                                                                                          | Description                                                 |
| ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| [`OpenSandboxConnectionConfig`](#nemo_gym-sandbox-providers-opensandbox-provider-OpenSandboxConnectionConfig) | OpenSandbox server connection settings.                     |
| [`OpenSandboxCreateConfig`](#nemo_gym-sandbox-providers-opensandbox-provider-OpenSandboxCreateConfig)         | OpenSandbox create/reconnect retry settings.                |
| [`OpenSandboxOperationConfig`](#nemo_gym-sandbox-providers-opensandbox-provider-OpenSandboxOperationConfig)   | Retry and timeout settings for SDK operations after create. |
| [`OpenSandboxProbeConfig`](#nemo_gym-sandbox-providers-opensandbox-provider-OpenSandboxProbeConfig)           | Post-create probe settings.                                 |
| [`OpenSandboxProvider`](#nemo_gym-sandbox-providers-opensandbox-provider-OpenSandboxProvider)                 | Provider backed by the OpenSandbox SDK/server API.          |

### Data

[`OpenSandboxAttributionConfig`](#nemo_gym-sandbox-providers-opensandbox-provider-OpenSandboxAttributionConfig)

### API

```python
class nemo_gym.sandbox.providers.opensandbox.OpenSandboxConnectionConfig(
    domain: str | None = None,
    api_key: str | None = None,
    protocol: str | None = None,
    request_timeout_s: int | None = None,
    use_server_proxy: bool = False,
    disable_connection_pooling: bool = False,
    keepalive_expiry_s: float | None = 3.0,
    max_keepalive_connections: int = 20,
    max_connections: int | None = 100,
    connect_retries: int = 2,
    transport_backend: str = 'aiohttp',
    tls_verify: bool = False
)
```

Dataclass

OpenSandbox server connection settings.

With the legacy httpx backend, `keepalive_expiry_s` must stay below the
server's own keep-alive idle timeout (uvicorn defaults to 5s), or sockets are reused after the
server has closed them; null falls back to the SDK's default transport only
when certificate verification is enabled and pooling is not disabled.
`transport_backend=aiohttp` uses Gym's global client and connector limits;
provider-local pooling settings apply only to `transport_backend=httpx`.
With the explicit legacy combination `transport_backend=httpx`,
`keepalive_expiry_s=None` and `tls_verify=True` (pooling enabled), the
SDK owns its default transport. SDK 0.1.15 then discards command-status 410
bodies; lifecycle evidence remains available independently of that response.
`tls_verify` applies to every connection the provider opens (SDK transport
and PTY sockets) and is off by
default; set it for endpoints whose certificate the client can verify.
`domain` may carry its scheme (`https://sandbox.example`). The scheme is
moved into `protocol` and takes precedence over a configured `protocol`,
so every URL the provider builds itself (the PTY WebSocket target) agrees
with the SDK's base URL; the SDK receives the host plus any path prefix
(`sandbox.example:8080/prefix`). The SDK would accept a scheme in
`domain` on its own, but the provider reads `protocol` directly, hence
the normalization here. Only `scheme://host[:port][/path-prefix]` is
accepted: a query string or fragment is a configuration error.

**`api_key`** `str | None = None`

---

**`connect_retries`** `int = 2`

---

**`disable_connection_pooling`** `bool = False`

---

**`domain`** `str | None = None`

---

**`keepalive_expiry_s`** `float | None = 3.0`

---

**`max_connections`** `int | None = 100`

---

**`max_keepalive_connections`** `int = 20`

---

**`protocol`** `str | None = None`

---

**`request_timeout_s`** `int | None = None`

---

**`tls_verify`** `bool = False`

---

**`transport_backend`** `str = 'aiohttp'`

---

**`use_server_proxy`** `bool = False`

---

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxConnectionConfig.__post_init__() -> None
```

```python
class nemo_gym.sandbox.providers.opensandbox.OpenSandboxCreateConfig(
    request_timeout_s: int | None = None,
    timeout_s: float | None = None,
    retries: int = 2,
    retry_delay_s: float = 5.0,
    retry_max_delay_s: float = 60.0,
    fail_fast_on_pending: bool = False,
    image_pull_policy: str | None = DEFAULT_IMAGE_PULL_POLICY,
    skip_health_check: bool = False,
    connect_attempt_timeout_s: float = 30.0,
    connect_poll_s: float = 2.0,
    renew_interval_s: float | None = None,
    outcome_policy: nemo_gym.sandbox.providers.opensandbox.provider.OpenSandboxCreateOutcomePolicy = OpenSandboxCreateOutcomePol...
)
```

Dataclass

OpenSandbox create/reconnect retry settings.

**`connect_attempt_timeout_s`** `float = 30.0`

---

**`connect_poll_s`** `float = 2.0`

---

**`fail_fast_on_pending`** `bool = False`

---

**`image_pull_policy`** `str | None = DEFAULT_IMAGE_PULL_POLICY`

---

**`outcome_policy`** `OpenSandboxCreateOutcomePolicy`

---

**`renew_interval_s`** `float | None = None`

---

**`request_timeout_s`** `int | None = None`

---

**`retries`** `int = 2`

---

**`retry_delay_s`** `float = 5.0`

---

**`retry_max_delay_s`** `float = 60.0`

---

**`skip_health_check`** `bool = False`

---

**`timeout_s`** `float | None = None`

---

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxCreateConfig.__post_init__() -> None
```

```python
class nemo_gym.sandbox.providers.opensandbox.OpenSandboxOperationConfig(
    retries: int = 3,
    retry_delay_s: float = 1.0,
    retry_max_delay_s: float = 15.0,
    command_retries: int = 0,
    outcome_policy: nemo_gym.sandbox.providers.opensandbox.provider.OpenSandboxOutcomePolicy | collections.abc.Mapping[str, typing.Any] = OpenSandboxOutcomePolicy(),
    command_timeout_headroom_s: float = 60.0,
    status_recovery_timeout_s: float = 300.0,
    exec_hard_cap_slack_s: float = 30.0,
    close_timeout_s: float | None = 30.0,
    pause_resume_timeout_s: float = 600.0,
    background_exec: bool = False,
    background_poll_initial_s: float = 0.25,
    background_poll_interval_s: float = 2.0,
    status_poll_timeout_s: float | None = 10.0
)
```

Dataclass

Retry and timeout settings for SDK operations after create.

**`background_exec`** `bool = False`

---

**`background_poll_initial_s`** `float = 0.25`

---

**`background_poll_interval_s`** `float = 2.0`

---

**`close_timeout_s`** `float | None = 30.0`

---

**`command_retries`** `int = 0`

---

**`command_timeout_headroom_s`** `float = 60.0`

---

**`exec_hard_cap_slack_s`** `float = 30.0`

---

**`outcome_policy`** `OpenSandboxOutcomePolicy | Mapping[str, Any] = field(default_factory=OpenSandboxOutcomePolicy)`

---

**`pause_resume_timeout_s`** `float = 600.0`

---

**`retries`** `int = 3`

---

**`retry_delay_s`** `float = 1.0`

---

**`retry_max_delay_s`** `float = 15.0`

---

**`status_poll_timeout_s`** `float | None = 10.0`

---

**`status_recovery_timeout_s`** `float = 300.0`

---

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxOperationConfig.__post_init__() -> None
```

```python
class nemo_gym.sandbox.providers.opensandbox.OpenSandboxProbeConfig(
    command: str | None = 'printf nemo-gym-sandbox-re...,
    expected_stdout: str | None = 'nemo-gym-sandbox-ready',
    timeout_s: int = 30,
    deadline_s: float | None = None,
    stable_count: int = 1,
    stable_delay_s: float = 0.0,
    user: str | int | None = None
)
```

Dataclass

Post-create probe settings.

**`command`** `str | None = 'printf nemo-gym-sandbox-ready'`

---

**`deadline_s`** `float | None = None`

---

**`expected_stdout`** `str | None = 'nemo-gym-sandbox-ready'`

---

**`stable_count`** `int = 1`

---

**`stable_delay_s`** `float = 0.0`

---

**`timeout_s`** `int = 30`

---

**`user`** `str | int | None = None`

---

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProbeConfig.__post_init__() -> None
```

```python
class nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider(
    connection: nemo_gym.sandbox.providers.opensandbox.provider.OpenSandboxConnectionConfig | collections.abc.Mapping[str, typing.Any] | None = None,
    create: nemo_gym.sandbox.providers.opensandbox.provider.OpenSandboxCreateConfig | collections.abc.Mapping[str, typing.Any] | None = None,
    probe: nemo_gym.sandbox.providers.opensandbox.provider.OpenSandboxProbeConfig | collections.abc.Mapping[str, typing.Any] | None = None,
    operations: nemo_gym.sandbox.providers.opensandbox.provider.OpenSandboxOperationConfig | collections.abc.Mapping[str, typing.Any] | None = None,
    diagnostics: nemo_gym.sandbox.providers.opensandbox.provider.OpenSandboxDiagnosticsConfig | collections.abc.Mapping[str, typing.Any] | None = None,
    attribution: nemo_gym.sandbox.providers.opensandbox.provider.OpenSandboxAttributionConfig | collections.abc.Mapping[str, typing.Any] | None = None,
    networking: nemo_gym.sandbox.providers.opensandbox.provider.OpenSandboxNetworkingConfig | collections.abc.Mapping[str, typing.Any] | None = None,
    shared_storage: nemo_gym.sandbox.providers.opensandbox.provider.OpenSandboxSharedStorageConfig | collections.abc.Mapping[str, typing.Any] | None = None,
    runtime_requirements: nemo_gym.sandbox.providers.opensandbox.provider.OpenSandboxRuntimeRequirementsConfig | collections.abc.Mapping[str, typing.Any] | None = None,
    images: nemo_gym.sandbox.providers.opensandbox.provider.OpenSandboxImagesConfig | collections.abc.Mapping[str, typing.Any] | None = None,
    setup: nemo_gym.sandbox.providers.opensandbox.provider.OpenSandboxSetupConfig | collections.abc.Mapping[str, typing.Any] | None = None
)
```

Provider backed by the OpenSandbox SDK/server API.

**`_attribution`**

---

**`_connection`**

---

**`_create`** `= _coerce_config(create, OpenSandboxCreateConfig)`

---

**`_diagnostics`**

---

**`_images`** `= _coerce_config(images, OpenSandboxImagesConfig)`

---

**`_networking`**

---

**`_operations`**

---

**`_probe`** `= _coerce_config(probe, OpenSandboxProbeConfig)`

---

**`_pty_sessions`** `set[Any] = set()`

---

**`_renewals`** `dict[str, Task[None]] = {}`

---

**`_runtime_requirements`**

---

**`_setup`** `= _coerce_config(setup, OpenSandboxSetupConfig)`

---

**`_shared_storage`**

---

**`_transport`** `Any | None = None`

---

**`name`** `= 'opensandbox'`

---

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._await_sdk_call(
    awaitable: typing.Any,
    operation: str,
    sandbox_id: str | None,
    timeout_s: float | None
) -> typing.Any
```

async

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._await_sdk_operation(
    operation_factory: typing.Callable[[], typing.Awaitable[typing.Any]],
    operation: str,
    sandbox_id: str | None,
    timeout_s: float | None,
    retries: int | None = None,
    is_retryable: typing.Callable[[BaseException], bool] | None = None,
    replay_safe: bool = False
) -> typing.Any
```

async

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._build_transport() -> typing.Any
```

Use Gym's global HTTP pool, or the explicitly selected legacy backend.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._cleanup_failed_create_handle(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle
) -> None
```

async

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._command_retry_count() -> int
```

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._connect_after_create(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    spec: nemo_gym.sandbox.providers.base.SandboxSpec
) -> nemo_gym.sandbox.providers.base.SandboxHandle
```

async

Reconnect after SDK create so follow-up calls use a fresh SDK handle.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._connection_config(
    request_timeout_s: int | float | None = None
) -> typing.Any
```

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._control_plane_inspect_oom_evidence(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    deadline: float
) -> str | None
```

async

Opt-in OpenSandbox 1.1.0 text fallback; no supported structured equivalent is assumed.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._create_budget(
    spec: nemo_gym.sandbox.providers.base.SandboxSpec
) -> tuple[float | None, int | float | None]
```

The per-attempt budget and the SDK request timeout for one create of `spec`.

The create request blocks until the pod is allocated, so a configured request timeout
(`create.request_timeout_s`, else `connection.request_timeout_s`) is capped at the spec's ready
timeout: an unschedulable pod then fails within one ready timeout instead of the full request
timeout. When none is configured the SDK's own default stays, as the connection config the create
is given lives on the handle for the sandbox's life.

The SDK's readiness wait starts only once the request returns, so the attempt budget must hold the
request bound plus `ready_timeout_s`. A configured `create.timeout_s` is respected as is (a
warning names it when it is below that sum); otherwise the budget is that sum plus a slack.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._create_once(
    spec: nemo_gym.sandbox.providers.base.SandboxSpec
) -> nemo_gym.sandbox.providers.base.SandboxHandle
```

async

Create a sandbox through `opensandbox.Sandbox.create`.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._create_with_retries(
    spec: nemo_gym.sandbox.providers.base.SandboxSpec
) -> nemo_gym.sandbox.providers.base.SandboxHandle
```

async

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._delete_sandboxes_by_metadata(
    scope: dict[str, str],
    attempt_key: str
) -> list[dict[str, typing.Any]]
```

async

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._exec(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    command: str,
    cwd: str | None = None,
    env: dict[str, str] | None = None,
    timeout_s: int | float | None = None,
    user: str | int | None = None,
    retries: int | None = None
) -> nemo_gym.sandbox.providers.base.SandboxExecResult
```

async

Run a command inside an OpenSandbox sandbox.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._exec_background(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    command: str,
    opts_kwargs: dict[str, typing.Any],
    sdk_timeout_s: float | None,
    total_timeout_s: int | float | None,
    retries: int
) -> nemo_gym.sandbox.providers.base.SandboxExecResult
```

async

Run a command as a background execution polled via short requests.

The logs endpoint returns one combined stream, so unlike the foreground
path `stdout` carries both streams and `stderr` is set only when the
sandbox itself reports an error.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._exec_setup_command(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    command: str
) -> nemo_gym.sandbox.providers.base.SandboxExecResult
```

async

One `setup.commands` entry as root, or as the image's own user when the sandbox cannot switch
identity.

An image with a non-root `USER` on a cell that drops `CAP_SETUID` refuses the switch before the command
runs (`nemo_gym.sandbox.transfer.exec_as_root` degrades the same way), so a command written to no-op where
it does not apply gets to no-op, and one that needs root there fails on its own result, as before.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._get_transport() -> typing.Any
```

Return the provider-owned shared transport, building it on first use.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._kill_with_retry(
    kill: typing.Callable[[], typing.Awaitable[None]],
    sandbox_id: str
) -> None
```

async

Apply the same idempotent deletion and permission guards to handles and orphan cleanup.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._pty_failure(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    cause: BaseException
) -> nemo_gym.core.typed_exceptions.NgFailureEvent
```

async

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._pty_http_client() -> typing.Any
```

Return the aiohttp client for one PTY session (same `tls_verify` as the SDK transport).

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._pty_session_missing(
    base_url: str,
    headers: dict[str, str],
    session_id: str,
    request_timeout_s: float | None
) -> bool
```

async

True only when execd itself reports the PTY session does not exist.

A proxy 404 (route not registered yet) lacks execd's error code, and a
failed check is treated as unknown so the attach proceeds as before.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._pty_target(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle
) -> tuple[str, dict[str, str], float | None]
```

async

Resolve the sandbox's execd base URL, headers and request timeout.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._raise_timed_out_create(
    cause: BaseException,
    spec: nemo_gym.sandbox.providers.base.SandboxSpec,
    metadata: dict[str, str],
    attempt_key: str,
    how: str
) -> typing.NoReturn
```

async

Reap what a timed-out create left behind and raise the error that describes it.

Report provider_create_pending only for an observed Pending sandbox; otherwise report
provider_create_timeout. The create policy chooses retry, with fail_fast_on_pending
preventing another attempt for a Pending sandbox when configured.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._reap_orphaned_create(
    metadata: dict[str, str],
    attempt_key: str
) -> list[dict[str, typing.Any]]
```

async

Find and delete the sandbox a timed-out create request left behind; return what was found.

The request never returned, so the client holds no sandbox id: the sandbox is found through the
run's attribution metadata and this attempt's unique key. Each match is deleted and described
(`id`, `state`, `reason`, `message`) so the caller can tell a pod that never left
`PENDING` from one that was merely slow. Failures are logged, never raised: the create's own
timeout error is the one the caller must see.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._resolve_extensions(
    extensions: collections.abc.Mapping[str, str]
) -> dict[str, str]
```

Add the configured default image pull policy to SDK create extensions.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._retire_closed_pty_sessions() -> None
```

async

Release sessions that ended on their own; their aiohttp client is
only freed by `close()`. Called from create/attach so the tracking
set cannot grow without bound.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._run_setup_commands(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle
) -> None
```

async

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._sandbox_death_evidence(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    deadline: float,
    poll: bool = True
) -> nemo_gym.sandbox.providers.opensandbox.provider._SandboxDeathNotice | None
```

async

One evidence path for exec and PTY, bounded by the caller's existing deadline.

Lifecycle reasons do not identify the affected container, so even OOMKilled
establishes only unavailability. A recognized control-plane container report
or optional inspect can confirm OOM for the current user container.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._start_renewal(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    ttl_s: int | float
) -> None
```

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._stop_renewal(
    sandbox_id: str
) -> BaseException | None
```

async

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._submit_command(
    operation_factory: typing.Callable[[], typing.Awaitable[typing.Any]],
    operation: str,
    sandbox_id: str,
    timeout_s: float | None,
    retries: int
) -> typing.Any
```

async

Submit once: neither a 502 nor a timeout proves non-delivery.

Command retry settings cannot override this safety constraint. The provider
has no idempotency key or authoritative non-delivery receipt.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._verify_created_handle(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle
) -> None
```

async

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider._write_file(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    target_path: str,
    data: str | bytes
) -> None
```

async

Write one file into an OpenSandbox sandbox.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.aclose() -> None
```

async

Close provider-owned resources.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.attach_pty(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    session_id: str,
    takeover: bool = True,
    since: int | None = None
) -> nemo_gym.sandbox.providers.base.SandboxPtySession
```

async

Re-attach to an existing execd PTY session by id.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.close(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle
) -> None
```

async

Terminate the sandbox and close local SDK resources.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.configure_runtime(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    cap_add: tuple[str, ...],
    shm_size: int | None
) -> None
```

async

Probe capabilities and verify the shared memory allocated at creation.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.connect(
    descriptor: collections.abc.Mapping[str, typing.Any]
) -> nemo_gym.sandbox.providers.base.SandboxHandle
```

async

Rebuild a live handle from an OpenSandbox sandbox id via the SDK.

Running sandboxes are health-checked unless the caller opts out. A
paused sandbox has no exec daemon to check; resume rebuilds its
endpoints and performs the health check instead.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.create(
    spec: nemo_gym.sandbox.providers.base.SandboxSpec
) -> nemo_gym.sandbox.providers.base.SandboxHandle
```

async

Create one sandbox through the configured OpenSandbox path.

Job attribution keys (`team` / `user` / `workload` / `run`) are merged into the
spec's metadata (explicit spec keys win) so every sandbox is attributable via its labels.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.create_pty(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    spec: nemo_gym.sandbox.providers.base.SandboxPtySpec
) -> nemo_gym.sandbox.providers.base.SandboxPtySession
```

async

Open an interactive execd PTY session inside a sandbox.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.download_file(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    source_path: str,
    target_path: pathlib.Path
) -> None
```

async

Download one file from an OpenSandbox sandbox, streamed to disk in chunks.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.endpoint(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    port: int
) -> nemo_gym.sandbox.providers.base.SandboxEndpoint
```

async

Resolve one client-reachable direct or server-proxied service URL.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.exec(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    command: str,
    cwd: str | None = None,
    env: dict[str, str] | None = None,
    timeout_s: int | float | None = None,
    user: str | int | None = None
) -> nemo_gym.sandbox.providers.base.SandboxExecResult
```

async

Run a command inside an OpenSandbox sandbox.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.exec_with_background_services(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    command: str,
    cwd: str | None = None,
    env: dict[str, str] | None = None,
    timeout_s: int | float | None = None,
    user: str | int | None = None
) -> nemo_gym.sandbox.providers.base.SandboxExecResult
```

async

Preserve background services that redirect their stdout and stderr.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.forward_ports(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    target_address: str,
    ports: tuple[int, ...],
    ready_file: str
) -> None
```

async

Run loopback listeners in a foreground command owned by the collection.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.network_address(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle
) -> str
```

async

Resolve a direct container IP, independently of client proxy mode.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.pause(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle
) -> None
```

async

Pause a sandbox and wait until it reports paused.

Local PTY clients are detached first, while execd can still answer the
close handshake; server sessions are never deleted, so they remain
attachable if the pause request fails. After resume, the Kubernetes
backend has replaced the runtime (open a new PTY); the Docker backend
thawed it (re-attach by id).

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.pull_policy_options(
    policy: str
) -> dict[str, typing.Any]
```

Compose's `pull_policy` as the per-sandbox image pull policy extension (`_resolve_extensions` lets a
per-sandbox value win over the deployment default).

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.resource_allocation(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle
) -> nemo_gym.sandbox.resource_telemetry.ResourceAllocation
```

async

Read effective requests and limits from the deployment's inspection endpoint.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.resource_sample(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle
) -> dict[str, str | int | float | bool]
```

async

Read execd's existing snapshot; preserve its timestamp and measurement names.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.resume(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle
) -> None
```

async

Resume a paused sandbox and rebuild its SDK clients and endpoints.

One `pause_resume_timeout_s` deadline covers the request, endpoint
rebuild and readiness check. On timeout the server-side state is
unknown: reconnect and check `status()` before retrying. See
`pause()` for what happens to PTY sessions.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.serialize_handle(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    scope: str | None = None
) -> dict[str, typing.Any]
```

async

Return a descriptor for reattaching to this sandbox by id.

OpenSandbox sandboxes are reachable by id from any process that has the
connection config, so the id alone is enough to reconnect and no sandbox
server is needed to share one. `scope` is ignored: OpenSandbox has no
lease concept of its own.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.set_hosts(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    hosts: collections.abc.Mapping[str, str]
) -> None
```

async

Append validated peer aliases to the sandbox hosts file.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.shared_volume_metadata() -> dict[str, str]
```

Return placement metadata required by the configured shared storage.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.shared_volume_options(
    source: str | None,
    target: str,
    read_only: bool = False
) -> dict[str, typing.Any]
```

Mount a project directory, or the shared root for bootstrap when source is None.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.status(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle
) -> nemo_gym.sandbox.providers.base.SandboxStatus
```

async

Return the current OpenSandbox lifecycle status.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.upload_file(
    handle: nemo_gym.sandbox.providers.base.SandboxHandle,
    source_path: pathlib.Path,
    target_path: str
) -> None
```

async

Upload one local file into an OpenSandbox sandbox.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.uploads_independent_of_execs() -> bool
```

A foreground command holds one of the shared HTTP pool's connections for as long as it runs, so
`max_connections` running commands leave an upload none; a background command is polled and holds none.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.validate_networking() -> None
```

Require explicit deployment support for inter-sandbox networking.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.validate_port_forwarding() -> None
```

Require explicit deployment support for loopback TCP listeners.

```python
nemo_gym.sandbox.providers.opensandbox.OpenSandboxProvider.validate_runtime_requirements(
    cap_add: tuple[str, ...],
    shm_size: int | None
) -> dict[str, str]
```

Reject requirements without an operator-configured implementation.

```python
nemo_gym.sandbox.providers.opensandbox.provider.OpenSandboxAttributionConfig = AttributionConfig
```

## Docs

- [nemo_gym.sandbox.providers.opensandbox.cleanup_sandboxes](https://docs.nvidia.com/nemo/gym/v0.4.0/nemo-gym/nemo_gym/sandbox/providers/opensandbox/cleanup_sandboxes.md)
- [nemo_gym.sandbox.providers.opensandbox.failures](https://docs.nvidia.com/nemo/gym/v0.4.0/nemo-gym/nemo_gym/sandbox/providers/opensandbox/failures.md)
- [nemo_gym.sandbox.providers.opensandbox.provider](https://docs.nvidia.com/nemo/gym/v0.4.0/nemo-gym/nemo_gym/sandbox/providers/opensandbox/provider.md)
- [nemo_gym.sandbox.providers.opensandbox.pty](https://docs.nvidia.com/nemo/gym/v0.4.0/nemo-gym/nemo_gym/sandbox/providers/opensandbox/pty.md)
- [nemo_gym.sandbox.providers.opensandbox.resource_telemetry](https://docs.nvidia.com/nemo/gym/v0.4.0/nemo-gym/nemo_gym/sandbox/providers/opensandbox/resource_telemetry.md)
- [nemo_gym.sandbox.providers.opensandbox.snapshots](https://docs.nvidia.com/nemo/gym/v0.4.0/nemo-gym/nemo_gym/sandbox/providers/opensandbox/snapshots.md)