---
title: PodInfo
sidebar_label: PodInfo
sidebar_position: 2
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lium.io/llms.txt
> Use this file to discover all available pages before exploring further.

<!-- Generated by scripts/generate_sdk_reference.py. Do not edit directly. -->

# PodInfo

```python
from lium.sdk import PodInfo
```

Defined in `lium.sdk.models`.

```python
PodInfo(
    id: str,
    name: str,
    status: str,
    huid: str,
    ssh_cmd: Optional[str],
    ports: Dict,
    created_at: str,
    updated_at: str,
    executor: Optional[lium.sdk.models.ExecutorInfo],
    template: Dict,
    removal_scheduled_at: Optional[str],
    jupyter_installation_status: Optional[str],
    jupyter_url: Optional[str],
    enable_volume_encryption: bool | None = None,
    volume_encryption_status: str | None = None,
    estimated_ready_seconds: int | None = None,
    eta_basis: str | None = None,
    phase: str | None = None,
    gpu_count: Optional[int] = None,
    workspace_id: Optional[str] = None,
    cluster_id: Optional[str] = None,
    cluster_node_index: Optional[int] = None,
    cluster_overlay_ip: Optional[str] = None,
    api_key_id: Optional[str] = None,
    api_key_name: Optional[str] = None,
    api_key_stamped: bool = False
)
```

## Fields

| Name | Type | Default |
| --- | --- | --- |
| `id` | str |  |
| `name` | str |  |
| `status` | str |  |
| `huid` | str |  |
| `ssh_cmd` | Optional[str] |  |
| `ports` | Dict |  |
| `created_at` | str |  |
| `updated_at` | str |  |
| `executor` | Optional[[ExecutorInfo](/developers/sdk/reference/models/executor-info)] |  |
| `template` | Dict |  |
| `removal_scheduled_at` | Optional[str] |  |
| `jupyter_installation_status` | Optional[str] |  |
| `jupyter_url` | Optional[str] |  |
| `enable_volume_encryption` | bool | None | `None` |
| `volume_encryption_status` | str | None | `None` |
| `estimated_ready_seconds` | int | None | `None` |
| `eta_basis` | str | None | `None` |
| `phase` | str | None | `None` |
| `gpu_count` | Optional[int] | `None` |
| `workspace_id` | Optional[str] | `None` |
| `cluster_id` | Optional[str] | `None` |
| `cluster_node_index` | Optional[int] | `None` |
| `cluster_overlay_ip` | Optional[str] | `None` |
| `api_key_id` | Optional[str] | `None` |
| `api_key_name` | Optional[str] | `None` |
| `api_key_stamped` | bool | `False` |

## Properties

| Name | Type | Description |
| --- | --- | --- |
| `host` | Optional[str] |  |
| `username` | Optional[str] |  |
| `ssh_port` | int | Extract SSH port from command. |
| `volume_path` | str | Return the pod's local volume mount path. |
| `default_restore_path` | str | Return a safe restore destination below the local volume mount. |

## Methods

| Method | Description |
| --- | --- |
| [`eta_hint`](#eta_hint) | One line for a pod that is still starting, e.g. est. ready in ~18 s (phase: pulling image). |

### eta_hint

```python
def eta_hint() -> Optional[str]:
```

One line for a pod that is still starting, e.g. ``est. ready in ~18 s (phase: pulling image)``.

``None`` when the API sent neither an estimate nor a phase (older backend, or the pod is
already RUNNING).