Longhorn
@hivemq/longhornv2026.03.25.3
01Models
@hivemq/longhornv2026.03.24.1longhorn.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| kubeContext | string | Kubernetes context name (e.g. dev-harvester, prod-harvester) |
| longhornNamespace | string | Namespace where Longhorn is installed |
fn listClasses(filter?: string)
List storage classes provisioned by Longhorn with their parameters
| Argument | Type | Description |
|---|---|---|
| filter? | string | Only return storage classes whose name contains this string |
fn listVolumes(filter?: string, unhealthyOnly?: boolean)
List Longhorn volumes with their state, robustness, and associated workloads
| Argument | Type | Description |
|---|---|---|
| filter? | string | Only return volumes whose PVC name or workload name contains this string |
| unhealthyOnly? | boolean | Only return volumes that are not healthy (degraded, faulted, unknown) |
fn volumeHealth(filter: string)
Check volume health with replica placement for a filtered set of volumes
| Argument | Type | Description |
|---|---|---|
| filter | string | Filter volumes by PVC name or workload name |
fn createClass(name: string, numberOfReplicas: number, diskSelector?: string, nodeSelector?: string, migratable: boolean, reclaimPolicy: enum, dataEngine: enum, encrypted: boolean, staleReplicaTimeout: number)
Create a Longhorn storage class with the specified parameters
| Argument | Type | Description |
|---|---|---|
| name | string | Storage class name |
| numberOfReplicas | number | Number of Longhorn replicas (1-3) |
| diskSelector? | string | Longhorn disk tag selector (e.g. disk-primary, disk-secondary) |
| nodeSelector? | string | Longhorn node tag selector |
| migratable | boolean | Allow live migration of volumes |
| reclaimPolicy | enum | Reclaim policy for PVs |
| dataEngine | enum | Longhorn data engine version |
| encrypted | boolean | Enable volume encryption |
| staleReplicaTimeout | number | Minutes before a stale replica is removed |
fn deleteClass(name: string)
Delete a Longhorn storage class by name
| Argument | Type | Description |
|---|---|---|
| name | string | Storage class name to delete |
fn nodeHealth(filter?: string)
Check Longhorn node health including disk status and storage capacity
| Argument | Type | Description |
|---|---|---|
| filter? | string | Only return nodes whose name contains this string |
fn listPods(labelSelector?: string, filter?: string)
List pods in the Longhorn namespace with their pod IPs and node assignments
| Argument | Type | Description |
|---|---|---|
| labelSelector? | string | Kubernetes label selector (e.g. app=longhorn-manager) |
| filter? | string | Filter results by pod name, node name, or pod IP |
fn getSettings(filter?: string)
Get Longhorn settings, optionally filtered by name substring
| Argument | Type | Description |
|---|---|---|
| filter? | string | Only return settings whose name contains this string |
Resources
storageClass(infinite)— Longhorn storage class definition
volume(infinite)— Longhorn volume with workload and health info
replica(infinite)— Longhorn volume replica placement
node(infinite)— Longhorn node with disk health
managerPod(infinite)— Longhorn manager pod with IP and node mapping
setting(infinite)— Longhorn setting
summary(infinite)— Summary of a query operation
02Previous Versions
2026.03.25.1Mar 25, 2026
2026.03.24.57Mar 24, 2026
2026.03.24.53Mar 24, 2026
2026.03.24.51Mar 24, 2026
2026.03.19.2Mar 19, 2026
03Stats
F
33 / 100
Downloads
3
Archive size
367.5 KB
- Has README or module doc0/2missing
- README has a code example0/1missing
- README is substantive0/1pending
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description0/1missing
- Platform support declared (or universal)2/2earned
- License declared0/1missing
- Verified public repository0/2missing
04Platforms