research(cli): an interface description has four published maxima, so none is enforced #2041

Merged
jaylouisw merged 1 commit from rev/1118-2142 into main 2026-11-18 22:08:19 +00:00
Owner

Question

How long may an interface description be, and what does an IOS-like box do past the limit - refuse, truncate, or store it? The console stores whatever is typed (engine/cli.js:2320), prints it after desc: in show interfaces and as a line in show running-config, and had no rule either way.

Verdict: unresolved, no engine behaviour changed

The published maximum for this one command is four different numbers:

Source Figure
Catalyst 1200/1300 CLI guide, description 1-64 characters
IOS XE Catalyst SD-WAN qualified command reference 17.x, description (interface configuration) 200 characters
IOS Interface and Hardware Component Command Reference, description (interface configuration) 238 characters
Catalyst 2960-X 15.2(4)E, 3850 3SE and 3650 3SE configuration guides up to 240 characters

The only behavioural witness (a Cisco Community thread, solved) is an acceptance: about 200 words pasted into a 12.2 1700 "with no issues". Refusal is therefore contradicted by the one transcript, and truncation is indistinguishable from no enforcement in it. Which figure belongs to this family is also not settled - 238 comes from a router command reference, 200 from an SD-WAN-qualified book.

So the note is the deliverable (research/interface-description-length.md), plus a comment at the store site saying why no ceiling is invented. A 240-character refusal on this evidence would be a guess between two numbers.

Contrast

research/vlan-name-length.md was implementable: three independent references said 1-32 and the Name column of show vlan is 32 dashes wide, so the field and its print were one over-determined fact. Here nothing in the output is bounded by the value - the description is a trailing free text field, not a cell - so there is no printed evidence to lean on either.

Measurement of today

Generic switch, 300-character description: stored as 300 characters, echoed in full by the receipt, by show interfaces and by show running-config (a 314-column line). No column is pushed out of place.

Tests

node scripts/syntax-check.js 425 files OK; node scripts/check-control-bytes.js clean; full npm test - 350 suites, 12133 assertions, 0 failed (179.6 s). The engine change is a comment only.

What remains unresolved

  1. 238 or 240, and therefore what a 300-character description leaves behind.
  2. Refuse, truncate, or store.
  3. What description ? prints on a real box (the accepted answer says it states the limit; the text was never posted).
  4. Whether the ceiling varies by switch family.
  5. Where a future rule would live, so the CLI door and the config loader (engine/device.js:1583) cannot disagree.

What would settle all of it: one console capture on a named image of description <300 chars>, then show interfaces <port> description, show running-config interface <port> and description ?.

## Question How long may an interface `description` be, and what does an IOS-like box do past the limit - refuse, truncate, or store it? The console stores whatever is typed (`engine/cli.js:2320`), prints it after `desc:` in `show interfaces` and as a line in `show running-config`, and had no rule either way. ## Verdict: unresolved, no engine behaviour changed The published maximum for this one command is **four different numbers**: | Source | Figure | | --- | --- | | Catalyst 1200/1300 CLI guide, `description` | 1-64 characters | | IOS XE Catalyst SD-WAN qualified command reference 17.x, `description (interface configuration)` | 200 characters | | IOS Interface and Hardware Component Command Reference, `description (interface configuration)` | 238 characters | | Catalyst 2960-X 15.2(4)E, 3850 3SE and 3650 3SE configuration guides | up to 240 characters | The only behavioural witness (a Cisco Community thread, solved) is an **acceptance**: about 200 words pasted into a 12.2 1700 "with no issues". Refusal is therefore contradicted by the one transcript, and truncation is indistinguishable from no enforcement in it. Which figure belongs to this family is also not settled - 238 comes from a router command reference, 200 from an SD-WAN-qualified book. So the note is the deliverable (`research/interface-description-length.md`), plus a comment at the store site saying why no ceiling is invented. A 240-character refusal on this evidence would be a guess between two numbers. ## Contrast `research/vlan-name-length.md` *was* implementable: three independent references said 1-32 and the Name column of `show vlan` is 32 dashes wide, so the field and its print were one over-determined fact. Here nothing in the output is bounded by the value - the description is a trailing free text field, not a cell - so there is no printed evidence to lean on either. ## Measurement of today Generic switch, 300-character description: stored as 300 characters, echoed in full by the receipt, by `show interfaces` and by `show running-config` (a 314-column line). No column is pushed out of place. ## Tests `node scripts/syntax-check.js` 425 files OK; `node scripts/check-control-bytes.js` clean; full `npm test` - **350 suites, 12133 assertions, 0 failed** (179.6 s). The engine change is a comment only. ## What remains unresolved 1. 238 or 240, and therefore what a 300-character description leaves behind. 2. Refuse, truncate, or store. 3. What `description ?` prints on a real box (the accepted answer says it states the limit; the text was never posted). 4. Whether the ceiling varies by switch family. 5. Where a future rule would live, so the CLI door and the config loader (`engine/device.js:1583`) cannot disagree. **What would settle all of it:** one console capture on a named image of `description <300 chars>`, then `show interfaces <port> description`, `show running-config interface <port>` and `description ?`.
research(cli): an interface description has four published maxima, so none is enforced
All checks were successful
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 5s
CI / Classify the change (pull_request) Successful in 6s
CI / Server smoke test (pull_request) Successful in 11s
CI / Docker build (pull_request) Successful in 23s
CI / Test (Node 20) (pull_request) Successful in 54s
CI / Test (Node 22) (pull_request) Successful in 55s
CI / Test (Node 18) (pull_request) Successful in 1m0s
CI / Arm auto-merge (pull_request) Successful in 2s
d1d9e1445a
The same `description` command is capped at 64 characters by the Catalyst 1200
CLI guide, 200 by the IOS XE SD-WAN qualified command reference, 238 by the IOS
Interface and Hardware Component Command Reference, and 240 by the Catalyst
2960-X and 3850 configuration guides. The only transcript of an over-long
description is a 12.2 router taking about 200 words "with no issues" - an
acceptance, not a refusal, and with no capture of what running-config then
holds. Which number belongs to this family, and whether the box truncates or
refuses, is therefore unknown, so the console keeps storing what was typed: a
refusal on this evidence would be a guess between two figures. The note records
the six sources, the two inferences (240 is the likeliest family figure; the
238/240 gap is a measurement difference), the five open questions, and the one
capture that would settle all of them. Contrasts it with the VLAN-name rule,
which was implementable because three references and the table's own column
width agreed on 32.
forgejo-actions scheduled this pull request to auto merge when all checks succeed 2026-11-18 21:51:07 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
jaylouisw/packetforge!2041
No description provided.