Skip to content

netem endpoint #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FloSch62 merged 1 commit into from
Feb 8, 2026
Merged

netem endpoint #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
304 changes: 304 additions & 0 deletions docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1378,6 +1378,209 @@ const docTemplate = `{
}
}
},
"/api/v1/tools/netem/reset": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "Resets (removes) netem impairments from a specific interface of a containerlab node. Requires superuser privileges.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Tools - Netem"
],
"summary": "Reset link impairments (netem)",
"parameters": [
{
"description": "Netem Reset Parameters",
"name": "netem_reset_request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.NetemResetRequest"
}
}
],
"responses": {
"200": {
"description": "Impairments reset successfully",
"schema": {
"$ref": "#/definitions/models.GenericSuccessResponse"
}
},
"400": {
"description": "Invalid input parameters",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
},
"401": {
"description": "Unauthorized (JWT)",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
},
"403": {
"description": "Forbidden (User is not a superuser)",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
},
"404": {
"description": "Container or interface not found",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
}
},
"/api/v1/tools/netem/set": {
"post": {
"security": [
{
"BearerAuth": []
}
],
"description": "Sets netem impairments (delay, jitter, loss, rate limiting, corruption) on a specific interface of a containerlab node. Requires superuser privileges.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Tools - Netem"
],
"summary": "Set link impairments (netem)",
"parameters": [
{
"description": "Netem Set Parameters",
"name": "netem_set_request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.NetemSetRequest"
}
}
],
"responses": {
"200": {
"description": "Impairments set successfully",
"schema": {
"$ref": "#/definitions/models.GenericSuccessResponse"
}
},
"400": {
"description": "Invalid input parameters",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
},
"401": {
"description": "Unauthorized (JWT)",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
},
"403": {
"description": "Forbidden (User is not a superuser)",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
},
"404": {
"description": "Container or interface not found",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
}
},
"/api/v1/tools/netem/show": {
"get": {
"security": [
{
"BearerAuth": []
}
],
"description": "Lists netem impairments for a given containerlab node. Requires superuser privileges.",
"produces": [
"application/json"
],
"tags": [
"Tools - Netem"
],
"summary": "Show link impairments (netem)",
"parameters": [
{
"type": "string",
"example": "clab-my-lab-srl1",
"description": "Container/node name",
"name": "containerName",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "Netem impairments",
"schema": {
"$ref": "#/definitions/models.NetemShowResponse"
}
},
"400": {
"description": "Invalid input parameters",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
},
"401": {
"description": "Unauthorized (JWT)",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
},
"403": {
"description": "Forbidden (User is not a superuser)",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
},
"404": {
"description": "Container not found",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/models.ErrorResponse"
}
}
}
}
},
"/api/v1/tools/veth": {
"post": {
"security": [
Expand Down Expand Up @@ -2763,6 +2966,107 @@ const docTemplate = `{
}
}
},
"models.NetemInterfaceInfo": {
"type": "object",
"properties": {
"corruption": {
"description": "Percentage (might be missing in older clab versions)",
"type": "number"
},
"delay": {
"description": "Duration string or empty",
"type": "string"
},
"interface": {
"description": "Interface name",
"type": "string"
},
"jitter": {
"description": "Duration string or empty",
"type": "string"
},
"packet_loss": {
"description": "Percentage",
"type": "number"
},
"rate": {
"description": "Kbit/s",
"type": "integer"
}
}
},
"models.NetemResetRequest": {
"type": "object",
"required": [
"containerName",
"interface"
],
"properties": {
"containerName": {
"description": "Container/node name to reset impairments on (e.g., \"clab-my-lab-srl1\").",
"type": "string",
"example": "clab-my-lab-srl1"
},
"interface": {
"description": "Interface name or interface alias to reset impairments on (e.g., \"eth1\" or \"mgmt0\").",
"type": "string",
"example": "eth1"
}
}
},
"models.NetemSetRequest": {
"type": "object",
"required": [
"containerName",
"interface"
],
"properties": {
"containerName": {
"description": "Container/node name to apply impairments on (e.g., \"clab-my-lab-srl1\").",
"type": "string",
"example": "clab-my-lab-srl1"
},
"corruption": {
"description": "Percentage (0.0 to 100.0)",
"type": "number",
"example": 0.1
},
"delay": {
"description": "Duration string (e.g., \"100ms\", \"1s\")",
"type": "string",
"example": "50ms"
},
"interface": {
"description": "Interface name or interface alias to apply impairments on (e.g., \"eth1\" or \"mgmt0\").",
"type": "string",
"example": "eth1"
},
"jitter": {
"description": "Duration string, requires Delay",
"type": "string",
"example": "5ms"
},
"loss": {
"description": "Percentage (0.0 to 100.0)",
"type": "number",
"example": 10.5
},
"rate": {
"description": "Kbit/s (non-negative integer)",
"type": "integer",
"example": 1000
}
}
},
"models.NetemShowResponse": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/models.NetemInterfaceInfo"
}
}
},
"models.NodeInterfaceInfo": {
"type": "object",
"properties": {
Expand Down
Loading